From 44d81b3c16b3884aed141a16bc6094f5c54ab6d7 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Fri, 28 Jul 2023 02:54:55 -0500 Subject: [PATCH] feat: add `PredictionService.ServerStreamingPredict` method (#4439) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * feat: ScheduleService (schedule_service.proto) creates and manages Schedule resources to launch scheduled pipelines runs feat: Schedule (schedule.proto) periodically schedules runs to make API calls PiperOrigin-RevId: 550058610 Source-Link: https://github.com/googleapis/googleapis/commit/5b24e63727233503ff65adada22af98365fd37f4 Source-Link: https://github.com/googleapis/googleapis-gen/commit/4c5f6f9c4292c14287217b56f2dcb04cd7727832 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWFpcGxhdGZvcm0vLk93bEJvdC55YW1sIiwiaCI6IjRjNWY2ZjljNDI5MmMxNDI4NzIxN2I1NmYyZGNiMDRjZDc3Mjc4MzIifQ== * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * fix: fix typings for IAM methods docs: fixed links in the generated Markdown documentation PiperOrigin-RevId: 551610576 Source-Link: https://github.com/googleapis/googleapis/commit/73b1313cbd1fd0cc1e22684bc89ee1b1a416cfe0 Source-Link: https://github.com/googleapis/googleapis-gen/commit/8bec066492a6da2855b1b8ce562664c0a6b30b01 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWFpcGxhdGZvcm0vLk93bEJvdC55YW1sIiwiaCI6IjhiZWMwNjY0OTJhNmRhMjg1NWIxYjhjZTU2MjY2NGMwYTZiMzBiMDEifQ== * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * feat: add `PredictionService.ServerStreamingPredict` method feat: add `StreamingPredictRequest` type feat: add `StreamingPredictResponse` type feat: add `Tensor` type PiperOrigin-RevId: 551672526 Source-Link: https://github.com/googleapis/googleapis/commit/1b650d6c6ee9e50fe122562550a47ec258151498 Source-Link: https://github.com/googleapis/googleapis-gen/commit/62fb73702732ce727fbd2e5560d309ece0609850 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWFpcGxhdGZvcm0vLk93bEJvdC55YW1sIiwiaCI6IjYyZmI3MzcwMjczMmNlNzI3ZmJkMmU1NTYwZDMwOWVjZTA2MDk4NTAifQ== * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * chore!: update to Node 14 See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot Co-authored-by: sofisl <55454395+sofisl@users.noreply.github.com> Co-authored-by: Sofia Leon --- packages/google-cloud-aiplatform/README.md | 9 + packages/google-cloud-aiplatform/package.json | 13 +- .../aiplatform/v1/prediction_service.proto | 54 + .../google/cloud/aiplatform/v1/schedule.proto | 172 + .../aiplatform/v1/schedule_service.proto | 307 + .../google/cloud/aiplatform/v1/types.proto | 87 + .../v1beta1/prediction_service.proto | 55 + .../cloud/aiplatform/v1beta1/types.proto | 87 + .../protos/protos.d.ts | 2518 +++- .../google-cloud-aiplatform/protos/protos.js | 6183 +++++++++ .../protos/protos.json | 898 +- .../google-cloud-aiplatform/samples/README.md | 162 + .../v1/dataset_service.import_data.js | 2 +- .../v1/dataset_service.search_data_items.js | 2 +- .../v1/endpoint_service.deploy_model.js | 2 +- .../v1/endpoint_service.undeploy_model.js | 2 +- ...g_service.streaming_read_feature_values.js | 2 +- ...ne_serving_service.write_feature_values.js | 2 +- ...turestore_service.batch_create_features.js | 2 +- ...store_service.batch_read_feature_values.js | 4 +- ...turestore_service.export_feature_values.js | 2 +- ...turestore_service.import_feature_values.js | 2 +- .../v1/index_service.remove_datapoints.js | 2 +- .../v1/index_service.upsert_datapoints.js | 2 +- ...l_deployment_monitoring_stats_anomalies.js | 2 +- .../v1/match_service.find_neighbors.js | 2 +- .../v1/match_service.read_index_datapoints.js | 2 +- ...ce.add_context_artifacts_and_executions.js | 4 +- .../metadata_service.add_context_children.js | 2 +- .../metadata_service.add_execution_events.js | 2 +- ...etadata_service.remove_context_children.js | 2 +- ...gration_service.batch_migrate_resources.js | 2 +- ...vice.batch_import_evaluated_annotations.js | 2 +- ...ce.batch_import_model_evaluation_slices.js | 2 +- .../v1/model_service.merge_version_aliases.js | 2 +- .../v1/prediction_service.explain.js | 2 +- .../v1/prediction_service.predict.js | 2 +- ...iction_service.server_streaming_predict.js | 73 + .../v1/schedule_service.create_schedule.js | 67 + .../v1/schedule_service.delete_schedule.js | 64 + .../v1/schedule_service.get_schedule.js | 63 + .../v1/schedule_service.list_schedules.js | 122 + .../v1/schedule_service.pause_schedule.js | 63 + .../v1/schedule_service.resume_schedule.js | 71 + .../v1/schedule_service.update_schedule.js | 70 + ...t_metadata.google.cloud.aiplatform.v1.json | 308 + ...t_metadata_google.cloud.aiplatform.v1.json | 10231 +++++++++++++++ ...d_service.batch_create_tensorboard_runs.js | 2 +- ...ce.batch_create_tensorboard_time_series.js | 2 +- ...batch_read_tensorboard_time_series_data.js | 2 +- ...oard_service.read_tensorboard_blob_data.js | 2 +- ...rvice.write_tensorboard_experiment_data.js | 2 +- ...oard_service.write_tensorboard_run_data.js | 2 +- .../v1beta1/dataset_service.import_data.js | 2 +- .../dataset_service.search_data_items.js | 2 +- .../v1beta1/endpoint_service.deploy_model.js | 2 +- .../endpoint_service.undeploy_model.js | 2 +- ...g_service.streaming_read_feature_values.js | 2 +- ...ne_serving_service.write_feature_values.js | 2 +- ...turestore_service.batch_create_features.js | 2 +- ...store_service.batch_read_feature_values.js | 4 +- ...turestore_service.export_feature_values.js | 2 +- ...turestore_service.import_feature_values.js | 2 +- .../index_service.remove_datapoints.js | 2 +- .../index_service.upsert_datapoints.js | 2 +- ...l_deployment_monitoring_stats_anomalies.js | 2 +- .../v1beta1/match_service.find_neighbors.js | 2 +- .../match_service.read_index_datapoints.js | 2 +- ...ce.add_context_artifacts_and_executions.js | 4 +- .../metadata_service.add_context_children.js | 2 +- .../metadata_service.add_execution_events.js | 2 +- ...etadata_service.remove_context_children.js | 2 +- ...gration_service.batch_migrate_resources.js | 2 +- ...vice.batch_import_evaluated_annotations.js | 2 +- ...ce.batch_import_model_evaluation_slices.js | 2 +- .../model_service.merge_version_aliases.js | 2 +- .../v1beta1/prediction_service.explain.js | 2 +- .../v1beta1/prediction_service.predict.js | 2 +- ...iction_service.server_streaming_predict.js | 73 + ...adata_google.cloud.aiplatform.v1beta1.json | 10663 ++++++++++++++++ ...d_service.batch_create_tensorboard_runs.js | 2 +- ...ce.batch_create_tensorboard_time_series.js | 2 +- ...batch_read_tensorboard_time_series_data.js | 2 +- ...oard_service.read_tensorboard_blob_data.js | 2 +- ...rvice.write_tensorboard_experiment_data.js | 2 +- ...oard_service.write_tensorboard_run_data.js | 2 +- .../samples/package.json | 2 +- packages/google-cloud-aiplatform/src/index.ts | 4 + .../src/v1/dataset_service_client.ts | 222 +- .../src/v1/dataset_service_proto_list.json | 2 + .../src/v1/endpoint_service_client.ts | 165 +- .../src/v1/endpoint_service_proto_list.json | 2 + ...turestore_online_serving_service_client.ts | 87 +- ...ore_online_serving_service_proto_list.json | 2 + .../src/v1/featurestore_service_client.ts | 297 +- .../v1/featurestore_service_proto_list.json | 2 + .../src/v1/gapic_metadata.json | 93 + .../google-cloud-aiplatform/src/v1/index.ts | 1 + .../src/v1/index_endpoint_service_client.ts | 153 +- .../v1/index_endpoint_service_proto_list.json | 2 + .../src/v1/index_service_client.ts | 138 +- .../src/v1/index_service_proto_list.json | 2 + .../src/v1/job_service_client.ts | 452 +- .../src/v1/job_service_proto_list.json | 2 + .../src/v1/match_service_client.ts | 82 +- .../src/v1/match_service_proto_list.json | 2 + .../src/v1/metadata_service_client.ts | 358 +- .../src/v1/metadata_service_proto_list.json | 2 + .../src/v1/migration_service_client.ts | 101 +- .../src/v1/migration_service_proto_list.json | 2 + .../src/v1/model_garden_service_client.ts | 77 +- .../v1/model_garden_service_proto_list.json | 2 + .../src/v1/model_service_client.ts | 280 +- .../src/v1/model_service_proto_list.json | 2 + .../src/v1/pipeline_service_client.ts | 190 +- .../src/v1/pipeline_service_proto_list.json | 2 + .../src/v1/prediction_service_client.ts | 204 +- .../v1/prediction_service_client_config.json | 4 + .../src/v1/prediction_service_proto_list.json | 2 + .../src/v1/schedule_service_client.ts | 5437 ++++++++ .../v1/schedule_service_client_config.json | 54 + .../src/v1/schedule_service_proto_list.json | 120 + .../src/v1/specialist_pool_service_client.ts | 124 +- .../specialist_pool_service_proto_list.json | 2 + .../src/v1/tensorboard_service_client.ts | 351 +- .../v1/tensorboard_service_proto_list.json | 2 + .../src/v1/vizier_service_client.ts | 177 +- .../src/v1/vizier_service_proto_list.json | 2 + .../src/v1beta1/dataset_service_client.ts | 170 +- ...deployment_resource_pool_service_client.ts | 71 +- .../src/v1beta1/endpoint_service_client.ts | 113 +- ...turestore_online_serving_service_client.ts | 35 +- .../v1beta1/featurestore_service_client.ts | 245 +- .../src/v1beta1/gapic_metadata.json | 5 + .../v1beta1/index_endpoint_service_client.ts | 101 +- .../src/v1beta1/index_service_client.ts | 86 +- .../src/v1beta1/job_service_client.ts | 400 +- .../src/v1beta1/match_service_client.ts | 30 +- .../src/v1beta1/metadata_service_client.ts | 306 +- .../src/v1beta1/migration_service_client.ts | 49 +- .../v1beta1/model_garden_service_client.ts | 25 +- .../src/v1beta1/model_service_client.ts | 228 +- .../persistent_resource_service_client.ts | 66 +- .../src/v1beta1/pipeline_service_client.ts | 138 +- .../src/v1beta1/prediction_service_client.ts | 152 +- .../prediction_service_client_config.json | 4 + .../src/v1beta1/schedule_service_client.ts | 90 +- .../v1beta1/specialist_pool_service_client.ts | 72 +- .../src/v1beta1/tensorboard_service_client.ts | 304 +- .../src/v1beta1/vizier_service_client.ts | 125 +- .../system-test/fixtures/sample/src/index.js | 1 + .../system-test/fixtures/sample/src/index.ts | 7 + .../test/gapic_dataset_service_v1.ts | 64 + .../test/gapic_endpoint_service_v1.ts | 64 + ..._featurestore_online_serving_service_v1.ts | 67 + .../test/gapic_featurestore_service_v1.ts | 66 + .../test/gapic_index_endpoint_service_v1.ts | 65 + .../test/gapic_index_service_v1.ts | 64 + .../test/gapic_job_service_v1.ts | 64 + .../test/gapic_match_service_v1.ts | 64 + .../test/gapic_metadata_service_v1.ts | 64 + .../test/gapic_migration_service_v1.ts | 64 + .../test/gapic_model_garden_service_v1.ts | 64 + .../test/gapic_model_service_v1.ts | 64 + .../test/gapic_pipeline_service_v1.ts | 64 + .../test/gapic_prediction_service_v1.ts | 213 + .../test/gapic_prediction_service_v1beta1.ts | 152 + .../test/gapic_schedule_service_v1.ts | 5155 ++++++++ .../test/gapic_specialist_pool_service_v1.ts | 65 + .../test/gapic_tensorboard_service_v1.ts | 64 + .../test/gapic_vizier_service_v1.ts | 64 + 171 files changed, 47744 insertions(+), 3382 deletions(-) create mode 100644 packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/schedule.proto create mode 100644 packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/schedule_service.proto create mode 100644 packages/google-cloud-aiplatform/samples/generated/v1/prediction_service.server_streaming_predict.js create mode 100644 packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.create_schedule.js create mode 100644 packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.delete_schedule.js create mode 100644 packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.get_schedule.js create mode 100644 packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.list_schedules.js create mode 100644 packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.pause_schedule.js create mode 100644 packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.resume_schedule.js create mode 100644 packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.update_schedule.js create mode 100644 packages/google-cloud-aiplatform/samples/generated/v1/snippet_metadata_google.cloud.aiplatform.v1.json create mode 100644 packages/google-cloud-aiplatform/samples/generated/v1beta1/prediction_service.server_streaming_predict.js create mode 100644 packages/google-cloud-aiplatform/samples/generated/v1beta1/snippet_metadata_google.cloud.aiplatform.v1beta1.json create mode 100644 packages/google-cloud-aiplatform/src/v1/schedule_service_client.ts create mode 100644 packages/google-cloud-aiplatform/src/v1/schedule_service_client_config.json create mode 100644 packages/google-cloud-aiplatform/src/v1/schedule_service_proto_list.json create mode 100644 packages/google-cloud-aiplatform/test/gapic_schedule_service_v1.ts diff --git a/packages/google-cloud-aiplatform/README.md b/packages/google-cloud-aiplatform/README.md index fff3efc7bce..ffe3513f11d 100644 --- a/packages/google-cloud-aiplatform/README.md +++ b/packages/google-cloud-aiplatform/README.md @@ -265,6 +265,14 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/ | Prediction_service.explain | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-aiplatform/samples/generated/v1/prediction_service.explain.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-aiplatform/samples/generated/v1/prediction_service.explain.js,packages/google-cloud-aiplatform/samples/README.md) | | Prediction_service.predict | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-aiplatform/samples/generated/v1/prediction_service.predict.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-aiplatform/samples/generated/v1/prediction_service.predict.js,packages/google-cloud-aiplatform/samples/README.md) | | Prediction_service.raw_predict | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-aiplatform/samples/generated/v1/prediction_service.raw_predict.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-aiplatform/samples/generated/v1/prediction_service.raw_predict.js,packages/google-cloud-aiplatform/samples/README.md) | +| Prediction_service.server_streaming_predict | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-aiplatform/samples/generated/v1/prediction_service.server_streaming_predict.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-aiplatform/samples/generated/v1/prediction_service.server_streaming_predict.js,packages/google-cloud-aiplatform/samples/README.md) | +| Schedule_service.create_schedule | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.create_schedule.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.create_schedule.js,packages/google-cloud-aiplatform/samples/README.md) | +| Schedule_service.delete_schedule | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.delete_schedule.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.delete_schedule.js,packages/google-cloud-aiplatform/samples/README.md) | +| Schedule_service.get_schedule | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.get_schedule.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.get_schedule.js,packages/google-cloud-aiplatform/samples/README.md) | +| Schedule_service.list_schedules | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.list_schedules.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.list_schedules.js,packages/google-cloud-aiplatform/samples/README.md) | +| Schedule_service.pause_schedule | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.pause_schedule.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.pause_schedule.js,packages/google-cloud-aiplatform/samples/README.md) | +| Schedule_service.resume_schedule | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.resume_schedule.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.resume_schedule.js,packages/google-cloud-aiplatform/samples/README.md) | +| Schedule_service.update_schedule | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.update_schedule.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.update_schedule.js,packages/google-cloud-aiplatform/samples/README.md) | | Specialist_pool_service.create_specialist_pool | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-aiplatform/samples/generated/v1/specialist_pool_service.create_specialist_pool.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-aiplatform/samples/generated/v1/specialist_pool_service.create_specialist_pool.js,packages/google-cloud-aiplatform/samples/README.md) | | Specialist_pool_service.delete_specialist_pool | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-aiplatform/samples/generated/v1/specialist_pool_service.delete_specialist_pool.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-aiplatform/samples/generated/v1/specialist_pool_service.delete_specialist_pool.js,packages/google-cloud-aiplatform/samples/README.md) | | Specialist_pool_service.get_specialist_pool | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-aiplatform/samples/generated/v1/specialist_pool_service.get_specialist_pool.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-aiplatform/samples/generated/v1/specialist_pool_service.get_specialist_pool.js,packages/google-cloud-aiplatform/samples/README.md) | @@ -486,6 +494,7 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/ | Prediction_service.explain | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-aiplatform/samples/generated/v1beta1/prediction_service.explain.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-aiplatform/samples/generated/v1beta1/prediction_service.explain.js,packages/google-cloud-aiplatform/samples/README.md) | | Prediction_service.predict | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-aiplatform/samples/generated/v1beta1/prediction_service.predict.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-aiplatform/samples/generated/v1beta1/prediction_service.predict.js,packages/google-cloud-aiplatform/samples/README.md) | | Prediction_service.raw_predict | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-aiplatform/samples/generated/v1beta1/prediction_service.raw_predict.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-aiplatform/samples/generated/v1beta1/prediction_service.raw_predict.js,packages/google-cloud-aiplatform/samples/README.md) | +| Prediction_service.server_streaming_predict | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-aiplatform/samples/generated/v1beta1/prediction_service.server_streaming_predict.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-aiplatform/samples/generated/v1beta1/prediction_service.server_streaming_predict.js,packages/google-cloud-aiplatform/samples/README.md) | | Schedule_service.create_schedule | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-aiplatform/samples/generated/v1beta1/schedule_service.create_schedule.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-aiplatform/samples/generated/v1beta1/schedule_service.create_schedule.js,packages/google-cloud-aiplatform/samples/README.md) | | Schedule_service.delete_schedule | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-aiplatform/samples/generated/v1beta1/schedule_service.delete_schedule.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-aiplatform/samples/generated/v1beta1/schedule_service.delete_schedule.js,packages/google-cloud-aiplatform/samples/README.md) | | Schedule_service.get_schedule | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-aiplatform/samples/generated/v1beta1/schedule_service.get_schedule.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-aiplatform/samples/generated/v1beta1/schedule_service.get_schedule.js,packages/google-cloud-aiplatform/samples/README.md) | diff --git a/packages/google-cloud-aiplatform/package.json b/packages/google-cloud-aiplatform/package.json index 02690885952..a852450a553 100644 --- a/packages/google-cloud-aiplatform/package.json +++ b/packages/google-cloud-aiplatform/package.json @@ -53,15 +53,16 @@ "test": "c8 node build/test/run.js" }, "dependencies": { - "google-gax": "^3.5.8", + "google-gax": "^4.0.3", "protobuf.js": "^1.1.2" }, "devDependencies": { "@types/mocha": "^9.0.0", - "@types/node": "^18.0.0", + "@types/node": "^20.4.5", "@types/sinon": "^10.0.0", "c8": "^7.3.5", - "gts": "^3.1.0", + "gapic-tools": "^0.1.8", + "gts": "^5.0.0", "jsdoc": "^4.0.0", "jsdoc-fresh": "^2.0.0", "jsdoc-region-tag": "^2.0.0", @@ -72,12 +73,12 @@ "pack-n-play": "^1.0.0-2", "sinon": "^15.0.0", "ts-loader": "^9.0.0", - "typescript": "^4.6.4", + "typescript": "^5.1.6", "webpack": "^5.4.0", "webpack-cli": "^5.0.0" }, "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" }, "homepage": "https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-aiplatform" -} +} \ No newline at end of file diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/prediction_service.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/prediction_service.proto index 16dadb28af8..52b5d6df615 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/prediction_service.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/prediction_service.proto @@ -22,6 +22,7 @@ import "google/api/field_behavior.proto"; import "google/api/httpbody.proto"; import "google/api/resource.proto"; import "google/cloud/aiplatform/v1/explanation.proto"; +import "google/cloud/aiplatform/v1/types.proto"; import "google/protobuf/struct.proto"; option csharp_namespace = "Google.Cloud.AIPlatform.V1"; @@ -74,6 +75,20 @@ service PredictionService { option (google.api.method_signature) = "endpoint,http_body"; } + // Perform a server-side streaming online prediction request for Vertex + // LLM streaming. + rpc ServerStreamingPredict(StreamingPredictRequest) + returns (stream StreamingPredictResponse) { + option (google.api.http) = { + post: "/v1/{endpoint=projects/*/locations/*/endpoints/*}:serverStreamingPredict" + body: "*" + additional_bindings { + post: "/v1/{endpoint=projects/*/locations/*/publishers/*/models/*}:serverStreamingPredict" + body: "*" + } + }; + } + // Perform an online explanation. // // If @@ -158,6 +173,11 @@ message PredictResponse { // name][google.cloud.aiplatform.v1.Model.display_name] of the Model which is // deployed as the DeployedModel that this prediction hits. string model_display_name = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Request-level metadata returned by the model. The metadata + // type will be dependent upon the model implementation. + google.protobuf.Value metadata = 6 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // Request message for @@ -191,6 +211,40 @@ message RawPredictRequest { google.api.HttpBody http_body = 2; } +// Request message for +// [PredictionService.StreamingPredict][google.cloud.aiplatform.v1.PredictionService.StreamingPredict]. +// +// The first message must contain +// [endpoint][google.cloud.aiplatform.v1.StreamingPredictRequest.endpoint] field +// and optionally [input][]. The subsequent messages must contain [input][]. +message StreamingPredictRequest { + // Required. The name of the Endpoint requested to serve the prediction. + // Format: + // `projects/{project}/locations/{location}/endpoints/{endpoint}` + string endpoint = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "aiplatform.googleapis.com/Endpoint" + } + ]; + + // The prediction input. + repeated Tensor inputs = 2; + + // The parameters that govern the prediction. + Tensor parameters = 3; +} + +// Response message for +// [PredictionService.StreamingPredict][google.cloud.aiplatform.v1.PredictionService.StreamingPredict]. +message StreamingPredictResponse { + // The prediction output. + repeated Tensor outputs = 1; + + // The parameters that govern the prediction. + Tensor parameters = 2; +} + // Request message for // [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain]. message ExplainRequest { diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/schedule.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/schedule.proto new file mode 100644 index 00000000000..b66e735ac64 --- /dev/null +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/schedule.proto @@ -0,0 +1,172 @@ +// Copyright 2023 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 +// +// http://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. + +syntax = "proto3"; + +package google.cloud.aiplatform.v1; + +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; +import "google/cloud/aiplatform/v1/pipeline_service.proto"; +import "google/protobuf/timestamp.proto"; + +option csharp_namespace = "Google.Cloud.AIPlatform.V1"; +option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb"; +option java_multiple_files = true; +option java_outer_classname = "ScheduleProto"; +option java_package = "com.google.cloud.aiplatform.v1"; +option php_namespace = "Google\\Cloud\\AIPlatform\\V1"; +option ruby_package = "Google::Cloud::AIPlatform::V1"; + +// An instance of a Schedule periodically schedules runs to make API calls based +// on user specified time specification and API request type. +message Schedule { + option (google.api.resource) = { + type: "aiplatform.googleapis.com/Schedule" + pattern: "projects/{project}/locations/{location}/schedules/{schedule}" + }; + + // Status of a scheduled run. + message RunResponse { + // The scheduled run time based on the user-specified schedule. + google.protobuf.Timestamp scheduled_run_time = 1; + + // The response of the scheduled run. + string run_response = 2; + } + + // Possible state of the schedule. + enum State { + // Unspecified. + STATE_UNSPECIFIED = 0; + + // The Schedule is active. Runs are being scheduled on the user-specified + // timespec. + ACTIVE = 1; + + // The schedule is paused. No new runs will be created until the schedule + // is resumed. Already started runs will be allowed to complete. + PAUSED = 2; + + // The Schedule is completed. No new runs will be scheduled. Already started + // runs will be allowed to complete. Schedules in completed state cannot be + // paused or resumed. + COMPLETED = 3; + } + + // Required. + // The time specification to launch scheduled runs. + oneof time_specification { + // Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled + // runs. To explicitly set a timezone to the cron tab, apply a prefix in the + // cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". + // The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone + // database. For example, "CRON_TZ=America/New_York 1 * * * *", or + // "TZ=America/New_York 1 * * * *". + string cron = 10; + } + + // Required. + // The API request template to launch the scheduled runs. + // User-specified ID is not supported in the request template. + oneof request { + // Request for + // [PipelineService.CreatePipelineJob][google.cloud.aiplatform.v1.PipelineService.CreatePipelineJob]. + // CreatePipelineJobRequest.parent field is required (format: + // projects/{project}/locations/{location}). + CreatePipelineJobRequest create_pipeline_job_request = 14; + } + + // Output only. The resource name of the Schedule. + string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Required. User provided name of the Schedule. + // The name can be up to 128 characters long and can consist of any UTF-8 + // characters. + string display_name = 2 [(google.api.field_behavior) = REQUIRED]; + + // Optional. Timestamp after which the first run can be scheduled. + // Default to Schedule create time if not specified. + google.protobuf.Timestamp start_time = 3 + [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Timestamp after which no new runs can be scheduled. + // If specified, The schedule will be completed when either + // end_time is reached or when scheduled_run_count >= max_run_count. + // If not specified, new runs will keep getting scheduled until this Schedule + // is paused or deleted. Already scheduled runs will be allowed to complete. + // Unset if not specified. + google.protobuf.Timestamp end_time = 4 + [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Maximum run count of the schedule. + // If specified, The schedule will be completed when either + // started_run_count >= max_run_count or when end_time is reached. + // If not specified, new runs will keep getting scheduled until this Schedule + // is paused or deleted. Already scheduled runs will be allowed to complete. + // Unset if not specified. + int64 max_run_count = 16 [(google.api.field_behavior) = OPTIONAL]; + + // Output only. The number of runs started by this schedule. + int64 started_run_count = 17 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The state of this Schedule. + State state = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Timestamp when this Schedule was created. + google.protobuf.Timestamp create_time = 6 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Timestamp when this Schedule was updated. + google.protobuf.Timestamp update_time = 19 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Timestamp when this Schedule should schedule the next run. + // Having a next_run_time in the past means the runs are being started + // behind schedule. + google.protobuf.Timestamp next_run_time = 7 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Timestamp when this Schedule was last paused. + // Unset if never paused. + google.protobuf.Timestamp last_pause_time = 8 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Timestamp when this Schedule was last resumed. + // Unset if never resumed from pause. + google.protobuf.Timestamp last_resume_time = 9 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Required. Maximum number of runs that can be started concurrently for this + // Schedule. This is the limit for starting the scheduled requests and not the + // execution of the operations/jobs created by the requests (if applicable). + int64 max_concurrent_run_count = 11 [(google.api.field_behavior) = REQUIRED]; + + // Optional. Whether new scheduled runs can be queued when max_concurrent_runs + // limit is reached. If set to true, new runs will be queued instead of + // skipped. Default to false. + bool allow_queueing = 12 [(google.api.field_behavior) = OPTIONAL]; + + // Output only. Whether to backfill missed runs when the schedule is resumed + // from PAUSED state. If set to true, all missed runs will be scheduled. New + // runs will be scheduled after the backfill is complete. Default to false. + bool catch_up = 13 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Response of the last scheduled run. + // This is the response for starting the scheduled requests and not the + // execution of the operations/jobs created by the requests (if applicable). + // Unset if no run has been scheduled yet. + RunResponse last_scheduled_run_response = 18 + [(google.api.field_behavior) = OUTPUT_ONLY]; +} diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/schedule_service.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/schedule_service.proto new file mode 100644 index 00000000000..19ffc2b8953 --- /dev/null +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/schedule_service.proto @@ -0,0 +1,307 @@ +// Copyright 2023 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 +// +// http://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. + +syntax = "proto3"; + +package google.cloud.aiplatform.v1; + +import "google/api/annotations.proto"; +import "google/api/client.proto"; +import "google/api/field_behavior.proto"; +import "google/api/resource.proto"; +import "google/cloud/aiplatform/v1/operation.proto"; +import "google/cloud/aiplatform/v1/schedule.proto"; +import "google/longrunning/operations.proto"; +import "google/protobuf/empty.proto"; +import "google/protobuf/field_mask.proto"; + +option csharp_namespace = "Google.Cloud.AIPlatform.V1"; +option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb"; +option java_multiple_files = true; +option java_outer_classname = "ScheduleServiceProto"; +option java_package = "com.google.cloud.aiplatform.v1"; +option php_namespace = "Google\\Cloud\\AIPlatform\\V1"; +option ruby_package = "Google::Cloud::AIPlatform::V1"; + +// A service for creating and managing Vertex AI's Schedule resources to +// periodically launch shceudled runs to make API calls. +service ScheduleService { + option (google.api.default_host) = "aiplatform.googleapis.com"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/cloud-platform"; + + // Creates a Schedule. + rpc CreateSchedule(CreateScheduleRequest) returns (Schedule) { + option (google.api.http) = { + post: "/v1/{parent=projects/*/locations/*}/schedules" + body: "schedule" + }; + option (google.api.method_signature) = "parent,schedule"; + } + + // Deletes a Schedule. + rpc DeleteSchedule(DeleteScheduleRequest) + returns (google.longrunning.Operation) { + option (google.api.http) = { + delete: "/v1/{name=projects/*/locations/*/schedules/*}" + }; + option (google.api.method_signature) = "name"; + option (google.longrunning.operation_info) = { + response_type: "google.protobuf.Empty" + metadata_type: "DeleteOperationMetadata" + }; + } + + // Gets a Schedule. + rpc GetSchedule(GetScheduleRequest) returns (Schedule) { + option (google.api.http) = { + get: "/v1/{name=projects/*/locations/*/schedules/*}" + }; + option (google.api.method_signature) = "name"; + } + + // Lists Schedules in a Location. + rpc ListSchedules(ListSchedulesRequest) returns (ListSchedulesResponse) { + option (google.api.http) = { + get: "/v1/{parent=projects/*/locations/*}/schedules" + }; + option (google.api.method_signature) = "parent"; + } + + // Pauses a Schedule. Will mark + // [Schedule.state][google.cloud.aiplatform.v1.Schedule.state] to 'PAUSED'. If + // the schedule is paused, no new runs will be created. Already created runs + // will NOT be paused or canceled. + rpc PauseSchedule(PauseScheduleRequest) returns (google.protobuf.Empty) { + option (google.api.http) = { + post: "/v1/{name=projects/*/locations/*/schedules/*}:pause" + body: "*" + }; + option (google.api.method_signature) = "name"; + } + + // Resumes a paused Schedule to start scheduling new runs. Will mark + // [Schedule.state][google.cloud.aiplatform.v1.Schedule.state] to 'ACTIVE'. + // Only paused Schedule can be resumed. + // + // When the Schedule is resumed, new runs will be scheduled starting from the + // next execution time after the current time based on the time_specification + // in the Schedule. If [Schedule.catchUp][] is set up true, all + // missed runs will be scheduled for backfill first. + rpc ResumeSchedule(ResumeScheduleRequest) returns (google.protobuf.Empty) { + option (google.api.http) = { + post: "/v1/{name=projects/*/locations/*/schedules/*}:resume" + body: "*" + }; + option (google.api.method_signature) = "name"; + option (google.api.method_signature) = "name,catch_up"; + } + + // Updates an active or paused Schedule. + // + // When the Schedule is updated, new runs will be scheduled starting from the + // updated next execution time after the update time based on the + // time_specification in the updated Schedule. All unstarted runs before the + // update time will be skipped while already created runs will NOT be paused + // or canceled. + rpc UpdateSchedule(UpdateScheduleRequest) returns (Schedule) { + option (google.api.http) = { + patch: "/v1/{schedule.name=projects/*/locations/*/schedules/*}" + body: "schedule" + }; + option (google.api.method_signature) = "schedule,update_mask"; + } +} + +// Request message for +// [ScheduleService.CreateSchedule][google.cloud.aiplatform.v1.ScheduleService.CreateSchedule]. +message CreateScheduleRequest { + // Required. The resource name of the Location to create the Schedule in. + // Format: `projects/{project}/locations/{location}` + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "locations.googleapis.com/Location" + } + ]; + + // Required. The Schedule to create. + Schedule schedule = 2 [(google.api.field_behavior) = REQUIRED]; +} + +// Request message for +// [ScheduleService.GetSchedule][google.cloud.aiplatform.v1.ScheduleService.GetSchedule]. +message GetScheduleRequest { + // Required. The name of the Schedule resource. + // Format: + // `projects/{project}/locations/{location}/schedules/{schedule}` + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "aiplatform.googleapis.com/Schedule" + } + ]; +} + +// Request message for +// [ScheduleService.ListSchedules][google.cloud.aiplatform.v1.ScheduleService.ListSchedules]. +message ListSchedulesRequest { + // Required. The resource name of the Location to list the Schedules from. + // Format: `projects/{project}/locations/{location}` + string parent = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "locations.googleapis.com/Location" + } + ]; + + // Lists the Schedules that match the filter expression. The following + // fields are supported: + // + // * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. + // * `state`: Supports `=` and `!=` comparisons. + // * `request`: Supports existence of the check. + // (e.g. `create_pipeline_job_request:*` --> Schedule has + // create_pipeline_job_request). + // * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. + // Values must be in RFC 3339 format. + // * `start_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. + // Values must be in RFC 3339 format. + // * `end_time`: Supports `=`, `!=`, `<`, `>`, `<=`, `>=` comparisons and `:*` + // existence check. Values must be in RFC 3339 format. + // * `next_run_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` + // comparisons. Values must be in RFC 3339 format. + // + // + // Filter expressions can be combined together using logical operators + // (`NOT`, `AND` & `OR`). + // The syntax to define filter expression is based on + // https://google.aip.dev/160. + // + // Examples: + // + // * `state="ACTIVE" AND display_name:"my_schedule_*"` + // * `NOT display_name="my_schedule"` + // * `create_time>"2021-05-18T00:00:00Z"` + // * `end_time>"2021-05-18T00:00:00Z" OR NOT end_time:*` + // * `create_pipeline_job_request:*` + string filter = 2; + + // The standard list page size. + // Default to 100 if not specified. + int32 page_size = 3; + + // The standard list page token. + // Typically obtained via + // [ListSchedulesResponse.next_page_token][google.cloud.aiplatform.v1.ListSchedulesResponse.next_page_token] + // of the previous + // [ScheduleService.ListSchedules][google.cloud.aiplatform.v1.ScheduleService.ListSchedules] + // call. + string page_token = 4; + + // A comma-separated list of fields to order by. The default sort order is in + // ascending order. Use "desc" after a field name for descending. You can have + // multiple order_by fields provided. + // + // For example, using "create_time desc, end_time" will order results by + // create time in descending order, and if there are multiple schedules having + // the same create time, order them by the end time in ascending order. + // + // If order_by is not specified, it will order by default with create_time in + // descending order. + // + // Supported fields: + // * `create_time` + // * `start_time` + // * `end_time` + // * `next_run_time` + string order_by = 5; +} + +// Response message for +// [ScheduleService.ListSchedules][google.cloud.aiplatform.v1.ScheduleService.ListSchedules] +message ListSchedulesResponse { + // List of Schedules in the requested page. + repeated Schedule schedules = 1; + + // A token to retrieve the next page of results. + // Pass to + // [ListSchedulesRequest.page_token][google.cloud.aiplatform.v1.ListSchedulesRequest.page_token] + // to obtain that page. + string next_page_token = 2; +} + +// Request message for +// [ScheduleService.DeleteSchedule][google.cloud.aiplatform.v1.ScheduleService.DeleteSchedule]. +message DeleteScheduleRequest { + // Required. The name of the Schedule resource to be deleted. + // Format: + // `projects/{project}/locations/{location}/schedules/{schedule}` + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "aiplatform.googleapis.com/Schedule" + } + ]; +} + +// Request message for +// [ScheduleService.PauseSchedule][google.cloud.aiplatform.v1.ScheduleService.PauseSchedule]. +message PauseScheduleRequest { + // Required. The name of the Schedule resource to be paused. + // Format: + // `projects/{project}/locations/{location}/schedules/{schedule}` + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "aiplatform.googleapis.com/Schedule" + } + ]; +} + +// Request message for +// [ScheduleService.ResumeSchedule][google.cloud.aiplatform.v1.ScheduleService.ResumeSchedule]. +message ResumeScheduleRequest { + // Required. The name of the Schedule resource to be resumed. + // Format: + // `projects/{project}/locations/{location}/schedules/{schedule}` + string name = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "aiplatform.googleapis.com/Schedule" + } + ]; + + // Optional. Whether to backfill missed runs when the schedule is resumed from + // PAUSED state. If set to true, all missed runs will be scheduled. New runs + // will be scheduled after the backfill is complete. This will also update + // [Schedule.catch_up][google.cloud.aiplatform.v1.Schedule.catch_up] field. + // Default to false. + bool catch_up = 2 [(google.api.field_behavior) = OPTIONAL]; +} + +// Request message for +// [ScheduleService.UpdateSchedule][google.cloud.aiplatform.v1.ScheduleService.UpdateSchedule]. +message UpdateScheduleRequest { + // Required. The Schedule which replaces the resource on the server. + // The following restrictions will be applied: + // * The scheduled request type cannot be changed. + // * The output_only fields will be ignored if specified. + Schedule schedule = 1 [(google.api.field_behavior) = REQUIRED]; + + // Required. The update mask applies to the resource. See + // [google.protobuf.FieldMask][google.protobuf.FieldMask]. + google.protobuf.FieldMask update_mask = 2 + [(google.api.field_behavior) = REQUIRED]; +} diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/types.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/types.proto index 532638e4474..16ab0139d3c 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/types.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/types.proto @@ -47,3 +47,90 @@ message StringArray { // A list of string values. repeated string values = 1; } + +// A tensor value type. +message Tensor { + // Data type of the tensor. + enum DataType { + // Not a legal value for DataType. Used to indicate a DataType field has not + // been set. + DATA_TYPE_UNSPECIFIED = 0; + + // Data types that all computation devices are expected to be + // capable to support. + BOOL = 1; + + STRING = 2; + + FLOAT = 3; + + DOUBLE = 4; + + INT8 = 5; + + INT16 = 6; + + INT32 = 7; + + INT64 = 8; + + UINT8 = 9; + + UINT16 = 10; + + UINT32 = 11; + + UINT64 = 12; + } + + // The data type of tensor. + DataType dtype = 1; + + // Shape of the tensor. + repeated int64 shape = 2; + + // Type specific representations that make it easy to create tensor protos in + // all languages. Only the representation corresponding to "dtype" can + // be set. The values hold the flattened representation of the tensor in + // row major order. + // + // [BOOL][google.aiplatform.master.Tensor.DataType.BOOL] + repeated bool bool_val = 3; + + // [STRING][google.aiplatform.master.Tensor.DataType.STRING] + repeated string string_val = 14; + + // [STRING][google.aiplatform.master.Tensor.DataType.STRING] + repeated bytes bytes_val = 15; + + // [FLOAT][google.aiplatform.master.Tensor.DataType.FLOAT] + repeated float float_val = 5; + + // [DOUBLE][google.aiplatform.master.Tensor.DataType.DOUBLE] + repeated double double_val = 6; + + // [INT_8][google.aiplatform.master.Tensor.DataType.INT8] + // [INT_16][google.aiplatform.master.Tensor.DataType.INT16] + // [INT_32][google.aiplatform.master.Tensor.DataType.INT32] + repeated int32 int_val = 7; + + // [INT64][google.aiplatform.master.Tensor.DataType.INT64] + repeated int64 int64_val = 8; + + // [UINT8][google.aiplatform.master.Tensor.DataType.UINT8] + // [UINT16][google.aiplatform.master.Tensor.DataType.UINT16] + // [UINT32][google.aiplatform.master.Tensor.DataType.UINT32] + repeated uint32 uint_val = 9; + + // [UINT64][google.aiplatform.master.Tensor.DataType.UINT64] + repeated uint64 uint64_val = 10; + + // A list of tensor values. + repeated Tensor list_val = 11; + + // A map of string to tensor. + map struct_val = 12; + + // Serialized raw tensor content. + bytes tensor_val = 13; +} diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/prediction_service.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/prediction_service.proto index c96f0f24112..6a1c720d240 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/prediction_service.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/prediction_service.proto @@ -22,6 +22,7 @@ import "google/api/field_behavior.proto"; import "google/api/httpbody.proto"; import "google/api/resource.proto"; import "google/cloud/aiplatform/v1beta1/explanation.proto"; +import "google/cloud/aiplatform/v1beta1/types.proto"; import "google/protobuf/struct.proto"; option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1"; @@ -74,6 +75,20 @@ service PredictionService { option (google.api.method_signature) = "endpoint,http_body"; } + // Perform a server-side streaming online prediction request for Vertex + // LLM streaming. + rpc ServerStreamingPredict(StreamingPredictRequest) + returns (stream StreamingPredictResponse) { + option (google.api.http) = { + post: "/v1beta1/{endpoint=projects/*/locations/*/endpoints/*}:serverStreamingPredict" + body: "*" + additional_bindings { + post: "/v1beta1/{endpoint=projects/*/locations/*/publishers/*/models/*}:serverStreamingPredict" + body: "*" + } + }; + } + // Perform an online explanation. // // If @@ -160,6 +175,11 @@ message PredictResponse { // name][google.cloud.aiplatform.v1beta1.Model.display_name] of the Model // which is deployed as the DeployedModel that this prediction hits. string model_display_name = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Request-level metadata returned by the model. The metadata + // type will be dependent upon the model implementation. + google.protobuf.Value metadata = 6 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // Request message for @@ -193,6 +213,41 @@ message RawPredictRequest { google.api.HttpBody http_body = 2; } +// Request message for +// [PredictionService.StreamingPredict][google.cloud.aiplatform.v1beta1.PredictionService.StreamingPredict]. +// +// The first message must contain +// [endpoint][google.cloud.aiplatform.v1beta1.StreamingPredictRequest.endpoint] +// field and optionally [input][]. The subsequent messages must contain +// [input][]. +message StreamingPredictRequest { + // Required. The name of the Endpoint requested to serve the prediction. + // Format: + // `projects/{project}/locations/{location}/endpoints/{endpoint}` + string endpoint = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "aiplatform.googleapis.com/Endpoint" + } + ]; + + // The prediction input. + repeated Tensor inputs = 2; + + // The parameters that govern the prediction. + Tensor parameters = 3; +} + +// Response message for +// [PredictionService.StreamingPredict][google.cloud.aiplatform.v1beta1.PredictionService.StreamingPredict]. +message StreamingPredictResponse { + // The prediction output. + repeated Tensor outputs = 1; + + // The parameters that govern the prediction. + Tensor parameters = 2; +} + // Request message for // [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain]. message ExplainRequest { diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/types.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/types.proto index 48e3d118ef9..721f13f9297 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/types.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/types.proto @@ -47,3 +47,90 @@ message StringArray { // A list of string values. repeated string values = 1; } + +// A tensor value type. +message Tensor { + // Data type of the tensor. + enum DataType { + // Not a legal value for DataType. Used to indicate a DataType field has not + // been set. + DATA_TYPE_UNSPECIFIED = 0; + + // Data types that all computation devices are expected to be + // capable to support. + BOOL = 1; + + STRING = 2; + + FLOAT = 3; + + DOUBLE = 4; + + INT8 = 5; + + INT16 = 6; + + INT32 = 7; + + INT64 = 8; + + UINT8 = 9; + + UINT16 = 10; + + UINT32 = 11; + + UINT64 = 12; + } + + // The data type of tensor. + DataType dtype = 1; + + // Shape of the tensor. + repeated int64 shape = 2; + + // Type specific representations that make it easy to create tensor protos in + // all languages. Only the representation corresponding to "dtype" can + // be set. The values hold the flattened representation of the tensor in + // row major order. + // + // [BOOL][google.aiplatform.master.Tensor.DataType.BOOL] + repeated bool bool_val = 3; + + // [STRING][google.aiplatform.master.Tensor.DataType.STRING] + repeated string string_val = 14; + + // [STRING][google.aiplatform.master.Tensor.DataType.STRING] + repeated bytes bytes_val = 15; + + // [FLOAT][google.aiplatform.master.Tensor.DataType.FLOAT] + repeated float float_val = 5; + + // [DOUBLE][google.aiplatform.master.Tensor.DataType.DOUBLE] + repeated double double_val = 6; + + // [INT_8][google.aiplatform.master.Tensor.DataType.INT8] + // [INT_16][google.aiplatform.master.Tensor.DataType.INT16] + // [INT_32][google.aiplatform.master.Tensor.DataType.INT32] + repeated int32 int_val = 7; + + // [INT64][google.aiplatform.master.Tensor.DataType.INT64] + repeated int64 int64_val = 8; + + // [UINT8][google.aiplatform.master.Tensor.DataType.UINT8] + // [UINT16][google.aiplatform.master.Tensor.DataType.UINT16] + // [UINT32][google.aiplatform.master.Tensor.DataType.UINT32] + repeated uint32 uint_val = 9; + + // [UINT64][google.aiplatform.master.Tensor.DataType.UINT64] + repeated uint64 uint64_val = 10; + + // A list of tensor values. + repeated Tensor list_val = 11; + + // A map of string to tensor. + map struct_val = 12; + + // Serialized raw tensor content. + bytes tensor_val = 13; +} diff --git a/packages/google-cloud-aiplatform/protos/protos.d.ts b/packages/google-cloud-aiplatform/protos/protos.d.ts index 3385bfc683c..9513018976c 100644 --- a/packages/google-cloud-aiplatform/protos/protos.d.ts +++ b/packages/google-cloud-aiplatform/protos/protos.d.ts @@ -19857,6 +19857,201 @@ export namespace google { public static getTypeUrl(typeUrlPrefix?: string): string; } + /** Properties of a Tensor. */ + interface ITensor { + + /** Tensor dtype */ + dtype?: (google.cloud.aiplatform.v1.Tensor.DataType|keyof typeof google.cloud.aiplatform.v1.Tensor.DataType|null); + + /** Tensor shape */ + shape?: ((number|Long|string)[]|null); + + /** Tensor boolVal */ + boolVal?: (boolean[]|null); + + /** Tensor stringVal */ + stringVal?: (string[]|null); + + /** Tensor bytesVal */ + bytesVal?: (Uint8Array[]|null); + + /** Tensor floatVal */ + floatVal?: (number[]|null); + + /** Tensor doubleVal */ + doubleVal?: (number[]|null); + + /** Tensor intVal */ + intVal?: (number[]|null); + + /** Tensor int64Val */ + int64Val?: ((number|Long|string)[]|null); + + /** Tensor uintVal */ + uintVal?: (number[]|null); + + /** Tensor uint64Val */ + uint64Val?: ((number|Long|string)[]|null); + + /** Tensor listVal */ + listVal?: (google.cloud.aiplatform.v1.ITensor[]|null); + + /** Tensor structVal */ + structVal?: ({ [k: string]: google.cloud.aiplatform.v1.ITensor }|null); + + /** Tensor tensorVal */ + tensorVal?: (Uint8Array|string|null); + } + + /** Represents a Tensor. */ + class Tensor implements ITensor { + + /** + * Constructs a new Tensor. + * @param [properties] Properties to set + */ + constructor(properties?: google.cloud.aiplatform.v1.ITensor); + + /** Tensor dtype. */ + public dtype: (google.cloud.aiplatform.v1.Tensor.DataType|keyof typeof google.cloud.aiplatform.v1.Tensor.DataType); + + /** Tensor shape. */ + public shape: (number|Long|string)[]; + + /** Tensor boolVal. */ + public boolVal: boolean[]; + + /** Tensor stringVal. */ + public stringVal: string[]; + + /** Tensor bytesVal. */ + public bytesVal: Uint8Array[]; + + /** Tensor floatVal. */ + public floatVal: number[]; + + /** Tensor doubleVal. */ + public doubleVal: number[]; + + /** Tensor intVal. */ + public intVal: number[]; + + /** Tensor int64Val. */ + public int64Val: (number|Long|string)[]; + + /** Tensor uintVal. */ + public uintVal: number[]; + + /** Tensor uint64Val. */ + public uint64Val: (number|Long|string)[]; + + /** Tensor listVal. */ + public listVal: google.cloud.aiplatform.v1.ITensor[]; + + /** Tensor structVal. */ + public structVal: { [k: string]: google.cloud.aiplatform.v1.ITensor }; + + /** Tensor tensorVal. */ + public tensorVal: (Uint8Array|string); + + /** + * Creates a new Tensor instance using the specified properties. + * @param [properties] Properties to set + * @returns Tensor instance + */ + public static create(properties?: google.cloud.aiplatform.v1.ITensor): google.cloud.aiplatform.v1.Tensor; + + /** + * Encodes the specified Tensor message. Does not implicitly {@link google.cloud.aiplatform.v1.Tensor.verify|verify} messages. + * @param message Tensor message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encode(message: google.cloud.aiplatform.v1.ITensor, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Encodes the specified Tensor message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.Tensor.verify|verify} messages. + * @param message Tensor message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encodeDelimited(message: google.cloud.aiplatform.v1.ITensor, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Decodes a Tensor message from the specified reader or buffer. + * @param reader Reader or buffer to decode from + * @param [length] Message length if known beforehand + * @returns Tensor + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.Tensor; + + /** + * Decodes a Tensor message from the specified reader or buffer, length delimited. + * @param reader Reader or buffer to decode from + * @returns Tensor + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.Tensor; + + /** + * Verifies a Tensor message. + * @param message Plain object to verify + * @returns `null` if valid, otherwise the reason why it is not + */ + public static verify(message: { [k: string]: any }): (string|null); + + /** + * Creates a Tensor message from a plain object. Also converts values to their respective internal types. + * @param object Plain object + * @returns Tensor + */ + public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.Tensor; + + /** + * Creates a plain object from a Tensor message. Also converts values to other types if specified. + * @param message Tensor + * @param [options] Conversion options + * @returns Plain object + */ + public static toObject(message: google.cloud.aiplatform.v1.Tensor, options?: $protobuf.IConversionOptions): { [k: string]: any }; + + /** + * Converts this Tensor to JSON. + * @returns JSON object + */ + public toJSON(): { [k: string]: any }; + + /** + * Gets the default type url for Tensor + * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns The default type url + */ + public static getTypeUrl(typeUrlPrefix?: string): string; + } + + namespace Tensor { + + /** DataType enum. */ + enum DataType { + DATA_TYPE_UNSPECIFIED = 0, + BOOL = 1, + STRING = 2, + FLOAT = 3, + DOUBLE = 4, + INT8 = 5, + INT16 = 6, + INT32 = 7, + INT64 = 8, + UINT8 = 9, + UINT16 = 10, + UINT32 = 11, + UINT64 = 12 + } + } + /** Represents a FeaturestoreService */ class FeaturestoreService extends $protobuf.rpc.Service { @@ -60980,6 +61175,20 @@ export namespace google { */ public rawPredict(request: google.cloud.aiplatform.v1.IRawPredictRequest): Promise; + /** + * Calls ServerStreamingPredict. + * @param request StreamingPredictRequest message or plain object + * @param callback Node-style callback called with the error, if any, and StreamingPredictResponse + */ + public serverStreamingPredict(request: google.cloud.aiplatform.v1.IStreamingPredictRequest, callback: google.cloud.aiplatform.v1.PredictionService.ServerStreamingPredictCallback): void; + + /** + * Calls ServerStreamingPredict. + * @param request StreamingPredictRequest message or plain object + * @returns Promise + */ + public serverStreamingPredict(request: google.cloud.aiplatform.v1.IStreamingPredictRequest): Promise; + /** * Calls Explain. * @param request ExplainRequest message or plain object @@ -61011,6 +61220,13 @@ export namespace google { */ type RawPredictCallback = (error: (Error|null), response?: google.api.HttpBody) => void; + /** + * Callback as used by {@link google.cloud.aiplatform.v1.PredictionService|serverStreamingPredict}. + * @param error Error, if any + * @param [response] StreamingPredictResponse + */ + type ServerStreamingPredictCallback = (error: (Error|null), response?: google.cloud.aiplatform.v1.StreamingPredictResponse) => void; + /** * Callback as used by {@link google.cloud.aiplatform.v1.PredictionService|explain}. * @param error Error, if any @@ -61145,6 +61361,9 @@ export namespace google { /** PredictResponse modelDisplayName */ modelDisplayName?: (string|null); + + /** PredictResponse metadata */ + metadata?: (google.protobuf.IValue|null); } /** Represents a PredictResponse. */ @@ -61165,417 +61384,1946 @@ export namespace google { /** PredictResponse model. */ public model: string; - /** PredictResponse modelVersionId. */ - public modelVersionId: string; + /** PredictResponse modelVersionId. */ + public modelVersionId: string; + + /** PredictResponse modelDisplayName. */ + public modelDisplayName: string; + + /** PredictResponse metadata. */ + public metadata?: (google.protobuf.IValue|null); + + /** + * Creates a new PredictResponse instance using the specified properties. + * @param [properties] Properties to set + * @returns PredictResponse instance + */ + public static create(properties?: google.cloud.aiplatform.v1.IPredictResponse): google.cloud.aiplatform.v1.PredictResponse; + + /** + * Encodes the specified PredictResponse message. Does not implicitly {@link google.cloud.aiplatform.v1.PredictResponse.verify|verify} messages. + * @param message PredictResponse message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encode(message: google.cloud.aiplatform.v1.IPredictResponse, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Encodes the specified PredictResponse message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.PredictResponse.verify|verify} messages. + * @param message PredictResponse message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encodeDelimited(message: google.cloud.aiplatform.v1.IPredictResponse, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Decodes a PredictResponse message from the specified reader or buffer. + * @param reader Reader or buffer to decode from + * @param [length] Message length if known beforehand + * @returns PredictResponse + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.PredictResponse; + + /** + * Decodes a PredictResponse message from the specified reader or buffer, length delimited. + * @param reader Reader or buffer to decode from + * @returns PredictResponse + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.PredictResponse; + + /** + * Verifies a PredictResponse message. + * @param message Plain object to verify + * @returns `null` if valid, otherwise the reason why it is not + */ + public static verify(message: { [k: string]: any }): (string|null); + + /** + * Creates a PredictResponse message from a plain object. Also converts values to their respective internal types. + * @param object Plain object + * @returns PredictResponse + */ + public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.PredictResponse; + + /** + * Creates a plain object from a PredictResponse message. Also converts values to other types if specified. + * @param message PredictResponse + * @param [options] Conversion options + * @returns Plain object + */ + public static toObject(message: google.cloud.aiplatform.v1.PredictResponse, options?: $protobuf.IConversionOptions): { [k: string]: any }; + + /** + * Converts this PredictResponse to JSON. + * @returns JSON object + */ + public toJSON(): { [k: string]: any }; + + /** + * Gets the default type url for PredictResponse + * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns The default type url + */ + public static getTypeUrl(typeUrlPrefix?: string): string; + } + + /** Properties of a RawPredictRequest. */ + interface IRawPredictRequest { + + /** RawPredictRequest endpoint */ + endpoint?: (string|null); + + /** RawPredictRequest httpBody */ + httpBody?: (google.api.IHttpBody|null); + } + + /** Represents a RawPredictRequest. */ + class RawPredictRequest implements IRawPredictRequest { + + /** + * Constructs a new RawPredictRequest. + * @param [properties] Properties to set + */ + constructor(properties?: google.cloud.aiplatform.v1.IRawPredictRequest); + + /** RawPredictRequest endpoint. */ + public endpoint: string; + + /** RawPredictRequest httpBody. */ + public httpBody?: (google.api.IHttpBody|null); + + /** + * Creates a new RawPredictRequest instance using the specified properties. + * @param [properties] Properties to set + * @returns RawPredictRequest instance + */ + public static create(properties?: google.cloud.aiplatform.v1.IRawPredictRequest): google.cloud.aiplatform.v1.RawPredictRequest; + + /** + * Encodes the specified RawPredictRequest message. Does not implicitly {@link google.cloud.aiplatform.v1.RawPredictRequest.verify|verify} messages. + * @param message RawPredictRequest message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encode(message: google.cloud.aiplatform.v1.IRawPredictRequest, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Encodes the specified RawPredictRequest message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.RawPredictRequest.verify|verify} messages. + * @param message RawPredictRequest message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encodeDelimited(message: google.cloud.aiplatform.v1.IRawPredictRequest, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Decodes a RawPredictRequest message from the specified reader or buffer. + * @param reader Reader or buffer to decode from + * @param [length] Message length if known beforehand + * @returns RawPredictRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.RawPredictRequest; + + /** + * Decodes a RawPredictRequest message from the specified reader or buffer, length delimited. + * @param reader Reader or buffer to decode from + * @returns RawPredictRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.RawPredictRequest; + + /** + * Verifies a RawPredictRequest message. + * @param message Plain object to verify + * @returns `null` if valid, otherwise the reason why it is not + */ + public static verify(message: { [k: string]: any }): (string|null); + + /** + * Creates a RawPredictRequest message from a plain object. Also converts values to their respective internal types. + * @param object Plain object + * @returns RawPredictRequest + */ + public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.RawPredictRequest; + + /** + * Creates a plain object from a RawPredictRequest message. Also converts values to other types if specified. + * @param message RawPredictRequest + * @param [options] Conversion options + * @returns Plain object + */ + public static toObject(message: google.cloud.aiplatform.v1.RawPredictRequest, options?: $protobuf.IConversionOptions): { [k: string]: any }; + + /** + * Converts this RawPredictRequest to JSON. + * @returns JSON object + */ + public toJSON(): { [k: string]: any }; + + /** + * Gets the default type url for RawPredictRequest + * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns The default type url + */ + public static getTypeUrl(typeUrlPrefix?: string): string; + } + + /** Properties of a StreamingPredictRequest. */ + interface IStreamingPredictRequest { + + /** StreamingPredictRequest endpoint */ + endpoint?: (string|null); + + /** StreamingPredictRequest inputs */ + inputs?: (google.cloud.aiplatform.v1.ITensor[]|null); + + /** StreamingPredictRequest parameters */ + parameters?: (google.cloud.aiplatform.v1.ITensor|null); + } + + /** Represents a StreamingPredictRequest. */ + class StreamingPredictRequest implements IStreamingPredictRequest { + + /** + * Constructs a new StreamingPredictRequest. + * @param [properties] Properties to set + */ + constructor(properties?: google.cloud.aiplatform.v1.IStreamingPredictRequest); + + /** StreamingPredictRequest endpoint. */ + public endpoint: string; + + /** StreamingPredictRequest inputs. */ + public inputs: google.cloud.aiplatform.v1.ITensor[]; + + /** StreamingPredictRequest parameters. */ + public parameters?: (google.cloud.aiplatform.v1.ITensor|null); + + /** + * Creates a new StreamingPredictRequest instance using the specified properties. + * @param [properties] Properties to set + * @returns StreamingPredictRequest instance + */ + public static create(properties?: google.cloud.aiplatform.v1.IStreamingPredictRequest): google.cloud.aiplatform.v1.StreamingPredictRequest; + + /** + * Encodes the specified StreamingPredictRequest message. Does not implicitly {@link google.cloud.aiplatform.v1.StreamingPredictRequest.verify|verify} messages. + * @param message StreamingPredictRequest message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encode(message: google.cloud.aiplatform.v1.IStreamingPredictRequest, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Encodes the specified StreamingPredictRequest message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.StreamingPredictRequest.verify|verify} messages. + * @param message StreamingPredictRequest message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encodeDelimited(message: google.cloud.aiplatform.v1.IStreamingPredictRequest, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Decodes a StreamingPredictRequest message from the specified reader or buffer. + * @param reader Reader or buffer to decode from + * @param [length] Message length if known beforehand + * @returns StreamingPredictRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.StreamingPredictRequest; + + /** + * Decodes a StreamingPredictRequest message from the specified reader or buffer, length delimited. + * @param reader Reader or buffer to decode from + * @returns StreamingPredictRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.StreamingPredictRequest; + + /** + * Verifies a StreamingPredictRequest message. + * @param message Plain object to verify + * @returns `null` if valid, otherwise the reason why it is not + */ + public static verify(message: { [k: string]: any }): (string|null); + + /** + * Creates a StreamingPredictRequest message from a plain object. Also converts values to their respective internal types. + * @param object Plain object + * @returns StreamingPredictRequest + */ + public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.StreamingPredictRequest; + + /** + * Creates a plain object from a StreamingPredictRequest message. Also converts values to other types if specified. + * @param message StreamingPredictRequest + * @param [options] Conversion options + * @returns Plain object + */ + public static toObject(message: google.cloud.aiplatform.v1.StreamingPredictRequest, options?: $protobuf.IConversionOptions): { [k: string]: any }; + + /** + * Converts this StreamingPredictRequest to JSON. + * @returns JSON object + */ + public toJSON(): { [k: string]: any }; + + /** + * Gets the default type url for StreamingPredictRequest + * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns The default type url + */ + public static getTypeUrl(typeUrlPrefix?: string): string; + } + + /** Properties of a StreamingPredictResponse. */ + interface IStreamingPredictResponse { + + /** StreamingPredictResponse outputs */ + outputs?: (google.cloud.aiplatform.v1.ITensor[]|null); + + /** StreamingPredictResponse parameters */ + parameters?: (google.cloud.aiplatform.v1.ITensor|null); + } + + /** Represents a StreamingPredictResponse. */ + class StreamingPredictResponse implements IStreamingPredictResponse { + + /** + * Constructs a new StreamingPredictResponse. + * @param [properties] Properties to set + */ + constructor(properties?: google.cloud.aiplatform.v1.IStreamingPredictResponse); + + /** StreamingPredictResponse outputs. */ + public outputs: google.cloud.aiplatform.v1.ITensor[]; + + /** StreamingPredictResponse parameters. */ + public parameters?: (google.cloud.aiplatform.v1.ITensor|null); + + /** + * Creates a new StreamingPredictResponse instance using the specified properties. + * @param [properties] Properties to set + * @returns StreamingPredictResponse instance + */ + public static create(properties?: google.cloud.aiplatform.v1.IStreamingPredictResponse): google.cloud.aiplatform.v1.StreamingPredictResponse; + + /** + * Encodes the specified StreamingPredictResponse message. Does not implicitly {@link google.cloud.aiplatform.v1.StreamingPredictResponse.verify|verify} messages. + * @param message StreamingPredictResponse message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encode(message: google.cloud.aiplatform.v1.IStreamingPredictResponse, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Encodes the specified StreamingPredictResponse message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.StreamingPredictResponse.verify|verify} messages. + * @param message StreamingPredictResponse message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encodeDelimited(message: google.cloud.aiplatform.v1.IStreamingPredictResponse, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Decodes a StreamingPredictResponse message from the specified reader or buffer. + * @param reader Reader or buffer to decode from + * @param [length] Message length if known beforehand + * @returns StreamingPredictResponse + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.StreamingPredictResponse; + + /** + * Decodes a StreamingPredictResponse message from the specified reader or buffer, length delimited. + * @param reader Reader or buffer to decode from + * @returns StreamingPredictResponse + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.StreamingPredictResponse; + + /** + * Verifies a StreamingPredictResponse message. + * @param message Plain object to verify + * @returns `null` if valid, otherwise the reason why it is not + */ + public static verify(message: { [k: string]: any }): (string|null); + + /** + * Creates a StreamingPredictResponse message from a plain object. Also converts values to their respective internal types. + * @param object Plain object + * @returns StreamingPredictResponse + */ + public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.StreamingPredictResponse; + + /** + * Creates a plain object from a StreamingPredictResponse message. Also converts values to other types if specified. + * @param message StreamingPredictResponse + * @param [options] Conversion options + * @returns Plain object + */ + public static toObject(message: google.cloud.aiplatform.v1.StreamingPredictResponse, options?: $protobuf.IConversionOptions): { [k: string]: any }; + + /** + * Converts this StreamingPredictResponse to JSON. + * @returns JSON object + */ + public toJSON(): { [k: string]: any }; + + /** + * Gets the default type url for StreamingPredictResponse + * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns The default type url + */ + public static getTypeUrl(typeUrlPrefix?: string): string; + } + + /** Properties of an ExplainRequest. */ + interface IExplainRequest { + + /** ExplainRequest endpoint */ + endpoint?: (string|null); + + /** ExplainRequest instances */ + instances?: (google.protobuf.IValue[]|null); + + /** ExplainRequest parameters */ + parameters?: (google.protobuf.IValue|null); + + /** ExplainRequest explanationSpecOverride */ + explanationSpecOverride?: (google.cloud.aiplatform.v1.IExplanationSpecOverride|null); + + /** ExplainRequest deployedModelId */ + deployedModelId?: (string|null); + } + + /** Represents an ExplainRequest. */ + class ExplainRequest implements IExplainRequest { + + /** + * Constructs a new ExplainRequest. + * @param [properties] Properties to set + */ + constructor(properties?: google.cloud.aiplatform.v1.IExplainRequest); + + /** ExplainRequest endpoint. */ + public endpoint: string; + + /** ExplainRequest instances. */ + public instances: google.protobuf.IValue[]; + + /** ExplainRequest parameters. */ + public parameters?: (google.protobuf.IValue|null); + + /** ExplainRequest explanationSpecOverride. */ + public explanationSpecOverride?: (google.cloud.aiplatform.v1.IExplanationSpecOverride|null); + + /** ExplainRequest deployedModelId. */ + public deployedModelId: string; + + /** + * Creates a new ExplainRequest instance using the specified properties. + * @param [properties] Properties to set + * @returns ExplainRequest instance + */ + public static create(properties?: google.cloud.aiplatform.v1.IExplainRequest): google.cloud.aiplatform.v1.ExplainRequest; + + /** + * Encodes the specified ExplainRequest message. Does not implicitly {@link google.cloud.aiplatform.v1.ExplainRequest.verify|verify} messages. + * @param message ExplainRequest message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encode(message: google.cloud.aiplatform.v1.IExplainRequest, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Encodes the specified ExplainRequest message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.ExplainRequest.verify|verify} messages. + * @param message ExplainRequest message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encodeDelimited(message: google.cloud.aiplatform.v1.IExplainRequest, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Decodes an ExplainRequest message from the specified reader or buffer. + * @param reader Reader or buffer to decode from + * @param [length] Message length if known beforehand + * @returns ExplainRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.ExplainRequest; + + /** + * Decodes an ExplainRequest message from the specified reader or buffer, length delimited. + * @param reader Reader or buffer to decode from + * @returns ExplainRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.ExplainRequest; + + /** + * Verifies an ExplainRequest message. + * @param message Plain object to verify + * @returns `null` if valid, otherwise the reason why it is not + */ + public static verify(message: { [k: string]: any }): (string|null); + + /** + * Creates an ExplainRequest message from a plain object. Also converts values to their respective internal types. + * @param object Plain object + * @returns ExplainRequest + */ + public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.ExplainRequest; + + /** + * Creates a plain object from an ExplainRequest message. Also converts values to other types if specified. + * @param message ExplainRequest + * @param [options] Conversion options + * @returns Plain object + */ + public static toObject(message: google.cloud.aiplatform.v1.ExplainRequest, options?: $protobuf.IConversionOptions): { [k: string]: any }; + + /** + * Converts this ExplainRequest to JSON. + * @returns JSON object + */ + public toJSON(): { [k: string]: any }; + + /** + * Gets the default type url for ExplainRequest + * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns The default type url + */ + public static getTypeUrl(typeUrlPrefix?: string): string; + } + + /** Properties of an ExplainResponse. */ + interface IExplainResponse { + + /** ExplainResponse explanations */ + explanations?: (google.cloud.aiplatform.v1.IExplanation[]|null); + + /** ExplainResponse deployedModelId */ + deployedModelId?: (string|null); + + /** ExplainResponse predictions */ + predictions?: (google.protobuf.IValue[]|null); + } + + /** Represents an ExplainResponse. */ + class ExplainResponse implements IExplainResponse { + + /** + * Constructs a new ExplainResponse. + * @param [properties] Properties to set + */ + constructor(properties?: google.cloud.aiplatform.v1.IExplainResponse); + + /** ExplainResponse explanations. */ + public explanations: google.cloud.aiplatform.v1.IExplanation[]; + + /** ExplainResponse deployedModelId. */ + public deployedModelId: string; + + /** ExplainResponse predictions. */ + public predictions: google.protobuf.IValue[]; + + /** + * Creates a new ExplainResponse instance using the specified properties. + * @param [properties] Properties to set + * @returns ExplainResponse instance + */ + public static create(properties?: google.cloud.aiplatform.v1.IExplainResponse): google.cloud.aiplatform.v1.ExplainResponse; + + /** + * Encodes the specified ExplainResponse message. Does not implicitly {@link google.cloud.aiplatform.v1.ExplainResponse.verify|verify} messages. + * @param message ExplainResponse message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encode(message: google.cloud.aiplatform.v1.IExplainResponse, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Encodes the specified ExplainResponse message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.ExplainResponse.verify|verify} messages. + * @param message ExplainResponse message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encodeDelimited(message: google.cloud.aiplatform.v1.IExplainResponse, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Decodes an ExplainResponse message from the specified reader or buffer. + * @param reader Reader or buffer to decode from + * @param [length] Message length if known beforehand + * @returns ExplainResponse + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.ExplainResponse; + + /** + * Decodes an ExplainResponse message from the specified reader or buffer, length delimited. + * @param reader Reader or buffer to decode from + * @returns ExplainResponse + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.ExplainResponse; + + /** + * Verifies an ExplainResponse message. + * @param message Plain object to verify + * @returns `null` if valid, otherwise the reason why it is not + */ + public static verify(message: { [k: string]: any }): (string|null); + + /** + * Creates an ExplainResponse message from a plain object. Also converts values to their respective internal types. + * @param object Plain object + * @returns ExplainResponse + */ + public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.ExplainResponse; + + /** + * Creates a plain object from an ExplainResponse message. Also converts values to other types if specified. + * @param message ExplainResponse + * @param [options] Conversion options + * @returns Plain object + */ + public static toObject(message: google.cloud.aiplatform.v1.ExplainResponse, options?: $protobuf.IConversionOptions): { [k: string]: any }; + + /** + * Converts this ExplainResponse to JSON. + * @returns JSON object + */ + public toJSON(): { [k: string]: any }; + + /** + * Gets the default type url for ExplainResponse + * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns The default type url + */ + public static getTypeUrl(typeUrlPrefix?: string): string; + } + + /** Properties of a Schedule. */ + interface ISchedule { + + /** Schedule cron */ + cron?: (string|null); + + /** Schedule createPipelineJobRequest */ + createPipelineJobRequest?: (google.cloud.aiplatform.v1.ICreatePipelineJobRequest|null); + + /** Schedule name */ + name?: (string|null); + + /** Schedule displayName */ + displayName?: (string|null); + + /** Schedule startTime */ + startTime?: (google.protobuf.ITimestamp|null); + + /** Schedule endTime */ + endTime?: (google.protobuf.ITimestamp|null); + + /** Schedule maxRunCount */ + maxRunCount?: (number|Long|string|null); + + /** Schedule startedRunCount */ + startedRunCount?: (number|Long|string|null); + + /** Schedule state */ + state?: (google.cloud.aiplatform.v1.Schedule.State|keyof typeof google.cloud.aiplatform.v1.Schedule.State|null); + + /** Schedule createTime */ + createTime?: (google.protobuf.ITimestamp|null); + + /** Schedule updateTime */ + updateTime?: (google.protobuf.ITimestamp|null); + + /** Schedule nextRunTime */ + nextRunTime?: (google.protobuf.ITimestamp|null); + + /** Schedule lastPauseTime */ + lastPauseTime?: (google.protobuf.ITimestamp|null); + + /** Schedule lastResumeTime */ + lastResumeTime?: (google.protobuf.ITimestamp|null); + + /** Schedule maxConcurrentRunCount */ + maxConcurrentRunCount?: (number|Long|string|null); + + /** Schedule allowQueueing */ + allowQueueing?: (boolean|null); + + /** Schedule catchUp */ + catchUp?: (boolean|null); + + /** Schedule lastScheduledRunResponse */ + lastScheduledRunResponse?: (google.cloud.aiplatform.v1.Schedule.IRunResponse|null); + } + + /** Represents a Schedule. */ + class Schedule implements ISchedule { + + /** + * Constructs a new Schedule. + * @param [properties] Properties to set + */ + constructor(properties?: google.cloud.aiplatform.v1.ISchedule); + + /** Schedule cron. */ + public cron?: (string|null); + + /** Schedule createPipelineJobRequest. */ + public createPipelineJobRequest?: (google.cloud.aiplatform.v1.ICreatePipelineJobRequest|null); + + /** Schedule name. */ + public name: string; + + /** Schedule displayName. */ + public displayName: string; + + /** Schedule startTime. */ + public startTime?: (google.protobuf.ITimestamp|null); + + /** Schedule endTime. */ + public endTime?: (google.protobuf.ITimestamp|null); + + /** Schedule maxRunCount. */ + public maxRunCount: (number|Long|string); + + /** Schedule startedRunCount. */ + public startedRunCount: (number|Long|string); + + /** Schedule state. */ + public state: (google.cloud.aiplatform.v1.Schedule.State|keyof typeof google.cloud.aiplatform.v1.Schedule.State); + + /** Schedule createTime. */ + public createTime?: (google.protobuf.ITimestamp|null); + + /** Schedule updateTime. */ + public updateTime?: (google.protobuf.ITimestamp|null); + + /** Schedule nextRunTime. */ + public nextRunTime?: (google.protobuf.ITimestamp|null); + + /** Schedule lastPauseTime. */ + public lastPauseTime?: (google.protobuf.ITimestamp|null); + + /** Schedule lastResumeTime. */ + public lastResumeTime?: (google.protobuf.ITimestamp|null); + + /** Schedule maxConcurrentRunCount. */ + public maxConcurrentRunCount: (number|Long|string); + + /** Schedule allowQueueing. */ + public allowQueueing: boolean; + + /** Schedule catchUp. */ + public catchUp: boolean; + + /** Schedule lastScheduledRunResponse. */ + public lastScheduledRunResponse?: (google.cloud.aiplatform.v1.Schedule.IRunResponse|null); + + /** Schedule timeSpecification. */ + public timeSpecification?: "cron"; + + /** Schedule request. */ + public request?: "createPipelineJobRequest"; + + /** + * Creates a new Schedule instance using the specified properties. + * @param [properties] Properties to set + * @returns Schedule instance + */ + public static create(properties?: google.cloud.aiplatform.v1.ISchedule): google.cloud.aiplatform.v1.Schedule; + + /** + * Encodes the specified Schedule message. Does not implicitly {@link google.cloud.aiplatform.v1.Schedule.verify|verify} messages. + * @param message Schedule message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encode(message: google.cloud.aiplatform.v1.ISchedule, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Encodes the specified Schedule message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.Schedule.verify|verify} messages. + * @param message Schedule message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encodeDelimited(message: google.cloud.aiplatform.v1.ISchedule, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Decodes a Schedule message from the specified reader or buffer. + * @param reader Reader or buffer to decode from + * @param [length] Message length if known beforehand + * @returns Schedule + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.Schedule; + + /** + * Decodes a Schedule message from the specified reader or buffer, length delimited. + * @param reader Reader or buffer to decode from + * @returns Schedule + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.Schedule; + + /** + * Verifies a Schedule message. + * @param message Plain object to verify + * @returns `null` if valid, otherwise the reason why it is not + */ + public static verify(message: { [k: string]: any }): (string|null); + + /** + * Creates a Schedule message from a plain object. Also converts values to their respective internal types. + * @param object Plain object + * @returns Schedule + */ + public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.Schedule; + + /** + * Creates a plain object from a Schedule message. Also converts values to other types if specified. + * @param message Schedule + * @param [options] Conversion options + * @returns Plain object + */ + public static toObject(message: google.cloud.aiplatform.v1.Schedule, options?: $protobuf.IConversionOptions): { [k: string]: any }; + + /** + * Converts this Schedule to JSON. + * @returns JSON object + */ + public toJSON(): { [k: string]: any }; + + /** + * Gets the default type url for Schedule + * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns The default type url + */ + public static getTypeUrl(typeUrlPrefix?: string): string; + } + + namespace Schedule { + + /** Properties of a RunResponse. */ + interface IRunResponse { + + /** RunResponse scheduledRunTime */ + scheduledRunTime?: (google.protobuf.ITimestamp|null); + + /** RunResponse runResponse */ + runResponse?: (string|null); + } + + /** Represents a RunResponse. */ + class RunResponse implements IRunResponse { + + /** + * Constructs a new RunResponse. + * @param [properties] Properties to set + */ + constructor(properties?: google.cloud.aiplatform.v1.Schedule.IRunResponse); + + /** RunResponse scheduledRunTime. */ + public scheduledRunTime?: (google.protobuf.ITimestamp|null); + + /** RunResponse runResponse. */ + public runResponse: string; + + /** + * Creates a new RunResponse instance using the specified properties. + * @param [properties] Properties to set + * @returns RunResponse instance + */ + public static create(properties?: google.cloud.aiplatform.v1.Schedule.IRunResponse): google.cloud.aiplatform.v1.Schedule.RunResponse; + + /** + * Encodes the specified RunResponse message. Does not implicitly {@link google.cloud.aiplatform.v1.Schedule.RunResponse.verify|verify} messages. + * @param message RunResponse message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encode(message: google.cloud.aiplatform.v1.Schedule.IRunResponse, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Encodes the specified RunResponse message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.Schedule.RunResponse.verify|verify} messages. + * @param message RunResponse message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encodeDelimited(message: google.cloud.aiplatform.v1.Schedule.IRunResponse, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Decodes a RunResponse message from the specified reader or buffer. + * @param reader Reader or buffer to decode from + * @param [length] Message length if known beforehand + * @returns RunResponse + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.Schedule.RunResponse; + + /** + * Decodes a RunResponse message from the specified reader or buffer, length delimited. + * @param reader Reader or buffer to decode from + * @returns RunResponse + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.Schedule.RunResponse; + + /** + * Verifies a RunResponse message. + * @param message Plain object to verify + * @returns `null` if valid, otherwise the reason why it is not + */ + public static verify(message: { [k: string]: any }): (string|null); + + /** + * Creates a RunResponse message from a plain object. Also converts values to their respective internal types. + * @param object Plain object + * @returns RunResponse + */ + public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.Schedule.RunResponse; + + /** + * Creates a plain object from a RunResponse message. Also converts values to other types if specified. + * @param message RunResponse + * @param [options] Conversion options + * @returns Plain object + */ + public static toObject(message: google.cloud.aiplatform.v1.Schedule.RunResponse, options?: $protobuf.IConversionOptions): { [k: string]: any }; + + /** + * Converts this RunResponse to JSON. + * @returns JSON object + */ + public toJSON(): { [k: string]: any }; + + /** + * Gets the default type url for RunResponse + * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns The default type url + */ + public static getTypeUrl(typeUrlPrefix?: string): string; + } + + /** State enum. */ + enum State { + STATE_UNSPECIFIED = 0, + ACTIVE = 1, + PAUSED = 2, + COMPLETED = 3 + } + } + + /** Represents a ScheduleService */ + class ScheduleService extends $protobuf.rpc.Service { + + /** + * Constructs a new ScheduleService service. + * @param rpcImpl RPC implementation + * @param [requestDelimited=false] Whether requests are length-delimited + * @param [responseDelimited=false] Whether responses are length-delimited + */ + constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean); + + /** + * Creates new ScheduleService service using the specified rpc implementation. + * @param rpcImpl RPC implementation + * @param [requestDelimited=false] Whether requests are length-delimited + * @param [responseDelimited=false] Whether responses are length-delimited + * @returns RPC service. Useful where requests and/or responses are streamed. + */ + public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): ScheduleService; + + /** + * Calls CreateSchedule. + * @param request CreateScheduleRequest message or plain object + * @param callback Node-style callback called with the error, if any, and Schedule + */ + public createSchedule(request: google.cloud.aiplatform.v1.ICreateScheduleRequest, callback: google.cloud.aiplatform.v1.ScheduleService.CreateScheduleCallback): void; + + /** + * Calls CreateSchedule. + * @param request CreateScheduleRequest message or plain object + * @returns Promise + */ + public createSchedule(request: google.cloud.aiplatform.v1.ICreateScheduleRequest): Promise; + + /** + * Calls DeleteSchedule. + * @param request DeleteScheduleRequest message or plain object + * @param callback Node-style callback called with the error, if any, and Operation + */ + public deleteSchedule(request: google.cloud.aiplatform.v1.IDeleteScheduleRequest, callback: google.cloud.aiplatform.v1.ScheduleService.DeleteScheduleCallback): void; + + /** + * Calls DeleteSchedule. + * @param request DeleteScheduleRequest message or plain object + * @returns Promise + */ + public deleteSchedule(request: google.cloud.aiplatform.v1.IDeleteScheduleRequest): Promise; + + /** + * Calls GetSchedule. + * @param request GetScheduleRequest message or plain object + * @param callback Node-style callback called with the error, if any, and Schedule + */ + public getSchedule(request: google.cloud.aiplatform.v1.IGetScheduleRequest, callback: google.cloud.aiplatform.v1.ScheduleService.GetScheduleCallback): void; + + /** + * Calls GetSchedule. + * @param request GetScheduleRequest message or plain object + * @returns Promise + */ + public getSchedule(request: google.cloud.aiplatform.v1.IGetScheduleRequest): Promise; + + /** + * Calls ListSchedules. + * @param request ListSchedulesRequest message or plain object + * @param callback Node-style callback called with the error, if any, and ListSchedulesResponse + */ + public listSchedules(request: google.cloud.aiplatform.v1.IListSchedulesRequest, callback: google.cloud.aiplatform.v1.ScheduleService.ListSchedulesCallback): void; + + /** + * Calls ListSchedules. + * @param request ListSchedulesRequest message or plain object + * @returns Promise + */ + public listSchedules(request: google.cloud.aiplatform.v1.IListSchedulesRequest): Promise; + + /** + * Calls PauseSchedule. + * @param request PauseScheduleRequest message or plain object + * @param callback Node-style callback called with the error, if any, and Empty + */ + public pauseSchedule(request: google.cloud.aiplatform.v1.IPauseScheduleRequest, callback: google.cloud.aiplatform.v1.ScheduleService.PauseScheduleCallback): void; + + /** + * Calls PauseSchedule. + * @param request PauseScheduleRequest message or plain object + * @returns Promise + */ + public pauseSchedule(request: google.cloud.aiplatform.v1.IPauseScheduleRequest): Promise; + + /** + * Calls ResumeSchedule. + * @param request ResumeScheduleRequest message or plain object + * @param callback Node-style callback called with the error, if any, and Empty + */ + public resumeSchedule(request: google.cloud.aiplatform.v1.IResumeScheduleRequest, callback: google.cloud.aiplatform.v1.ScheduleService.ResumeScheduleCallback): void; + + /** + * Calls ResumeSchedule. + * @param request ResumeScheduleRequest message or plain object + * @returns Promise + */ + public resumeSchedule(request: google.cloud.aiplatform.v1.IResumeScheduleRequest): Promise; + + /** + * Calls UpdateSchedule. + * @param request UpdateScheduleRequest message or plain object + * @param callback Node-style callback called with the error, if any, and Schedule + */ + public updateSchedule(request: google.cloud.aiplatform.v1.IUpdateScheduleRequest, callback: google.cloud.aiplatform.v1.ScheduleService.UpdateScheduleCallback): void; + + /** + * Calls UpdateSchedule. + * @param request UpdateScheduleRequest message or plain object + * @returns Promise + */ + public updateSchedule(request: google.cloud.aiplatform.v1.IUpdateScheduleRequest): Promise; + } + + namespace ScheduleService { + + /** + * Callback as used by {@link google.cloud.aiplatform.v1.ScheduleService|createSchedule}. + * @param error Error, if any + * @param [response] Schedule + */ + type CreateScheduleCallback = (error: (Error|null), response?: google.cloud.aiplatform.v1.Schedule) => void; + + /** + * Callback as used by {@link google.cloud.aiplatform.v1.ScheduleService|deleteSchedule}. + * @param error Error, if any + * @param [response] Operation + */ + type DeleteScheduleCallback = (error: (Error|null), response?: google.longrunning.Operation) => void; + + /** + * Callback as used by {@link google.cloud.aiplatform.v1.ScheduleService|getSchedule}. + * @param error Error, if any + * @param [response] Schedule + */ + type GetScheduleCallback = (error: (Error|null), response?: google.cloud.aiplatform.v1.Schedule) => void; + + /** + * Callback as used by {@link google.cloud.aiplatform.v1.ScheduleService|listSchedules}. + * @param error Error, if any + * @param [response] ListSchedulesResponse + */ + type ListSchedulesCallback = (error: (Error|null), response?: google.cloud.aiplatform.v1.ListSchedulesResponse) => void; + + /** + * Callback as used by {@link google.cloud.aiplatform.v1.ScheduleService|pauseSchedule}. + * @param error Error, if any + * @param [response] Empty + */ + type PauseScheduleCallback = (error: (Error|null), response?: google.protobuf.Empty) => void; + + /** + * Callback as used by {@link google.cloud.aiplatform.v1.ScheduleService|resumeSchedule}. + * @param error Error, if any + * @param [response] Empty + */ + type ResumeScheduleCallback = (error: (Error|null), response?: google.protobuf.Empty) => void; + + /** + * Callback as used by {@link google.cloud.aiplatform.v1.ScheduleService|updateSchedule}. + * @param error Error, if any + * @param [response] Schedule + */ + type UpdateScheduleCallback = (error: (Error|null), response?: google.cloud.aiplatform.v1.Schedule) => void; + } + + /** Properties of a CreateScheduleRequest. */ + interface ICreateScheduleRequest { + + /** CreateScheduleRequest parent */ + parent?: (string|null); + + /** CreateScheduleRequest schedule */ + schedule?: (google.cloud.aiplatform.v1.ISchedule|null); + } + + /** Represents a CreateScheduleRequest. */ + class CreateScheduleRequest implements ICreateScheduleRequest { + + /** + * Constructs a new CreateScheduleRequest. + * @param [properties] Properties to set + */ + constructor(properties?: google.cloud.aiplatform.v1.ICreateScheduleRequest); + + /** CreateScheduleRequest parent. */ + public parent: string; + + /** CreateScheduleRequest schedule. */ + public schedule?: (google.cloud.aiplatform.v1.ISchedule|null); + + /** + * Creates a new CreateScheduleRequest instance using the specified properties. + * @param [properties] Properties to set + * @returns CreateScheduleRequest instance + */ + public static create(properties?: google.cloud.aiplatform.v1.ICreateScheduleRequest): google.cloud.aiplatform.v1.CreateScheduleRequest; + + /** + * Encodes the specified CreateScheduleRequest message. Does not implicitly {@link google.cloud.aiplatform.v1.CreateScheduleRequest.verify|verify} messages. + * @param message CreateScheduleRequest message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encode(message: google.cloud.aiplatform.v1.ICreateScheduleRequest, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Encodes the specified CreateScheduleRequest message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.CreateScheduleRequest.verify|verify} messages. + * @param message CreateScheduleRequest message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encodeDelimited(message: google.cloud.aiplatform.v1.ICreateScheduleRequest, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Decodes a CreateScheduleRequest message from the specified reader or buffer. + * @param reader Reader or buffer to decode from + * @param [length] Message length if known beforehand + * @returns CreateScheduleRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.CreateScheduleRequest; + + /** + * Decodes a CreateScheduleRequest message from the specified reader or buffer, length delimited. + * @param reader Reader or buffer to decode from + * @returns CreateScheduleRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.CreateScheduleRequest; + + /** + * Verifies a CreateScheduleRequest message. + * @param message Plain object to verify + * @returns `null` if valid, otherwise the reason why it is not + */ + public static verify(message: { [k: string]: any }): (string|null); + + /** + * Creates a CreateScheduleRequest message from a plain object. Also converts values to their respective internal types. + * @param object Plain object + * @returns CreateScheduleRequest + */ + public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.CreateScheduleRequest; + + /** + * Creates a plain object from a CreateScheduleRequest message. Also converts values to other types if specified. + * @param message CreateScheduleRequest + * @param [options] Conversion options + * @returns Plain object + */ + public static toObject(message: google.cloud.aiplatform.v1.CreateScheduleRequest, options?: $protobuf.IConversionOptions): { [k: string]: any }; + + /** + * Converts this CreateScheduleRequest to JSON. + * @returns JSON object + */ + public toJSON(): { [k: string]: any }; + + /** + * Gets the default type url for CreateScheduleRequest + * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns The default type url + */ + public static getTypeUrl(typeUrlPrefix?: string): string; + } + + /** Properties of a GetScheduleRequest. */ + interface IGetScheduleRequest { + + /** GetScheduleRequest name */ + name?: (string|null); + } + + /** Represents a GetScheduleRequest. */ + class GetScheduleRequest implements IGetScheduleRequest { + + /** + * Constructs a new GetScheduleRequest. + * @param [properties] Properties to set + */ + constructor(properties?: google.cloud.aiplatform.v1.IGetScheduleRequest); + + /** GetScheduleRequest name. */ + public name: string; + + /** + * Creates a new GetScheduleRequest instance using the specified properties. + * @param [properties] Properties to set + * @returns GetScheduleRequest instance + */ + public static create(properties?: google.cloud.aiplatform.v1.IGetScheduleRequest): google.cloud.aiplatform.v1.GetScheduleRequest; + + /** + * Encodes the specified GetScheduleRequest message. Does not implicitly {@link google.cloud.aiplatform.v1.GetScheduleRequest.verify|verify} messages. + * @param message GetScheduleRequest message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encode(message: google.cloud.aiplatform.v1.IGetScheduleRequest, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Encodes the specified GetScheduleRequest message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.GetScheduleRequest.verify|verify} messages. + * @param message GetScheduleRequest message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encodeDelimited(message: google.cloud.aiplatform.v1.IGetScheduleRequest, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Decodes a GetScheduleRequest message from the specified reader or buffer. + * @param reader Reader or buffer to decode from + * @param [length] Message length if known beforehand + * @returns GetScheduleRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.GetScheduleRequest; + + /** + * Decodes a GetScheduleRequest message from the specified reader or buffer, length delimited. + * @param reader Reader or buffer to decode from + * @returns GetScheduleRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.GetScheduleRequest; + + /** + * Verifies a GetScheduleRequest message. + * @param message Plain object to verify + * @returns `null` if valid, otherwise the reason why it is not + */ + public static verify(message: { [k: string]: any }): (string|null); + + /** + * Creates a GetScheduleRequest message from a plain object. Also converts values to their respective internal types. + * @param object Plain object + * @returns GetScheduleRequest + */ + public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.GetScheduleRequest; + + /** + * Creates a plain object from a GetScheduleRequest message. Also converts values to other types if specified. + * @param message GetScheduleRequest + * @param [options] Conversion options + * @returns Plain object + */ + public static toObject(message: google.cloud.aiplatform.v1.GetScheduleRequest, options?: $protobuf.IConversionOptions): { [k: string]: any }; + + /** + * Converts this GetScheduleRequest to JSON. + * @returns JSON object + */ + public toJSON(): { [k: string]: any }; + + /** + * Gets the default type url for GetScheduleRequest + * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns The default type url + */ + public static getTypeUrl(typeUrlPrefix?: string): string; + } + + /** Properties of a ListSchedulesRequest. */ + interface IListSchedulesRequest { + + /** ListSchedulesRequest parent */ + parent?: (string|null); + + /** ListSchedulesRequest filter */ + filter?: (string|null); + + /** ListSchedulesRequest pageSize */ + pageSize?: (number|null); + + /** ListSchedulesRequest pageToken */ + pageToken?: (string|null); + + /** ListSchedulesRequest orderBy */ + orderBy?: (string|null); + } + + /** Represents a ListSchedulesRequest. */ + class ListSchedulesRequest implements IListSchedulesRequest { + + /** + * Constructs a new ListSchedulesRequest. + * @param [properties] Properties to set + */ + constructor(properties?: google.cloud.aiplatform.v1.IListSchedulesRequest); + + /** ListSchedulesRequest parent. */ + public parent: string; + + /** ListSchedulesRequest filter. */ + public filter: string; + + /** ListSchedulesRequest pageSize. */ + public pageSize: number; + + /** ListSchedulesRequest pageToken. */ + public pageToken: string; + + /** ListSchedulesRequest orderBy. */ + public orderBy: string; + + /** + * Creates a new ListSchedulesRequest instance using the specified properties. + * @param [properties] Properties to set + * @returns ListSchedulesRequest instance + */ + public static create(properties?: google.cloud.aiplatform.v1.IListSchedulesRequest): google.cloud.aiplatform.v1.ListSchedulesRequest; + + /** + * Encodes the specified ListSchedulesRequest message. Does not implicitly {@link google.cloud.aiplatform.v1.ListSchedulesRequest.verify|verify} messages. + * @param message ListSchedulesRequest message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encode(message: google.cloud.aiplatform.v1.IListSchedulesRequest, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Encodes the specified ListSchedulesRequest message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.ListSchedulesRequest.verify|verify} messages. + * @param message ListSchedulesRequest message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encodeDelimited(message: google.cloud.aiplatform.v1.IListSchedulesRequest, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Decodes a ListSchedulesRequest message from the specified reader or buffer. + * @param reader Reader or buffer to decode from + * @param [length] Message length if known beforehand + * @returns ListSchedulesRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.ListSchedulesRequest; + + /** + * Decodes a ListSchedulesRequest message from the specified reader or buffer, length delimited. + * @param reader Reader or buffer to decode from + * @returns ListSchedulesRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.ListSchedulesRequest; + + /** + * Verifies a ListSchedulesRequest message. + * @param message Plain object to verify + * @returns `null` if valid, otherwise the reason why it is not + */ + public static verify(message: { [k: string]: any }): (string|null); + + /** + * Creates a ListSchedulesRequest message from a plain object. Also converts values to their respective internal types. + * @param object Plain object + * @returns ListSchedulesRequest + */ + public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.ListSchedulesRequest; + + /** + * Creates a plain object from a ListSchedulesRequest message. Also converts values to other types if specified. + * @param message ListSchedulesRequest + * @param [options] Conversion options + * @returns Plain object + */ + public static toObject(message: google.cloud.aiplatform.v1.ListSchedulesRequest, options?: $protobuf.IConversionOptions): { [k: string]: any }; + + /** + * Converts this ListSchedulesRequest to JSON. + * @returns JSON object + */ + public toJSON(): { [k: string]: any }; + + /** + * Gets the default type url for ListSchedulesRequest + * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns The default type url + */ + public static getTypeUrl(typeUrlPrefix?: string): string; + } + + /** Properties of a ListSchedulesResponse. */ + interface IListSchedulesResponse { + + /** ListSchedulesResponse schedules */ + schedules?: (google.cloud.aiplatform.v1.ISchedule[]|null); + + /** ListSchedulesResponse nextPageToken */ + nextPageToken?: (string|null); + } + + /** Represents a ListSchedulesResponse. */ + class ListSchedulesResponse implements IListSchedulesResponse { + + /** + * Constructs a new ListSchedulesResponse. + * @param [properties] Properties to set + */ + constructor(properties?: google.cloud.aiplatform.v1.IListSchedulesResponse); + + /** ListSchedulesResponse schedules. */ + public schedules: google.cloud.aiplatform.v1.ISchedule[]; + + /** ListSchedulesResponse nextPageToken. */ + public nextPageToken: string; + + /** + * Creates a new ListSchedulesResponse instance using the specified properties. + * @param [properties] Properties to set + * @returns ListSchedulesResponse instance + */ + public static create(properties?: google.cloud.aiplatform.v1.IListSchedulesResponse): google.cloud.aiplatform.v1.ListSchedulesResponse; + + /** + * Encodes the specified ListSchedulesResponse message. Does not implicitly {@link google.cloud.aiplatform.v1.ListSchedulesResponse.verify|verify} messages. + * @param message ListSchedulesResponse message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encode(message: google.cloud.aiplatform.v1.IListSchedulesResponse, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Encodes the specified ListSchedulesResponse message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.ListSchedulesResponse.verify|verify} messages. + * @param message ListSchedulesResponse message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encodeDelimited(message: google.cloud.aiplatform.v1.IListSchedulesResponse, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Decodes a ListSchedulesResponse message from the specified reader or buffer. + * @param reader Reader or buffer to decode from + * @param [length] Message length if known beforehand + * @returns ListSchedulesResponse + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.ListSchedulesResponse; + + /** + * Decodes a ListSchedulesResponse message from the specified reader or buffer, length delimited. + * @param reader Reader or buffer to decode from + * @returns ListSchedulesResponse + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.ListSchedulesResponse; + + /** + * Verifies a ListSchedulesResponse message. + * @param message Plain object to verify + * @returns `null` if valid, otherwise the reason why it is not + */ + public static verify(message: { [k: string]: any }): (string|null); + + /** + * Creates a ListSchedulesResponse message from a plain object. Also converts values to their respective internal types. + * @param object Plain object + * @returns ListSchedulesResponse + */ + public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.ListSchedulesResponse; + + /** + * Creates a plain object from a ListSchedulesResponse message. Also converts values to other types if specified. + * @param message ListSchedulesResponse + * @param [options] Conversion options + * @returns Plain object + */ + public static toObject(message: google.cloud.aiplatform.v1.ListSchedulesResponse, options?: $protobuf.IConversionOptions): { [k: string]: any }; + + /** + * Converts this ListSchedulesResponse to JSON. + * @returns JSON object + */ + public toJSON(): { [k: string]: any }; + + /** + * Gets the default type url for ListSchedulesResponse + * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns The default type url + */ + public static getTypeUrl(typeUrlPrefix?: string): string; + } + + /** Properties of a DeleteScheduleRequest. */ + interface IDeleteScheduleRequest { + + /** DeleteScheduleRequest name */ + name?: (string|null); + } + + /** Represents a DeleteScheduleRequest. */ + class DeleteScheduleRequest implements IDeleteScheduleRequest { + + /** + * Constructs a new DeleteScheduleRequest. + * @param [properties] Properties to set + */ + constructor(properties?: google.cloud.aiplatform.v1.IDeleteScheduleRequest); - /** PredictResponse modelDisplayName. */ - public modelDisplayName: string; + /** DeleteScheduleRequest name. */ + public name: string; /** - * Creates a new PredictResponse instance using the specified properties. + * Creates a new DeleteScheduleRequest instance using the specified properties. * @param [properties] Properties to set - * @returns PredictResponse instance + * @returns DeleteScheduleRequest instance */ - public static create(properties?: google.cloud.aiplatform.v1.IPredictResponse): google.cloud.aiplatform.v1.PredictResponse; + public static create(properties?: google.cloud.aiplatform.v1.IDeleteScheduleRequest): google.cloud.aiplatform.v1.DeleteScheduleRequest; /** - * Encodes the specified PredictResponse message. Does not implicitly {@link google.cloud.aiplatform.v1.PredictResponse.verify|verify} messages. - * @param message PredictResponse message or plain object to encode + * Encodes the specified DeleteScheduleRequest message. Does not implicitly {@link google.cloud.aiplatform.v1.DeleteScheduleRequest.verify|verify} messages. + * @param message DeleteScheduleRequest message or plain object to encode * @param [writer] Writer to encode to * @returns Writer */ - public static encode(message: google.cloud.aiplatform.v1.IPredictResponse, writer?: $protobuf.Writer): $protobuf.Writer; + public static encode(message: google.cloud.aiplatform.v1.IDeleteScheduleRequest, writer?: $protobuf.Writer): $protobuf.Writer; /** - * Encodes the specified PredictResponse message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.PredictResponse.verify|verify} messages. - * @param message PredictResponse message or plain object to encode + * Encodes the specified DeleteScheduleRequest message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.DeleteScheduleRequest.verify|verify} messages. + * @param message DeleteScheduleRequest message or plain object to encode * @param [writer] Writer to encode to * @returns Writer */ - public static encodeDelimited(message: google.cloud.aiplatform.v1.IPredictResponse, writer?: $protobuf.Writer): $protobuf.Writer; + public static encodeDelimited(message: google.cloud.aiplatform.v1.IDeleteScheduleRequest, writer?: $protobuf.Writer): $protobuf.Writer; /** - * Decodes a PredictResponse message from the specified reader or buffer. + * Decodes a DeleteScheduleRequest message from the specified reader or buffer. * @param reader Reader or buffer to decode from * @param [length] Message length if known beforehand - * @returns PredictResponse + * @returns DeleteScheduleRequest * @throws {Error} If the payload is not a reader or valid buffer * @throws {$protobuf.util.ProtocolError} If required fields are missing */ - public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.PredictResponse; + public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.DeleteScheduleRequest; /** - * Decodes a PredictResponse message from the specified reader or buffer, length delimited. + * Decodes a DeleteScheduleRequest message from the specified reader or buffer, length delimited. * @param reader Reader or buffer to decode from - * @returns PredictResponse + * @returns DeleteScheduleRequest * @throws {Error} If the payload is not a reader or valid buffer * @throws {$protobuf.util.ProtocolError} If required fields are missing */ - public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.PredictResponse; + public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.DeleteScheduleRequest; /** - * Verifies a PredictResponse message. + * Verifies a DeleteScheduleRequest message. * @param message Plain object to verify * @returns `null` if valid, otherwise the reason why it is not */ public static verify(message: { [k: string]: any }): (string|null); /** - * Creates a PredictResponse message from a plain object. Also converts values to their respective internal types. + * Creates a DeleteScheduleRequest message from a plain object. Also converts values to their respective internal types. * @param object Plain object - * @returns PredictResponse + * @returns DeleteScheduleRequest */ - public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.PredictResponse; + public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.DeleteScheduleRequest; /** - * Creates a plain object from a PredictResponse message. Also converts values to other types if specified. - * @param message PredictResponse + * Creates a plain object from a DeleteScheduleRequest message. Also converts values to other types if specified. + * @param message DeleteScheduleRequest * @param [options] Conversion options * @returns Plain object */ - public static toObject(message: google.cloud.aiplatform.v1.PredictResponse, options?: $protobuf.IConversionOptions): { [k: string]: any }; + public static toObject(message: google.cloud.aiplatform.v1.DeleteScheduleRequest, options?: $protobuf.IConversionOptions): { [k: string]: any }; /** - * Converts this PredictResponse to JSON. + * Converts this DeleteScheduleRequest to JSON. * @returns JSON object */ public toJSON(): { [k: string]: any }; /** - * Gets the default type url for PredictResponse + * Gets the default type url for DeleteScheduleRequest * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") * @returns The default type url */ public static getTypeUrl(typeUrlPrefix?: string): string; } - /** Properties of a RawPredictRequest. */ - interface IRawPredictRequest { - - /** RawPredictRequest endpoint */ - endpoint?: (string|null); + /** Properties of a PauseScheduleRequest. */ + interface IPauseScheduleRequest { - /** RawPredictRequest httpBody */ - httpBody?: (google.api.IHttpBody|null); + /** PauseScheduleRequest name */ + name?: (string|null); } - /** Represents a RawPredictRequest. */ - class RawPredictRequest implements IRawPredictRequest { + /** Represents a PauseScheduleRequest. */ + class PauseScheduleRequest implements IPauseScheduleRequest { /** - * Constructs a new RawPredictRequest. + * Constructs a new PauseScheduleRequest. * @param [properties] Properties to set */ - constructor(properties?: google.cloud.aiplatform.v1.IRawPredictRequest); - - /** RawPredictRequest endpoint. */ - public endpoint: string; + constructor(properties?: google.cloud.aiplatform.v1.IPauseScheduleRequest); - /** RawPredictRequest httpBody. */ - public httpBody?: (google.api.IHttpBody|null); + /** PauseScheduleRequest name. */ + public name: string; /** - * Creates a new RawPredictRequest instance using the specified properties. + * Creates a new PauseScheduleRequest instance using the specified properties. * @param [properties] Properties to set - * @returns RawPredictRequest instance + * @returns PauseScheduleRequest instance */ - public static create(properties?: google.cloud.aiplatform.v1.IRawPredictRequest): google.cloud.aiplatform.v1.RawPredictRequest; + public static create(properties?: google.cloud.aiplatform.v1.IPauseScheduleRequest): google.cloud.aiplatform.v1.PauseScheduleRequest; /** - * Encodes the specified RawPredictRequest message. Does not implicitly {@link google.cloud.aiplatform.v1.RawPredictRequest.verify|verify} messages. - * @param message RawPredictRequest message or plain object to encode + * Encodes the specified PauseScheduleRequest message. Does not implicitly {@link google.cloud.aiplatform.v1.PauseScheduleRequest.verify|verify} messages. + * @param message PauseScheduleRequest message or plain object to encode * @param [writer] Writer to encode to * @returns Writer */ - public static encode(message: google.cloud.aiplatform.v1.IRawPredictRequest, writer?: $protobuf.Writer): $protobuf.Writer; + public static encode(message: google.cloud.aiplatform.v1.IPauseScheduleRequest, writer?: $protobuf.Writer): $protobuf.Writer; /** - * Encodes the specified RawPredictRequest message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.RawPredictRequest.verify|verify} messages. - * @param message RawPredictRequest message or plain object to encode + * Encodes the specified PauseScheduleRequest message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.PauseScheduleRequest.verify|verify} messages. + * @param message PauseScheduleRequest message or plain object to encode * @param [writer] Writer to encode to * @returns Writer */ - public static encodeDelimited(message: google.cloud.aiplatform.v1.IRawPredictRequest, writer?: $protobuf.Writer): $protobuf.Writer; + public static encodeDelimited(message: google.cloud.aiplatform.v1.IPauseScheduleRequest, writer?: $protobuf.Writer): $protobuf.Writer; /** - * Decodes a RawPredictRequest message from the specified reader or buffer. + * Decodes a PauseScheduleRequest message from the specified reader or buffer. * @param reader Reader or buffer to decode from * @param [length] Message length if known beforehand - * @returns RawPredictRequest + * @returns PauseScheduleRequest * @throws {Error} If the payload is not a reader or valid buffer * @throws {$protobuf.util.ProtocolError} If required fields are missing */ - public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.RawPredictRequest; + public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.PauseScheduleRequest; /** - * Decodes a RawPredictRequest message from the specified reader or buffer, length delimited. + * Decodes a PauseScheduleRequest message from the specified reader or buffer, length delimited. * @param reader Reader or buffer to decode from - * @returns RawPredictRequest + * @returns PauseScheduleRequest * @throws {Error} If the payload is not a reader or valid buffer * @throws {$protobuf.util.ProtocolError} If required fields are missing */ - public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.RawPredictRequest; + public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.PauseScheduleRequest; /** - * Verifies a RawPredictRequest message. + * Verifies a PauseScheduleRequest message. * @param message Plain object to verify * @returns `null` if valid, otherwise the reason why it is not */ public static verify(message: { [k: string]: any }): (string|null); /** - * Creates a RawPredictRequest message from a plain object. Also converts values to their respective internal types. + * Creates a PauseScheduleRequest message from a plain object. Also converts values to their respective internal types. * @param object Plain object - * @returns RawPredictRequest + * @returns PauseScheduleRequest */ - public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.RawPredictRequest; + public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.PauseScheduleRequest; /** - * Creates a plain object from a RawPredictRequest message. Also converts values to other types if specified. - * @param message RawPredictRequest + * Creates a plain object from a PauseScheduleRequest message. Also converts values to other types if specified. + * @param message PauseScheduleRequest * @param [options] Conversion options * @returns Plain object */ - public static toObject(message: google.cloud.aiplatform.v1.RawPredictRequest, options?: $protobuf.IConversionOptions): { [k: string]: any }; + public static toObject(message: google.cloud.aiplatform.v1.PauseScheduleRequest, options?: $protobuf.IConversionOptions): { [k: string]: any }; /** - * Converts this RawPredictRequest to JSON. + * Converts this PauseScheduleRequest to JSON. * @returns JSON object */ public toJSON(): { [k: string]: any }; /** - * Gets the default type url for RawPredictRequest + * Gets the default type url for PauseScheduleRequest * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") * @returns The default type url */ public static getTypeUrl(typeUrlPrefix?: string): string; } - /** Properties of an ExplainRequest. */ - interface IExplainRequest { - - /** ExplainRequest endpoint */ - endpoint?: (string|null); - - /** ExplainRequest instances */ - instances?: (google.protobuf.IValue[]|null); - - /** ExplainRequest parameters */ - parameters?: (google.protobuf.IValue|null); + /** Properties of a ResumeScheduleRequest. */ + interface IResumeScheduleRequest { - /** ExplainRequest explanationSpecOverride */ - explanationSpecOverride?: (google.cloud.aiplatform.v1.IExplanationSpecOverride|null); + /** ResumeScheduleRequest name */ + name?: (string|null); - /** ExplainRequest deployedModelId */ - deployedModelId?: (string|null); + /** ResumeScheduleRequest catchUp */ + catchUp?: (boolean|null); } - /** Represents an ExplainRequest. */ - class ExplainRequest implements IExplainRequest { + /** Represents a ResumeScheduleRequest. */ + class ResumeScheduleRequest implements IResumeScheduleRequest { /** - * Constructs a new ExplainRequest. + * Constructs a new ResumeScheduleRequest. * @param [properties] Properties to set */ - constructor(properties?: google.cloud.aiplatform.v1.IExplainRequest); - - /** ExplainRequest endpoint. */ - public endpoint: string; - - /** ExplainRequest instances. */ - public instances: google.protobuf.IValue[]; - - /** ExplainRequest parameters. */ - public parameters?: (google.protobuf.IValue|null); + constructor(properties?: google.cloud.aiplatform.v1.IResumeScheduleRequest); - /** ExplainRequest explanationSpecOverride. */ - public explanationSpecOverride?: (google.cloud.aiplatform.v1.IExplanationSpecOverride|null); + /** ResumeScheduleRequest name. */ + public name: string; - /** ExplainRequest deployedModelId. */ - public deployedModelId: string; + /** ResumeScheduleRequest catchUp. */ + public catchUp: boolean; /** - * Creates a new ExplainRequest instance using the specified properties. + * Creates a new ResumeScheduleRequest instance using the specified properties. * @param [properties] Properties to set - * @returns ExplainRequest instance + * @returns ResumeScheduleRequest instance */ - public static create(properties?: google.cloud.aiplatform.v1.IExplainRequest): google.cloud.aiplatform.v1.ExplainRequest; + public static create(properties?: google.cloud.aiplatform.v1.IResumeScheduleRequest): google.cloud.aiplatform.v1.ResumeScheduleRequest; /** - * Encodes the specified ExplainRequest message. Does not implicitly {@link google.cloud.aiplatform.v1.ExplainRequest.verify|verify} messages. - * @param message ExplainRequest message or plain object to encode + * Encodes the specified ResumeScheduleRequest message. Does not implicitly {@link google.cloud.aiplatform.v1.ResumeScheduleRequest.verify|verify} messages. + * @param message ResumeScheduleRequest message or plain object to encode * @param [writer] Writer to encode to * @returns Writer */ - public static encode(message: google.cloud.aiplatform.v1.IExplainRequest, writer?: $protobuf.Writer): $protobuf.Writer; + public static encode(message: google.cloud.aiplatform.v1.IResumeScheduleRequest, writer?: $protobuf.Writer): $protobuf.Writer; /** - * Encodes the specified ExplainRequest message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.ExplainRequest.verify|verify} messages. - * @param message ExplainRequest message or plain object to encode + * Encodes the specified ResumeScheduleRequest message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.ResumeScheduleRequest.verify|verify} messages. + * @param message ResumeScheduleRequest message or plain object to encode * @param [writer] Writer to encode to * @returns Writer */ - public static encodeDelimited(message: google.cloud.aiplatform.v1.IExplainRequest, writer?: $protobuf.Writer): $protobuf.Writer; + public static encodeDelimited(message: google.cloud.aiplatform.v1.IResumeScheduleRequest, writer?: $protobuf.Writer): $protobuf.Writer; /** - * Decodes an ExplainRequest message from the specified reader or buffer. + * Decodes a ResumeScheduleRequest message from the specified reader or buffer. * @param reader Reader or buffer to decode from * @param [length] Message length if known beforehand - * @returns ExplainRequest + * @returns ResumeScheduleRequest * @throws {Error} If the payload is not a reader or valid buffer * @throws {$protobuf.util.ProtocolError} If required fields are missing */ - public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.ExplainRequest; + public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.ResumeScheduleRequest; /** - * Decodes an ExplainRequest message from the specified reader or buffer, length delimited. + * Decodes a ResumeScheduleRequest message from the specified reader or buffer, length delimited. * @param reader Reader or buffer to decode from - * @returns ExplainRequest + * @returns ResumeScheduleRequest * @throws {Error} If the payload is not a reader or valid buffer * @throws {$protobuf.util.ProtocolError} If required fields are missing */ - public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.ExplainRequest; + public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.ResumeScheduleRequest; /** - * Verifies an ExplainRequest message. + * Verifies a ResumeScheduleRequest message. * @param message Plain object to verify * @returns `null` if valid, otherwise the reason why it is not */ public static verify(message: { [k: string]: any }): (string|null); /** - * Creates an ExplainRequest message from a plain object. Also converts values to their respective internal types. + * Creates a ResumeScheduleRequest message from a plain object. Also converts values to their respective internal types. * @param object Plain object - * @returns ExplainRequest + * @returns ResumeScheduleRequest */ - public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.ExplainRequest; + public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.ResumeScheduleRequest; /** - * Creates a plain object from an ExplainRequest message. Also converts values to other types if specified. - * @param message ExplainRequest + * Creates a plain object from a ResumeScheduleRequest message. Also converts values to other types if specified. + * @param message ResumeScheduleRequest * @param [options] Conversion options * @returns Plain object */ - public static toObject(message: google.cloud.aiplatform.v1.ExplainRequest, options?: $protobuf.IConversionOptions): { [k: string]: any }; + public static toObject(message: google.cloud.aiplatform.v1.ResumeScheduleRequest, options?: $protobuf.IConversionOptions): { [k: string]: any }; /** - * Converts this ExplainRequest to JSON. + * Converts this ResumeScheduleRequest to JSON. * @returns JSON object */ public toJSON(): { [k: string]: any }; /** - * Gets the default type url for ExplainRequest + * Gets the default type url for ResumeScheduleRequest * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") * @returns The default type url */ public static getTypeUrl(typeUrlPrefix?: string): string; } - /** Properties of an ExplainResponse. */ - interface IExplainResponse { - - /** ExplainResponse explanations */ - explanations?: (google.cloud.aiplatform.v1.IExplanation[]|null); + /** Properties of an UpdateScheduleRequest. */ + interface IUpdateScheduleRequest { - /** ExplainResponse deployedModelId */ - deployedModelId?: (string|null); + /** UpdateScheduleRequest schedule */ + schedule?: (google.cloud.aiplatform.v1.ISchedule|null); - /** ExplainResponse predictions */ - predictions?: (google.protobuf.IValue[]|null); + /** UpdateScheduleRequest updateMask */ + updateMask?: (google.protobuf.IFieldMask|null); } - /** Represents an ExplainResponse. */ - class ExplainResponse implements IExplainResponse { + /** Represents an UpdateScheduleRequest. */ + class UpdateScheduleRequest implements IUpdateScheduleRequest { /** - * Constructs a new ExplainResponse. + * Constructs a new UpdateScheduleRequest. * @param [properties] Properties to set */ - constructor(properties?: google.cloud.aiplatform.v1.IExplainResponse); + constructor(properties?: google.cloud.aiplatform.v1.IUpdateScheduleRequest); - /** ExplainResponse explanations. */ - public explanations: google.cloud.aiplatform.v1.IExplanation[]; - - /** ExplainResponse deployedModelId. */ - public deployedModelId: string; + /** UpdateScheduleRequest schedule. */ + public schedule?: (google.cloud.aiplatform.v1.ISchedule|null); - /** ExplainResponse predictions. */ - public predictions: google.protobuf.IValue[]; + /** UpdateScheduleRequest updateMask. */ + public updateMask?: (google.protobuf.IFieldMask|null); /** - * Creates a new ExplainResponse instance using the specified properties. + * Creates a new UpdateScheduleRequest instance using the specified properties. * @param [properties] Properties to set - * @returns ExplainResponse instance + * @returns UpdateScheduleRequest instance */ - public static create(properties?: google.cloud.aiplatform.v1.IExplainResponse): google.cloud.aiplatform.v1.ExplainResponse; + public static create(properties?: google.cloud.aiplatform.v1.IUpdateScheduleRequest): google.cloud.aiplatform.v1.UpdateScheduleRequest; /** - * Encodes the specified ExplainResponse message. Does not implicitly {@link google.cloud.aiplatform.v1.ExplainResponse.verify|verify} messages. - * @param message ExplainResponse message or plain object to encode + * Encodes the specified UpdateScheduleRequest message. Does not implicitly {@link google.cloud.aiplatform.v1.UpdateScheduleRequest.verify|verify} messages. + * @param message UpdateScheduleRequest message or plain object to encode * @param [writer] Writer to encode to * @returns Writer */ - public static encode(message: google.cloud.aiplatform.v1.IExplainResponse, writer?: $protobuf.Writer): $protobuf.Writer; + public static encode(message: google.cloud.aiplatform.v1.IUpdateScheduleRequest, writer?: $protobuf.Writer): $protobuf.Writer; /** - * Encodes the specified ExplainResponse message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.ExplainResponse.verify|verify} messages. - * @param message ExplainResponse message or plain object to encode + * Encodes the specified UpdateScheduleRequest message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.UpdateScheduleRequest.verify|verify} messages. + * @param message UpdateScheduleRequest message or plain object to encode * @param [writer] Writer to encode to * @returns Writer */ - public static encodeDelimited(message: google.cloud.aiplatform.v1.IExplainResponse, writer?: $protobuf.Writer): $protobuf.Writer; + public static encodeDelimited(message: google.cloud.aiplatform.v1.IUpdateScheduleRequest, writer?: $protobuf.Writer): $protobuf.Writer; /** - * Decodes an ExplainResponse message from the specified reader or buffer. + * Decodes an UpdateScheduleRequest message from the specified reader or buffer. * @param reader Reader or buffer to decode from * @param [length] Message length if known beforehand - * @returns ExplainResponse + * @returns UpdateScheduleRequest * @throws {Error} If the payload is not a reader or valid buffer * @throws {$protobuf.util.ProtocolError} If required fields are missing */ - public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.ExplainResponse; + public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.UpdateScheduleRequest; /** - * Decodes an ExplainResponse message from the specified reader or buffer, length delimited. + * Decodes an UpdateScheduleRequest message from the specified reader or buffer, length delimited. * @param reader Reader or buffer to decode from - * @returns ExplainResponse + * @returns UpdateScheduleRequest * @throws {Error} If the payload is not a reader or valid buffer * @throws {$protobuf.util.ProtocolError} If required fields are missing */ - public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.ExplainResponse; + public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.UpdateScheduleRequest; /** - * Verifies an ExplainResponse message. + * Verifies an UpdateScheduleRequest message. * @param message Plain object to verify * @returns `null` if valid, otherwise the reason why it is not */ public static verify(message: { [k: string]: any }): (string|null); /** - * Creates an ExplainResponse message from a plain object. Also converts values to their respective internal types. + * Creates an UpdateScheduleRequest message from a plain object. Also converts values to their respective internal types. * @param object Plain object - * @returns ExplainResponse + * @returns UpdateScheduleRequest */ - public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.ExplainResponse; + public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.UpdateScheduleRequest; /** - * Creates a plain object from an ExplainResponse message. Also converts values to other types if specified. - * @param message ExplainResponse + * Creates a plain object from an UpdateScheduleRequest message. Also converts values to other types if specified. + * @param message UpdateScheduleRequest * @param [options] Conversion options * @returns Plain object */ - public static toObject(message: google.cloud.aiplatform.v1.ExplainResponse, options?: $protobuf.IConversionOptions): { [k: string]: any }; + public static toObject(message: google.cloud.aiplatform.v1.UpdateScheduleRequest, options?: $protobuf.IConversionOptions): { [k: string]: any }; /** - * Converts this ExplainResponse to JSON. + * Converts this UpdateScheduleRequest to JSON. * @returns JSON object */ public toJSON(): { [k: string]: any }; /** - * Gets the default type url for ExplainResponse + * Gets the default type url for UpdateScheduleRequest * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") * @returns The default type url */ @@ -101787,6 +103535,201 @@ export namespace google { public static getTypeUrl(typeUrlPrefix?: string): string; } + /** Properties of a Tensor. */ + interface ITensor { + + /** Tensor dtype */ + dtype?: (google.cloud.aiplatform.v1beta1.Tensor.DataType|keyof typeof google.cloud.aiplatform.v1beta1.Tensor.DataType|null); + + /** Tensor shape */ + shape?: ((number|Long|string)[]|null); + + /** Tensor boolVal */ + boolVal?: (boolean[]|null); + + /** Tensor stringVal */ + stringVal?: (string[]|null); + + /** Tensor bytesVal */ + bytesVal?: (Uint8Array[]|null); + + /** Tensor floatVal */ + floatVal?: (number[]|null); + + /** Tensor doubleVal */ + doubleVal?: (number[]|null); + + /** Tensor intVal */ + intVal?: (number[]|null); + + /** Tensor int64Val */ + int64Val?: ((number|Long|string)[]|null); + + /** Tensor uintVal */ + uintVal?: (number[]|null); + + /** Tensor uint64Val */ + uint64Val?: ((number|Long|string)[]|null); + + /** Tensor listVal */ + listVal?: (google.cloud.aiplatform.v1beta1.ITensor[]|null); + + /** Tensor structVal */ + structVal?: ({ [k: string]: google.cloud.aiplatform.v1beta1.ITensor }|null); + + /** Tensor tensorVal */ + tensorVal?: (Uint8Array|string|null); + } + + /** Represents a Tensor. */ + class Tensor implements ITensor { + + /** + * Constructs a new Tensor. + * @param [properties] Properties to set + */ + constructor(properties?: google.cloud.aiplatform.v1beta1.ITensor); + + /** Tensor dtype. */ + public dtype: (google.cloud.aiplatform.v1beta1.Tensor.DataType|keyof typeof google.cloud.aiplatform.v1beta1.Tensor.DataType); + + /** Tensor shape. */ + public shape: (number|Long|string)[]; + + /** Tensor boolVal. */ + public boolVal: boolean[]; + + /** Tensor stringVal. */ + public stringVal: string[]; + + /** Tensor bytesVal. */ + public bytesVal: Uint8Array[]; + + /** Tensor floatVal. */ + public floatVal: number[]; + + /** Tensor doubleVal. */ + public doubleVal: number[]; + + /** Tensor intVal. */ + public intVal: number[]; + + /** Tensor int64Val. */ + public int64Val: (number|Long|string)[]; + + /** Tensor uintVal. */ + public uintVal: number[]; + + /** Tensor uint64Val. */ + public uint64Val: (number|Long|string)[]; + + /** Tensor listVal. */ + public listVal: google.cloud.aiplatform.v1beta1.ITensor[]; + + /** Tensor structVal. */ + public structVal: { [k: string]: google.cloud.aiplatform.v1beta1.ITensor }; + + /** Tensor tensorVal. */ + public tensorVal: (Uint8Array|string); + + /** + * Creates a new Tensor instance using the specified properties. + * @param [properties] Properties to set + * @returns Tensor instance + */ + public static create(properties?: google.cloud.aiplatform.v1beta1.ITensor): google.cloud.aiplatform.v1beta1.Tensor; + + /** + * Encodes the specified Tensor message. Does not implicitly {@link google.cloud.aiplatform.v1beta1.Tensor.verify|verify} messages. + * @param message Tensor message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encode(message: google.cloud.aiplatform.v1beta1.ITensor, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Encodes the specified Tensor message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1beta1.Tensor.verify|verify} messages. + * @param message Tensor message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encodeDelimited(message: google.cloud.aiplatform.v1beta1.ITensor, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Decodes a Tensor message from the specified reader or buffer. + * @param reader Reader or buffer to decode from + * @param [length] Message length if known beforehand + * @returns Tensor + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1beta1.Tensor; + + /** + * Decodes a Tensor message from the specified reader or buffer, length delimited. + * @param reader Reader or buffer to decode from + * @returns Tensor + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1beta1.Tensor; + + /** + * Verifies a Tensor message. + * @param message Plain object to verify + * @returns `null` if valid, otherwise the reason why it is not + */ + public static verify(message: { [k: string]: any }): (string|null); + + /** + * Creates a Tensor message from a plain object. Also converts values to their respective internal types. + * @param object Plain object + * @returns Tensor + */ + public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1beta1.Tensor; + + /** + * Creates a plain object from a Tensor message. Also converts values to other types if specified. + * @param message Tensor + * @param [options] Conversion options + * @returns Plain object + */ + public static toObject(message: google.cloud.aiplatform.v1beta1.Tensor, options?: $protobuf.IConversionOptions): { [k: string]: any }; + + /** + * Converts this Tensor to JSON. + * @returns JSON object + */ + public toJSON(): { [k: string]: any }; + + /** + * Gets the default type url for Tensor + * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns The default type url + */ + public static getTypeUrl(typeUrlPrefix?: string): string; + } + + namespace Tensor { + + /** DataType enum. */ + enum DataType { + DATA_TYPE_UNSPECIFIED = 0, + BOOL = 1, + STRING = 2, + FLOAT = 3, + DOUBLE = 4, + INT8 = 5, + INT16 = 6, + INT32 = 7, + INT64 = 8, + UINT8 = 9, + UINT16 = 10, + UINT32 = 11, + UINT64 = 12 + } + } + /** Represents a FeaturestoreService */ class FeaturestoreService extends $protobuf.rpc.Service { @@ -142472,6 +144415,20 @@ export namespace google { */ public rawPredict(request: google.cloud.aiplatform.v1beta1.IRawPredictRequest): Promise; + /** + * Calls ServerStreamingPredict. + * @param request StreamingPredictRequest message or plain object + * @param callback Node-style callback called with the error, if any, and StreamingPredictResponse + */ + public serverStreamingPredict(request: google.cloud.aiplatform.v1beta1.IStreamingPredictRequest, callback: google.cloud.aiplatform.v1beta1.PredictionService.ServerStreamingPredictCallback): void; + + /** + * Calls ServerStreamingPredict. + * @param request StreamingPredictRequest message or plain object + * @returns Promise + */ + public serverStreamingPredict(request: google.cloud.aiplatform.v1beta1.IStreamingPredictRequest): Promise; + /** * Calls Explain. * @param request ExplainRequest message or plain object @@ -142503,6 +144460,13 @@ export namespace google { */ type RawPredictCallback = (error: (Error|null), response?: google.api.HttpBody) => void; + /** + * Callback as used by {@link google.cloud.aiplatform.v1beta1.PredictionService|serverStreamingPredict}. + * @param error Error, if any + * @param [response] StreamingPredictResponse + */ + type ServerStreamingPredictCallback = (error: (Error|null), response?: google.cloud.aiplatform.v1beta1.StreamingPredictResponse) => void; + /** * Callback as used by {@link google.cloud.aiplatform.v1beta1.PredictionService|explain}. * @param error Error, if any @@ -142637,6 +144601,9 @@ export namespace google { /** PredictResponse modelDisplayName */ modelDisplayName?: (string|null); + + /** PredictResponse metadata */ + metadata?: (google.protobuf.IValue|null); } /** Represents a PredictResponse. */ @@ -142663,6 +144630,9 @@ export namespace google { /** PredictResponse modelDisplayName. */ public modelDisplayName: string; + /** PredictResponse metadata. */ + public metadata?: (google.protobuf.IValue|null); + /** * Creates a new PredictResponse instance using the specified properties. * @param [properties] Properties to set @@ -142844,6 +144814,218 @@ export namespace google { public static getTypeUrl(typeUrlPrefix?: string): string; } + /** Properties of a StreamingPredictRequest. */ + interface IStreamingPredictRequest { + + /** StreamingPredictRequest endpoint */ + endpoint?: (string|null); + + /** StreamingPredictRequest inputs */ + inputs?: (google.cloud.aiplatform.v1beta1.ITensor[]|null); + + /** StreamingPredictRequest parameters */ + parameters?: (google.cloud.aiplatform.v1beta1.ITensor|null); + } + + /** Represents a StreamingPredictRequest. */ + class StreamingPredictRequest implements IStreamingPredictRequest { + + /** + * Constructs a new StreamingPredictRequest. + * @param [properties] Properties to set + */ + constructor(properties?: google.cloud.aiplatform.v1beta1.IStreamingPredictRequest); + + /** StreamingPredictRequest endpoint. */ + public endpoint: string; + + /** StreamingPredictRequest inputs. */ + public inputs: google.cloud.aiplatform.v1beta1.ITensor[]; + + /** StreamingPredictRequest parameters. */ + public parameters?: (google.cloud.aiplatform.v1beta1.ITensor|null); + + /** + * Creates a new StreamingPredictRequest instance using the specified properties. + * @param [properties] Properties to set + * @returns StreamingPredictRequest instance + */ + public static create(properties?: google.cloud.aiplatform.v1beta1.IStreamingPredictRequest): google.cloud.aiplatform.v1beta1.StreamingPredictRequest; + + /** + * Encodes the specified StreamingPredictRequest message. Does not implicitly {@link google.cloud.aiplatform.v1beta1.StreamingPredictRequest.verify|verify} messages. + * @param message StreamingPredictRequest message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encode(message: google.cloud.aiplatform.v1beta1.IStreamingPredictRequest, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Encodes the specified StreamingPredictRequest message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1beta1.StreamingPredictRequest.verify|verify} messages. + * @param message StreamingPredictRequest message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encodeDelimited(message: google.cloud.aiplatform.v1beta1.IStreamingPredictRequest, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Decodes a StreamingPredictRequest message from the specified reader or buffer. + * @param reader Reader or buffer to decode from + * @param [length] Message length if known beforehand + * @returns StreamingPredictRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1beta1.StreamingPredictRequest; + + /** + * Decodes a StreamingPredictRequest message from the specified reader or buffer, length delimited. + * @param reader Reader or buffer to decode from + * @returns StreamingPredictRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1beta1.StreamingPredictRequest; + + /** + * Verifies a StreamingPredictRequest message. + * @param message Plain object to verify + * @returns `null` if valid, otherwise the reason why it is not + */ + public static verify(message: { [k: string]: any }): (string|null); + + /** + * Creates a StreamingPredictRequest message from a plain object. Also converts values to their respective internal types. + * @param object Plain object + * @returns StreamingPredictRequest + */ + public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1beta1.StreamingPredictRequest; + + /** + * Creates a plain object from a StreamingPredictRequest message. Also converts values to other types if specified. + * @param message StreamingPredictRequest + * @param [options] Conversion options + * @returns Plain object + */ + public static toObject(message: google.cloud.aiplatform.v1beta1.StreamingPredictRequest, options?: $protobuf.IConversionOptions): { [k: string]: any }; + + /** + * Converts this StreamingPredictRequest to JSON. + * @returns JSON object + */ + public toJSON(): { [k: string]: any }; + + /** + * Gets the default type url for StreamingPredictRequest + * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns The default type url + */ + public static getTypeUrl(typeUrlPrefix?: string): string; + } + + /** Properties of a StreamingPredictResponse. */ + interface IStreamingPredictResponse { + + /** StreamingPredictResponse outputs */ + outputs?: (google.cloud.aiplatform.v1beta1.ITensor[]|null); + + /** StreamingPredictResponse parameters */ + parameters?: (google.cloud.aiplatform.v1beta1.ITensor|null); + } + + /** Represents a StreamingPredictResponse. */ + class StreamingPredictResponse implements IStreamingPredictResponse { + + /** + * Constructs a new StreamingPredictResponse. + * @param [properties] Properties to set + */ + constructor(properties?: google.cloud.aiplatform.v1beta1.IStreamingPredictResponse); + + /** StreamingPredictResponse outputs. */ + public outputs: google.cloud.aiplatform.v1beta1.ITensor[]; + + /** StreamingPredictResponse parameters. */ + public parameters?: (google.cloud.aiplatform.v1beta1.ITensor|null); + + /** + * Creates a new StreamingPredictResponse instance using the specified properties. + * @param [properties] Properties to set + * @returns StreamingPredictResponse instance + */ + public static create(properties?: google.cloud.aiplatform.v1beta1.IStreamingPredictResponse): google.cloud.aiplatform.v1beta1.StreamingPredictResponse; + + /** + * Encodes the specified StreamingPredictResponse message. Does not implicitly {@link google.cloud.aiplatform.v1beta1.StreamingPredictResponse.verify|verify} messages. + * @param message StreamingPredictResponse message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encode(message: google.cloud.aiplatform.v1beta1.IStreamingPredictResponse, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Encodes the specified StreamingPredictResponse message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1beta1.StreamingPredictResponse.verify|verify} messages. + * @param message StreamingPredictResponse message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encodeDelimited(message: google.cloud.aiplatform.v1beta1.IStreamingPredictResponse, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Decodes a StreamingPredictResponse message from the specified reader or buffer. + * @param reader Reader or buffer to decode from + * @param [length] Message length if known beforehand + * @returns StreamingPredictResponse + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1beta1.StreamingPredictResponse; + + /** + * Decodes a StreamingPredictResponse message from the specified reader or buffer, length delimited. + * @param reader Reader or buffer to decode from + * @returns StreamingPredictResponse + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1beta1.StreamingPredictResponse; + + /** + * Verifies a StreamingPredictResponse message. + * @param message Plain object to verify + * @returns `null` if valid, otherwise the reason why it is not + */ + public static verify(message: { [k: string]: any }): (string|null); + + /** + * Creates a StreamingPredictResponse message from a plain object. Also converts values to their respective internal types. + * @param object Plain object + * @returns StreamingPredictResponse + */ + public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1beta1.StreamingPredictResponse; + + /** + * Creates a plain object from a StreamingPredictResponse message. Also converts values to other types if specified. + * @param message StreamingPredictResponse + * @param [options] Conversion options + * @returns Plain object + */ + public static toObject(message: google.cloud.aiplatform.v1beta1.StreamingPredictResponse, options?: $protobuf.IConversionOptions): { [k: string]: any }; + + /** + * Converts this StreamingPredictResponse to JSON. + * @returns JSON object + */ + public toJSON(): { [k: string]: any }; + + /** + * Gets the default type url for StreamingPredictResponse + * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns The default type url + */ + public static getTypeUrl(typeUrlPrefix?: string): string; + } + /** Properties of an ExplainRequest. */ interface IExplainRequest { diff --git a/packages/google-cloud-aiplatform/protos/protos.js b/packages/google-cloud-aiplatform/protos/protos.js index 1fcc4d2f3b1..29973d23eb2 100644 --- a/packages/google-cloud-aiplatform/protos/protos.js +++ b/packages/google-cloud-aiplatform/protos/protos.js @@ -50676,6 +50676,951 @@ return StringArray; })(); + v1.Tensor = (function() { + + /** + * Properties of a Tensor. + * @memberof google.cloud.aiplatform.v1 + * @interface ITensor + * @property {google.cloud.aiplatform.v1.Tensor.DataType|null} [dtype] Tensor dtype + * @property {Array.|null} [shape] Tensor shape + * @property {Array.|null} [boolVal] Tensor boolVal + * @property {Array.|null} [stringVal] Tensor stringVal + * @property {Array.|null} [bytesVal] Tensor bytesVal + * @property {Array.|null} [floatVal] Tensor floatVal + * @property {Array.|null} [doubleVal] Tensor doubleVal + * @property {Array.|null} [intVal] Tensor intVal + * @property {Array.|null} [int64Val] Tensor int64Val + * @property {Array.|null} [uintVal] Tensor uintVal + * @property {Array.|null} [uint64Val] Tensor uint64Val + * @property {Array.|null} [listVal] Tensor listVal + * @property {Object.|null} [structVal] Tensor structVal + * @property {Uint8Array|null} [tensorVal] Tensor tensorVal + */ + + /** + * Constructs a new Tensor. + * @memberof google.cloud.aiplatform.v1 + * @classdesc Represents a Tensor. + * @implements ITensor + * @constructor + * @param {google.cloud.aiplatform.v1.ITensor=} [properties] Properties to set + */ + function Tensor(properties) { + this.shape = []; + this.boolVal = []; + this.stringVal = []; + this.bytesVal = []; + this.floatVal = []; + this.doubleVal = []; + this.intVal = []; + this.int64Val = []; + this.uintVal = []; + this.uint64Val = []; + this.listVal = []; + this.structVal = {}; + if (properties) + for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) + if (properties[keys[i]] != null) + this[keys[i]] = properties[keys[i]]; + } + + /** + * Tensor dtype. + * @member {google.cloud.aiplatform.v1.Tensor.DataType} dtype + * @memberof google.cloud.aiplatform.v1.Tensor + * @instance + */ + Tensor.prototype.dtype = 0; + + /** + * Tensor shape. + * @member {Array.} shape + * @memberof google.cloud.aiplatform.v1.Tensor + * @instance + */ + Tensor.prototype.shape = $util.emptyArray; + + /** + * Tensor boolVal. + * @member {Array.} boolVal + * @memberof google.cloud.aiplatform.v1.Tensor + * @instance + */ + Tensor.prototype.boolVal = $util.emptyArray; + + /** + * Tensor stringVal. + * @member {Array.} stringVal + * @memberof google.cloud.aiplatform.v1.Tensor + * @instance + */ + Tensor.prototype.stringVal = $util.emptyArray; + + /** + * Tensor bytesVal. + * @member {Array.} bytesVal + * @memberof google.cloud.aiplatform.v1.Tensor + * @instance + */ + Tensor.prototype.bytesVal = $util.emptyArray; + + /** + * Tensor floatVal. + * @member {Array.} floatVal + * @memberof google.cloud.aiplatform.v1.Tensor + * @instance + */ + Tensor.prototype.floatVal = $util.emptyArray; + + /** + * Tensor doubleVal. + * @member {Array.} doubleVal + * @memberof google.cloud.aiplatform.v1.Tensor + * @instance + */ + Tensor.prototype.doubleVal = $util.emptyArray; + + /** + * Tensor intVal. + * @member {Array.} intVal + * @memberof google.cloud.aiplatform.v1.Tensor + * @instance + */ + Tensor.prototype.intVal = $util.emptyArray; + + /** + * Tensor int64Val. + * @member {Array.} int64Val + * @memberof google.cloud.aiplatform.v1.Tensor + * @instance + */ + Tensor.prototype.int64Val = $util.emptyArray; + + /** + * Tensor uintVal. + * @member {Array.} uintVal + * @memberof google.cloud.aiplatform.v1.Tensor + * @instance + */ + Tensor.prototype.uintVal = $util.emptyArray; + + /** + * Tensor uint64Val. + * @member {Array.} uint64Val + * @memberof google.cloud.aiplatform.v1.Tensor + * @instance + */ + Tensor.prototype.uint64Val = $util.emptyArray; + + /** + * Tensor listVal. + * @member {Array.} listVal + * @memberof google.cloud.aiplatform.v1.Tensor + * @instance + */ + Tensor.prototype.listVal = $util.emptyArray; + + /** + * Tensor structVal. + * @member {Object.} structVal + * @memberof google.cloud.aiplatform.v1.Tensor + * @instance + */ + Tensor.prototype.structVal = $util.emptyObject; + + /** + * Tensor tensorVal. + * @member {Uint8Array} tensorVal + * @memberof google.cloud.aiplatform.v1.Tensor + * @instance + */ + Tensor.prototype.tensorVal = $util.newBuffer([]); + + /** + * Creates a new Tensor instance using the specified properties. + * @function create + * @memberof google.cloud.aiplatform.v1.Tensor + * @static + * @param {google.cloud.aiplatform.v1.ITensor=} [properties] Properties to set + * @returns {google.cloud.aiplatform.v1.Tensor} Tensor instance + */ + Tensor.create = function create(properties) { + return new Tensor(properties); + }; + + /** + * Encodes the specified Tensor message. Does not implicitly {@link google.cloud.aiplatform.v1.Tensor.verify|verify} messages. + * @function encode + * @memberof google.cloud.aiplatform.v1.Tensor + * @static + * @param {google.cloud.aiplatform.v1.ITensor} message Tensor message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + Tensor.encode = function encode(message, writer) { + if (!writer) + writer = $Writer.create(); + if (message.dtype != null && Object.hasOwnProperty.call(message, "dtype")) + writer.uint32(/* id 1, wireType 0 =*/8).int32(message.dtype); + if (message.shape != null && message.shape.length) { + writer.uint32(/* id 2, wireType 2 =*/18).fork(); + for (var i = 0; i < message.shape.length; ++i) + writer.int64(message.shape[i]); + writer.ldelim(); + } + if (message.boolVal != null && message.boolVal.length) { + writer.uint32(/* id 3, wireType 2 =*/26).fork(); + for (var i = 0; i < message.boolVal.length; ++i) + writer.bool(message.boolVal[i]); + writer.ldelim(); + } + if (message.floatVal != null && message.floatVal.length) { + writer.uint32(/* id 5, wireType 2 =*/42).fork(); + for (var i = 0; i < message.floatVal.length; ++i) + writer.float(message.floatVal[i]); + writer.ldelim(); + } + if (message.doubleVal != null && message.doubleVal.length) { + writer.uint32(/* id 6, wireType 2 =*/50).fork(); + for (var i = 0; i < message.doubleVal.length; ++i) + writer.double(message.doubleVal[i]); + writer.ldelim(); + } + if (message.intVal != null && message.intVal.length) { + writer.uint32(/* id 7, wireType 2 =*/58).fork(); + for (var i = 0; i < message.intVal.length; ++i) + writer.int32(message.intVal[i]); + writer.ldelim(); + } + if (message.int64Val != null && message.int64Val.length) { + writer.uint32(/* id 8, wireType 2 =*/66).fork(); + for (var i = 0; i < message.int64Val.length; ++i) + writer.int64(message.int64Val[i]); + writer.ldelim(); + } + if (message.uintVal != null && message.uintVal.length) { + writer.uint32(/* id 9, wireType 2 =*/74).fork(); + for (var i = 0; i < message.uintVal.length; ++i) + writer.uint32(message.uintVal[i]); + writer.ldelim(); + } + if (message.uint64Val != null && message.uint64Val.length) { + writer.uint32(/* id 10, wireType 2 =*/82).fork(); + for (var i = 0; i < message.uint64Val.length; ++i) + writer.uint64(message.uint64Val[i]); + writer.ldelim(); + } + if (message.listVal != null && message.listVal.length) + for (var i = 0; i < message.listVal.length; ++i) + $root.google.cloud.aiplatform.v1.Tensor.encode(message.listVal[i], writer.uint32(/* id 11, wireType 2 =*/90).fork()).ldelim(); + if (message.structVal != null && Object.hasOwnProperty.call(message, "structVal")) + for (var keys = Object.keys(message.structVal), i = 0; i < keys.length; ++i) { + writer.uint32(/* id 12, wireType 2 =*/98).fork().uint32(/* id 1, wireType 2 =*/10).string(keys[i]); + $root.google.cloud.aiplatform.v1.Tensor.encode(message.structVal[keys[i]], writer.uint32(/* id 2, wireType 2 =*/18).fork()).ldelim().ldelim(); + } + if (message.tensorVal != null && Object.hasOwnProperty.call(message, "tensorVal")) + writer.uint32(/* id 13, wireType 2 =*/106).bytes(message.tensorVal); + if (message.stringVal != null && message.stringVal.length) + for (var i = 0; i < message.stringVal.length; ++i) + writer.uint32(/* id 14, wireType 2 =*/114).string(message.stringVal[i]); + if (message.bytesVal != null && message.bytesVal.length) + for (var i = 0; i < message.bytesVal.length; ++i) + writer.uint32(/* id 15, wireType 2 =*/122).bytes(message.bytesVal[i]); + return writer; + }; + + /** + * Encodes the specified Tensor message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.Tensor.verify|verify} messages. + * @function encodeDelimited + * @memberof google.cloud.aiplatform.v1.Tensor + * @static + * @param {google.cloud.aiplatform.v1.ITensor} message Tensor message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + Tensor.encodeDelimited = function encodeDelimited(message, writer) { + return this.encode(message, writer).ldelim(); + }; + + /** + * Decodes a Tensor message from the specified reader or buffer. + * @function decode + * @memberof google.cloud.aiplatform.v1.Tensor + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @param {number} [length] Message length if known beforehand + * @returns {google.cloud.aiplatform.v1.Tensor} Tensor + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + Tensor.decode = function decode(reader, length) { + if (!(reader instanceof $Reader)) + reader = $Reader.create(reader); + var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.aiplatform.v1.Tensor(), key, value; + while (reader.pos < end) { + var tag = reader.uint32(); + switch (tag >>> 3) { + case 1: { + message.dtype = reader.int32(); + break; + } + case 2: { + if (!(message.shape && message.shape.length)) + message.shape = []; + if ((tag & 7) === 2) { + var end2 = reader.uint32() + reader.pos; + while (reader.pos < end2) + message.shape.push(reader.int64()); + } else + message.shape.push(reader.int64()); + break; + } + case 3: { + if (!(message.boolVal && message.boolVal.length)) + message.boolVal = []; + if ((tag & 7) === 2) { + var end2 = reader.uint32() + reader.pos; + while (reader.pos < end2) + message.boolVal.push(reader.bool()); + } else + message.boolVal.push(reader.bool()); + break; + } + case 14: { + if (!(message.stringVal && message.stringVal.length)) + message.stringVal = []; + message.stringVal.push(reader.string()); + break; + } + case 15: { + if (!(message.bytesVal && message.bytesVal.length)) + message.bytesVal = []; + message.bytesVal.push(reader.bytes()); + break; + } + case 5: { + if (!(message.floatVal && message.floatVal.length)) + message.floatVal = []; + if ((tag & 7) === 2) { + var end2 = reader.uint32() + reader.pos; + while (reader.pos < end2) + message.floatVal.push(reader.float()); + } else + message.floatVal.push(reader.float()); + break; + } + case 6: { + if (!(message.doubleVal && message.doubleVal.length)) + message.doubleVal = []; + if ((tag & 7) === 2) { + var end2 = reader.uint32() + reader.pos; + while (reader.pos < end2) + message.doubleVal.push(reader.double()); + } else + message.doubleVal.push(reader.double()); + break; + } + case 7: { + if (!(message.intVal && message.intVal.length)) + message.intVal = []; + if ((tag & 7) === 2) { + var end2 = reader.uint32() + reader.pos; + while (reader.pos < end2) + message.intVal.push(reader.int32()); + } else + message.intVal.push(reader.int32()); + break; + } + case 8: { + if (!(message.int64Val && message.int64Val.length)) + message.int64Val = []; + if ((tag & 7) === 2) { + var end2 = reader.uint32() + reader.pos; + while (reader.pos < end2) + message.int64Val.push(reader.int64()); + } else + message.int64Val.push(reader.int64()); + break; + } + case 9: { + if (!(message.uintVal && message.uintVal.length)) + message.uintVal = []; + if ((tag & 7) === 2) { + var end2 = reader.uint32() + reader.pos; + while (reader.pos < end2) + message.uintVal.push(reader.uint32()); + } else + message.uintVal.push(reader.uint32()); + break; + } + case 10: { + if (!(message.uint64Val && message.uint64Val.length)) + message.uint64Val = []; + if ((tag & 7) === 2) { + var end2 = reader.uint32() + reader.pos; + while (reader.pos < end2) + message.uint64Val.push(reader.uint64()); + } else + message.uint64Val.push(reader.uint64()); + break; + } + case 11: { + if (!(message.listVal && message.listVal.length)) + message.listVal = []; + message.listVal.push($root.google.cloud.aiplatform.v1.Tensor.decode(reader, reader.uint32())); + break; + } + case 12: { + if (message.structVal === $util.emptyObject) + message.structVal = {}; + var end2 = reader.uint32() + reader.pos; + key = ""; + value = null; + while (reader.pos < end2) { + var tag2 = reader.uint32(); + switch (tag2 >>> 3) { + case 1: + key = reader.string(); + break; + case 2: + value = $root.google.cloud.aiplatform.v1.Tensor.decode(reader, reader.uint32()); + break; + default: + reader.skipType(tag2 & 7); + break; + } + } + message.structVal[key] = value; + break; + } + case 13: { + message.tensorVal = reader.bytes(); + break; + } + default: + reader.skipType(tag & 7); + break; + } + } + return message; + }; + + /** + * Decodes a Tensor message from the specified reader or buffer, length delimited. + * @function decodeDelimited + * @memberof google.cloud.aiplatform.v1.Tensor + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @returns {google.cloud.aiplatform.v1.Tensor} Tensor + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + Tensor.decodeDelimited = function decodeDelimited(reader) { + if (!(reader instanceof $Reader)) + reader = new $Reader(reader); + return this.decode(reader, reader.uint32()); + }; + + /** + * Verifies a Tensor message. + * @function verify + * @memberof google.cloud.aiplatform.v1.Tensor + * @static + * @param {Object.} message Plain object to verify + * @returns {string|null} `null` if valid, otherwise the reason why it is not + */ + Tensor.verify = function verify(message) { + if (typeof message !== "object" || message === null) + return "object expected"; + if (message.dtype != null && message.hasOwnProperty("dtype")) + switch (message.dtype) { + default: + return "dtype: enum value expected"; + case 0: + case 1: + case 2: + case 3: + case 4: + case 5: + case 6: + case 7: + case 8: + case 9: + case 10: + case 11: + case 12: + break; + } + if (message.shape != null && message.hasOwnProperty("shape")) { + if (!Array.isArray(message.shape)) + return "shape: array expected"; + for (var i = 0; i < message.shape.length; ++i) + if (!$util.isInteger(message.shape[i]) && !(message.shape[i] && $util.isInteger(message.shape[i].low) && $util.isInteger(message.shape[i].high))) + return "shape: integer|Long[] expected"; + } + if (message.boolVal != null && message.hasOwnProperty("boolVal")) { + if (!Array.isArray(message.boolVal)) + return "boolVal: array expected"; + for (var i = 0; i < message.boolVal.length; ++i) + if (typeof message.boolVal[i] !== "boolean") + return "boolVal: boolean[] expected"; + } + if (message.stringVal != null && message.hasOwnProperty("stringVal")) { + if (!Array.isArray(message.stringVal)) + return "stringVal: array expected"; + for (var i = 0; i < message.stringVal.length; ++i) + if (!$util.isString(message.stringVal[i])) + return "stringVal: string[] expected"; + } + if (message.bytesVal != null && message.hasOwnProperty("bytesVal")) { + if (!Array.isArray(message.bytesVal)) + return "bytesVal: array expected"; + for (var i = 0; i < message.bytesVal.length; ++i) + if (!(message.bytesVal[i] && typeof message.bytesVal[i].length === "number" || $util.isString(message.bytesVal[i]))) + return "bytesVal: buffer[] expected"; + } + if (message.floatVal != null && message.hasOwnProperty("floatVal")) { + if (!Array.isArray(message.floatVal)) + return "floatVal: array expected"; + for (var i = 0; i < message.floatVal.length; ++i) + if (typeof message.floatVal[i] !== "number") + return "floatVal: number[] expected"; + } + if (message.doubleVal != null && message.hasOwnProperty("doubleVal")) { + if (!Array.isArray(message.doubleVal)) + return "doubleVal: array expected"; + for (var i = 0; i < message.doubleVal.length; ++i) + if (typeof message.doubleVal[i] !== "number") + return "doubleVal: number[] expected"; + } + if (message.intVal != null && message.hasOwnProperty("intVal")) { + if (!Array.isArray(message.intVal)) + return "intVal: array expected"; + for (var i = 0; i < message.intVal.length; ++i) + if (!$util.isInteger(message.intVal[i])) + return "intVal: integer[] expected"; + } + if (message.int64Val != null && message.hasOwnProperty("int64Val")) { + if (!Array.isArray(message.int64Val)) + return "int64Val: array expected"; + for (var i = 0; i < message.int64Val.length; ++i) + if (!$util.isInteger(message.int64Val[i]) && !(message.int64Val[i] && $util.isInteger(message.int64Val[i].low) && $util.isInteger(message.int64Val[i].high))) + return "int64Val: integer|Long[] expected"; + } + if (message.uintVal != null && message.hasOwnProperty("uintVal")) { + if (!Array.isArray(message.uintVal)) + return "uintVal: array expected"; + for (var i = 0; i < message.uintVal.length; ++i) + if (!$util.isInteger(message.uintVal[i])) + return "uintVal: integer[] expected"; + } + if (message.uint64Val != null && message.hasOwnProperty("uint64Val")) { + if (!Array.isArray(message.uint64Val)) + return "uint64Val: array expected"; + for (var i = 0; i < message.uint64Val.length; ++i) + if (!$util.isInteger(message.uint64Val[i]) && !(message.uint64Val[i] && $util.isInteger(message.uint64Val[i].low) && $util.isInteger(message.uint64Val[i].high))) + return "uint64Val: integer|Long[] expected"; + } + if (message.listVal != null && message.hasOwnProperty("listVal")) { + if (!Array.isArray(message.listVal)) + return "listVal: array expected"; + for (var i = 0; i < message.listVal.length; ++i) { + var error = $root.google.cloud.aiplatform.v1.Tensor.verify(message.listVal[i]); + if (error) + return "listVal." + error; + } + } + if (message.structVal != null && message.hasOwnProperty("structVal")) { + if (!$util.isObject(message.structVal)) + return "structVal: object expected"; + var key = Object.keys(message.structVal); + for (var i = 0; i < key.length; ++i) { + var error = $root.google.cloud.aiplatform.v1.Tensor.verify(message.structVal[key[i]]); + if (error) + return "structVal." + error; + } + } + if (message.tensorVal != null && message.hasOwnProperty("tensorVal")) + if (!(message.tensorVal && typeof message.tensorVal.length === "number" || $util.isString(message.tensorVal))) + return "tensorVal: buffer expected"; + return null; + }; + + /** + * Creates a Tensor message from a plain object. Also converts values to their respective internal types. + * @function fromObject + * @memberof google.cloud.aiplatform.v1.Tensor + * @static + * @param {Object.} object Plain object + * @returns {google.cloud.aiplatform.v1.Tensor} Tensor + */ + Tensor.fromObject = function fromObject(object) { + if (object instanceof $root.google.cloud.aiplatform.v1.Tensor) + return object; + var message = new $root.google.cloud.aiplatform.v1.Tensor(); + switch (object.dtype) { + default: + if (typeof object.dtype === "number") { + message.dtype = object.dtype; + break; + } + break; + case "DATA_TYPE_UNSPECIFIED": + case 0: + message.dtype = 0; + break; + case "BOOL": + case 1: + message.dtype = 1; + break; + case "STRING": + case 2: + message.dtype = 2; + break; + case "FLOAT": + case 3: + message.dtype = 3; + break; + case "DOUBLE": + case 4: + message.dtype = 4; + break; + case "INT8": + case 5: + message.dtype = 5; + break; + case "INT16": + case 6: + message.dtype = 6; + break; + case "INT32": + case 7: + message.dtype = 7; + break; + case "INT64": + case 8: + message.dtype = 8; + break; + case "UINT8": + case 9: + message.dtype = 9; + break; + case "UINT16": + case 10: + message.dtype = 10; + break; + case "UINT32": + case 11: + message.dtype = 11; + break; + case "UINT64": + case 12: + message.dtype = 12; + break; + } + if (object.shape) { + if (!Array.isArray(object.shape)) + throw TypeError(".google.cloud.aiplatform.v1.Tensor.shape: array expected"); + message.shape = []; + for (var i = 0; i < object.shape.length; ++i) + if ($util.Long) + (message.shape[i] = $util.Long.fromValue(object.shape[i])).unsigned = false; + else if (typeof object.shape[i] === "string") + message.shape[i] = parseInt(object.shape[i], 10); + else if (typeof object.shape[i] === "number") + message.shape[i] = object.shape[i]; + else if (typeof object.shape[i] === "object") + message.shape[i] = new $util.LongBits(object.shape[i].low >>> 0, object.shape[i].high >>> 0).toNumber(); + } + if (object.boolVal) { + if (!Array.isArray(object.boolVal)) + throw TypeError(".google.cloud.aiplatform.v1.Tensor.boolVal: array expected"); + message.boolVal = []; + for (var i = 0; i < object.boolVal.length; ++i) + message.boolVal[i] = Boolean(object.boolVal[i]); + } + if (object.stringVal) { + if (!Array.isArray(object.stringVal)) + throw TypeError(".google.cloud.aiplatform.v1.Tensor.stringVal: array expected"); + message.stringVal = []; + for (var i = 0; i < object.stringVal.length; ++i) + message.stringVal[i] = String(object.stringVal[i]); + } + if (object.bytesVal) { + if (!Array.isArray(object.bytesVal)) + throw TypeError(".google.cloud.aiplatform.v1.Tensor.bytesVal: array expected"); + message.bytesVal = []; + for (var i = 0; i < object.bytesVal.length; ++i) + if (typeof object.bytesVal[i] === "string") + $util.base64.decode(object.bytesVal[i], message.bytesVal[i] = $util.newBuffer($util.base64.length(object.bytesVal[i])), 0); + else if (object.bytesVal[i].length >= 0) + message.bytesVal[i] = object.bytesVal[i]; + } + if (object.floatVal) { + if (!Array.isArray(object.floatVal)) + throw TypeError(".google.cloud.aiplatform.v1.Tensor.floatVal: array expected"); + message.floatVal = []; + for (var i = 0; i < object.floatVal.length; ++i) + message.floatVal[i] = Number(object.floatVal[i]); + } + if (object.doubleVal) { + if (!Array.isArray(object.doubleVal)) + throw TypeError(".google.cloud.aiplatform.v1.Tensor.doubleVal: array expected"); + message.doubleVal = []; + for (var i = 0; i < object.doubleVal.length; ++i) + message.doubleVal[i] = Number(object.doubleVal[i]); + } + if (object.intVal) { + if (!Array.isArray(object.intVal)) + throw TypeError(".google.cloud.aiplatform.v1.Tensor.intVal: array expected"); + message.intVal = []; + for (var i = 0; i < object.intVal.length; ++i) + message.intVal[i] = object.intVal[i] | 0; + } + if (object.int64Val) { + if (!Array.isArray(object.int64Val)) + throw TypeError(".google.cloud.aiplatform.v1.Tensor.int64Val: array expected"); + message.int64Val = []; + for (var i = 0; i < object.int64Val.length; ++i) + if ($util.Long) + (message.int64Val[i] = $util.Long.fromValue(object.int64Val[i])).unsigned = false; + else if (typeof object.int64Val[i] === "string") + message.int64Val[i] = parseInt(object.int64Val[i], 10); + else if (typeof object.int64Val[i] === "number") + message.int64Val[i] = object.int64Val[i]; + else if (typeof object.int64Val[i] === "object") + message.int64Val[i] = new $util.LongBits(object.int64Val[i].low >>> 0, object.int64Val[i].high >>> 0).toNumber(); + } + if (object.uintVal) { + if (!Array.isArray(object.uintVal)) + throw TypeError(".google.cloud.aiplatform.v1.Tensor.uintVal: array expected"); + message.uintVal = []; + for (var i = 0; i < object.uintVal.length; ++i) + message.uintVal[i] = object.uintVal[i] >>> 0; + } + if (object.uint64Val) { + if (!Array.isArray(object.uint64Val)) + throw TypeError(".google.cloud.aiplatform.v1.Tensor.uint64Val: array expected"); + message.uint64Val = []; + for (var i = 0; i < object.uint64Val.length; ++i) + if ($util.Long) + (message.uint64Val[i] = $util.Long.fromValue(object.uint64Val[i])).unsigned = true; + else if (typeof object.uint64Val[i] === "string") + message.uint64Val[i] = parseInt(object.uint64Val[i], 10); + else if (typeof object.uint64Val[i] === "number") + message.uint64Val[i] = object.uint64Val[i]; + else if (typeof object.uint64Val[i] === "object") + message.uint64Val[i] = new $util.LongBits(object.uint64Val[i].low >>> 0, object.uint64Val[i].high >>> 0).toNumber(true); + } + if (object.listVal) { + if (!Array.isArray(object.listVal)) + throw TypeError(".google.cloud.aiplatform.v1.Tensor.listVal: array expected"); + message.listVal = []; + for (var i = 0; i < object.listVal.length; ++i) { + if (typeof object.listVal[i] !== "object") + throw TypeError(".google.cloud.aiplatform.v1.Tensor.listVal: object expected"); + message.listVal[i] = $root.google.cloud.aiplatform.v1.Tensor.fromObject(object.listVal[i]); + } + } + if (object.structVal) { + if (typeof object.structVal !== "object") + throw TypeError(".google.cloud.aiplatform.v1.Tensor.structVal: object expected"); + message.structVal = {}; + for (var keys = Object.keys(object.structVal), i = 0; i < keys.length; ++i) { + if (typeof object.structVal[keys[i]] !== "object") + throw TypeError(".google.cloud.aiplatform.v1.Tensor.structVal: object expected"); + message.structVal[keys[i]] = $root.google.cloud.aiplatform.v1.Tensor.fromObject(object.structVal[keys[i]]); + } + } + if (object.tensorVal != null) + if (typeof object.tensorVal === "string") + $util.base64.decode(object.tensorVal, message.tensorVal = $util.newBuffer($util.base64.length(object.tensorVal)), 0); + else if (object.tensorVal.length >= 0) + message.tensorVal = object.tensorVal; + return message; + }; + + /** + * Creates a plain object from a Tensor message. Also converts values to other types if specified. + * @function toObject + * @memberof google.cloud.aiplatform.v1.Tensor + * @static + * @param {google.cloud.aiplatform.v1.Tensor} message Tensor + * @param {$protobuf.IConversionOptions} [options] Conversion options + * @returns {Object.} Plain object + */ + Tensor.toObject = function toObject(message, options) { + if (!options) + options = {}; + var object = {}; + if (options.arrays || options.defaults) { + object.shape = []; + object.boolVal = []; + object.floatVal = []; + object.doubleVal = []; + object.intVal = []; + object.int64Val = []; + object.uintVal = []; + object.uint64Val = []; + object.listVal = []; + object.stringVal = []; + object.bytesVal = []; + } + if (options.objects || options.defaults) + object.structVal = {}; + if (options.defaults) { + object.dtype = options.enums === String ? "DATA_TYPE_UNSPECIFIED" : 0; + if (options.bytes === String) + object.tensorVal = ""; + else { + object.tensorVal = []; + if (options.bytes !== Array) + object.tensorVal = $util.newBuffer(object.tensorVal); + } + } + if (message.dtype != null && message.hasOwnProperty("dtype")) + object.dtype = options.enums === String ? $root.google.cloud.aiplatform.v1.Tensor.DataType[message.dtype] === undefined ? message.dtype : $root.google.cloud.aiplatform.v1.Tensor.DataType[message.dtype] : message.dtype; + if (message.shape && message.shape.length) { + object.shape = []; + for (var j = 0; j < message.shape.length; ++j) + if (typeof message.shape[j] === "number") + object.shape[j] = options.longs === String ? String(message.shape[j]) : message.shape[j]; + else + object.shape[j] = options.longs === String ? $util.Long.prototype.toString.call(message.shape[j]) : options.longs === Number ? new $util.LongBits(message.shape[j].low >>> 0, message.shape[j].high >>> 0).toNumber() : message.shape[j]; + } + if (message.boolVal && message.boolVal.length) { + object.boolVal = []; + for (var j = 0; j < message.boolVal.length; ++j) + object.boolVal[j] = message.boolVal[j]; + } + if (message.floatVal && message.floatVal.length) { + object.floatVal = []; + for (var j = 0; j < message.floatVal.length; ++j) + object.floatVal[j] = options.json && !isFinite(message.floatVal[j]) ? String(message.floatVal[j]) : message.floatVal[j]; + } + if (message.doubleVal && message.doubleVal.length) { + object.doubleVal = []; + for (var j = 0; j < message.doubleVal.length; ++j) + object.doubleVal[j] = options.json && !isFinite(message.doubleVal[j]) ? String(message.doubleVal[j]) : message.doubleVal[j]; + } + if (message.intVal && message.intVal.length) { + object.intVal = []; + for (var j = 0; j < message.intVal.length; ++j) + object.intVal[j] = message.intVal[j]; + } + if (message.int64Val && message.int64Val.length) { + object.int64Val = []; + for (var j = 0; j < message.int64Val.length; ++j) + if (typeof message.int64Val[j] === "number") + object.int64Val[j] = options.longs === String ? String(message.int64Val[j]) : message.int64Val[j]; + else + object.int64Val[j] = options.longs === String ? $util.Long.prototype.toString.call(message.int64Val[j]) : options.longs === Number ? new $util.LongBits(message.int64Val[j].low >>> 0, message.int64Val[j].high >>> 0).toNumber() : message.int64Val[j]; + } + if (message.uintVal && message.uintVal.length) { + object.uintVal = []; + for (var j = 0; j < message.uintVal.length; ++j) + object.uintVal[j] = message.uintVal[j]; + } + if (message.uint64Val && message.uint64Val.length) { + object.uint64Val = []; + for (var j = 0; j < message.uint64Val.length; ++j) + if (typeof message.uint64Val[j] === "number") + object.uint64Val[j] = options.longs === String ? String(message.uint64Val[j]) : message.uint64Val[j]; + else + object.uint64Val[j] = options.longs === String ? $util.Long.prototype.toString.call(message.uint64Val[j]) : options.longs === Number ? new $util.LongBits(message.uint64Val[j].low >>> 0, message.uint64Val[j].high >>> 0).toNumber(true) : message.uint64Val[j]; + } + if (message.listVal && message.listVal.length) { + object.listVal = []; + for (var j = 0; j < message.listVal.length; ++j) + object.listVal[j] = $root.google.cloud.aiplatform.v1.Tensor.toObject(message.listVal[j], options); + } + var keys2; + if (message.structVal && (keys2 = Object.keys(message.structVal)).length) { + object.structVal = {}; + for (var j = 0; j < keys2.length; ++j) + object.structVal[keys2[j]] = $root.google.cloud.aiplatform.v1.Tensor.toObject(message.structVal[keys2[j]], options); + } + if (message.tensorVal != null && message.hasOwnProperty("tensorVal")) + object.tensorVal = options.bytes === String ? $util.base64.encode(message.tensorVal, 0, message.tensorVal.length) : options.bytes === Array ? Array.prototype.slice.call(message.tensorVal) : message.tensorVal; + if (message.stringVal && message.stringVal.length) { + object.stringVal = []; + for (var j = 0; j < message.stringVal.length; ++j) + object.stringVal[j] = message.stringVal[j]; + } + if (message.bytesVal && message.bytesVal.length) { + object.bytesVal = []; + for (var j = 0; j < message.bytesVal.length; ++j) + object.bytesVal[j] = options.bytes === String ? $util.base64.encode(message.bytesVal[j], 0, message.bytesVal[j].length) : options.bytes === Array ? Array.prototype.slice.call(message.bytesVal[j]) : message.bytesVal[j]; + } + return object; + }; + + /** + * Converts this Tensor to JSON. + * @function toJSON + * @memberof google.cloud.aiplatform.v1.Tensor + * @instance + * @returns {Object.} JSON object + */ + Tensor.prototype.toJSON = function toJSON() { + return this.constructor.toObject(this, $protobuf.util.toJSONOptions); + }; + + /** + * Gets the default type url for Tensor + * @function getTypeUrl + * @memberof google.cloud.aiplatform.v1.Tensor + * @static + * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns {string} The default type url + */ + Tensor.getTypeUrl = function getTypeUrl(typeUrlPrefix) { + if (typeUrlPrefix === undefined) { + typeUrlPrefix = "type.googleapis.com"; + } + return typeUrlPrefix + "/google.cloud.aiplatform.v1.Tensor"; + }; + + /** + * DataType enum. + * @name google.cloud.aiplatform.v1.Tensor.DataType + * @enum {number} + * @property {number} DATA_TYPE_UNSPECIFIED=0 DATA_TYPE_UNSPECIFIED value + * @property {number} BOOL=1 BOOL value + * @property {number} STRING=2 STRING value + * @property {number} FLOAT=3 FLOAT value + * @property {number} DOUBLE=4 DOUBLE value + * @property {number} INT8=5 INT8 value + * @property {number} INT16=6 INT16 value + * @property {number} INT32=7 INT32 value + * @property {number} INT64=8 INT64 value + * @property {number} UINT8=9 UINT8 value + * @property {number} UINT16=10 UINT16 value + * @property {number} UINT32=11 UINT32 value + * @property {number} UINT64=12 UINT64 value + */ + Tensor.DataType = (function() { + var valuesById = {}, values = Object.create(valuesById); + values[valuesById[0] = "DATA_TYPE_UNSPECIFIED"] = 0; + values[valuesById[1] = "BOOL"] = 1; + values[valuesById[2] = "STRING"] = 2; + values[valuesById[3] = "FLOAT"] = 3; + values[valuesById[4] = "DOUBLE"] = 4; + values[valuesById[5] = "INT8"] = 5; + values[valuesById[6] = "INT16"] = 6; + values[valuesById[7] = "INT32"] = 7; + values[valuesById[8] = "INT64"] = 8; + values[valuesById[9] = "UINT8"] = 9; + values[valuesById[10] = "UINT16"] = 10; + values[valuesById[11] = "UINT32"] = 11; + values[valuesById[12] = "UINT64"] = 12; + return values; + })(); + + return Tensor; + })(); + v1.FeaturestoreService = (function() { /** @@ -148405,6 +149350,39 @@ * @variation 2 */ + /** + * Callback as used by {@link google.cloud.aiplatform.v1.PredictionService|serverStreamingPredict}. + * @memberof google.cloud.aiplatform.v1.PredictionService + * @typedef ServerStreamingPredictCallback + * @type {function} + * @param {Error|null} error Error, if any + * @param {google.cloud.aiplatform.v1.StreamingPredictResponse} [response] StreamingPredictResponse + */ + + /** + * Calls ServerStreamingPredict. + * @function serverStreamingPredict + * @memberof google.cloud.aiplatform.v1.PredictionService + * @instance + * @param {google.cloud.aiplatform.v1.IStreamingPredictRequest} request StreamingPredictRequest message or plain object + * @param {google.cloud.aiplatform.v1.PredictionService.ServerStreamingPredictCallback} callback Node-style callback called with the error, if any, and StreamingPredictResponse + * @returns {undefined} + * @variation 1 + */ + Object.defineProperty(PredictionService.prototype.serverStreamingPredict = function serverStreamingPredict(request, callback) { + return this.rpcCall(serverStreamingPredict, $root.google.cloud.aiplatform.v1.StreamingPredictRequest, $root.google.cloud.aiplatform.v1.StreamingPredictResponse, request, callback); + }, "name", { value: "ServerStreamingPredict" }); + + /** + * Calls ServerStreamingPredict. + * @function serverStreamingPredict + * @memberof google.cloud.aiplatform.v1.PredictionService + * @instance + * @param {google.cloud.aiplatform.v1.IStreamingPredictRequest} request StreamingPredictRequest message or plain object + * @returns {Promise} Promise + * @variation 2 + */ + /** * Callback as used by {@link google.cloud.aiplatform.v1.PredictionService|explain}. * @memberof google.cloud.aiplatform.v1.PredictionService @@ -148729,6 +149707,7 @@ * @property {string|null} [model] PredictResponse model * @property {string|null} [modelVersionId] PredictResponse modelVersionId * @property {string|null} [modelDisplayName] PredictResponse modelDisplayName + * @property {google.protobuf.IValue|null} [metadata] PredictResponse metadata */ /** @@ -148787,6 +149766,14 @@ */ PredictResponse.prototype.modelDisplayName = ""; + /** + * PredictResponse metadata. + * @member {google.protobuf.IValue|null|undefined} metadata + * @memberof google.cloud.aiplatform.v1.PredictResponse + * @instance + */ + PredictResponse.prototype.metadata = null; + /** * Creates a new PredictResponse instance using the specified properties. * @function create @@ -148822,6 +149809,8 @@ writer.uint32(/* id 4, wireType 2 =*/34).string(message.modelDisplayName); if (message.modelVersionId != null && Object.hasOwnProperty.call(message, "modelVersionId")) writer.uint32(/* id 5, wireType 2 =*/42).string(message.modelVersionId); + if (message.metadata != null && Object.hasOwnProperty.call(message, "metadata")) + $root.google.protobuf.Value.encode(message.metadata, writer.uint32(/* id 6, wireType 2 =*/50).fork()).ldelim(); return writer; }; @@ -148878,6 +149867,10 @@ message.modelDisplayName = reader.string(); break; } + case 6: { + message.metadata = $root.google.protobuf.Value.decode(reader, reader.uint32()); + break; + } default: reader.skipType(tag & 7); break; @@ -148934,6 +149927,11 @@ if (message.modelDisplayName != null && message.hasOwnProperty("modelDisplayName")) if (!$util.isString(message.modelDisplayName)) return "modelDisplayName: string expected"; + if (message.metadata != null && message.hasOwnProperty("metadata")) { + var error = $root.google.protobuf.Value.verify(message.metadata); + if (error) + return "metadata." + error; + } return null; }; @@ -148967,6 +149965,11 @@ message.modelVersionId = String(object.modelVersionId); if (object.modelDisplayName != null) message.modelDisplayName = String(object.modelDisplayName); + if (object.metadata != null) { + if (typeof object.metadata !== "object") + throw TypeError(".google.cloud.aiplatform.v1.PredictResponse.metadata: object expected"); + message.metadata = $root.google.protobuf.Value.fromObject(object.metadata); + } return message; }; @@ -148990,6 +149993,7 @@ object.model = ""; object.modelDisplayName = ""; object.modelVersionId = ""; + object.metadata = null; } if (message.predictions && message.predictions.length) { object.predictions = []; @@ -149004,6 +150008,8 @@ object.modelDisplayName = message.modelDisplayName; if (message.modelVersionId != null && message.hasOwnProperty("modelVersionId")) object.modelVersionId = message.modelVersionId; + if (message.metadata != null && message.hasOwnProperty("metadata")) + object.metadata = $root.google.protobuf.Value.toObject(message.metadata, options); return object; }; @@ -149268,6 +150274,536 @@ return RawPredictRequest; })(); + v1.StreamingPredictRequest = (function() { + + /** + * Properties of a StreamingPredictRequest. + * @memberof google.cloud.aiplatform.v1 + * @interface IStreamingPredictRequest + * @property {string|null} [endpoint] StreamingPredictRequest endpoint + * @property {Array.|null} [inputs] StreamingPredictRequest inputs + * @property {google.cloud.aiplatform.v1.ITensor|null} [parameters] StreamingPredictRequest parameters + */ + + /** + * Constructs a new StreamingPredictRequest. + * @memberof google.cloud.aiplatform.v1 + * @classdesc Represents a StreamingPredictRequest. + * @implements IStreamingPredictRequest + * @constructor + * @param {google.cloud.aiplatform.v1.IStreamingPredictRequest=} [properties] Properties to set + */ + function StreamingPredictRequest(properties) { + this.inputs = []; + if (properties) + for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) + if (properties[keys[i]] != null) + this[keys[i]] = properties[keys[i]]; + } + + /** + * StreamingPredictRequest endpoint. + * @member {string} endpoint + * @memberof google.cloud.aiplatform.v1.StreamingPredictRequest + * @instance + */ + StreamingPredictRequest.prototype.endpoint = ""; + + /** + * StreamingPredictRequest inputs. + * @member {Array.} inputs + * @memberof google.cloud.aiplatform.v1.StreamingPredictRequest + * @instance + */ + StreamingPredictRequest.prototype.inputs = $util.emptyArray; + + /** + * StreamingPredictRequest parameters. + * @member {google.cloud.aiplatform.v1.ITensor|null|undefined} parameters + * @memberof google.cloud.aiplatform.v1.StreamingPredictRequest + * @instance + */ + StreamingPredictRequest.prototype.parameters = null; + + /** + * Creates a new StreamingPredictRequest instance using the specified properties. + * @function create + * @memberof google.cloud.aiplatform.v1.StreamingPredictRequest + * @static + * @param {google.cloud.aiplatform.v1.IStreamingPredictRequest=} [properties] Properties to set + * @returns {google.cloud.aiplatform.v1.StreamingPredictRequest} StreamingPredictRequest instance + */ + StreamingPredictRequest.create = function create(properties) { + return new StreamingPredictRequest(properties); + }; + + /** + * Encodes the specified StreamingPredictRequest message. Does not implicitly {@link google.cloud.aiplatform.v1.StreamingPredictRequest.verify|verify} messages. + * @function encode + * @memberof google.cloud.aiplatform.v1.StreamingPredictRequest + * @static + * @param {google.cloud.aiplatform.v1.IStreamingPredictRequest} message StreamingPredictRequest message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + StreamingPredictRequest.encode = function encode(message, writer) { + if (!writer) + writer = $Writer.create(); + if (message.endpoint != null && Object.hasOwnProperty.call(message, "endpoint")) + writer.uint32(/* id 1, wireType 2 =*/10).string(message.endpoint); + if (message.inputs != null && message.inputs.length) + for (var i = 0; i < message.inputs.length; ++i) + $root.google.cloud.aiplatform.v1.Tensor.encode(message.inputs[i], writer.uint32(/* id 2, wireType 2 =*/18).fork()).ldelim(); + if (message.parameters != null && Object.hasOwnProperty.call(message, "parameters")) + $root.google.cloud.aiplatform.v1.Tensor.encode(message.parameters, writer.uint32(/* id 3, wireType 2 =*/26).fork()).ldelim(); + return writer; + }; + + /** + * Encodes the specified StreamingPredictRequest message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.StreamingPredictRequest.verify|verify} messages. + * @function encodeDelimited + * @memberof google.cloud.aiplatform.v1.StreamingPredictRequest + * @static + * @param {google.cloud.aiplatform.v1.IStreamingPredictRequest} message StreamingPredictRequest message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + StreamingPredictRequest.encodeDelimited = function encodeDelimited(message, writer) { + return this.encode(message, writer).ldelim(); + }; + + /** + * Decodes a StreamingPredictRequest message from the specified reader or buffer. + * @function decode + * @memberof google.cloud.aiplatform.v1.StreamingPredictRequest + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @param {number} [length] Message length if known beforehand + * @returns {google.cloud.aiplatform.v1.StreamingPredictRequest} StreamingPredictRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + StreamingPredictRequest.decode = function decode(reader, length) { + if (!(reader instanceof $Reader)) + reader = $Reader.create(reader); + var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.aiplatform.v1.StreamingPredictRequest(); + while (reader.pos < end) { + var tag = reader.uint32(); + switch (tag >>> 3) { + case 1: { + message.endpoint = reader.string(); + break; + } + case 2: { + if (!(message.inputs && message.inputs.length)) + message.inputs = []; + message.inputs.push($root.google.cloud.aiplatform.v1.Tensor.decode(reader, reader.uint32())); + break; + } + case 3: { + message.parameters = $root.google.cloud.aiplatform.v1.Tensor.decode(reader, reader.uint32()); + break; + } + default: + reader.skipType(tag & 7); + break; + } + } + return message; + }; + + /** + * Decodes a StreamingPredictRequest message from the specified reader or buffer, length delimited. + * @function decodeDelimited + * @memberof google.cloud.aiplatform.v1.StreamingPredictRequest + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @returns {google.cloud.aiplatform.v1.StreamingPredictRequest} StreamingPredictRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + StreamingPredictRequest.decodeDelimited = function decodeDelimited(reader) { + if (!(reader instanceof $Reader)) + reader = new $Reader(reader); + return this.decode(reader, reader.uint32()); + }; + + /** + * Verifies a StreamingPredictRequest message. + * @function verify + * @memberof google.cloud.aiplatform.v1.StreamingPredictRequest + * @static + * @param {Object.} message Plain object to verify + * @returns {string|null} `null` if valid, otherwise the reason why it is not + */ + StreamingPredictRequest.verify = function verify(message) { + if (typeof message !== "object" || message === null) + return "object expected"; + if (message.endpoint != null && message.hasOwnProperty("endpoint")) + if (!$util.isString(message.endpoint)) + return "endpoint: string expected"; + if (message.inputs != null && message.hasOwnProperty("inputs")) { + if (!Array.isArray(message.inputs)) + return "inputs: array expected"; + for (var i = 0; i < message.inputs.length; ++i) { + var error = $root.google.cloud.aiplatform.v1.Tensor.verify(message.inputs[i]); + if (error) + return "inputs." + error; + } + } + if (message.parameters != null && message.hasOwnProperty("parameters")) { + var error = $root.google.cloud.aiplatform.v1.Tensor.verify(message.parameters); + if (error) + return "parameters." + error; + } + return null; + }; + + /** + * Creates a StreamingPredictRequest message from a plain object. Also converts values to their respective internal types. + * @function fromObject + * @memberof google.cloud.aiplatform.v1.StreamingPredictRequest + * @static + * @param {Object.} object Plain object + * @returns {google.cloud.aiplatform.v1.StreamingPredictRequest} StreamingPredictRequest + */ + StreamingPredictRequest.fromObject = function fromObject(object) { + if (object instanceof $root.google.cloud.aiplatform.v1.StreamingPredictRequest) + return object; + var message = new $root.google.cloud.aiplatform.v1.StreamingPredictRequest(); + if (object.endpoint != null) + message.endpoint = String(object.endpoint); + if (object.inputs) { + if (!Array.isArray(object.inputs)) + throw TypeError(".google.cloud.aiplatform.v1.StreamingPredictRequest.inputs: array expected"); + message.inputs = []; + for (var i = 0; i < object.inputs.length; ++i) { + if (typeof object.inputs[i] !== "object") + throw TypeError(".google.cloud.aiplatform.v1.StreamingPredictRequest.inputs: object expected"); + message.inputs[i] = $root.google.cloud.aiplatform.v1.Tensor.fromObject(object.inputs[i]); + } + } + if (object.parameters != null) { + if (typeof object.parameters !== "object") + throw TypeError(".google.cloud.aiplatform.v1.StreamingPredictRequest.parameters: object expected"); + message.parameters = $root.google.cloud.aiplatform.v1.Tensor.fromObject(object.parameters); + } + return message; + }; + + /** + * Creates a plain object from a StreamingPredictRequest message. Also converts values to other types if specified. + * @function toObject + * @memberof google.cloud.aiplatform.v1.StreamingPredictRequest + * @static + * @param {google.cloud.aiplatform.v1.StreamingPredictRequest} message StreamingPredictRequest + * @param {$protobuf.IConversionOptions} [options] Conversion options + * @returns {Object.} Plain object + */ + StreamingPredictRequest.toObject = function toObject(message, options) { + if (!options) + options = {}; + var object = {}; + if (options.arrays || options.defaults) + object.inputs = []; + if (options.defaults) { + object.endpoint = ""; + object.parameters = null; + } + if (message.endpoint != null && message.hasOwnProperty("endpoint")) + object.endpoint = message.endpoint; + if (message.inputs && message.inputs.length) { + object.inputs = []; + for (var j = 0; j < message.inputs.length; ++j) + object.inputs[j] = $root.google.cloud.aiplatform.v1.Tensor.toObject(message.inputs[j], options); + } + if (message.parameters != null && message.hasOwnProperty("parameters")) + object.parameters = $root.google.cloud.aiplatform.v1.Tensor.toObject(message.parameters, options); + return object; + }; + + /** + * Converts this StreamingPredictRequest to JSON. + * @function toJSON + * @memberof google.cloud.aiplatform.v1.StreamingPredictRequest + * @instance + * @returns {Object.} JSON object + */ + StreamingPredictRequest.prototype.toJSON = function toJSON() { + return this.constructor.toObject(this, $protobuf.util.toJSONOptions); + }; + + /** + * Gets the default type url for StreamingPredictRequest + * @function getTypeUrl + * @memberof google.cloud.aiplatform.v1.StreamingPredictRequest + * @static + * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns {string} The default type url + */ + StreamingPredictRequest.getTypeUrl = function getTypeUrl(typeUrlPrefix) { + if (typeUrlPrefix === undefined) { + typeUrlPrefix = "type.googleapis.com"; + } + return typeUrlPrefix + "/google.cloud.aiplatform.v1.StreamingPredictRequest"; + }; + + return StreamingPredictRequest; + })(); + + v1.StreamingPredictResponse = (function() { + + /** + * Properties of a StreamingPredictResponse. + * @memberof google.cloud.aiplatform.v1 + * @interface IStreamingPredictResponse + * @property {Array.|null} [outputs] StreamingPredictResponse outputs + * @property {google.cloud.aiplatform.v1.ITensor|null} [parameters] StreamingPredictResponse parameters + */ + + /** + * Constructs a new StreamingPredictResponse. + * @memberof google.cloud.aiplatform.v1 + * @classdesc Represents a StreamingPredictResponse. + * @implements IStreamingPredictResponse + * @constructor + * @param {google.cloud.aiplatform.v1.IStreamingPredictResponse=} [properties] Properties to set + */ + function StreamingPredictResponse(properties) { + this.outputs = []; + if (properties) + for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) + if (properties[keys[i]] != null) + this[keys[i]] = properties[keys[i]]; + } + + /** + * StreamingPredictResponse outputs. + * @member {Array.} outputs + * @memberof google.cloud.aiplatform.v1.StreamingPredictResponse + * @instance + */ + StreamingPredictResponse.prototype.outputs = $util.emptyArray; + + /** + * StreamingPredictResponse parameters. + * @member {google.cloud.aiplatform.v1.ITensor|null|undefined} parameters + * @memberof google.cloud.aiplatform.v1.StreamingPredictResponse + * @instance + */ + StreamingPredictResponse.prototype.parameters = null; + + /** + * Creates a new StreamingPredictResponse instance using the specified properties. + * @function create + * @memberof google.cloud.aiplatform.v1.StreamingPredictResponse + * @static + * @param {google.cloud.aiplatform.v1.IStreamingPredictResponse=} [properties] Properties to set + * @returns {google.cloud.aiplatform.v1.StreamingPredictResponse} StreamingPredictResponse instance + */ + StreamingPredictResponse.create = function create(properties) { + return new StreamingPredictResponse(properties); + }; + + /** + * Encodes the specified StreamingPredictResponse message. Does not implicitly {@link google.cloud.aiplatform.v1.StreamingPredictResponse.verify|verify} messages. + * @function encode + * @memberof google.cloud.aiplatform.v1.StreamingPredictResponse + * @static + * @param {google.cloud.aiplatform.v1.IStreamingPredictResponse} message StreamingPredictResponse message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + StreamingPredictResponse.encode = function encode(message, writer) { + if (!writer) + writer = $Writer.create(); + if (message.outputs != null && message.outputs.length) + for (var i = 0; i < message.outputs.length; ++i) + $root.google.cloud.aiplatform.v1.Tensor.encode(message.outputs[i], writer.uint32(/* id 1, wireType 2 =*/10).fork()).ldelim(); + if (message.parameters != null && Object.hasOwnProperty.call(message, "parameters")) + $root.google.cloud.aiplatform.v1.Tensor.encode(message.parameters, writer.uint32(/* id 2, wireType 2 =*/18).fork()).ldelim(); + return writer; + }; + + /** + * Encodes the specified StreamingPredictResponse message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.StreamingPredictResponse.verify|verify} messages. + * @function encodeDelimited + * @memberof google.cloud.aiplatform.v1.StreamingPredictResponse + * @static + * @param {google.cloud.aiplatform.v1.IStreamingPredictResponse} message StreamingPredictResponse message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + StreamingPredictResponse.encodeDelimited = function encodeDelimited(message, writer) { + return this.encode(message, writer).ldelim(); + }; + + /** + * Decodes a StreamingPredictResponse message from the specified reader or buffer. + * @function decode + * @memberof google.cloud.aiplatform.v1.StreamingPredictResponse + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @param {number} [length] Message length if known beforehand + * @returns {google.cloud.aiplatform.v1.StreamingPredictResponse} StreamingPredictResponse + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + StreamingPredictResponse.decode = function decode(reader, length) { + if (!(reader instanceof $Reader)) + reader = $Reader.create(reader); + var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.aiplatform.v1.StreamingPredictResponse(); + while (reader.pos < end) { + var tag = reader.uint32(); + switch (tag >>> 3) { + case 1: { + if (!(message.outputs && message.outputs.length)) + message.outputs = []; + message.outputs.push($root.google.cloud.aiplatform.v1.Tensor.decode(reader, reader.uint32())); + break; + } + case 2: { + message.parameters = $root.google.cloud.aiplatform.v1.Tensor.decode(reader, reader.uint32()); + break; + } + default: + reader.skipType(tag & 7); + break; + } + } + return message; + }; + + /** + * Decodes a StreamingPredictResponse message from the specified reader or buffer, length delimited. + * @function decodeDelimited + * @memberof google.cloud.aiplatform.v1.StreamingPredictResponse + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @returns {google.cloud.aiplatform.v1.StreamingPredictResponse} StreamingPredictResponse + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + StreamingPredictResponse.decodeDelimited = function decodeDelimited(reader) { + if (!(reader instanceof $Reader)) + reader = new $Reader(reader); + return this.decode(reader, reader.uint32()); + }; + + /** + * Verifies a StreamingPredictResponse message. + * @function verify + * @memberof google.cloud.aiplatform.v1.StreamingPredictResponse + * @static + * @param {Object.} message Plain object to verify + * @returns {string|null} `null` if valid, otherwise the reason why it is not + */ + StreamingPredictResponse.verify = function verify(message) { + if (typeof message !== "object" || message === null) + return "object expected"; + if (message.outputs != null && message.hasOwnProperty("outputs")) { + if (!Array.isArray(message.outputs)) + return "outputs: array expected"; + for (var i = 0; i < message.outputs.length; ++i) { + var error = $root.google.cloud.aiplatform.v1.Tensor.verify(message.outputs[i]); + if (error) + return "outputs." + error; + } + } + if (message.parameters != null && message.hasOwnProperty("parameters")) { + var error = $root.google.cloud.aiplatform.v1.Tensor.verify(message.parameters); + if (error) + return "parameters." + error; + } + return null; + }; + + /** + * Creates a StreamingPredictResponse message from a plain object. Also converts values to their respective internal types. + * @function fromObject + * @memberof google.cloud.aiplatform.v1.StreamingPredictResponse + * @static + * @param {Object.} object Plain object + * @returns {google.cloud.aiplatform.v1.StreamingPredictResponse} StreamingPredictResponse + */ + StreamingPredictResponse.fromObject = function fromObject(object) { + if (object instanceof $root.google.cloud.aiplatform.v1.StreamingPredictResponse) + return object; + var message = new $root.google.cloud.aiplatform.v1.StreamingPredictResponse(); + if (object.outputs) { + if (!Array.isArray(object.outputs)) + throw TypeError(".google.cloud.aiplatform.v1.StreamingPredictResponse.outputs: array expected"); + message.outputs = []; + for (var i = 0; i < object.outputs.length; ++i) { + if (typeof object.outputs[i] !== "object") + throw TypeError(".google.cloud.aiplatform.v1.StreamingPredictResponse.outputs: object expected"); + message.outputs[i] = $root.google.cloud.aiplatform.v1.Tensor.fromObject(object.outputs[i]); + } + } + if (object.parameters != null) { + if (typeof object.parameters !== "object") + throw TypeError(".google.cloud.aiplatform.v1.StreamingPredictResponse.parameters: object expected"); + message.parameters = $root.google.cloud.aiplatform.v1.Tensor.fromObject(object.parameters); + } + return message; + }; + + /** + * Creates a plain object from a StreamingPredictResponse message. Also converts values to other types if specified. + * @function toObject + * @memberof google.cloud.aiplatform.v1.StreamingPredictResponse + * @static + * @param {google.cloud.aiplatform.v1.StreamingPredictResponse} message StreamingPredictResponse + * @param {$protobuf.IConversionOptions} [options] Conversion options + * @returns {Object.} Plain object + */ + StreamingPredictResponse.toObject = function toObject(message, options) { + if (!options) + options = {}; + var object = {}; + if (options.arrays || options.defaults) + object.outputs = []; + if (options.defaults) + object.parameters = null; + if (message.outputs && message.outputs.length) { + object.outputs = []; + for (var j = 0; j < message.outputs.length; ++j) + object.outputs[j] = $root.google.cloud.aiplatform.v1.Tensor.toObject(message.outputs[j], options); + } + if (message.parameters != null && message.hasOwnProperty("parameters")) + object.parameters = $root.google.cloud.aiplatform.v1.Tensor.toObject(message.parameters, options); + return object; + }; + + /** + * Converts this StreamingPredictResponse to JSON. + * @function toJSON + * @memberof google.cloud.aiplatform.v1.StreamingPredictResponse + * @instance + * @returns {Object.} JSON object + */ + StreamingPredictResponse.prototype.toJSON = function toJSON() { + return this.constructor.toObject(this, $protobuf.util.toJSONOptions); + }; + + /** + * Gets the default type url for StreamingPredictResponse + * @function getTypeUrl + * @memberof google.cloud.aiplatform.v1.StreamingPredictResponse + * @static + * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns {string} The default type url + */ + StreamingPredictResponse.getTypeUrl = function getTypeUrl(typeUrlPrefix) { + if (typeUrlPrefix === undefined) { + typeUrlPrefix = "type.googleapis.com"; + } + return typeUrlPrefix + "/google.cloud.aiplatform.v1.StreamingPredictResponse"; + }; + + return StreamingPredictResponse; + })(); + v1.ExplainRequest = (function() { /** @@ -149889,6 +151425,3117 @@ return ExplainResponse; })(); + v1.Schedule = (function() { + + /** + * Properties of a Schedule. + * @memberof google.cloud.aiplatform.v1 + * @interface ISchedule + * @property {string|null} [cron] Schedule cron + * @property {google.cloud.aiplatform.v1.ICreatePipelineJobRequest|null} [createPipelineJobRequest] Schedule createPipelineJobRequest + * @property {string|null} [name] Schedule name + * @property {string|null} [displayName] Schedule displayName + * @property {google.protobuf.ITimestamp|null} [startTime] Schedule startTime + * @property {google.protobuf.ITimestamp|null} [endTime] Schedule endTime + * @property {number|Long|null} [maxRunCount] Schedule maxRunCount + * @property {number|Long|null} [startedRunCount] Schedule startedRunCount + * @property {google.cloud.aiplatform.v1.Schedule.State|null} [state] Schedule state + * @property {google.protobuf.ITimestamp|null} [createTime] Schedule createTime + * @property {google.protobuf.ITimestamp|null} [updateTime] Schedule updateTime + * @property {google.protobuf.ITimestamp|null} [nextRunTime] Schedule nextRunTime + * @property {google.protobuf.ITimestamp|null} [lastPauseTime] Schedule lastPauseTime + * @property {google.protobuf.ITimestamp|null} [lastResumeTime] Schedule lastResumeTime + * @property {number|Long|null} [maxConcurrentRunCount] Schedule maxConcurrentRunCount + * @property {boolean|null} [allowQueueing] Schedule allowQueueing + * @property {boolean|null} [catchUp] Schedule catchUp + * @property {google.cloud.aiplatform.v1.Schedule.IRunResponse|null} [lastScheduledRunResponse] Schedule lastScheduledRunResponse + */ + + /** + * Constructs a new Schedule. + * @memberof google.cloud.aiplatform.v1 + * @classdesc Represents a Schedule. + * @implements ISchedule + * @constructor + * @param {google.cloud.aiplatform.v1.ISchedule=} [properties] Properties to set + */ + function Schedule(properties) { + if (properties) + for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) + if (properties[keys[i]] != null) + this[keys[i]] = properties[keys[i]]; + } + + /** + * Schedule cron. + * @member {string|null|undefined} cron + * @memberof google.cloud.aiplatform.v1.Schedule + * @instance + */ + Schedule.prototype.cron = null; + + /** + * Schedule createPipelineJobRequest. + * @member {google.cloud.aiplatform.v1.ICreatePipelineJobRequest|null|undefined} createPipelineJobRequest + * @memberof google.cloud.aiplatform.v1.Schedule + * @instance + */ + Schedule.prototype.createPipelineJobRequest = null; + + /** + * Schedule name. + * @member {string} name + * @memberof google.cloud.aiplatform.v1.Schedule + * @instance + */ + Schedule.prototype.name = ""; + + /** + * Schedule displayName. + * @member {string} displayName + * @memberof google.cloud.aiplatform.v1.Schedule + * @instance + */ + Schedule.prototype.displayName = ""; + + /** + * Schedule startTime. + * @member {google.protobuf.ITimestamp|null|undefined} startTime + * @memberof google.cloud.aiplatform.v1.Schedule + * @instance + */ + Schedule.prototype.startTime = null; + + /** + * Schedule endTime. + * @member {google.protobuf.ITimestamp|null|undefined} endTime + * @memberof google.cloud.aiplatform.v1.Schedule + * @instance + */ + Schedule.prototype.endTime = null; + + /** + * Schedule maxRunCount. + * @member {number|Long} maxRunCount + * @memberof google.cloud.aiplatform.v1.Schedule + * @instance + */ + Schedule.prototype.maxRunCount = $util.Long ? $util.Long.fromBits(0,0,false) : 0; + + /** + * Schedule startedRunCount. + * @member {number|Long} startedRunCount + * @memberof google.cloud.aiplatform.v1.Schedule + * @instance + */ + Schedule.prototype.startedRunCount = $util.Long ? $util.Long.fromBits(0,0,false) : 0; + + /** + * Schedule state. + * @member {google.cloud.aiplatform.v1.Schedule.State} state + * @memberof google.cloud.aiplatform.v1.Schedule + * @instance + */ + Schedule.prototype.state = 0; + + /** + * Schedule createTime. + * @member {google.protobuf.ITimestamp|null|undefined} createTime + * @memberof google.cloud.aiplatform.v1.Schedule + * @instance + */ + Schedule.prototype.createTime = null; + + /** + * Schedule updateTime. + * @member {google.protobuf.ITimestamp|null|undefined} updateTime + * @memberof google.cloud.aiplatform.v1.Schedule + * @instance + */ + Schedule.prototype.updateTime = null; + + /** + * Schedule nextRunTime. + * @member {google.protobuf.ITimestamp|null|undefined} nextRunTime + * @memberof google.cloud.aiplatform.v1.Schedule + * @instance + */ + Schedule.prototype.nextRunTime = null; + + /** + * Schedule lastPauseTime. + * @member {google.protobuf.ITimestamp|null|undefined} lastPauseTime + * @memberof google.cloud.aiplatform.v1.Schedule + * @instance + */ + Schedule.prototype.lastPauseTime = null; + + /** + * Schedule lastResumeTime. + * @member {google.protobuf.ITimestamp|null|undefined} lastResumeTime + * @memberof google.cloud.aiplatform.v1.Schedule + * @instance + */ + Schedule.prototype.lastResumeTime = null; + + /** + * Schedule maxConcurrentRunCount. + * @member {number|Long} maxConcurrentRunCount + * @memberof google.cloud.aiplatform.v1.Schedule + * @instance + */ + Schedule.prototype.maxConcurrentRunCount = $util.Long ? $util.Long.fromBits(0,0,false) : 0; + + /** + * Schedule allowQueueing. + * @member {boolean} allowQueueing + * @memberof google.cloud.aiplatform.v1.Schedule + * @instance + */ + Schedule.prototype.allowQueueing = false; + + /** + * Schedule catchUp. + * @member {boolean} catchUp + * @memberof google.cloud.aiplatform.v1.Schedule + * @instance + */ + Schedule.prototype.catchUp = false; + + /** + * Schedule lastScheduledRunResponse. + * @member {google.cloud.aiplatform.v1.Schedule.IRunResponse|null|undefined} lastScheduledRunResponse + * @memberof google.cloud.aiplatform.v1.Schedule + * @instance + */ + Schedule.prototype.lastScheduledRunResponse = null; + + // OneOf field names bound to virtual getters and setters + var $oneOfFields; + + /** + * Schedule timeSpecification. + * @member {"cron"|undefined} timeSpecification + * @memberof google.cloud.aiplatform.v1.Schedule + * @instance + */ + Object.defineProperty(Schedule.prototype, "timeSpecification", { + get: $util.oneOfGetter($oneOfFields = ["cron"]), + set: $util.oneOfSetter($oneOfFields) + }); + + /** + * Schedule request. + * @member {"createPipelineJobRequest"|undefined} request + * @memberof google.cloud.aiplatform.v1.Schedule + * @instance + */ + Object.defineProperty(Schedule.prototype, "request", { + get: $util.oneOfGetter($oneOfFields = ["createPipelineJobRequest"]), + set: $util.oneOfSetter($oneOfFields) + }); + + /** + * Creates a new Schedule instance using the specified properties. + * @function create + * @memberof google.cloud.aiplatform.v1.Schedule + * @static + * @param {google.cloud.aiplatform.v1.ISchedule=} [properties] Properties to set + * @returns {google.cloud.aiplatform.v1.Schedule} Schedule instance + */ + Schedule.create = function create(properties) { + return new Schedule(properties); + }; + + /** + * Encodes the specified Schedule message. Does not implicitly {@link google.cloud.aiplatform.v1.Schedule.verify|verify} messages. + * @function encode + * @memberof google.cloud.aiplatform.v1.Schedule + * @static + * @param {google.cloud.aiplatform.v1.ISchedule} message Schedule message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + Schedule.encode = function encode(message, writer) { + if (!writer) + writer = $Writer.create(); + if (message.name != null && Object.hasOwnProperty.call(message, "name")) + writer.uint32(/* id 1, wireType 2 =*/10).string(message.name); + if (message.displayName != null && Object.hasOwnProperty.call(message, "displayName")) + writer.uint32(/* id 2, wireType 2 =*/18).string(message.displayName); + if (message.startTime != null && Object.hasOwnProperty.call(message, "startTime")) + $root.google.protobuf.Timestamp.encode(message.startTime, writer.uint32(/* id 3, wireType 2 =*/26).fork()).ldelim(); + if (message.endTime != null && Object.hasOwnProperty.call(message, "endTime")) + $root.google.protobuf.Timestamp.encode(message.endTime, writer.uint32(/* id 4, wireType 2 =*/34).fork()).ldelim(); + if (message.state != null && Object.hasOwnProperty.call(message, "state")) + writer.uint32(/* id 5, wireType 0 =*/40).int32(message.state); + if (message.createTime != null && Object.hasOwnProperty.call(message, "createTime")) + $root.google.protobuf.Timestamp.encode(message.createTime, writer.uint32(/* id 6, wireType 2 =*/50).fork()).ldelim(); + if (message.nextRunTime != null && Object.hasOwnProperty.call(message, "nextRunTime")) + $root.google.protobuf.Timestamp.encode(message.nextRunTime, writer.uint32(/* id 7, wireType 2 =*/58).fork()).ldelim(); + if (message.lastPauseTime != null && Object.hasOwnProperty.call(message, "lastPauseTime")) + $root.google.protobuf.Timestamp.encode(message.lastPauseTime, writer.uint32(/* id 8, wireType 2 =*/66).fork()).ldelim(); + if (message.lastResumeTime != null && Object.hasOwnProperty.call(message, "lastResumeTime")) + $root.google.protobuf.Timestamp.encode(message.lastResumeTime, writer.uint32(/* id 9, wireType 2 =*/74).fork()).ldelim(); + if (message.cron != null && Object.hasOwnProperty.call(message, "cron")) + writer.uint32(/* id 10, wireType 2 =*/82).string(message.cron); + if (message.maxConcurrentRunCount != null && Object.hasOwnProperty.call(message, "maxConcurrentRunCount")) + writer.uint32(/* id 11, wireType 0 =*/88).int64(message.maxConcurrentRunCount); + if (message.allowQueueing != null && Object.hasOwnProperty.call(message, "allowQueueing")) + writer.uint32(/* id 12, wireType 0 =*/96).bool(message.allowQueueing); + if (message.catchUp != null && Object.hasOwnProperty.call(message, "catchUp")) + writer.uint32(/* id 13, wireType 0 =*/104).bool(message.catchUp); + if (message.createPipelineJobRequest != null && Object.hasOwnProperty.call(message, "createPipelineJobRequest")) + $root.google.cloud.aiplatform.v1.CreatePipelineJobRequest.encode(message.createPipelineJobRequest, writer.uint32(/* id 14, wireType 2 =*/114).fork()).ldelim(); + if (message.maxRunCount != null && Object.hasOwnProperty.call(message, "maxRunCount")) + writer.uint32(/* id 16, wireType 0 =*/128).int64(message.maxRunCount); + if (message.startedRunCount != null && Object.hasOwnProperty.call(message, "startedRunCount")) + writer.uint32(/* id 17, wireType 0 =*/136).int64(message.startedRunCount); + if (message.lastScheduledRunResponse != null && Object.hasOwnProperty.call(message, "lastScheduledRunResponse")) + $root.google.cloud.aiplatform.v1.Schedule.RunResponse.encode(message.lastScheduledRunResponse, writer.uint32(/* id 18, wireType 2 =*/146).fork()).ldelim(); + if (message.updateTime != null && Object.hasOwnProperty.call(message, "updateTime")) + $root.google.protobuf.Timestamp.encode(message.updateTime, writer.uint32(/* id 19, wireType 2 =*/154).fork()).ldelim(); + return writer; + }; + + /** + * Encodes the specified Schedule message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.Schedule.verify|verify} messages. + * @function encodeDelimited + * @memberof google.cloud.aiplatform.v1.Schedule + * @static + * @param {google.cloud.aiplatform.v1.ISchedule} message Schedule message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + Schedule.encodeDelimited = function encodeDelimited(message, writer) { + return this.encode(message, writer).ldelim(); + }; + + /** + * Decodes a Schedule message from the specified reader or buffer. + * @function decode + * @memberof google.cloud.aiplatform.v1.Schedule + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @param {number} [length] Message length if known beforehand + * @returns {google.cloud.aiplatform.v1.Schedule} Schedule + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + Schedule.decode = function decode(reader, length) { + if (!(reader instanceof $Reader)) + reader = $Reader.create(reader); + var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.aiplatform.v1.Schedule(); + while (reader.pos < end) { + var tag = reader.uint32(); + switch (tag >>> 3) { + case 10: { + message.cron = reader.string(); + break; + } + case 14: { + message.createPipelineJobRequest = $root.google.cloud.aiplatform.v1.CreatePipelineJobRequest.decode(reader, reader.uint32()); + break; + } + case 1: { + message.name = reader.string(); + break; + } + case 2: { + message.displayName = reader.string(); + break; + } + case 3: { + message.startTime = $root.google.protobuf.Timestamp.decode(reader, reader.uint32()); + break; + } + case 4: { + message.endTime = $root.google.protobuf.Timestamp.decode(reader, reader.uint32()); + break; + } + case 16: { + message.maxRunCount = reader.int64(); + break; + } + case 17: { + message.startedRunCount = reader.int64(); + break; + } + case 5: { + message.state = reader.int32(); + break; + } + case 6: { + message.createTime = $root.google.protobuf.Timestamp.decode(reader, reader.uint32()); + break; + } + case 19: { + message.updateTime = $root.google.protobuf.Timestamp.decode(reader, reader.uint32()); + break; + } + case 7: { + message.nextRunTime = $root.google.protobuf.Timestamp.decode(reader, reader.uint32()); + break; + } + case 8: { + message.lastPauseTime = $root.google.protobuf.Timestamp.decode(reader, reader.uint32()); + break; + } + case 9: { + message.lastResumeTime = $root.google.protobuf.Timestamp.decode(reader, reader.uint32()); + break; + } + case 11: { + message.maxConcurrentRunCount = reader.int64(); + break; + } + case 12: { + message.allowQueueing = reader.bool(); + break; + } + case 13: { + message.catchUp = reader.bool(); + break; + } + case 18: { + message.lastScheduledRunResponse = $root.google.cloud.aiplatform.v1.Schedule.RunResponse.decode(reader, reader.uint32()); + break; + } + default: + reader.skipType(tag & 7); + break; + } + } + return message; + }; + + /** + * Decodes a Schedule message from the specified reader or buffer, length delimited. + * @function decodeDelimited + * @memberof google.cloud.aiplatform.v1.Schedule + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @returns {google.cloud.aiplatform.v1.Schedule} Schedule + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + Schedule.decodeDelimited = function decodeDelimited(reader) { + if (!(reader instanceof $Reader)) + reader = new $Reader(reader); + return this.decode(reader, reader.uint32()); + }; + + /** + * Verifies a Schedule message. + * @function verify + * @memberof google.cloud.aiplatform.v1.Schedule + * @static + * @param {Object.} message Plain object to verify + * @returns {string|null} `null` if valid, otherwise the reason why it is not + */ + Schedule.verify = function verify(message) { + if (typeof message !== "object" || message === null) + return "object expected"; + var properties = {}; + if (message.cron != null && message.hasOwnProperty("cron")) { + properties.timeSpecification = 1; + if (!$util.isString(message.cron)) + return "cron: string expected"; + } + if (message.createPipelineJobRequest != null && message.hasOwnProperty("createPipelineJobRequest")) { + properties.request = 1; + { + var error = $root.google.cloud.aiplatform.v1.CreatePipelineJobRequest.verify(message.createPipelineJobRequest); + if (error) + return "createPipelineJobRequest." + error; + } + } + if (message.name != null && message.hasOwnProperty("name")) + if (!$util.isString(message.name)) + return "name: string expected"; + if (message.displayName != null && message.hasOwnProperty("displayName")) + if (!$util.isString(message.displayName)) + return "displayName: string expected"; + if (message.startTime != null && message.hasOwnProperty("startTime")) { + var error = $root.google.protobuf.Timestamp.verify(message.startTime); + if (error) + return "startTime." + error; + } + if (message.endTime != null && message.hasOwnProperty("endTime")) { + var error = $root.google.protobuf.Timestamp.verify(message.endTime); + if (error) + return "endTime." + error; + } + if (message.maxRunCount != null && message.hasOwnProperty("maxRunCount")) + if (!$util.isInteger(message.maxRunCount) && !(message.maxRunCount && $util.isInteger(message.maxRunCount.low) && $util.isInteger(message.maxRunCount.high))) + return "maxRunCount: integer|Long expected"; + if (message.startedRunCount != null && message.hasOwnProperty("startedRunCount")) + if (!$util.isInteger(message.startedRunCount) && !(message.startedRunCount && $util.isInteger(message.startedRunCount.low) && $util.isInteger(message.startedRunCount.high))) + return "startedRunCount: integer|Long expected"; + if (message.state != null && message.hasOwnProperty("state")) + switch (message.state) { + default: + return "state: enum value expected"; + case 0: + case 1: + case 2: + case 3: + break; + } + if (message.createTime != null && message.hasOwnProperty("createTime")) { + var error = $root.google.protobuf.Timestamp.verify(message.createTime); + if (error) + return "createTime." + error; + } + if (message.updateTime != null && message.hasOwnProperty("updateTime")) { + var error = $root.google.protobuf.Timestamp.verify(message.updateTime); + if (error) + return "updateTime." + error; + } + if (message.nextRunTime != null && message.hasOwnProperty("nextRunTime")) { + var error = $root.google.protobuf.Timestamp.verify(message.nextRunTime); + if (error) + return "nextRunTime." + error; + } + if (message.lastPauseTime != null && message.hasOwnProperty("lastPauseTime")) { + var error = $root.google.protobuf.Timestamp.verify(message.lastPauseTime); + if (error) + return "lastPauseTime." + error; + } + if (message.lastResumeTime != null && message.hasOwnProperty("lastResumeTime")) { + var error = $root.google.protobuf.Timestamp.verify(message.lastResumeTime); + if (error) + return "lastResumeTime." + error; + } + if (message.maxConcurrentRunCount != null && message.hasOwnProperty("maxConcurrentRunCount")) + if (!$util.isInteger(message.maxConcurrentRunCount) && !(message.maxConcurrentRunCount && $util.isInteger(message.maxConcurrentRunCount.low) && $util.isInteger(message.maxConcurrentRunCount.high))) + return "maxConcurrentRunCount: integer|Long expected"; + if (message.allowQueueing != null && message.hasOwnProperty("allowQueueing")) + if (typeof message.allowQueueing !== "boolean") + return "allowQueueing: boolean expected"; + if (message.catchUp != null && message.hasOwnProperty("catchUp")) + if (typeof message.catchUp !== "boolean") + return "catchUp: boolean expected"; + if (message.lastScheduledRunResponse != null && message.hasOwnProperty("lastScheduledRunResponse")) { + var error = $root.google.cloud.aiplatform.v1.Schedule.RunResponse.verify(message.lastScheduledRunResponse); + if (error) + return "lastScheduledRunResponse." + error; + } + return null; + }; + + /** + * Creates a Schedule message from a plain object. Also converts values to their respective internal types. + * @function fromObject + * @memberof google.cloud.aiplatform.v1.Schedule + * @static + * @param {Object.} object Plain object + * @returns {google.cloud.aiplatform.v1.Schedule} Schedule + */ + Schedule.fromObject = function fromObject(object) { + if (object instanceof $root.google.cloud.aiplatform.v1.Schedule) + return object; + var message = new $root.google.cloud.aiplatform.v1.Schedule(); + if (object.cron != null) + message.cron = String(object.cron); + if (object.createPipelineJobRequest != null) { + if (typeof object.createPipelineJobRequest !== "object") + throw TypeError(".google.cloud.aiplatform.v1.Schedule.createPipelineJobRequest: object expected"); + message.createPipelineJobRequest = $root.google.cloud.aiplatform.v1.CreatePipelineJobRequest.fromObject(object.createPipelineJobRequest); + } + if (object.name != null) + message.name = String(object.name); + if (object.displayName != null) + message.displayName = String(object.displayName); + if (object.startTime != null) { + if (typeof object.startTime !== "object") + throw TypeError(".google.cloud.aiplatform.v1.Schedule.startTime: object expected"); + message.startTime = $root.google.protobuf.Timestamp.fromObject(object.startTime); + } + if (object.endTime != null) { + if (typeof object.endTime !== "object") + throw TypeError(".google.cloud.aiplatform.v1.Schedule.endTime: object expected"); + message.endTime = $root.google.protobuf.Timestamp.fromObject(object.endTime); + } + if (object.maxRunCount != null) + if ($util.Long) + (message.maxRunCount = $util.Long.fromValue(object.maxRunCount)).unsigned = false; + else if (typeof object.maxRunCount === "string") + message.maxRunCount = parseInt(object.maxRunCount, 10); + else if (typeof object.maxRunCount === "number") + message.maxRunCount = object.maxRunCount; + else if (typeof object.maxRunCount === "object") + message.maxRunCount = new $util.LongBits(object.maxRunCount.low >>> 0, object.maxRunCount.high >>> 0).toNumber(); + if (object.startedRunCount != null) + if ($util.Long) + (message.startedRunCount = $util.Long.fromValue(object.startedRunCount)).unsigned = false; + else if (typeof object.startedRunCount === "string") + message.startedRunCount = parseInt(object.startedRunCount, 10); + else if (typeof object.startedRunCount === "number") + message.startedRunCount = object.startedRunCount; + else if (typeof object.startedRunCount === "object") + message.startedRunCount = new $util.LongBits(object.startedRunCount.low >>> 0, object.startedRunCount.high >>> 0).toNumber(); + switch (object.state) { + default: + if (typeof object.state === "number") { + message.state = object.state; + break; + } + break; + case "STATE_UNSPECIFIED": + case 0: + message.state = 0; + break; + case "ACTIVE": + case 1: + message.state = 1; + break; + case "PAUSED": + case 2: + message.state = 2; + break; + case "COMPLETED": + case 3: + message.state = 3; + break; + } + if (object.createTime != null) { + if (typeof object.createTime !== "object") + throw TypeError(".google.cloud.aiplatform.v1.Schedule.createTime: object expected"); + message.createTime = $root.google.protobuf.Timestamp.fromObject(object.createTime); + } + if (object.updateTime != null) { + if (typeof object.updateTime !== "object") + throw TypeError(".google.cloud.aiplatform.v1.Schedule.updateTime: object expected"); + message.updateTime = $root.google.protobuf.Timestamp.fromObject(object.updateTime); + } + if (object.nextRunTime != null) { + if (typeof object.nextRunTime !== "object") + throw TypeError(".google.cloud.aiplatform.v1.Schedule.nextRunTime: object expected"); + message.nextRunTime = $root.google.protobuf.Timestamp.fromObject(object.nextRunTime); + } + if (object.lastPauseTime != null) { + if (typeof object.lastPauseTime !== "object") + throw TypeError(".google.cloud.aiplatform.v1.Schedule.lastPauseTime: object expected"); + message.lastPauseTime = $root.google.protobuf.Timestamp.fromObject(object.lastPauseTime); + } + if (object.lastResumeTime != null) { + if (typeof object.lastResumeTime !== "object") + throw TypeError(".google.cloud.aiplatform.v1.Schedule.lastResumeTime: object expected"); + message.lastResumeTime = $root.google.protobuf.Timestamp.fromObject(object.lastResumeTime); + } + if (object.maxConcurrentRunCount != null) + if ($util.Long) + (message.maxConcurrentRunCount = $util.Long.fromValue(object.maxConcurrentRunCount)).unsigned = false; + else if (typeof object.maxConcurrentRunCount === "string") + message.maxConcurrentRunCount = parseInt(object.maxConcurrentRunCount, 10); + else if (typeof object.maxConcurrentRunCount === "number") + message.maxConcurrentRunCount = object.maxConcurrentRunCount; + else if (typeof object.maxConcurrentRunCount === "object") + message.maxConcurrentRunCount = new $util.LongBits(object.maxConcurrentRunCount.low >>> 0, object.maxConcurrentRunCount.high >>> 0).toNumber(); + if (object.allowQueueing != null) + message.allowQueueing = Boolean(object.allowQueueing); + if (object.catchUp != null) + message.catchUp = Boolean(object.catchUp); + if (object.lastScheduledRunResponse != null) { + if (typeof object.lastScheduledRunResponse !== "object") + throw TypeError(".google.cloud.aiplatform.v1.Schedule.lastScheduledRunResponse: object expected"); + message.lastScheduledRunResponse = $root.google.cloud.aiplatform.v1.Schedule.RunResponse.fromObject(object.lastScheduledRunResponse); + } + return message; + }; + + /** + * Creates a plain object from a Schedule message. Also converts values to other types if specified. + * @function toObject + * @memberof google.cloud.aiplatform.v1.Schedule + * @static + * @param {google.cloud.aiplatform.v1.Schedule} message Schedule + * @param {$protobuf.IConversionOptions} [options] Conversion options + * @returns {Object.} Plain object + */ + Schedule.toObject = function toObject(message, options) { + if (!options) + options = {}; + var object = {}; + if (options.defaults) { + object.name = ""; + object.displayName = ""; + object.startTime = null; + object.endTime = null; + object.state = options.enums === String ? "STATE_UNSPECIFIED" : 0; + object.createTime = null; + object.nextRunTime = null; + object.lastPauseTime = null; + object.lastResumeTime = null; + if ($util.Long) { + var long = new $util.Long(0, 0, false); + object.maxConcurrentRunCount = options.longs === String ? long.toString() : options.longs === Number ? long.toNumber() : long; + } else + object.maxConcurrentRunCount = options.longs === String ? "0" : 0; + object.allowQueueing = false; + object.catchUp = false; + if ($util.Long) { + var long = new $util.Long(0, 0, false); + object.maxRunCount = options.longs === String ? long.toString() : options.longs === Number ? long.toNumber() : long; + } else + object.maxRunCount = options.longs === String ? "0" : 0; + if ($util.Long) { + var long = new $util.Long(0, 0, false); + object.startedRunCount = options.longs === String ? long.toString() : options.longs === Number ? long.toNumber() : long; + } else + object.startedRunCount = options.longs === String ? "0" : 0; + object.lastScheduledRunResponse = null; + object.updateTime = null; + } + if (message.name != null && message.hasOwnProperty("name")) + object.name = message.name; + if (message.displayName != null && message.hasOwnProperty("displayName")) + object.displayName = message.displayName; + if (message.startTime != null && message.hasOwnProperty("startTime")) + object.startTime = $root.google.protobuf.Timestamp.toObject(message.startTime, options); + if (message.endTime != null && message.hasOwnProperty("endTime")) + object.endTime = $root.google.protobuf.Timestamp.toObject(message.endTime, options); + if (message.state != null && message.hasOwnProperty("state")) + object.state = options.enums === String ? $root.google.cloud.aiplatform.v1.Schedule.State[message.state] === undefined ? message.state : $root.google.cloud.aiplatform.v1.Schedule.State[message.state] : message.state; + if (message.createTime != null && message.hasOwnProperty("createTime")) + object.createTime = $root.google.protobuf.Timestamp.toObject(message.createTime, options); + if (message.nextRunTime != null && message.hasOwnProperty("nextRunTime")) + object.nextRunTime = $root.google.protobuf.Timestamp.toObject(message.nextRunTime, options); + if (message.lastPauseTime != null && message.hasOwnProperty("lastPauseTime")) + object.lastPauseTime = $root.google.protobuf.Timestamp.toObject(message.lastPauseTime, options); + if (message.lastResumeTime != null && message.hasOwnProperty("lastResumeTime")) + object.lastResumeTime = $root.google.protobuf.Timestamp.toObject(message.lastResumeTime, options); + if (message.cron != null && message.hasOwnProperty("cron")) { + object.cron = message.cron; + if (options.oneofs) + object.timeSpecification = "cron"; + } + if (message.maxConcurrentRunCount != null && message.hasOwnProperty("maxConcurrentRunCount")) + if (typeof message.maxConcurrentRunCount === "number") + object.maxConcurrentRunCount = options.longs === String ? String(message.maxConcurrentRunCount) : message.maxConcurrentRunCount; + else + object.maxConcurrentRunCount = options.longs === String ? $util.Long.prototype.toString.call(message.maxConcurrentRunCount) : options.longs === Number ? new $util.LongBits(message.maxConcurrentRunCount.low >>> 0, message.maxConcurrentRunCount.high >>> 0).toNumber() : message.maxConcurrentRunCount; + if (message.allowQueueing != null && message.hasOwnProperty("allowQueueing")) + object.allowQueueing = message.allowQueueing; + if (message.catchUp != null && message.hasOwnProperty("catchUp")) + object.catchUp = message.catchUp; + if (message.createPipelineJobRequest != null && message.hasOwnProperty("createPipelineJobRequest")) { + object.createPipelineJobRequest = $root.google.cloud.aiplatform.v1.CreatePipelineJobRequest.toObject(message.createPipelineJobRequest, options); + if (options.oneofs) + object.request = "createPipelineJobRequest"; + } + if (message.maxRunCount != null && message.hasOwnProperty("maxRunCount")) + if (typeof message.maxRunCount === "number") + object.maxRunCount = options.longs === String ? String(message.maxRunCount) : message.maxRunCount; + else + object.maxRunCount = options.longs === String ? $util.Long.prototype.toString.call(message.maxRunCount) : options.longs === Number ? new $util.LongBits(message.maxRunCount.low >>> 0, message.maxRunCount.high >>> 0).toNumber() : message.maxRunCount; + if (message.startedRunCount != null && message.hasOwnProperty("startedRunCount")) + if (typeof message.startedRunCount === "number") + object.startedRunCount = options.longs === String ? String(message.startedRunCount) : message.startedRunCount; + else + object.startedRunCount = options.longs === String ? $util.Long.prototype.toString.call(message.startedRunCount) : options.longs === Number ? new $util.LongBits(message.startedRunCount.low >>> 0, message.startedRunCount.high >>> 0).toNumber() : message.startedRunCount; + if (message.lastScheduledRunResponse != null && message.hasOwnProperty("lastScheduledRunResponse")) + object.lastScheduledRunResponse = $root.google.cloud.aiplatform.v1.Schedule.RunResponse.toObject(message.lastScheduledRunResponse, options); + if (message.updateTime != null && message.hasOwnProperty("updateTime")) + object.updateTime = $root.google.protobuf.Timestamp.toObject(message.updateTime, options); + return object; + }; + + /** + * Converts this Schedule to JSON. + * @function toJSON + * @memberof google.cloud.aiplatform.v1.Schedule + * @instance + * @returns {Object.} JSON object + */ + Schedule.prototype.toJSON = function toJSON() { + return this.constructor.toObject(this, $protobuf.util.toJSONOptions); + }; + + /** + * Gets the default type url for Schedule + * @function getTypeUrl + * @memberof google.cloud.aiplatform.v1.Schedule + * @static + * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns {string} The default type url + */ + Schedule.getTypeUrl = function getTypeUrl(typeUrlPrefix) { + if (typeUrlPrefix === undefined) { + typeUrlPrefix = "type.googleapis.com"; + } + return typeUrlPrefix + "/google.cloud.aiplatform.v1.Schedule"; + }; + + Schedule.RunResponse = (function() { + + /** + * Properties of a RunResponse. + * @memberof google.cloud.aiplatform.v1.Schedule + * @interface IRunResponse + * @property {google.protobuf.ITimestamp|null} [scheduledRunTime] RunResponse scheduledRunTime + * @property {string|null} [runResponse] RunResponse runResponse + */ + + /** + * Constructs a new RunResponse. + * @memberof google.cloud.aiplatform.v1.Schedule + * @classdesc Represents a RunResponse. + * @implements IRunResponse + * @constructor + * @param {google.cloud.aiplatform.v1.Schedule.IRunResponse=} [properties] Properties to set + */ + function RunResponse(properties) { + if (properties) + for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) + if (properties[keys[i]] != null) + this[keys[i]] = properties[keys[i]]; + } + + /** + * RunResponse scheduledRunTime. + * @member {google.protobuf.ITimestamp|null|undefined} scheduledRunTime + * @memberof google.cloud.aiplatform.v1.Schedule.RunResponse + * @instance + */ + RunResponse.prototype.scheduledRunTime = null; + + /** + * RunResponse runResponse. + * @member {string} runResponse + * @memberof google.cloud.aiplatform.v1.Schedule.RunResponse + * @instance + */ + RunResponse.prototype.runResponse = ""; + + /** + * Creates a new RunResponse instance using the specified properties. + * @function create + * @memberof google.cloud.aiplatform.v1.Schedule.RunResponse + * @static + * @param {google.cloud.aiplatform.v1.Schedule.IRunResponse=} [properties] Properties to set + * @returns {google.cloud.aiplatform.v1.Schedule.RunResponse} RunResponse instance + */ + RunResponse.create = function create(properties) { + return new RunResponse(properties); + }; + + /** + * Encodes the specified RunResponse message. Does not implicitly {@link google.cloud.aiplatform.v1.Schedule.RunResponse.verify|verify} messages. + * @function encode + * @memberof google.cloud.aiplatform.v1.Schedule.RunResponse + * @static + * @param {google.cloud.aiplatform.v1.Schedule.IRunResponse} message RunResponse message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + RunResponse.encode = function encode(message, writer) { + if (!writer) + writer = $Writer.create(); + if (message.scheduledRunTime != null && Object.hasOwnProperty.call(message, "scheduledRunTime")) + $root.google.protobuf.Timestamp.encode(message.scheduledRunTime, writer.uint32(/* id 1, wireType 2 =*/10).fork()).ldelim(); + if (message.runResponse != null && Object.hasOwnProperty.call(message, "runResponse")) + writer.uint32(/* id 2, wireType 2 =*/18).string(message.runResponse); + return writer; + }; + + /** + * Encodes the specified RunResponse message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.Schedule.RunResponse.verify|verify} messages. + * @function encodeDelimited + * @memberof google.cloud.aiplatform.v1.Schedule.RunResponse + * @static + * @param {google.cloud.aiplatform.v1.Schedule.IRunResponse} message RunResponse message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + RunResponse.encodeDelimited = function encodeDelimited(message, writer) { + return this.encode(message, writer).ldelim(); + }; + + /** + * Decodes a RunResponse message from the specified reader or buffer. + * @function decode + * @memberof google.cloud.aiplatform.v1.Schedule.RunResponse + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @param {number} [length] Message length if known beforehand + * @returns {google.cloud.aiplatform.v1.Schedule.RunResponse} RunResponse + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + RunResponse.decode = function decode(reader, length) { + if (!(reader instanceof $Reader)) + reader = $Reader.create(reader); + var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.aiplatform.v1.Schedule.RunResponse(); + while (reader.pos < end) { + var tag = reader.uint32(); + switch (tag >>> 3) { + case 1: { + message.scheduledRunTime = $root.google.protobuf.Timestamp.decode(reader, reader.uint32()); + break; + } + case 2: { + message.runResponse = reader.string(); + break; + } + default: + reader.skipType(tag & 7); + break; + } + } + return message; + }; + + /** + * Decodes a RunResponse message from the specified reader or buffer, length delimited. + * @function decodeDelimited + * @memberof google.cloud.aiplatform.v1.Schedule.RunResponse + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @returns {google.cloud.aiplatform.v1.Schedule.RunResponse} RunResponse + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + RunResponse.decodeDelimited = function decodeDelimited(reader) { + if (!(reader instanceof $Reader)) + reader = new $Reader(reader); + return this.decode(reader, reader.uint32()); + }; + + /** + * Verifies a RunResponse message. + * @function verify + * @memberof google.cloud.aiplatform.v1.Schedule.RunResponse + * @static + * @param {Object.} message Plain object to verify + * @returns {string|null} `null` if valid, otherwise the reason why it is not + */ + RunResponse.verify = function verify(message) { + if (typeof message !== "object" || message === null) + return "object expected"; + if (message.scheduledRunTime != null && message.hasOwnProperty("scheduledRunTime")) { + var error = $root.google.protobuf.Timestamp.verify(message.scheduledRunTime); + if (error) + return "scheduledRunTime." + error; + } + if (message.runResponse != null && message.hasOwnProperty("runResponse")) + if (!$util.isString(message.runResponse)) + return "runResponse: string expected"; + return null; + }; + + /** + * Creates a RunResponse message from a plain object. Also converts values to their respective internal types. + * @function fromObject + * @memberof google.cloud.aiplatform.v1.Schedule.RunResponse + * @static + * @param {Object.} object Plain object + * @returns {google.cloud.aiplatform.v1.Schedule.RunResponse} RunResponse + */ + RunResponse.fromObject = function fromObject(object) { + if (object instanceof $root.google.cloud.aiplatform.v1.Schedule.RunResponse) + return object; + var message = new $root.google.cloud.aiplatform.v1.Schedule.RunResponse(); + if (object.scheduledRunTime != null) { + if (typeof object.scheduledRunTime !== "object") + throw TypeError(".google.cloud.aiplatform.v1.Schedule.RunResponse.scheduledRunTime: object expected"); + message.scheduledRunTime = $root.google.protobuf.Timestamp.fromObject(object.scheduledRunTime); + } + if (object.runResponse != null) + message.runResponse = String(object.runResponse); + return message; + }; + + /** + * Creates a plain object from a RunResponse message. Also converts values to other types if specified. + * @function toObject + * @memberof google.cloud.aiplatform.v1.Schedule.RunResponse + * @static + * @param {google.cloud.aiplatform.v1.Schedule.RunResponse} message RunResponse + * @param {$protobuf.IConversionOptions} [options] Conversion options + * @returns {Object.} Plain object + */ + RunResponse.toObject = function toObject(message, options) { + if (!options) + options = {}; + var object = {}; + if (options.defaults) { + object.scheduledRunTime = null; + object.runResponse = ""; + } + if (message.scheduledRunTime != null && message.hasOwnProperty("scheduledRunTime")) + object.scheduledRunTime = $root.google.protobuf.Timestamp.toObject(message.scheduledRunTime, options); + if (message.runResponse != null && message.hasOwnProperty("runResponse")) + object.runResponse = message.runResponse; + return object; + }; + + /** + * Converts this RunResponse to JSON. + * @function toJSON + * @memberof google.cloud.aiplatform.v1.Schedule.RunResponse + * @instance + * @returns {Object.} JSON object + */ + RunResponse.prototype.toJSON = function toJSON() { + return this.constructor.toObject(this, $protobuf.util.toJSONOptions); + }; + + /** + * Gets the default type url for RunResponse + * @function getTypeUrl + * @memberof google.cloud.aiplatform.v1.Schedule.RunResponse + * @static + * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns {string} The default type url + */ + RunResponse.getTypeUrl = function getTypeUrl(typeUrlPrefix) { + if (typeUrlPrefix === undefined) { + typeUrlPrefix = "type.googleapis.com"; + } + return typeUrlPrefix + "/google.cloud.aiplatform.v1.Schedule.RunResponse"; + }; + + return RunResponse; + })(); + + /** + * State enum. + * @name google.cloud.aiplatform.v1.Schedule.State + * @enum {number} + * @property {number} STATE_UNSPECIFIED=0 STATE_UNSPECIFIED value + * @property {number} ACTIVE=1 ACTIVE value + * @property {number} PAUSED=2 PAUSED value + * @property {number} COMPLETED=3 COMPLETED value + */ + Schedule.State = (function() { + var valuesById = {}, values = Object.create(valuesById); + values[valuesById[0] = "STATE_UNSPECIFIED"] = 0; + values[valuesById[1] = "ACTIVE"] = 1; + values[valuesById[2] = "PAUSED"] = 2; + values[valuesById[3] = "COMPLETED"] = 3; + return values; + })(); + + return Schedule; + })(); + + v1.ScheduleService = (function() { + + /** + * Constructs a new ScheduleService service. + * @memberof google.cloud.aiplatform.v1 + * @classdesc Represents a ScheduleService + * @extends $protobuf.rpc.Service + * @constructor + * @param {$protobuf.RPCImpl} rpcImpl RPC implementation + * @param {boolean} [requestDelimited=false] Whether requests are length-delimited + * @param {boolean} [responseDelimited=false] Whether responses are length-delimited + */ + function ScheduleService(rpcImpl, requestDelimited, responseDelimited) { + $protobuf.rpc.Service.call(this, rpcImpl, requestDelimited, responseDelimited); + } + + (ScheduleService.prototype = Object.create($protobuf.rpc.Service.prototype)).constructor = ScheduleService; + + /** + * Creates new ScheduleService service using the specified rpc implementation. + * @function create + * @memberof google.cloud.aiplatform.v1.ScheduleService + * @static + * @param {$protobuf.RPCImpl} rpcImpl RPC implementation + * @param {boolean} [requestDelimited=false] Whether requests are length-delimited + * @param {boolean} [responseDelimited=false] Whether responses are length-delimited + * @returns {ScheduleService} RPC service. Useful where requests and/or responses are streamed. + */ + ScheduleService.create = function create(rpcImpl, requestDelimited, responseDelimited) { + return new this(rpcImpl, requestDelimited, responseDelimited); + }; + + /** + * Callback as used by {@link google.cloud.aiplatform.v1.ScheduleService|createSchedule}. + * @memberof google.cloud.aiplatform.v1.ScheduleService + * @typedef CreateScheduleCallback + * @type {function} + * @param {Error|null} error Error, if any + * @param {google.cloud.aiplatform.v1.Schedule} [response] Schedule + */ + + /** + * Calls CreateSchedule. + * @function createSchedule + * @memberof google.cloud.aiplatform.v1.ScheduleService + * @instance + * @param {google.cloud.aiplatform.v1.ICreateScheduleRequest} request CreateScheduleRequest message or plain object + * @param {google.cloud.aiplatform.v1.ScheduleService.CreateScheduleCallback} callback Node-style callback called with the error, if any, and Schedule + * @returns {undefined} + * @variation 1 + */ + Object.defineProperty(ScheduleService.prototype.createSchedule = function createSchedule(request, callback) { + return this.rpcCall(createSchedule, $root.google.cloud.aiplatform.v1.CreateScheduleRequest, $root.google.cloud.aiplatform.v1.Schedule, request, callback); + }, "name", { value: "CreateSchedule" }); + + /** + * Calls CreateSchedule. + * @function createSchedule + * @memberof google.cloud.aiplatform.v1.ScheduleService + * @instance + * @param {google.cloud.aiplatform.v1.ICreateScheduleRequest} request CreateScheduleRequest message or plain object + * @returns {Promise} Promise + * @variation 2 + */ + + /** + * Callback as used by {@link google.cloud.aiplatform.v1.ScheduleService|deleteSchedule}. + * @memberof google.cloud.aiplatform.v1.ScheduleService + * @typedef DeleteScheduleCallback + * @type {function} + * @param {Error|null} error Error, if any + * @param {google.longrunning.Operation} [response] Operation + */ + + /** + * Calls DeleteSchedule. + * @function deleteSchedule + * @memberof google.cloud.aiplatform.v1.ScheduleService + * @instance + * @param {google.cloud.aiplatform.v1.IDeleteScheduleRequest} request DeleteScheduleRequest message or plain object + * @param {google.cloud.aiplatform.v1.ScheduleService.DeleteScheduleCallback} callback Node-style callback called with the error, if any, and Operation + * @returns {undefined} + * @variation 1 + */ + Object.defineProperty(ScheduleService.prototype.deleteSchedule = function deleteSchedule(request, callback) { + return this.rpcCall(deleteSchedule, $root.google.cloud.aiplatform.v1.DeleteScheduleRequest, $root.google.longrunning.Operation, request, callback); + }, "name", { value: "DeleteSchedule" }); + + /** + * Calls DeleteSchedule. + * @function deleteSchedule + * @memberof google.cloud.aiplatform.v1.ScheduleService + * @instance + * @param {google.cloud.aiplatform.v1.IDeleteScheduleRequest} request DeleteScheduleRequest message or plain object + * @returns {Promise} Promise + * @variation 2 + */ + + /** + * Callback as used by {@link google.cloud.aiplatform.v1.ScheduleService|getSchedule}. + * @memberof google.cloud.aiplatform.v1.ScheduleService + * @typedef GetScheduleCallback + * @type {function} + * @param {Error|null} error Error, if any + * @param {google.cloud.aiplatform.v1.Schedule} [response] Schedule + */ + + /** + * Calls GetSchedule. + * @function getSchedule + * @memberof google.cloud.aiplatform.v1.ScheduleService + * @instance + * @param {google.cloud.aiplatform.v1.IGetScheduleRequest} request GetScheduleRequest message or plain object + * @param {google.cloud.aiplatform.v1.ScheduleService.GetScheduleCallback} callback Node-style callback called with the error, if any, and Schedule + * @returns {undefined} + * @variation 1 + */ + Object.defineProperty(ScheduleService.prototype.getSchedule = function getSchedule(request, callback) { + return this.rpcCall(getSchedule, $root.google.cloud.aiplatform.v1.GetScheduleRequest, $root.google.cloud.aiplatform.v1.Schedule, request, callback); + }, "name", { value: "GetSchedule" }); + + /** + * Calls GetSchedule. + * @function getSchedule + * @memberof google.cloud.aiplatform.v1.ScheduleService + * @instance + * @param {google.cloud.aiplatform.v1.IGetScheduleRequest} request GetScheduleRequest message or plain object + * @returns {Promise} Promise + * @variation 2 + */ + + /** + * Callback as used by {@link google.cloud.aiplatform.v1.ScheduleService|listSchedules}. + * @memberof google.cloud.aiplatform.v1.ScheduleService + * @typedef ListSchedulesCallback + * @type {function} + * @param {Error|null} error Error, if any + * @param {google.cloud.aiplatform.v1.ListSchedulesResponse} [response] ListSchedulesResponse + */ + + /** + * Calls ListSchedules. + * @function listSchedules + * @memberof google.cloud.aiplatform.v1.ScheduleService + * @instance + * @param {google.cloud.aiplatform.v1.IListSchedulesRequest} request ListSchedulesRequest message or plain object + * @param {google.cloud.aiplatform.v1.ScheduleService.ListSchedulesCallback} callback Node-style callback called with the error, if any, and ListSchedulesResponse + * @returns {undefined} + * @variation 1 + */ + Object.defineProperty(ScheduleService.prototype.listSchedules = function listSchedules(request, callback) { + return this.rpcCall(listSchedules, $root.google.cloud.aiplatform.v1.ListSchedulesRequest, $root.google.cloud.aiplatform.v1.ListSchedulesResponse, request, callback); + }, "name", { value: "ListSchedules" }); + + /** + * Calls ListSchedules. + * @function listSchedules + * @memberof google.cloud.aiplatform.v1.ScheduleService + * @instance + * @param {google.cloud.aiplatform.v1.IListSchedulesRequest} request ListSchedulesRequest message or plain object + * @returns {Promise} Promise + * @variation 2 + */ + + /** + * Callback as used by {@link google.cloud.aiplatform.v1.ScheduleService|pauseSchedule}. + * @memberof google.cloud.aiplatform.v1.ScheduleService + * @typedef PauseScheduleCallback + * @type {function} + * @param {Error|null} error Error, if any + * @param {google.protobuf.Empty} [response] Empty + */ + + /** + * Calls PauseSchedule. + * @function pauseSchedule + * @memberof google.cloud.aiplatform.v1.ScheduleService + * @instance + * @param {google.cloud.aiplatform.v1.IPauseScheduleRequest} request PauseScheduleRequest message or plain object + * @param {google.cloud.aiplatform.v1.ScheduleService.PauseScheduleCallback} callback Node-style callback called with the error, if any, and Empty + * @returns {undefined} + * @variation 1 + */ + Object.defineProperty(ScheduleService.prototype.pauseSchedule = function pauseSchedule(request, callback) { + return this.rpcCall(pauseSchedule, $root.google.cloud.aiplatform.v1.PauseScheduleRequest, $root.google.protobuf.Empty, request, callback); + }, "name", { value: "PauseSchedule" }); + + /** + * Calls PauseSchedule. + * @function pauseSchedule + * @memberof google.cloud.aiplatform.v1.ScheduleService + * @instance + * @param {google.cloud.aiplatform.v1.IPauseScheduleRequest} request PauseScheduleRequest message or plain object + * @returns {Promise} Promise + * @variation 2 + */ + + /** + * Callback as used by {@link google.cloud.aiplatform.v1.ScheduleService|resumeSchedule}. + * @memberof google.cloud.aiplatform.v1.ScheduleService + * @typedef ResumeScheduleCallback + * @type {function} + * @param {Error|null} error Error, if any + * @param {google.protobuf.Empty} [response] Empty + */ + + /** + * Calls ResumeSchedule. + * @function resumeSchedule + * @memberof google.cloud.aiplatform.v1.ScheduleService + * @instance + * @param {google.cloud.aiplatform.v1.IResumeScheduleRequest} request ResumeScheduleRequest message or plain object + * @param {google.cloud.aiplatform.v1.ScheduleService.ResumeScheduleCallback} callback Node-style callback called with the error, if any, and Empty + * @returns {undefined} + * @variation 1 + */ + Object.defineProperty(ScheduleService.prototype.resumeSchedule = function resumeSchedule(request, callback) { + return this.rpcCall(resumeSchedule, $root.google.cloud.aiplatform.v1.ResumeScheduleRequest, $root.google.protobuf.Empty, request, callback); + }, "name", { value: "ResumeSchedule" }); + + /** + * Calls ResumeSchedule. + * @function resumeSchedule + * @memberof google.cloud.aiplatform.v1.ScheduleService + * @instance + * @param {google.cloud.aiplatform.v1.IResumeScheduleRequest} request ResumeScheduleRequest message or plain object + * @returns {Promise} Promise + * @variation 2 + */ + + /** + * Callback as used by {@link google.cloud.aiplatform.v1.ScheduleService|updateSchedule}. + * @memberof google.cloud.aiplatform.v1.ScheduleService + * @typedef UpdateScheduleCallback + * @type {function} + * @param {Error|null} error Error, if any + * @param {google.cloud.aiplatform.v1.Schedule} [response] Schedule + */ + + /** + * Calls UpdateSchedule. + * @function updateSchedule + * @memberof google.cloud.aiplatform.v1.ScheduleService + * @instance + * @param {google.cloud.aiplatform.v1.IUpdateScheduleRequest} request UpdateScheduleRequest message or plain object + * @param {google.cloud.aiplatform.v1.ScheduleService.UpdateScheduleCallback} callback Node-style callback called with the error, if any, and Schedule + * @returns {undefined} + * @variation 1 + */ + Object.defineProperty(ScheduleService.prototype.updateSchedule = function updateSchedule(request, callback) { + return this.rpcCall(updateSchedule, $root.google.cloud.aiplatform.v1.UpdateScheduleRequest, $root.google.cloud.aiplatform.v1.Schedule, request, callback); + }, "name", { value: "UpdateSchedule" }); + + /** + * Calls UpdateSchedule. + * @function updateSchedule + * @memberof google.cloud.aiplatform.v1.ScheduleService + * @instance + * @param {google.cloud.aiplatform.v1.IUpdateScheduleRequest} request UpdateScheduleRequest message or plain object + * @returns {Promise} Promise + * @variation 2 + */ + + return ScheduleService; + })(); + + v1.CreateScheduleRequest = (function() { + + /** + * Properties of a CreateScheduleRequest. + * @memberof google.cloud.aiplatform.v1 + * @interface ICreateScheduleRequest + * @property {string|null} [parent] CreateScheduleRequest parent + * @property {google.cloud.aiplatform.v1.ISchedule|null} [schedule] CreateScheduleRequest schedule + */ + + /** + * Constructs a new CreateScheduleRequest. + * @memberof google.cloud.aiplatform.v1 + * @classdesc Represents a CreateScheduleRequest. + * @implements ICreateScheduleRequest + * @constructor + * @param {google.cloud.aiplatform.v1.ICreateScheduleRequest=} [properties] Properties to set + */ + function CreateScheduleRequest(properties) { + if (properties) + for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) + if (properties[keys[i]] != null) + this[keys[i]] = properties[keys[i]]; + } + + /** + * CreateScheduleRequest parent. + * @member {string} parent + * @memberof google.cloud.aiplatform.v1.CreateScheduleRequest + * @instance + */ + CreateScheduleRequest.prototype.parent = ""; + + /** + * CreateScheduleRequest schedule. + * @member {google.cloud.aiplatform.v1.ISchedule|null|undefined} schedule + * @memberof google.cloud.aiplatform.v1.CreateScheduleRequest + * @instance + */ + CreateScheduleRequest.prototype.schedule = null; + + /** + * Creates a new CreateScheduleRequest instance using the specified properties. + * @function create + * @memberof google.cloud.aiplatform.v1.CreateScheduleRequest + * @static + * @param {google.cloud.aiplatform.v1.ICreateScheduleRequest=} [properties] Properties to set + * @returns {google.cloud.aiplatform.v1.CreateScheduleRequest} CreateScheduleRequest instance + */ + CreateScheduleRequest.create = function create(properties) { + return new CreateScheduleRequest(properties); + }; + + /** + * Encodes the specified CreateScheduleRequest message. Does not implicitly {@link google.cloud.aiplatform.v1.CreateScheduleRequest.verify|verify} messages. + * @function encode + * @memberof google.cloud.aiplatform.v1.CreateScheduleRequest + * @static + * @param {google.cloud.aiplatform.v1.ICreateScheduleRequest} message CreateScheduleRequest message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + CreateScheduleRequest.encode = function encode(message, writer) { + if (!writer) + writer = $Writer.create(); + if (message.parent != null && Object.hasOwnProperty.call(message, "parent")) + writer.uint32(/* id 1, wireType 2 =*/10).string(message.parent); + if (message.schedule != null && Object.hasOwnProperty.call(message, "schedule")) + $root.google.cloud.aiplatform.v1.Schedule.encode(message.schedule, writer.uint32(/* id 2, wireType 2 =*/18).fork()).ldelim(); + return writer; + }; + + /** + * Encodes the specified CreateScheduleRequest message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.CreateScheduleRequest.verify|verify} messages. + * @function encodeDelimited + * @memberof google.cloud.aiplatform.v1.CreateScheduleRequest + * @static + * @param {google.cloud.aiplatform.v1.ICreateScheduleRequest} message CreateScheduleRequest message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + CreateScheduleRequest.encodeDelimited = function encodeDelimited(message, writer) { + return this.encode(message, writer).ldelim(); + }; + + /** + * Decodes a CreateScheduleRequest message from the specified reader or buffer. + * @function decode + * @memberof google.cloud.aiplatform.v1.CreateScheduleRequest + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @param {number} [length] Message length if known beforehand + * @returns {google.cloud.aiplatform.v1.CreateScheduleRequest} CreateScheduleRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + CreateScheduleRequest.decode = function decode(reader, length) { + if (!(reader instanceof $Reader)) + reader = $Reader.create(reader); + var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.aiplatform.v1.CreateScheduleRequest(); + while (reader.pos < end) { + var tag = reader.uint32(); + switch (tag >>> 3) { + case 1: { + message.parent = reader.string(); + break; + } + case 2: { + message.schedule = $root.google.cloud.aiplatform.v1.Schedule.decode(reader, reader.uint32()); + break; + } + default: + reader.skipType(tag & 7); + break; + } + } + return message; + }; + + /** + * Decodes a CreateScheduleRequest message from the specified reader or buffer, length delimited. + * @function decodeDelimited + * @memberof google.cloud.aiplatform.v1.CreateScheduleRequest + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @returns {google.cloud.aiplatform.v1.CreateScheduleRequest} CreateScheduleRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + CreateScheduleRequest.decodeDelimited = function decodeDelimited(reader) { + if (!(reader instanceof $Reader)) + reader = new $Reader(reader); + return this.decode(reader, reader.uint32()); + }; + + /** + * Verifies a CreateScheduleRequest message. + * @function verify + * @memberof google.cloud.aiplatform.v1.CreateScheduleRequest + * @static + * @param {Object.} message Plain object to verify + * @returns {string|null} `null` if valid, otherwise the reason why it is not + */ + CreateScheduleRequest.verify = function verify(message) { + if (typeof message !== "object" || message === null) + return "object expected"; + if (message.parent != null && message.hasOwnProperty("parent")) + if (!$util.isString(message.parent)) + return "parent: string expected"; + if (message.schedule != null && message.hasOwnProperty("schedule")) { + var error = $root.google.cloud.aiplatform.v1.Schedule.verify(message.schedule); + if (error) + return "schedule." + error; + } + return null; + }; + + /** + * Creates a CreateScheduleRequest message from a plain object. Also converts values to their respective internal types. + * @function fromObject + * @memberof google.cloud.aiplatform.v1.CreateScheduleRequest + * @static + * @param {Object.} object Plain object + * @returns {google.cloud.aiplatform.v1.CreateScheduleRequest} CreateScheduleRequest + */ + CreateScheduleRequest.fromObject = function fromObject(object) { + if (object instanceof $root.google.cloud.aiplatform.v1.CreateScheduleRequest) + return object; + var message = new $root.google.cloud.aiplatform.v1.CreateScheduleRequest(); + if (object.parent != null) + message.parent = String(object.parent); + if (object.schedule != null) { + if (typeof object.schedule !== "object") + throw TypeError(".google.cloud.aiplatform.v1.CreateScheduleRequest.schedule: object expected"); + message.schedule = $root.google.cloud.aiplatform.v1.Schedule.fromObject(object.schedule); + } + return message; + }; + + /** + * Creates a plain object from a CreateScheduleRequest message. Also converts values to other types if specified. + * @function toObject + * @memberof google.cloud.aiplatform.v1.CreateScheduleRequest + * @static + * @param {google.cloud.aiplatform.v1.CreateScheduleRequest} message CreateScheduleRequest + * @param {$protobuf.IConversionOptions} [options] Conversion options + * @returns {Object.} Plain object + */ + CreateScheduleRequest.toObject = function toObject(message, options) { + if (!options) + options = {}; + var object = {}; + if (options.defaults) { + object.parent = ""; + object.schedule = null; + } + if (message.parent != null && message.hasOwnProperty("parent")) + object.parent = message.parent; + if (message.schedule != null && message.hasOwnProperty("schedule")) + object.schedule = $root.google.cloud.aiplatform.v1.Schedule.toObject(message.schedule, options); + return object; + }; + + /** + * Converts this CreateScheduleRequest to JSON. + * @function toJSON + * @memberof google.cloud.aiplatform.v1.CreateScheduleRequest + * @instance + * @returns {Object.} JSON object + */ + CreateScheduleRequest.prototype.toJSON = function toJSON() { + return this.constructor.toObject(this, $protobuf.util.toJSONOptions); + }; + + /** + * Gets the default type url for CreateScheduleRequest + * @function getTypeUrl + * @memberof google.cloud.aiplatform.v1.CreateScheduleRequest + * @static + * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns {string} The default type url + */ + CreateScheduleRequest.getTypeUrl = function getTypeUrl(typeUrlPrefix) { + if (typeUrlPrefix === undefined) { + typeUrlPrefix = "type.googleapis.com"; + } + return typeUrlPrefix + "/google.cloud.aiplatform.v1.CreateScheduleRequest"; + }; + + return CreateScheduleRequest; + })(); + + v1.GetScheduleRequest = (function() { + + /** + * Properties of a GetScheduleRequest. + * @memberof google.cloud.aiplatform.v1 + * @interface IGetScheduleRequest + * @property {string|null} [name] GetScheduleRequest name + */ + + /** + * Constructs a new GetScheduleRequest. + * @memberof google.cloud.aiplatform.v1 + * @classdesc Represents a GetScheduleRequest. + * @implements IGetScheduleRequest + * @constructor + * @param {google.cloud.aiplatform.v1.IGetScheduleRequest=} [properties] Properties to set + */ + function GetScheduleRequest(properties) { + if (properties) + for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) + if (properties[keys[i]] != null) + this[keys[i]] = properties[keys[i]]; + } + + /** + * GetScheduleRequest name. + * @member {string} name + * @memberof google.cloud.aiplatform.v1.GetScheduleRequest + * @instance + */ + GetScheduleRequest.prototype.name = ""; + + /** + * Creates a new GetScheduleRequest instance using the specified properties. + * @function create + * @memberof google.cloud.aiplatform.v1.GetScheduleRequest + * @static + * @param {google.cloud.aiplatform.v1.IGetScheduleRequest=} [properties] Properties to set + * @returns {google.cloud.aiplatform.v1.GetScheduleRequest} GetScheduleRequest instance + */ + GetScheduleRequest.create = function create(properties) { + return new GetScheduleRequest(properties); + }; + + /** + * Encodes the specified GetScheduleRequest message. Does not implicitly {@link google.cloud.aiplatform.v1.GetScheduleRequest.verify|verify} messages. + * @function encode + * @memberof google.cloud.aiplatform.v1.GetScheduleRequest + * @static + * @param {google.cloud.aiplatform.v1.IGetScheduleRequest} message GetScheduleRequest message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + GetScheduleRequest.encode = function encode(message, writer) { + if (!writer) + writer = $Writer.create(); + if (message.name != null && Object.hasOwnProperty.call(message, "name")) + writer.uint32(/* id 1, wireType 2 =*/10).string(message.name); + return writer; + }; + + /** + * Encodes the specified GetScheduleRequest message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.GetScheduleRequest.verify|verify} messages. + * @function encodeDelimited + * @memberof google.cloud.aiplatform.v1.GetScheduleRequest + * @static + * @param {google.cloud.aiplatform.v1.IGetScheduleRequest} message GetScheduleRequest message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + GetScheduleRequest.encodeDelimited = function encodeDelimited(message, writer) { + return this.encode(message, writer).ldelim(); + }; + + /** + * Decodes a GetScheduleRequest message from the specified reader or buffer. + * @function decode + * @memberof google.cloud.aiplatform.v1.GetScheduleRequest + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @param {number} [length] Message length if known beforehand + * @returns {google.cloud.aiplatform.v1.GetScheduleRequest} GetScheduleRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + GetScheduleRequest.decode = function decode(reader, length) { + if (!(reader instanceof $Reader)) + reader = $Reader.create(reader); + var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.aiplatform.v1.GetScheduleRequest(); + while (reader.pos < end) { + var tag = reader.uint32(); + switch (tag >>> 3) { + case 1: { + message.name = reader.string(); + break; + } + default: + reader.skipType(tag & 7); + break; + } + } + return message; + }; + + /** + * Decodes a GetScheduleRequest message from the specified reader or buffer, length delimited. + * @function decodeDelimited + * @memberof google.cloud.aiplatform.v1.GetScheduleRequest + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @returns {google.cloud.aiplatform.v1.GetScheduleRequest} GetScheduleRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + GetScheduleRequest.decodeDelimited = function decodeDelimited(reader) { + if (!(reader instanceof $Reader)) + reader = new $Reader(reader); + return this.decode(reader, reader.uint32()); + }; + + /** + * Verifies a GetScheduleRequest message. + * @function verify + * @memberof google.cloud.aiplatform.v1.GetScheduleRequest + * @static + * @param {Object.} message Plain object to verify + * @returns {string|null} `null` if valid, otherwise the reason why it is not + */ + GetScheduleRequest.verify = function verify(message) { + if (typeof message !== "object" || message === null) + return "object expected"; + if (message.name != null && message.hasOwnProperty("name")) + if (!$util.isString(message.name)) + return "name: string expected"; + return null; + }; + + /** + * Creates a GetScheduleRequest message from a plain object. Also converts values to their respective internal types. + * @function fromObject + * @memberof google.cloud.aiplatform.v1.GetScheduleRequest + * @static + * @param {Object.} object Plain object + * @returns {google.cloud.aiplatform.v1.GetScheduleRequest} GetScheduleRequest + */ + GetScheduleRequest.fromObject = function fromObject(object) { + if (object instanceof $root.google.cloud.aiplatform.v1.GetScheduleRequest) + return object; + var message = new $root.google.cloud.aiplatform.v1.GetScheduleRequest(); + if (object.name != null) + message.name = String(object.name); + return message; + }; + + /** + * Creates a plain object from a GetScheduleRequest message. Also converts values to other types if specified. + * @function toObject + * @memberof google.cloud.aiplatform.v1.GetScheduleRequest + * @static + * @param {google.cloud.aiplatform.v1.GetScheduleRequest} message GetScheduleRequest + * @param {$protobuf.IConversionOptions} [options] Conversion options + * @returns {Object.} Plain object + */ + GetScheduleRequest.toObject = function toObject(message, options) { + if (!options) + options = {}; + var object = {}; + if (options.defaults) + object.name = ""; + if (message.name != null && message.hasOwnProperty("name")) + object.name = message.name; + return object; + }; + + /** + * Converts this GetScheduleRequest to JSON. + * @function toJSON + * @memberof google.cloud.aiplatform.v1.GetScheduleRequest + * @instance + * @returns {Object.} JSON object + */ + GetScheduleRequest.prototype.toJSON = function toJSON() { + return this.constructor.toObject(this, $protobuf.util.toJSONOptions); + }; + + /** + * Gets the default type url for GetScheduleRequest + * @function getTypeUrl + * @memberof google.cloud.aiplatform.v1.GetScheduleRequest + * @static + * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns {string} The default type url + */ + GetScheduleRequest.getTypeUrl = function getTypeUrl(typeUrlPrefix) { + if (typeUrlPrefix === undefined) { + typeUrlPrefix = "type.googleapis.com"; + } + return typeUrlPrefix + "/google.cloud.aiplatform.v1.GetScheduleRequest"; + }; + + return GetScheduleRequest; + })(); + + v1.ListSchedulesRequest = (function() { + + /** + * Properties of a ListSchedulesRequest. + * @memberof google.cloud.aiplatform.v1 + * @interface IListSchedulesRequest + * @property {string|null} [parent] ListSchedulesRequest parent + * @property {string|null} [filter] ListSchedulesRequest filter + * @property {number|null} [pageSize] ListSchedulesRequest pageSize + * @property {string|null} [pageToken] ListSchedulesRequest pageToken + * @property {string|null} [orderBy] ListSchedulesRequest orderBy + */ + + /** + * Constructs a new ListSchedulesRequest. + * @memberof google.cloud.aiplatform.v1 + * @classdesc Represents a ListSchedulesRequest. + * @implements IListSchedulesRequest + * @constructor + * @param {google.cloud.aiplatform.v1.IListSchedulesRequest=} [properties] Properties to set + */ + function ListSchedulesRequest(properties) { + if (properties) + for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) + if (properties[keys[i]] != null) + this[keys[i]] = properties[keys[i]]; + } + + /** + * ListSchedulesRequest parent. + * @member {string} parent + * @memberof google.cloud.aiplatform.v1.ListSchedulesRequest + * @instance + */ + ListSchedulesRequest.prototype.parent = ""; + + /** + * ListSchedulesRequest filter. + * @member {string} filter + * @memberof google.cloud.aiplatform.v1.ListSchedulesRequest + * @instance + */ + ListSchedulesRequest.prototype.filter = ""; + + /** + * ListSchedulesRequest pageSize. + * @member {number} pageSize + * @memberof google.cloud.aiplatform.v1.ListSchedulesRequest + * @instance + */ + ListSchedulesRequest.prototype.pageSize = 0; + + /** + * ListSchedulesRequest pageToken. + * @member {string} pageToken + * @memberof google.cloud.aiplatform.v1.ListSchedulesRequest + * @instance + */ + ListSchedulesRequest.prototype.pageToken = ""; + + /** + * ListSchedulesRequest orderBy. + * @member {string} orderBy + * @memberof google.cloud.aiplatform.v1.ListSchedulesRequest + * @instance + */ + ListSchedulesRequest.prototype.orderBy = ""; + + /** + * Creates a new ListSchedulesRequest instance using the specified properties. + * @function create + * @memberof google.cloud.aiplatform.v1.ListSchedulesRequest + * @static + * @param {google.cloud.aiplatform.v1.IListSchedulesRequest=} [properties] Properties to set + * @returns {google.cloud.aiplatform.v1.ListSchedulesRequest} ListSchedulesRequest instance + */ + ListSchedulesRequest.create = function create(properties) { + return new ListSchedulesRequest(properties); + }; + + /** + * Encodes the specified ListSchedulesRequest message. Does not implicitly {@link google.cloud.aiplatform.v1.ListSchedulesRequest.verify|verify} messages. + * @function encode + * @memberof google.cloud.aiplatform.v1.ListSchedulesRequest + * @static + * @param {google.cloud.aiplatform.v1.IListSchedulesRequest} message ListSchedulesRequest message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + ListSchedulesRequest.encode = function encode(message, writer) { + if (!writer) + writer = $Writer.create(); + if (message.parent != null && Object.hasOwnProperty.call(message, "parent")) + writer.uint32(/* id 1, wireType 2 =*/10).string(message.parent); + if (message.filter != null && Object.hasOwnProperty.call(message, "filter")) + writer.uint32(/* id 2, wireType 2 =*/18).string(message.filter); + if (message.pageSize != null && Object.hasOwnProperty.call(message, "pageSize")) + writer.uint32(/* id 3, wireType 0 =*/24).int32(message.pageSize); + if (message.pageToken != null && Object.hasOwnProperty.call(message, "pageToken")) + writer.uint32(/* id 4, wireType 2 =*/34).string(message.pageToken); + if (message.orderBy != null && Object.hasOwnProperty.call(message, "orderBy")) + writer.uint32(/* id 5, wireType 2 =*/42).string(message.orderBy); + return writer; + }; + + /** + * Encodes the specified ListSchedulesRequest message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.ListSchedulesRequest.verify|verify} messages. + * @function encodeDelimited + * @memberof google.cloud.aiplatform.v1.ListSchedulesRequest + * @static + * @param {google.cloud.aiplatform.v1.IListSchedulesRequest} message ListSchedulesRequest message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + ListSchedulesRequest.encodeDelimited = function encodeDelimited(message, writer) { + return this.encode(message, writer).ldelim(); + }; + + /** + * Decodes a ListSchedulesRequest message from the specified reader or buffer. + * @function decode + * @memberof google.cloud.aiplatform.v1.ListSchedulesRequest + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @param {number} [length] Message length if known beforehand + * @returns {google.cloud.aiplatform.v1.ListSchedulesRequest} ListSchedulesRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + ListSchedulesRequest.decode = function decode(reader, length) { + if (!(reader instanceof $Reader)) + reader = $Reader.create(reader); + var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.aiplatform.v1.ListSchedulesRequest(); + while (reader.pos < end) { + var tag = reader.uint32(); + switch (tag >>> 3) { + case 1: { + message.parent = reader.string(); + break; + } + case 2: { + message.filter = reader.string(); + break; + } + case 3: { + message.pageSize = reader.int32(); + break; + } + case 4: { + message.pageToken = reader.string(); + break; + } + case 5: { + message.orderBy = reader.string(); + break; + } + default: + reader.skipType(tag & 7); + break; + } + } + return message; + }; + + /** + * Decodes a ListSchedulesRequest message from the specified reader or buffer, length delimited. + * @function decodeDelimited + * @memberof google.cloud.aiplatform.v1.ListSchedulesRequest + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @returns {google.cloud.aiplatform.v1.ListSchedulesRequest} ListSchedulesRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + ListSchedulesRequest.decodeDelimited = function decodeDelimited(reader) { + if (!(reader instanceof $Reader)) + reader = new $Reader(reader); + return this.decode(reader, reader.uint32()); + }; + + /** + * Verifies a ListSchedulesRequest message. + * @function verify + * @memberof google.cloud.aiplatform.v1.ListSchedulesRequest + * @static + * @param {Object.} message Plain object to verify + * @returns {string|null} `null` if valid, otherwise the reason why it is not + */ + ListSchedulesRequest.verify = function verify(message) { + if (typeof message !== "object" || message === null) + return "object expected"; + if (message.parent != null && message.hasOwnProperty("parent")) + if (!$util.isString(message.parent)) + return "parent: string expected"; + if (message.filter != null && message.hasOwnProperty("filter")) + if (!$util.isString(message.filter)) + return "filter: string expected"; + if (message.pageSize != null && message.hasOwnProperty("pageSize")) + if (!$util.isInteger(message.pageSize)) + return "pageSize: integer expected"; + if (message.pageToken != null && message.hasOwnProperty("pageToken")) + if (!$util.isString(message.pageToken)) + return "pageToken: string expected"; + if (message.orderBy != null && message.hasOwnProperty("orderBy")) + if (!$util.isString(message.orderBy)) + return "orderBy: string expected"; + return null; + }; + + /** + * Creates a ListSchedulesRequest message from a plain object. Also converts values to their respective internal types. + * @function fromObject + * @memberof google.cloud.aiplatform.v1.ListSchedulesRequest + * @static + * @param {Object.} object Plain object + * @returns {google.cloud.aiplatform.v1.ListSchedulesRequest} ListSchedulesRequest + */ + ListSchedulesRequest.fromObject = function fromObject(object) { + if (object instanceof $root.google.cloud.aiplatform.v1.ListSchedulesRequest) + return object; + var message = new $root.google.cloud.aiplatform.v1.ListSchedulesRequest(); + if (object.parent != null) + message.parent = String(object.parent); + if (object.filter != null) + message.filter = String(object.filter); + if (object.pageSize != null) + message.pageSize = object.pageSize | 0; + if (object.pageToken != null) + message.pageToken = String(object.pageToken); + if (object.orderBy != null) + message.orderBy = String(object.orderBy); + return message; + }; + + /** + * Creates a plain object from a ListSchedulesRequest message. Also converts values to other types if specified. + * @function toObject + * @memberof google.cloud.aiplatform.v1.ListSchedulesRequest + * @static + * @param {google.cloud.aiplatform.v1.ListSchedulesRequest} message ListSchedulesRequest + * @param {$protobuf.IConversionOptions} [options] Conversion options + * @returns {Object.} Plain object + */ + ListSchedulesRequest.toObject = function toObject(message, options) { + if (!options) + options = {}; + var object = {}; + if (options.defaults) { + object.parent = ""; + object.filter = ""; + object.pageSize = 0; + object.pageToken = ""; + object.orderBy = ""; + } + if (message.parent != null && message.hasOwnProperty("parent")) + object.parent = message.parent; + if (message.filter != null && message.hasOwnProperty("filter")) + object.filter = message.filter; + if (message.pageSize != null && message.hasOwnProperty("pageSize")) + object.pageSize = message.pageSize; + if (message.pageToken != null && message.hasOwnProperty("pageToken")) + object.pageToken = message.pageToken; + if (message.orderBy != null && message.hasOwnProperty("orderBy")) + object.orderBy = message.orderBy; + return object; + }; + + /** + * Converts this ListSchedulesRequest to JSON. + * @function toJSON + * @memberof google.cloud.aiplatform.v1.ListSchedulesRequest + * @instance + * @returns {Object.} JSON object + */ + ListSchedulesRequest.prototype.toJSON = function toJSON() { + return this.constructor.toObject(this, $protobuf.util.toJSONOptions); + }; + + /** + * Gets the default type url for ListSchedulesRequest + * @function getTypeUrl + * @memberof google.cloud.aiplatform.v1.ListSchedulesRequest + * @static + * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns {string} The default type url + */ + ListSchedulesRequest.getTypeUrl = function getTypeUrl(typeUrlPrefix) { + if (typeUrlPrefix === undefined) { + typeUrlPrefix = "type.googleapis.com"; + } + return typeUrlPrefix + "/google.cloud.aiplatform.v1.ListSchedulesRequest"; + }; + + return ListSchedulesRequest; + })(); + + v1.ListSchedulesResponse = (function() { + + /** + * Properties of a ListSchedulesResponse. + * @memberof google.cloud.aiplatform.v1 + * @interface IListSchedulesResponse + * @property {Array.|null} [schedules] ListSchedulesResponse schedules + * @property {string|null} [nextPageToken] ListSchedulesResponse nextPageToken + */ + + /** + * Constructs a new ListSchedulesResponse. + * @memberof google.cloud.aiplatform.v1 + * @classdesc Represents a ListSchedulesResponse. + * @implements IListSchedulesResponse + * @constructor + * @param {google.cloud.aiplatform.v1.IListSchedulesResponse=} [properties] Properties to set + */ + function ListSchedulesResponse(properties) { + this.schedules = []; + if (properties) + for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) + if (properties[keys[i]] != null) + this[keys[i]] = properties[keys[i]]; + } + + /** + * ListSchedulesResponse schedules. + * @member {Array.} schedules + * @memberof google.cloud.aiplatform.v1.ListSchedulesResponse + * @instance + */ + ListSchedulesResponse.prototype.schedules = $util.emptyArray; + + /** + * ListSchedulesResponse nextPageToken. + * @member {string} nextPageToken + * @memberof google.cloud.aiplatform.v1.ListSchedulesResponse + * @instance + */ + ListSchedulesResponse.prototype.nextPageToken = ""; + + /** + * Creates a new ListSchedulesResponse instance using the specified properties. + * @function create + * @memberof google.cloud.aiplatform.v1.ListSchedulesResponse + * @static + * @param {google.cloud.aiplatform.v1.IListSchedulesResponse=} [properties] Properties to set + * @returns {google.cloud.aiplatform.v1.ListSchedulesResponse} ListSchedulesResponse instance + */ + ListSchedulesResponse.create = function create(properties) { + return new ListSchedulesResponse(properties); + }; + + /** + * Encodes the specified ListSchedulesResponse message. Does not implicitly {@link google.cloud.aiplatform.v1.ListSchedulesResponse.verify|verify} messages. + * @function encode + * @memberof google.cloud.aiplatform.v1.ListSchedulesResponse + * @static + * @param {google.cloud.aiplatform.v1.IListSchedulesResponse} message ListSchedulesResponse message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + ListSchedulesResponse.encode = function encode(message, writer) { + if (!writer) + writer = $Writer.create(); + if (message.schedules != null && message.schedules.length) + for (var i = 0; i < message.schedules.length; ++i) + $root.google.cloud.aiplatform.v1.Schedule.encode(message.schedules[i], writer.uint32(/* id 1, wireType 2 =*/10).fork()).ldelim(); + if (message.nextPageToken != null && Object.hasOwnProperty.call(message, "nextPageToken")) + writer.uint32(/* id 2, wireType 2 =*/18).string(message.nextPageToken); + return writer; + }; + + /** + * Encodes the specified ListSchedulesResponse message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.ListSchedulesResponse.verify|verify} messages. + * @function encodeDelimited + * @memberof google.cloud.aiplatform.v1.ListSchedulesResponse + * @static + * @param {google.cloud.aiplatform.v1.IListSchedulesResponse} message ListSchedulesResponse message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + ListSchedulesResponse.encodeDelimited = function encodeDelimited(message, writer) { + return this.encode(message, writer).ldelim(); + }; + + /** + * Decodes a ListSchedulesResponse message from the specified reader or buffer. + * @function decode + * @memberof google.cloud.aiplatform.v1.ListSchedulesResponse + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @param {number} [length] Message length if known beforehand + * @returns {google.cloud.aiplatform.v1.ListSchedulesResponse} ListSchedulesResponse + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + ListSchedulesResponse.decode = function decode(reader, length) { + if (!(reader instanceof $Reader)) + reader = $Reader.create(reader); + var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.aiplatform.v1.ListSchedulesResponse(); + while (reader.pos < end) { + var tag = reader.uint32(); + switch (tag >>> 3) { + case 1: { + if (!(message.schedules && message.schedules.length)) + message.schedules = []; + message.schedules.push($root.google.cloud.aiplatform.v1.Schedule.decode(reader, reader.uint32())); + break; + } + case 2: { + message.nextPageToken = reader.string(); + break; + } + default: + reader.skipType(tag & 7); + break; + } + } + return message; + }; + + /** + * Decodes a ListSchedulesResponse message from the specified reader or buffer, length delimited. + * @function decodeDelimited + * @memberof google.cloud.aiplatform.v1.ListSchedulesResponse + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @returns {google.cloud.aiplatform.v1.ListSchedulesResponse} ListSchedulesResponse + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + ListSchedulesResponse.decodeDelimited = function decodeDelimited(reader) { + if (!(reader instanceof $Reader)) + reader = new $Reader(reader); + return this.decode(reader, reader.uint32()); + }; + + /** + * Verifies a ListSchedulesResponse message. + * @function verify + * @memberof google.cloud.aiplatform.v1.ListSchedulesResponse + * @static + * @param {Object.} message Plain object to verify + * @returns {string|null} `null` if valid, otherwise the reason why it is not + */ + ListSchedulesResponse.verify = function verify(message) { + if (typeof message !== "object" || message === null) + return "object expected"; + if (message.schedules != null && message.hasOwnProperty("schedules")) { + if (!Array.isArray(message.schedules)) + return "schedules: array expected"; + for (var i = 0; i < message.schedules.length; ++i) { + var error = $root.google.cloud.aiplatform.v1.Schedule.verify(message.schedules[i]); + if (error) + return "schedules." + error; + } + } + if (message.nextPageToken != null && message.hasOwnProperty("nextPageToken")) + if (!$util.isString(message.nextPageToken)) + return "nextPageToken: string expected"; + return null; + }; + + /** + * Creates a ListSchedulesResponse message from a plain object. Also converts values to their respective internal types. + * @function fromObject + * @memberof google.cloud.aiplatform.v1.ListSchedulesResponse + * @static + * @param {Object.} object Plain object + * @returns {google.cloud.aiplatform.v1.ListSchedulesResponse} ListSchedulesResponse + */ + ListSchedulesResponse.fromObject = function fromObject(object) { + if (object instanceof $root.google.cloud.aiplatform.v1.ListSchedulesResponse) + return object; + var message = new $root.google.cloud.aiplatform.v1.ListSchedulesResponse(); + if (object.schedules) { + if (!Array.isArray(object.schedules)) + throw TypeError(".google.cloud.aiplatform.v1.ListSchedulesResponse.schedules: array expected"); + message.schedules = []; + for (var i = 0; i < object.schedules.length; ++i) { + if (typeof object.schedules[i] !== "object") + throw TypeError(".google.cloud.aiplatform.v1.ListSchedulesResponse.schedules: object expected"); + message.schedules[i] = $root.google.cloud.aiplatform.v1.Schedule.fromObject(object.schedules[i]); + } + } + if (object.nextPageToken != null) + message.nextPageToken = String(object.nextPageToken); + return message; + }; + + /** + * Creates a plain object from a ListSchedulesResponse message. Also converts values to other types if specified. + * @function toObject + * @memberof google.cloud.aiplatform.v1.ListSchedulesResponse + * @static + * @param {google.cloud.aiplatform.v1.ListSchedulesResponse} message ListSchedulesResponse + * @param {$protobuf.IConversionOptions} [options] Conversion options + * @returns {Object.} Plain object + */ + ListSchedulesResponse.toObject = function toObject(message, options) { + if (!options) + options = {}; + var object = {}; + if (options.arrays || options.defaults) + object.schedules = []; + if (options.defaults) + object.nextPageToken = ""; + if (message.schedules && message.schedules.length) { + object.schedules = []; + for (var j = 0; j < message.schedules.length; ++j) + object.schedules[j] = $root.google.cloud.aiplatform.v1.Schedule.toObject(message.schedules[j], options); + } + if (message.nextPageToken != null && message.hasOwnProperty("nextPageToken")) + object.nextPageToken = message.nextPageToken; + return object; + }; + + /** + * Converts this ListSchedulesResponse to JSON. + * @function toJSON + * @memberof google.cloud.aiplatform.v1.ListSchedulesResponse + * @instance + * @returns {Object.} JSON object + */ + ListSchedulesResponse.prototype.toJSON = function toJSON() { + return this.constructor.toObject(this, $protobuf.util.toJSONOptions); + }; + + /** + * Gets the default type url for ListSchedulesResponse + * @function getTypeUrl + * @memberof google.cloud.aiplatform.v1.ListSchedulesResponse + * @static + * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns {string} The default type url + */ + ListSchedulesResponse.getTypeUrl = function getTypeUrl(typeUrlPrefix) { + if (typeUrlPrefix === undefined) { + typeUrlPrefix = "type.googleapis.com"; + } + return typeUrlPrefix + "/google.cloud.aiplatform.v1.ListSchedulesResponse"; + }; + + return ListSchedulesResponse; + })(); + + v1.DeleteScheduleRequest = (function() { + + /** + * Properties of a DeleteScheduleRequest. + * @memberof google.cloud.aiplatform.v1 + * @interface IDeleteScheduleRequest + * @property {string|null} [name] DeleteScheduleRequest name + */ + + /** + * Constructs a new DeleteScheduleRequest. + * @memberof google.cloud.aiplatform.v1 + * @classdesc Represents a DeleteScheduleRequest. + * @implements IDeleteScheduleRequest + * @constructor + * @param {google.cloud.aiplatform.v1.IDeleteScheduleRequest=} [properties] Properties to set + */ + function DeleteScheduleRequest(properties) { + if (properties) + for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) + if (properties[keys[i]] != null) + this[keys[i]] = properties[keys[i]]; + } + + /** + * DeleteScheduleRequest name. + * @member {string} name + * @memberof google.cloud.aiplatform.v1.DeleteScheduleRequest + * @instance + */ + DeleteScheduleRequest.prototype.name = ""; + + /** + * Creates a new DeleteScheduleRequest instance using the specified properties. + * @function create + * @memberof google.cloud.aiplatform.v1.DeleteScheduleRequest + * @static + * @param {google.cloud.aiplatform.v1.IDeleteScheduleRequest=} [properties] Properties to set + * @returns {google.cloud.aiplatform.v1.DeleteScheduleRequest} DeleteScheduleRequest instance + */ + DeleteScheduleRequest.create = function create(properties) { + return new DeleteScheduleRequest(properties); + }; + + /** + * Encodes the specified DeleteScheduleRequest message. Does not implicitly {@link google.cloud.aiplatform.v1.DeleteScheduleRequest.verify|verify} messages. + * @function encode + * @memberof google.cloud.aiplatform.v1.DeleteScheduleRequest + * @static + * @param {google.cloud.aiplatform.v1.IDeleteScheduleRequest} message DeleteScheduleRequest message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + DeleteScheduleRequest.encode = function encode(message, writer) { + if (!writer) + writer = $Writer.create(); + if (message.name != null && Object.hasOwnProperty.call(message, "name")) + writer.uint32(/* id 1, wireType 2 =*/10).string(message.name); + return writer; + }; + + /** + * Encodes the specified DeleteScheduleRequest message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.DeleteScheduleRequest.verify|verify} messages. + * @function encodeDelimited + * @memberof google.cloud.aiplatform.v1.DeleteScheduleRequest + * @static + * @param {google.cloud.aiplatform.v1.IDeleteScheduleRequest} message DeleteScheduleRequest message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + DeleteScheduleRequest.encodeDelimited = function encodeDelimited(message, writer) { + return this.encode(message, writer).ldelim(); + }; + + /** + * Decodes a DeleteScheduleRequest message from the specified reader or buffer. + * @function decode + * @memberof google.cloud.aiplatform.v1.DeleteScheduleRequest + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @param {number} [length] Message length if known beforehand + * @returns {google.cloud.aiplatform.v1.DeleteScheduleRequest} DeleteScheduleRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + DeleteScheduleRequest.decode = function decode(reader, length) { + if (!(reader instanceof $Reader)) + reader = $Reader.create(reader); + var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.aiplatform.v1.DeleteScheduleRequest(); + while (reader.pos < end) { + var tag = reader.uint32(); + switch (tag >>> 3) { + case 1: { + message.name = reader.string(); + break; + } + default: + reader.skipType(tag & 7); + break; + } + } + return message; + }; + + /** + * Decodes a DeleteScheduleRequest message from the specified reader or buffer, length delimited. + * @function decodeDelimited + * @memberof google.cloud.aiplatform.v1.DeleteScheduleRequest + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @returns {google.cloud.aiplatform.v1.DeleteScheduleRequest} DeleteScheduleRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + DeleteScheduleRequest.decodeDelimited = function decodeDelimited(reader) { + if (!(reader instanceof $Reader)) + reader = new $Reader(reader); + return this.decode(reader, reader.uint32()); + }; + + /** + * Verifies a DeleteScheduleRequest message. + * @function verify + * @memberof google.cloud.aiplatform.v1.DeleteScheduleRequest + * @static + * @param {Object.} message Plain object to verify + * @returns {string|null} `null` if valid, otherwise the reason why it is not + */ + DeleteScheduleRequest.verify = function verify(message) { + if (typeof message !== "object" || message === null) + return "object expected"; + if (message.name != null && message.hasOwnProperty("name")) + if (!$util.isString(message.name)) + return "name: string expected"; + return null; + }; + + /** + * Creates a DeleteScheduleRequest message from a plain object. Also converts values to their respective internal types. + * @function fromObject + * @memberof google.cloud.aiplatform.v1.DeleteScheduleRequest + * @static + * @param {Object.} object Plain object + * @returns {google.cloud.aiplatform.v1.DeleteScheduleRequest} DeleteScheduleRequest + */ + DeleteScheduleRequest.fromObject = function fromObject(object) { + if (object instanceof $root.google.cloud.aiplatform.v1.DeleteScheduleRequest) + return object; + var message = new $root.google.cloud.aiplatform.v1.DeleteScheduleRequest(); + if (object.name != null) + message.name = String(object.name); + return message; + }; + + /** + * Creates a plain object from a DeleteScheduleRequest message. Also converts values to other types if specified. + * @function toObject + * @memberof google.cloud.aiplatform.v1.DeleteScheduleRequest + * @static + * @param {google.cloud.aiplatform.v1.DeleteScheduleRequest} message DeleteScheduleRequest + * @param {$protobuf.IConversionOptions} [options] Conversion options + * @returns {Object.} Plain object + */ + DeleteScheduleRequest.toObject = function toObject(message, options) { + if (!options) + options = {}; + var object = {}; + if (options.defaults) + object.name = ""; + if (message.name != null && message.hasOwnProperty("name")) + object.name = message.name; + return object; + }; + + /** + * Converts this DeleteScheduleRequest to JSON. + * @function toJSON + * @memberof google.cloud.aiplatform.v1.DeleteScheduleRequest + * @instance + * @returns {Object.} JSON object + */ + DeleteScheduleRequest.prototype.toJSON = function toJSON() { + return this.constructor.toObject(this, $protobuf.util.toJSONOptions); + }; + + /** + * Gets the default type url for DeleteScheduleRequest + * @function getTypeUrl + * @memberof google.cloud.aiplatform.v1.DeleteScheduleRequest + * @static + * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns {string} The default type url + */ + DeleteScheduleRequest.getTypeUrl = function getTypeUrl(typeUrlPrefix) { + if (typeUrlPrefix === undefined) { + typeUrlPrefix = "type.googleapis.com"; + } + return typeUrlPrefix + "/google.cloud.aiplatform.v1.DeleteScheduleRequest"; + }; + + return DeleteScheduleRequest; + })(); + + v1.PauseScheduleRequest = (function() { + + /** + * Properties of a PauseScheduleRequest. + * @memberof google.cloud.aiplatform.v1 + * @interface IPauseScheduleRequest + * @property {string|null} [name] PauseScheduleRequest name + */ + + /** + * Constructs a new PauseScheduleRequest. + * @memberof google.cloud.aiplatform.v1 + * @classdesc Represents a PauseScheduleRequest. + * @implements IPauseScheduleRequest + * @constructor + * @param {google.cloud.aiplatform.v1.IPauseScheduleRequest=} [properties] Properties to set + */ + function PauseScheduleRequest(properties) { + if (properties) + for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) + if (properties[keys[i]] != null) + this[keys[i]] = properties[keys[i]]; + } + + /** + * PauseScheduleRequest name. + * @member {string} name + * @memberof google.cloud.aiplatform.v1.PauseScheduleRequest + * @instance + */ + PauseScheduleRequest.prototype.name = ""; + + /** + * Creates a new PauseScheduleRequest instance using the specified properties. + * @function create + * @memberof google.cloud.aiplatform.v1.PauseScheduleRequest + * @static + * @param {google.cloud.aiplatform.v1.IPauseScheduleRequest=} [properties] Properties to set + * @returns {google.cloud.aiplatform.v1.PauseScheduleRequest} PauseScheduleRequest instance + */ + PauseScheduleRequest.create = function create(properties) { + return new PauseScheduleRequest(properties); + }; + + /** + * Encodes the specified PauseScheduleRequest message. Does not implicitly {@link google.cloud.aiplatform.v1.PauseScheduleRequest.verify|verify} messages. + * @function encode + * @memberof google.cloud.aiplatform.v1.PauseScheduleRequest + * @static + * @param {google.cloud.aiplatform.v1.IPauseScheduleRequest} message PauseScheduleRequest message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + PauseScheduleRequest.encode = function encode(message, writer) { + if (!writer) + writer = $Writer.create(); + if (message.name != null && Object.hasOwnProperty.call(message, "name")) + writer.uint32(/* id 1, wireType 2 =*/10).string(message.name); + return writer; + }; + + /** + * Encodes the specified PauseScheduleRequest message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.PauseScheduleRequest.verify|verify} messages. + * @function encodeDelimited + * @memberof google.cloud.aiplatform.v1.PauseScheduleRequest + * @static + * @param {google.cloud.aiplatform.v1.IPauseScheduleRequest} message PauseScheduleRequest message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + PauseScheduleRequest.encodeDelimited = function encodeDelimited(message, writer) { + return this.encode(message, writer).ldelim(); + }; + + /** + * Decodes a PauseScheduleRequest message from the specified reader or buffer. + * @function decode + * @memberof google.cloud.aiplatform.v1.PauseScheduleRequest + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @param {number} [length] Message length if known beforehand + * @returns {google.cloud.aiplatform.v1.PauseScheduleRequest} PauseScheduleRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + PauseScheduleRequest.decode = function decode(reader, length) { + if (!(reader instanceof $Reader)) + reader = $Reader.create(reader); + var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.aiplatform.v1.PauseScheduleRequest(); + while (reader.pos < end) { + var tag = reader.uint32(); + switch (tag >>> 3) { + case 1: { + message.name = reader.string(); + break; + } + default: + reader.skipType(tag & 7); + break; + } + } + return message; + }; + + /** + * Decodes a PauseScheduleRequest message from the specified reader or buffer, length delimited. + * @function decodeDelimited + * @memberof google.cloud.aiplatform.v1.PauseScheduleRequest + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @returns {google.cloud.aiplatform.v1.PauseScheduleRequest} PauseScheduleRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + PauseScheduleRequest.decodeDelimited = function decodeDelimited(reader) { + if (!(reader instanceof $Reader)) + reader = new $Reader(reader); + return this.decode(reader, reader.uint32()); + }; + + /** + * Verifies a PauseScheduleRequest message. + * @function verify + * @memberof google.cloud.aiplatform.v1.PauseScheduleRequest + * @static + * @param {Object.} message Plain object to verify + * @returns {string|null} `null` if valid, otherwise the reason why it is not + */ + PauseScheduleRequest.verify = function verify(message) { + if (typeof message !== "object" || message === null) + return "object expected"; + if (message.name != null && message.hasOwnProperty("name")) + if (!$util.isString(message.name)) + return "name: string expected"; + return null; + }; + + /** + * Creates a PauseScheduleRequest message from a plain object. Also converts values to their respective internal types. + * @function fromObject + * @memberof google.cloud.aiplatform.v1.PauseScheduleRequest + * @static + * @param {Object.} object Plain object + * @returns {google.cloud.aiplatform.v1.PauseScheduleRequest} PauseScheduleRequest + */ + PauseScheduleRequest.fromObject = function fromObject(object) { + if (object instanceof $root.google.cloud.aiplatform.v1.PauseScheduleRequest) + return object; + var message = new $root.google.cloud.aiplatform.v1.PauseScheduleRequest(); + if (object.name != null) + message.name = String(object.name); + return message; + }; + + /** + * Creates a plain object from a PauseScheduleRequest message. Also converts values to other types if specified. + * @function toObject + * @memberof google.cloud.aiplatform.v1.PauseScheduleRequest + * @static + * @param {google.cloud.aiplatform.v1.PauseScheduleRequest} message PauseScheduleRequest + * @param {$protobuf.IConversionOptions} [options] Conversion options + * @returns {Object.} Plain object + */ + PauseScheduleRequest.toObject = function toObject(message, options) { + if (!options) + options = {}; + var object = {}; + if (options.defaults) + object.name = ""; + if (message.name != null && message.hasOwnProperty("name")) + object.name = message.name; + return object; + }; + + /** + * Converts this PauseScheduleRequest to JSON. + * @function toJSON + * @memberof google.cloud.aiplatform.v1.PauseScheduleRequest + * @instance + * @returns {Object.} JSON object + */ + PauseScheduleRequest.prototype.toJSON = function toJSON() { + return this.constructor.toObject(this, $protobuf.util.toJSONOptions); + }; + + /** + * Gets the default type url for PauseScheduleRequest + * @function getTypeUrl + * @memberof google.cloud.aiplatform.v1.PauseScheduleRequest + * @static + * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns {string} The default type url + */ + PauseScheduleRequest.getTypeUrl = function getTypeUrl(typeUrlPrefix) { + if (typeUrlPrefix === undefined) { + typeUrlPrefix = "type.googleapis.com"; + } + return typeUrlPrefix + "/google.cloud.aiplatform.v1.PauseScheduleRequest"; + }; + + return PauseScheduleRequest; + })(); + + v1.ResumeScheduleRequest = (function() { + + /** + * Properties of a ResumeScheduleRequest. + * @memberof google.cloud.aiplatform.v1 + * @interface IResumeScheduleRequest + * @property {string|null} [name] ResumeScheduleRequest name + * @property {boolean|null} [catchUp] ResumeScheduleRequest catchUp + */ + + /** + * Constructs a new ResumeScheduleRequest. + * @memberof google.cloud.aiplatform.v1 + * @classdesc Represents a ResumeScheduleRequest. + * @implements IResumeScheduleRequest + * @constructor + * @param {google.cloud.aiplatform.v1.IResumeScheduleRequest=} [properties] Properties to set + */ + function ResumeScheduleRequest(properties) { + if (properties) + for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) + if (properties[keys[i]] != null) + this[keys[i]] = properties[keys[i]]; + } + + /** + * ResumeScheduleRequest name. + * @member {string} name + * @memberof google.cloud.aiplatform.v1.ResumeScheduleRequest + * @instance + */ + ResumeScheduleRequest.prototype.name = ""; + + /** + * ResumeScheduleRequest catchUp. + * @member {boolean} catchUp + * @memberof google.cloud.aiplatform.v1.ResumeScheduleRequest + * @instance + */ + ResumeScheduleRequest.prototype.catchUp = false; + + /** + * Creates a new ResumeScheduleRequest instance using the specified properties. + * @function create + * @memberof google.cloud.aiplatform.v1.ResumeScheduleRequest + * @static + * @param {google.cloud.aiplatform.v1.IResumeScheduleRequest=} [properties] Properties to set + * @returns {google.cloud.aiplatform.v1.ResumeScheduleRequest} ResumeScheduleRequest instance + */ + ResumeScheduleRequest.create = function create(properties) { + return new ResumeScheduleRequest(properties); + }; + + /** + * Encodes the specified ResumeScheduleRequest message. Does not implicitly {@link google.cloud.aiplatform.v1.ResumeScheduleRequest.verify|verify} messages. + * @function encode + * @memberof google.cloud.aiplatform.v1.ResumeScheduleRequest + * @static + * @param {google.cloud.aiplatform.v1.IResumeScheduleRequest} message ResumeScheduleRequest message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + ResumeScheduleRequest.encode = function encode(message, writer) { + if (!writer) + writer = $Writer.create(); + if (message.name != null && Object.hasOwnProperty.call(message, "name")) + writer.uint32(/* id 1, wireType 2 =*/10).string(message.name); + if (message.catchUp != null && Object.hasOwnProperty.call(message, "catchUp")) + writer.uint32(/* id 2, wireType 0 =*/16).bool(message.catchUp); + return writer; + }; + + /** + * Encodes the specified ResumeScheduleRequest message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.ResumeScheduleRequest.verify|verify} messages. + * @function encodeDelimited + * @memberof google.cloud.aiplatform.v1.ResumeScheduleRequest + * @static + * @param {google.cloud.aiplatform.v1.IResumeScheduleRequest} message ResumeScheduleRequest message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + ResumeScheduleRequest.encodeDelimited = function encodeDelimited(message, writer) { + return this.encode(message, writer).ldelim(); + }; + + /** + * Decodes a ResumeScheduleRequest message from the specified reader or buffer. + * @function decode + * @memberof google.cloud.aiplatform.v1.ResumeScheduleRequest + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @param {number} [length] Message length if known beforehand + * @returns {google.cloud.aiplatform.v1.ResumeScheduleRequest} ResumeScheduleRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + ResumeScheduleRequest.decode = function decode(reader, length) { + if (!(reader instanceof $Reader)) + reader = $Reader.create(reader); + var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.aiplatform.v1.ResumeScheduleRequest(); + while (reader.pos < end) { + var tag = reader.uint32(); + switch (tag >>> 3) { + case 1: { + message.name = reader.string(); + break; + } + case 2: { + message.catchUp = reader.bool(); + break; + } + default: + reader.skipType(tag & 7); + break; + } + } + return message; + }; + + /** + * Decodes a ResumeScheduleRequest message from the specified reader or buffer, length delimited. + * @function decodeDelimited + * @memberof google.cloud.aiplatform.v1.ResumeScheduleRequest + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @returns {google.cloud.aiplatform.v1.ResumeScheduleRequest} ResumeScheduleRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + ResumeScheduleRequest.decodeDelimited = function decodeDelimited(reader) { + if (!(reader instanceof $Reader)) + reader = new $Reader(reader); + return this.decode(reader, reader.uint32()); + }; + + /** + * Verifies a ResumeScheduleRequest message. + * @function verify + * @memberof google.cloud.aiplatform.v1.ResumeScheduleRequest + * @static + * @param {Object.} message Plain object to verify + * @returns {string|null} `null` if valid, otherwise the reason why it is not + */ + ResumeScheduleRequest.verify = function verify(message) { + if (typeof message !== "object" || message === null) + return "object expected"; + if (message.name != null && message.hasOwnProperty("name")) + if (!$util.isString(message.name)) + return "name: string expected"; + if (message.catchUp != null && message.hasOwnProperty("catchUp")) + if (typeof message.catchUp !== "boolean") + return "catchUp: boolean expected"; + return null; + }; + + /** + * Creates a ResumeScheduleRequest message from a plain object. Also converts values to their respective internal types. + * @function fromObject + * @memberof google.cloud.aiplatform.v1.ResumeScheduleRequest + * @static + * @param {Object.} object Plain object + * @returns {google.cloud.aiplatform.v1.ResumeScheduleRequest} ResumeScheduleRequest + */ + ResumeScheduleRequest.fromObject = function fromObject(object) { + if (object instanceof $root.google.cloud.aiplatform.v1.ResumeScheduleRequest) + return object; + var message = new $root.google.cloud.aiplatform.v1.ResumeScheduleRequest(); + if (object.name != null) + message.name = String(object.name); + if (object.catchUp != null) + message.catchUp = Boolean(object.catchUp); + return message; + }; + + /** + * Creates a plain object from a ResumeScheduleRequest message. Also converts values to other types if specified. + * @function toObject + * @memberof google.cloud.aiplatform.v1.ResumeScheduleRequest + * @static + * @param {google.cloud.aiplatform.v1.ResumeScheduleRequest} message ResumeScheduleRequest + * @param {$protobuf.IConversionOptions} [options] Conversion options + * @returns {Object.} Plain object + */ + ResumeScheduleRequest.toObject = function toObject(message, options) { + if (!options) + options = {}; + var object = {}; + if (options.defaults) { + object.name = ""; + object.catchUp = false; + } + if (message.name != null && message.hasOwnProperty("name")) + object.name = message.name; + if (message.catchUp != null && message.hasOwnProperty("catchUp")) + object.catchUp = message.catchUp; + return object; + }; + + /** + * Converts this ResumeScheduleRequest to JSON. + * @function toJSON + * @memberof google.cloud.aiplatform.v1.ResumeScheduleRequest + * @instance + * @returns {Object.} JSON object + */ + ResumeScheduleRequest.prototype.toJSON = function toJSON() { + return this.constructor.toObject(this, $protobuf.util.toJSONOptions); + }; + + /** + * Gets the default type url for ResumeScheduleRequest + * @function getTypeUrl + * @memberof google.cloud.aiplatform.v1.ResumeScheduleRequest + * @static + * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns {string} The default type url + */ + ResumeScheduleRequest.getTypeUrl = function getTypeUrl(typeUrlPrefix) { + if (typeUrlPrefix === undefined) { + typeUrlPrefix = "type.googleapis.com"; + } + return typeUrlPrefix + "/google.cloud.aiplatform.v1.ResumeScheduleRequest"; + }; + + return ResumeScheduleRequest; + })(); + + v1.UpdateScheduleRequest = (function() { + + /** + * Properties of an UpdateScheduleRequest. + * @memberof google.cloud.aiplatform.v1 + * @interface IUpdateScheduleRequest + * @property {google.cloud.aiplatform.v1.ISchedule|null} [schedule] UpdateScheduleRequest schedule + * @property {google.protobuf.IFieldMask|null} [updateMask] UpdateScheduleRequest updateMask + */ + + /** + * Constructs a new UpdateScheduleRequest. + * @memberof google.cloud.aiplatform.v1 + * @classdesc Represents an UpdateScheduleRequest. + * @implements IUpdateScheduleRequest + * @constructor + * @param {google.cloud.aiplatform.v1.IUpdateScheduleRequest=} [properties] Properties to set + */ + function UpdateScheduleRequest(properties) { + if (properties) + for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) + if (properties[keys[i]] != null) + this[keys[i]] = properties[keys[i]]; + } + + /** + * UpdateScheduleRequest schedule. + * @member {google.cloud.aiplatform.v1.ISchedule|null|undefined} schedule + * @memberof google.cloud.aiplatform.v1.UpdateScheduleRequest + * @instance + */ + UpdateScheduleRequest.prototype.schedule = null; + + /** + * UpdateScheduleRequest updateMask. + * @member {google.protobuf.IFieldMask|null|undefined} updateMask + * @memberof google.cloud.aiplatform.v1.UpdateScheduleRequest + * @instance + */ + UpdateScheduleRequest.prototype.updateMask = null; + + /** + * Creates a new UpdateScheduleRequest instance using the specified properties. + * @function create + * @memberof google.cloud.aiplatform.v1.UpdateScheduleRequest + * @static + * @param {google.cloud.aiplatform.v1.IUpdateScheduleRequest=} [properties] Properties to set + * @returns {google.cloud.aiplatform.v1.UpdateScheduleRequest} UpdateScheduleRequest instance + */ + UpdateScheduleRequest.create = function create(properties) { + return new UpdateScheduleRequest(properties); + }; + + /** + * Encodes the specified UpdateScheduleRequest message. Does not implicitly {@link google.cloud.aiplatform.v1.UpdateScheduleRequest.verify|verify} messages. + * @function encode + * @memberof google.cloud.aiplatform.v1.UpdateScheduleRequest + * @static + * @param {google.cloud.aiplatform.v1.IUpdateScheduleRequest} message UpdateScheduleRequest message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + UpdateScheduleRequest.encode = function encode(message, writer) { + if (!writer) + writer = $Writer.create(); + if (message.schedule != null && Object.hasOwnProperty.call(message, "schedule")) + $root.google.cloud.aiplatform.v1.Schedule.encode(message.schedule, writer.uint32(/* id 1, wireType 2 =*/10).fork()).ldelim(); + if (message.updateMask != null && Object.hasOwnProperty.call(message, "updateMask")) + $root.google.protobuf.FieldMask.encode(message.updateMask, writer.uint32(/* id 2, wireType 2 =*/18).fork()).ldelim(); + return writer; + }; + + /** + * Encodes the specified UpdateScheduleRequest message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.UpdateScheduleRequest.verify|verify} messages. + * @function encodeDelimited + * @memberof google.cloud.aiplatform.v1.UpdateScheduleRequest + * @static + * @param {google.cloud.aiplatform.v1.IUpdateScheduleRequest} message UpdateScheduleRequest message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + UpdateScheduleRequest.encodeDelimited = function encodeDelimited(message, writer) { + return this.encode(message, writer).ldelim(); + }; + + /** + * Decodes an UpdateScheduleRequest message from the specified reader or buffer. + * @function decode + * @memberof google.cloud.aiplatform.v1.UpdateScheduleRequest + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @param {number} [length] Message length if known beforehand + * @returns {google.cloud.aiplatform.v1.UpdateScheduleRequest} UpdateScheduleRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + UpdateScheduleRequest.decode = function decode(reader, length) { + if (!(reader instanceof $Reader)) + reader = $Reader.create(reader); + var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.aiplatform.v1.UpdateScheduleRequest(); + while (reader.pos < end) { + var tag = reader.uint32(); + switch (tag >>> 3) { + case 1: { + message.schedule = $root.google.cloud.aiplatform.v1.Schedule.decode(reader, reader.uint32()); + break; + } + case 2: { + message.updateMask = $root.google.protobuf.FieldMask.decode(reader, reader.uint32()); + break; + } + default: + reader.skipType(tag & 7); + break; + } + } + return message; + }; + + /** + * Decodes an UpdateScheduleRequest message from the specified reader or buffer, length delimited. + * @function decodeDelimited + * @memberof google.cloud.aiplatform.v1.UpdateScheduleRequest + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @returns {google.cloud.aiplatform.v1.UpdateScheduleRequest} UpdateScheduleRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + UpdateScheduleRequest.decodeDelimited = function decodeDelimited(reader) { + if (!(reader instanceof $Reader)) + reader = new $Reader(reader); + return this.decode(reader, reader.uint32()); + }; + + /** + * Verifies an UpdateScheduleRequest message. + * @function verify + * @memberof google.cloud.aiplatform.v1.UpdateScheduleRequest + * @static + * @param {Object.} message Plain object to verify + * @returns {string|null} `null` if valid, otherwise the reason why it is not + */ + UpdateScheduleRequest.verify = function verify(message) { + if (typeof message !== "object" || message === null) + return "object expected"; + if (message.schedule != null && message.hasOwnProperty("schedule")) { + var error = $root.google.cloud.aiplatform.v1.Schedule.verify(message.schedule); + if (error) + return "schedule." + error; + } + if (message.updateMask != null && message.hasOwnProperty("updateMask")) { + var error = $root.google.protobuf.FieldMask.verify(message.updateMask); + if (error) + return "updateMask." + error; + } + return null; + }; + + /** + * Creates an UpdateScheduleRequest message from a plain object. Also converts values to their respective internal types. + * @function fromObject + * @memberof google.cloud.aiplatform.v1.UpdateScheduleRequest + * @static + * @param {Object.} object Plain object + * @returns {google.cloud.aiplatform.v1.UpdateScheduleRequest} UpdateScheduleRequest + */ + UpdateScheduleRequest.fromObject = function fromObject(object) { + if (object instanceof $root.google.cloud.aiplatform.v1.UpdateScheduleRequest) + return object; + var message = new $root.google.cloud.aiplatform.v1.UpdateScheduleRequest(); + if (object.schedule != null) { + if (typeof object.schedule !== "object") + throw TypeError(".google.cloud.aiplatform.v1.UpdateScheduleRequest.schedule: object expected"); + message.schedule = $root.google.cloud.aiplatform.v1.Schedule.fromObject(object.schedule); + } + if (object.updateMask != null) { + if (typeof object.updateMask !== "object") + throw TypeError(".google.cloud.aiplatform.v1.UpdateScheduleRequest.updateMask: object expected"); + message.updateMask = $root.google.protobuf.FieldMask.fromObject(object.updateMask); + } + return message; + }; + + /** + * Creates a plain object from an UpdateScheduleRequest message. Also converts values to other types if specified. + * @function toObject + * @memberof google.cloud.aiplatform.v1.UpdateScheduleRequest + * @static + * @param {google.cloud.aiplatform.v1.UpdateScheduleRequest} message UpdateScheduleRequest + * @param {$protobuf.IConversionOptions} [options] Conversion options + * @returns {Object.} Plain object + */ + UpdateScheduleRequest.toObject = function toObject(message, options) { + if (!options) + options = {}; + var object = {}; + if (options.defaults) { + object.schedule = null; + object.updateMask = null; + } + if (message.schedule != null && message.hasOwnProperty("schedule")) + object.schedule = $root.google.cloud.aiplatform.v1.Schedule.toObject(message.schedule, options); + if (message.updateMask != null && message.hasOwnProperty("updateMask")) + object.updateMask = $root.google.protobuf.FieldMask.toObject(message.updateMask, options); + return object; + }; + + /** + * Converts this UpdateScheduleRequest to JSON. + * @function toJSON + * @memberof google.cloud.aiplatform.v1.UpdateScheduleRequest + * @instance + * @returns {Object.} JSON object + */ + UpdateScheduleRequest.prototype.toJSON = function toJSON() { + return this.constructor.toObject(this, $protobuf.util.toJSONOptions); + }; + + /** + * Gets the default type url for UpdateScheduleRequest + * @function getTypeUrl + * @memberof google.cloud.aiplatform.v1.UpdateScheduleRequest + * @static + * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns {string} The default type url + */ + UpdateScheduleRequest.getTypeUrl = function getTypeUrl(typeUrlPrefix) { + if (typeUrlPrefix === undefined) { + typeUrlPrefix = "type.googleapis.com"; + } + return typeUrlPrefix + "/google.cloud.aiplatform.v1.UpdateScheduleRequest"; + }; + + return UpdateScheduleRequest; + })(); + v1.schema = (function() { /** @@ -248659,6 +253306,951 @@ return StringArray; })(); + v1beta1.Tensor = (function() { + + /** + * Properties of a Tensor. + * @memberof google.cloud.aiplatform.v1beta1 + * @interface ITensor + * @property {google.cloud.aiplatform.v1beta1.Tensor.DataType|null} [dtype] Tensor dtype + * @property {Array.|null} [shape] Tensor shape + * @property {Array.|null} [boolVal] Tensor boolVal + * @property {Array.|null} [stringVal] Tensor stringVal + * @property {Array.|null} [bytesVal] Tensor bytesVal + * @property {Array.|null} [floatVal] Tensor floatVal + * @property {Array.|null} [doubleVal] Tensor doubleVal + * @property {Array.|null} [intVal] Tensor intVal + * @property {Array.|null} [int64Val] Tensor int64Val + * @property {Array.|null} [uintVal] Tensor uintVal + * @property {Array.|null} [uint64Val] Tensor uint64Val + * @property {Array.|null} [listVal] Tensor listVal + * @property {Object.|null} [structVal] Tensor structVal + * @property {Uint8Array|null} [tensorVal] Tensor tensorVal + */ + + /** + * Constructs a new Tensor. + * @memberof google.cloud.aiplatform.v1beta1 + * @classdesc Represents a Tensor. + * @implements ITensor + * @constructor + * @param {google.cloud.aiplatform.v1beta1.ITensor=} [properties] Properties to set + */ + function Tensor(properties) { + this.shape = []; + this.boolVal = []; + this.stringVal = []; + this.bytesVal = []; + this.floatVal = []; + this.doubleVal = []; + this.intVal = []; + this.int64Val = []; + this.uintVal = []; + this.uint64Val = []; + this.listVal = []; + this.structVal = {}; + if (properties) + for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) + if (properties[keys[i]] != null) + this[keys[i]] = properties[keys[i]]; + } + + /** + * Tensor dtype. + * @member {google.cloud.aiplatform.v1beta1.Tensor.DataType} dtype + * @memberof google.cloud.aiplatform.v1beta1.Tensor + * @instance + */ + Tensor.prototype.dtype = 0; + + /** + * Tensor shape. + * @member {Array.} shape + * @memberof google.cloud.aiplatform.v1beta1.Tensor + * @instance + */ + Tensor.prototype.shape = $util.emptyArray; + + /** + * Tensor boolVal. + * @member {Array.} boolVal + * @memberof google.cloud.aiplatform.v1beta1.Tensor + * @instance + */ + Tensor.prototype.boolVal = $util.emptyArray; + + /** + * Tensor stringVal. + * @member {Array.} stringVal + * @memberof google.cloud.aiplatform.v1beta1.Tensor + * @instance + */ + Tensor.prototype.stringVal = $util.emptyArray; + + /** + * Tensor bytesVal. + * @member {Array.} bytesVal + * @memberof google.cloud.aiplatform.v1beta1.Tensor + * @instance + */ + Tensor.prototype.bytesVal = $util.emptyArray; + + /** + * Tensor floatVal. + * @member {Array.} floatVal + * @memberof google.cloud.aiplatform.v1beta1.Tensor + * @instance + */ + Tensor.prototype.floatVal = $util.emptyArray; + + /** + * Tensor doubleVal. + * @member {Array.} doubleVal + * @memberof google.cloud.aiplatform.v1beta1.Tensor + * @instance + */ + Tensor.prototype.doubleVal = $util.emptyArray; + + /** + * Tensor intVal. + * @member {Array.} intVal + * @memberof google.cloud.aiplatform.v1beta1.Tensor + * @instance + */ + Tensor.prototype.intVal = $util.emptyArray; + + /** + * Tensor int64Val. + * @member {Array.} int64Val + * @memberof google.cloud.aiplatform.v1beta1.Tensor + * @instance + */ + Tensor.prototype.int64Val = $util.emptyArray; + + /** + * Tensor uintVal. + * @member {Array.} uintVal + * @memberof google.cloud.aiplatform.v1beta1.Tensor + * @instance + */ + Tensor.prototype.uintVal = $util.emptyArray; + + /** + * Tensor uint64Val. + * @member {Array.} uint64Val + * @memberof google.cloud.aiplatform.v1beta1.Tensor + * @instance + */ + Tensor.prototype.uint64Val = $util.emptyArray; + + /** + * Tensor listVal. + * @member {Array.} listVal + * @memberof google.cloud.aiplatform.v1beta1.Tensor + * @instance + */ + Tensor.prototype.listVal = $util.emptyArray; + + /** + * Tensor structVal. + * @member {Object.} structVal + * @memberof google.cloud.aiplatform.v1beta1.Tensor + * @instance + */ + Tensor.prototype.structVal = $util.emptyObject; + + /** + * Tensor tensorVal. + * @member {Uint8Array} tensorVal + * @memberof google.cloud.aiplatform.v1beta1.Tensor + * @instance + */ + Tensor.prototype.tensorVal = $util.newBuffer([]); + + /** + * Creates a new Tensor instance using the specified properties. + * @function create + * @memberof google.cloud.aiplatform.v1beta1.Tensor + * @static + * @param {google.cloud.aiplatform.v1beta1.ITensor=} [properties] Properties to set + * @returns {google.cloud.aiplatform.v1beta1.Tensor} Tensor instance + */ + Tensor.create = function create(properties) { + return new Tensor(properties); + }; + + /** + * Encodes the specified Tensor message. Does not implicitly {@link google.cloud.aiplatform.v1beta1.Tensor.verify|verify} messages. + * @function encode + * @memberof google.cloud.aiplatform.v1beta1.Tensor + * @static + * @param {google.cloud.aiplatform.v1beta1.ITensor} message Tensor message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + Tensor.encode = function encode(message, writer) { + if (!writer) + writer = $Writer.create(); + if (message.dtype != null && Object.hasOwnProperty.call(message, "dtype")) + writer.uint32(/* id 1, wireType 0 =*/8).int32(message.dtype); + if (message.shape != null && message.shape.length) { + writer.uint32(/* id 2, wireType 2 =*/18).fork(); + for (var i = 0; i < message.shape.length; ++i) + writer.int64(message.shape[i]); + writer.ldelim(); + } + if (message.boolVal != null && message.boolVal.length) { + writer.uint32(/* id 3, wireType 2 =*/26).fork(); + for (var i = 0; i < message.boolVal.length; ++i) + writer.bool(message.boolVal[i]); + writer.ldelim(); + } + if (message.floatVal != null && message.floatVal.length) { + writer.uint32(/* id 5, wireType 2 =*/42).fork(); + for (var i = 0; i < message.floatVal.length; ++i) + writer.float(message.floatVal[i]); + writer.ldelim(); + } + if (message.doubleVal != null && message.doubleVal.length) { + writer.uint32(/* id 6, wireType 2 =*/50).fork(); + for (var i = 0; i < message.doubleVal.length; ++i) + writer.double(message.doubleVal[i]); + writer.ldelim(); + } + if (message.intVal != null && message.intVal.length) { + writer.uint32(/* id 7, wireType 2 =*/58).fork(); + for (var i = 0; i < message.intVal.length; ++i) + writer.int32(message.intVal[i]); + writer.ldelim(); + } + if (message.int64Val != null && message.int64Val.length) { + writer.uint32(/* id 8, wireType 2 =*/66).fork(); + for (var i = 0; i < message.int64Val.length; ++i) + writer.int64(message.int64Val[i]); + writer.ldelim(); + } + if (message.uintVal != null && message.uintVal.length) { + writer.uint32(/* id 9, wireType 2 =*/74).fork(); + for (var i = 0; i < message.uintVal.length; ++i) + writer.uint32(message.uintVal[i]); + writer.ldelim(); + } + if (message.uint64Val != null && message.uint64Val.length) { + writer.uint32(/* id 10, wireType 2 =*/82).fork(); + for (var i = 0; i < message.uint64Val.length; ++i) + writer.uint64(message.uint64Val[i]); + writer.ldelim(); + } + if (message.listVal != null && message.listVal.length) + for (var i = 0; i < message.listVal.length; ++i) + $root.google.cloud.aiplatform.v1beta1.Tensor.encode(message.listVal[i], writer.uint32(/* id 11, wireType 2 =*/90).fork()).ldelim(); + if (message.structVal != null && Object.hasOwnProperty.call(message, "structVal")) + for (var keys = Object.keys(message.structVal), i = 0; i < keys.length; ++i) { + writer.uint32(/* id 12, wireType 2 =*/98).fork().uint32(/* id 1, wireType 2 =*/10).string(keys[i]); + $root.google.cloud.aiplatform.v1beta1.Tensor.encode(message.structVal[keys[i]], writer.uint32(/* id 2, wireType 2 =*/18).fork()).ldelim().ldelim(); + } + if (message.tensorVal != null && Object.hasOwnProperty.call(message, "tensorVal")) + writer.uint32(/* id 13, wireType 2 =*/106).bytes(message.tensorVal); + if (message.stringVal != null && message.stringVal.length) + for (var i = 0; i < message.stringVal.length; ++i) + writer.uint32(/* id 14, wireType 2 =*/114).string(message.stringVal[i]); + if (message.bytesVal != null && message.bytesVal.length) + for (var i = 0; i < message.bytesVal.length; ++i) + writer.uint32(/* id 15, wireType 2 =*/122).bytes(message.bytesVal[i]); + return writer; + }; + + /** + * Encodes the specified Tensor message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1beta1.Tensor.verify|verify} messages. + * @function encodeDelimited + * @memberof google.cloud.aiplatform.v1beta1.Tensor + * @static + * @param {google.cloud.aiplatform.v1beta1.ITensor} message Tensor message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + Tensor.encodeDelimited = function encodeDelimited(message, writer) { + return this.encode(message, writer).ldelim(); + }; + + /** + * Decodes a Tensor message from the specified reader or buffer. + * @function decode + * @memberof google.cloud.aiplatform.v1beta1.Tensor + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @param {number} [length] Message length if known beforehand + * @returns {google.cloud.aiplatform.v1beta1.Tensor} Tensor + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + Tensor.decode = function decode(reader, length) { + if (!(reader instanceof $Reader)) + reader = $Reader.create(reader); + var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.aiplatform.v1beta1.Tensor(), key, value; + while (reader.pos < end) { + var tag = reader.uint32(); + switch (tag >>> 3) { + case 1: { + message.dtype = reader.int32(); + break; + } + case 2: { + if (!(message.shape && message.shape.length)) + message.shape = []; + if ((tag & 7) === 2) { + var end2 = reader.uint32() + reader.pos; + while (reader.pos < end2) + message.shape.push(reader.int64()); + } else + message.shape.push(reader.int64()); + break; + } + case 3: { + if (!(message.boolVal && message.boolVal.length)) + message.boolVal = []; + if ((tag & 7) === 2) { + var end2 = reader.uint32() + reader.pos; + while (reader.pos < end2) + message.boolVal.push(reader.bool()); + } else + message.boolVal.push(reader.bool()); + break; + } + case 14: { + if (!(message.stringVal && message.stringVal.length)) + message.stringVal = []; + message.stringVal.push(reader.string()); + break; + } + case 15: { + if (!(message.bytesVal && message.bytesVal.length)) + message.bytesVal = []; + message.bytesVal.push(reader.bytes()); + break; + } + case 5: { + if (!(message.floatVal && message.floatVal.length)) + message.floatVal = []; + if ((tag & 7) === 2) { + var end2 = reader.uint32() + reader.pos; + while (reader.pos < end2) + message.floatVal.push(reader.float()); + } else + message.floatVal.push(reader.float()); + break; + } + case 6: { + if (!(message.doubleVal && message.doubleVal.length)) + message.doubleVal = []; + if ((tag & 7) === 2) { + var end2 = reader.uint32() + reader.pos; + while (reader.pos < end2) + message.doubleVal.push(reader.double()); + } else + message.doubleVal.push(reader.double()); + break; + } + case 7: { + if (!(message.intVal && message.intVal.length)) + message.intVal = []; + if ((tag & 7) === 2) { + var end2 = reader.uint32() + reader.pos; + while (reader.pos < end2) + message.intVal.push(reader.int32()); + } else + message.intVal.push(reader.int32()); + break; + } + case 8: { + if (!(message.int64Val && message.int64Val.length)) + message.int64Val = []; + if ((tag & 7) === 2) { + var end2 = reader.uint32() + reader.pos; + while (reader.pos < end2) + message.int64Val.push(reader.int64()); + } else + message.int64Val.push(reader.int64()); + break; + } + case 9: { + if (!(message.uintVal && message.uintVal.length)) + message.uintVal = []; + if ((tag & 7) === 2) { + var end2 = reader.uint32() + reader.pos; + while (reader.pos < end2) + message.uintVal.push(reader.uint32()); + } else + message.uintVal.push(reader.uint32()); + break; + } + case 10: { + if (!(message.uint64Val && message.uint64Val.length)) + message.uint64Val = []; + if ((tag & 7) === 2) { + var end2 = reader.uint32() + reader.pos; + while (reader.pos < end2) + message.uint64Val.push(reader.uint64()); + } else + message.uint64Val.push(reader.uint64()); + break; + } + case 11: { + if (!(message.listVal && message.listVal.length)) + message.listVal = []; + message.listVal.push($root.google.cloud.aiplatform.v1beta1.Tensor.decode(reader, reader.uint32())); + break; + } + case 12: { + if (message.structVal === $util.emptyObject) + message.structVal = {}; + var end2 = reader.uint32() + reader.pos; + key = ""; + value = null; + while (reader.pos < end2) { + var tag2 = reader.uint32(); + switch (tag2 >>> 3) { + case 1: + key = reader.string(); + break; + case 2: + value = $root.google.cloud.aiplatform.v1beta1.Tensor.decode(reader, reader.uint32()); + break; + default: + reader.skipType(tag2 & 7); + break; + } + } + message.structVal[key] = value; + break; + } + case 13: { + message.tensorVal = reader.bytes(); + break; + } + default: + reader.skipType(tag & 7); + break; + } + } + return message; + }; + + /** + * Decodes a Tensor message from the specified reader or buffer, length delimited. + * @function decodeDelimited + * @memberof google.cloud.aiplatform.v1beta1.Tensor + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @returns {google.cloud.aiplatform.v1beta1.Tensor} Tensor + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + Tensor.decodeDelimited = function decodeDelimited(reader) { + if (!(reader instanceof $Reader)) + reader = new $Reader(reader); + return this.decode(reader, reader.uint32()); + }; + + /** + * Verifies a Tensor message. + * @function verify + * @memberof google.cloud.aiplatform.v1beta1.Tensor + * @static + * @param {Object.} message Plain object to verify + * @returns {string|null} `null` if valid, otherwise the reason why it is not + */ + Tensor.verify = function verify(message) { + if (typeof message !== "object" || message === null) + return "object expected"; + if (message.dtype != null && message.hasOwnProperty("dtype")) + switch (message.dtype) { + default: + return "dtype: enum value expected"; + case 0: + case 1: + case 2: + case 3: + case 4: + case 5: + case 6: + case 7: + case 8: + case 9: + case 10: + case 11: + case 12: + break; + } + if (message.shape != null && message.hasOwnProperty("shape")) { + if (!Array.isArray(message.shape)) + return "shape: array expected"; + for (var i = 0; i < message.shape.length; ++i) + if (!$util.isInteger(message.shape[i]) && !(message.shape[i] && $util.isInteger(message.shape[i].low) && $util.isInteger(message.shape[i].high))) + return "shape: integer|Long[] expected"; + } + if (message.boolVal != null && message.hasOwnProperty("boolVal")) { + if (!Array.isArray(message.boolVal)) + return "boolVal: array expected"; + for (var i = 0; i < message.boolVal.length; ++i) + if (typeof message.boolVal[i] !== "boolean") + return "boolVal: boolean[] expected"; + } + if (message.stringVal != null && message.hasOwnProperty("stringVal")) { + if (!Array.isArray(message.stringVal)) + return "stringVal: array expected"; + for (var i = 0; i < message.stringVal.length; ++i) + if (!$util.isString(message.stringVal[i])) + return "stringVal: string[] expected"; + } + if (message.bytesVal != null && message.hasOwnProperty("bytesVal")) { + if (!Array.isArray(message.bytesVal)) + return "bytesVal: array expected"; + for (var i = 0; i < message.bytesVal.length; ++i) + if (!(message.bytesVal[i] && typeof message.bytesVal[i].length === "number" || $util.isString(message.bytesVal[i]))) + return "bytesVal: buffer[] expected"; + } + if (message.floatVal != null && message.hasOwnProperty("floatVal")) { + if (!Array.isArray(message.floatVal)) + return "floatVal: array expected"; + for (var i = 0; i < message.floatVal.length; ++i) + if (typeof message.floatVal[i] !== "number") + return "floatVal: number[] expected"; + } + if (message.doubleVal != null && message.hasOwnProperty("doubleVal")) { + if (!Array.isArray(message.doubleVal)) + return "doubleVal: array expected"; + for (var i = 0; i < message.doubleVal.length; ++i) + if (typeof message.doubleVal[i] !== "number") + return "doubleVal: number[] expected"; + } + if (message.intVal != null && message.hasOwnProperty("intVal")) { + if (!Array.isArray(message.intVal)) + return "intVal: array expected"; + for (var i = 0; i < message.intVal.length; ++i) + if (!$util.isInteger(message.intVal[i])) + return "intVal: integer[] expected"; + } + if (message.int64Val != null && message.hasOwnProperty("int64Val")) { + if (!Array.isArray(message.int64Val)) + return "int64Val: array expected"; + for (var i = 0; i < message.int64Val.length; ++i) + if (!$util.isInteger(message.int64Val[i]) && !(message.int64Val[i] && $util.isInteger(message.int64Val[i].low) && $util.isInteger(message.int64Val[i].high))) + return "int64Val: integer|Long[] expected"; + } + if (message.uintVal != null && message.hasOwnProperty("uintVal")) { + if (!Array.isArray(message.uintVal)) + return "uintVal: array expected"; + for (var i = 0; i < message.uintVal.length; ++i) + if (!$util.isInteger(message.uintVal[i])) + return "uintVal: integer[] expected"; + } + if (message.uint64Val != null && message.hasOwnProperty("uint64Val")) { + if (!Array.isArray(message.uint64Val)) + return "uint64Val: array expected"; + for (var i = 0; i < message.uint64Val.length; ++i) + if (!$util.isInteger(message.uint64Val[i]) && !(message.uint64Val[i] && $util.isInteger(message.uint64Val[i].low) && $util.isInteger(message.uint64Val[i].high))) + return "uint64Val: integer|Long[] expected"; + } + if (message.listVal != null && message.hasOwnProperty("listVal")) { + if (!Array.isArray(message.listVal)) + return "listVal: array expected"; + for (var i = 0; i < message.listVal.length; ++i) { + var error = $root.google.cloud.aiplatform.v1beta1.Tensor.verify(message.listVal[i]); + if (error) + return "listVal." + error; + } + } + if (message.structVal != null && message.hasOwnProperty("structVal")) { + if (!$util.isObject(message.structVal)) + return "structVal: object expected"; + var key = Object.keys(message.structVal); + for (var i = 0; i < key.length; ++i) { + var error = $root.google.cloud.aiplatform.v1beta1.Tensor.verify(message.structVal[key[i]]); + if (error) + return "structVal." + error; + } + } + if (message.tensorVal != null && message.hasOwnProperty("tensorVal")) + if (!(message.tensorVal && typeof message.tensorVal.length === "number" || $util.isString(message.tensorVal))) + return "tensorVal: buffer expected"; + return null; + }; + + /** + * Creates a Tensor message from a plain object. Also converts values to their respective internal types. + * @function fromObject + * @memberof google.cloud.aiplatform.v1beta1.Tensor + * @static + * @param {Object.} object Plain object + * @returns {google.cloud.aiplatform.v1beta1.Tensor} Tensor + */ + Tensor.fromObject = function fromObject(object) { + if (object instanceof $root.google.cloud.aiplatform.v1beta1.Tensor) + return object; + var message = new $root.google.cloud.aiplatform.v1beta1.Tensor(); + switch (object.dtype) { + default: + if (typeof object.dtype === "number") { + message.dtype = object.dtype; + break; + } + break; + case "DATA_TYPE_UNSPECIFIED": + case 0: + message.dtype = 0; + break; + case "BOOL": + case 1: + message.dtype = 1; + break; + case "STRING": + case 2: + message.dtype = 2; + break; + case "FLOAT": + case 3: + message.dtype = 3; + break; + case "DOUBLE": + case 4: + message.dtype = 4; + break; + case "INT8": + case 5: + message.dtype = 5; + break; + case "INT16": + case 6: + message.dtype = 6; + break; + case "INT32": + case 7: + message.dtype = 7; + break; + case "INT64": + case 8: + message.dtype = 8; + break; + case "UINT8": + case 9: + message.dtype = 9; + break; + case "UINT16": + case 10: + message.dtype = 10; + break; + case "UINT32": + case 11: + message.dtype = 11; + break; + case "UINT64": + case 12: + message.dtype = 12; + break; + } + if (object.shape) { + if (!Array.isArray(object.shape)) + throw TypeError(".google.cloud.aiplatform.v1beta1.Tensor.shape: array expected"); + message.shape = []; + for (var i = 0; i < object.shape.length; ++i) + if ($util.Long) + (message.shape[i] = $util.Long.fromValue(object.shape[i])).unsigned = false; + else if (typeof object.shape[i] === "string") + message.shape[i] = parseInt(object.shape[i], 10); + else if (typeof object.shape[i] === "number") + message.shape[i] = object.shape[i]; + else if (typeof object.shape[i] === "object") + message.shape[i] = new $util.LongBits(object.shape[i].low >>> 0, object.shape[i].high >>> 0).toNumber(); + } + if (object.boolVal) { + if (!Array.isArray(object.boolVal)) + throw TypeError(".google.cloud.aiplatform.v1beta1.Tensor.boolVal: array expected"); + message.boolVal = []; + for (var i = 0; i < object.boolVal.length; ++i) + message.boolVal[i] = Boolean(object.boolVal[i]); + } + if (object.stringVal) { + if (!Array.isArray(object.stringVal)) + throw TypeError(".google.cloud.aiplatform.v1beta1.Tensor.stringVal: array expected"); + message.stringVal = []; + for (var i = 0; i < object.stringVal.length; ++i) + message.stringVal[i] = String(object.stringVal[i]); + } + if (object.bytesVal) { + if (!Array.isArray(object.bytesVal)) + throw TypeError(".google.cloud.aiplatform.v1beta1.Tensor.bytesVal: array expected"); + message.bytesVal = []; + for (var i = 0; i < object.bytesVal.length; ++i) + if (typeof object.bytesVal[i] === "string") + $util.base64.decode(object.bytesVal[i], message.bytesVal[i] = $util.newBuffer($util.base64.length(object.bytesVal[i])), 0); + else if (object.bytesVal[i].length >= 0) + message.bytesVal[i] = object.bytesVal[i]; + } + if (object.floatVal) { + if (!Array.isArray(object.floatVal)) + throw TypeError(".google.cloud.aiplatform.v1beta1.Tensor.floatVal: array expected"); + message.floatVal = []; + for (var i = 0; i < object.floatVal.length; ++i) + message.floatVal[i] = Number(object.floatVal[i]); + } + if (object.doubleVal) { + if (!Array.isArray(object.doubleVal)) + throw TypeError(".google.cloud.aiplatform.v1beta1.Tensor.doubleVal: array expected"); + message.doubleVal = []; + for (var i = 0; i < object.doubleVal.length; ++i) + message.doubleVal[i] = Number(object.doubleVal[i]); + } + if (object.intVal) { + if (!Array.isArray(object.intVal)) + throw TypeError(".google.cloud.aiplatform.v1beta1.Tensor.intVal: array expected"); + message.intVal = []; + for (var i = 0; i < object.intVal.length; ++i) + message.intVal[i] = object.intVal[i] | 0; + } + if (object.int64Val) { + if (!Array.isArray(object.int64Val)) + throw TypeError(".google.cloud.aiplatform.v1beta1.Tensor.int64Val: array expected"); + message.int64Val = []; + for (var i = 0; i < object.int64Val.length; ++i) + if ($util.Long) + (message.int64Val[i] = $util.Long.fromValue(object.int64Val[i])).unsigned = false; + else if (typeof object.int64Val[i] === "string") + message.int64Val[i] = parseInt(object.int64Val[i], 10); + else if (typeof object.int64Val[i] === "number") + message.int64Val[i] = object.int64Val[i]; + else if (typeof object.int64Val[i] === "object") + message.int64Val[i] = new $util.LongBits(object.int64Val[i].low >>> 0, object.int64Val[i].high >>> 0).toNumber(); + } + if (object.uintVal) { + if (!Array.isArray(object.uintVal)) + throw TypeError(".google.cloud.aiplatform.v1beta1.Tensor.uintVal: array expected"); + message.uintVal = []; + for (var i = 0; i < object.uintVal.length; ++i) + message.uintVal[i] = object.uintVal[i] >>> 0; + } + if (object.uint64Val) { + if (!Array.isArray(object.uint64Val)) + throw TypeError(".google.cloud.aiplatform.v1beta1.Tensor.uint64Val: array expected"); + message.uint64Val = []; + for (var i = 0; i < object.uint64Val.length; ++i) + if ($util.Long) + (message.uint64Val[i] = $util.Long.fromValue(object.uint64Val[i])).unsigned = true; + else if (typeof object.uint64Val[i] === "string") + message.uint64Val[i] = parseInt(object.uint64Val[i], 10); + else if (typeof object.uint64Val[i] === "number") + message.uint64Val[i] = object.uint64Val[i]; + else if (typeof object.uint64Val[i] === "object") + message.uint64Val[i] = new $util.LongBits(object.uint64Val[i].low >>> 0, object.uint64Val[i].high >>> 0).toNumber(true); + } + if (object.listVal) { + if (!Array.isArray(object.listVal)) + throw TypeError(".google.cloud.aiplatform.v1beta1.Tensor.listVal: array expected"); + message.listVal = []; + for (var i = 0; i < object.listVal.length; ++i) { + if (typeof object.listVal[i] !== "object") + throw TypeError(".google.cloud.aiplatform.v1beta1.Tensor.listVal: object expected"); + message.listVal[i] = $root.google.cloud.aiplatform.v1beta1.Tensor.fromObject(object.listVal[i]); + } + } + if (object.structVal) { + if (typeof object.structVal !== "object") + throw TypeError(".google.cloud.aiplatform.v1beta1.Tensor.structVal: object expected"); + message.structVal = {}; + for (var keys = Object.keys(object.structVal), i = 0; i < keys.length; ++i) { + if (typeof object.structVal[keys[i]] !== "object") + throw TypeError(".google.cloud.aiplatform.v1beta1.Tensor.structVal: object expected"); + message.structVal[keys[i]] = $root.google.cloud.aiplatform.v1beta1.Tensor.fromObject(object.structVal[keys[i]]); + } + } + if (object.tensorVal != null) + if (typeof object.tensorVal === "string") + $util.base64.decode(object.tensorVal, message.tensorVal = $util.newBuffer($util.base64.length(object.tensorVal)), 0); + else if (object.tensorVal.length >= 0) + message.tensorVal = object.tensorVal; + return message; + }; + + /** + * Creates a plain object from a Tensor message. Also converts values to other types if specified. + * @function toObject + * @memberof google.cloud.aiplatform.v1beta1.Tensor + * @static + * @param {google.cloud.aiplatform.v1beta1.Tensor} message Tensor + * @param {$protobuf.IConversionOptions} [options] Conversion options + * @returns {Object.} Plain object + */ + Tensor.toObject = function toObject(message, options) { + if (!options) + options = {}; + var object = {}; + if (options.arrays || options.defaults) { + object.shape = []; + object.boolVal = []; + object.floatVal = []; + object.doubleVal = []; + object.intVal = []; + object.int64Val = []; + object.uintVal = []; + object.uint64Val = []; + object.listVal = []; + object.stringVal = []; + object.bytesVal = []; + } + if (options.objects || options.defaults) + object.structVal = {}; + if (options.defaults) { + object.dtype = options.enums === String ? "DATA_TYPE_UNSPECIFIED" : 0; + if (options.bytes === String) + object.tensorVal = ""; + else { + object.tensorVal = []; + if (options.bytes !== Array) + object.tensorVal = $util.newBuffer(object.tensorVal); + } + } + if (message.dtype != null && message.hasOwnProperty("dtype")) + object.dtype = options.enums === String ? $root.google.cloud.aiplatform.v1beta1.Tensor.DataType[message.dtype] === undefined ? message.dtype : $root.google.cloud.aiplatform.v1beta1.Tensor.DataType[message.dtype] : message.dtype; + if (message.shape && message.shape.length) { + object.shape = []; + for (var j = 0; j < message.shape.length; ++j) + if (typeof message.shape[j] === "number") + object.shape[j] = options.longs === String ? String(message.shape[j]) : message.shape[j]; + else + object.shape[j] = options.longs === String ? $util.Long.prototype.toString.call(message.shape[j]) : options.longs === Number ? new $util.LongBits(message.shape[j].low >>> 0, message.shape[j].high >>> 0).toNumber() : message.shape[j]; + } + if (message.boolVal && message.boolVal.length) { + object.boolVal = []; + for (var j = 0; j < message.boolVal.length; ++j) + object.boolVal[j] = message.boolVal[j]; + } + if (message.floatVal && message.floatVal.length) { + object.floatVal = []; + for (var j = 0; j < message.floatVal.length; ++j) + object.floatVal[j] = options.json && !isFinite(message.floatVal[j]) ? String(message.floatVal[j]) : message.floatVal[j]; + } + if (message.doubleVal && message.doubleVal.length) { + object.doubleVal = []; + for (var j = 0; j < message.doubleVal.length; ++j) + object.doubleVal[j] = options.json && !isFinite(message.doubleVal[j]) ? String(message.doubleVal[j]) : message.doubleVal[j]; + } + if (message.intVal && message.intVal.length) { + object.intVal = []; + for (var j = 0; j < message.intVal.length; ++j) + object.intVal[j] = message.intVal[j]; + } + if (message.int64Val && message.int64Val.length) { + object.int64Val = []; + for (var j = 0; j < message.int64Val.length; ++j) + if (typeof message.int64Val[j] === "number") + object.int64Val[j] = options.longs === String ? String(message.int64Val[j]) : message.int64Val[j]; + else + object.int64Val[j] = options.longs === String ? $util.Long.prototype.toString.call(message.int64Val[j]) : options.longs === Number ? new $util.LongBits(message.int64Val[j].low >>> 0, message.int64Val[j].high >>> 0).toNumber() : message.int64Val[j]; + } + if (message.uintVal && message.uintVal.length) { + object.uintVal = []; + for (var j = 0; j < message.uintVal.length; ++j) + object.uintVal[j] = message.uintVal[j]; + } + if (message.uint64Val && message.uint64Val.length) { + object.uint64Val = []; + for (var j = 0; j < message.uint64Val.length; ++j) + if (typeof message.uint64Val[j] === "number") + object.uint64Val[j] = options.longs === String ? String(message.uint64Val[j]) : message.uint64Val[j]; + else + object.uint64Val[j] = options.longs === String ? $util.Long.prototype.toString.call(message.uint64Val[j]) : options.longs === Number ? new $util.LongBits(message.uint64Val[j].low >>> 0, message.uint64Val[j].high >>> 0).toNumber(true) : message.uint64Val[j]; + } + if (message.listVal && message.listVal.length) { + object.listVal = []; + for (var j = 0; j < message.listVal.length; ++j) + object.listVal[j] = $root.google.cloud.aiplatform.v1beta1.Tensor.toObject(message.listVal[j], options); + } + var keys2; + if (message.structVal && (keys2 = Object.keys(message.structVal)).length) { + object.structVal = {}; + for (var j = 0; j < keys2.length; ++j) + object.structVal[keys2[j]] = $root.google.cloud.aiplatform.v1beta1.Tensor.toObject(message.structVal[keys2[j]], options); + } + if (message.tensorVal != null && message.hasOwnProperty("tensorVal")) + object.tensorVal = options.bytes === String ? $util.base64.encode(message.tensorVal, 0, message.tensorVal.length) : options.bytes === Array ? Array.prototype.slice.call(message.tensorVal) : message.tensorVal; + if (message.stringVal && message.stringVal.length) { + object.stringVal = []; + for (var j = 0; j < message.stringVal.length; ++j) + object.stringVal[j] = message.stringVal[j]; + } + if (message.bytesVal && message.bytesVal.length) { + object.bytesVal = []; + for (var j = 0; j < message.bytesVal.length; ++j) + object.bytesVal[j] = options.bytes === String ? $util.base64.encode(message.bytesVal[j], 0, message.bytesVal[j].length) : options.bytes === Array ? Array.prototype.slice.call(message.bytesVal[j]) : message.bytesVal[j]; + } + return object; + }; + + /** + * Converts this Tensor to JSON. + * @function toJSON + * @memberof google.cloud.aiplatform.v1beta1.Tensor + * @instance + * @returns {Object.} JSON object + */ + Tensor.prototype.toJSON = function toJSON() { + return this.constructor.toObject(this, $protobuf.util.toJSONOptions); + }; + + /** + * Gets the default type url for Tensor + * @function getTypeUrl + * @memberof google.cloud.aiplatform.v1beta1.Tensor + * @static + * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns {string} The default type url + */ + Tensor.getTypeUrl = function getTypeUrl(typeUrlPrefix) { + if (typeUrlPrefix === undefined) { + typeUrlPrefix = "type.googleapis.com"; + } + return typeUrlPrefix + "/google.cloud.aiplatform.v1beta1.Tensor"; + }; + + /** + * DataType enum. + * @name google.cloud.aiplatform.v1beta1.Tensor.DataType + * @enum {number} + * @property {number} DATA_TYPE_UNSPECIFIED=0 DATA_TYPE_UNSPECIFIED value + * @property {number} BOOL=1 BOOL value + * @property {number} STRING=2 STRING value + * @property {number} FLOAT=3 FLOAT value + * @property {number} DOUBLE=4 DOUBLE value + * @property {number} INT8=5 INT8 value + * @property {number} INT16=6 INT16 value + * @property {number} INT32=7 INT32 value + * @property {number} INT64=8 INT64 value + * @property {number} UINT8=9 UINT8 value + * @property {number} UINT16=10 UINT16 value + * @property {number} UINT32=11 UINT32 value + * @property {number} UINT64=12 UINT64 value + */ + Tensor.DataType = (function() { + var valuesById = {}, values = Object.create(valuesById); + values[valuesById[0] = "DATA_TYPE_UNSPECIFIED"] = 0; + values[valuesById[1] = "BOOL"] = 1; + values[valuesById[2] = "STRING"] = 2; + values[valuesById[3] = "FLOAT"] = 3; + values[valuesById[4] = "DOUBLE"] = 4; + values[valuesById[5] = "INT8"] = 5; + values[valuesById[6] = "INT16"] = 6; + values[valuesById[7] = "INT32"] = 7; + values[valuesById[8] = "INT64"] = 8; + values[valuesById[9] = "UINT8"] = 9; + values[valuesById[10] = "UINT16"] = 10; + values[valuesById[11] = "UINT32"] = 11; + values[valuesById[12] = "UINT64"] = 12; + return values; + })(); + + return Tensor; + })(); + v1beta1.FeaturestoreService = (function() { /** @@ -344886,6 +350478,39 @@ * @variation 2 */ + /** + * Callback as used by {@link google.cloud.aiplatform.v1beta1.PredictionService|serverStreamingPredict}. + * @memberof google.cloud.aiplatform.v1beta1.PredictionService + * @typedef ServerStreamingPredictCallback + * @type {function} + * @param {Error|null} error Error, if any + * @param {google.cloud.aiplatform.v1beta1.StreamingPredictResponse} [response] StreamingPredictResponse + */ + + /** + * Calls ServerStreamingPredict. + * @function serverStreamingPredict + * @memberof google.cloud.aiplatform.v1beta1.PredictionService + * @instance + * @param {google.cloud.aiplatform.v1beta1.IStreamingPredictRequest} request StreamingPredictRequest message or plain object + * @param {google.cloud.aiplatform.v1beta1.PredictionService.ServerStreamingPredictCallback} callback Node-style callback called with the error, if any, and StreamingPredictResponse + * @returns {undefined} + * @variation 1 + */ + Object.defineProperty(PredictionService.prototype.serverStreamingPredict = function serverStreamingPredict(request, callback) { + return this.rpcCall(serverStreamingPredict, $root.google.cloud.aiplatform.v1beta1.StreamingPredictRequest, $root.google.cloud.aiplatform.v1beta1.StreamingPredictResponse, request, callback); + }, "name", { value: "ServerStreamingPredict" }); + + /** + * Calls ServerStreamingPredict. + * @function serverStreamingPredict + * @memberof google.cloud.aiplatform.v1beta1.PredictionService + * @instance + * @param {google.cloud.aiplatform.v1beta1.IStreamingPredictRequest} request StreamingPredictRequest message or plain object + * @returns {Promise} Promise + * @variation 2 + */ + /** * Callback as used by {@link google.cloud.aiplatform.v1beta1.PredictionService|explain}. * @memberof google.cloud.aiplatform.v1beta1.PredictionService @@ -345210,6 +350835,7 @@ * @property {string|null} [model] PredictResponse model * @property {string|null} [modelVersionId] PredictResponse modelVersionId * @property {string|null} [modelDisplayName] PredictResponse modelDisplayName + * @property {google.protobuf.IValue|null} [metadata] PredictResponse metadata */ /** @@ -345268,6 +350894,14 @@ */ PredictResponse.prototype.modelDisplayName = ""; + /** + * PredictResponse metadata. + * @member {google.protobuf.IValue|null|undefined} metadata + * @memberof google.cloud.aiplatform.v1beta1.PredictResponse + * @instance + */ + PredictResponse.prototype.metadata = null; + /** * Creates a new PredictResponse instance using the specified properties. * @function create @@ -345303,6 +350937,8 @@ writer.uint32(/* id 4, wireType 2 =*/34).string(message.modelDisplayName); if (message.modelVersionId != null && Object.hasOwnProperty.call(message, "modelVersionId")) writer.uint32(/* id 5, wireType 2 =*/42).string(message.modelVersionId); + if (message.metadata != null && Object.hasOwnProperty.call(message, "metadata")) + $root.google.protobuf.Value.encode(message.metadata, writer.uint32(/* id 6, wireType 2 =*/50).fork()).ldelim(); return writer; }; @@ -345359,6 +350995,10 @@ message.modelDisplayName = reader.string(); break; } + case 6: { + message.metadata = $root.google.protobuf.Value.decode(reader, reader.uint32()); + break; + } default: reader.skipType(tag & 7); break; @@ -345415,6 +351055,11 @@ if (message.modelDisplayName != null && message.hasOwnProperty("modelDisplayName")) if (!$util.isString(message.modelDisplayName)) return "modelDisplayName: string expected"; + if (message.metadata != null && message.hasOwnProperty("metadata")) { + var error = $root.google.protobuf.Value.verify(message.metadata); + if (error) + return "metadata." + error; + } return null; }; @@ -345448,6 +351093,11 @@ message.modelVersionId = String(object.modelVersionId); if (object.modelDisplayName != null) message.modelDisplayName = String(object.modelDisplayName); + if (object.metadata != null) { + if (typeof object.metadata !== "object") + throw TypeError(".google.cloud.aiplatform.v1beta1.PredictResponse.metadata: object expected"); + message.metadata = $root.google.protobuf.Value.fromObject(object.metadata); + } return message; }; @@ -345471,6 +351121,7 @@ object.model = ""; object.modelDisplayName = ""; object.modelVersionId = ""; + object.metadata = null; } if (message.predictions && message.predictions.length) { object.predictions = []; @@ -345485,6 +351136,8 @@ object.modelDisplayName = message.modelDisplayName; if (message.modelVersionId != null && message.hasOwnProperty("modelVersionId")) object.modelVersionId = message.modelVersionId; + if (message.metadata != null && message.hasOwnProperty("metadata")) + object.metadata = $root.google.protobuf.Value.toObject(message.metadata, options); return object; }; @@ -345749,6 +351402,536 @@ return RawPredictRequest; })(); + v1beta1.StreamingPredictRequest = (function() { + + /** + * Properties of a StreamingPredictRequest. + * @memberof google.cloud.aiplatform.v1beta1 + * @interface IStreamingPredictRequest + * @property {string|null} [endpoint] StreamingPredictRequest endpoint + * @property {Array.|null} [inputs] StreamingPredictRequest inputs + * @property {google.cloud.aiplatform.v1beta1.ITensor|null} [parameters] StreamingPredictRequest parameters + */ + + /** + * Constructs a new StreamingPredictRequest. + * @memberof google.cloud.aiplatform.v1beta1 + * @classdesc Represents a StreamingPredictRequest. + * @implements IStreamingPredictRequest + * @constructor + * @param {google.cloud.aiplatform.v1beta1.IStreamingPredictRequest=} [properties] Properties to set + */ + function StreamingPredictRequest(properties) { + this.inputs = []; + if (properties) + for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) + if (properties[keys[i]] != null) + this[keys[i]] = properties[keys[i]]; + } + + /** + * StreamingPredictRequest endpoint. + * @member {string} endpoint + * @memberof google.cloud.aiplatform.v1beta1.StreamingPredictRequest + * @instance + */ + StreamingPredictRequest.prototype.endpoint = ""; + + /** + * StreamingPredictRequest inputs. + * @member {Array.} inputs + * @memberof google.cloud.aiplatform.v1beta1.StreamingPredictRequest + * @instance + */ + StreamingPredictRequest.prototype.inputs = $util.emptyArray; + + /** + * StreamingPredictRequest parameters. + * @member {google.cloud.aiplatform.v1beta1.ITensor|null|undefined} parameters + * @memberof google.cloud.aiplatform.v1beta1.StreamingPredictRequest + * @instance + */ + StreamingPredictRequest.prototype.parameters = null; + + /** + * Creates a new StreamingPredictRequest instance using the specified properties. + * @function create + * @memberof google.cloud.aiplatform.v1beta1.StreamingPredictRequest + * @static + * @param {google.cloud.aiplatform.v1beta1.IStreamingPredictRequest=} [properties] Properties to set + * @returns {google.cloud.aiplatform.v1beta1.StreamingPredictRequest} StreamingPredictRequest instance + */ + StreamingPredictRequest.create = function create(properties) { + return new StreamingPredictRequest(properties); + }; + + /** + * Encodes the specified StreamingPredictRequest message. Does not implicitly {@link google.cloud.aiplatform.v1beta1.StreamingPredictRequest.verify|verify} messages. + * @function encode + * @memberof google.cloud.aiplatform.v1beta1.StreamingPredictRequest + * @static + * @param {google.cloud.aiplatform.v1beta1.IStreamingPredictRequest} message StreamingPredictRequest message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + StreamingPredictRequest.encode = function encode(message, writer) { + if (!writer) + writer = $Writer.create(); + if (message.endpoint != null && Object.hasOwnProperty.call(message, "endpoint")) + writer.uint32(/* id 1, wireType 2 =*/10).string(message.endpoint); + if (message.inputs != null && message.inputs.length) + for (var i = 0; i < message.inputs.length; ++i) + $root.google.cloud.aiplatform.v1beta1.Tensor.encode(message.inputs[i], writer.uint32(/* id 2, wireType 2 =*/18).fork()).ldelim(); + if (message.parameters != null && Object.hasOwnProperty.call(message, "parameters")) + $root.google.cloud.aiplatform.v1beta1.Tensor.encode(message.parameters, writer.uint32(/* id 3, wireType 2 =*/26).fork()).ldelim(); + return writer; + }; + + /** + * Encodes the specified StreamingPredictRequest message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1beta1.StreamingPredictRequest.verify|verify} messages. + * @function encodeDelimited + * @memberof google.cloud.aiplatform.v1beta1.StreamingPredictRequest + * @static + * @param {google.cloud.aiplatform.v1beta1.IStreamingPredictRequest} message StreamingPredictRequest message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + StreamingPredictRequest.encodeDelimited = function encodeDelimited(message, writer) { + return this.encode(message, writer).ldelim(); + }; + + /** + * Decodes a StreamingPredictRequest message from the specified reader or buffer. + * @function decode + * @memberof google.cloud.aiplatform.v1beta1.StreamingPredictRequest + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @param {number} [length] Message length if known beforehand + * @returns {google.cloud.aiplatform.v1beta1.StreamingPredictRequest} StreamingPredictRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + StreamingPredictRequest.decode = function decode(reader, length) { + if (!(reader instanceof $Reader)) + reader = $Reader.create(reader); + var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.aiplatform.v1beta1.StreamingPredictRequest(); + while (reader.pos < end) { + var tag = reader.uint32(); + switch (tag >>> 3) { + case 1: { + message.endpoint = reader.string(); + break; + } + case 2: { + if (!(message.inputs && message.inputs.length)) + message.inputs = []; + message.inputs.push($root.google.cloud.aiplatform.v1beta1.Tensor.decode(reader, reader.uint32())); + break; + } + case 3: { + message.parameters = $root.google.cloud.aiplatform.v1beta1.Tensor.decode(reader, reader.uint32()); + break; + } + default: + reader.skipType(tag & 7); + break; + } + } + return message; + }; + + /** + * Decodes a StreamingPredictRequest message from the specified reader or buffer, length delimited. + * @function decodeDelimited + * @memberof google.cloud.aiplatform.v1beta1.StreamingPredictRequest + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @returns {google.cloud.aiplatform.v1beta1.StreamingPredictRequest} StreamingPredictRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + StreamingPredictRequest.decodeDelimited = function decodeDelimited(reader) { + if (!(reader instanceof $Reader)) + reader = new $Reader(reader); + return this.decode(reader, reader.uint32()); + }; + + /** + * Verifies a StreamingPredictRequest message. + * @function verify + * @memberof google.cloud.aiplatform.v1beta1.StreamingPredictRequest + * @static + * @param {Object.} message Plain object to verify + * @returns {string|null} `null` if valid, otherwise the reason why it is not + */ + StreamingPredictRequest.verify = function verify(message) { + if (typeof message !== "object" || message === null) + return "object expected"; + if (message.endpoint != null && message.hasOwnProperty("endpoint")) + if (!$util.isString(message.endpoint)) + return "endpoint: string expected"; + if (message.inputs != null && message.hasOwnProperty("inputs")) { + if (!Array.isArray(message.inputs)) + return "inputs: array expected"; + for (var i = 0; i < message.inputs.length; ++i) { + var error = $root.google.cloud.aiplatform.v1beta1.Tensor.verify(message.inputs[i]); + if (error) + return "inputs." + error; + } + } + if (message.parameters != null && message.hasOwnProperty("parameters")) { + var error = $root.google.cloud.aiplatform.v1beta1.Tensor.verify(message.parameters); + if (error) + return "parameters." + error; + } + return null; + }; + + /** + * Creates a StreamingPredictRequest message from a plain object. Also converts values to their respective internal types. + * @function fromObject + * @memberof google.cloud.aiplatform.v1beta1.StreamingPredictRequest + * @static + * @param {Object.} object Plain object + * @returns {google.cloud.aiplatform.v1beta1.StreamingPredictRequest} StreamingPredictRequest + */ + StreamingPredictRequest.fromObject = function fromObject(object) { + if (object instanceof $root.google.cloud.aiplatform.v1beta1.StreamingPredictRequest) + return object; + var message = new $root.google.cloud.aiplatform.v1beta1.StreamingPredictRequest(); + if (object.endpoint != null) + message.endpoint = String(object.endpoint); + if (object.inputs) { + if (!Array.isArray(object.inputs)) + throw TypeError(".google.cloud.aiplatform.v1beta1.StreamingPredictRequest.inputs: array expected"); + message.inputs = []; + for (var i = 0; i < object.inputs.length; ++i) { + if (typeof object.inputs[i] !== "object") + throw TypeError(".google.cloud.aiplatform.v1beta1.StreamingPredictRequest.inputs: object expected"); + message.inputs[i] = $root.google.cloud.aiplatform.v1beta1.Tensor.fromObject(object.inputs[i]); + } + } + if (object.parameters != null) { + if (typeof object.parameters !== "object") + throw TypeError(".google.cloud.aiplatform.v1beta1.StreamingPredictRequest.parameters: object expected"); + message.parameters = $root.google.cloud.aiplatform.v1beta1.Tensor.fromObject(object.parameters); + } + return message; + }; + + /** + * Creates a plain object from a StreamingPredictRequest message. Also converts values to other types if specified. + * @function toObject + * @memberof google.cloud.aiplatform.v1beta1.StreamingPredictRequest + * @static + * @param {google.cloud.aiplatform.v1beta1.StreamingPredictRequest} message StreamingPredictRequest + * @param {$protobuf.IConversionOptions} [options] Conversion options + * @returns {Object.} Plain object + */ + StreamingPredictRequest.toObject = function toObject(message, options) { + if (!options) + options = {}; + var object = {}; + if (options.arrays || options.defaults) + object.inputs = []; + if (options.defaults) { + object.endpoint = ""; + object.parameters = null; + } + if (message.endpoint != null && message.hasOwnProperty("endpoint")) + object.endpoint = message.endpoint; + if (message.inputs && message.inputs.length) { + object.inputs = []; + for (var j = 0; j < message.inputs.length; ++j) + object.inputs[j] = $root.google.cloud.aiplatform.v1beta1.Tensor.toObject(message.inputs[j], options); + } + if (message.parameters != null && message.hasOwnProperty("parameters")) + object.parameters = $root.google.cloud.aiplatform.v1beta1.Tensor.toObject(message.parameters, options); + return object; + }; + + /** + * Converts this StreamingPredictRequest to JSON. + * @function toJSON + * @memberof google.cloud.aiplatform.v1beta1.StreamingPredictRequest + * @instance + * @returns {Object.} JSON object + */ + StreamingPredictRequest.prototype.toJSON = function toJSON() { + return this.constructor.toObject(this, $protobuf.util.toJSONOptions); + }; + + /** + * Gets the default type url for StreamingPredictRequest + * @function getTypeUrl + * @memberof google.cloud.aiplatform.v1beta1.StreamingPredictRequest + * @static + * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns {string} The default type url + */ + StreamingPredictRequest.getTypeUrl = function getTypeUrl(typeUrlPrefix) { + if (typeUrlPrefix === undefined) { + typeUrlPrefix = "type.googleapis.com"; + } + return typeUrlPrefix + "/google.cloud.aiplatform.v1beta1.StreamingPredictRequest"; + }; + + return StreamingPredictRequest; + })(); + + v1beta1.StreamingPredictResponse = (function() { + + /** + * Properties of a StreamingPredictResponse. + * @memberof google.cloud.aiplatform.v1beta1 + * @interface IStreamingPredictResponse + * @property {Array.|null} [outputs] StreamingPredictResponse outputs + * @property {google.cloud.aiplatform.v1beta1.ITensor|null} [parameters] StreamingPredictResponse parameters + */ + + /** + * Constructs a new StreamingPredictResponse. + * @memberof google.cloud.aiplatform.v1beta1 + * @classdesc Represents a StreamingPredictResponse. + * @implements IStreamingPredictResponse + * @constructor + * @param {google.cloud.aiplatform.v1beta1.IStreamingPredictResponse=} [properties] Properties to set + */ + function StreamingPredictResponse(properties) { + this.outputs = []; + if (properties) + for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) + if (properties[keys[i]] != null) + this[keys[i]] = properties[keys[i]]; + } + + /** + * StreamingPredictResponse outputs. + * @member {Array.} outputs + * @memberof google.cloud.aiplatform.v1beta1.StreamingPredictResponse + * @instance + */ + StreamingPredictResponse.prototype.outputs = $util.emptyArray; + + /** + * StreamingPredictResponse parameters. + * @member {google.cloud.aiplatform.v1beta1.ITensor|null|undefined} parameters + * @memberof google.cloud.aiplatform.v1beta1.StreamingPredictResponse + * @instance + */ + StreamingPredictResponse.prototype.parameters = null; + + /** + * Creates a new StreamingPredictResponse instance using the specified properties. + * @function create + * @memberof google.cloud.aiplatform.v1beta1.StreamingPredictResponse + * @static + * @param {google.cloud.aiplatform.v1beta1.IStreamingPredictResponse=} [properties] Properties to set + * @returns {google.cloud.aiplatform.v1beta1.StreamingPredictResponse} StreamingPredictResponse instance + */ + StreamingPredictResponse.create = function create(properties) { + return new StreamingPredictResponse(properties); + }; + + /** + * Encodes the specified StreamingPredictResponse message. Does not implicitly {@link google.cloud.aiplatform.v1beta1.StreamingPredictResponse.verify|verify} messages. + * @function encode + * @memberof google.cloud.aiplatform.v1beta1.StreamingPredictResponse + * @static + * @param {google.cloud.aiplatform.v1beta1.IStreamingPredictResponse} message StreamingPredictResponse message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + StreamingPredictResponse.encode = function encode(message, writer) { + if (!writer) + writer = $Writer.create(); + if (message.outputs != null && message.outputs.length) + for (var i = 0; i < message.outputs.length; ++i) + $root.google.cloud.aiplatform.v1beta1.Tensor.encode(message.outputs[i], writer.uint32(/* id 1, wireType 2 =*/10).fork()).ldelim(); + if (message.parameters != null && Object.hasOwnProperty.call(message, "parameters")) + $root.google.cloud.aiplatform.v1beta1.Tensor.encode(message.parameters, writer.uint32(/* id 2, wireType 2 =*/18).fork()).ldelim(); + return writer; + }; + + /** + * Encodes the specified StreamingPredictResponse message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1beta1.StreamingPredictResponse.verify|verify} messages. + * @function encodeDelimited + * @memberof google.cloud.aiplatform.v1beta1.StreamingPredictResponse + * @static + * @param {google.cloud.aiplatform.v1beta1.IStreamingPredictResponse} message StreamingPredictResponse message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + StreamingPredictResponse.encodeDelimited = function encodeDelimited(message, writer) { + return this.encode(message, writer).ldelim(); + }; + + /** + * Decodes a StreamingPredictResponse message from the specified reader or buffer. + * @function decode + * @memberof google.cloud.aiplatform.v1beta1.StreamingPredictResponse + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @param {number} [length] Message length if known beforehand + * @returns {google.cloud.aiplatform.v1beta1.StreamingPredictResponse} StreamingPredictResponse + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + StreamingPredictResponse.decode = function decode(reader, length) { + if (!(reader instanceof $Reader)) + reader = $Reader.create(reader); + var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.aiplatform.v1beta1.StreamingPredictResponse(); + while (reader.pos < end) { + var tag = reader.uint32(); + switch (tag >>> 3) { + case 1: { + if (!(message.outputs && message.outputs.length)) + message.outputs = []; + message.outputs.push($root.google.cloud.aiplatform.v1beta1.Tensor.decode(reader, reader.uint32())); + break; + } + case 2: { + message.parameters = $root.google.cloud.aiplatform.v1beta1.Tensor.decode(reader, reader.uint32()); + break; + } + default: + reader.skipType(tag & 7); + break; + } + } + return message; + }; + + /** + * Decodes a StreamingPredictResponse message from the specified reader or buffer, length delimited. + * @function decodeDelimited + * @memberof google.cloud.aiplatform.v1beta1.StreamingPredictResponse + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @returns {google.cloud.aiplatform.v1beta1.StreamingPredictResponse} StreamingPredictResponse + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + StreamingPredictResponse.decodeDelimited = function decodeDelimited(reader) { + if (!(reader instanceof $Reader)) + reader = new $Reader(reader); + return this.decode(reader, reader.uint32()); + }; + + /** + * Verifies a StreamingPredictResponse message. + * @function verify + * @memberof google.cloud.aiplatform.v1beta1.StreamingPredictResponse + * @static + * @param {Object.} message Plain object to verify + * @returns {string|null} `null` if valid, otherwise the reason why it is not + */ + StreamingPredictResponse.verify = function verify(message) { + if (typeof message !== "object" || message === null) + return "object expected"; + if (message.outputs != null && message.hasOwnProperty("outputs")) { + if (!Array.isArray(message.outputs)) + return "outputs: array expected"; + for (var i = 0; i < message.outputs.length; ++i) { + var error = $root.google.cloud.aiplatform.v1beta1.Tensor.verify(message.outputs[i]); + if (error) + return "outputs." + error; + } + } + if (message.parameters != null && message.hasOwnProperty("parameters")) { + var error = $root.google.cloud.aiplatform.v1beta1.Tensor.verify(message.parameters); + if (error) + return "parameters." + error; + } + return null; + }; + + /** + * Creates a StreamingPredictResponse message from a plain object. Also converts values to their respective internal types. + * @function fromObject + * @memberof google.cloud.aiplatform.v1beta1.StreamingPredictResponse + * @static + * @param {Object.} object Plain object + * @returns {google.cloud.aiplatform.v1beta1.StreamingPredictResponse} StreamingPredictResponse + */ + StreamingPredictResponse.fromObject = function fromObject(object) { + if (object instanceof $root.google.cloud.aiplatform.v1beta1.StreamingPredictResponse) + return object; + var message = new $root.google.cloud.aiplatform.v1beta1.StreamingPredictResponse(); + if (object.outputs) { + if (!Array.isArray(object.outputs)) + throw TypeError(".google.cloud.aiplatform.v1beta1.StreamingPredictResponse.outputs: array expected"); + message.outputs = []; + for (var i = 0; i < object.outputs.length; ++i) { + if (typeof object.outputs[i] !== "object") + throw TypeError(".google.cloud.aiplatform.v1beta1.StreamingPredictResponse.outputs: object expected"); + message.outputs[i] = $root.google.cloud.aiplatform.v1beta1.Tensor.fromObject(object.outputs[i]); + } + } + if (object.parameters != null) { + if (typeof object.parameters !== "object") + throw TypeError(".google.cloud.aiplatform.v1beta1.StreamingPredictResponse.parameters: object expected"); + message.parameters = $root.google.cloud.aiplatform.v1beta1.Tensor.fromObject(object.parameters); + } + return message; + }; + + /** + * Creates a plain object from a StreamingPredictResponse message. Also converts values to other types if specified. + * @function toObject + * @memberof google.cloud.aiplatform.v1beta1.StreamingPredictResponse + * @static + * @param {google.cloud.aiplatform.v1beta1.StreamingPredictResponse} message StreamingPredictResponse + * @param {$protobuf.IConversionOptions} [options] Conversion options + * @returns {Object.} Plain object + */ + StreamingPredictResponse.toObject = function toObject(message, options) { + if (!options) + options = {}; + var object = {}; + if (options.arrays || options.defaults) + object.outputs = []; + if (options.defaults) + object.parameters = null; + if (message.outputs && message.outputs.length) { + object.outputs = []; + for (var j = 0; j < message.outputs.length; ++j) + object.outputs[j] = $root.google.cloud.aiplatform.v1beta1.Tensor.toObject(message.outputs[j], options); + } + if (message.parameters != null && message.hasOwnProperty("parameters")) + object.parameters = $root.google.cloud.aiplatform.v1beta1.Tensor.toObject(message.parameters, options); + return object; + }; + + /** + * Converts this StreamingPredictResponse to JSON. + * @function toJSON + * @memberof google.cloud.aiplatform.v1beta1.StreamingPredictResponse + * @instance + * @returns {Object.} JSON object + */ + StreamingPredictResponse.prototype.toJSON = function toJSON() { + return this.constructor.toObject(this, $protobuf.util.toJSONOptions); + }; + + /** + * Gets the default type url for StreamingPredictResponse + * @function getTypeUrl + * @memberof google.cloud.aiplatform.v1beta1.StreamingPredictResponse + * @static + * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns {string} The default type url + */ + StreamingPredictResponse.getTypeUrl = function getTypeUrl(typeUrlPrefix) { + if (typeUrlPrefix === undefined) { + typeUrlPrefix = "type.googleapis.com"; + } + return typeUrlPrefix + "/google.cloud.aiplatform.v1beta1.StreamingPredictResponse"; + }; + + return StreamingPredictResponse; + })(); + v1beta1.ExplainRequest = (function() { /** diff --git a/packages/google-cloud-aiplatform/protos/protos.json b/packages/google-cloud-aiplatform/protos/protos.json index cbbd89aa559..7f567c5b261 100644 --- a/packages/google-cloud-aiplatform/protos/protos.json +++ b/packages/google-cloud-aiplatform/protos/protos.json @@ -5275,6 +5275,97 @@ } } }, + "Tensor": { + "fields": { + "dtype": { + "type": "DataType", + "id": 1 + }, + "shape": { + "rule": "repeated", + "type": "int64", + "id": 2 + }, + "boolVal": { + "rule": "repeated", + "type": "bool", + "id": 3 + }, + "stringVal": { + "rule": "repeated", + "type": "string", + "id": 14 + }, + "bytesVal": { + "rule": "repeated", + "type": "bytes", + "id": 15 + }, + "floatVal": { + "rule": "repeated", + "type": "float", + "id": 5 + }, + "doubleVal": { + "rule": "repeated", + "type": "double", + "id": 6 + }, + "intVal": { + "rule": "repeated", + "type": "int32", + "id": 7 + }, + "int64Val": { + "rule": "repeated", + "type": "int64", + "id": 8 + }, + "uintVal": { + "rule": "repeated", + "type": "uint32", + "id": 9 + }, + "uint64Val": { + "rule": "repeated", + "type": "uint64", + "id": 10 + }, + "listVal": { + "rule": "repeated", + "type": "Tensor", + "id": 11 + }, + "structVal": { + "keyType": "string", + "type": "Tensor", + "id": 12 + }, + "tensorVal": { + "type": "bytes", + "id": 13 + } + }, + "nested": { + "DataType": { + "values": { + "DATA_TYPE_UNSPECIFIED": 0, + "BOOL": 1, + "STRING": 2, + "FLOAT": 3, + "DOUBLE": 4, + "INT8": 5, + "INT16": 6, + "INT32": 7, + "INT64": 8, + "UINT8": 9, + "UINT16": 10, + "UINT32": 11, + "UINT64": 12 + } + } + } + }, "FeaturestoreService": { "options": { "(google.api.default_host)": "aiplatform.googleapis.com", @@ -16125,6 +16216,29 @@ } ] }, + "ServerStreamingPredict": { + "requestType": "StreamingPredictRequest", + "responseType": "StreamingPredictResponse", + "responseStream": true, + "options": { + "(google.api.http).post": "/v1/{endpoint=projects/*/locations/*/endpoints/*}:serverStreamingPredict", + "(google.api.http).body": "*", + "(google.api.http).additional_bindings.post": "/v1/{endpoint=projects/*/locations/*/publishers/*/models/*}:serverStreamingPredict", + "(google.api.http).additional_bindings.body": "*" + }, + "parsedOptions": [ + { + "(google.api.http)": { + "post": "/v1/{endpoint=projects/*/locations/*/endpoints/*}:serverStreamingPredict", + "body": "*", + "additional_bindings": { + "post": "/v1/{endpoint=projects/*/locations/*/publishers/*/models/*}:serverStreamingPredict", + "body": "*" + } + } + } + ] + }, "Explain": { "requestType": "ExplainRequest", "responseType": "ExplainResponse", @@ -16141,134 +16255,623 @@ } }, { - "(google.api.method_signature)": "endpoint,instances,parameters,deployed_model_id" + "(google.api.method_signature)": "endpoint,instances,parameters,deployed_model_id" + } + ] + } + } + }, + "PredictRequest": { + "fields": { + "endpoint": { + "type": "string", + "id": 1, + "options": { + "(google.api.field_behavior)": "REQUIRED", + "(google.api.resource_reference).type": "aiplatform.googleapis.com/Endpoint" + } + }, + "instances": { + "rule": "repeated", + "type": "google.protobuf.Value", + "id": 2, + "options": { + "(google.api.field_behavior)": "REQUIRED" + } + }, + "parameters": { + "type": "google.protobuf.Value", + "id": 3 + } + } + }, + "PredictResponse": { + "fields": { + "predictions": { + "rule": "repeated", + "type": "google.protobuf.Value", + "id": 1 + }, + "deployedModelId": { + "type": "string", + "id": 2 + }, + "model": { + "type": "string", + "id": 3, + "options": { + "(google.api.field_behavior)": "OUTPUT_ONLY", + "(google.api.resource_reference).type": "aiplatform.googleapis.com/Model" + } + }, + "modelVersionId": { + "type": "string", + "id": 5, + "options": { + "(google.api.field_behavior)": "OUTPUT_ONLY" + } + }, + "modelDisplayName": { + "type": "string", + "id": 4, + "options": { + "(google.api.field_behavior)": "OUTPUT_ONLY" + } + }, + "metadata": { + "type": "google.protobuf.Value", + "id": 6, + "options": { + "(google.api.field_behavior)": "OUTPUT_ONLY" + } + } + } + }, + "RawPredictRequest": { + "fields": { + "endpoint": { + "type": "string", + "id": 1, + "options": { + "(google.api.field_behavior)": "REQUIRED", + "(google.api.resource_reference).type": "aiplatform.googleapis.com/Endpoint" + } + }, + "httpBody": { + "type": "google.api.HttpBody", + "id": 2 + } + } + }, + "StreamingPredictRequest": { + "fields": { + "endpoint": { + "type": "string", + "id": 1, + "options": { + "(google.api.field_behavior)": "REQUIRED", + "(google.api.resource_reference).type": "aiplatform.googleapis.com/Endpoint" + } + }, + "inputs": { + "rule": "repeated", + "type": "Tensor", + "id": 2 + }, + "parameters": { + "type": "Tensor", + "id": 3 + } + } + }, + "StreamingPredictResponse": { + "fields": { + "outputs": { + "rule": "repeated", + "type": "Tensor", + "id": 1 + }, + "parameters": { + "type": "Tensor", + "id": 2 + } + } + }, + "ExplainRequest": { + "fields": { + "endpoint": { + "type": "string", + "id": 1, + "options": { + "(google.api.field_behavior)": "REQUIRED", + "(google.api.resource_reference).type": "aiplatform.googleapis.com/Endpoint" + } + }, + "instances": { + "rule": "repeated", + "type": "google.protobuf.Value", + "id": 2, + "options": { + "(google.api.field_behavior)": "REQUIRED" + } + }, + "parameters": { + "type": "google.protobuf.Value", + "id": 4 + }, + "explanationSpecOverride": { + "type": "ExplanationSpecOverride", + "id": 5 + }, + "deployedModelId": { + "type": "string", + "id": 3 + } + } + }, + "ExplainResponse": { + "fields": { + "explanations": { + "rule": "repeated", + "type": "Explanation", + "id": 1 + }, + "deployedModelId": { + "type": "string", + "id": 2 + }, + "predictions": { + "rule": "repeated", + "type": "google.protobuf.Value", + "id": 3 + } + } + }, + "Schedule": { + "options": { + "(google.api.resource).type": "aiplatform.googleapis.com/Schedule", + "(google.api.resource).pattern": "projects/{project}/locations/{location}/schedules/{schedule}" + }, + "oneofs": { + "timeSpecification": { + "oneof": [ + "cron" + ] + }, + "request": { + "oneof": [ + "createPipelineJobRequest" + ] + } + }, + "fields": { + "cron": { + "type": "string", + "id": 10 + }, + "createPipelineJobRequest": { + "type": "CreatePipelineJobRequest", + "id": 14 + }, + "name": { + "type": "string", + "id": 1, + "options": { + "(google.api.field_behavior)": "OUTPUT_ONLY" + } + }, + "displayName": { + "type": "string", + "id": 2, + "options": { + "(google.api.field_behavior)": "REQUIRED" + } + }, + "startTime": { + "type": "google.protobuf.Timestamp", + "id": 3, + "options": { + "(google.api.field_behavior)": "OPTIONAL" + } + }, + "endTime": { + "type": "google.protobuf.Timestamp", + "id": 4, + "options": { + "(google.api.field_behavior)": "OPTIONAL" + } + }, + "maxRunCount": { + "type": "int64", + "id": 16, + "options": { + "(google.api.field_behavior)": "OPTIONAL" + } + }, + "startedRunCount": { + "type": "int64", + "id": 17, + "options": { + "(google.api.field_behavior)": "OUTPUT_ONLY" + } + }, + "state": { + "type": "State", + "id": 5, + "options": { + "(google.api.field_behavior)": "OUTPUT_ONLY" + } + }, + "createTime": { + "type": "google.protobuf.Timestamp", + "id": 6, + "options": { + "(google.api.field_behavior)": "OUTPUT_ONLY" + } + }, + "updateTime": { + "type": "google.protobuf.Timestamp", + "id": 19, + "options": { + "(google.api.field_behavior)": "OUTPUT_ONLY" + } + }, + "nextRunTime": { + "type": "google.protobuf.Timestamp", + "id": 7, + "options": { + "(google.api.field_behavior)": "OUTPUT_ONLY" + } + }, + "lastPauseTime": { + "type": "google.protobuf.Timestamp", + "id": 8, + "options": { + "(google.api.field_behavior)": "OUTPUT_ONLY" + } + }, + "lastResumeTime": { + "type": "google.protobuf.Timestamp", + "id": 9, + "options": { + "(google.api.field_behavior)": "OUTPUT_ONLY" + } + }, + "maxConcurrentRunCount": { + "type": "int64", + "id": 11, + "options": { + "(google.api.field_behavior)": "REQUIRED" + } + }, + "allowQueueing": { + "type": "bool", + "id": 12, + "options": { + "(google.api.field_behavior)": "OPTIONAL" + } + }, + "catchUp": { + "type": "bool", + "id": 13, + "options": { + "(google.api.field_behavior)": "OUTPUT_ONLY" + } + }, + "lastScheduledRunResponse": { + "type": "RunResponse", + "id": 18, + "options": { + "(google.api.field_behavior)": "OUTPUT_ONLY" + } + } + }, + "nested": { + "RunResponse": { + "fields": { + "scheduledRunTime": { + "type": "google.protobuf.Timestamp", + "id": 1 + }, + "runResponse": { + "type": "string", + "id": 2 + } + } + }, + "State": { + "values": { + "STATE_UNSPECIFIED": 0, + "ACTIVE": 1, + "PAUSED": 2, + "COMPLETED": 3 + } + } + } + }, + "ScheduleService": { + "options": { + "(google.api.default_host)": "aiplatform.googleapis.com", + "(google.api.oauth_scopes)": "https://www.googleapis.com/auth/cloud-platform" + }, + "methods": { + "CreateSchedule": { + "requestType": "CreateScheduleRequest", + "responseType": "Schedule", + "options": { + "(google.api.http).post": "/v1/{parent=projects/*/locations/*}/schedules", + "(google.api.http).body": "schedule", + "(google.api.method_signature)": "parent,schedule" + }, + "parsedOptions": [ + { + "(google.api.http)": { + "post": "/v1/{parent=projects/*/locations/*}/schedules", + "body": "schedule" + } + }, + { + "(google.api.method_signature)": "parent,schedule" + } + ] + }, + "DeleteSchedule": { + "requestType": "DeleteScheduleRequest", + "responseType": "google.longrunning.Operation", + "options": { + "(google.api.http).delete": "/v1/{name=projects/*/locations/*/schedules/*}", + "(google.api.method_signature)": "name", + "(google.longrunning.operation_info).response_type": "google.protobuf.Empty", + "(google.longrunning.operation_info).metadata_type": "DeleteOperationMetadata" + }, + "parsedOptions": [ + { + "(google.api.http)": { + "delete": "/v1/{name=projects/*/locations/*/schedules/*}" + } + }, + { + "(google.api.method_signature)": "name" + }, + { + "(google.longrunning.operation_info)": { + "response_type": "google.protobuf.Empty", + "metadata_type": "DeleteOperationMetadata" + } + } + ] + }, + "GetSchedule": { + "requestType": "GetScheduleRequest", + "responseType": "Schedule", + "options": { + "(google.api.http).get": "/v1/{name=projects/*/locations/*/schedules/*}", + "(google.api.method_signature)": "name" + }, + "parsedOptions": [ + { + "(google.api.http)": { + "get": "/v1/{name=projects/*/locations/*/schedules/*}" + } + }, + { + "(google.api.method_signature)": "name" + } + ] + }, + "ListSchedules": { + "requestType": "ListSchedulesRequest", + "responseType": "ListSchedulesResponse", + "options": { + "(google.api.http).get": "/v1/{parent=projects/*/locations/*}/schedules", + "(google.api.method_signature)": "parent" + }, + "parsedOptions": [ + { + "(google.api.http)": { + "get": "/v1/{parent=projects/*/locations/*}/schedules" + } + }, + { + "(google.api.method_signature)": "parent" + } + ] + }, + "PauseSchedule": { + "requestType": "PauseScheduleRequest", + "responseType": "google.protobuf.Empty", + "options": { + "(google.api.http).post": "/v1/{name=projects/*/locations/*/schedules/*}:pause", + "(google.api.http).body": "*", + "(google.api.method_signature)": "name" + }, + "parsedOptions": [ + { + "(google.api.http)": { + "post": "/v1/{name=projects/*/locations/*/schedules/*}:pause", + "body": "*" + } + }, + { + "(google.api.method_signature)": "name" + } + ] + }, + "ResumeSchedule": { + "requestType": "ResumeScheduleRequest", + "responseType": "google.protobuf.Empty", + "options": { + "(google.api.http).post": "/v1/{name=projects/*/locations/*/schedules/*}:resume", + "(google.api.http).body": "*", + "(google.api.method_signature)": "name,catch_up" + }, + "parsedOptions": [ + { + "(google.api.http)": { + "post": "/v1/{name=projects/*/locations/*/schedules/*}:resume", + "body": "*" + } + }, + { + "(google.api.method_signature)": "name" + }, + { + "(google.api.method_signature)": "name,catch_up" + } + ] + }, + "UpdateSchedule": { + "requestType": "UpdateScheduleRequest", + "responseType": "Schedule", + "options": { + "(google.api.http).patch": "/v1/{schedule.name=projects/*/locations/*/schedules/*}", + "(google.api.http).body": "schedule", + "(google.api.method_signature)": "schedule,update_mask" + }, + "parsedOptions": [ + { + "(google.api.http)": { + "patch": "/v1/{schedule.name=projects/*/locations/*/schedules/*}", + "body": "schedule" + } + }, + { + "(google.api.method_signature)": "schedule,update_mask" } ] } } }, - "PredictRequest": { + "CreateScheduleRequest": { "fields": { - "endpoint": { + "parent": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", - "(google.api.resource_reference).type": "aiplatform.googleapis.com/Endpoint" + "(google.api.resource_reference).type": "locations.googleapis.com/Location" } }, - "instances": { - "rule": "repeated", - "type": "google.protobuf.Value", + "schedule": { + "type": "Schedule", "id": 2, "options": { "(google.api.field_behavior)": "REQUIRED" } - }, - "parameters": { - "type": "google.protobuf.Value", - "id": 3 } } }, - "PredictResponse": { + "GetScheduleRequest": { "fields": { - "predictions": { - "rule": "repeated", - "type": "google.protobuf.Value", - "id": 1 + "name": { + "type": "string", + "id": 1, + "options": { + "(google.api.field_behavior)": "REQUIRED", + "(google.api.resource_reference).type": "aiplatform.googleapis.com/Schedule" + } + } + } + }, + "ListSchedulesRequest": { + "fields": { + "parent": { + "type": "string", + "id": 1, + "options": { + "(google.api.field_behavior)": "REQUIRED", + "(google.api.resource_reference).type": "locations.googleapis.com/Location" + } }, - "deployedModelId": { + "filter": { "type": "string", "id": 2 }, - "model": { + "pageSize": { + "type": "int32", + "id": 3 + }, + "pageToken": { "type": "string", - "id": 3, - "options": { - "(google.api.field_behavior)": "OUTPUT_ONLY", - "(google.api.resource_reference).type": "aiplatform.googleapis.com/Model" - } + "id": 4 }, - "modelVersionId": { + "orderBy": { "type": "string", - "id": 5, - "options": { - "(google.api.field_behavior)": "OUTPUT_ONLY" - } + "id": 5 + } + } + }, + "ListSchedulesResponse": { + "fields": { + "schedules": { + "rule": "repeated", + "type": "Schedule", + "id": 1 }, - "modelDisplayName": { + "nextPageToken": { "type": "string", - "id": 4, + "id": 2 + } + } + }, + "DeleteScheduleRequest": { + "fields": { + "name": { + "type": "string", + "id": 1, "options": { - "(google.api.field_behavior)": "OUTPUT_ONLY" + "(google.api.field_behavior)": "REQUIRED", + "(google.api.resource_reference).type": "aiplatform.googleapis.com/Schedule" } } } }, - "RawPredictRequest": { + "PauseScheduleRequest": { "fields": { - "endpoint": { + "name": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", - "(google.api.resource_reference).type": "aiplatform.googleapis.com/Endpoint" + "(google.api.resource_reference).type": "aiplatform.googleapis.com/Schedule" } - }, - "httpBody": { - "type": "google.api.HttpBody", - "id": 2 } } }, - "ExplainRequest": { + "ResumeScheduleRequest": { "fields": { - "endpoint": { + "name": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", - "(google.api.resource_reference).type": "aiplatform.googleapis.com/Endpoint" + "(google.api.resource_reference).type": "aiplatform.googleapis.com/Schedule" } }, - "instances": { - "rule": "repeated", - "type": "google.protobuf.Value", + "catchUp": { + "type": "bool", "id": 2, "options": { - "(google.api.field_behavior)": "REQUIRED" + "(google.api.field_behavior)": "OPTIONAL" } - }, - "parameters": { - "type": "google.protobuf.Value", - "id": 4 - }, - "explanationSpecOverride": { - "type": "ExplanationSpecOverride", - "id": 5 - }, - "deployedModelId": { - "type": "string", - "id": 3 } } }, - "ExplainResponse": { + "UpdateScheduleRequest": { "fields": { - "explanations": { - "rule": "repeated", - "type": "Explanation", - "id": 1 - }, - "deployedModelId": { - "type": "string", - "id": 2 + "schedule": { + "type": "Schedule", + "id": 1, + "options": { + "(google.api.field_behavior)": "REQUIRED" + } }, - "predictions": { - "rule": "repeated", - "type": "google.protobuf.Value", - "id": 3 + "updateMask": { + "type": "google.protobuf.FieldMask", + "id": 2, + "options": { + "(google.api.field_behavior)": "REQUIRED" + } } } }, @@ -26132,6 +26735,97 @@ } } }, + "Tensor": { + "fields": { + "dtype": { + "type": "DataType", + "id": 1 + }, + "shape": { + "rule": "repeated", + "type": "int64", + "id": 2 + }, + "boolVal": { + "rule": "repeated", + "type": "bool", + "id": 3 + }, + "stringVal": { + "rule": "repeated", + "type": "string", + "id": 14 + }, + "bytesVal": { + "rule": "repeated", + "type": "bytes", + "id": 15 + }, + "floatVal": { + "rule": "repeated", + "type": "float", + "id": 5 + }, + "doubleVal": { + "rule": "repeated", + "type": "double", + "id": 6 + }, + "intVal": { + "rule": "repeated", + "type": "int32", + "id": 7 + }, + "int64Val": { + "rule": "repeated", + "type": "int64", + "id": 8 + }, + "uintVal": { + "rule": "repeated", + "type": "uint32", + "id": 9 + }, + "uint64Val": { + "rule": "repeated", + "type": "uint64", + "id": 10 + }, + "listVal": { + "rule": "repeated", + "type": "Tensor", + "id": 11 + }, + "structVal": { + "keyType": "string", + "type": "Tensor", + "id": 12 + }, + "tensorVal": { + "type": "bytes", + "id": 13 + } + }, + "nested": { + "DataType": { + "values": { + "DATA_TYPE_UNSPECIFIED": 0, + "BOOL": 1, + "STRING": 2, + "FLOAT": 3, + "DOUBLE": 4, + "INT8": 5, + "INT16": 6, + "INT32": 7, + "INT64": 8, + "UINT8": 9, + "UINT16": 10, + "UINT32": 11, + "UINT64": 12 + } + } + } + }, "FeaturestoreService": { "options": { "(google.api.default_host)": "aiplatform.googleapis.com", @@ -36988,6 +37682,29 @@ } ] }, + "ServerStreamingPredict": { + "requestType": "StreamingPredictRequest", + "responseType": "StreamingPredictResponse", + "responseStream": true, + "options": { + "(google.api.http).post": "/v1beta1/{endpoint=projects/*/locations/*/endpoints/*}:serverStreamingPredict", + "(google.api.http).body": "*", + "(google.api.http).additional_bindings.post": "/v1beta1/{endpoint=projects/*/locations/*/publishers/*/models/*}:serverStreamingPredict", + "(google.api.http).additional_bindings.body": "*" + }, + "parsedOptions": [ + { + "(google.api.http)": { + "post": "/v1beta1/{endpoint=projects/*/locations/*/endpoints/*}:serverStreamingPredict", + "body": "*", + "additional_bindings": { + "post": "/v1beta1/{endpoint=projects/*/locations/*/publishers/*/models/*}:serverStreamingPredict", + "body": "*" + } + } + } + ] + }, "Explain": { "requestType": "ExplainRequest", "responseType": "ExplainResponse", @@ -37066,6 +37783,13 @@ "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } + }, + "metadata": { + "type": "google.protobuf.Value", + "id": 6, + "options": { + "(google.api.field_behavior)": "OUTPUT_ONLY" + } } } }, @@ -37085,6 +37809,40 @@ } } }, + "StreamingPredictRequest": { + "fields": { + "endpoint": { + "type": "string", + "id": 1, + "options": { + "(google.api.field_behavior)": "REQUIRED", + "(google.api.resource_reference).type": "aiplatform.googleapis.com/Endpoint" + } + }, + "inputs": { + "rule": "repeated", + "type": "Tensor", + "id": 2 + }, + "parameters": { + "type": "Tensor", + "id": 3 + } + } + }, + "StreamingPredictResponse": { + "fields": { + "outputs": { + "rule": "repeated", + "type": "Tensor", + "id": 1 + }, + "parameters": { + "type": "Tensor", + "id": 2 + } + } + }, "ExplainRequest": { "fields": { "endpoint": { diff --git a/packages/google-cloud-aiplatform/samples/README.md b/packages/google-cloud-aiplatform/samples/README.md index a02060c0d53..bb032abe8f2 100644 --- a/packages/google-cloud-aiplatform/samples/README.md +++ b/packages/google-cloud-aiplatform/samples/README.md @@ -175,6 +175,14 @@ * [Prediction_service.explain](#prediction_service.explain) * [Prediction_service.predict](#prediction_service.predict) * [Prediction_service.raw_predict](#prediction_service.raw_predict) + * [Prediction_service.server_streaming_predict](#prediction_service.server_streaming_predict) + * [Schedule_service.create_schedule](#schedule_service.create_schedule) + * [Schedule_service.delete_schedule](#schedule_service.delete_schedule) + * [Schedule_service.get_schedule](#schedule_service.get_schedule) + * [Schedule_service.list_schedules](#schedule_service.list_schedules) + * [Schedule_service.pause_schedule](#schedule_service.pause_schedule) + * [Schedule_service.resume_schedule](#schedule_service.resume_schedule) + * [Schedule_service.update_schedule](#schedule_service.update_schedule) * [Specialist_pool_service.create_specialist_pool](#specialist_pool_service.create_specialist_pool) * [Specialist_pool_service.delete_specialist_pool](#specialist_pool_service.delete_specialist_pool) * [Specialist_pool_service.get_specialist_pool](#specialist_pool_service.get_specialist_pool) @@ -396,6 +404,7 @@ * [Prediction_service.explain](#prediction_service.explain) * [Prediction_service.predict](#prediction_service.predict) * [Prediction_service.raw_predict](#prediction_service.raw_predict) + * [Prediction_service.server_streaming_predict](#prediction_service.server_streaming_predict) * [Schedule_service.create_schedule](#schedule_service.create_schedule) * [Schedule_service.delete_schedule](#schedule_service.delete_schedule) * [Schedule_service.get_schedule](#schedule_service.get_schedule) @@ -3241,6 +3250,142 @@ __Usage:__ +### Prediction_service.server_streaming_predict + +View the [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-aiplatform/samples/generated/v1/prediction_service.server_streaming_predict.js). + +[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-aiplatform/samples/generated/v1/prediction_service.server_streaming_predict.js,samples/README.md) + +__Usage:__ + + +`node packages/google-cloud-aiplatform/samples/generated/v1/prediction_service.server_streaming_predict.js` + + +----- + + + + +### Schedule_service.create_schedule + +View the [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.create_schedule.js). + +[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.create_schedule.js,samples/README.md) + +__Usage:__ + + +`node packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.create_schedule.js` + + +----- + + + + +### Schedule_service.delete_schedule + +View the [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.delete_schedule.js). + +[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.delete_schedule.js,samples/README.md) + +__Usage:__ + + +`node packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.delete_schedule.js` + + +----- + + + + +### Schedule_service.get_schedule + +View the [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.get_schedule.js). + +[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.get_schedule.js,samples/README.md) + +__Usage:__ + + +`node packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.get_schedule.js` + + +----- + + + + +### Schedule_service.list_schedules + +View the [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.list_schedules.js). + +[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.list_schedules.js,samples/README.md) + +__Usage:__ + + +`node packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.list_schedules.js` + + +----- + + + + +### Schedule_service.pause_schedule + +View the [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.pause_schedule.js). + +[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.pause_schedule.js,samples/README.md) + +__Usage:__ + + +`node packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.pause_schedule.js` + + +----- + + + + +### Schedule_service.resume_schedule + +View the [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.resume_schedule.js). + +[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.resume_schedule.js,samples/README.md) + +__Usage:__ + + +`node packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.resume_schedule.js` + + +----- + + + + +### Schedule_service.update_schedule + +View the [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.update_schedule.js). + +[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.update_schedule.js,samples/README.md) + +__Usage:__ + + +`node packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.update_schedule.js` + + +----- + + + + ### Specialist_pool_service.create_specialist_pool View the [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-aiplatform/samples/generated/v1/specialist_pool_service.create_specialist_pool.js). @@ -6998,6 +7143,23 @@ __Usage:__ +### Prediction_service.server_streaming_predict + +View the [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-aiplatform/samples/generated/v1beta1/prediction_service.server_streaming_predict.js). + +[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-aiplatform/samples/generated/v1beta1/prediction_service.server_streaming_predict.js,samples/README.md) + +__Usage:__ + + +`node packages/google-cloud-aiplatform/samples/generated/v1beta1/prediction_service.server_streaming_predict.js` + + +----- + + + + ### Schedule_service.create_schedule View the [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-aiplatform/samples/generated/v1beta1/schedule_service.create_schedule.js). diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/dataset_service.import_data.js b/packages/google-cloud-aiplatform/samples/generated/v1/dataset_service.import_data.js index 44bf6b741a2..b836bb5048a 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1/dataset_service.import_data.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1/dataset_service.import_data.js @@ -38,7 +38,7 @@ function main(name, importConfigs) { * Required. The desired input locations. The contents of all input locations * will be imported in one batch. */ - // const importConfigs = 1234 + // const importConfigs = [1,2,3,4] // Imports the Aiplatform library const {DatasetServiceClient} = require('@google-cloud/aiplatform').v1; diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/dataset_service.search_data_items.js b/packages/google-cloud-aiplatform/samples/generated/v1/dataset_service.search_data_items.js index 16a5ad270ff..c0150cf1800 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1/dataset_service.search_data_items.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1/dataset_service.search_data_items.js @@ -83,7 +83,7 @@ function main(dataset) { * Must specify `saved_query_id=` - saved query id that annotations should * belong to. */ - // const annotationFilters = 'abc123' + // const annotationFilters = ['abc','def'] /** * Mask specifying which fields of * DataItemView google.cloud.aiplatform.v1.DataItemView to read. diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/endpoint_service.deploy_model.js b/packages/google-cloud-aiplatform/samples/generated/v1/endpoint_service.deploy_model.js index 615edb73165..2a9a6e1a403 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1/endpoint_service.deploy_model.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1/endpoint_service.deploy_model.js @@ -55,7 +55,7 @@ function main(endpoint, deployedModel) { * traffic_split google.cloud.aiplatform.v1.Endpoint.traffic_split is not * updated. */ - // const trafficSplit = 1234 + // const trafficSplit = [1,2,3,4] // Imports the Aiplatform library const {EndpointServiceClient} = require('@google-cloud/aiplatform').v1; diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/endpoint_service.undeploy_model.js b/packages/google-cloud-aiplatform/samples/generated/v1/endpoint_service.undeploy_model.js index 92dba5b524e..ff8631a42ac 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1/endpoint_service.undeploy_model.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1/endpoint_service.undeploy_model.js @@ -47,7 +47,7 @@ function main(endpoint, deployedModelId) { * doesn't have any traffic assigned to it when this method executes, or if * this field unassigns any traffic to it. */ - // const trafficSplit = 1234 + // const trafficSplit = [1,2,3,4] // Imports the Aiplatform library const {EndpointServiceClient} = require('@google-cloud/aiplatform').v1; diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_online_serving_service.streaming_read_feature_values.js b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_online_serving_service.streaming_read_feature_values.js index f5d3994a05a..d2b37bb4190 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_online_serving_service.streaming_read_feature_values.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_online_serving_service.streaming_read_feature_values.js @@ -42,7 +42,7 @@ function main(entityType, entityIds, featureSelector) { * IDs is 100. For example, for a machine learning model predicting user * clicks on a website, an entity ID could be `user_123`. */ - // const entityIds = 'abc123' + // const entityIds = ['abc','def'] /** * Required. Selector choosing Features of the target EntityType. Feature IDs * will be deduplicated. diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_online_serving_service.write_feature_values.js b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_online_serving_service.write_feature_values.js index 04ebb53c6ce..898492d2dba 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_online_serving_service.write_feature_values.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_online_serving_service.write_feature_values.js @@ -41,7 +41,7 @@ function main(entityType, payloads) { * Required. The entities to be written. Up to 100,000 feature values can be * written across all `payloads`. */ - // const payloads = 1234 + // const payloads = [1,2,3,4] // Imports the Aiplatform library const {FeaturestoreOnlineServingServiceClient} = require('@google-cloud/aiplatform').v1; diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.batch_create_features.js b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.batch_create_features.js index af3c004559a..d30b39e76a9 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.batch_create_features.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.batch_create_features.js @@ -41,7 +41,7 @@ function main(parent, requests) { * child request, then the value must match the `parent` value in this request * message. */ - // const requests = 1234 + // const requests = [1,2,3,4] // Imports the Aiplatform library const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1; diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.batch_read_feature_values.js b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.batch_read_feature_values.js index b07a09d510b..1ddff3403e5 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.batch_read_feature_values.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.batch_read_feature_values.js @@ -70,12 +70,12 @@ function main(featurestore, destination, entityTypeSpecs) { * automatically inferred. For CSV source, the pass-through values will be * passed as opaque bytes. */ - // const passThroughFields = 1234 + // const passThroughFields = [1,2,3,4] /** * Required. Specifies EntityType grouping Features to read values of and * settings. */ - // const entityTypeSpecs = 1234 + // const entityTypeSpecs = [1,2,3,4] /** * Optional. Excludes Feature values with feature generation timestamp before * this timestamp. If not set, retrieve oldest values kept in Feature Store. diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.export_feature_values.js b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.export_feature_values.js index 4f2572c668d..77e1f2963e1 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.export_feature_values.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.export_feature_values.js @@ -55,7 +55,7 @@ function main(entityType, destination, featureSelector) { /** * Per-Feature export settings. */ - // const settings = 1234 + // const settings = [1,2,3,4] // Imports the Aiplatform library const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1; diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.import_feature_values.js b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.import_feature_values.js index be61c3c19d2..21af06130b8 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.import_feature_values.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.import_feature_values.js @@ -63,7 +63,7 @@ function main(entityType, featureSpecs) { * entity. The request fails if no feature_specs are provided, and having * multiple feature_specs for one Feature is not allowed. */ - // const featureSpecs = 1234 + // const featureSpecs = [1,2,3,4] /** * If set, data will not be imported for online serving. This * is typically used for backfilling, where Feature generation timestamps are diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/index_service.remove_datapoints.js b/packages/google-cloud-aiplatform/samples/generated/v1/index_service.remove_datapoints.js index 4d5f4f26775..638e0404a5c 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1/index_service.remove_datapoints.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1/index_service.remove_datapoints.js @@ -37,7 +37,7 @@ function main(index) { /** * A list of datapoint ids to be deleted. */ - // const datapointIds = 'abc123' + // const datapointIds = ['abc','def'] // Imports the Aiplatform library const {IndexServiceClient} = require('@google-cloud/aiplatform').v1; diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/index_service.upsert_datapoints.js b/packages/google-cloud-aiplatform/samples/generated/v1/index_service.upsert_datapoints.js index 96dd27c0e06..814de369f37 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1/index_service.upsert_datapoints.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1/index_service.upsert_datapoints.js @@ -37,7 +37,7 @@ function main(index) { /** * A list of datapoints to be created/updated. */ - // const datapoints = 1234 + // const datapoints = [1,2,3,4] // Imports the Aiplatform library const {IndexServiceClient} = require('@google-cloud/aiplatform').v1; diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/job_service.search_model_deployment_monitoring_stats_anomalies.js b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.search_model_deployment_monitoring_stats_anomalies.js index 66cd739cfa6..8a9d2bcfac5 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1/job_service.search_model_deployment_monitoring_stats_anomalies.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.search_model_deployment_monitoring_stats_anomalies.js @@ -49,7 +49,7 @@ function main(modelDeploymentMonitoringJob, deployedModelId, objectives) { /** * Required. Objectives of the stats to retrieve. */ - // const objectives = 1234 + // const objectives = [1,2,3,4] /** * The standard list page size. */ diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/match_service.find_neighbors.js b/packages/google-cloud-aiplatform/samples/generated/v1/match_service.find_neighbors.js index 10e858026fb..93c5b107e7e 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1/match_service.find_neighbors.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1/match_service.find_neighbors.js @@ -46,7 +46,7 @@ function main(indexEndpoint) { /** * The list of queries. */ - // const queries = 1234 + // const queries = [1,2,3,4] /** * If set to true, the full datapoints (including all vector values and * restricts) of the nearest neighbors are returned. diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/match_service.read_index_datapoints.js b/packages/google-cloud-aiplatform/samples/generated/v1/match_service.read_index_datapoints.js index 3cddeb89767..e77afa02400 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1/match_service.read_index_datapoints.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1/match_service.read_index_datapoints.js @@ -41,7 +41,7 @@ function main(indexEndpoint) { /** * IDs of the datapoints to be searched for. */ - // const ids = 'abc123' + // const ids = ['abc','def'] // Imports the Aiplatform library const {MatchServiceClient} = require('@google-cloud/aiplatform').v1; diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.add_context_artifacts_and_executions.js b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.add_context_artifacts_and_executions.js index 8eed91b6b01..3e1c719ba33 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.add_context_artifacts_and_executions.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.add_context_artifacts_and_executions.js @@ -39,14 +39,14 @@ function main(context) { * Format: * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` */ - // const artifacts = 'abc123' + // const artifacts = ['abc','def'] /** * The resource names of the Executions to associate with the * Context. * Format: * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` */ - // const executions = 'abc123' + // const executions = ['abc','def'] // Imports the Aiplatform library const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1; diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.add_context_children.js b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.add_context_children.js index 591c72a7523..b22224f6c4d 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.add_context_children.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.add_context_children.js @@ -37,7 +37,7 @@ function main(context) { /** * The resource names of the child Contexts. */ - // const childContexts = 'abc123' + // const childContexts = ['abc','def'] // Imports the Aiplatform library const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1; diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.add_execution_events.js b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.add_execution_events.js index 8d09f93968c..463b39ffbe3 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.add_execution_events.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.add_execution_events.js @@ -38,7 +38,7 @@ function main(execution) { /** * The Events to create and add. */ - // const events = 1234 + // const events = [1,2,3,4] // Imports the Aiplatform library const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1; diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.remove_context_children.js b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.remove_context_children.js index ada0b7bb5a1..adb88c09345 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.remove_context_children.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.remove_context_children.js @@ -37,7 +37,7 @@ function main(context) { /** * The resource names of the child Contexts. */ - // const childContexts = 'abc123' + // const childContexts = ['abc','def'] // Imports the Aiplatform library const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1; diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/migration_service.batch_migrate_resources.js b/packages/google-cloud-aiplatform/samples/generated/v1/migration_service.batch_migrate_resources.js index 59335195c83..963dd9852e9 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1/migration_service.batch_migrate_resources.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1/migration_service.batch_migrate_resources.js @@ -38,7 +38,7 @@ function main(parent, migrateResourceRequests) { * They must be in the same location as the destination. * Up to 50 resources can be migrated in one batch. */ - // const migrateResourceRequests = 1234 + // const migrateResourceRequests = [1,2,3,4] // Imports the Aiplatform library const {MigrationServiceClient} = require('@google-cloud/aiplatform').v1; diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/model_service.batch_import_evaluated_annotations.js b/packages/google-cloud-aiplatform/samples/generated/v1/model_service.batch_import_evaluated_annotations.js index f173b6c2489..edbf1be9f34 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1/model_service.batch_import_evaluated_annotations.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1/model_service.batch_import_evaluated_annotations.js @@ -37,7 +37,7 @@ function main(parent, evaluatedAnnotations) { /** * Required. Evaluated annotations resource to be imported. */ - // const evaluatedAnnotations = 1234 + // const evaluatedAnnotations = [1,2,3,4] // Imports the Aiplatform library const {ModelServiceClient} = require('@google-cloud/aiplatform').v1; diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/model_service.batch_import_model_evaluation_slices.js b/packages/google-cloud-aiplatform/samples/generated/v1/model_service.batch_import_model_evaluation_slices.js index 443a660252f..012413f470c 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1/model_service.batch_import_model_evaluation_slices.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1/model_service.batch_import_model_evaluation_slices.js @@ -37,7 +37,7 @@ function main(parent, modelEvaluationSlices) { /** * Required. Model evaluation slice resource to be imported. */ - // const modelEvaluationSlices = 1234 + // const modelEvaluationSlices = [1,2,3,4] // Imports the Aiplatform library const {ModelServiceClient} = require('@google-cloud/aiplatform').v1; diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/model_service.merge_version_aliases.js b/packages/google-cloud-aiplatform/samples/generated/v1/model_service.merge_version_aliases.js index 726a497ea51..b9153357146 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1/model_service.merge_version_aliases.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1/model_service.merge_version_aliases.js @@ -47,7 +47,7 @@ function main(name, versionAliases) { * alias in the request is not recommended, and the 2 operations will be * cancelled out. */ - // const versionAliases = 'abc123' + // const versionAliases = ['abc','def'] // Imports the Aiplatform library const {ModelServiceClient} = require('@google-cloud/aiplatform').v1; diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/prediction_service.explain.js b/packages/google-cloud-aiplatform/samples/generated/v1/prediction_service.explain.js index d295de04288..ecb04bc9114 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1/prediction_service.explain.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1/prediction_service.explain.js @@ -45,7 +45,7 @@ function main(endpoint, instances) { * PredictSchemata's google.cloud.aiplatform.v1.Model.predict_schemata * instance_schema_uri google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri. */ - // const instances = 1234 + // const instances = [1,2,3,4] /** * The parameters that govern the prediction. The schema of the parameters may * be specified via Endpoint's DeployedModels' Model's diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/prediction_service.predict.js b/packages/google-cloud-aiplatform/samples/generated/v1/prediction_service.predict.js index e3190b754e5..3e26bda9371 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1/prediction_service.predict.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1/prediction_service.predict.js @@ -45,7 +45,7 @@ function main(endpoint, instances) { * PredictSchemata's google.cloud.aiplatform.v1.Model.predict_schemata * instance_schema_uri google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri. */ - // const instances = 1234 + // const instances = [1,2,3,4] /** * The parameters that govern the prediction. The schema of the parameters may * be specified via Endpoint's DeployedModels' Model's diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/prediction_service.server_streaming_predict.js b/packages/google-cloud-aiplatform/samples/generated/v1/prediction_service.server_streaming_predict.js new file mode 100644 index 00000000000..d79e35ec657 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/prediction_service.server_streaming_predict.js @@ -0,0 +1,73 @@ +// Copyright 2023 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. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(endpoint) { + // [START aiplatform_v1_generated_PredictionService_ServerStreamingPredict_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Endpoint requested to serve the prediction. + * Format: + * `projects/{project}/locations/{location}/endpoints/{endpoint}` + */ + // const endpoint = 'abc123' + /** + * The prediction input. + */ + // const inputs = [1,2,3,4] + /** + * The parameters that govern the prediction. + */ + // const parameters = {} + + // Imports the Aiplatform library + const {PredictionServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new PredictionServiceClient(); + + async function callServerStreamingPredict() { + // Construct request + const request = { + endpoint, + }; + + // Run request + const stream = await aiplatformClient.serverStreamingPredict(request); + stream.on('data', (response) => { console.log(response) }); + stream.on('error', (err) => { throw(err) }); + stream.on('end', () => { /* API call completed */ }); + } + + callServerStreamingPredict(); + // [END aiplatform_v1_generated_PredictionService_ServerStreamingPredict_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.create_schedule.js b/packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.create_schedule.js new file mode 100644 index 00000000000..39a269e2b05 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.create_schedule.js @@ -0,0 +1,67 @@ +// Copyright 2023 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. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, schedule) { + // [START aiplatform_v1_generated_ScheduleService_CreateSchedule_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to create the Schedule in. + * Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Required. The Schedule to create. + */ + // const schedule = {} + + // Imports the Aiplatform library + const {ScheduleServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new ScheduleServiceClient(); + + async function callCreateSchedule() { + // Construct request + const request = { + parent, + schedule, + }; + + // Run request + const response = await aiplatformClient.createSchedule(request); + console.log(response); + } + + callCreateSchedule(); + // [END aiplatform_v1_generated_ScheduleService_CreateSchedule_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.delete_schedule.js b/packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.delete_schedule.js new file mode 100644 index 00000000000..1c741af73c4 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.delete_schedule.js @@ -0,0 +1,64 @@ +// Copyright 2023 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. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_ScheduleService_DeleteSchedule_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Schedule resource to be deleted. + * Format: + * `projects/{project}/locations/{location}/schedules/{schedule}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {ScheduleServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new ScheduleServiceClient(); + + async function callDeleteSchedule() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteSchedule(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteSchedule(); + // [END aiplatform_v1_generated_ScheduleService_DeleteSchedule_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.get_schedule.js b/packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.get_schedule.js new file mode 100644 index 00000000000..af126ccf535 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.get_schedule.js @@ -0,0 +1,63 @@ +// Copyright 2023 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. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_ScheduleService_GetSchedule_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Schedule resource. + * Format: + * `projects/{project}/locations/{location}/schedules/{schedule}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {ScheduleServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new ScheduleServiceClient(); + + async function callGetSchedule() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getSchedule(request); + console.log(response); + } + + callGetSchedule(); + // [END aiplatform_v1_generated_ScheduleService_GetSchedule_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.list_schedules.js b/packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.list_schedules.js new file mode 100644 index 00000000000..ed828a4d50b --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.list_schedules.js @@ -0,0 +1,122 @@ +// Copyright 2023 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. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1_generated_ScheduleService_ListSchedules_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to list the Schedules from. + * Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Lists the Schedules that match the filter expression. The following + * fields are supported: + * * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. + * * `state`: Supports `=` and `!=` comparisons. + * * `request`: Supports existence of the check. + * (e.g. `create_pipeline_job_request:*` --> Schedule has + * create_pipeline_job_request). + * * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. + * Values must be in RFC 3339 format. + * * `start_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. + * Values must be in RFC 3339 format. + * * `end_time`: Supports `=`, `!=`, `<`, `>`, `<=`, `>=` comparisons and `:*` + * existence check. Values must be in RFC 3339 format. + * * `next_run_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` + * comparisons. Values must be in RFC 3339 format. + * Filter expressions can be combined together using logical operators + * (`NOT`, `AND` & `OR`). + * The syntax to define filter expression is based on + * https://google.aip.dev/160. + * Examples: + * * `state="ACTIVE" AND display_name:"my_schedule_*"` + * * `NOT display_name="my_schedule"` + * * `create_time>"2021-05-18T00:00:00Z"` + * * `end_time>"2021-05-18T00:00:00Z" OR NOT end_time:*` + * * `create_pipeline_job_request:*` + */ + // const filter = 'abc123' + /** + * The standard list page size. + * Default to 100 if not specified. + */ + // const pageSize = 1234 + /** + * The standard list page token. + * Typically obtained via + * ListSchedulesResponse.next_page_token google.cloud.aiplatform.v1.ListSchedulesResponse.next_page_token + * of the previous + * ScheduleService.ListSchedules google.cloud.aiplatform.v1.ScheduleService.ListSchedules + * call. + */ + // const pageToken = 'abc123' + /** + * A comma-separated list of fields to order by. The default sort order is in + * ascending order. Use "desc" after a field name for descending. You can have + * multiple order_by fields provided. + * For example, using "create_time desc, end_time" will order results by + * create time in descending order, and if there are multiple schedules having + * the same create time, order them by the end time in ascending order. + * If order_by is not specified, it will order by default with create_time in + * descending order. + * Supported fields: + * * `create_time` + * * `start_time` + * * `end_time` + * * `next_run_time` + */ + // const orderBy = 'abc123' + + // Imports the Aiplatform library + const {ScheduleServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new ScheduleServiceClient(); + + async function callListSchedules() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listSchedulesAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListSchedules(); + // [END aiplatform_v1_generated_ScheduleService_ListSchedules_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.pause_schedule.js b/packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.pause_schedule.js new file mode 100644 index 00000000000..67f0e500456 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.pause_schedule.js @@ -0,0 +1,63 @@ +// Copyright 2023 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. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_ScheduleService_PauseSchedule_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Schedule resource to be paused. + * Format: + * `projects/{project}/locations/{location}/schedules/{schedule}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {ScheduleServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new ScheduleServiceClient(); + + async function callPauseSchedule() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.pauseSchedule(request); + console.log(response); + } + + callPauseSchedule(); + // [END aiplatform_v1_generated_ScheduleService_PauseSchedule_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.resume_schedule.js b/packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.resume_schedule.js new file mode 100644 index 00000000000..cf037c58bf5 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.resume_schedule.js @@ -0,0 +1,71 @@ +// Copyright 2023 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. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_ScheduleService_ResumeSchedule_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Schedule resource to be resumed. + * Format: + * `projects/{project}/locations/{location}/schedules/{schedule}` + */ + // const name = 'abc123' + /** + * Optional. Whether to backfill missed runs when the schedule is resumed from + * PAUSED state. If set to true, all missed runs will be scheduled. New runs + * will be scheduled after the backfill is complete. This will also update + * Schedule.catch_up google.cloud.aiplatform.v1.Schedule.catch_up field. + * Default to false. + */ + // const catchUp = true + + // Imports the Aiplatform library + const {ScheduleServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new ScheduleServiceClient(); + + async function callResumeSchedule() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.resumeSchedule(request); + console.log(response); + } + + callResumeSchedule(); + // [END aiplatform_v1_generated_ScheduleService_ResumeSchedule_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.update_schedule.js b/packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.update_schedule.js new file mode 100644 index 00000000000..12d7e4ce50e --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/schedule_service.update_schedule.js @@ -0,0 +1,70 @@ +// Copyright 2023 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. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(schedule, updateMask) { + // [START aiplatform_v1_generated_ScheduleService_UpdateSchedule_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The Schedule which replaces the resource on the server. + * The following restrictions will be applied: + * * The scheduled request type cannot be changed. + * * The output_only fields will be ignored if specified. + */ + // const schedule = {} + /** + * Required. The update mask applies to the resource. See + * google.protobuf.FieldMask google.protobuf.FieldMask. + */ + // const updateMask = {} + + // Imports the Aiplatform library + const {ScheduleServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new ScheduleServiceClient(); + + async function callUpdateSchedule() { + // Construct request + const request = { + schedule, + updateMask, + }; + + // Run request + const response = await aiplatformClient.updateSchedule(request); + console.log(response); + } + + callUpdateSchedule(); + // [END aiplatform_v1_generated_ScheduleService_UpdateSchedule_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/snippet_metadata.google.cloud.aiplatform.v1.json b/packages/google-cloud-aiplatform/samples/generated/v1/snippet_metadata.google.cloud.aiplatform.v1.json index 103d3b05205..c6a6a87aadc 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1/snippet_metadata.google.cloud.aiplatform.v1.json +++ b/packages/google-cloud-aiplatform/samples/generated/v1/snippet_metadata.google.cloud.aiplatform.v1.json @@ -7663,6 +7663,314 @@ } } }, + { + "regionTag": "aiplatform_v1_generated_ScheduleService_CreateSchedule_async", + "title": "DatasetService createSchedule Sample", + "origin": "API_DEFINITION", + "description": " Creates a Schedule.", + "canonical": true, + "file": "schedule_service.create_schedule.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateSchedule", + "fullName": "google.cloud.aiplatform.v1.ScheduleService.CreateSchedule", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "schedule", + "type": ".google.cloud.aiplatform.v1.Schedule" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Schedule", + "client": { + "shortName": "ScheduleServiceClient", + "fullName": "google.cloud.aiplatform.v1.ScheduleServiceClient" + }, + "method": { + "shortName": "CreateSchedule", + "fullName": "google.cloud.aiplatform.v1.ScheduleService.CreateSchedule", + "service": { + "shortName": "ScheduleService", + "fullName": "google.cloud.aiplatform.v1.ScheduleService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ScheduleService_DeleteSchedule_async", + "title": "DatasetService deleteSchedule Sample", + "origin": "API_DEFINITION", + "description": " Deletes a Schedule.", + "canonical": true, + "file": "schedule_service.delete_schedule.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteSchedule", + "fullName": "google.cloud.aiplatform.v1.ScheduleService.DeleteSchedule", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ScheduleServiceClient", + "fullName": "google.cloud.aiplatform.v1.ScheduleServiceClient" + }, + "method": { + "shortName": "DeleteSchedule", + "fullName": "google.cloud.aiplatform.v1.ScheduleService.DeleteSchedule", + "service": { + "shortName": "ScheduleService", + "fullName": "google.cloud.aiplatform.v1.ScheduleService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ScheduleService_GetSchedule_async", + "title": "DatasetService getSchedule Sample", + "origin": "API_DEFINITION", + "description": " Gets a Schedule.", + "canonical": true, + "file": "schedule_service.get_schedule.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetSchedule", + "fullName": "google.cloud.aiplatform.v1.ScheduleService.GetSchedule", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Schedule", + "client": { + "shortName": "ScheduleServiceClient", + "fullName": "google.cloud.aiplatform.v1.ScheduleServiceClient" + }, + "method": { + "shortName": "GetSchedule", + "fullName": "google.cloud.aiplatform.v1.ScheduleService.GetSchedule", + "service": { + "shortName": "ScheduleService", + "fullName": "google.cloud.aiplatform.v1.ScheduleService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ScheduleService_ListSchedules_async", + "title": "DatasetService listSchedules Sample", + "origin": "API_DEFINITION", + "description": " Lists Schedules in a Location.", + "canonical": true, + "file": "schedule_service.list_schedules.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 114, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListSchedules", + "fullName": "google.cloud.aiplatform.v1.ScheduleService.ListSchedules", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListSchedulesResponse", + "client": { + "shortName": "ScheduleServiceClient", + "fullName": "google.cloud.aiplatform.v1.ScheduleServiceClient" + }, + "method": { + "shortName": "ListSchedules", + "fullName": "google.cloud.aiplatform.v1.ScheduleService.ListSchedules", + "service": { + "shortName": "ScheduleService", + "fullName": "google.cloud.aiplatform.v1.ScheduleService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ScheduleService_PauseSchedule_async", + "title": "DatasetService pauseSchedule Sample", + "origin": "API_DEFINITION", + "description": " Pauses a Schedule. Will mark [Schedule.state][google.cloud.aiplatform.v1.Schedule.state] to 'PAUSED'. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled.", + "canonical": true, + "file": "schedule_service.pause_schedule.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "PauseSchedule", + "fullName": "google.cloud.aiplatform.v1.ScheduleService.PauseSchedule", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "ScheduleServiceClient", + "fullName": "google.cloud.aiplatform.v1.ScheduleServiceClient" + }, + "method": { + "shortName": "PauseSchedule", + "fullName": "google.cloud.aiplatform.v1.ScheduleService.PauseSchedule", + "service": { + "shortName": "ScheduleService", + "fullName": "google.cloud.aiplatform.v1.ScheduleService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ScheduleService_ResumeSchedule_async", + "title": "DatasetService resumeSchedule Sample", + "origin": "API_DEFINITION", + "description": " Resumes a paused Schedule to start scheduling new runs. Will mark [Schedule.state][google.cloud.aiplatform.v1.Schedule.state] to 'ACTIVE'. Only paused Schedule can be resumed. When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If [Schedule.catchUp][] is set up true, all missed runs will be scheduled for backfill first.", + "canonical": true, + "file": "schedule_service.resume_schedule.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ResumeSchedule", + "fullName": "google.cloud.aiplatform.v1.ScheduleService.ResumeSchedule", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "catch_up", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "ScheduleServiceClient", + "fullName": "google.cloud.aiplatform.v1.ScheduleServiceClient" + }, + "method": { + "shortName": "ResumeSchedule", + "fullName": "google.cloud.aiplatform.v1.ScheduleService.ResumeSchedule", + "service": { + "shortName": "ScheduleService", + "fullName": "google.cloud.aiplatform.v1.ScheduleService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ScheduleService_UpdateSchedule_async", + "title": "DatasetService updateSchedule Sample", + "origin": "API_DEFINITION", + "description": " Updates an active or paused Schedule. When the Schedule is updated, new runs will be scheduled starting from the updated next execution time after the update time based on the time_specification in the updated Schedule. All unstarted runs before the update time will be skipped while already created runs will NOT be paused or canceled.", + "canonical": true, + "file": "schedule_service.update_schedule.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateSchedule", + "fullName": "google.cloud.aiplatform.v1.ScheduleService.UpdateSchedule", + "async": true, + "parameters": [ + { + "name": "schedule", + "type": ".google.cloud.aiplatform.v1.Schedule" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Schedule", + "client": { + "shortName": "ScheduleServiceClient", + "fullName": "google.cloud.aiplatform.v1.ScheduleServiceClient" + }, + "method": { + "shortName": "UpdateSchedule", + "fullName": "google.cloud.aiplatform.v1.ScheduleService.UpdateSchedule", + "service": { + "shortName": "ScheduleService", + "fullName": "google.cloud.aiplatform.v1.ScheduleService" + } + } + } + }, { "regionTag": "aiplatform_v1_generated_SpecialistPoolService_CreateSpecialistPool_async", "title": "DatasetService createSpecialistPool Sample", diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/snippet_metadata_google.cloud.aiplatform.v1.json b/packages/google-cloud-aiplatform/samples/generated/v1/snippet_metadata_google.cloud.aiplatform.v1.json new file mode 100644 index 00000000000..c10ed790ab3 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/snippet_metadata_google.cloud.aiplatform.v1.json @@ -0,0 +1,10231 @@ +{ + "clientLibrary": { + "name": "nodejs-aiplatform", + "version": "2.17.0", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.aiplatform.v1", + "version": "v1" + } + ] + }, + "snippets": [ + { + "regionTag": "aiplatform_v1_generated_DatasetService_CreateDataset_async", + "title": "DatasetService createDataset Sample", + "origin": "API_DEFINITION", + "description": " Creates a Dataset.", + "canonical": true, + "file": "dataset_service.create_dataset.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateDataset", + "fullName": "google.cloud.aiplatform.v1.DatasetService.CreateDataset", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "dataset", + "type": ".google.cloud.aiplatform.v1.Dataset" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1.DatasetServiceClient" + }, + "method": { + "shortName": "CreateDataset", + "fullName": "google.cloud.aiplatform.v1.DatasetService.CreateDataset", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_DatasetService_GetDataset_async", + "title": "DatasetService getDataset Sample", + "origin": "API_DEFINITION", + "description": " Gets a Dataset.", + "canonical": true, + "file": "dataset_service.get_dataset.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 57, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetDataset", + "fullName": "google.cloud.aiplatform.v1.DatasetService.GetDataset", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Dataset", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1.DatasetServiceClient" + }, + "method": { + "shortName": "GetDataset", + "fullName": "google.cloud.aiplatform.v1.DatasetService.GetDataset", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_DatasetService_UpdateDataset_async", + "title": "DatasetService updateDataset Sample", + "origin": "API_DEFINITION", + "description": " Updates a Dataset.", + "canonical": true, + "file": "dataset_service.update_dataset.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateDataset", + "fullName": "google.cloud.aiplatform.v1.DatasetService.UpdateDataset", + "async": true, + "parameters": [ + { + "name": "dataset", + "type": ".google.cloud.aiplatform.v1.Dataset" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Dataset", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1.DatasetServiceClient" + }, + "method": { + "shortName": "UpdateDataset", + "fullName": "google.cloud.aiplatform.v1.DatasetService.UpdateDataset", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_DatasetService_ListDatasets_async", + "title": "DatasetService listDatasets Sample", + "origin": "API_DEFINITION", + "description": " Lists Datasets in a Location.", + "canonical": true, + "file": "dataset_service.list_datasets.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 91, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListDatasets", + "fullName": "google.cloud.aiplatform.v1.DatasetService.ListDatasets", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListDatasetsResponse", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1.DatasetServiceClient" + }, + "method": { + "shortName": "ListDatasets", + "fullName": "google.cloud.aiplatform.v1.DatasetService.ListDatasets", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_DatasetService_DeleteDataset_async", + "title": "DatasetService deleteDataset Sample", + "origin": "API_DEFINITION", + "description": " Deletes a Dataset.", + "canonical": true, + "file": "dataset_service.delete_dataset.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteDataset", + "fullName": "google.cloud.aiplatform.v1.DatasetService.DeleteDataset", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1.DatasetServiceClient" + }, + "method": { + "shortName": "DeleteDataset", + "fullName": "google.cloud.aiplatform.v1.DatasetService.DeleteDataset", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_DatasetService_ImportData_async", + "title": "DatasetService importData Sample", + "origin": "API_DEFINITION", + "description": " Imports data into a Dataset.", + "canonical": true, + "file": "dataset_service.import_data.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ImportData", + "fullName": "google.cloud.aiplatform.v1.DatasetService.ImportData", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "import_configs", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1.DatasetServiceClient" + }, + "method": { + "shortName": "ImportData", + "fullName": "google.cloud.aiplatform.v1.DatasetService.ImportData", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_DatasetService_ExportData_async", + "title": "DatasetService exportData Sample", + "origin": "API_DEFINITION", + "description": " Exports data from a Dataset.", + "canonical": true, + "file": "dataset_service.export_data.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ExportData", + "fullName": "google.cloud.aiplatform.v1.DatasetService.ExportData", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "export_config", + "type": ".google.cloud.aiplatform.v1.ExportDataConfig" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1.DatasetServiceClient" + }, + "method": { + "shortName": "ExportData", + "fullName": "google.cloud.aiplatform.v1.DatasetService.ExportData", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_DatasetService_ListDataItems_async", + "title": "DatasetService listDataItems Sample", + "origin": "API_DEFINITION", + "description": " Lists DataItems in a Dataset.", + "canonical": true, + "file": "dataset_service.list_data_items.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 78, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListDataItems", + "fullName": "google.cloud.aiplatform.v1.DatasetService.ListDataItems", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListDataItemsResponse", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1.DatasetServiceClient" + }, + "method": { + "shortName": "ListDataItems", + "fullName": "google.cloud.aiplatform.v1.DatasetService.ListDataItems", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_DatasetService_SearchDataItems_async", + "title": "DatasetService searchDataItems Sample", + "origin": "API_DEFINITION", + "description": " Searches DataItems in a Dataset.", + "canonical": true, + "file": "dataset_service.search_data_items.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 137, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SearchDataItems", + "fullName": "google.cloud.aiplatform.v1.DatasetService.SearchDataItems", + "async": true, + "parameters": [ + { + "name": "order_by_data_item", + "type": "TYPE_STRING" + }, + { + "name": "order_by_annotation", + "type": ".google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation" + }, + { + "name": "dataset", + "type": "TYPE_STRING" + }, + { + "name": "saved_query", + "type": "TYPE_STRING" + }, + { + "name": "data_labeling_job", + "type": "TYPE_STRING" + }, + { + "name": "data_item_filter", + "type": "TYPE_STRING" + }, + { + "name": "annotations_filter", + "type": "TYPE_STRING" + }, + { + "name": "annotation_filters", + "type": "TYPE_STRING[]" + }, + { + "name": "field_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "annotations_limit", + "type": "TYPE_INT32" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.SearchDataItemsResponse", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1.DatasetServiceClient" + }, + "method": { + "shortName": "SearchDataItems", + "fullName": "google.cloud.aiplatform.v1.DatasetService.SearchDataItems", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_DatasetService_ListSavedQueries_async", + "title": "DatasetService listSavedQueries Sample", + "origin": "API_DEFINITION", + "description": " Lists SavedQueries in a Dataset.", + "canonical": true, + "file": "dataset_service.list_saved_queries.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 78, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListSavedQueries", + "fullName": "google.cloud.aiplatform.v1.DatasetService.ListSavedQueries", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListSavedQueriesResponse", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1.DatasetServiceClient" + }, + "method": { + "shortName": "ListSavedQueries", + "fullName": "google.cloud.aiplatform.v1.DatasetService.ListSavedQueries", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_DatasetService_DeleteSavedQuery_async", + "title": "DatasetService deleteSavedQuery Sample", + "origin": "API_DEFINITION", + "description": " Deletes a SavedQuery.", + "canonical": true, + "file": "dataset_service.delete_saved_query.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteSavedQuery", + "fullName": "google.cloud.aiplatform.v1.DatasetService.DeleteSavedQuery", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1.DatasetServiceClient" + }, + "method": { + "shortName": "DeleteSavedQuery", + "fullName": "google.cloud.aiplatform.v1.DatasetService.DeleteSavedQuery", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_DatasetService_GetAnnotationSpec_async", + "title": "DatasetService getAnnotationSpec Sample", + "origin": "API_DEFINITION", + "description": " Gets an AnnotationSpec.", + "canonical": true, + "file": "dataset_service.get_annotation_spec.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetAnnotationSpec", + "fullName": "google.cloud.aiplatform.v1.DatasetService.GetAnnotationSpec", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.AnnotationSpec", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1.DatasetServiceClient" + }, + "method": { + "shortName": "GetAnnotationSpec", + "fullName": "google.cloud.aiplatform.v1.DatasetService.GetAnnotationSpec", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_DatasetService_ListAnnotations_async", + "title": "DatasetService listAnnotations Sample", + "origin": "API_DEFINITION", + "description": " Lists Annotations belongs to a dataitem", + "canonical": true, + "file": "dataset_service.list_annotations.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 78, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListAnnotations", + "fullName": "google.cloud.aiplatform.v1.DatasetService.ListAnnotations", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListAnnotationsResponse", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1.DatasetServiceClient" + }, + "method": { + "shortName": "ListAnnotations", + "fullName": "google.cloud.aiplatform.v1.DatasetService.ListAnnotations", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_EndpointService_CreateEndpoint_async", + "title": "DatasetService createEndpoint Sample", + "origin": "API_DEFINITION", + "description": " Creates an Endpoint.", + "canonical": true, + "file": "endpoint_service.create_endpoint.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateEndpoint", + "fullName": "google.cloud.aiplatform.v1.EndpointService.CreateEndpoint", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "endpoint", + "type": ".google.cloud.aiplatform.v1.Endpoint" + }, + { + "name": "endpoint_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "EndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1.EndpointServiceClient" + }, + "method": { + "shortName": "CreateEndpoint", + "fullName": "google.cloud.aiplatform.v1.EndpointService.CreateEndpoint", + "service": { + "shortName": "EndpointService", + "fullName": "google.cloud.aiplatform.v1.EndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_EndpointService_GetEndpoint_async", + "title": "DatasetService getEndpoint Sample", + "origin": "API_DEFINITION", + "description": " Gets an Endpoint.", + "canonical": true, + "file": "endpoint_service.get_endpoint.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetEndpoint", + "fullName": "google.cloud.aiplatform.v1.EndpointService.GetEndpoint", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Endpoint", + "client": { + "shortName": "EndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1.EndpointServiceClient" + }, + "method": { + "shortName": "GetEndpoint", + "fullName": "google.cloud.aiplatform.v1.EndpointService.GetEndpoint", + "service": { + "shortName": "EndpointService", + "fullName": "google.cloud.aiplatform.v1.EndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_EndpointService_ListEndpoints_async", + "title": "DatasetService listEndpoints Sample", + "origin": "API_DEFINITION", + "description": " Lists Endpoints in a Location.", + "canonical": true, + "file": "endpoint_service.list_endpoints.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 100, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListEndpoints", + "fullName": "google.cloud.aiplatform.v1.EndpointService.ListEndpoints", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListEndpointsResponse", + "client": { + "shortName": "EndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1.EndpointServiceClient" + }, + "method": { + "shortName": "ListEndpoints", + "fullName": "google.cloud.aiplatform.v1.EndpointService.ListEndpoints", + "service": { + "shortName": "EndpointService", + "fullName": "google.cloud.aiplatform.v1.EndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_EndpointService_UpdateEndpoint_async", + "title": "DatasetService updateEndpoint Sample", + "origin": "API_DEFINITION", + "description": " Updates an Endpoint.", + "canonical": true, + "file": "endpoint_service.update_endpoint.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateEndpoint", + "fullName": "google.cloud.aiplatform.v1.EndpointService.UpdateEndpoint", + "async": true, + "parameters": [ + { + "name": "endpoint", + "type": ".google.cloud.aiplatform.v1.Endpoint" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Endpoint", + "client": { + "shortName": "EndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1.EndpointServiceClient" + }, + "method": { + "shortName": "UpdateEndpoint", + "fullName": "google.cloud.aiplatform.v1.EndpointService.UpdateEndpoint", + "service": { + "shortName": "EndpointService", + "fullName": "google.cloud.aiplatform.v1.EndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_EndpointService_DeleteEndpoint_async", + "title": "DatasetService deleteEndpoint Sample", + "origin": "API_DEFINITION", + "description": " Deletes an Endpoint.", + "canonical": true, + "file": "endpoint_service.delete_endpoint.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteEndpoint", + "fullName": "google.cloud.aiplatform.v1.EndpointService.DeleteEndpoint", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "EndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1.EndpointServiceClient" + }, + "method": { + "shortName": "DeleteEndpoint", + "fullName": "google.cloud.aiplatform.v1.EndpointService.DeleteEndpoint", + "service": { + "shortName": "EndpointService", + "fullName": "google.cloud.aiplatform.v1.EndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_EndpointService_DeployModel_async", + "title": "DatasetService deployModel Sample", + "origin": "API_DEFINITION", + "description": " Deploys a Model into this Endpoint, creating a DeployedModel within it.", + "canonical": true, + "file": "endpoint_service.deploy_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeployModel", + "fullName": "google.cloud.aiplatform.v1.EndpointService.DeployModel", + "async": true, + "parameters": [ + { + "name": "endpoint", + "type": "TYPE_STRING" + }, + { + "name": "deployed_model", + "type": ".google.cloud.aiplatform.v1.DeployedModel" + }, + { + "name": "traffic_split", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "EndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1.EndpointServiceClient" + }, + "method": { + "shortName": "DeployModel", + "fullName": "google.cloud.aiplatform.v1.EndpointService.DeployModel", + "service": { + "shortName": "EndpointService", + "fullName": "google.cloud.aiplatform.v1.EndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_EndpointService_UndeployModel_async", + "title": "DatasetService undeployModel Sample", + "origin": "API_DEFINITION", + "description": " Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using.", + "canonical": true, + "file": "endpoint_service.undeploy_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UndeployModel", + "fullName": "google.cloud.aiplatform.v1.EndpointService.UndeployModel", + "async": true, + "parameters": [ + { + "name": "endpoint", + "type": "TYPE_STRING" + }, + { + "name": "deployed_model_id", + "type": "TYPE_STRING" + }, + { + "name": "traffic_split", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "EndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1.EndpointServiceClient" + }, + "method": { + "shortName": "UndeployModel", + "fullName": "google.cloud.aiplatform.v1.EndpointService.UndeployModel", + "service": { + "shortName": "EndpointService", + "fullName": "google.cloud.aiplatform.v1.EndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_EndpointService_MutateDeployedModel_async", + "title": "DatasetService mutateDeployedModel Sample", + "origin": "API_DEFINITION", + "description": " Updates an existing deployed model. Updatable fields include `min_replica_count`, `max_replica_count`, `autoscaling_metric_specs`, `disable_container_logging` (v1 only), and `enable_container_logging` (v1beta1 only).", + "canonical": true, + "file": "endpoint_service.mutate_deployed_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 77, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "MutateDeployedModel", + "fullName": "google.cloud.aiplatform.v1.EndpointService.MutateDeployedModel", + "async": true, + "parameters": [ + { + "name": "endpoint", + "type": "TYPE_STRING" + }, + { + "name": "deployed_model", + "type": ".google.cloud.aiplatform.v1.DeployedModel" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "EndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1.EndpointServiceClient" + }, + "method": { + "shortName": "MutateDeployedModel", + "fullName": "google.cloud.aiplatform.v1.EndpointService.MutateDeployedModel", + "service": { + "shortName": "EndpointService", + "fullName": "google.cloud.aiplatform.v1.EndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreOnlineServingService_ReadFeatureValues_async", + "title": "DatasetService readFeatureValues Sample", + "origin": "API_DEFINITION", + "description": " Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues.", + "canonical": true, + "file": "featurestore_online_serving_service.read_feature_values.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ReadFeatureValues", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreOnlineServingService.ReadFeatureValues", + "async": true, + "parameters": [ + { + "name": "entity_type", + "type": "TYPE_STRING" + }, + { + "name": "entity_id", + "type": "TYPE_STRING" + }, + { + "name": "feature_selector", + "type": ".google.cloud.aiplatform.v1.FeatureSelector" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ReadFeatureValuesResponse", + "client": { + "shortName": "FeaturestoreOnlineServingServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreOnlineServingServiceClient" + }, + "method": { + "shortName": "ReadFeatureValues", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreOnlineServingService.ReadFeatureValues", + "service": { + "shortName": "FeaturestoreOnlineServingService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreOnlineServingService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreOnlineServingService_StreamingReadFeatureValues_async", + "title": "DatasetService streamingReadFeatureValues Sample", + "origin": "API_DEFINITION", + "description": " Reads Feature values for multiple entities. Depending on their size, data for different entities may be broken up across multiple responses.", + "canonical": true, + "file": "featurestore_online_serving_service.streaming_read_feature_values.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 73, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "StreamingReadFeatureValues", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreOnlineServingService.StreamingReadFeatureValues", + "async": true, + "parameters": [ + { + "name": "entity_type", + "type": "TYPE_STRING" + }, + { + "name": "entity_ids", + "type": "TYPE_STRING[]" + }, + { + "name": "feature_selector", + "type": ".google.cloud.aiplatform.v1.FeatureSelector" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ReadFeatureValuesResponse", + "client": { + "shortName": "FeaturestoreOnlineServingServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreOnlineServingServiceClient" + }, + "method": { + "shortName": "StreamingReadFeatureValues", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreOnlineServingService.StreamingReadFeatureValues", + "service": { + "shortName": "FeaturestoreOnlineServingService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreOnlineServingService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreOnlineServingService_WriteFeatureValues_async", + "title": "DatasetService writeFeatureValues Sample", + "origin": "API_DEFINITION", + "description": " Writes Feature values of one or more entities of an EntityType. The Feature values are merged into existing entities if any. The Feature values to be written must have timestamp within the online storage retention.", + "canonical": true, + "file": "featurestore_online_serving_service.write_feature_values.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 64, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "WriteFeatureValues", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreOnlineServingService.WriteFeatureValues", + "async": true, + "parameters": [ + { + "name": "entity_type", + "type": "TYPE_STRING" + }, + { + "name": "payloads", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1.WriteFeatureValuesResponse", + "client": { + "shortName": "FeaturestoreOnlineServingServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreOnlineServingServiceClient" + }, + "method": { + "shortName": "WriteFeatureValues", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreOnlineServingService.WriteFeatureValues", + "service": { + "shortName": "FeaturestoreOnlineServingService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreOnlineServingService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreService_CreateFeaturestore_async", + "title": "DatasetService createFeaturestore Sample", + "origin": "API_DEFINITION", + "description": " Creates a new Featurestore in a given project and location.", + "canonical": true, + "file": "featurestore_service.create_featurestore.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 70, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateFeaturestore", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.CreateFeaturestore", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "featurestore", + "type": ".google.cloud.aiplatform.v1.Featurestore" + }, + { + "name": "featurestore_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "CreateFeaturestore", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.CreateFeaturestore", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreService_GetFeaturestore_async", + "title": "DatasetService getFeaturestore Sample", + "origin": "API_DEFINITION", + "description": " Gets details of a single Featurestore.", + "canonical": true, + "file": "featurestore_service.get_featurestore.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetFeaturestore", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.GetFeaturestore", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Featurestore", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "GetFeaturestore", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.GetFeaturestore", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreService_ListFeaturestores_async", + "title": "DatasetService listFeaturestores Sample", + "origin": "API_DEFINITION", + "description": " Lists Featurestores in a given project and location.", + "canonical": true, + "file": "featurestore_service.list_featurestores.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 105, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListFeaturestores", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListFeaturestoresResponse", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "ListFeaturestores", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreService_UpdateFeaturestore_async", + "title": "DatasetService updateFeaturestore Sample", + "origin": "API_DEFINITION", + "description": " Updates the parameters of a single Featurestore.", + "canonical": true, + "file": "featurestore_service.update_featurestore.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateFeaturestore", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.UpdateFeaturestore", + "async": true, + "parameters": [ + { + "name": "featurestore", + "type": ".google.cloud.aiplatform.v1.Featurestore" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "UpdateFeaturestore", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.UpdateFeaturestore", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreService_DeleteFeaturestore_async", + "title": "DatasetService deleteFeaturestore Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single Featurestore. The Featurestore must not contain any EntityTypes or `force` must be set to true for the request to succeed.", + "canonical": true, + "file": "featurestore_service.delete_featurestore.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteFeaturestore", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.DeleteFeaturestore", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "DeleteFeaturestore", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.DeleteFeaturestore", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreService_CreateEntityType_async", + "title": "DatasetService createEntityType Sample", + "origin": "API_DEFINITION", + "description": " Creates a new EntityType in a given Featurestore.", + "canonical": true, + "file": "featurestore_service.create_entity_type.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateEntityType", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.CreateEntityType", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "entity_type", + "type": ".google.cloud.aiplatform.v1.EntityType" + }, + { + "name": "entity_type_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "CreateEntityType", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.CreateEntityType", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreService_GetEntityType_async", + "title": "DatasetService getEntityType Sample", + "origin": "API_DEFINITION", + "description": " Gets details of a single EntityType.", + "canonical": true, + "file": "featurestore_service.get_entity_type.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetEntityType", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.GetEntityType", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.EntityType", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "GetEntityType", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.GetEntityType", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreService_ListEntityTypes_async", + "title": "DatasetService listEntityTypes Sample", + "origin": "API_DEFINITION", + "description": " Lists EntityTypes in a given Featurestore.", + "canonical": true, + "file": "featurestore_service.list_entity_types.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 104, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListEntityTypes", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListEntityTypesResponse", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "ListEntityTypes", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreService_UpdateEntityType_async", + "title": "DatasetService updateEntityType Sample", + "origin": "API_DEFINITION", + "description": " Updates the parameters of a single EntityType.", + "canonical": true, + "file": "featurestore_service.update_entity_type.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 76, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateEntityType", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.UpdateEntityType", + "async": true, + "parameters": [ + { + "name": "entity_type", + "type": ".google.cloud.aiplatform.v1.EntityType" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.EntityType", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "UpdateEntityType", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.UpdateEntityType", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreService_DeleteEntityType_async", + "title": "DatasetService deleteEntityType Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single EntityType. The EntityType must not have any Features or `force` must be set to true for the request to succeed.", + "canonical": true, + "file": "featurestore_service.delete_entity_type.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteEntityType", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.DeleteEntityType", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "DeleteEntityType", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.DeleteEntityType", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreService_CreateFeature_async", + "title": "DatasetService createFeature Sample", + "origin": "API_DEFINITION", + "description": " Creates a new Feature in a given EntityType.", + "canonical": true, + "file": "featurestore_service.create_feature.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 70, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateFeature", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.CreateFeature", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "feature", + "type": ".google.cloud.aiplatform.v1.Feature" + }, + { + "name": "feature_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "CreateFeature", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.CreateFeature", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreService_BatchCreateFeatures_async", + "title": "DatasetService batchCreateFeatures Sample", + "origin": "API_DEFINITION", + "description": " Creates a batch of Features in a given EntityType.", + "canonical": true, + "file": "featurestore_service.batch_create_features.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchCreateFeatures", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.BatchCreateFeatures", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "requests", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "BatchCreateFeatures", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.BatchCreateFeatures", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreService_GetFeature_async", + "title": "DatasetService getFeature Sample", + "origin": "API_DEFINITION", + "description": " Gets details of a single Feature.", + "canonical": true, + "file": "featurestore_service.get_feature.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetFeature", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.GetFeature", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Feature", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "GetFeature", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.GetFeature", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreService_ListFeatures_async", + "title": "DatasetService listFeatures Sample", + "origin": "API_DEFINITION", + "description": " Lists Features in a given EntityType.", + "canonical": true, + "file": "featurestore_service.list_features.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 116, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListFeatures", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "latest_stats_count", + "type": "TYPE_INT32" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListFeaturesResponse", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "ListFeatures", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreService_UpdateFeature_async", + "title": "DatasetService updateFeature Sample", + "origin": "API_DEFINITION", + "description": " Updates the parameters of a single Feature.", + "canonical": true, + "file": "featurestore_service.update_feature.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 70, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateFeature", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.UpdateFeature", + "async": true, + "parameters": [ + { + "name": "feature", + "type": ".google.cloud.aiplatform.v1.Feature" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Feature", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "UpdateFeature", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.UpdateFeature", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreService_DeleteFeature_async", + "title": "DatasetService deleteFeature Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single Feature.", + "canonical": true, + "file": "featurestore_service.delete_feature.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteFeature", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.DeleteFeature", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "DeleteFeature", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.DeleteFeature", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreService_ImportFeatureValues_async", + "title": "DatasetService importFeatureValues Sample", + "origin": "API_DEFINITION", + "description": " Imports Feature values into the Featurestore from a source storage. The progress of the import is tracked by the returned operation. The imported features are guaranteed to be visible to subsequent read operations after the operation is marked as successfully done. If an import operation fails, the Feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same import request again and wait till the new operation returned is marked as successfully done. There are also scenarios where the caller can cause inconsistency. - Source data for import contains multiple distinct Feature values for the same entity ID and timestamp. - Source is modified during an import. This includes adding, updating, or removing source data and/or metadata. Examples of updating metadata include but are not limited to changing storage location, storage class, or retention policy. - Online serving cluster is under-provisioned.", + "canonical": true, + "file": "featurestore_service.import_feature_values.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 106, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ImportFeatureValues", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.ImportFeatureValues", + "async": true, + "parameters": [ + { + "name": "avro_source", + "type": ".google.cloud.aiplatform.v1.AvroSource" + }, + { + "name": "bigquery_source", + "type": ".google.cloud.aiplatform.v1.BigQuerySource" + }, + { + "name": "csv_source", + "type": ".google.cloud.aiplatform.v1.CsvSource" + }, + { + "name": "feature_time_field", + "type": "TYPE_STRING" + }, + { + "name": "feature_time", + "type": ".google.protobuf.Timestamp" + }, + { + "name": "entity_type", + "type": "TYPE_STRING" + }, + { + "name": "entity_id_field", + "type": "TYPE_STRING" + }, + { + "name": "feature_specs", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "disable_online_serving", + "type": "TYPE_BOOL" + }, + { + "name": "worker_count", + "type": "TYPE_INT32" + }, + { + "name": "disable_ingestion_analysis", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "ImportFeatureValues", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.ImportFeatureValues", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreService_BatchReadFeatureValues_async", + "title": "DatasetService batchReadFeatureValues Sample", + "origin": "API_DEFINITION", + "description": " Batch reads Feature values from a Featurestore. This API enables batch reading Feature values, where each read instance in the batch may read Feature values of entities from one or more EntityTypes. Point-in-time correctness is guaranteed for Feature values of each read instance as of each instance's read timestamp.", + "canonical": true, + "file": "featurestore_service.batch_read_feature_values.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 106, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchReadFeatureValues", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.BatchReadFeatureValues", + "async": true, + "parameters": [ + { + "name": "csv_read_instances", + "type": ".google.cloud.aiplatform.v1.CsvSource" + }, + { + "name": "bigquery_read_instances", + "type": ".google.cloud.aiplatform.v1.BigQuerySource" + }, + { + "name": "featurestore", + "type": "TYPE_STRING" + }, + { + "name": "destination", + "type": ".google.cloud.aiplatform.v1.FeatureValueDestination" + }, + { + "name": "pass_through_fields", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "entity_type_specs", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "start_time", + "type": ".google.protobuf.Timestamp" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "BatchReadFeatureValues", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.BatchReadFeatureValues", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreService_ExportFeatureValues_async", + "title": "DatasetService exportFeatureValues Sample", + "origin": "API_DEFINITION", + "description": " Exports Feature values from all the entities of a target EntityType.", + "canonical": true, + "file": "featurestore_service.export_feature_values.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ExportFeatureValues", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.ExportFeatureValues", + "async": true, + "parameters": [ + { + "name": "snapshot_export", + "type": ".google.cloud.aiplatform.v1.ExportFeatureValuesRequest.SnapshotExport" + }, + { + "name": "full_export", + "type": ".google.cloud.aiplatform.v1.ExportFeatureValuesRequest.FullExport" + }, + { + "name": "entity_type", + "type": "TYPE_STRING" + }, + { + "name": "destination", + "type": ".google.cloud.aiplatform.v1.FeatureValueDestination" + }, + { + "name": "feature_selector", + "type": ".google.cloud.aiplatform.v1.FeatureSelector" + }, + { + "name": "settings", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "ExportFeatureValues", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.ExportFeatureValues", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreService_DeleteFeatureValues_async", + "title": "DatasetService deleteFeatureValues Sample", + "origin": "API_DEFINITION", + "description": " Delete Feature values from Featurestore. The progress of the deletion is tracked by the returned operation. The deleted feature values are guaranteed to be invisible to subsequent read operations after the operation is marked as successfully done. If a delete feature values operation fails, the feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same delete request again and wait till the new operation returned is marked as successfully done.", + "canonical": true, + "file": "featurestore_service.delete_feature_values.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteFeatureValues", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.DeleteFeatureValues", + "async": true, + "parameters": [ + { + "name": "select_entity", + "type": ".google.cloud.aiplatform.v1.DeleteFeatureValuesRequest.SelectEntity" + }, + { + "name": "select_time_range_and_feature", + "type": ".google.cloud.aiplatform.v1.DeleteFeatureValuesRequest.SelectTimeRangeAndFeature" + }, + { + "name": "entity_type", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "DeleteFeatureValues", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.DeleteFeatureValues", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreService_SearchFeatures_async", + "title": "DatasetService searchFeatures Sample", + "origin": "API_DEFINITION", + "description": " Searches Features matching a query in a given project.", + "canonical": true, + "file": "featurestore_service.search_features.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 124, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SearchFeatures", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures", + "async": true, + "parameters": [ + { + "name": "location", + "type": "TYPE_STRING" + }, + { + "name": "query", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.SearchFeaturesResponse", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "SearchFeatures", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_IndexEndpointService_CreateIndexEndpoint_async", + "title": "DatasetService createIndexEndpoint Sample", + "origin": "API_DEFINITION", + "description": " Creates an IndexEndpoint.", + "canonical": true, + "file": "index_endpoint_service.create_index_endpoint.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateIndexEndpoint", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService.CreateIndexEndpoint", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "index_endpoint", + "type": ".google.cloud.aiplatform.v1.IndexEndpoint" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "IndexEndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointServiceClient" + }, + "method": { + "shortName": "CreateIndexEndpoint", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService.CreateIndexEndpoint", + "service": { + "shortName": "IndexEndpointService", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_IndexEndpointService_GetIndexEndpoint_async", + "title": "DatasetService getIndexEndpoint Sample", + "origin": "API_DEFINITION", + "description": " Gets an IndexEndpoint.", + "canonical": true, + "file": "index_endpoint_service.get_index_endpoint.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetIndexEndpoint", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService.GetIndexEndpoint", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.IndexEndpoint", + "client": { + "shortName": "IndexEndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointServiceClient" + }, + "method": { + "shortName": "GetIndexEndpoint", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService.GetIndexEndpoint", + "service": { + "shortName": "IndexEndpointService", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_IndexEndpointService_ListIndexEndpoints_async", + "title": "DatasetService listIndexEndpoints Sample", + "origin": "API_DEFINITION", + "description": " Lists IndexEndpoints in a Location.", + "canonical": true, + "file": "index_endpoint_service.list_index_endpoints.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 92, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListIndexEndpoints", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListIndexEndpointsResponse", + "client": { + "shortName": "IndexEndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointServiceClient" + }, + "method": { + "shortName": "ListIndexEndpoints", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints", + "service": { + "shortName": "IndexEndpointService", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_IndexEndpointService_UpdateIndexEndpoint_async", + "title": "DatasetService updateIndexEndpoint Sample", + "origin": "API_DEFINITION", + "description": " Updates an IndexEndpoint.", + "canonical": true, + "file": "index_endpoint_service.update_index_endpoint.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateIndexEndpoint", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService.UpdateIndexEndpoint", + "async": true, + "parameters": [ + { + "name": "index_endpoint", + "type": ".google.cloud.aiplatform.v1.IndexEndpoint" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.IndexEndpoint", + "client": { + "shortName": "IndexEndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointServiceClient" + }, + "method": { + "shortName": "UpdateIndexEndpoint", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService.UpdateIndexEndpoint", + "service": { + "shortName": "IndexEndpointService", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_IndexEndpointService_DeleteIndexEndpoint_async", + "title": "DatasetService deleteIndexEndpoint Sample", + "origin": "API_DEFINITION", + "description": " Deletes an IndexEndpoint.", + "canonical": true, + "file": "index_endpoint_service.delete_index_endpoint.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteIndexEndpoint", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService.DeleteIndexEndpoint", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "IndexEndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointServiceClient" + }, + "method": { + "shortName": "DeleteIndexEndpoint", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService.DeleteIndexEndpoint", + "service": { + "shortName": "IndexEndpointService", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_IndexEndpointService_DeployIndex_async", + "title": "DatasetService deployIndex Sample", + "origin": "API_DEFINITION", + "description": " Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. Only non-empty Indexes can be deployed.", + "canonical": true, + "file": "index_endpoint_service.deploy_index.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeployIndex", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService.DeployIndex", + "async": true, + "parameters": [ + { + "name": "index_endpoint", + "type": "TYPE_STRING" + }, + { + "name": "deployed_index", + "type": ".google.cloud.aiplatform.v1.DeployedIndex" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "IndexEndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointServiceClient" + }, + "method": { + "shortName": "DeployIndex", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService.DeployIndex", + "service": { + "shortName": "IndexEndpointService", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_IndexEndpointService_UndeployIndex_async", + "title": "DatasetService undeployIndex Sample", + "origin": "API_DEFINITION", + "description": " Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.", + "canonical": true, + "file": "index_endpoint_service.undeploy_index.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UndeployIndex", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService.UndeployIndex", + "async": true, + "parameters": [ + { + "name": "index_endpoint", + "type": "TYPE_STRING" + }, + { + "name": "deployed_index_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "IndexEndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointServiceClient" + }, + "method": { + "shortName": "UndeployIndex", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService.UndeployIndex", + "service": { + "shortName": "IndexEndpointService", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_IndexEndpointService_MutateDeployedIndex_async", + "title": "DatasetService mutateDeployedIndex Sample", + "origin": "API_DEFINITION", + "description": " Update an existing DeployedIndex under an IndexEndpoint.", + "canonical": true, + "file": "index_endpoint_service.mutate_deployed_index.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "MutateDeployedIndex", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService.MutateDeployedIndex", + "async": true, + "parameters": [ + { + "name": "index_endpoint", + "type": "TYPE_STRING" + }, + { + "name": "deployed_index", + "type": ".google.cloud.aiplatform.v1.DeployedIndex" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "IndexEndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointServiceClient" + }, + "method": { + "shortName": "MutateDeployedIndex", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService.MutateDeployedIndex", + "service": { + "shortName": "IndexEndpointService", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_IndexService_CreateIndex_async", + "title": "DatasetService createIndex Sample", + "origin": "API_DEFINITION", + "description": " Creates an Index.", + "canonical": true, + "file": "index_service.create_index.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateIndex", + "fullName": "google.cloud.aiplatform.v1.IndexService.CreateIndex", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "index", + "type": ".google.cloud.aiplatform.v1.Index" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "IndexServiceClient", + "fullName": "google.cloud.aiplatform.v1.IndexServiceClient" + }, + "method": { + "shortName": "CreateIndex", + "fullName": "google.cloud.aiplatform.v1.IndexService.CreateIndex", + "service": { + "shortName": "IndexService", + "fullName": "google.cloud.aiplatform.v1.IndexService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_IndexService_GetIndex_async", + "title": "DatasetService getIndex Sample", + "origin": "API_DEFINITION", + "description": " Gets an Index.", + "canonical": true, + "file": "index_service.get_index.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetIndex", + "fullName": "google.cloud.aiplatform.v1.IndexService.GetIndex", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Index", + "client": { + "shortName": "IndexServiceClient", + "fullName": "google.cloud.aiplatform.v1.IndexServiceClient" + }, + "method": { + "shortName": "GetIndex", + "fullName": "google.cloud.aiplatform.v1.IndexService.GetIndex", + "service": { + "shortName": "IndexService", + "fullName": "google.cloud.aiplatform.v1.IndexService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_IndexService_ListIndexes_async", + "title": "DatasetService listIndexes Sample", + "origin": "API_DEFINITION", + "description": " Lists Indexes in a Location.", + "canonical": true, + "file": "index_service.list_indexes.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 77, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListIndexes", + "fullName": "google.cloud.aiplatform.v1.IndexService.ListIndexes", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListIndexesResponse", + "client": { + "shortName": "IndexServiceClient", + "fullName": "google.cloud.aiplatform.v1.IndexServiceClient" + }, + "method": { + "shortName": "ListIndexes", + "fullName": "google.cloud.aiplatform.v1.IndexService.ListIndexes", + "service": { + "shortName": "IndexService", + "fullName": "google.cloud.aiplatform.v1.IndexService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_IndexService_UpdateIndex_async", + "title": "DatasetService updateIndex Sample", + "origin": "API_DEFINITION", + "description": " Updates an Index.", + "canonical": true, + "file": "index_service.update_index.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateIndex", + "fullName": "google.cloud.aiplatform.v1.IndexService.UpdateIndex", + "async": true, + "parameters": [ + { + "name": "index", + "type": ".google.cloud.aiplatform.v1.Index" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "IndexServiceClient", + "fullName": "google.cloud.aiplatform.v1.IndexServiceClient" + }, + "method": { + "shortName": "UpdateIndex", + "fullName": "google.cloud.aiplatform.v1.IndexService.UpdateIndex", + "service": { + "shortName": "IndexService", + "fullName": "google.cloud.aiplatform.v1.IndexService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_IndexService_DeleteIndex_async", + "title": "DatasetService deleteIndex Sample", + "origin": "API_DEFINITION", + "description": " Deletes an Index. An Index can only be deleted when all its [DeployedIndexes][google.cloud.aiplatform.v1.Index.deployed_indexes] had been undeployed.", + "canonical": true, + "file": "index_service.delete_index.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteIndex", + "fullName": "google.cloud.aiplatform.v1.IndexService.DeleteIndex", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "IndexServiceClient", + "fullName": "google.cloud.aiplatform.v1.IndexServiceClient" + }, + "method": { + "shortName": "DeleteIndex", + "fullName": "google.cloud.aiplatform.v1.IndexService.DeleteIndex", + "service": { + "shortName": "IndexService", + "fullName": "google.cloud.aiplatform.v1.IndexService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_IndexService_UpsertDatapoints_async", + "title": "DatasetService upsertDatapoints Sample", + "origin": "API_DEFINITION", + "description": " Add/update Datapoints into an Index.", + "canonical": true, + "file": "index_service.upsert_datapoints.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpsertDatapoints", + "fullName": "google.cloud.aiplatform.v1.IndexService.UpsertDatapoints", + "async": true, + "parameters": [ + { + "name": "index", + "type": "TYPE_STRING" + }, + { + "name": "datapoints", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1.UpsertDatapointsResponse", + "client": { + "shortName": "IndexServiceClient", + "fullName": "google.cloud.aiplatform.v1.IndexServiceClient" + }, + "method": { + "shortName": "UpsertDatapoints", + "fullName": "google.cloud.aiplatform.v1.IndexService.UpsertDatapoints", + "service": { + "shortName": "IndexService", + "fullName": "google.cloud.aiplatform.v1.IndexService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_IndexService_RemoveDatapoints_async", + "title": "DatasetService removeDatapoints Sample", + "origin": "API_DEFINITION", + "description": " Remove Datapoints from an Index.", + "canonical": true, + "file": "index_service.remove_datapoints.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RemoveDatapoints", + "fullName": "google.cloud.aiplatform.v1.IndexService.RemoveDatapoints", + "async": true, + "parameters": [ + { + "name": "index", + "type": "TYPE_STRING" + }, + { + "name": "datapoint_ids", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1.RemoveDatapointsResponse", + "client": { + "shortName": "IndexServiceClient", + "fullName": "google.cloud.aiplatform.v1.IndexServiceClient" + }, + "method": { + "shortName": "RemoveDatapoints", + "fullName": "google.cloud.aiplatform.v1.IndexService.RemoveDatapoints", + "service": { + "shortName": "IndexService", + "fullName": "google.cloud.aiplatform.v1.IndexService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_CreateCustomJob_async", + "title": "DatasetService createCustomJob Sample", + "origin": "API_DEFINITION", + "description": " Creates a CustomJob. A created CustomJob right away will be attempted to be run.", + "canonical": true, + "file": "job_service.create_custom_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateCustomJob", + "fullName": "google.cloud.aiplatform.v1.JobService.CreateCustomJob", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "custom_job", + "type": ".google.cloud.aiplatform.v1.CustomJob" + } + ], + "resultType": ".google.cloud.aiplatform.v1.CustomJob", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "CreateCustomJob", + "fullName": "google.cloud.aiplatform.v1.JobService.CreateCustomJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_GetCustomJob_async", + "title": "DatasetService getCustomJob Sample", + "origin": "API_DEFINITION", + "description": " Gets a CustomJob.", + "canonical": true, + "file": "job_service.get_custom_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetCustomJob", + "fullName": "google.cloud.aiplatform.v1.JobService.GetCustomJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.CustomJob", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "GetCustomJob", + "fullName": "google.cloud.aiplatform.v1.JobService.GetCustomJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_ListCustomJobs_async", + "title": "DatasetService listCustomJobs Sample", + "origin": "API_DEFINITION", + "description": " Lists CustomJobs in a Location.", + "canonical": true, + "file": "job_service.list_custom_jobs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 92, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListCustomJobs", + "fullName": "google.cloud.aiplatform.v1.JobService.ListCustomJobs", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListCustomJobsResponse", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "ListCustomJobs", + "fullName": "google.cloud.aiplatform.v1.JobService.ListCustomJobs", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_DeleteCustomJob_async", + "title": "DatasetService deleteCustomJob Sample", + "origin": "API_DEFINITION", + "description": " Deletes a CustomJob.", + "canonical": true, + "file": "job_service.delete_custom_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteCustomJob", + "fullName": "google.cloud.aiplatform.v1.JobService.DeleteCustomJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "DeleteCustomJob", + "fullName": "google.cloud.aiplatform.v1.JobService.DeleteCustomJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_CancelCustomJob_async", + "title": "DatasetService cancelCustomJob Sample", + "origin": "API_DEFINITION", + "description": " Cancels a CustomJob. Starts asynchronous cancellation on the CustomJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use [JobService.GetCustomJob][google.cloud.aiplatform.v1.JobService.GetCustomJob] or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the CustomJob is not deleted; instead it becomes a job with a [CustomJob.error][google.cloud.aiplatform.v1.CustomJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [CustomJob.state][google.cloud.aiplatform.v1.CustomJob.state] is set to `CANCELLED`.", + "canonical": true, + "file": "job_service.cancel_custom_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CancelCustomJob", + "fullName": "google.cloud.aiplatform.v1.JobService.CancelCustomJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "CancelCustomJob", + "fullName": "google.cloud.aiplatform.v1.JobService.CancelCustomJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_CreateDataLabelingJob_async", + "title": "DatasetService createDataLabelingJob Sample", + "origin": "API_DEFINITION", + "description": " Creates a DataLabelingJob.", + "canonical": true, + "file": "job_service.create_data_labeling_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateDataLabelingJob", + "fullName": "google.cloud.aiplatform.v1.JobService.CreateDataLabelingJob", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "data_labeling_job", + "type": ".google.cloud.aiplatform.v1.DataLabelingJob" + } + ], + "resultType": ".google.cloud.aiplatform.v1.DataLabelingJob", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "CreateDataLabelingJob", + "fullName": "google.cloud.aiplatform.v1.JobService.CreateDataLabelingJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_GetDataLabelingJob_async", + "title": "DatasetService getDataLabelingJob Sample", + "origin": "API_DEFINITION", + "description": " Gets a DataLabelingJob.", + "canonical": true, + "file": "job_service.get_data_labeling_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetDataLabelingJob", + "fullName": "google.cloud.aiplatform.v1.JobService.GetDataLabelingJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.DataLabelingJob", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "GetDataLabelingJob", + "fullName": "google.cloud.aiplatform.v1.JobService.GetDataLabelingJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_ListDataLabelingJobs_async", + "title": "DatasetService listDataLabelingJobs Sample", + "origin": "API_DEFINITION", + "description": " Lists DataLabelingJobs in a Location.", + "canonical": true, + "file": "job_service.list_data_labeling_jobs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 96, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListDataLabelingJobs", + "fullName": "google.cloud.aiplatform.v1.JobService.ListDataLabelingJobs", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListDataLabelingJobsResponse", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "ListDataLabelingJobs", + "fullName": "google.cloud.aiplatform.v1.JobService.ListDataLabelingJobs", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_DeleteDataLabelingJob_async", + "title": "DatasetService deleteDataLabelingJob Sample", + "origin": "API_DEFINITION", + "description": " Deletes a DataLabelingJob.", + "canonical": true, + "file": "job_service.delete_data_labeling_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteDataLabelingJob", + "fullName": "google.cloud.aiplatform.v1.JobService.DeleteDataLabelingJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "DeleteDataLabelingJob", + "fullName": "google.cloud.aiplatform.v1.JobService.DeleteDataLabelingJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_CancelDataLabelingJob_async", + "title": "DatasetService cancelDataLabelingJob Sample", + "origin": "API_DEFINITION", + "description": " Cancels a DataLabelingJob. Success of cancellation is not guaranteed.", + "canonical": true, + "file": "job_service.cancel_data_labeling_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CancelDataLabelingJob", + "fullName": "google.cloud.aiplatform.v1.JobService.CancelDataLabelingJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "CancelDataLabelingJob", + "fullName": "google.cloud.aiplatform.v1.JobService.CancelDataLabelingJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_CreateHyperparameterTuningJob_async", + "title": "DatasetService createHyperparameterTuningJob Sample", + "origin": "API_DEFINITION", + "description": " Creates a HyperparameterTuningJob", + "canonical": true, + "file": "job_service.create_hyperparameter_tuning_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateHyperparameterTuningJob", + "fullName": "google.cloud.aiplatform.v1.JobService.CreateHyperparameterTuningJob", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "hyperparameter_tuning_job", + "type": ".google.cloud.aiplatform.v1.HyperparameterTuningJob" + } + ], + "resultType": ".google.cloud.aiplatform.v1.HyperparameterTuningJob", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "CreateHyperparameterTuningJob", + "fullName": "google.cloud.aiplatform.v1.JobService.CreateHyperparameterTuningJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_GetHyperparameterTuningJob_async", + "title": "DatasetService getHyperparameterTuningJob Sample", + "origin": "API_DEFINITION", + "description": " Gets a HyperparameterTuningJob", + "canonical": true, + "file": "job_service.get_hyperparameter_tuning_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetHyperparameterTuningJob", + "fullName": "google.cloud.aiplatform.v1.JobService.GetHyperparameterTuningJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.HyperparameterTuningJob", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "GetHyperparameterTuningJob", + "fullName": "google.cloud.aiplatform.v1.JobService.GetHyperparameterTuningJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_ListHyperparameterTuningJobs_async", + "title": "DatasetService listHyperparameterTuningJobs Sample", + "origin": "API_DEFINITION", + "description": " Lists HyperparameterTuningJobs in a Location.", + "canonical": true, + "file": "job_service.list_hyperparameter_tuning_jobs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 93, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListHyperparameterTuningJobs", + "fullName": "google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListHyperparameterTuningJobsResponse", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "ListHyperparameterTuningJobs", + "fullName": "google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_DeleteHyperparameterTuningJob_async", + "title": "DatasetService deleteHyperparameterTuningJob Sample", + "origin": "API_DEFINITION", + "description": " Deletes a HyperparameterTuningJob.", + "canonical": true, + "file": "job_service.delete_hyperparameter_tuning_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteHyperparameterTuningJob", + "fullName": "google.cloud.aiplatform.v1.JobService.DeleteHyperparameterTuningJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "DeleteHyperparameterTuningJob", + "fullName": "google.cloud.aiplatform.v1.JobService.DeleteHyperparameterTuningJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_CancelHyperparameterTuningJob_async", + "title": "DatasetService cancelHyperparameterTuningJob Sample", + "origin": "API_DEFINITION", + "description": " Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on the HyperparameterTuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use [JobService.GetHyperparameterTuningJob][google.cloud.aiplatform.v1.JobService.GetHyperparameterTuningJob] or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the HyperparameterTuningJob is not deleted; instead it becomes a job with a [HyperparameterTuningJob.error][google.cloud.aiplatform.v1.HyperparameterTuningJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [HyperparameterTuningJob.state][google.cloud.aiplatform.v1.HyperparameterTuningJob.state] is set to `CANCELLED`.", + "canonical": true, + "file": "job_service.cancel_hyperparameter_tuning_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CancelHyperparameterTuningJob", + "fullName": "google.cloud.aiplatform.v1.JobService.CancelHyperparameterTuningJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "CancelHyperparameterTuningJob", + "fullName": "google.cloud.aiplatform.v1.JobService.CancelHyperparameterTuningJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_CreateNasJob_async", + "title": "DatasetService createNasJob Sample", + "origin": "API_DEFINITION", + "description": " Creates a NasJob", + "canonical": true, + "file": "job_service.create_nas_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateNasJob", + "fullName": "google.cloud.aiplatform.v1.JobService.CreateNasJob", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "nas_job", + "type": ".google.cloud.aiplatform.v1.NasJob" + } + ], + "resultType": ".google.cloud.aiplatform.v1.NasJob", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "CreateNasJob", + "fullName": "google.cloud.aiplatform.v1.JobService.CreateNasJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_GetNasJob_async", + "title": "DatasetService getNasJob Sample", + "origin": "API_DEFINITION", + "description": " Gets a NasJob", + "canonical": true, + "file": "job_service.get_nas_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetNasJob", + "fullName": "google.cloud.aiplatform.v1.JobService.GetNasJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.NasJob", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "GetNasJob", + "fullName": "google.cloud.aiplatform.v1.JobService.GetNasJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_ListNasJobs_async", + "title": "DatasetService listNasJobs Sample", + "origin": "API_DEFINITION", + "description": " Lists NasJobs in a Location.", + "canonical": true, + "file": "job_service.list_nas_jobs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 92, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListNasJobs", + "fullName": "google.cloud.aiplatform.v1.JobService.ListNasJobs", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListNasJobsResponse", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "ListNasJobs", + "fullName": "google.cloud.aiplatform.v1.JobService.ListNasJobs", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_DeleteNasJob_async", + "title": "DatasetService deleteNasJob Sample", + "origin": "API_DEFINITION", + "description": " Deletes a NasJob.", + "canonical": true, + "file": "job_service.delete_nas_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteNasJob", + "fullName": "google.cloud.aiplatform.v1.JobService.DeleteNasJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "DeleteNasJob", + "fullName": "google.cloud.aiplatform.v1.JobService.DeleteNasJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_CancelNasJob_async", + "title": "DatasetService cancelNasJob Sample", + "origin": "API_DEFINITION", + "description": " Cancels a NasJob. Starts asynchronous cancellation on the NasJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use [JobService.GetNasJob][google.cloud.aiplatform.v1.JobService.GetNasJob] or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the NasJob is not deleted; instead it becomes a job with a [NasJob.error][google.cloud.aiplatform.v1.NasJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [NasJob.state][google.cloud.aiplatform.v1.NasJob.state] is set to `CANCELLED`.", + "canonical": true, + "file": "job_service.cancel_nas_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CancelNasJob", + "fullName": "google.cloud.aiplatform.v1.JobService.CancelNasJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "CancelNasJob", + "fullName": "google.cloud.aiplatform.v1.JobService.CancelNasJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_GetNasTrialDetail_async", + "title": "DatasetService getNasTrialDetail Sample", + "origin": "API_DEFINITION", + "description": " Gets a NasTrialDetail.", + "canonical": true, + "file": "job_service.get_nas_trial_detail.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetNasTrialDetail", + "fullName": "google.cloud.aiplatform.v1.JobService.GetNasTrialDetail", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.NasTrialDetail", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "GetNasTrialDetail", + "fullName": "google.cloud.aiplatform.v1.JobService.GetNasTrialDetail", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_ListNasTrialDetails_async", + "title": "DatasetService listNasTrialDetails Sample", + "origin": "API_DEFINITION", + "description": " List top NasTrialDetails of a NasJob.", + "canonical": true, + "file": "job_service.list_nas_trial_details.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 70, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListNasTrialDetails", + "fullName": "google.cloud.aiplatform.v1.JobService.ListNasTrialDetails", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListNasTrialDetailsResponse", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "ListNasTrialDetails", + "fullName": "google.cloud.aiplatform.v1.JobService.ListNasTrialDetails", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_CreateBatchPredictionJob_async", + "title": "DatasetService createBatchPredictionJob Sample", + "origin": "API_DEFINITION", + "description": " Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.", + "canonical": true, + "file": "job_service.create_batch_prediction_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateBatchPredictionJob", + "fullName": "google.cloud.aiplatform.v1.JobService.CreateBatchPredictionJob", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "batch_prediction_job", + "type": ".google.cloud.aiplatform.v1.BatchPredictionJob" + } + ], + "resultType": ".google.cloud.aiplatform.v1.BatchPredictionJob", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "CreateBatchPredictionJob", + "fullName": "google.cloud.aiplatform.v1.JobService.CreateBatchPredictionJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_GetBatchPredictionJob_async", + "title": "DatasetService getBatchPredictionJob Sample", + "origin": "API_DEFINITION", + "description": " Gets a BatchPredictionJob", + "canonical": true, + "file": "job_service.get_batch_prediction_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetBatchPredictionJob", + "fullName": "google.cloud.aiplatform.v1.JobService.GetBatchPredictionJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.BatchPredictionJob", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "GetBatchPredictionJob", + "fullName": "google.cloud.aiplatform.v1.JobService.GetBatchPredictionJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_ListBatchPredictionJobs_async", + "title": "DatasetService listBatchPredictionJobs Sample", + "origin": "API_DEFINITION", + "description": " Lists BatchPredictionJobs in a Location.", + "canonical": true, + "file": "job_service.list_batch_prediction_jobs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 93, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListBatchPredictionJobs", + "fullName": "google.cloud.aiplatform.v1.JobService.ListBatchPredictionJobs", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListBatchPredictionJobsResponse", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "ListBatchPredictionJobs", + "fullName": "google.cloud.aiplatform.v1.JobService.ListBatchPredictionJobs", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_DeleteBatchPredictionJob_async", + "title": "DatasetService deleteBatchPredictionJob Sample", + "origin": "API_DEFINITION", + "description": " Deletes a BatchPredictionJob. Can only be called on jobs that already finished.", + "canonical": true, + "file": "job_service.delete_batch_prediction_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteBatchPredictionJob", + "fullName": "google.cloud.aiplatform.v1.JobService.DeleteBatchPredictionJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "DeleteBatchPredictionJob", + "fullName": "google.cloud.aiplatform.v1.JobService.DeleteBatchPredictionJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_CancelBatchPredictionJob_async", + "title": "DatasetService cancelBatchPredictionJob Sample", + "origin": "API_DEFINITION", + "description": " Cancels a BatchPredictionJob. Starts asynchronous cancellation on the BatchPredictionJob. The server makes the best effort to cancel the job, but success is not guaranteed. Clients can use [JobService.GetBatchPredictionJob][google.cloud.aiplatform.v1.JobService.GetBatchPredictionJob] or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob is not deleted;instead its [BatchPredictionJob.state][google.cloud.aiplatform.v1.BatchPredictionJob.state] is set to `CANCELLED`. Any files already outputted by the job are not deleted.", + "canonical": true, + "file": "job_service.cancel_batch_prediction_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CancelBatchPredictionJob", + "fullName": "google.cloud.aiplatform.v1.JobService.CancelBatchPredictionJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "CancelBatchPredictionJob", + "fullName": "google.cloud.aiplatform.v1.JobService.CancelBatchPredictionJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_CreateModelDeploymentMonitoringJob_async", + "title": "DatasetService createModelDeploymentMonitoringJob Sample", + "origin": "API_DEFINITION", + "description": " Creates a ModelDeploymentMonitoringJob. It will run periodically on a configured interval.", + "canonical": true, + "file": "job_service.create_model_deployment_monitoring_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1.JobService.CreateModelDeploymentMonitoringJob", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "model_deployment_monitoring_job", + "type": ".google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "CreateModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1.JobService.CreateModelDeploymentMonitoringJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_SearchModelDeploymentMonitoringStatsAnomalies_async", + "title": "DatasetService searchModelDeploymentMonitoringStatsAnomalies Sample", + "origin": "API_DEFINITION", + "description": " Searches Model Monitoring Statistics generated within a given time window.", + "canonical": true, + "file": "job_service.search_model_deployment_monitoring_stats_anomalies.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 95, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SearchModelDeploymentMonitoringStatsAnomalies", + "fullName": "google.cloud.aiplatform.v1.JobService.SearchModelDeploymentMonitoringStatsAnomalies", + "async": true, + "parameters": [ + { + "name": "model_deployment_monitoring_job", + "type": "TYPE_STRING" + }, + { + "name": "deployed_model_id", + "type": "TYPE_STRING" + }, + { + "name": "feature_display_name", + "type": "TYPE_STRING" + }, + { + "name": "objectives", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "start_time", + "type": ".google.protobuf.Timestamp" + }, + { + "name": "end_time", + "type": ".google.protobuf.Timestamp" + } + ], + "resultType": ".google.cloud.aiplatform.v1.SearchModelDeploymentMonitoringStatsAnomaliesResponse", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "SearchModelDeploymentMonitoringStatsAnomalies", + "fullName": "google.cloud.aiplatform.v1.JobService.SearchModelDeploymentMonitoringStatsAnomalies", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_GetModelDeploymentMonitoringJob_async", + "title": "DatasetService getModelDeploymentMonitoringJob Sample", + "origin": "API_DEFINITION", + "description": " Gets a ModelDeploymentMonitoringJob.", + "canonical": true, + "file": "job_service.get_model_deployment_monitoring_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1.JobService.GetModelDeploymentMonitoringJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "GetModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1.JobService.GetModelDeploymentMonitoringJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_ListModelDeploymentMonitoringJobs_async", + "title": "DatasetService listModelDeploymentMonitoringJobs Sample", + "origin": "API_DEFINITION", + "description": " Lists ModelDeploymentMonitoringJobs in a Location.", + "canonical": true, + "file": "job_service.list_model_deployment_monitoring_jobs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 87, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListModelDeploymentMonitoringJobs", + "fullName": "google.cloud.aiplatform.v1.JobService.ListModelDeploymentMonitoringJobs", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListModelDeploymentMonitoringJobsResponse", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "ListModelDeploymentMonitoringJobs", + "fullName": "google.cloud.aiplatform.v1.JobService.ListModelDeploymentMonitoringJobs", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_UpdateModelDeploymentMonitoringJob_async", + "title": "DatasetService updateModelDeploymentMonitoringJob Sample", + "origin": "API_DEFINITION", + "description": " Updates a ModelDeploymentMonitoringJob.", + "canonical": true, + "file": "job_service.update_model_deployment_monitoring_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 83, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1.JobService.UpdateModelDeploymentMonitoringJob", + "async": true, + "parameters": [ + { + "name": "model_deployment_monitoring_job", + "type": ".google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "UpdateModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1.JobService.UpdateModelDeploymentMonitoringJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_DeleteModelDeploymentMonitoringJob_async", + "title": "DatasetService deleteModelDeploymentMonitoringJob Sample", + "origin": "API_DEFINITION", + "description": " Deletes a ModelDeploymentMonitoringJob.", + "canonical": true, + "file": "job_service.delete_model_deployment_monitoring_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1.JobService.DeleteModelDeploymentMonitoringJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "DeleteModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1.JobService.DeleteModelDeploymentMonitoringJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_PauseModelDeploymentMonitoringJob_async", + "title": "DatasetService pauseModelDeploymentMonitoringJob Sample", + "origin": "API_DEFINITION", + "description": " Pauses a ModelDeploymentMonitoringJob. If the job is running, the server makes a best effort to cancel the job. Will mark [ModelDeploymentMonitoringJob.state][google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob.state] to 'PAUSED'.", + "canonical": true, + "file": "job_service.pause_model_deployment_monitoring_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "PauseModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1.JobService.PauseModelDeploymentMonitoringJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "PauseModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1.JobService.PauseModelDeploymentMonitoringJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_ResumeModelDeploymentMonitoringJob_async", + "title": "DatasetService resumeModelDeploymentMonitoringJob Sample", + "origin": "API_DEFINITION", + "description": " Resumes a paused ModelDeploymentMonitoringJob. It will start to run from next scheduled time. A deleted ModelDeploymentMonitoringJob can't be resumed.", + "canonical": true, + "file": "job_service.resume_model_deployment_monitoring_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ResumeModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1.JobService.ResumeModelDeploymentMonitoringJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "ResumeModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1.JobService.ResumeModelDeploymentMonitoringJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MatchService_FindNeighbors_async", + "title": "DatasetService findNeighbors Sample", + "origin": "API_DEFINITION", + "description": " Finds the nearest neighbors of each vector within the request.", + "canonical": true, + "file": "match_service.find_neighbors.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "FindNeighbors", + "fullName": "google.cloud.aiplatform.v1.MatchService.FindNeighbors", + "async": true, + "parameters": [ + { + "name": "index_endpoint", + "type": "TYPE_STRING" + }, + { + "name": "deployed_index_id", + "type": "TYPE_STRING" + }, + { + "name": "queries", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "return_full_datapoint", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.aiplatform.v1.FindNeighborsResponse", + "client": { + "shortName": "MatchServiceClient", + "fullName": "google.cloud.aiplatform.v1.MatchServiceClient" + }, + "method": { + "shortName": "FindNeighbors", + "fullName": "google.cloud.aiplatform.v1.MatchService.FindNeighbors", + "service": { + "shortName": "MatchService", + "fullName": "google.cloud.aiplatform.v1.MatchService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MatchService_ReadIndexDatapoints_async", + "title": "DatasetService readIndexDatapoints Sample", + "origin": "API_DEFINITION", + "description": " Reads the datapoints/vectors of the given IDs. A maximum of 1000 datapoints can be retrieved in a batch.", + "canonical": true, + "file": "match_service.read_index_datapoints.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ReadIndexDatapoints", + "fullName": "google.cloud.aiplatform.v1.MatchService.ReadIndexDatapoints", + "async": true, + "parameters": [ + { + "name": "index_endpoint", + "type": "TYPE_STRING" + }, + { + "name": "deployed_index_id", + "type": "TYPE_STRING" + }, + { + "name": "ids", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ReadIndexDatapointsResponse", + "client": { + "shortName": "MatchServiceClient", + "fullName": "google.cloud.aiplatform.v1.MatchServiceClient" + }, + "method": { + "shortName": "ReadIndexDatapoints", + "fullName": "google.cloud.aiplatform.v1.MatchService.ReadIndexDatapoints", + "service": { + "shortName": "MatchService", + "fullName": "google.cloud.aiplatform.v1.MatchService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_CreateMetadataStore_async", + "title": "DatasetService createMetadataStore Sample", + "origin": "API_DEFINITION", + "description": " Initializes a MetadataStore, including allocation of resources.", + "canonical": true, + "file": "metadata_service.create_metadata_store.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateMetadataStore", + "fullName": "google.cloud.aiplatform.v1.MetadataService.CreateMetadataStore", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "metadata_store", + "type": ".google.cloud.aiplatform.v1.MetadataStore" + }, + { + "name": "metadata_store_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "CreateMetadataStore", + "fullName": "google.cloud.aiplatform.v1.MetadataService.CreateMetadataStore", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_GetMetadataStore_async", + "title": "DatasetService getMetadataStore Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a specific MetadataStore.", + "canonical": true, + "file": "metadata_service.get_metadata_store.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetMetadataStore", + "fullName": "google.cloud.aiplatform.v1.MetadataService.GetMetadataStore", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.MetadataStore", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "GetMetadataStore", + "fullName": "google.cloud.aiplatform.v1.MetadataService.GetMetadataStore", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_ListMetadataStores_async", + "title": "DatasetService listMetadataStores Sample", + "origin": "API_DEFINITION", + "description": " Lists MetadataStores for a Location.", + "canonical": true, + "file": "metadata_service.list_metadata_stores.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListMetadataStores", + "fullName": "google.cloud.aiplatform.v1.MetadataService.ListMetadataStores", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListMetadataStoresResponse", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "ListMetadataStores", + "fullName": "google.cloud.aiplatform.v1.MetadataService.ListMetadataStores", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_DeleteMetadataStore_async", + "title": "DatasetService deleteMetadataStore Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts).", + "canonical": true, + "file": "metadata_service.delete_metadata_store.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteMetadataStore", + "fullName": "google.cloud.aiplatform.v1.MetadataService.DeleteMetadataStore", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "DeleteMetadataStore", + "fullName": "google.cloud.aiplatform.v1.MetadataService.DeleteMetadataStore", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_CreateArtifact_async", + "title": "DatasetService createArtifact Sample", + "origin": "API_DEFINITION", + "description": " Creates an Artifact associated with a MetadataStore.", + "canonical": true, + "file": "metadata_service.create_artifact.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateArtifact", + "fullName": "google.cloud.aiplatform.v1.MetadataService.CreateArtifact", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "artifact", + "type": ".google.cloud.aiplatform.v1.Artifact" + }, + { + "name": "artifact_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Artifact", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "CreateArtifact", + "fullName": "google.cloud.aiplatform.v1.MetadataService.CreateArtifact", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_GetArtifact_async", + "title": "DatasetService getArtifact Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a specific Artifact.", + "canonical": true, + "file": "metadata_service.get_artifact.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetArtifact", + "fullName": "google.cloud.aiplatform.v1.MetadataService.GetArtifact", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Artifact", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "GetArtifact", + "fullName": "google.cloud.aiplatform.v1.MetadataService.GetArtifact", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_ListArtifacts_async", + "title": "DatasetService listArtifacts Sample", + "origin": "API_DEFINITION", + "description": " Lists Artifacts in the MetadataStore.", + "canonical": true, + "file": "metadata_service.list_artifacts.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 111, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListArtifacts", + "fullName": "google.cloud.aiplatform.v1.MetadataService.ListArtifacts", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListArtifactsResponse", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "ListArtifacts", + "fullName": "google.cloud.aiplatform.v1.MetadataService.ListArtifacts", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_UpdateArtifact_async", + "title": "DatasetService updateArtifact Sample", + "origin": "API_DEFINITION", + "description": " Updates a stored Artifact.", + "canonical": true, + "file": "metadata_service.update_artifact.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateArtifact", + "fullName": "google.cloud.aiplatform.v1.MetadataService.UpdateArtifact", + "async": true, + "parameters": [ + { + "name": "artifact", + "type": ".google.cloud.aiplatform.v1.Artifact" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "allow_missing", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Artifact", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "UpdateArtifact", + "fullName": "google.cloud.aiplatform.v1.MetadataService.UpdateArtifact", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_DeleteArtifact_async", + "title": "DatasetService deleteArtifact Sample", + "origin": "API_DEFINITION", + "description": " Deletes an Artifact.", + "canonical": true, + "file": "metadata_service.delete_artifact.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteArtifact", + "fullName": "google.cloud.aiplatform.v1.MetadataService.DeleteArtifact", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "etag", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "DeleteArtifact", + "fullName": "google.cloud.aiplatform.v1.MetadataService.DeleteArtifact", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_PurgeArtifacts_async", + "title": "DatasetService purgeArtifacts Sample", + "origin": "API_DEFINITION", + "description": " Purges Artifacts.", + "canonical": true, + "file": "metadata_service.purge_artifacts.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "PurgeArtifacts", + "fullName": "google.cloud.aiplatform.v1.MetadataService.PurgeArtifacts", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "PurgeArtifacts", + "fullName": "google.cloud.aiplatform.v1.MetadataService.PurgeArtifacts", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_CreateContext_async", + "title": "DatasetService createContext Sample", + "origin": "API_DEFINITION", + "description": " Creates a Context associated with a MetadataStore.", + "canonical": true, + "file": "metadata_service.create_context.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 70, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateContext", + "fullName": "google.cloud.aiplatform.v1.MetadataService.CreateContext", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "context", + "type": ".google.cloud.aiplatform.v1.Context" + }, + { + "name": "context_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Context", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "CreateContext", + "fullName": "google.cloud.aiplatform.v1.MetadataService.CreateContext", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_GetContext_async", + "title": "DatasetService getContext Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a specific Context.", + "canonical": true, + "file": "metadata_service.get_context.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetContext", + "fullName": "google.cloud.aiplatform.v1.MetadataService.GetContext", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Context", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "GetContext", + "fullName": "google.cloud.aiplatform.v1.MetadataService.GetContext", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_ListContexts_async", + "title": "DatasetService listContexts Sample", + "origin": "API_DEFINITION", + "description": " Lists Contexts on the MetadataStore.", + "canonical": true, + "file": "metadata_service.list_contexts.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 114, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListContexts", + "fullName": "google.cloud.aiplatform.v1.MetadataService.ListContexts", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListContextsResponse", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "ListContexts", + "fullName": "google.cloud.aiplatform.v1.MetadataService.ListContexts", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_UpdateContext_async", + "title": "DatasetService updateContext Sample", + "origin": "API_DEFINITION", + "description": " Updates a stored Context.", + "canonical": true, + "file": "metadata_service.update_context.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateContext", + "fullName": "google.cloud.aiplatform.v1.MetadataService.UpdateContext", + "async": true, + "parameters": [ + { + "name": "context", + "type": ".google.cloud.aiplatform.v1.Context" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "allow_missing", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Context", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "UpdateContext", + "fullName": "google.cloud.aiplatform.v1.MetadataService.UpdateContext", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_DeleteContext_async", + "title": "DatasetService deleteContext Sample", + "origin": "API_DEFINITION", + "description": " Deletes a stored Context.", + "canonical": true, + "file": "metadata_service.delete_context.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteContext", + "fullName": "google.cloud.aiplatform.v1.MetadataService.DeleteContext", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" + }, + { + "name": "etag", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "DeleteContext", + "fullName": "google.cloud.aiplatform.v1.MetadataService.DeleteContext", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_PurgeContexts_async", + "title": "DatasetService purgeContexts Sample", + "origin": "API_DEFINITION", + "description": " Purges Contexts.", + "canonical": true, + "file": "metadata_service.purge_contexts.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "PurgeContexts", + "fullName": "google.cloud.aiplatform.v1.MetadataService.PurgeContexts", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "PurgeContexts", + "fullName": "google.cloud.aiplatform.v1.MetadataService.PurgeContexts", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_AddContextArtifactsAndExecutions_async", + "title": "DatasetService addContextArtifactsAndExecutions Sample", + "origin": "API_DEFINITION", + "description": " Adds a set of Artifacts and Executions to a Context. If any of the Artifacts or Executions have already been added to a Context, they are simply skipped.", + "canonical": true, + "file": "metadata_service.add_context_artifacts_and_executions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AddContextArtifactsAndExecutions", + "fullName": "google.cloud.aiplatform.v1.MetadataService.AddContextArtifactsAndExecutions", + "async": true, + "parameters": [ + { + "name": "context", + "type": "TYPE_STRING" + }, + { + "name": "artifacts", + "type": "TYPE_STRING[]" + }, + { + "name": "executions", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1.AddContextArtifactsAndExecutionsResponse", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "AddContextArtifactsAndExecutions", + "fullName": "google.cloud.aiplatform.v1.MetadataService.AddContextArtifactsAndExecutions", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_AddContextChildren_async", + "title": "DatasetService addContextChildren Sample", + "origin": "API_DEFINITION", + "description": " Adds a set of Contexts as children to a parent Context. If any of the child Contexts have already been added to the parent Context, they are simply skipped. If this call would create a cycle or cause any Context to have more than 10 parents, the request will fail with an INVALID_ARGUMENT error.", + "canonical": true, + "file": "metadata_service.add_context_children.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AddContextChildren", + "fullName": "google.cloud.aiplatform.v1.MetadataService.AddContextChildren", + "async": true, + "parameters": [ + { + "name": "context", + "type": "TYPE_STRING" + }, + { + "name": "child_contexts", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1.AddContextChildrenResponse", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "AddContextChildren", + "fullName": "google.cloud.aiplatform.v1.MetadataService.AddContextChildren", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_RemoveContextChildren_async", + "title": "DatasetService removeContextChildren Sample", + "origin": "API_DEFINITION", + "description": " Remove a set of children contexts from a parent Context. If any of the child Contexts were NOT added to the parent Context, they are simply skipped.", + "canonical": true, + "file": "metadata_service.remove_context_children.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RemoveContextChildren", + "fullName": "google.cloud.aiplatform.v1.MetadataService.RemoveContextChildren", + "async": true, + "parameters": [ + { + "name": "context", + "type": "TYPE_STRING" + }, + { + "name": "child_contexts", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1.RemoveContextChildrenResponse", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "RemoveContextChildren", + "fullName": "google.cloud.aiplatform.v1.MetadataService.RemoveContextChildren", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_QueryContextLineageSubgraph_async", + "title": "DatasetService queryContextLineageSubgraph Sample", + "origin": "API_DEFINITION", + "description": " Retrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph.", + "canonical": true, + "file": "metadata_service.query_context_lineage_subgraph.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "QueryContextLineageSubgraph", + "fullName": "google.cloud.aiplatform.v1.MetadataService.QueryContextLineageSubgraph", + "async": true, + "parameters": [ + { + "name": "context", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.LineageSubgraph", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "QueryContextLineageSubgraph", + "fullName": "google.cloud.aiplatform.v1.MetadataService.QueryContextLineageSubgraph", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_CreateExecution_async", + "title": "DatasetService createExecution Sample", + "origin": "API_DEFINITION", + "description": " Creates an Execution associated with a MetadataStore.", + "canonical": true, + "file": "metadata_service.create_execution.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateExecution", + "fullName": "google.cloud.aiplatform.v1.MetadataService.CreateExecution", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "execution", + "type": ".google.cloud.aiplatform.v1.Execution" + }, + { + "name": "execution_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Execution", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "CreateExecution", + "fullName": "google.cloud.aiplatform.v1.MetadataService.CreateExecution", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_GetExecution_async", + "title": "DatasetService getExecution Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a specific Execution.", + "canonical": true, + "file": "metadata_service.get_execution.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetExecution", + "fullName": "google.cloud.aiplatform.v1.MetadataService.GetExecution", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Execution", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "GetExecution", + "fullName": "google.cloud.aiplatform.v1.MetadataService.GetExecution", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_ListExecutions_async", + "title": "DatasetService listExecutions Sample", + "origin": "API_DEFINITION", + "description": " Lists Executions in the MetadataStore.", + "canonical": true, + "file": "metadata_service.list_executions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 111, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListExecutions", + "fullName": "google.cloud.aiplatform.v1.MetadataService.ListExecutions", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListExecutionsResponse", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "ListExecutions", + "fullName": "google.cloud.aiplatform.v1.MetadataService.ListExecutions", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_UpdateExecution_async", + "title": "DatasetService updateExecution Sample", + "origin": "API_DEFINITION", + "description": " Updates a stored Execution.", + "canonical": true, + "file": "metadata_service.update_execution.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateExecution", + "fullName": "google.cloud.aiplatform.v1.MetadataService.UpdateExecution", + "async": true, + "parameters": [ + { + "name": "execution", + "type": ".google.cloud.aiplatform.v1.Execution" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "allow_missing", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Execution", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "UpdateExecution", + "fullName": "google.cloud.aiplatform.v1.MetadataService.UpdateExecution", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_DeleteExecution_async", + "title": "DatasetService deleteExecution Sample", + "origin": "API_DEFINITION", + "description": " Deletes an Execution.", + "canonical": true, + "file": "metadata_service.delete_execution.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteExecution", + "fullName": "google.cloud.aiplatform.v1.MetadataService.DeleteExecution", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "etag", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "DeleteExecution", + "fullName": "google.cloud.aiplatform.v1.MetadataService.DeleteExecution", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_PurgeExecutions_async", + "title": "DatasetService purgeExecutions Sample", + "origin": "API_DEFINITION", + "description": " Purges Executions.", + "canonical": true, + "file": "metadata_service.purge_executions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "PurgeExecutions", + "fullName": "google.cloud.aiplatform.v1.MetadataService.PurgeExecutions", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "PurgeExecutions", + "fullName": "google.cloud.aiplatform.v1.MetadataService.PurgeExecutions", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_AddExecutionEvents_async", + "title": "DatasetService addExecutionEvents Sample", + "origin": "API_DEFINITION", + "description": " Adds Events to the specified Execution. An Event indicates whether an Artifact was used as an input or output for an Execution. If an Event already exists between the Execution and the Artifact, the Event is skipped.", + "canonical": true, + "file": "metadata_service.add_execution_events.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AddExecutionEvents", + "fullName": "google.cloud.aiplatform.v1.MetadataService.AddExecutionEvents", + "async": true, + "parameters": [ + { + "name": "execution", + "type": "TYPE_STRING" + }, + { + "name": "events", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1.AddExecutionEventsResponse", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "AddExecutionEvents", + "fullName": "google.cloud.aiplatform.v1.MetadataService.AddExecutionEvents", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_QueryExecutionInputsAndOutputs_async", + "title": "DatasetService queryExecutionInputsAndOutputs Sample", + "origin": "API_DEFINITION", + "description": " Obtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events.", + "canonical": true, + "file": "metadata_service.query_execution_inputs_and_outputs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "QueryExecutionInputsAndOutputs", + "fullName": "google.cloud.aiplatform.v1.MetadataService.QueryExecutionInputsAndOutputs", + "async": true, + "parameters": [ + { + "name": "execution", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.LineageSubgraph", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "QueryExecutionInputsAndOutputs", + "fullName": "google.cloud.aiplatform.v1.MetadataService.QueryExecutionInputsAndOutputs", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_CreateMetadataSchema_async", + "title": "DatasetService createMetadataSchema Sample", + "origin": "API_DEFINITION", + "description": " Creates a MetadataSchema.", + "canonical": true, + "file": "metadata_service.create_metadata_schema.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateMetadataSchema", + "fullName": "google.cloud.aiplatform.v1.MetadataService.CreateMetadataSchema", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "metadata_schema", + "type": ".google.cloud.aiplatform.v1.MetadataSchema" + }, + { + "name": "metadata_schema_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.MetadataSchema", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "CreateMetadataSchema", + "fullName": "google.cloud.aiplatform.v1.MetadataService.CreateMetadataSchema", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_GetMetadataSchema_async", + "title": "DatasetService getMetadataSchema Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a specific MetadataSchema.", + "canonical": true, + "file": "metadata_service.get_metadata_schema.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetMetadataSchema", + "fullName": "google.cloud.aiplatform.v1.MetadataService.GetMetadataSchema", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.MetadataSchema", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "GetMetadataSchema", + "fullName": "google.cloud.aiplatform.v1.MetadataService.GetMetadataSchema", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_ListMetadataSchemas_async", + "title": "DatasetService listMetadataSchemas Sample", + "origin": "API_DEFINITION", + "description": " Lists MetadataSchemas.", + "canonical": true, + "file": "metadata_service.list_metadata_schemas.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 76, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListMetadataSchemas", + "fullName": "google.cloud.aiplatform.v1.MetadataService.ListMetadataSchemas", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListMetadataSchemasResponse", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "ListMetadataSchemas", + "fullName": "google.cloud.aiplatform.v1.MetadataService.ListMetadataSchemas", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_QueryArtifactLineageSubgraph_async", + "title": "DatasetService queryArtifactLineageSubgraph Sample", + "origin": "API_DEFINITION", + "description": " Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph.", + "canonical": true, + "file": "metadata_service.query_artifact_lineage_subgraph.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 91, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "QueryArtifactLineageSubgraph", + "fullName": "google.cloud.aiplatform.v1.MetadataService.QueryArtifactLineageSubgraph", + "async": true, + "parameters": [ + { + "name": "artifact", + "type": "TYPE_STRING" + }, + { + "name": "max_hops", + "type": "TYPE_INT32" + }, + { + "name": "filter", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.LineageSubgraph", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "QueryArtifactLineageSubgraph", + "fullName": "google.cloud.aiplatform.v1.MetadataService.QueryArtifactLineageSubgraph", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MigrationService_SearchMigratableResources_async", + "title": "DatasetService searchMigratableResources Sample", + "origin": "API_DEFINITION", + "description": " Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com that can be migrated to Vertex AI's given location.", + "canonical": true, + "file": "migration_service.search_migratable_resources.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 81, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SearchMigratableResources", + "fullName": "google.cloud.aiplatform.v1.MigrationService.SearchMigratableResources", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.SearchMigratableResourcesResponse", + "client": { + "shortName": "MigrationServiceClient", + "fullName": "google.cloud.aiplatform.v1.MigrationServiceClient" + }, + "method": { + "shortName": "SearchMigratableResources", + "fullName": "google.cloud.aiplatform.v1.MigrationService.SearchMigratableResources", + "service": { + "shortName": "MigrationService", + "fullName": "google.cloud.aiplatform.v1.MigrationService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MigrationService_BatchMigrateResources_async", + "title": "DatasetService batchMigrateResources Sample", + "origin": "API_DEFINITION", + "description": " Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI.", + "canonical": true, + "file": "migration_service.batch_migrate_resources.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchMigrateResources", + "fullName": "google.cloud.aiplatform.v1.MigrationService.BatchMigrateResources", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "migrate_resource_requests", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "MigrationServiceClient", + "fullName": "google.cloud.aiplatform.v1.MigrationServiceClient" + }, + "method": { + "shortName": "BatchMigrateResources", + "fullName": "google.cloud.aiplatform.v1.MigrationService.BatchMigrateResources", + "service": { + "shortName": "MigrationService", + "fullName": "google.cloud.aiplatform.v1.MigrationService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ModelGardenService_GetPublisherModel_async", + "title": "DatasetService getPublisherModel Sample", + "origin": "API_DEFINITION", + "description": " Gets a Model Garden publisher model.", + "canonical": true, + "file": "model_garden_service.get_publisher_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 64, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetPublisherModel", + "fullName": "google.cloud.aiplatform.v1.ModelGardenService.GetPublisherModel", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "language_code", + "type": "TYPE_STRING" + }, + { + "name": "view", + "type": ".google.cloud.aiplatform.v1.PublisherModelView" + } + ], + "resultType": ".google.cloud.aiplatform.v1.PublisherModel", + "client": { + "shortName": "ModelGardenServiceClient", + "fullName": "google.cloud.aiplatform.v1.ModelGardenServiceClient" + }, + "method": { + "shortName": "GetPublisherModel", + "fullName": "google.cloud.aiplatform.v1.ModelGardenService.GetPublisherModel", + "service": { + "shortName": "ModelGardenService", + "fullName": "google.cloud.aiplatform.v1.ModelGardenService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ModelService_UploadModel_async", + "title": "DatasetService uploadModel Sample", + "origin": "API_DEFINITION", + "description": " Uploads a Model artifact into Vertex AI.", + "canonical": true, + "file": "model_service.upload_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 82, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UploadModel", + "fullName": "google.cloud.aiplatform.v1.ModelService.UploadModel", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "parent_model", + "type": "TYPE_STRING" + }, + { + "name": "model_id", + "type": "TYPE_STRING" + }, + { + "name": "model", + "type": ".google.cloud.aiplatform.v1.Model" + }, + { + "name": "service_account", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1.ModelServiceClient" + }, + "method": { + "shortName": "UploadModel", + "fullName": "google.cloud.aiplatform.v1.ModelService.UploadModel", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ModelService_GetModel_async", + "title": "DatasetService getModel Sample", + "origin": "API_DEFINITION", + "description": " Gets a Model.", + "canonical": true, + "file": "model_service.get_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetModel", + "fullName": "google.cloud.aiplatform.v1.ModelService.GetModel", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Model", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1.ModelServiceClient" + }, + "method": { + "shortName": "GetModel", + "fullName": "google.cloud.aiplatform.v1.ModelService.GetModel", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ModelService_ListModels_async", + "title": "DatasetService listModels Sample", + "origin": "API_DEFINITION", + "description": " Lists Models in a Location.", + "canonical": true, + "file": "model_service.list_models.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 100, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListModels", + "fullName": "google.cloud.aiplatform.v1.ModelService.ListModels", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListModelsResponse", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1.ModelServiceClient" + }, + "method": { + "shortName": "ListModels", + "fullName": "google.cloud.aiplatform.v1.ModelService.ListModels", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ModelService_ListModelVersions_async", + "title": "DatasetService listModelVersions Sample", + "origin": "API_DEFINITION", + "description": " Lists versions of the specified model.", + "canonical": true, + "file": "model_service.list_model_versions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 92, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListModelVersions", + "fullName": "google.cloud.aiplatform.v1.ModelService.ListModelVersions", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListModelVersionsResponse", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1.ModelServiceClient" + }, + "method": { + "shortName": "ListModelVersions", + "fullName": "google.cloud.aiplatform.v1.ModelService.ListModelVersions", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ModelService_UpdateModel_async", + "title": "DatasetService updateModel Sample", + "origin": "API_DEFINITION", + "description": " Updates a Model.", + "canonical": true, + "file": "model_service.update_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 77, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateModel", + "fullName": "google.cloud.aiplatform.v1.ModelService.UpdateModel", + "async": true, + "parameters": [ + { + "name": "model", + "type": ".google.cloud.aiplatform.v1.Model" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Model", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1.ModelServiceClient" + }, + "method": { + "shortName": "UpdateModel", + "fullName": "google.cloud.aiplatform.v1.ModelService.UpdateModel", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ModelService_UpdateExplanationDataset_async", + "title": "DatasetService updateExplanationDataset Sample", + "origin": "API_DEFINITION", + "description": " Incrementally update the dataset used for an examples model.", + "canonical": true, + "file": "model_service.update_explanation_dataset.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateExplanationDataset", + "fullName": "google.cloud.aiplatform.v1.ModelService.UpdateExplanationDataset", + "async": true, + "parameters": [ + { + "name": "model", + "type": "TYPE_STRING" + }, + { + "name": "examples", + "type": ".google.cloud.aiplatform.v1.Examples" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1.ModelServiceClient" + }, + "method": { + "shortName": "UpdateExplanationDataset", + "fullName": "google.cloud.aiplatform.v1.ModelService.UpdateExplanationDataset", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ModelService_DeleteModel_async", + "title": "DatasetService deleteModel Sample", + "origin": "API_DEFINITION", + "description": " Deletes a Model. A model cannot be deleted if any [Endpoint][google.cloud.aiplatform.v1.Endpoint] resource has a [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] based on the model in its [deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models] field.", + "canonical": true, + "file": "model_service.delete_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteModel", + "fullName": "google.cloud.aiplatform.v1.ModelService.DeleteModel", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1.ModelServiceClient" + }, + "method": { + "shortName": "DeleteModel", + "fullName": "google.cloud.aiplatform.v1.ModelService.DeleteModel", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ModelService_DeleteModelVersion_async", + "title": "DatasetService deleteModelVersion Sample", + "origin": "API_DEFINITION", + "description": " Deletes a Model version. Model version can only be deleted if there are no [DeployedModels][google.cloud.aiplatform.v1.DeployedModel] created from it. Deleting the only version in the Model is not allowed. Use [DeleteModel][google.cloud.aiplatform.v1.ModelService.DeleteModel] for deleting the Model instead.", + "canonical": true, + "file": "model_service.delete_model_version.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteModelVersion", + "fullName": "google.cloud.aiplatform.v1.ModelService.DeleteModelVersion", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1.ModelServiceClient" + }, + "method": { + "shortName": "DeleteModelVersion", + "fullName": "google.cloud.aiplatform.v1.ModelService.DeleteModelVersion", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ModelService_MergeVersionAliases_async", + "title": "DatasetService mergeVersionAliases Sample", + "origin": "API_DEFINITION", + "description": " Merges a set of aliases for a Model version.", + "canonical": true, + "file": "model_service.merge_version_aliases.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 70, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "MergeVersionAliases", + "fullName": "google.cloud.aiplatform.v1.ModelService.MergeVersionAliases", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "version_aliases", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Model", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1.ModelServiceClient" + }, + "method": { + "shortName": "MergeVersionAliases", + "fullName": "google.cloud.aiplatform.v1.ModelService.MergeVersionAliases", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ModelService_ExportModel_async", + "title": "DatasetService exportModel Sample", + "origin": "API_DEFINITION", + "description": " Exports a trained, exportable Model to a location specified by the user. A Model is considered to be exportable if it has at least one [supported export format][google.cloud.aiplatform.v1.Model.supported_export_formats].", + "canonical": true, + "file": "model_service.export_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ExportModel", + "fullName": "google.cloud.aiplatform.v1.ModelService.ExportModel", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "output_config", + "type": ".google.cloud.aiplatform.v1.ExportModelRequest.OutputConfig" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1.ModelServiceClient" + }, + "method": { + "shortName": "ExportModel", + "fullName": "google.cloud.aiplatform.v1.ModelService.ExportModel", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ModelService_CopyModel_async", + "title": "DatasetService copyModel Sample", + "origin": "API_DEFINITION", + "description": " Copies an already existing Vertex AI Model into the specified Location. The source Model must exist in the same Project. When copying custom Models, the users themselves are responsible for [Model.metadata][google.cloud.aiplatform.v1.Model.metadata] content to be region-agnostic, as well as making sure that any resources (e.g. files) it depends on remain accessible.", + "canonical": true, + "file": "model_service.copy_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CopyModel", + "fullName": "google.cloud.aiplatform.v1.ModelService.CopyModel", + "async": true, + "parameters": [ + { + "name": "model_id", + "type": "TYPE_STRING" + }, + { + "name": "parent_model", + "type": "TYPE_STRING" + }, + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "source_model", + "type": "TYPE_STRING" + }, + { + "name": "encryption_spec", + "type": ".google.cloud.aiplatform.v1.EncryptionSpec" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1.ModelServiceClient" + }, + "method": { + "shortName": "CopyModel", + "fullName": "google.cloud.aiplatform.v1.ModelService.CopyModel", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ModelService_ImportModelEvaluation_async", + "title": "DatasetService importModelEvaluation Sample", + "origin": "API_DEFINITION", + "description": " Imports an externally generated ModelEvaluation.", + "canonical": true, + "file": "model_service.import_model_evaluation.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ImportModelEvaluation", + "fullName": "google.cloud.aiplatform.v1.ModelService.ImportModelEvaluation", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "model_evaluation", + "type": ".google.cloud.aiplatform.v1.ModelEvaluation" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ModelEvaluation", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1.ModelServiceClient" + }, + "method": { + "shortName": "ImportModelEvaluation", + "fullName": "google.cloud.aiplatform.v1.ModelService.ImportModelEvaluation", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ModelService_BatchImportModelEvaluationSlices_async", + "title": "DatasetService batchImportModelEvaluationSlices Sample", + "origin": "API_DEFINITION", + "description": " Imports a list of externally generated ModelEvaluationSlice.", + "canonical": true, + "file": "model_service.batch_import_model_evaluation_slices.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchImportModelEvaluationSlices", + "fullName": "google.cloud.aiplatform.v1.ModelService.BatchImportModelEvaluationSlices", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "model_evaluation_slices", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1.BatchImportModelEvaluationSlicesResponse", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1.ModelServiceClient" + }, + "method": { + "shortName": "BatchImportModelEvaluationSlices", + "fullName": "google.cloud.aiplatform.v1.ModelService.BatchImportModelEvaluationSlices", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ModelService_BatchImportEvaluatedAnnotations_async", + "title": "DatasetService batchImportEvaluatedAnnotations Sample", + "origin": "API_DEFINITION", + "description": " Imports a list of externally generated EvaluatedAnnotations.", + "canonical": true, + "file": "model_service.batch_import_evaluated_annotations.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchImportEvaluatedAnnotations", + "fullName": "google.cloud.aiplatform.v1.ModelService.BatchImportEvaluatedAnnotations", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "evaluated_annotations", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1.BatchImportEvaluatedAnnotationsResponse", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1.ModelServiceClient" + }, + "method": { + "shortName": "BatchImportEvaluatedAnnotations", + "fullName": "google.cloud.aiplatform.v1.ModelService.BatchImportEvaluatedAnnotations", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ModelService_GetModelEvaluation_async", + "title": "DatasetService getModelEvaluation Sample", + "origin": "API_DEFINITION", + "description": " Gets a ModelEvaluation.", + "canonical": true, + "file": "model_service.get_model_evaluation.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetModelEvaluation", + "fullName": "google.cloud.aiplatform.v1.ModelService.GetModelEvaluation", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ModelEvaluation", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1.ModelServiceClient" + }, + "method": { + "shortName": "GetModelEvaluation", + "fullName": "google.cloud.aiplatform.v1.ModelService.GetModelEvaluation", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ModelService_ListModelEvaluations_async", + "title": "DatasetService listModelEvaluations Sample", + "origin": "API_DEFINITION", + "description": " Lists ModelEvaluations in a Model.", + "canonical": true, + "file": "model_service.list_model_evaluations.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 77, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListModelEvaluations", + "fullName": "google.cloud.aiplatform.v1.ModelService.ListModelEvaluations", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListModelEvaluationsResponse", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1.ModelServiceClient" + }, + "method": { + "shortName": "ListModelEvaluations", + "fullName": "google.cloud.aiplatform.v1.ModelService.ListModelEvaluations", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ModelService_GetModelEvaluationSlice_async", + "title": "DatasetService getModelEvaluationSlice Sample", + "origin": "API_DEFINITION", + "description": " Gets a ModelEvaluationSlice.", + "canonical": true, + "file": "model_service.get_model_evaluation_slice.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetModelEvaluationSlice", + "fullName": "google.cloud.aiplatform.v1.ModelService.GetModelEvaluationSlice", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ModelEvaluationSlice", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1.ModelServiceClient" + }, + "method": { + "shortName": "GetModelEvaluationSlice", + "fullName": "google.cloud.aiplatform.v1.ModelService.GetModelEvaluationSlice", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ModelService_ListModelEvaluationSlices_async", + "title": "DatasetService listModelEvaluationSlices Sample", + "origin": "API_DEFINITION", + "description": " Lists ModelEvaluationSlices in a ModelEvaluation.", + "canonical": true, + "file": "model_service.list_model_evaluation_slices.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListModelEvaluationSlices", + "fullName": "google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListModelEvaluationSlicesResponse", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1.ModelServiceClient" + }, + "method": { + "shortName": "ListModelEvaluationSlices", + "fullName": "google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_PipelineService_CreateTrainingPipeline_async", + "title": "DatasetService createTrainingPipeline Sample", + "origin": "API_DEFINITION", + "description": " Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.", + "canonical": true, + "file": "pipeline_service.create_training_pipeline.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateTrainingPipeline", + "fullName": "google.cloud.aiplatform.v1.PipelineService.CreateTrainingPipeline", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "training_pipeline", + "type": ".google.cloud.aiplatform.v1.TrainingPipeline" + } + ], + "resultType": ".google.cloud.aiplatform.v1.TrainingPipeline", + "client": { + "shortName": "PipelineServiceClient", + "fullName": "google.cloud.aiplatform.v1.PipelineServiceClient" + }, + "method": { + "shortName": "CreateTrainingPipeline", + "fullName": "google.cloud.aiplatform.v1.PipelineService.CreateTrainingPipeline", + "service": { + "shortName": "PipelineService", + "fullName": "google.cloud.aiplatform.v1.PipelineService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_PipelineService_GetTrainingPipeline_async", + "title": "DatasetService getTrainingPipeline Sample", + "origin": "API_DEFINITION", + "description": " Gets a TrainingPipeline.", + "canonical": true, + "file": "pipeline_service.get_training_pipeline.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetTrainingPipeline", + "fullName": "google.cloud.aiplatform.v1.PipelineService.GetTrainingPipeline", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.TrainingPipeline", + "client": { + "shortName": "PipelineServiceClient", + "fullName": "google.cloud.aiplatform.v1.PipelineServiceClient" + }, + "method": { + "shortName": "GetTrainingPipeline", + "fullName": "google.cloud.aiplatform.v1.PipelineService.GetTrainingPipeline", + "service": { + "shortName": "PipelineService", + "fullName": "google.cloud.aiplatform.v1.PipelineService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_PipelineService_ListTrainingPipelines_async", + "title": "DatasetService listTrainingPipelines Sample", + "origin": "API_DEFINITION", + "description": " Lists TrainingPipelines in a Location.", + "canonical": true, + "file": "pipeline_service.list_training_pipelines.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 92, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListTrainingPipelines", + "fullName": "google.cloud.aiplatform.v1.PipelineService.ListTrainingPipelines", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListTrainingPipelinesResponse", + "client": { + "shortName": "PipelineServiceClient", + "fullName": "google.cloud.aiplatform.v1.PipelineServiceClient" + }, + "method": { + "shortName": "ListTrainingPipelines", + "fullName": "google.cloud.aiplatform.v1.PipelineService.ListTrainingPipelines", + "service": { + "shortName": "PipelineService", + "fullName": "google.cloud.aiplatform.v1.PipelineService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_PipelineService_DeleteTrainingPipeline_async", + "title": "DatasetService deleteTrainingPipeline Sample", + "origin": "API_DEFINITION", + "description": " Deletes a TrainingPipeline.", + "canonical": true, + "file": "pipeline_service.delete_training_pipeline.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteTrainingPipeline", + "fullName": "google.cloud.aiplatform.v1.PipelineService.DeleteTrainingPipeline", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "PipelineServiceClient", + "fullName": "google.cloud.aiplatform.v1.PipelineServiceClient" + }, + "method": { + "shortName": "DeleteTrainingPipeline", + "fullName": "google.cloud.aiplatform.v1.PipelineService.DeleteTrainingPipeline", + "service": { + "shortName": "PipelineService", + "fullName": "google.cloud.aiplatform.v1.PipelineService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_PipelineService_CancelTrainingPipeline_async", + "title": "DatasetService cancelTrainingPipeline Sample", + "origin": "API_DEFINITION", + "description": " Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use [PipelineService.GetTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.GetTrainingPipeline] or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead it becomes a pipeline with a [TrainingPipeline.error][google.cloud.aiplatform.v1.TrainingPipeline.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [TrainingPipeline.state][google.cloud.aiplatform.v1.TrainingPipeline.state] is set to `CANCELLED`.", + "canonical": true, + "file": "pipeline_service.cancel_training_pipeline.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CancelTrainingPipeline", + "fullName": "google.cloud.aiplatform.v1.PipelineService.CancelTrainingPipeline", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "PipelineServiceClient", + "fullName": "google.cloud.aiplatform.v1.PipelineServiceClient" + }, + "method": { + "shortName": "CancelTrainingPipeline", + "fullName": "google.cloud.aiplatform.v1.PipelineService.CancelTrainingPipeline", + "service": { + "shortName": "PipelineService", + "fullName": "google.cloud.aiplatform.v1.PipelineService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_PipelineService_CreatePipelineJob_async", + "title": "DatasetService createPipelineJob Sample", + "origin": "API_DEFINITION", + "description": " Creates a PipelineJob. A PipelineJob will run immediately when created.", + "canonical": true, + "file": "pipeline_service.create_pipeline_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreatePipelineJob", + "fullName": "google.cloud.aiplatform.v1.PipelineService.CreatePipelineJob", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "pipeline_job", + "type": ".google.cloud.aiplatform.v1.PipelineJob" + }, + { + "name": "pipeline_job_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.PipelineJob", + "client": { + "shortName": "PipelineServiceClient", + "fullName": "google.cloud.aiplatform.v1.PipelineServiceClient" + }, + "method": { + "shortName": "CreatePipelineJob", + "fullName": "google.cloud.aiplatform.v1.PipelineService.CreatePipelineJob", + "service": { + "shortName": "PipelineService", + "fullName": "google.cloud.aiplatform.v1.PipelineService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_PipelineService_GetPipelineJob_async", + "title": "DatasetService getPipelineJob Sample", + "origin": "API_DEFINITION", + "description": " Gets a PipelineJob.", + "canonical": true, + "file": "pipeline_service.get_pipeline_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetPipelineJob", + "fullName": "google.cloud.aiplatform.v1.PipelineService.GetPipelineJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.PipelineJob", + "client": { + "shortName": "PipelineServiceClient", + "fullName": "google.cloud.aiplatform.v1.PipelineServiceClient" + }, + "method": { + "shortName": "GetPipelineJob", + "fullName": "google.cloud.aiplatform.v1.PipelineService.GetPipelineJob", + "service": { + "shortName": "PipelineService", + "fullName": "google.cloud.aiplatform.v1.PipelineService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_PipelineService_ListPipelineJobs_async", + "title": "DatasetService listPipelineJobs Sample", + "origin": "API_DEFINITION", + "description": " Lists PipelineJobs in a Location.", + "canonical": true, + "file": "pipeline_service.list_pipeline_jobs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 120, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListPipelineJobs", + "fullName": "google.cloud.aiplatform.v1.PipelineService.ListPipelineJobs", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListPipelineJobsResponse", + "client": { + "shortName": "PipelineServiceClient", + "fullName": "google.cloud.aiplatform.v1.PipelineServiceClient" + }, + "method": { + "shortName": "ListPipelineJobs", + "fullName": "google.cloud.aiplatform.v1.PipelineService.ListPipelineJobs", + "service": { + "shortName": "PipelineService", + "fullName": "google.cloud.aiplatform.v1.PipelineService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_PipelineService_DeletePipelineJob_async", + "title": "DatasetService deletePipelineJob Sample", + "origin": "API_DEFINITION", + "description": " Deletes a PipelineJob.", + "canonical": true, + "file": "pipeline_service.delete_pipeline_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeletePipelineJob", + "fullName": "google.cloud.aiplatform.v1.PipelineService.DeletePipelineJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "PipelineServiceClient", + "fullName": "google.cloud.aiplatform.v1.PipelineServiceClient" + }, + "method": { + "shortName": "DeletePipelineJob", + "fullName": "google.cloud.aiplatform.v1.PipelineService.DeletePipelineJob", + "service": { + "shortName": "PipelineService", + "fullName": "google.cloud.aiplatform.v1.PipelineService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_PipelineService_CancelPipelineJob_async", + "title": "DatasetService cancelPipelineJob Sample", + "origin": "API_DEFINITION", + "description": " Cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use [PipelineService.GetPipelineJob][google.cloud.aiplatform.v1.PipelineService.GetPipelineJob] or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the PipelineJob is not deleted; instead it becomes a pipeline with a [PipelineJob.error][google.cloud.aiplatform.v1.PipelineJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [PipelineJob.state][google.cloud.aiplatform.v1.PipelineJob.state] is set to `CANCELLED`.", + "canonical": true, + "file": "pipeline_service.cancel_pipeline_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CancelPipelineJob", + "fullName": "google.cloud.aiplatform.v1.PipelineService.CancelPipelineJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "PipelineServiceClient", + "fullName": "google.cloud.aiplatform.v1.PipelineServiceClient" + }, + "method": { + "shortName": "CancelPipelineJob", + "fullName": "google.cloud.aiplatform.v1.PipelineService.CancelPipelineJob", + "service": { + "shortName": "PipelineService", + "fullName": "google.cloud.aiplatform.v1.PipelineService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_PredictionService_Predict_async", + "title": "DatasetService predict Sample", + "origin": "API_DEFINITION", + "description": " Perform an online prediction.", + "canonical": true, + "file": "prediction_service.predict.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 76, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Predict", + "fullName": "google.cloud.aiplatform.v1.PredictionService.Predict", + "async": true, + "parameters": [ + { + "name": "endpoint", + "type": "TYPE_STRING" + }, + { + "name": "instances", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "parameters", + "type": ".google.protobuf.Value" + } + ], + "resultType": ".google.cloud.aiplatform.v1.PredictResponse", + "client": { + "shortName": "PredictionServiceClient", + "fullName": "google.cloud.aiplatform.v1.PredictionServiceClient" + }, + "method": { + "shortName": "Predict", + "fullName": "google.cloud.aiplatform.v1.PredictionService.Predict", + "service": { + "shortName": "PredictionService", + "fullName": "google.cloud.aiplatform.v1.PredictionService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_PredictionService_RawPredict_async", + "title": "DatasetService rawPredict Sample", + "origin": "API_DEFINITION", + "description": " Perform an online prediction with an arbitrary HTTP payload. The response includes the following HTTP headers: * `X-Vertex-AI-Endpoint-Id`: ID of the [Endpoint][google.cloud.aiplatform.v1.Endpoint] that served this prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] that served this prediction.", + "canonical": true, + "file": "prediction_service.raw_predict.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RawPredict", + "fullName": "google.cloud.aiplatform.v1.PredictionService.RawPredict", + "async": true, + "parameters": [ + { + "name": "endpoint", + "type": "TYPE_STRING" + }, + { + "name": "http_body", + "type": ".google.api.HttpBody" + } + ], + "resultType": ".google.api.HttpBody", + "client": { + "shortName": "PredictionServiceClient", + "fullName": "google.cloud.aiplatform.v1.PredictionServiceClient" + }, + "method": { + "shortName": "RawPredict", + "fullName": "google.cloud.aiplatform.v1.PredictionService.RawPredict", + "service": { + "shortName": "PredictionService", + "fullName": "google.cloud.aiplatform.v1.PredictionService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_PredictionService_ServerStreamingPredict_async", + "title": "DatasetService serverStreamingPredict Sample", + "origin": "API_DEFINITION", + "description": " Perform a server-side streaming online prediction request for Vertex LLM streaming.", + "canonical": true, + "file": "prediction_service.server_streaming_predict.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ServerStreamingPredict", + "fullName": "google.cloud.aiplatform.v1.PredictionService.ServerStreamingPredict", + "async": true, + "parameters": [ + { + "name": "endpoint", + "type": "TYPE_STRING" + }, + { + "name": "inputs", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "parameters", + "type": ".google.cloud.aiplatform.v1.Tensor" + } + ], + "resultType": ".google.cloud.aiplatform.v1.StreamingPredictResponse", + "client": { + "shortName": "PredictionServiceClient", + "fullName": "google.cloud.aiplatform.v1.PredictionServiceClient" + }, + "method": { + "shortName": "ServerStreamingPredict", + "fullName": "google.cloud.aiplatform.v1.PredictionService.ServerStreamingPredict", + "service": { + "shortName": "PredictionService", + "fullName": "google.cloud.aiplatform.v1.PredictionService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_PredictionService_Explain_async", + "title": "DatasetService explain Sample", + "origin": "API_DEFINITION", + "description": " Perform an online explanation. If [deployed_model_id][google.cloud.aiplatform.v1.ExplainRequest.deployed_model_id] is specified, the corresponding DeployModel must have [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] populated. If [deployed_model_id][google.cloud.aiplatform.v1.ExplainRequest.deployed_model_id] is not specified, all DeployedModels must have [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] populated.", + "canonical": true, + "file": "prediction_service.explain.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 93, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Explain", + "fullName": "google.cloud.aiplatform.v1.PredictionService.Explain", + "async": true, + "parameters": [ + { + "name": "endpoint", + "type": "TYPE_STRING" + }, + { + "name": "instances", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "parameters", + "type": ".google.protobuf.Value" + }, + { + "name": "explanation_spec_override", + "type": ".google.cloud.aiplatform.v1.ExplanationSpecOverride" + }, + { + "name": "deployed_model_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ExplainResponse", + "client": { + "shortName": "PredictionServiceClient", + "fullName": "google.cloud.aiplatform.v1.PredictionServiceClient" + }, + "method": { + "shortName": "Explain", + "fullName": "google.cloud.aiplatform.v1.PredictionService.Explain", + "service": { + "shortName": "PredictionService", + "fullName": "google.cloud.aiplatform.v1.PredictionService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ScheduleService_CreateSchedule_async", + "title": "DatasetService createSchedule Sample", + "origin": "API_DEFINITION", + "description": " Creates a Schedule.", + "canonical": true, + "file": "schedule_service.create_schedule.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateSchedule", + "fullName": "google.cloud.aiplatform.v1.ScheduleService.CreateSchedule", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "schedule", + "type": ".google.cloud.aiplatform.v1.Schedule" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Schedule", + "client": { + "shortName": "ScheduleServiceClient", + "fullName": "google.cloud.aiplatform.v1.ScheduleServiceClient" + }, + "method": { + "shortName": "CreateSchedule", + "fullName": "google.cloud.aiplatform.v1.ScheduleService.CreateSchedule", + "service": { + "shortName": "ScheduleService", + "fullName": "google.cloud.aiplatform.v1.ScheduleService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ScheduleService_DeleteSchedule_async", + "title": "DatasetService deleteSchedule Sample", + "origin": "API_DEFINITION", + "description": " Deletes a Schedule.", + "canonical": true, + "file": "schedule_service.delete_schedule.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteSchedule", + "fullName": "google.cloud.aiplatform.v1.ScheduleService.DeleteSchedule", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ScheduleServiceClient", + "fullName": "google.cloud.aiplatform.v1.ScheduleServiceClient" + }, + "method": { + "shortName": "DeleteSchedule", + "fullName": "google.cloud.aiplatform.v1.ScheduleService.DeleteSchedule", + "service": { + "shortName": "ScheduleService", + "fullName": "google.cloud.aiplatform.v1.ScheduleService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ScheduleService_GetSchedule_async", + "title": "DatasetService getSchedule Sample", + "origin": "API_DEFINITION", + "description": " Gets a Schedule.", + "canonical": true, + "file": "schedule_service.get_schedule.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetSchedule", + "fullName": "google.cloud.aiplatform.v1.ScheduleService.GetSchedule", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Schedule", + "client": { + "shortName": "ScheduleServiceClient", + "fullName": "google.cloud.aiplatform.v1.ScheduleServiceClient" + }, + "method": { + "shortName": "GetSchedule", + "fullName": "google.cloud.aiplatform.v1.ScheduleService.GetSchedule", + "service": { + "shortName": "ScheduleService", + "fullName": "google.cloud.aiplatform.v1.ScheduleService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ScheduleService_ListSchedules_async", + "title": "DatasetService listSchedules Sample", + "origin": "API_DEFINITION", + "description": " Lists Schedules in a Location.", + "canonical": true, + "file": "schedule_service.list_schedules.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 114, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListSchedules", + "fullName": "google.cloud.aiplatform.v1.ScheduleService.ListSchedules", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListSchedulesResponse", + "client": { + "shortName": "ScheduleServiceClient", + "fullName": "google.cloud.aiplatform.v1.ScheduleServiceClient" + }, + "method": { + "shortName": "ListSchedules", + "fullName": "google.cloud.aiplatform.v1.ScheduleService.ListSchedules", + "service": { + "shortName": "ScheduleService", + "fullName": "google.cloud.aiplatform.v1.ScheduleService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ScheduleService_PauseSchedule_async", + "title": "DatasetService pauseSchedule Sample", + "origin": "API_DEFINITION", + "description": " Pauses a Schedule. Will mark [Schedule.state][google.cloud.aiplatform.v1.Schedule.state] to 'PAUSED'. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled.", + "canonical": true, + "file": "schedule_service.pause_schedule.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "PauseSchedule", + "fullName": "google.cloud.aiplatform.v1.ScheduleService.PauseSchedule", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "ScheduleServiceClient", + "fullName": "google.cloud.aiplatform.v1.ScheduleServiceClient" + }, + "method": { + "shortName": "PauseSchedule", + "fullName": "google.cloud.aiplatform.v1.ScheduleService.PauseSchedule", + "service": { + "shortName": "ScheduleService", + "fullName": "google.cloud.aiplatform.v1.ScheduleService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ScheduleService_ResumeSchedule_async", + "title": "DatasetService resumeSchedule Sample", + "origin": "API_DEFINITION", + "description": " Resumes a paused Schedule to start scheduling new runs. Will mark [Schedule.state][google.cloud.aiplatform.v1.Schedule.state] to 'ACTIVE'. Only paused Schedule can be resumed. When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If [Schedule.catchUp][] is set up true, all missed runs will be scheduled for backfill first.", + "canonical": true, + "file": "schedule_service.resume_schedule.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ResumeSchedule", + "fullName": "google.cloud.aiplatform.v1.ScheduleService.ResumeSchedule", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "catch_up", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "ScheduleServiceClient", + "fullName": "google.cloud.aiplatform.v1.ScheduleServiceClient" + }, + "method": { + "shortName": "ResumeSchedule", + "fullName": "google.cloud.aiplatform.v1.ScheduleService.ResumeSchedule", + "service": { + "shortName": "ScheduleService", + "fullName": "google.cloud.aiplatform.v1.ScheduleService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ScheduleService_UpdateSchedule_async", + "title": "DatasetService updateSchedule Sample", + "origin": "API_DEFINITION", + "description": " Updates an active or paused Schedule. When the Schedule is updated, new runs will be scheduled starting from the updated next execution time after the update time based on the time_specification in the updated Schedule. All unstarted runs before the update time will be skipped while already created runs will NOT be paused or canceled.", + "canonical": true, + "file": "schedule_service.update_schedule.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateSchedule", + "fullName": "google.cloud.aiplatform.v1.ScheduleService.UpdateSchedule", + "async": true, + "parameters": [ + { + "name": "schedule", + "type": ".google.cloud.aiplatform.v1.Schedule" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Schedule", + "client": { + "shortName": "ScheduleServiceClient", + "fullName": "google.cloud.aiplatform.v1.ScheduleServiceClient" + }, + "method": { + "shortName": "UpdateSchedule", + "fullName": "google.cloud.aiplatform.v1.ScheduleService.UpdateSchedule", + "service": { + "shortName": "ScheduleService", + "fullName": "google.cloud.aiplatform.v1.ScheduleService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_SpecialistPoolService_CreateSpecialistPool_async", + "title": "DatasetService createSpecialistPool Sample", + "origin": "API_DEFINITION", + "description": " Creates a SpecialistPool.", + "canonical": true, + "file": "specialist_pool_service.create_specialist_pool.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateSpecialistPool", + "fullName": "google.cloud.aiplatform.v1.SpecialistPoolService.CreateSpecialistPool", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "specialist_pool", + "type": ".google.cloud.aiplatform.v1.SpecialistPool" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "SpecialistPoolServiceClient", + "fullName": "google.cloud.aiplatform.v1.SpecialistPoolServiceClient" + }, + "method": { + "shortName": "CreateSpecialistPool", + "fullName": "google.cloud.aiplatform.v1.SpecialistPoolService.CreateSpecialistPool", + "service": { + "shortName": "SpecialistPoolService", + "fullName": "google.cloud.aiplatform.v1.SpecialistPoolService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_SpecialistPoolService_GetSpecialistPool_async", + "title": "DatasetService getSpecialistPool Sample", + "origin": "API_DEFINITION", + "description": " Gets a SpecialistPool.", + "canonical": true, + "file": "specialist_pool_service.get_specialist_pool.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetSpecialistPool", + "fullName": "google.cloud.aiplatform.v1.SpecialistPoolService.GetSpecialistPool", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.SpecialistPool", + "client": { + "shortName": "SpecialistPoolServiceClient", + "fullName": "google.cloud.aiplatform.v1.SpecialistPoolServiceClient" + }, + "method": { + "shortName": "GetSpecialistPool", + "fullName": "google.cloud.aiplatform.v1.SpecialistPoolService.GetSpecialistPool", + "service": { + "shortName": "SpecialistPoolService", + "fullName": "google.cloud.aiplatform.v1.SpecialistPoolService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_SpecialistPoolService_ListSpecialistPools_async", + "title": "DatasetService listSpecialistPools Sample", + "origin": "API_DEFINITION", + "description": " Lists SpecialistPools in a Location.", + "canonical": true, + "file": "specialist_pool_service.list_specialist_pools.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 73, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListSpecialistPools", + "fullName": "google.cloud.aiplatform.v1.SpecialistPoolService.ListSpecialistPools", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListSpecialistPoolsResponse", + "client": { + "shortName": "SpecialistPoolServiceClient", + "fullName": "google.cloud.aiplatform.v1.SpecialistPoolServiceClient" + }, + "method": { + "shortName": "ListSpecialistPools", + "fullName": "google.cloud.aiplatform.v1.SpecialistPoolService.ListSpecialistPools", + "service": { + "shortName": "SpecialistPoolService", + "fullName": "google.cloud.aiplatform.v1.SpecialistPoolService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_SpecialistPoolService_DeleteSpecialistPool_async", + "title": "DatasetService deleteSpecialistPool Sample", + "origin": "API_DEFINITION", + "description": " Deletes a SpecialistPool as well as all Specialists in the pool.", + "canonical": true, + "file": "specialist_pool_service.delete_specialist_pool.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteSpecialistPool", + "fullName": "google.cloud.aiplatform.v1.SpecialistPoolService.DeleteSpecialistPool", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "SpecialistPoolServiceClient", + "fullName": "google.cloud.aiplatform.v1.SpecialistPoolServiceClient" + }, + "method": { + "shortName": "DeleteSpecialistPool", + "fullName": "google.cloud.aiplatform.v1.SpecialistPoolService.DeleteSpecialistPool", + "service": { + "shortName": "SpecialistPoolService", + "fullName": "google.cloud.aiplatform.v1.SpecialistPoolService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_SpecialistPoolService_UpdateSpecialistPool_async", + "title": "DatasetService updateSpecialistPool Sample", + "origin": "API_DEFINITION", + "description": " Updates a SpecialistPool.", + "canonical": true, + "file": "specialist_pool_service.update_specialist_pool.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateSpecialistPool", + "fullName": "google.cloud.aiplatform.v1.SpecialistPoolService.UpdateSpecialistPool", + "async": true, + "parameters": [ + { + "name": "specialist_pool", + "type": ".google.cloud.aiplatform.v1.SpecialistPool" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "SpecialistPoolServiceClient", + "fullName": "google.cloud.aiplatform.v1.SpecialistPoolServiceClient" + }, + "method": { + "shortName": "UpdateSpecialistPool", + "fullName": "google.cloud.aiplatform.v1.SpecialistPoolService.UpdateSpecialistPool", + "service": { + "shortName": "SpecialistPoolService", + "fullName": "google.cloud.aiplatform.v1.SpecialistPoolService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_CreateTensorboard_async", + "title": "DatasetService createTensorboard Sample", + "origin": "API_DEFINITION", + "description": " Creates a Tensorboard.", + "canonical": true, + "file": "tensorboard_service.create_tensorboard.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateTensorboard", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.CreateTensorboard", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "tensorboard", + "type": ".google.cloud.aiplatform.v1.Tensorboard" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "CreateTensorboard", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.CreateTensorboard", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_GetTensorboard_async", + "title": "DatasetService getTensorboard Sample", + "origin": "API_DEFINITION", + "description": " Gets a Tensorboard.", + "canonical": true, + "file": "tensorboard_service.get_tensorboard.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetTensorboard", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.GetTensorboard", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Tensorboard", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "GetTensorboard", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.GetTensorboard", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_UpdateTensorboard_async", + "title": "DatasetService updateTensorboard Sample", + "origin": "API_DEFINITION", + "description": " Updates a Tensorboard.", + "canonical": true, + "file": "tensorboard_service.update_tensorboard.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateTensorboard", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.UpdateTensorboard", + "async": true, + "parameters": [ + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "tensorboard", + "type": ".google.cloud.aiplatform.v1.Tensorboard" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "UpdateTensorboard", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.UpdateTensorboard", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_ListTensorboards_async", + "title": "DatasetService listTensorboards Sample", + "origin": "API_DEFINITION", + "description": " Lists Tensorboards in a Location.", + "canonical": true, + "file": "tensorboard_service.list_tensorboards.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 85, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListTensorboards", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.ListTensorboards", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListTensorboardsResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "ListTensorboards", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.ListTensorboards", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_DeleteTensorboard_async", + "title": "DatasetService deleteTensorboard Sample", + "origin": "API_DEFINITION", + "description": " Deletes a Tensorboard.", + "canonical": true, + "file": "tensorboard_service.delete_tensorboard.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteTensorboard", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.DeleteTensorboard", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "DeleteTensorboard", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.DeleteTensorboard", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_ReadTensorboardUsage_async", + "title": "DatasetService readTensorboardUsage Sample", + "origin": "API_DEFINITION", + "description": " Returns a list of monthly active users for a given TensorBoard instance.", + "canonical": true, + "file": "tensorboard_service.read_tensorboard_usage.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ReadTensorboardUsage", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardUsage", + "async": true, + "parameters": [ + { + "name": "tensorboard", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ReadTensorboardUsageResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "ReadTensorboardUsage", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardUsage", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_CreateTensorboardExperiment_async", + "title": "DatasetService createTensorboardExperiment Sample", + "origin": "API_DEFINITION", + "description": " Creates a TensorboardExperiment.", + "canonical": true, + "file": "tensorboard_service.create_tensorboard_experiment.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateTensorboardExperiment", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.CreateTensorboardExperiment", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "tensorboard_experiment", + "type": ".google.cloud.aiplatform.v1.TensorboardExperiment" + }, + { + "name": "tensorboard_experiment_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.TensorboardExperiment", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "CreateTensorboardExperiment", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.CreateTensorboardExperiment", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_GetTensorboardExperiment_async", + "title": "DatasetService getTensorboardExperiment Sample", + "origin": "API_DEFINITION", + "description": " Gets a TensorboardExperiment.", + "canonical": true, + "file": "tensorboard_service.get_tensorboard_experiment.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetTensorboardExperiment", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.GetTensorboardExperiment", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.TensorboardExperiment", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "GetTensorboardExperiment", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.GetTensorboardExperiment", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_UpdateTensorboardExperiment_async", + "title": "DatasetService updateTensorboardExperiment Sample", + "origin": "API_DEFINITION", + "description": " Updates a TensorboardExperiment.", + "canonical": true, + "file": "tensorboard_service.update_tensorboard_experiment.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateTensorboardExperiment", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.UpdateTensorboardExperiment", + "async": true, + "parameters": [ + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "tensorboard_experiment", + "type": ".google.cloud.aiplatform.v1.TensorboardExperiment" + } + ], + "resultType": ".google.cloud.aiplatform.v1.TensorboardExperiment", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "UpdateTensorboardExperiment", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.UpdateTensorboardExperiment", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_ListTensorboardExperiments_async", + "title": "DatasetService listTensorboardExperiments Sample", + "origin": "API_DEFINITION", + "description": " Lists TensorboardExperiments in a Location.", + "canonical": true, + "file": "tensorboard_service.list_tensorboard_experiments.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 85, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListTensorboardExperiments", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListTensorboardExperimentsResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "ListTensorboardExperiments", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_DeleteTensorboardExperiment_async", + "title": "DatasetService deleteTensorboardExperiment Sample", + "origin": "API_DEFINITION", + "description": " Deletes a TensorboardExperiment.", + "canonical": true, + "file": "tensorboard_service.delete_tensorboard_experiment.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteTensorboardExperiment", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.DeleteTensorboardExperiment", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "DeleteTensorboardExperiment", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.DeleteTensorboardExperiment", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_CreateTensorboardRun_async", + "title": "DatasetService createTensorboardRun Sample", + "origin": "API_DEFINITION", + "description": " Creates a TensorboardRun.", + "canonical": true, + "file": "tensorboard_service.create_tensorboard_run.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateTensorboardRun", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.CreateTensorboardRun", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "tensorboard_run", + "type": ".google.cloud.aiplatform.v1.TensorboardRun" + }, + { + "name": "tensorboard_run_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.TensorboardRun", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "CreateTensorboardRun", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.CreateTensorboardRun", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_BatchCreateTensorboardRuns_async", + "title": "DatasetService batchCreateTensorboardRuns Sample", + "origin": "API_DEFINITION", + "description": " Batch create TensorboardRuns.", + "canonical": true, + "file": "tensorboard_service.batch_create_tensorboard_runs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchCreateTensorboardRuns", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.BatchCreateTensorboardRuns", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "requests", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1.BatchCreateTensorboardRunsResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "BatchCreateTensorboardRuns", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.BatchCreateTensorboardRuns", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_GetTensorboardRun_async", + "title": "DatasetService getTensorboardRun Sample", + "origin": "API_DEFINITION", + "description": " Gets a TensorboardRun.", + "canonical": true, + "file": "tensorboard_service.get_tensorboard_run.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetTensorboardRun", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.GetTensorboardRun", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.TensorboardRun", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "GetTensorboardRun", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.GetTensorboardRun", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_UpdateTensorboardRun_async", + "title": "DatasetService updateTensorboardRun Sample", + "origin": "API_DEFINITION", + "description": " Updates a TensorboardRun.", + "canonical": true, + "file": "tensorboard_service.update_tensorboard_run.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateTensorboardRun", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.UpdateTensorboardRun", + "async": true, + "parameters": [ + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "tensorboard_run", + "type": ".google.cloud.aiplatform.v1.TensorboardRun" + } + ], + "resultType": ".google.cloud.aiplatform.v1.TensorboardRun", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "UpdateTensorboardRun", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.UpdateTensorboardRun", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_ListTensorboardRuns_async", + "title": "DatasetService listTensorboardRuns Sample", + "origin": "API_DEFINITION", + "description": " Lists TensorboardRuns in a Location.", + "canonical": true, + "file": "tensorboard_service.list_tensorboard_runs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 85, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListTensorboardRuns", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListTensorboardRunsResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "ListTensorboardRuns", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_DeleteTensorboardRun_async", + "title": "DatasetService deleteTensorboardRun Sample", + "origin": "API_DEFINITION", + "description": " Deletes a TensorboardRun.", + "canonical": true, + "file": "tensorboard_service.delete_tensorboard_run.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteTensorboardRun", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.DeleteTensorboardRun", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "DeleteTensorboardRun", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.DeleteTensorboardRun", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_BatchCreateTensorboardTimeSeries_async", + "title": "DatasetService batchCreateTensorboardTimeSeries Sample", + "origin": "API_DEFINITION", + "description": " Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.", + "canonical": true, + "file": "tensorboard_service.batch_create_tensorboard_time_series.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchCreateTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.BatchCreateTensorboardTimeSeries", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "requests", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1.BatchCreateTensorboardTimeSeriesResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "BatchCreateTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.BatchCreateTensorboardTimeSeries", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_CreateTensorboardTimeSeries_async", + "title": "DatasetService createTensorboardTimeSeries Sample", + "origin": "API_DEFINITION", + "description": " Creates a TensorboardTimeSeries.", + "canonical": true, + "file": "tensorboard_service.create_tensorboard_time_series.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.CreateTensorboardTimeSeries", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "tensorboard_time_series_id", + "type": "TYPE_STRING" + }, + { + "name": "tensorboard_time_series", + "type": ".google.cloud.aiplatform.v1.TensorboardTimeSeries" + } + ], + "resultType": ".google.cloud.aiplatform.v1.TensorboardTimeSeries", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "CreateTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.CreateTensorboardTimeSeries", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_GetTensorboardTimeSeries_async", + "title": "DatasetService getTensorboardTimeSeries Sample", + "origin": "API_DEFINITION", + "description": " Gets a TensorboardTimeSeries.", + "canonical": true, + "file": "tensorboard_service.get_tensorboard_time_series.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.GetTensorboardTimeSeries", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.TensorboardTimeSeries", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "GetTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.GetTensorboardTimeSeries", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_UpdateTensorboardTimeSeries_async", + "title": "DatasetService updateTensorboardTimeSeries Sample", + "origin": "API_DEFINITION", + "description": " Updates a TensorboardTimeSeries.", + "canonical": true, + "file": "tensorboard_service.update_tensorboard_time_series.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.UpdateTensorboardTimeSeries", + "async": true, + "parameters": [ + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "tensorboard_time_series", + "type": ".google.cloud.aiplatform.v1.TensorboardTimeSeries" + } + ], + "resultType": ".google.cloud.aiplatform.v1.TensorboardTimeSeries", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "UpdateTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.UpdateTensorboardTimeSeries", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_ListTensorboardTimeSeries_async", + "title": "DatasetService listTensorboardTimeSeries Sample", + "origin": "API_DEFINITION", + "description": " Lists TensorboardTimeSeries in a Location.", + "canonical": true, + "file": "tensorboard_service.list_tensorboard_time_series.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 85, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListTensorboardTimeSeriesResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "ListTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_DeleteTensorboardTimeSeries_async", + "title": "DatasetService deleteTensorboardTimeSeries Sample", + "origin": "API_DEFINITION", + "description": " Deletes a TensorboardTimeSeries.", + "canonical": true, + "file": "tensorboard_service.delete_tensorboard_time_series.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.DeleteTensorboardTimeSeries", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "DeleteTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.DeleteTensorboardTimeSeries", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_BatchReadTensorboardTimeSeriesData_async", + "title": "DatasetService batchReadTensorboardTimeSeriesData Sample", + "origin": "API_DEFINITION", + "description": " Reads multiple TensorboardTimeSeries' data. The data point number limit is 1000 for scalars, 100 for tensors and blob references. If the number of data points stored is less than the limit, all data is returned. Otherwise, the number limit of data points is randomly selected from this time series and returned.", + "canonical": true, + "file": "tensorboard_service.batch_read_tensorboard_time_series_data.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchReadTensorboardTimeSeriesData", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.BatchReadTensorboardTimeSeriesData", + "async": true, + "parameters": [ + { + "name": "tensorboard", + "type": "TYPE_STRING" + }, + { + "name": "time_series", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1.BatchReadTensorboardTimeSeriesDataResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "BatchReadTensorboardTimeSeriesData", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.BatchReadTensorboardTimeSeriesData", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_ReadTensorboardTimeSeriesData_async", + "title": "DatasetService readTensorboardTimeSeriesData Sample", + "origin": "API_DEFINITION", + "description": " Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k.", + "canonical": true, + "file": "tensorboard_service.read_tensorboard_time_series_data.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ReadTensorboardTimeSeriesData", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardTimeSeriesData", + "async": true, + "parameters": [ + { + "name": "tensorboard_time_series", + "type": "TYPE_STRING" + }, + { + "name": "max_data_points", + "type": "TYPE_INT32" + }, + { + "name": "filter", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ReadTensorboardTimeSeriesDataResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "ReadTensorboardTimeSeriesData", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardTimeSeriesData", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_ReadTensorboardBlobData_async", + "title": "DatasetService readTensorboardBlobData Sample", + "origin": "API_DEFINITION", + "description": " Gets bytes of TensorboardBlobs. This is to allow reading blob data stored in consumer project's Cloud Storage bucket without users having to obtain Cloud Storage access permission.", + "canonical": true, + "file": "tensorboard_service.read_tensorboard_blob_data.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ReadTensorboardBlobData", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardBlobData", + "async": true, + "parameters": [ + { + "name": "time_series", + "type": "TYPE_STRING" + }, + { + "name": "blob_ids", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ReadTensorboardBlobDataResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "ReadTensorboardBlobData", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardBlobData", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_WriteTensorboardExperimentData_async", + "title": "DatasetService writeTensorboardExperimentData Sample", + "origin": "API_DEFINITION", + "description": " Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's. If any data fail to be ingested, an error is returned.", + "canonical": true, + "file": "tensorboard_service.write_tensorboard_experiment_data.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "WriteTensorboardExperimentData", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.WriteTensorboardExperimentData", + "async": true, + "parameters": [ + { + "name": "tensorboard_experiment", + "type": "TYPE_STRING" + }, + { + "name": "write_run_data_requests", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1.WriteTensorboardExperimentDataResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "WriteTensorboardExperimentData", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.WriteTensorboardExperimentData", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_WriteTensorboardRunData_async", + "title": "DatasetService writeTensorboardRunData Sample", + "origin": "API_DEFINITION", + "description": " Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun. If any data fail to be ingested, an error is returned.", + "canonical": true, + "file": "tensorboard_service.write_tensorboard_run_data.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 64, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "WriteTensorboardRunData", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.WriteTensorboardRunData", + "async": true, + "parameters": [ + { + "name": "tensorboard_run", + "type": "TYPE_STRING" + }, + { + "name": "time_series_data", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1.WriteTensorboardRunDataResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "WriteTensorboardRunData", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.WriteTensorboardRunData", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_ExportTensorboardTimeSeriesData_async", + "title": "DatasetService exportTensorboardTimeSeriesData Sample", + "origin": "API_DEFINITION", + "description": " Exports a TensorboardTimeSeries' data. Data is returned in paginated responses.", + "canonical": true, + "file": "tensorboard_service.export_tensorboard_time_series_data.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 82, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ExportTensorboardTimeSeriesData", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.ExportTensorboardTimeSeriesData", + "async": true, + "parameters": [ + { + "name": "tensorboard_time_series", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ExportTensorboardTimeSeriesDataResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "ExportTensorboardTimeSeriesData", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.ExportTensorboardTimeSeriesData", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_VizierService_CreateStudy_async", + "title": "DatasetService createStudy Sample", + "origin": "API_DEFINITION", + "description": " Creates a Study. A resource name will be generated after creation of the Study.", + "canonical": true, + "file": "vizier_service.create_study.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateStudy", + "fullName": "google.cloud.aiplatform.v1.VizierService.CreateStudy", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "study", + "type": ".google.cloud.aiplatform.v1.Study" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Study", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1.VizierServiceClient" + }, + "method": { + "shortName": "CreateStudy", + "fullName": "google.cloud.aiplatform.v1.VizierService.CreateStudy", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_VizierService_GetStudy_async", + "title": "DatasetService getStudy Sample", + "origin": "API_DEFINITION", + "description": " Gets a Study by name.", + "canonical": true, + "file": "vizier_service.get_study.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetStudy", + "fullName": "google.cloud.aiplatform.v1.VizierService.GetStudy", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Study", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1.VizierServiceClient" + }, + "method": { + "shortName": "GetStudy", + "fullName": "google.cloud.aiplatform.v1.VizierService.GetStudy", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_VizierService_ListStudies_async", + "title": "DatasetService listStudies Sample", + "origin": "API_DEFINITION", + "description": " Lists all the studies in a region for an associated project.", + "canonical": true, + "file": "vizier_service.list_studies.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListStudies", + "fullName": "google.cloud.aiplatform.v1.VizierService.ListStudies", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListStudiesResponse", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1.VizierServiceClient" + }, + "method": { + "shortName": "ListStudies", + "fullName": "google.cloud.aiplatform.v1.VizierService.ListStudies", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_VizierService_DeleteStudy_async", + "title": "DatasetService deleteStudy Sample", + "origin": "API_DEFINITION", + "description": " Deletes a Study.", + "canonical": true, + "file": "vizier_service.delete_study.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteStudy", + "fullName": "google.cloud.aiplatform.v1.VizierService.DeleteStudy", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1.VizierServiceClient" + }, + "method": { + "shortName": "DeleteStudy", + "fullName": "google.cloud.aiplatform.v1.VizierService.DeleteStudy", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_VizierService_LookupStudy_async", + "title": "DatasetService lookupStudy Sample", + "origin": "API_DEFINITION", + "description": " Looks a study up using the user-defined display_name field instead of the fully qualified resource name.", + "canonical": true, + "file": "vizier_service.lookup_study.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "LookupStudy", + "fullName": "google.cloud.aiplatform.v1.VizierService.LookupStudy", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "display_name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Study", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1.VizierServiceClient" + }, + "method": { + "shortName": "LookupStudy", + "fullName": "google.cloud.aiplatform.v1.VizierService.LookupStudy", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_VizierService_SuggestTrials_async", + "title": "DatasetService suggestTrials Sample", + "origin": "API_DEFINITION", + "description": " Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier. Returns a long-running operation associated with the generation of Trial suggestions. When this long-running operation succeeds, it will contain a [SuggestTrialsResponse][google.cloud.aiplatform.v1.SuggestTrialsResponse].", + "canonical": true, + "file": "vizier_service.suggest_trials.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SuggestTrials", + "fullName": "google.cloud.aiplatform.v1.VizierService.SuggestTrials", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "suggestion_count", + "type": "TYPE_INT32" + }, + { + "name": "client_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1.VizierServiceClient" + }, + "method": { + "shortName": "SuggestTrials", + "fullName": "google.cloud.aiplatform.v1.VizierService.SuggestTrials", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_VizierService_CreateTrial_async", + "title": "DatasetService createTrial Sample", + "origin": "API_DEFINITION", + "description": " Adds a user provided Trial to a Study.", + "canonical": true, + "file": "vizier_service.create_trial.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateTrial", + "fullName": "google.cloud.aiplatform.v1.VizierService.CreateTrial", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "trial", + "type": ".google.cloud.aiplatform.v1.Trial" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Trial", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1.VizierServiceClient" + }, + "method": { + "shortName": "CreateTrial", + "fullName": "google.cloud.aiplatform.v1.VizierService.CreateTrial", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_VizierService_GetTrial_async", + "title": "DatasetService getTrial Sample", + "origin": "API_DEFINITION", + "description": " Gets a Trial.", + "canonical": true, + "file": "vizier_service.get_trial.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetTrial", + "fullName": "google.cloud.aiplatform.v1.VizierService.GetTrial", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Trial", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1.VizierServiceClient" + }, + "method": { + "shortName": "GetTrial", + "fullName": "google.cloud.aiplatform.v1.VizierService.GetTrial", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_VizierService_ListTrials_async", + "title": "DatasetService listTrials Sample", + "origin": "API_DEFINITION", + "description": " Lists the Trials associated with a Study.", + "canonical": true, + "file": "vizier_service.list_trials.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListTrials", + "fullName": "google.cloud.aiplatform.v1.VizierService.ListTrials", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListTrialsResponse", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1.VizierServiceClient" + }, + "method": { + "shortName": "ListTrials", + "fullName": "google.cloud.aiplatform.v1.VizierService.ListTrials", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_VizierService_AddTrialMeasurement_async", + "title": "DatasetService addTrialMeasurement Sample", + "origin": "API_DEFINITION", + "description": " Adds a measurement of the objective metrics to a Trial. This measurement is assumed to have been taken before the Trial is complete.", + "canonical": true, + "file": "vizier_service.add_trial_measurement.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AddTrialMeasurement", + "fullName": "google.cloud.aiplatform.v1.VizierService.AddTrialMeasurement", + "async": true, + "parameters": [ + { + "name": "trial_name", + "type": "TYPE_STRING" + }, + { + "name": "measurement", + "type": ".google.cloud.aiplatform.v1.Measurement" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Trial", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1.VizierServiceClient" + }, + "method": { + "shortName": "AddTrialMeasurement", + "fullName": "google.cloud.aiplatform.v1.VizierService.AddTrialMeasurement", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_VizierService_CompleteTrial_async", + "title": "DatasetService completeTrial Sample", + "origin": "API_DEFINITION", + "description": " Marks a Trial as complete.", + "canonical": true, + "file": "vizier_service.complete_trial.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CompleteTrial", + "fullName": "google.cloud.aiplatform.v1.VizierService.CompleteTrial", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "final_measurement", + "type": ".google.cloud.aiplatform.v1.Measurement" + }, + { + "name": "trial_infeasible", + "type": "TYPE_BOOL" + }, + { + "name": "infeasible_reason", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Trial", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1.VizierServiceClient" + }, + "method": { + "shortName": "CompleteTrial", + "fullName": "google.cloud.aiplatform.v1.VizierService.CompleteTrial", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_VizierService_DeleteTrial_async", + "title": "DatasetService deleteTrial Sample", + "origin": "API_DEFINITION", + "description": " Deletes a Trial.", + "canonical": true, + "file": "vizier_service.delete_trial.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteTrial", + "fullName": "google.cloud.aiplatform.v1.VizierService.DeleteTrial", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1.VizierServiceClient" + }, + "method": { + "shortName": "DeleteTrial", + "fullName": "google.cloud.aiplatform.v1.VizierService.DeleteTrial", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_VizierService_CheckTrialEarlyStoppingState_async", + "title": "DatasetService checkTrialEarlyStoppingState Sample", + "origin": "API_DEFINITION", + "description": " Checks whether a Trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a [CheckTrialEarlyStoppingStateResponse][google.cloud.aiplatform.v1.CheckTrialEarlyStoppingStateResponse].", + "canonical": true, + "file": "vizier_service.check_trial_early_stopping_state.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CheckTrialEarlyStoppingState", + "fullName": "google.cloud.aiplatform.v1.VizierService.CheckTrialEarlyStoppingState", + "async": true, + "parameters": [ + { + "name": "trial_name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1.VizierServiceClient" + }, + "method": { + "shortName": "CheckTrialEarlyStoppingState", + "fullName": "google.cloud.aiplatform.v1.VizierService.CheckTrialEarlyStoppingState", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_VizierService_StopTrial_async", + "title": "DatasetService stopTrial Sample", + "origin": "API_DEFINITION", + "description": " Stops a Trial.", + "canonical": true, + "file": "vizier_service.stop_trial.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "StopTrial", + "fullName": "google.cloud.aiplatform.v1.VizierService.StopTrial", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Trial", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1.VizierServiceClient" + }, + "method": { + "shortName": "StopTrial", + "fullName": "google.cloud.aiplatform.v1.VizierService.StopTrial", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_VizierService_ListOptimalTrials_async", + "title": "DatasetService listOptimalTrials Sample", + "origin": "API_DEFINITION", + "description": " Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency", + "canonical": true, + "file": "vizier_service.list_optimal_trials.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListOptimalTrials", + "fullName": "google.cloud.aiplatform.v1.VizierService.ListOptimalTrials", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListOptimalTrialsResponse", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1.VizierServiceClient" + }, + "method": { + "shortName": "ListOptimalTrials", + "fullName": "google.cloud.aiplatform.v1.VizierService.ListOptimalTrials", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1.VizierService" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.batch_create_tensorboard_runs.js b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.batch_create_tensorboard_runs.js index 8c44669ef54..de1bef923a5 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.batch_create_tensorboard_runs.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.batch_create_tensorboard_runs.js @@ -40,7 +40,7 @@ function main(parent, requests) { * Required. The request message specifying the TensorboardRuns to create. * A maximum of 1000 TensorboardRuns can be created in a batch. */ - // const requests = 1234 + // const requests = [1,2,3,4] // Imports the Aiplatform library const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1; diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.batch_create_tensorboard_time_series.js b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.batch_create_tensorboard_time_series.js index b92437e832b..735ce3d8b2d 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.batch_create_tensorboard_time_series.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.batch_create_tensorboard_time_series.js @@ -42,7 +42,7 @@ function main(parent, requests) { * Required. The request message specifying the TensorboardTimeSeries to * create. A maximum of 1000 TensorboardTimeSeries can be created in a batch. */ - // const requests = 1234 + // const requests = [1,2,3,4] // Imports the Aiplatform library const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1; diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.batch_read_tensorboard_time_series_data.js b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.batch_read_tensorboard_time_series_data.js index 75415d97322..86355cd43cf 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.batch_read_tensorboard_time_series_data.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.batch_read_tensorboard_time_series_data.js @@ -42,7 +42,7 @@ function main(tensorboard, timeSeries) { * from. Format: * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}` */ - // const timeSeries = 'abc123' + // const timeSeries = ['abc','def'] // Imports the Aiplatform library const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1; diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.read_tensorboard_blob_data.js b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.read_tensorboard_blob_data.js index d58f753d47b..2707f2d900b 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.read_tensorboard_blob_data.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.read_tensorboard_blob_data.js @@ -37,7 +37,7 @@ function main(timeSeries) { /** * IDs of the blobs to read. */ - // const blobIds = 'abc123' + // const blobIds = ['abc','def'] // Imports the Aiplatform library const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1; diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.write_tensorboard_experiment_data.js b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.write_tensorboard_experiment_data.js index aac2a01b842..6815cf46806 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.write_tensorboard_experiment_data.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.write_tensorboard_experiment_data.js @@ -37,7 +37,7 @@ function main(tensorboardExperiment, writeRunDataRequests) { /** * Required. Requests containing per-run TensorboardTimeSeries data to write. */ - // const writeRunDataRequests = 1234 + // const writeRunDataRequests = [1,2,3,4] // Imports the Aiplatform library const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1; diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.write_tensorboard_run_data.js b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.write_tensorboard_run_data.js index 92214418c3d..d7b38fa4e38 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.write_tensorboard_run_data.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.write_tensorboard_run_data.js @@ -41,7 +41,7 @@ function main(tensorboardRun, timeSeriesData) { * step. * The upper limit of data points per write request is 5000. */ - // const timeSeriesData = 1234 + // const timeSeriesData = [1,2,3,4] // Imports the Aiplatform library const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1; diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/dataset_service.import_data.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/dataset_service.import_data.js index dfa6395c1ec..6c909e7d5e2 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1beta1/dataset_service.import_data.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/dataset_service.import_data.js @@ -38,7 +38,7 @@ function main(name, importConfigs) { * Required. The desired input locations. The contents of all input locations * will be imported in one batch. */ - // const importConfigs = 1234 + // const importConfigs = [1,2,3,4] // Imports the Aiplatform library const {DatasetServiceClient} = require('@google-cloud/aiplatform').v1beta1; diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/dataset_service.search_data_items.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/dataset_service.search_data_items.js index bddd43f6697..0a68c3dd8c4 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1beta1/dataset_service.search_data_items.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/dataset_service.search_data_items.js @@ -83,7 +83,7 @@ function main(dataset) { * Must specify `saved_query_id=` - saved query id that annotations should * belong to. */ - // const annotationFilters = 'abc123' + // const annotationFilters = ['abc','def'] /** * Mask specifying which fields of * DataItemView google.cloud.aiplatform.v1beta1.DataItemView to read. diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/endpoint_service.deploy_model.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/endpoint_service.deploy_model.js index ba2ce26e8c5..7516b1fcff9 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1beta1/endpoint_service.deploy_model.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/endpoint_service.deploy_model.js @@ -55,7 +55,7 @@ function main(endpoint, deployedModel) { * traffic_split google.cloud.aiplatform.v1beta1.Endpoint.traffic_split is * not updated. */ - // const trafficSplit = 1234 + // const trafficSplit = [1,2,3,4] // Imports the Aiplatform library const {EndpointServiceClient} = require('@google-cloud/aiplatform').v1beta1; diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/endpoint_service.undeploy_model.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/endpoint_service.undeploy_model.js index 72313423887..f278a4e78be 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1beta1/endpoint_service.undeploy_model.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/endpoint_service.undeploy_model.js @@ -47,7 +47,7 @@ function main(endpoint, deployedModelId) { * it doesn't have any traffic assigned to it when this method executes, or if * this field unassigns any traffic to it. */ - // const trafficSplit = 1234 + // const trafficSplit = [1,2,3,4] // Imports the Aiplatform library const {EndpointServiceClient} = require('@google-cloud/aiplatform').v1beta1; diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_online_serving_service.streaming_read_feature_values.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_online_serving_service.streaming_read_feature_values.js index 1def4fc792b..add8d51dd93 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_online_serving_service.streaming_read_feature_values.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_online_serving_service.streaming_read_feature_values.js @@ -42,7 +42,7 @@ function main(entityType, entityIds, featureSelector) { * IDs is 100. For example, for a machine learning model predicting user * clicks on a website, an entity ID could be `user_123`. */ - // const entityIds = 'abc123' + // const entityIds = ['abc','def'] /** * Required. Selector choosing Features of the target EntityType. Feature IDs * will be deduplicated. diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_online_serving_service.write_feature_values.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_online_serving_service.write_feature_values.js index e2719975b5e..801e6570126 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_online_serving_service.write_feature_values.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_online_serving_service.write_feature_values.js @@ -41,7 +41,7 @@ function main(entityType, payloads) { * Required. The entities to be written. Up to 100,000 feature values can be * written across all `payloads`. */ - // const payloads = 1234 + // const payloads = [1,2,3,4] // Imports the Aiplatform library const {FeaturestoreOnlineServingServiceClient} = require('@google-cloud/aiplatform').v1beta1; diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.batch_create_features.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.batch_create_features.js index 796e5b5bfd1..1a95601095e 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.batch_create_features.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.batch_create_features.js @@ -41,7 +41,7 @@ function main(parent, requests) { * child request, then the value must match the `parent` value in this request * message. */ - // const requests = 1234 + // const requests = [1,2,3,4] // Imports the Aiplatform library const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1beta1; diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.batch_read_feature_values.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.batch_read_feature_values.js index fa45c919c23..874234be18c 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.batch_read_feature_values.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.batch_read_feature_values.js @@ -70,12 +70,12 @@ function main(featurestore, destination, entityTypeSpecs) { * automatically inferred. For CSV source, the pass-through values will be * passed as opaque bytes. */ - // const passThroughFields = 1234 + // const passThroughFields = [1,2,3,4] /** * Required. Specifies EntityType grouping Features to read values of and * settings. */ - // const entityTypeSpecs = 1234 + // const entityTypeSpecs = [1,2,3,4] /** * Optional. Excludes Feature values with feature generation timestamp before * this timestamp. If not set, retrieve oldest values kept in Feature Store. diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.export_feature_values.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.export_feature_values.js index d57684e53ab..766329553e6 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.export_feature_values.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.export_feature_values.js @@ -55,7 +55,7 @@ function main(entityType, destination, featureSelector) { /** * Per-Feature export settings. */ - // const settings = 1234 + // const settings = [1,2,3,4] // Imports the Aiplatform library const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1beta1; diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.import_feature_values.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.import_feature_values.js index d237424c203..87670d16917 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.import_feature_values.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.import_feature_values.js @@ -63,7 +63,7 @@ function main(entityType, featureSpecs) { * entity. The request fails if no feature_specs are provided, and having * multiple feature_specs for one Feature is not allowed. */ - // const featureSpecs = 1234 + // const featureSpecs = [1,2,3,4] /** * If set, data will not be imported for online serving. This * is typically used for backfilling, where Feature generation timestamps are diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_service.remove_datapoints.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_service.remove_datapoints.js index 25bdf8eeaa8..89c74d14e16 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_service.remove_datapoints.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_service.remove_datapoints.js @@ -37,7 +37,7 @@ function main(index) { /** * A list of datapoint ids to be deleted. */ - // const datapointIds = 'abc123' + // const datapointIds = ['abc','def'] // Imports the Aiplatform library const {IndexServiceClient} = require('@google-cloud/aiplatform').v1beta1; diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_service.upsert_datapoints.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_service.upsert_datapoints.js index 0fd92c020bd..2ee35116f11 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_service.upsert_datapoints.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_service.upsert_datapoints.js @@ -37,7 +37,7 @@ function main(index) { /** * A list of datapoints to be created/updated. */ - // const datapoints = 1234 + // const datapoints = [1,2,3,4] // Imports the Aiplatform library const {IndexServiceClient} = require('@google-cloud/aiplatform').v1beta1; diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.search_model_deployment_monitoring_stats_anomalies.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.search_model_deployment_monitoring_stats_anomalies.js index b50912a9af3..4480682c296 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.search_model_deployment_monitoring_stats_anomalies.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.search_model_deployment_monitoring_stats_anomalies.js @@ -49,7 +49,7 @@ function main(modelDeploymentMonitoringJob, deployedModelId, objectives) { /** * Required. Objectives of the stats to retrieve. */ - // const objectives = 1234 + // const objectives = [1,2,3,4] /** * The standard list page size. */ diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/match_service.find_neighbors.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/match_service.find_neighbors.js index 4de8b881880..d1da7a6c84d 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1beta1/match_service.find_neighbors.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/match_service.find_neighbors.js @@ -46,7 +46,7 @@ function main(indexEndpoint) { /** * The list of queries. */ - // const queries = 1234 + // const queries = [1,2,3,4] /** * If set to true, the full datapoints (including all vector values and * restricts) of the nearest neighbors are returned. diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/match_service.read_index_datapoints.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/match_service.read_index_datapoints.js index 2ca65a32959..e49a5f56662 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1beta1/match_service.read_index_datapoints.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/match_service.read_index_datapoints.js @@ -41,7 +41,7 @@ function main(indexEndpoint) { /** * IDs of the datapoints to be searched for. */ - // const ids = 'abc123' + // const ids = ['abc','def'] // Imports the Aiplatform library const {MatchServiceClient} = require('@google-cloud/aiplatform').v1beta1; diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.add_context_artifacts_and_executions.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.add_context_artifacts_and_executions.js index ed7d9cc0acf..d92e726e226 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.add_context_artifacts_and_executions.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.add_context_artifacts_and_executions.js @@ -39,14 +39,14 @@ function main(context) { * Format: * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` */ - // const artifacts = 'abc123' + // const artifacts = ['abc','def'] /** * The resource names of the Executions to associate with the * Context. * Format: * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` */ - // const executions = 'abc123' + // const executions = ['abc','def'] // Imports the Aiplatform library const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1; diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.add_context_children.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.add_context_children.js index 01baae68bfb..a6873314118 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.add_context_children.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.add_context_children.js @@ -37,7 +37,7 @@ function main(context) { /** * The resource names of the child Contexts. */ - // const childContexts = 'abc123' + // const childContexts = ['abc','def'] // Imports the Aiplatform library const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1; diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.add_execution_events.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.add_execution_events.js index d0d5f16e1f2..d6136c6215c 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.add_execution_events.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.add_execution_events.js @@ -38,7 +38,7 @@ function main(execution) { /** * The Events to create and add. */ - // const events = 1234 + // const events = [1,2,3,4] // Imports the Aiplatform library const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1; diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.remove_context_children.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.remove_context_children.js index 5d40daec1c8..4b2102d9a2e 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.remove_context_children.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.remove_context_children.js @@ -37,7 +37,7 @@ function main(context) { /** * The resource names of the child Contexts. */ - // const childContexts = 'abc123' + // const childContexts = ['abc','def'] // Imports the Aiplatform library const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1; diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/migration_service.batch_migrate_resources.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/migration_service.batch_migrate_resources.js index 6a1ad98af2b..24bfa3f8846 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1beta1/migration_service.batch_migrate_resources.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/migration_service.batch_migrate_resources.js @@ -38,7 +38,7 @@ function main(parent, migrateResourceRequests) { * They must be in the same location as the destination. * Up to 50 resources can be migrated in one batch. */ - // const migrateResourceRequests = 1234 + // const migrateResourceRequests = [1,2,3,4] // Imports the Aiplatform library const {MigrationServiceClient} = require('@google-cloud/aiplatform').v1beta1; diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.batch_import_evaluated_annotations.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.batch_import_evaluated_annotations.js index 8131cf24472..b3cdd7c0fff 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.batch_import_evaluated_annotations.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.batch_import_evaluated_annotations.js @@ -37,7 +37,7 @@ function main(parent, evaluatedAnnotations) { /** * Required. Evaluated annotations resource to be imported. */ - // const evaluatedAnnotations = 1234 + // const evaluatedAnnotations = [1,2,3,4] // Imports the Aiplatform library const {ModelServiceClient} = require('@google-cloud/aiplatform').v1beta1; diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.batch_import_model_evaluation_slices.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.batch_import_model_evaluation_slices.js index 265072a76ca..d6f0903ee01 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.batch_import_model_evaluation_slices.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.batch_import_model_evaluation_slices.js @@ -37,7 +37,7 @@ function main(parent, modelEvaluationSlices) { /** * Required. Model evaluation slice resource to be imported. */ - // const modelEvaluationSlices = 1234 + // const modelEvaluationSlices = [1,2,3,4] // Imports the Aiplatform library const {ModelServiceClient} = require('@google-cloud/aiplatform').v1beta1; diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.merge_version_aliases.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.merge_version_aliases.js index eca91b71fa9..d6bd1b4ddff 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.merge_version_aliases.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.merge_version_aliases.js @@ -47,7 +47,7 @@ function main(name, versionAliases) { * alias in the request is not recommended, and the 2 operations will be * cancelled out. */ - // const versionAliases = 'abc123' + // const versionAliases = ['abc','def'] // Imports the Aiplatform library const {ModelServiceClient} = require('@google-cloud/aiplatform').v1beta1; diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/prediction_service.explain.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/prediction_service.explain.js index 5e8de6cbfe4..8b835397d01 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1beta1/prediction_service.explain.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/prediction_service.explain.js @@ -46,7 +46,7 @@ function main(endpoint, instances) { * PredictSchemata's google.cloud.aiplatform.v1beta1.Model.predict_schemata * instance_schema_uri google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri. */ - // const instances = 1234 + // const instances = [1,2,3,4] /** * The parameters that govern the prediction. The schema of the parameters may * be specified via Endpoint's DeployedModels' Model's diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/prediction_service.predict.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/prediction_service.predict.js index 9c9e4ccf04a..61c986ca0fc 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1beta1/prediction_service.predict.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/prediction_service.predict.js @@ -46,7 +46,7 @@ function main(endpoint, instances) { * PredictSchemata's google.cloud.aiplatform.v1beta1.Model.predict_schemata * instance_schema_uri google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri. */ - // const instances = 1234 + // const instances = [1,2,3,4] /** * The parameters that govern the prediction. The schema of the parameters may * be specified via Endpoint's DeployedModels' Model's diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/prediction_service.server_streaming_predict.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/prediction_service.server_streaming_predict.js new file mode 100644 index 00000000000..a0ae2cc81bf --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/prediction_service.server_streaming_predict.js @@ -0,0 +1,73 @@ +// Copyright 2023 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. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(endpoint) { + // [START aiplatform_v1beta1_generated_PredictionService_ServerStreamingPredict_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Endpoint requested to serve the prediction. + * Format: + * `projects/{project}/locations/{location}/endpoints/{endpoint}` + */ + // const endpoint = 'abc123' + /** + * The prediction input. + */ + // const inputs = [1,2,3,4] + /** + * The parameters that govern the prediction. + */ + // const parameters = {} + + // Imports the Aiplatform library + const {PredictionServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new PredictionServiceClient(); + + async function callServerStreamingPredict() { + // Construct request + const request = { + endpoint, + }; + + // Run request + const stream = await aiplatformClient.serverStreamingPredict(request); + stream.on('data', (response) => { console.log(response) }); + stream.on('error', (err) => { throw(err) }); + stream.on('end', () => { /* API call completed */ }); + } + + callServerStreamingPredict(); + // [END aiplatform_v1beta1_generated_PredictionService_ServerStreamingPredict_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/snippet_metadata_google.cloud.aiplatform.v1beta1.json b/packages/google-cloud-aiplatform/samples/generated/v1beta1/snippet_metadata_google.cloud.aiplatform.v1beta1.json new file mode 100644 index 00000000000..6735b711b3d --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/snippet_metadata_google.cloud.aiplatform.v1beta1.json @@ -0,0 +1,10663 @@ +{ + "clientLibrary": { + "name": "nodejs-aiplatform", + "version": "2.17.0", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.aiplatform.v1beta1", + "version": "v1beta1" + } + ] + }, + "snippets": [ + { + "regionTag": "aiplatform_v1beta1_generated_DatasetService_CreateDataset_async", + "title": "DatasetService createDataset Sample", + "origin": "API_DEFINITION", + "description": " Creates a Dataset.", + "canonical": true, + "file": "dataset_service.create_dataset.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateDataset", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.CreateDataset", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "dataset", + "type": ".google.cloud.aiplatform.v1beta1.Dataset" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetServiceClient" + }, + "method": { + "shortName": "CreateDataset", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.CreateDataset", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_DatasetService_GetDataset_async", + "title": "DatasetService getDataset Sample", + "origin": "API_DEFINITION", + "description": " Gets a Dataset.", + "canonical": true, + "file": "dataset_service.get_dataset.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 57, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetDataset", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.GetDataset", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Dataset", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetServiceClient" + }, + "method": { + "shortName": "GetDataset", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.GetDataset", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_DatasetService_UpdateDataset_async", + "title": "DatasetService updateDataset Sample", + "origin": "API_DEFINITION", + "description": " Updates a Dataset.", + "canonical": true, + "file": "dataset_service.update_dataset.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateDataset", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.UpdateDataset", + "async": true, + "parameters": [ + { + "name": "dataset", + "type": ".google.cloud.aiplatform.v1beta1.Dataset" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Dataset", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetServiceClient" + }, + "method": { + "shortName": "UpdateDataset", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.UpdateDataset", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_DatasetService_ListDatasets_async", + "title": "DatasetService listDatasets Sample", + "origin": "API_DEFINITION", + "description": " Lists Datasets in a Location.", + "canonical": true, + "file": "dataset_service.list_datasets.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 91, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListDatasets", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.ListDatasets", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListDatasetsResponse", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetServiceClient" + }, + "method": { + "shortName": "ListDatasets", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.ListDatasets", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_DatasetService_DeleteDataset_async", + "title": "DatasetService deleteDataset Sample", + "origin": "API_DEFINITION", + "description": " Deletes a Dataset.", + "canonical": true, + "file": "dataset_service.delete_dataset.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteDataset", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.DeleteDataset", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetServiceClient" + }, + "method": { + "shortName": "DeleteDataset", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.DeleteDataset", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_DatasetService_ImportData_async", + "title": "DatasetService importData Sample", + "origin": "API_DEFINITION", + "description": " Imports data into a Dataset.", + "canonical": true, + "file": "dataset_service.import_data.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ImportData", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.ImportData", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "import_configs", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetServiceClient" + }, + "method": { + "shortName": "ImportData", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.ImportData", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_DatasetService_ExportData_async", + "title": "DatasetService exportData Sample", + "origin": "API_DEFINITION", + "description": " Exports data from a Dataset.", + "canonical": true, + "file": "dataset_service.export_data.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ExportData", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.ExportData", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "export_config", + "type": ".google.cloud.aiplatform.v1beta1.ExportDataConfig" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetServiceClient" + }, + "method": { + "shortName": "ExportData", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.ExportData", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_DatasetService_ListDataItems_async", + "title": "DatasetService listDataItems Sample", + "origin": "API_DEFINITION", + "description": " Lists DataItems in a Dataset.", + "canonical": true, + "file": "dataset_service.list_data_items.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 78, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListDataItems", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.ListDataItems", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListDataItemsResponse", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetServiceClient" + }, + "method": { + "shortName": "ListDataItems", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.ListDataItems", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_DatasetService_SearchDataItems_async", + "title": "DatasetService searchDataItems Sample", + "origin": "API_DEFINITION", + "description": " Searches DataItems in a Dataset.", + "canonical": true, + "file": "dataset_service.search_data_items.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 137, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SearchDataItems", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.SearchDataItems", + "async": true, + "parameters": [ + { + "name": "order_by_data_item", + "type": "TYPE_STRING" + }, + { + "name": "order_by_annotation", + "type": ".google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation" + }, + { + "name": "dataset", + "type": "TYPE_STRING" + }, + { + "name": "saved_query", + "type": "TYPE_STRING" + }, + { + "name": "data_labeling_job", + "type": "TYPE_STRING" + }, + { + "name": "data_item_filter", + "type": "TYPE_STRING" + }, + { + "name": "annotations_filter", + "type": "TYPE_STRING" + }, + { + "name": "annotation_filters", + "type": "TYPE_STRING[]" + }, + { + "name": "field_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "annotations_limit", + "type": "TYPE_INT32" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.SearchDataItemsResponse", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetServiceClient" + }, + "method": { + "shortName": "SearchDataItems", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.SearchDataItems", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_DatasetService_ListSavedQueries_async", + "title": "DatasetService listSavedQueries Sample", + "origin": "API_DEFINITION", + "description": " Lists SavedQueries in a Dataset.", + "canonical": true, + "file": "dataset_service.list_saved_queries.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 78, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListSavedQueries", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.ListSavedQueries", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListSavedQueriesResponse", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetServiceClient" + }, + "method": { + "shortName": "ListSavedQueries", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.ListSavedQueries", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_DatasetService_DeleteSavedQuery_async", + "title": "DatasetService deleteSavedQuery Sample", + "origin": "API_DEFINITION", + "description": " Deletes a SavedQuery.", + "canonical": true, + "file": "dataset_service.delete_saved_query.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteSavedQuery", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.DeleteSavedQuery", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetServiceClient" + }, + "method": { + "shortName": "DeleteSavedQuery", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.DeleteSavedQuery", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_DatasetService_GetAnnotationSpec_async", + "title": "DatasetService getAnnotationSpec Sample", + "origin": "API_DEFINITION", + "description": " Gets an AnnotationSpec.", + "canonical": true, + "file": "dataset_service.get_annotation_spec.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetAnnotationSpec", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.GetAnnotationSpec", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.AnnotationSpec", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetServiceClient" + }, + "method": { + "shortName": "GetAnnotationSpec", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.GetAnnotationSpec", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_DatasetService_ListAnnotations_async", + "title": "DatasetService listAnnotations Sample", + "origin": "API_DEFINITION", + "description": " Lists Annotations belongs to a dataitem", + "canonical": true, + "file": "dataset_service.list_annotations.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 78, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListAnnotations", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.ListAnnotations", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListAnnotationsResponse", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetServiceClient" + }, + "method": { + "shortName": "ListAnnotations", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.ListAnnotations", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_DeploymentResourcePoolService_CreateDeploymentResourcePool_async", + "title": "DatasetService createDeploymentResourcePool Sample", + "origin": "API_DEFINITION", + "description": " Create a DeploymentResourcePool.", + "canonical": true, + "file": "deployment_resource_pool_service.create_deployment_resource_pool.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateDeploymentResourcePool", + "fullName": "google.cloud.aiplatform.v1beta1.DeploymentResourcePoolService.CreateDeploymentResourcePool", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "deployment_resource_pool", + "type": ".google.cloud.aiplatform.v1beta1.DeploymentResourcePool" + }, + { + "name": "deployment_resource_pool_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DeploymentResourcePoolServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.DeploymentResourcePoolServiceClient" + }, + "method": { + "shortName": "CreateDeploymentResourcePool", + "fullName": "google.cloud.aiplatform.v1beta1.DeploymentResourcePoolService.CreateDeploymentResourcePool", + "service": { + "shortName": "DeploymentResourcePoolService", + "fullName": "google.cloud.aiplatform.v1beta1.DeploymentResourcePoolService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_DeploymentResourcePoolService_GetDeploymentResourcePool_async", + "title": "DatasetService getDeploymentResourcePool Sample", + "origin": "API_DEFINITION", + "description": " Get a DeploymentResourcePool.", + "canonical": true, + "file": "deployment_resource_pool_service.get_deployment_resource_pool.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetDeploymentResourcePool", + "fullName": "google.cloud.aiplatform.v1beta1.DeploymentResourcePoolService.GetDeploymentResourcePool", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.DeploymentResourcePool", + "client": { + "shortName": "DeploymentResourcePoolServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.DeploymentResourcePoolServiceClient" + }, + "method": { + "shortName": "GetDeploymentResourcePool", + "fullName": "google.cloud.aiplatform.v1beta1.DeploymentResourcePoolService.GetDeploymentResourcePool", + "service": { + "shortName": "DeploymentResourcePoolService", + "fullName": "google.cloud.aiplatform.v1beta1.DeploymentResourcePoolService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_DeploymentResourcePoolService_ListDeploymentResourcePools_async", + "title": "DatasetService listDeploymentResourcePools Sample", + "origin": "API_DEFINITION", + "description": " List DeploymentResourcePools in a location.", + "canonical": true, + "file": "deployment_resource_pool_service.list_deployment_resource_pools.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListDeploymentResourcePools", + "fullName": "google.cloud.aiplatform.v1beta1.DeploymentResourcePoolService.ListDeploymentResourcePools", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListDeploymentResourcePoolsResponse", + "client": { + "shortName": "DeploymentResourcePoolServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.DeploymentResourcePoolServiceClient" + }, + "method": { + "shortName": "ListDeploymentResourcePools", + "fullName": "google.cloud.aiplatform.v1beta1.DeploymentResourcePoolService.ListDeploymentResourcePools", + "service": { + "shortName": "DeploymentResourcePoolService", + "fullName": "google.cloud.aiplatform.v1beta1.DeploymentResourcePoolService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_DeploymentResourcePoolService_DeleteDeploymentResourcePool_async", + "title": "DatasetService deleteDeploymentResourcePool Sample", + "origin": "API_DEFINITION", + "description": " Delete a DeploymentResourcePool.", + "canonical": true, + "file": "deployment_resource_pool_service.delete_deployment_resource_pool.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteDeploymentResourcePool", + "fullName": "google.cloud.aiplatform.v1beta1.DeploymentResourcePoolService.DeleteDeploymentResourcePool", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DeploymentResourcePoolServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.DeploymentResourcePoolServiceClient" + }, + "method": { + "shortName": "DeleteDeploymentResourcePool", + "fullName": "google.cloud.aiplatform.v1beta1.DeploymentResourcePoolService.DeleteDeploymentResourcePool", + "service": { + "shortName": "DeploymentResourcePoolService", + "fullName": "google.cloud.aiplatform.v1beta1.DeploymentResourcePoolService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_DeploymentResourcePoolService_QueryDeployedModels_async", + "title": "DatasetService queryDeployedModels Sample", + "origin": "API_DEFINITION", + "description": " List DeployedModels that have been deployed on this DeploymentResourcePool.", + "canonical": true, + "file": "deployment_resource_pool_service.query_deployed_models.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 70, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "QueryDeployedModels", + "fullName": "google.cloud.aiplatform.v1beta1.DeploymentResourcePoolService.QueryDeployedModels", + "async": true, + "parameters": [ + { + "name": "deployment_resource_pool", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.QueryDeployedModelsResponse", + "client": { + "shortName": "DeploymentResourcePoolServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.DeploymentResourcePoolServiceClient" + }, + "method": { + "shortName": "QueryDeployedModels", + "fullName": "google.cloud.aiplatform.v1beta1.DeploymentResourcePoolService.QueryDeployedModels", + "service": { + "shortName": "DeploymentResourcePoolService", + "fullName": "google.cloud.aiplatform.v1beta1.DeploymentResourcePoolService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_EndpointService_CreateEndpoint_async", + "title": "DatasetService createEndpoint Sample", + "origin": "API_DEFINITION", + "description": " Creates an Endpoint.", + "canonical": true, + "file": "endpoint_service.create_endpoint.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateEndpoint", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointService.CreateEndpoint", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "endpoint", + "type": ".google.cloud.aiplatform.v1beta1.Endpoint" + }, + { + "name": "endpoint_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "EndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointServiceClient" + }, + "method": { + "shortName": "CreateEndpoint", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointService.CreateEndpoint", + "service": { + "shortName": "EndpointService", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_EndpointService_GetEndpoint_async", + "title": "DatasetService getEndpoint Sample", + "origin": "API_DEFINITION", + "description": " Gets an Endpoint.", + "canonical": true, + "file": "endpoint_service.get_endpoint.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetEndpoint", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointService.GetEndpoint", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Endpoint", + "client": { + "shortName": "EndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointServiceClient" + }, + "method": { + "shortName": "GetEndpoint", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointService.GetEndpoint", + "service": { + "shortName": "EndpointService", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_EndpointService_ListEndpoints_async", + "title": "DatasetService listEndpoints Sample", + "origin": "API_DEFINITION", + "description": " Lists Endpoints in a Location.", + "canonical": true, + "file": "endpoint_service.list_endpoints.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 90, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListEndpoints", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointService.ListEndpoints", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListEndpointsResponse", + "client": { + "shortName": "EndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointServiceClient" + }, + "method": { + "shortName": "ListEndpoints", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointService.ListEndpoints", + "service": { + "shortName": "EndpointService", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_EndpointService_UpdateEndpoint_async", + "title": "DatasetService updateEndpoint Sample", + "origin": "API_DEFINITION", + "description": " Updates an Endpoint.", + "canonical": true, + "file": "endpoint_service.update_endpoint.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateEndpoint", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointService.UpdateEndpoint", + "async": true, + "parameters": [ + { + "name": "endpoint", + "type": ".google.cloud.aiplatform.v1beta1.Endpoint" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Endpoint", + "client": { + "shortName": "EndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointServiceClient" + }, + "method": { + "shortName": "UpdateEndpoint", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointService.UpdateEndpoint", + "service": { + "shortName": "EndpointService", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_EndpointService_DeleteEndpoint_async", + "title": "DatasetService deleteEndpoint Sample", + "origin": "API_DEFINITION", + "description": " Deletes an Endpoint.", + "canonical": true, + "file": "endpoint_service.delete_endpoint.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteEndpoint", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointService.DeleteEndpoint", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "EndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointServiceClient" + }, + "method": { + "shortName": "DeleteEndpoint", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointService.DeleteEndpoint", + "service": { + "shortName": "EndpointService", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_EndpointService_DeployModel_async", + "title": "DatasetService deployModel Sample", + "origin": "API_DEFINITION", + "description": " Deploys a Model into this Endpoint, creating a DeployedModel within it.", + "canonical": true, + "file": "endpoint_service.deploy_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeployModel", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointService.DeployModel", + "async": true, + "parameters": [ + { + "name": "endpoint", + "type": "TYPE_STRING" + }, + { + "name": "deployed_model", + "type": ".google.cloud.aiplatform.v1beta1.DeployedModel" + }, + { + "name": "traffic_split", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "EndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointServiceClient" + }, + "method": { + "shortName": "DeployModel", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointService.DeployModel", + "service": { + "shortName": "EndpointService", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_EndpointService_UndeployModel_async", + "title": "DatasetService undeployModel Sample", + "origin": "API_DEFINITION", + "description": " Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using.", + "canonical": true, + "file": "endpoint_service.undeploy_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UndeployModel", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointService.UndeployModel", + "async": true, + "parameters": [ + { + "name": "endpoint", + "type": "TYPE_STRING" + }, + { + "name": "deployed_model_id", + "type": "TYPE_STRING" + }, + { + "name": "traffic_split", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "EndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointServiceClient" + }, + "method": { + "shortName": "UndeployModel", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointService.UndeployModel", + "service": { + "shortName": "EndpointService", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_EndpointService_MutateDeployedModel_async", + "title": "DatasetService mutateDeployedModel Sample", + "origin": "API_DEFINITION", + "description": " Updates an existing deployed model. Updatable fields include `min_replica_count`, `max_replica_count`, `autoscaling_metric_specs`, `disable_container_logging` (v1 only), and `enable_container_logging` (v1beta1 only).", + "canonical": true, + "file": "endpoint_service.mutate_deployed_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 77, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "MutateDeployedModel", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointService.MutateDeployedModel", + "async": true, + "parameters": [ + { + "name": "endpoint", + "type": "TYPE_STRING" + }, + { + "name": "deployed_model", + "type": ".google.cloud.aiplatform.v1beta1.DeployedModel" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "EndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointServiceClient" + }, + "method": { + "shortName": "MutateDeployedModel", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointService.MutateDeployedModel", + "service": { + "shortName": "EndpointService", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreOnlineServingService_ReadFeatureValues_async", + "title": "DatasetService readFeatureValues Sample", + "origin": "API_DEFINITION", + "description": " Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues.", + "canonical": true, + "file": "featurestore_online_serving_service.read_feature_values.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ReadFeatureValues", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreOnlineServingService.ReadFeatureValues", + "async": true, + "parameters": [ + { + "name": "entity_type", + "type": "TYPE_STRING" + }, + { + "name": "entity_id", + "type": "TYPE_STRING" + }, + { + "name": "feature_selector", + "type": ".google.cloud.aiplatform.v1beta1.FeatureSelector" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ReadFeatureValuesResponse", + "client": { + "shortName": "FeaturestoreOnlineServingServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreOnlineServingServiceClient" + }, + "method": { + "shortName": "ReadFeatureValues", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreOnlineServingService.ReadFeatureValues", + "service": { + "shortName": "FeaturestoreOnlineServingService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreOnlineServingService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreOnlineServingService_StreamingReadFeatureValues_async", + "title": "DatasetService streamingReadFeatureValues Sample", + "origin": "API_DEFINITION", + "description": " Reads Feature values for multiple entities. Depending on their size, data for different entities may be broken up across multiple responses.", + "canonical": true, + "file": "featurestore_online_serving_service.streaming_read_feature_values.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 73, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "StreamingReadFeatureValues", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreOnlineServingService.StreamingReadFeatureValues", + "async": true, + "parameters": [ + { + "name": "entity_type", + "type": "TYPE_STRING" + }, + { + "name": "entity_ids", + "type": "TYPE_STRING[]" + }, + { + "name": "feature_selector", + "type": ".google.cloud.aiplatform.v1beta1.FeatureSelector" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ReadFeatureValuesResponse", + "client": { + "shortName": "FeaturestoreOnlineServingServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreOnlineServingServiceClient" + }, + "method": { + "shortName": "StreamingReadFeatureValues", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreOnlineServingService.StreamingReadFeatureValues", + "service": { + "shortName": "FeaturestoreOnlineServingService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreOnlineServingService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreOnlineServingService_WriteFeatureValues_async", + "title": "DatasetService writeFeatureValues Sample", + "origin": "API_DEFINITION", + "description": " Writes Feature values of one or more entities of an EntityType. The Feature values are merged into existing entities if any. The Feature values to be written must have timestamp within the online storage retention.", + "canonical": true, + "file": "featurestore_online_serving_service.write_feature_values.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 64, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "WriteFeatureValues", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreOnlineServingService.WriteFeatureValues", + "async": true, + "parameters": [ + { + "name": "entity_type", + "type": "TYPE_STRING" + }, + { + "name": "payloads", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.WriteFeatureValuesResponse", + "client": { + "shortName": "FeaturestoreOnlineServingServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreOnlineServingServiceClient" + }, + "method": { + "shortName": "WriteFeatureValues", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreOnlineServingService.WriteFeatureValues", + "service": { + "shortName": "FeaturestoreOnlineServingService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreOnlineServingService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreService_CreateFeaturestore_async", + "title": "DatasetService createFeaturestore Sample", + "origin": "API_DEFINITION", + "description": " Creates a new Featurestore in a given project and location.", + "canonical": true, + "file": "featurestore_service.create_featurestore.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 70, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateFeaturestore", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.CreateFeaturestore", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "featurestore", + "type": ".google.cloud.aiplatform.v1beta1.Featurestore" + }, + { + "name": "featurestore_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "CreateFeaturestore", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.CreateFeaturestore", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreService_GetFeaturestore_async", + "title": "DatasetService getFeaturestore Sample", + "origin": "API_DEFINITION", + "description": " Gets details of a single Featurestore.", + "canonical": true, + "file": "featurestore_service.get_featurestore.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetFeaturestore", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.GetFeaturestore", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Featurestore", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "GetFeaturestore", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.GetFeaturestore", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreService_ListFeaturestores_async", + "title": "DatasetService listFeaturestores Sample", + "origin": "API_DEFINITION", + "description": " Lists Featurestores in a given project and location.", + "canonical": true, + "file": "featurestore_service.list_featurestores.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 105, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListFeaturestores", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeaturestores", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListFeaturestoresResponse", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "ListFeaturestores", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeaturestores", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreService_UpdateFeaturestore_async", + "title": "DatasetService updateFeaturestore Sample", + "origin": "API_DEFINITION", + "description": " Updates the parameters of a single Featurestore.", + "canonical": true, + "file": "featurestore_service.update_featurestore.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateFeaturestore", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.UpdateFeaturestore", + "async": true, + "parameters": [ + { + "name": "featurestore", + "type": ".google.cloud.aiplatform.v1beta1.Featurestore" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "UpdateFeaturestore", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.UpdateFeaturestore", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreService_DeleteFeaturestore_async", + "title": "DatasetService deleteFeaturestore Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single Featurestore. The Featurestore must not contain any EntityTypes or `force` must be set to true for the request to succeed.", + "canonical": true, + "file": "featurestore_service.delete_featurestore.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteFeaturestore", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.DeleteFeaturestore", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "DeleteFeaturestore", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.DeleteFeaturestore", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreService_CreateEntityType_async", + "title": "DatasetService createEntityType Sample", + "origin": "API_DEFINITION", + "description": " Creates a new EntityType in a given Featurestore.", + "canonical": true, + "file": "featurestore_service.create_entity_type.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateEntityType", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.CreateEntityType", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "entity_type", + "type": ".google.cloud.aiplatform.v1beta1.EntityType" + }, + { + "name": "entity_type_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "CreateEntityType", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.CreateEntityType", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreService_GetEntityType_async", + "title": "DatasetService getEntityType Sample", + "origin": "API_DEFINITION", + "description": " Gets details of a single EntityType.", + "canonical": true, + "file": "featurestore_service.get_entity_type.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetEntityType", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.GetEntityType", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.EntityType", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "GetEntityType", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.GetEntityType", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreService_ListEntityTypes_async", + "title": "DatasetService listEntityTypes Sample", + "origin": "API_DEFINITION", + "description": " Lists EntityTypes in a given Featurestore.", + "canonical": true, + "file": "featurestore_service.list_entity_types.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 104, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListEntityTypes", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListEntityTypesResponse", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "ListEntityTypes", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreService_UpdateEntityType_async", + "title": "DatasetService updateEntityType Sample", + "origin": "API_DEFINITION", + "description": " Updates the parameters of a single EntityType.", + "canonical": true, + "file": "featurestore_service.update_entity_type.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 76, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateEntityType", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.UpdateEntityType", + "async": true, + "parameters": [ + { + "name": "entity_type", + "type": ".google.cloud.aiplatform.v1beta1.EntityType" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.EntityType", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "UpdateEntityType", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.UpdateEntityType", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreService_DeleteEntityType_async", + "title": "DatasetService deleteEntityType Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single EntityType. The EntityType must not have any Features or `force` must be set to true for the request to succeed.", + "canonical": true, + "file": "featurestore_service.delete_entity_type.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteEntityType", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.DeleteEntityType", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "DeleteEntityType", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.DeleteEntityType", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreService_CreateFeature_async", + "title": "DatasetService createFeature Sample", + "origin": "API_DEFINITION", + "description": " Creates a new Feature in a given EntityType.", + "canonical": true, + "file": "featurestore_service.create_feature.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 70, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateFeature", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.CreateFeature", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "feature", + "type": ".google.cloud.aiplatform.v1beta1.Feature" + }, + { + "name": "feature_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "CreateFeature", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.CreateFeature", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreService_BatchCreateFeatures_async", + "title": "DatasetService batchCreateFeatures Sample", + "origin": "API_DEFINITION", + "description": " Creates a batch of Features in a given EntityType.", + "canonical": true, + "file": "featurestore_service.batch_create_features.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchCreateFeatures", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.BatchCreateFeatures", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "requests", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "BatchCreateFeatures", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.BatchCreateFeatures", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreService_GetFeature_async", + "title": "DatasetService getFeature Sample", + "origin": "API_DEFINITION", + "description": " Gets details of a single Feature.", + "canonical": true, + "file": "featurestore_service.get_feature.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetFeature", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.GetFeature", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Feature", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "GetFeature", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.GetFeature", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreService_ListFeatures_async", + "title": "DatasetService listFeatures Sample", + "origin": "API_DEFINITION", + "description": " Lists Features in a given EntityType.", + "canonical": true, + "file": "featurestore_service.list_features.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 116, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListFeatures", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "latest_stats_count", + "type": "TYPE_INT32" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListFeaturesResponse", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "ListFeatures", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreService_UpdateFeature_async", + "title": "DatasetService updateFeature Sample", + "origin": "API_DEFINITION", + "description": " Updates the parameters of a single Feature.", + "canonical": true, + "file": "featurestore_service.update_feature.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 70, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateFeature", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.UpdateFeature", + "async": true, + "parameters": [ + { + "name": "feature", + "type": ".google.cloud.aiplatform.v1beta1.Feature" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Feature", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "UpdateFeature", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.UpdateFeature", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreService_DeleteFeature_async", + "title": "DatasetService deleteFeature Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single Feature.", + "canonical": true, + "file": "featurestore_service.delete_feature.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteFeature", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.DeleteFeature", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "DeleteFeature", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.DeleteFeature", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreService_ImportFeatureValues_async", + "title": "DatasetService importFeatureValues Sample", + "origin": "API_DEFINITION", + "description": " Imports Feature values into the Featurestore from a source storage. The progress of the import is tracked by the returned operation. The imported features are guaranteed to be visible to subsequent read operations after the operation is marked as successfully done. If an import operation fails, the Feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same import request again and wait till the new operation returned is marked as successfully done. There are also scenarios where the caller can cause inconsistency. - Source data for import contains multiple distinct Feature values for the same entity ID and timestamp. - Source is modified during an import. This includes adding, updating, or removing source data and/or metadata. Examples of updating metadata include but are not limited to changing storage location, storage class, or retention policy. - Online serving cluster is under-provisioned.", + "canonical": true, + "file": "featurestore_service.import_feature_values.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 106, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ImportFeatureValues", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.ImportFeatureValues", + "async": true, + "parameters": [ + { + "name": "avro_source", + "type": ".google.cloud.aiplatform.v1beta1.AvroSource" + }, + { + "name": "bigquery_source", + "type": ".google.cloud.aiplatform.v1beta1.BigQuerySource" + }, + { + "name": "csv_source", + "type": ".google.cloud.aiplatform.v1beta1.CsvSource" + }, + { + "name": "feature_time_field", + "type": "TYPE_STRING" + }, + { + "name": "feature_time", + "type": ".google.protobuf.Timestamp" + }, + { + "name": "entity_type", + "type": "TYPE_STRING" + }, + { + "name": "entity_id_field", + "type": "TYPE_STRING" + }, + { + "name": "feature_specs", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "disable_online_serving", + "type": "TYPE_BOOL" + }, + { + "name": "worker_count", + "type": "TYPE_INT32" + }, + { + "name": "disable_ingestion_analysis", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "ImportFeatureValues", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.ImportFeatureValues", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreService_BatchReadFeatureValues_async", + "title": "DatasetService batchReadFeatureValues Sample", + "origin": "API_DEFINITION", + "description": " Batch reads Feature values from a Featurestore. This API enables batch reading Feature values, where each read instance in the batch may read Feature values of entities from one or more EntityTypes. Point-in-time correctness is guaranteed for Feature values of each read instance as of each instance's read timestamp.", + "canonical": true, + "file": "featurestore_service.batch_read_feature_values.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 106, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchReadFeatureValues", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.BatchReadFeatureValues", + "async": true, + "parameters": [ + { + "name": "csv_read_instances", + "type": ".google.cloud.aiplatform.v1beta1.CsvSource" + }, + { + "name": "bigquery_read_instances", + "type": ".google.cloud.aiplatform.v1beta1.BigQuerySource" + }, + { + "name": "featurestore", + "type": "TYPE_STRING" + }, + { + "name": "destination", + "type": ".google.cloud.aiplatform.v1beta1.FeatureValueDestination" + }, + { + "name": "pass_through_fields", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "entity_type_specs", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "start_time", + "type": ".google.protobuf.Timestamp" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "BatchReadFeatureValues", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.BatchReadFeatureValues", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreService_ExportFeatureValues_async", + "title": "DatasetService exportFeatureValues Sample", + "origin": "API_DEFINITION", + "description": " Exports Feature values from all the entities of a target EntityType.", + "canonical": true, + "file": "featurestore_service.export_feature_values.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ExportFeatureValues", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.ExportFeatureValues", + "async": true, + "parameters": [ + { + "name": "snapshot_export", + "type": ".google.cloud.aiplatform.v1beta1.ExportFeatureValuesRequest.SnapshotExport" + }, + { + "name": "full_export", + "type": ".google.cloud.aiplatform.v1beta1.ExportFeatureValuesRequest.FullExport" + }, + { + "name": "entity_type", + "type": "TYPE_STRING" + }, + { + "name": "destination", + "type": ".google.cloud.aiplatform.v1beta1.FeatureValueDestination" + }, + { + "name": "feature_selector", + "type": ".google.cloud.aiplatform.v1beta1.FeatureSelector" + }, + { + "name": "settings", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "ExportFeatureValues", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.ExportFeatureValues", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreService_DeleteFeatureValues_async", + "title": "DatasetService deleteFeatureValues Sample", + "origin": "API_DEFINITION", + "description": " Delete Feature values from Featurestore. The progress of the deletion is tracked by the returned operation. The deleted feature values are guaranteed to be invisible to subsequent read operations after the operation is marked as successfully done. If a delete feature values operation fails, the feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same delete request again and wait till the new operation returned is marked as successfully done.", + "canonical": true, + "file": "featurestore_service.delete_feature_values.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteFeatureValues", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.DeleteFeatureValues", + "async": true, + "parameters": [ + { + "name": "select_entity", + "type": ".google.cloud.aiplatform.v1beta1.DeleteFeatureValuesRequest.SelectEntity" + }, + { + "name": "select_time_range_and_feature", + "type": ".google.cloud.aiplatform.v1beta1.DeleteFeatureValuesRequest.SelectTimeRangeAndFeature" + }, + { + "name": "entity_type", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "DeleteFeatureValues", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.DeleteFeatureValues", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreService_SearchFeatures_async", + "title": "DatasetService searchFeatures Sample", + "origin": "API_DEFINITION", + "description": " Searches Features matching a query in a given project.", + "canonical": true, + "file": "featurestore_service.search_features.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 124, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SearchFeatures", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures", + "async": true, + "parameters": [ + { + "name": "location", + "type": "TYPE_STRING" + }, + { + "name": "query", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.SearchFeaturesResponse", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "SearchFeatures", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_IndexEndpointService_CreateIndexEndpoint_async", + "title": "DatasetService createIndexEndpoint Sample", + "origin": "API_DEFINITION", + "description": " Creates an IndexEndpoint.", + "canonical": true, + "file": "index_endpoint_service.create_index_endpoint.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateIndexEndpoint", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService.CreateIndexEndpoint", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "index_endpoint", + "type": ".google.cloud.aiplatform.v1beta1.IndexEndpoint" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "IndexEndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointServiceClient" + }, + "method": { + "shortName": "CreateIndexEndpoint", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService.CreateIndexEndpoint", + "service": { + "shortName": "IndexEndpointService", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_IndexEndpointService_GetIndexEndpoint_async", + "title": "DatasetService getIndexEndpoint Sample", + "origin": "API_DEFINITION", + "description": " Gets an IndexEndpoint.", + "canonical": true, + "file": "index_endpoint_service.get_index_endpoint.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetIndexEndpoint", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService.GetIndexEndpoint", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.IndexEndpoint", + "client": { + "shortName": "IndexEndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointServiceClient" + }, + "method": { + "shortName": "GetIndexEndpoint", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService.GetIndexEndpoint", + "service": { + "shortName": "IndexEndpointService", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_IndexEndpointService_ListIndexEndpoints_async", + "title": "DatasetService listIndexEndpoints Sample", + "origin": "API_DEFINITION", + "description": " Lists IndexEndpoints in a Location.", + "canonical": true, + "file": "index_endpoint_service.list_index_endpoints.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 92, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListIndexEndpoints", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService.ListIndexEndpoints", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListIndexEndpointsResponse", + "client": { + "shortName": "IndexEndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointServiceClient" + }, + "method": { + "shortName": "ListIndexEndpoints", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService.ListIndexEndpoints", + "service": { + "shortName": "IndexEndpointService", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_IndexEndpointService_UpdateIndexEndpoint_async", + "title": "DatasetService updateIndexEndpoint Sample", + "origin": "API_DEFINITION", + "description": " Updates an IndexEndpoint.", + "canonical": true, + "file": "index_endpoint_service.update_index_endpoint.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateIndexEndpoint", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService.UpdateIndexEndpoint", + "async": true, + "parameters": [ + { + "name": "index_endpoint", + "type": ".google.cloud.aiplatform.v1beta1.IndexEndpoint" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.IndexEndpoint", + "client": { + "shortName": "IndexEndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointServiceClient" + }, + "method": { + "shortName": "UpdateIndexEndpoint", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService.UpdateIndexEndpoint", + "service": { + "shortName": "IndexEndpointService", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_IndexEndpointService_DeleteIndexEndpoint_async", + "title": "DatasetService deleteIndexEndpoint Sample", + "origin": "API_DEFINITION", + "description": " Deletes an IndexEndpoint.", + "canonical": true, + "file": "index_endpoint_service.delete_index_endpoint.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteIndexEndpoint", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService.DeleteIndexEndpoint", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "IndexEndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointServiceClient" + }, + "method": { + "shortName": "DeleteIndexEndpoint", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService.DeleteIndexEndpoint", + "service": { + "shortName": "IndexEndpointService", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_IndexEndpointService_DeployIndex_async", + "title": "DatasetService deployIndex Sample", + "origin": "API_DEFINITION", + "description": " Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. Only non-empty Indexes can be deployed.", + "canonical": true, + "file": "index_endpoint_service.deploy_index.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeployIndex", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService.DeployIndex", + "async": true, + "parameters": [ + { + "name": "index_endpoint", + "type": "TYPE_STRING" + }, + { + "name": "deployed_index", + "type": ".google.cloud.aiplatform.v1beta1.DeployedIndex" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "IndexEndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointServiceClient" + }, + "method": { + "shortName": "DeployIndex", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService.DeployIndex", + "service": { + "shortName": "IndexEndpointService", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_IndexEndpointService_UndeployIndex_async", + "title": "DatasetService undeployIndex Sample", + "origin": "API_DEFINITION", + "description": " Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.", + "canonical": true, + "file": "index_endpoint_service.undeploy_index.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UndeployIndex", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService.UndeployIndex", + "async": true, + "parameters": [ + { + "name": "index_endpoint", + "type": "TYPE_STRING" + }, + { + "name": "deployed_index_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "IndexEndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointServiceClient" + }, + "method": { + "shortName": "UndeployIndex", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService.UndeployIndex", + "service": { + "shortName": "IndexEndpointService", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_IndexEndpointService_MutateDeployedIndex_async", + "title": "DatasetService mutateDeployedIndex Sample", + "origin": "API_DEFINITION", + "description": " Update an existing DeployedIndex under an IndexEndpoint.", + "canonical": true, + "file": "index_endpoint_service.mutate_deployed_index.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "MutateDeployedIndex", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService.MutateDeployedIndex", + "async": true, + "parameters": [ + { + "name": "index_endpoint", + "type": "TYPE_STRING" + }, + { + "name": "deployed_index", + "type": ".google.cloud.aiplatform.v1beta1.DeployedIndex" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "IndexEndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointServiceClient" + }, + "method": { + "shortName": "MutateDeployedIndex", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService.MutateDeployedIndex", + "service": { + "shortName": "IndexEndpointService", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_IndexService_CreateIndex_async", + "title": "DatasetService createIndex Sample", + "origin": "API_DEFINITION", + "description": " Creates an Index.", + "canonical": true, + "file": "index_service.create_index.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateIndex", + "fullName": "google.cloud.aiplatform.v1beta1.IndexService.CreateIndex", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "index", + "type": ".google.cloud.aiplatform.v1beta1.Index" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "IndexServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.IndexServiceClient" + }, + "method": { + "shortName": "CreateIndex", + "fullName": "google.cloud.aiplatform.v1beta1.IndexService.CreateIndex", + "service": { + "shortName": "IndexService", + "fullName": "google.cloud.aiplatform.v1beta1.IndexService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_IndexService_GetIndex_async", + "title": "DatasetService getIndex Sample", + "origin": "API_DEFINITION", + "description": " Gets an Index.", + "canonical": true, + "file": "index_service.get_index.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetIndex", + "fullName": "google.cloud.aiplatform.v1beta1.IndexService.GetIndex", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Index", + "client": { + "shortName": "IndexServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.IndexServiceClient" + }, + "method": { + "shortName": "GetIndex", + "fullName": "google.cloud.aiplatform.v1beta1.IndexService.GetIndex", + "service": { + "shortName": "IndexService", + "fullName": "google.cloud.aiplatform.v1beta1.IndexService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_IndexService_ListIndexes_async", + "title": "DatasetService listIndexes Sample", + "origin": "API_DEFINITION", + "description": " Lists Indexes in a Location.", + "canonical": true, + "file": "index_service.list_indexes.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 77, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListIndexes", + "fullName": "google.cloud.aiplatform.v1beta1.IndexService.ListIndexes", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListIndexesResponse", + "client": { + "shortName": "IndexServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.IndexServiceClient" + }, + "method": { + "shortName": "ListIndexes", + "fullName": "google.cloud.aiplatform.v1beta1.IndexService.ListIndexes", + "service": { + "shortName": "IndexService", + "fullName": "google.cloud.aiplatform.v1beta1.IndexService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_IndexService_UpdateIndex_async", + "title": "DatasetService updateIndex Sample", + "origin": "API_DEFINITION", + "description": " Updates an Index.", + "canonical": true, + "file": "index_service.update_index.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateIndex", + "fullName": "google.cloud.aiplatform.v1beta1.IndexService.UpdateIndex", + "async": true, + "parameters": [ + { + "name": "index", + "type": ".google.cloud.aiplatform.v1beta1.Index" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "IndexServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.IndexServiceClient" + }, + "method": { + "shortName": "UpdateIndex", + "fullName": "google.cloud.aiplatform.v1beta1.IndexService.UpdateIndex", + "service": { + "shortName": "IndexService", + "fullName": "google.cloud.aiplatform.v1beta1.IndexService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_IndexService_DeleteIndex_async", + "title": "DatasetService deleteIndex Sample", + "origin": "API_DEFINITION", + "description": " Deletes an Index. An Index can only be deleted when all its [DeployedIndexes][google.cloud.aiplatform.v1beta1.Index.deployed_indexes] had been undeployed.", + "canonical": true, + "file": "index_service.delete_index.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteIndex", + "fullName": "google.cloud.aiplatform.v1beta1.IndexService.DeleteIndex", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "IndexServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.IndexServiceClient" + }, + "method": { + "shortName": "DeleteIndex", + "fullName": "google.cloud.aiplatform.v1beta1.IndexService.DeleteIndex", + "service": { + "shortName": "IndexService", + "fullName": "google.cloud.aiplatform.v1beta1.IndexService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_IndexService_UpsertDatapoints_async", + "title": "DatasetService upsertDatapoints Sample", + "origin": "API_DEFINITION", + "description": " Add/update Datapoints into an Index.", + "canonical": true, + "file": "index_service.upsert_datapoints.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpsertDatapoints", + "fullName": "google.cloud.aiplatform.v1beta1.IndexService.UpsertDatapoints", + "async": true, + "parameters": [ + { + "name": "index", + "type": "TYPE_STRING" + }, + { + "name": "datapoints", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.UpsertDatapointsResponse", + "client": { + "shortName": "IndexServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.IndexServiceClient" + }, + "method": { + "shortName": "UpsertDatapoints", + "fullName": "google.cloud.aiplatform.v1beta1.IndexService.UpsertDatapoints", + "service": { + "shortName": "IndexService", + "fullName": "google.cloud.aiplatform.v1beta1.IndexService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_IndexService_RemoveDatapoints_async", + "title": "DatasetService removeDatapoints Sample", + "origin": "API_DEFINITION", + "description": " Remove Datapoints from an Index.", + "canonical": true, + "file": "index_service.remove_datapoints.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RemoveDatapoints", + "fullName": "google.cloud.aiplatform.v1beta1.IndexService.RemoveDatapoints", + "async": true, + "parameters": [ + { + "name": "index", + "type": "TYPE_STRING" + }, + { + "name": "datapoint_ids", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.RemoveDatapointsResponse", + "client": { + "shortName": "IndexServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.IndexServiceClient" + }, + "method": { + "shortName": "RemoveDatapoints", + "fullName": "google.cloud.aiplatform.v1beta1.IndexService.RemoveDatapoints", + "service": { + "shortName": "IndexService", + "fullName": "google.cloud.aiplatform.v1beta1.IndexService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_CreateCustomJob_async", + "title": "DatasetService createCustomJob Sample", + "origin": "API_DEFINITION", + "description": " Creates a CustomJob. A created CustomJob right away will be attempted to be run.", + "canonical": true, + "file": "job_service.create_custom_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateCustomJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.CreateCustomJob", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "custom_job", + "type": ".google.cloud.aiplatform.v1beta1.CustomJob" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.CustomJob", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "CreateCustomJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.CreateCustomJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_GetCustomJob_async", + "title": "DatasetService getCustomJob Sample", + "origin": "API_DEFINITION", + "description": " Gets a CustomJob.", + "canonical": true, + "file": "job_service.get_custom_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetCustomJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.GetCustomJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.CustomJob", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "GetCustomJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.GetCustomJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_ListCustomJobs_async", + "title": "DatasetService listCustomJobs Sample", + "origin": "API_DEFINITION", + "description": " Lists CustomJobs in a Location.", + "canonical": true, + "file": "job_service.list_custom_jobs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 92, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListCustomJobs", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.ListCustomJobs", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListCustomJobsResponse", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "ListCustomJobs", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.ListCustomJobs", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_DeleteCustomJob_async", + "title": "DatasetService deleteCustomJob Sample", + "origin": "API_DEFINITION", + "description": " Deletes a CustomJob.", + "canonical": true, + "file": "job_service.delete_custom_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteCustomJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.DeleteCustomJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "DeleteCustomJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.DeleteCustomJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_CancelCustomJob_async", + "title": "DatasetService cancelCustomJob Sample", + "origin": "API_DEFINITION", + "description": " Cancels a CustomJob. Starts asynchronous cancellation on the CustomJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use [JobService.GetCustomJob][google.cloud.aiplatform.v1beta1.JobService.GetCustomJob] or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the CustomJob is not deleted; instead it becomes a job with a [CustomJob.error][google.cloud.aiplatform.v1beta1.CustomJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [CustomJob.state][google.cloud.aiplatform.v1beta1.CustomJob.state] is set to `CANCELLED`.", + "canonical": true, + "file": "job_service.cancel_custom_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CancelCustomJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.CancelCustomJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "CancelCustomJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.CancelCustomJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_CreateDataLabelingJob_async", + "title": "DatasetService createDataLabelingJob Sample", + "origin": "API_DEFINITION", + "description": " Creates a DataLabelingJob.", + "canonical": true, + "file": "job_service.create_data_labeling_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateDataLabelingJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.CreateDataLabelingJob", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "data_labeling_job", + "type": ".google.cloud.aiplatform.v1beta1.DataLabelingJob" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.DataLabelingJob", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "CreateDataLabelingJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.CreateDataLabelingJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_GetDataLabelingJob_async", + "title": "DatasetService getDataLabelingJob Sample", + "origin": "API_DEFINITION", + "description": " Gets a DataLabelingJob.", + "canonical": true, + "file": "job_service.get_data_labeling_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetDataLabelingJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.GetDataLabelingJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.DataLabelingJob", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "GetDataLabelingJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.GetDataLabelingJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_ListDataLabelingJobs_async", + "title": "DatasetService listDataLabelingJobs Sample", + "origin": "API_DEFINITION", + "description": " Lists DataLabelingJobs in a Location.", + "canonical": true, + "file": "job_service.list_data_labeling_jobs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 96, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListDataLabelingJobs", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.ListDataLabelingJobs", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListDataLabelingJobsResponse", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "ListDataLabelingJobs", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.ListDataLabelingJobs", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_DeleteDataLabelingJob_async", + "title": "DatasetService deleteDataLabelingJob Sample", + "origin": "API_DEFINITION", + "description": " Deletes a DataLabelingJob.", + "canonical": true, + "file": "job_service.delete_data_labeling_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteDataLabelingJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.DeleteDataLabelingJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "DeleteDataLabelingJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.DeleteDataLabelingJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_CancelDataLabelingJob_async", + "title": "DatasetService cancelDataLabelingJob Sample", + "origin": "API_DEFINITION", + "description": " Cancels a DataLabelingJob. Success of cancellation is not guaranteed.", + "canonical": true, + "file": "job_service.cancel_data_labeling_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CancelDataLabelingJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.CancelDataLabelingJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "CancelDataLabelingJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.CancelDataLabelingJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_CreateHyperparameterTuningJob_async", + "title": "DatasetService createHyperparameterTuningJob Sample", + "origin": "API_DEFINITION", + "description": " Creates a HyperparameterTuningJob", + "canonical": true, + "file": "job_service.create_hyperparameter_tuning_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateHyperparameterTuningJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.CreateHyperparameterTuningJob", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "hyperparameter_tuning_job", + "type": ".google.cloud.aiplatform.v1beta1.HyperparameterTuningJob" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.HyperparameterTuningJob", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "CreateHyperparameterTuningJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.CreateHyperparameterTuningJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_GetHyperparameterTuningJob_async", + "title": "DatasetService getHyperparameterTuningJob Sample", + "origin": "API_DEFINITION", + "description": " Gets a HyperparameterTuningJob", + "canonical": true, + "file": "job_service.get_hyperparameter_tuning_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetHyperparameterTuningJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.GetHyperparameterTuningJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.HyperparameterTuningJob", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "GetHyperparameterTuningJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.GetHyperparameterTuningJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_ListHyperparameterTuningJobs_async", + "title": "DatasetService listHyperparameterTuningJobs Sample", + "origin": "API_DEFINITION", + "description": " Lists HyperparameterTuningJobs in a Location.", + "canonical": true, + "file": "job_service.list_hyperparameter_tuning_jobs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 93, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListHyperparameterTuningJobs", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.ListHyperparameterTuningJobs", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListHyperparameterTuningJobsResponse", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "ListHyperparameterTuningJobs", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.ListHyperparameterTuningJobs", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_DeleteHyperparameterTuningJob_async", + "title": "DatasetService deleteHyperparameterTuningJob Sample", + "origin": "API_DEFINITION", + "description": " Deletes a HyperparameterTuningJob.", + "canonical": true, + "file": "job_service.delete_hyperparameter_tuning_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteHyperparameterTuningJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.DeleteHyperparameterTuningJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "DeleteHyperparameterTuningJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.DeleteHyperparameterTuningJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_CancelHyperparameterTuningJob_async", + "title": "DatasetService cancelHyperparameterTuningJob Sample", + "origin": "API_DEFINITION", + "description": " Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on the HyperparameterTuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use [JobService.GetHyperparameterTuningJob][google.cloud.aiplatform.v1beta1.JobService.GetHyperparameterTuningJob] or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the HyperparameterTuningJob is not deleted; instead it becomes a job with a [HyperparameterTuningJob.error][google.cloud.aiplatform.v1beta1.HyperparameterTuningJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [HyperparameterTuningJob.state][google.cloud.aiplatform.v1beta1.HyperparameterTuningJob.state] is set to `CANCELLED`.", + "canonical": true, + "file": "job_service.cancel_hyperparameter_tuning_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CancelHyperparameterTuningJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.CancelHyperparameterTuningJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "CancelHyperparameterTuningJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.CancelHyperparameterTuningJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_CreateNasJob_async", + "title": "DatasetService createNasJob Sample", + "origin": "API_DEFINITION", + "description": " Creates a NasJob", + "canonical": true, + "file": "job_service.create_nas_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateNasJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.CreateNasJob", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "nas_job", + "type": ".google.cloud.aiplatform.v1beta1.NasJob" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.NasJob", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "CreateNasJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.CreateNasJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_GetNasJob_async", + "title": "DatasetService getNasJob Sample", + "origin": "API_DEFINITION", + "description": " Gets a NasJob", + "canonical": true, + "file": "job_service.get_nas_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetNasJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.GetNasJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.NasJob", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "GetNasJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.GetNasJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_ListNasJobs_async", + "title": "DatasetService listNasJobs Sample", + "origin": "API_DEFINITION", + "description": " Lists NasJobs in a Location.", + "canonical": true, + "file": "job_service.list_nas_jobs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 92, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListNasJobs", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.ListNasJobs", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListNasJobsResponse", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "ListNasJobs", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.ListNasJobs", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_DeleteNasJob_async", + "title": "DatasetService deleteNasJob Sample", + "origin": "API_DEFINITION", + "description": " Deletes a NasJob.", + "canonical": true, + "file": "job_service.delete_nas_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteNasJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.DeleteNasJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "DeleteNasJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.DeleteNasJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_CancelNasJob_async", + "title": "DatasetService cancelNasJob Sample", + "origin": "API_DEFINITION", + "description": " Cancels a NasJob. Starts asynchronous cancellation on the NasJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use [JobService.GetNasJob][google.cloud.aiplatform.v1beta1.JobService.GetNasJob] or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the NasJob is not deleted; instead it becomes a job with a [NasJob.error][google.cloud.aiplatform.v1beta1.NasJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [NasJob.state][google.cloud.aiplatform.v1beta1.NasJob.state] is set to `CANCELLED`.", + "canonical": true, + "file": "job_service.cancel_nas_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CancelNasJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.CancelNasJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "CancelNasJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.CancelNasJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_GetNasTrialDetail_async", + "title": "DatasetService getNasTrialDetail Sample", + "origin": "API_DEFINITION", + "description": " Gets a NasTrialDetail.", + "canonical": true, + "file": "job_service.get_nas_trial_detail.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetNasTrialDetail", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.GetNasTrialDetail", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.NasTrialDetail", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "GetNasTrialDetail", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.GetNasTrialDetail", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_ListNasTrialDetails_async", + "title": "DatasetService listNasTrialDetails Sample", + "origin": "API_DEFINITION", + "description": " List top NasTrialDetails of a NasJob.", + "canonical": true, + "file": "job_service.list_nas_trial_details.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 70, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListNasTrialDetails", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.ListNasTrialDetails", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListNasTrialDetailsResponse", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "ListNasTrialDetails", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.ListNasTrialDetails", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_CreateBatchPredictionJob_async", + "title": "DatasetService createBatchPredictionJob Sample", + "origin": "API_DEFINITION", + "description": " Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.", + "canonical": true, + "file": "job_service.create_batch_prediction_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateBatchPredictionJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.CreateBatchPredictionJob", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "batch_prediction_job", + "type": ".google.cloud.aiplatform.v1beta1.BatchPredictionJob" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.BatchPredictionJob", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "CreateBatchPredictionJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.CreateBatchPredictionJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_GetBatchPredictionJob_async", + "title": "DatasetService getBatchPredictionJob Sample", + "origin": "API_DEFINITION", + "description": " Gets a BatchPredictionJob", + "canonical": true, + "file": "job_service.get_batch_prediction_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetBatchPredictionJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.GetBatchPredictionJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.BatchPredictionJob", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "GetBatchPredictionJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.GetBatchPredictionJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_ListBatchPredictionJobs_async", + "title": "DatasetService listBatchPredictionJobs Sample", + "origin": "API_DEFINITION", + "description": " Lists BatchPredictionJobs in a Location.", + "canonical": true, + "file": "job_service.list_batch_prediction_jobs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 93, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListBatchPredictionJobs", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.ListBatchPredictionJobs", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListBatchPredictionJobsResponse", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "ListBatchPredictionJobs", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.ListBatchPredictionJobs", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_DeleteBatchPredictionJob_async", + "title": "DatasetService deleteBatchPredictionJob Sample", + "origin": "API_DEFINITION", + "description": " Deletes a BatchPredictionJob. Can only be called on jobs that already finished.", + "canonical": true, + "file": "job_service.delete_batch_prediction_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteBatchPredictionJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.DeleteBatchPredictionJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "DeleteBatchPredictionJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.DeleteBatchPredictionJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_CancelBatchPredictionJob_async", + "title": "DatasetService cancelBatchPredictionJob Sample", + "origin": "API_DEFINITION", + "description": " Cancels a BatchPredictionJob. Starts asynchronous cancellation on the BatchPredictionJob. The server makes the best effort to cancel the job, but success is not guaranteed. Clients can use [JobService.GetBatchPredictionJob][google.cloud.aiplatform.v1beta1.JobService.GetBatchPredictionJob] or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob is not deleted;instead its [BatchPredictionJob.state][google.cloud.aiplatform.v1beta1.BatchPredictionJob.state] is set to `CANCELLED`. Any files already outputted by the job are not deleted.", + "canonical": true, + "file": "job_service.cancel_batch_prediction_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CancelBatchPredictionJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.CancelBatchPredictionJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "CancelBatchPredictionJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.CancelBatchPredictionJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_CreateModelDeploymentMonitoringJob_async", + "title": "DatasetService createModelDeploymentMonitoringJob Sample", + "origin": "API_DEFINITION", + "description": " Creates a ModelDeploymentMonitoringJob. It will run periodically on a configured interval.", + "canonical": true, + "file": "job_service.create_model_deployment_monitoring_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.CreateModelDeploymentMonitoringJob", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "model_deployment_monitoring_job", + "type": ".google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "CreateModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.CreateModelDeploymentMonitoringJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_SearchModelDeploymentMonitoringStatsAnomalies_async", + "title": "DatasetService searchModelDeploymentMonitoringStatsAnomalies Sample", + "origin": "API_DEFINITION", + "description": " Searches Model Monitoring Statistics generated within a given time window.", + "canonical": true, + "file": "job_service.search_model_deployment_monitoring_stats_anomalies.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 95, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SearchModelDeploymentMonitoringStatsAnomalies", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.SearchModelDeploymentMonitoringStatsAnomalies", + "async": true, + "parameters": [ + { + "name": "model_deployment_monitoring_job", + "type": "TYPE_STRING" + }, + { + "name": "deployed_model_id", + "type": "TYPE_STRING" + }, + { + "name": "feature_display_name", + "type": "TYPE_STRING" + }, + { + "name": "objectives", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "start_time", + "type": ".google.protobuf.Timestamp" + }, + { + "name": "end_time", + "type": ".google.protobuf.Timestamp" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.SearchModelDeploymentMonitoringStatsAnomaliesResponse", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "SearchModelDeploymentMonitoringStatsAnomalies", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.SearchModelDeploymentMonitoringStatsAnomalies", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_GetModelDeploymentMonitoringJob_async", + "title": "DatasetService getModelDeploymentMonitoringJob Sample", + "origin": "API_DEFINITION", + "description": " Gets a ModelDeploymentMonitoringJob.", + "canonical": true, + "file": "job_service.get_model_deployment_monitoring_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.GetModelDeploymentMonitoringJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "GetModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.GetModelDeploymentMonitoringJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_ListModelDeploymentMonitoringJobs_async", + "title": "DatasetService listModelDeploymentMonitoringJobs Sample", + "origin": "API_DEFINITION", + "description": " Lists ModelDeploymentMonitoringJobs in a Location.", + "canonical": true, + "file": "job_service.list_model_deployment_monitoring_jobs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 87, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListModelDeploymentMonitoringJobs", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.ListModelDeploymentMonitoringJobs", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListModelDeploymentMonitoringJobsResponse", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "ListModelDeploymentMonitoringJobs", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.ListModelDeploymentMonitoringJobs", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_UpdateModelDeploymentMonitoringJob_async", + "title": "DatasetService updateModelDeploymentMonitoringJob Sample", + "origin": "API_DEFINITION", + "description": " Updates a ModelDeploymentMonitoringJob.", + "canonical": true, + "file": "job_service.update_model_deployment_monitoring_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 83, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.UpdateModelDeploymentMonitoringJob", + "async": true, + "parameters": [ + { + "name": "model_deployment_monitoring_job", + "type": ".google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "UpdateModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.UpdateModelDeploymentMonitoringJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_DeleteModelDeploymentMonitoringJob_async", + "title": "DatasetService deleteModelDeploymentMonitoringJob Sample", + "origin": "API_DEFINITION", + "description": " Deletes a ModelDeploymentMonitoringJob.", + "canonical": true, + "file": "job_service.delete_model_deployment_monitoring_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.DeleteModelDeploymentMonitoringJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "DeleteModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.DeleteModelDeploymentMonitoringJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_PauseModelDeploymentMonitoringJob_async", + "title": "DatasetService pauseModelDeploymentMonitoringJob Sample", + "origin": "API_DEFINITION", + "description": " Pauses a ModelDeploymentMonitoringJob. If the job is running, the server makes a best effort to cancel the job. Will mark [ModelDeploymentMonitoringJob.state][google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob.state] to 'PAUSED'.", + "canonical": true, + "file": "job_service.pause_model_deployment_monitoring_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "PauseModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.PauseModelDeploymentMonitoringJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "PauseModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.PauseModelDeploymentMonitoringJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_ResumeModelDeploymentMonitoringJob_async", + "title": "DatasetService resumeModelDeploymentMonitoringJob Sample", + "origin": "API_DEFINITION", + "description": " Resumes a paused ModelDeploymentMonitoringJob. It will start to run from next scheduled time. A deleted ModelDeploymentMonitoringJob can't be resumed.", + "canonical": true, + "file": "job_service.resume_model_deployment_monitoring_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ResumeModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.ResumeModelDeploymentMonitoringJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "ResumeModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.ResumeModelDeploymentMonitoringJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MatchService_FindNeighbors_async", + "title": "DatasetService findNeighbors Sample", + "origin": "API_DEFINITION", + "description": " Finds the nearest neighbors of each vector within the request.", + "canonical": true, + "file": "match_service.find_neighbors.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "FindNeighbors", + "fullName": "google.cloud.aiplatform.v1beta1.MatchService.FindNeighbors", + "async": true, + "parameters": [ + { + "name": "index_endpoint", + "type": "TYPE_STRING" + }, + { + "name": "deployed_index_id", + "type": "TYPE_STRING" + }, + { + "name": "queries", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "return_full_datapoint", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.FindNeighborsResponse", + "client": { + "shortName": "MatchServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MatchServiceClient" + }, + "method": { + "shortName": "FindNeighbors", + "fullName": "google.cloud.aiplatform.v1beta1.MatchService.FindNeighbors", + "service": { + "shortName": "MatchService", + "fullName": "google.cloud.aiplatform.v1beta1.MatchService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MatchService_ReadIndexDatapoints_async", + "title": "DatasetService readIndexDatapoints Sample", + "origin": "API_DEFINITION", + "description": " Reads the datapoints/vectors of the given IDs. A maximum of 1000 datapoints can be retrieved in a batch.", + "canonical": true, + "file": "match_service.read_index_datapoints.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ReadIndexDatapoints", + "fullName": "google.cloud.aiplatform.v1beta1.MatchService.ReadIndexDatapoints", + "async": true, + "parameters": [ + { + "name": "index_endpoint", + "type": "TYPE_STRING" + }, + { + "name": "deployed_index_id", + "type": "TYPE_STRING" + }, + { + "name": "ids", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ReadIndexDatapointsResponse", + "client": { + "shortName": "MatchServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MatchServiceClient" + }, + "method": { + "shortName": "ReadIndexDatapoints", + "fullName": "google.cloud.aiplatform.v1beta1.MatchService.ReadIndexDatapoints", + "service": { + "shortName": "MatchService", + "fullName": "google.cloud.aiplatform.v1beta1.MatchService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_CreateMetadataStore_async", + "title": "DatasetService createMetadataStore Sample", + "origin": "API_DEFINITION", + "description": " Initializes a MetadataStore, including allocation of resources.", + "canonical": true, + "file": "metadata_service.create_metadata_store.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateMetadataStore", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.CreateMetadataStore", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "metadata_store", + "type": ".google.cloud.aiplatform.v1beta1.MetadataStore" + }, + { + "name": "metadata_store_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "CreateMetadataStore", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.CreateMetadataStore", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_GetMetadataStore_async", + "title": "DatasetService getMetadataStore Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a specific MetadataStore.", + "canonical": true, + "file": "metadata_service.get_metadata_store.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetMetadataStore", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.GetMetadataStore", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.MetadataStore", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "GetMetadataStore", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.GetMetadataStore", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_ListMetadataStores_async", + "title": "DatasetService listMetadataStores Sample", + "origin": "API_DEFINITION", + "description": " Lists MetadataStores for a Location.", + "canonical": true, + "file": "metadata_service.list_metadata_stores.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListMetadataStores", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataStores", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListMetadataStoresResponse", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "ListMetadataStores", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataStores", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_DeleteMetadataStore_async", + "title": "DatasetService deleteMetadataStore Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts).", + "canonical": true, + "file": "metadata_service.delete_metadata_store.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteMetadataStore", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.DeleteMetadataStore", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "DeleteMetadataStore", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.DeleteMetadataStore", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_CreateArtifact_async", + "title": "DatasetService createArtifact Sample", + "origin": "API_DEFINITION", + "description": " Creates an Artifact associated with a MetadataStore.", + "canonical": true, + "file": "metadata_service.create_artifact.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateArtifact", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.CreateArtifact", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "artifact", + "type": ".google.cloud.aiplatform.v1beta1.Artifact" + }, + { + "name": "artifact_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Artifact", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "CreateArtifact", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.CreateArtifact", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_GetArtifact_async", + "title": "DatasetService getArtifact Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a specific Artifact.", + "canonical": true, + "file": "metadata_service.get_artifact.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetArtifact", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.GetArtifact", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Artifact", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "GetArtifact", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.GetArtifact", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_ListArtifacts_async", + "title": "DatasetService listArtifacts Sample", + "origin": "API_DEFINITION", + "description": " Lists Artifacts in the MetadataStore.", + "canonical": true, + "file": "metadata_service.list_artifacts.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 111, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListArtifacts", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.ListArtifacts", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListArtifactsResponse", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "ListArtifacts", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.ListArtifacts", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_UpdateArtifact_async", + "title": "DatasetService updateArtifact Sample", + "origin": "API_DEFINITION", + "description": " Updates a stored Artifact.", + "canonical": true, + "file": "metadata_service.update_artifact.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateArtifact", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.UpdateArtifact", + "async": true, + "parameters": [ + { + "name": "artifact", + "type": ".google.cloud.aiplatform.v1beta1.Artifact" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "allow_missing", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Artifact", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "UpdateArtifact", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.UpdateArtifact", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_DeleteArtifact_async", + "title": "DatasetService deleteArtifact Sample", + "origin": "API_DEFINITION", + "description": " Deletes an Artifact.", + "canonical": true, + "file": "metadata_service.delete_artifact.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteArtifact", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.DeleteArtifact", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "etag", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "DeleteArtifact", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.DeleteArtifact", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_PurgeArtifacts_async", + "title": "DatasetService purgeArtifacts Sample", + "origin": "API_DEFINITION", + "description": " Purges Artifacts.", + "canonical": true, + "file": "metadata_service.purge_artifacts.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "PurgeArtifacts", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.PurgeArtifacts", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "PurgeArtifacts", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.PurgeArtifacts", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_CreateContext_async", + "title": "DatasetService createContext Sample", + "origin": "API_DEFINITION", + "description": " Creates a Context associated with a MetadataStore.", + "canonical": true, + "file": "metadata_service.create_context.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 70, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateContext", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.CreateContext", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "context", + "type": ".google.cloud.aiplatform.v1beta1.Context" + }, + { + "name": "context_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Context", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "CreateContext", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.CreateContext", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_GetContext_async", + "title": "DatasetService getContext Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a specific Context.", + "canonical": true, + "file": "metadata_service.get_context.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetContext", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.GetContext", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Context", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "GetContext", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.GetContext", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_ListContexts_async", + "title": "DatasetService listContexts Sample", + "origin": "API_DEFINITION", + "description": " Lists Contexts on the MetadataStore.", + "canonical": true, + "file": "metadata_service.list_contexts.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 114, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListContexts", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.ListContexts", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListContextsResponse", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "ListContexts", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.ListContexts", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_UpdateContext_async", + "title": "DatasetService updateContext Sample", + "origin": "API_DEFINITION", + "description": " Updates a stored Context.", + "canonical": true, + "file": "metadata_service.update_context.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateContext", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.UpdateContext", + "async": true, + "parameters": [ + { + "name": "context", + "type": ".google.cloud.aiplatform.v1beta1.Context" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "allow_missing", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Context", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "UpdateContext", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.UpdateContext", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_DeleteContext_async", + "title": "DatasetService deleteContext Sample", + "origin": "API_DEFINITION", + "description": " Deletes a stored Context.", + "canonical": true, + "file": "metadata_service.delete_context.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteContext", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.DeleteContext", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" + }, + { + "name": "etag", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "DeleteContext", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.DeleteContext", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_PurgeContexts_async", + "title": "DatasetService purgeContexts Sample", + "origin": "API_DEFINITION", + "description": " Purges Contexts.", + "canonical": true, + "file": "metadata_service.purge_contexts.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "PurgeContexts", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.PurgeContexts", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "PurgeContexts", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.PurgeContexts", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_AddContextArtifactsAndExecutions_async", + "title": "DatasetService addContextArtifactsAndExecutions Sample", + "origin": "API_DEFINITION", + "description": " Adds a set of Artifacts and Executions to a Context. If any of the Artifacts or Executions have already been added to a Context, they are simply skipped.", + "canonical": true, + "file": "metadata_service.add_context_artifacts_and_executions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AddContextArtifactsAndExecutions", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.AddContextArtifactsAndExecutions", + "async": true, + "parameters": [ + { + "name": "context", + "type": "TYPE_STRING" + }, + { + "name": "artifacts", + "type": "TYPE_STRING[]" + }, + { + "name": "executions", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.AddContextArtifactsAndExecutionsResponse", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "AddContextArtifactsAndExecutions", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.AddContextArtifactsAndExecutions", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_AddContextChildren_async", + "title": "DatasetService addContextChildren Sample", + "origin": "API_DEFINITION", + "description": " Adds a set of Contexts as children to a parent Context. If any of the child Contexts have already been added to the parent Context, they are simply skipped. If this call would create a cycle or cause any Context to have more than 10 parents, the request will fail with an INVALID_ARGUMENT error.", + "canonical": true, + "file": "metadata_service.add_context_children.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AddContextChildren", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.AddContextChildren", + "async": true, + "parameters": [ + { + "name": "context", + "type": "TYPE_STRING" + }, + { + "name": "child_contexts", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.AddContextChildrenResponse", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "AddContextChildren", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.AddContextChildren", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_RemoveContextChildren_async", + "title": "DatasetService removeContextChildren Sample", + "origin": "API_DEFINITION", + "description": " Remove a set of children contexts from a parent Context. If any of the child Contexts were NOT added to the parent Context, they are simply skipped.", + "canonical": true, + "file": "metadata_service.remove_context_children.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RemoveContextChildren", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.RemoveContextChildren", + "async": true, + "parameters": [ + { + "name": "context", + "type": "TYPE_STRING" + }, + { + "name": "child_contexts", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.RemoveContextChildrenResponse", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "RemoveContextChildren", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.RemoveContextChildren", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_QueryContextLineageSubgraph_async", + "title": "DatasetService queryContextLineageSubgraph Sample", + "origin": "API_DEFINITION", + "description": " Retrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph.", + "canonical": true, + "file": "metadata_service.query_context_lineage_subgraph.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "QueryContextLineageSubgraph", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.QueryContextLineageSubgraph", + "async": true, + "parameters": [ + { + "name": "context", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.LineageSubgraph", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "QueryContextLineageSubgraph", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.QueryContextLineageSubgraph", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_CreateExecution_async", + "title": "DatasetService createExecution Sample", + "origin": "API_DEFINITION", + "description": " Creates an Execution associated with a MetadataStore.", + "canonical": true, + "file": "metadata_service.create_execution.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateExecution", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.CreateExecution", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "execution", + "type": ".google.cloud.aiplatform.v1beta1.Execution" + }, + { + "name": "execution_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Execution", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "CreateExecution", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.CreateExecution", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_GetExecution_async", + "title": "DatasetService getExecution Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a specific Execution.", + "canonical": true, + "file": "metadata_service.get_execution.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetExecution", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.GetExecution", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Execution", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "GetExecution", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.GetExecution", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_ListExecutions_async", + "title": "DatasetService listExecutions Sample", + "origin": "API_DEFINITION", + "description": " Lists Executions in the MetadataStore.", + "canonical": true, + "file": "metadata_service.list_executions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 111, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListExecutions", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.ListExecutions", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListExecutionsResponse", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "ListExecutions", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.ListExecutions", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_UpdateExecution_async", + "title": "DatasetService updateExecution Sample", + "origin": "API_DEFINITION", + "description": " Updates a stored Execution.", + "canonical": true, + "file": "metadata_service.update_execution.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateExecution", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.UpdateExecution", + "async": true, + "parameters": [ + { + "name": "execution", + "type": ".google.cloud.aiplatform.v1beta1.Execution" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "allow_missing", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Execution", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "UpdateExecution", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.UpdateExecution", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_DeleteExecution_async", + "title": "DatasetService deleteExecution Sample", + "origin": "API_DEFINITION", + "description": " Deletes an Execution.", + "canonical": true, + "file": "metadata_service.delete_execution.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteExecution", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.DeleteExecution", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "etag", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "DeleteExecution", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.DeleteExecution", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_PurgeExecutions_async", + "title": "DatasetService purgeExecutions Sample", + "origin": "API_DEFINITION", + "description": " Purges Executions.", + "canonical": true, + "file": "metadata_service.purge_executions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "PurgeExecutions", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.PurgeExecutions", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "PurgeExecutions", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.PurgeExecutions", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_AddExecutionEvents_async", + "title": "DatasetService addExecutionEvents Sample", + "origin": "API_DEFINITION", + "description": " Adds Events to the specified Execution. An Event indicates whether an Artifact was used as an input or output for an Execution. If an Event already exists between the Execution and the Artifact, the Event is skipped.", + "canonical": true, + "file": "metadata_service.add_execution_events.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AddExecutionEvents", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.AddExecutionEvents", + "async": true, + "parameters": [ + { + "name": "execution", + "type": "TYPE_STRING" + }, + { + "name": "events", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.AddExecutionEventsResponse", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "AddExecutionEvents", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.AddExecutionEvents", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_QueryExecutionInputsAndOutputs_async", + "title": "DatasetService queryExecutionInputsAndOutputs Sample", + "origin": "API_DEFINITION", + "description": " Obtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events.", + "canonical": true, + "file": "metadata_service.query_execution_inputs_and_outputs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "QueryExecutionInputsAndOutputs", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.QueryExecutionInputsAndOutputs", + "async": true, + "parameters": [ + { + "name": "execution", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.LineageSubgraph", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "QueryExecutionInputsAndOutputs", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.QueryExecutionInputsAndOutputs", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_CreateMetadataSchema_async", + "title": "DatasetService createMetadataSchema Sample", + "origin": "API_DEFINITION", + "description": " Creates a MetadataSchema.", + "canonical": true, + "file": "metadata_service.create_metadata_schema.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateMetadataSchema", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.CreateMetadataSchema", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "metadata_schema", + "type": ".google.cloud.aiplatform.v1beta1.MetadataSchema" + }, + { + "name": "metadata_schema_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.MetadataSchema", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "CreateMetadataSchema", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.CreateMetadataSchema", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_GetMetadataSchema_async", + "title": "DatasetService getMetadataSchema Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a specific MetadataSchema.", + "canonical": true, + "file": "metadata_service.get_metadata_schema.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetMetadataSchema", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.GetMetadataSchema", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.MetadataSchema", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "GetMetadataSchema", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.GetMetadataSchema", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_ListMetadataSchemas_async", + "title": "DatasetService listMetadataSchemas Sample", + "origin": "API_DEFINITION", + "description": " Lists MetadataSchemas.", + "canonical": true, + "file": "metadata_service.list_metadata_schemas.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 76, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListMetadataSchemas", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataSchemas", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListMetadataSchemasResponse", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "ListMetadataSchemas", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataSchemas", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_QueryArtifactLineageSubgraph_async", + "title": "DatasetService queryArtifactLineageSubgraph Sample", + "origin": "API_DEFINITION", + "description": " Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph.", + "canonical": true, + "file": "metadata_service.query_artifact_lineage_subgraph.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 91, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "QueryArtifactLineageSubgraph", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.QueryArtifactLineageSubgraph", + "async": true, + "parameters": [ + { + "name": "artifact", + "type": "TYPE_STRING" + }, + { + "name": "max_hops", + "type": "TYPE_INT32" + }, + { + "name": "filter", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.LineageSubgraph", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "QueryArtifactLineageSubgraph", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.QueryArtifactLineageSubgraph", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MigrationService_SearchMigratableResources_async", + "title": "DatasetService searchMigratableResources Sample", + "origin": "API_DEFINITION", + "description": " Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com that can be migrated to Vertex AI's given location.", + "canonical": true, + "file": "migration_service.search_migratable_resources.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 82, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SearchMigratableResources", + "fullName": "google.cloud.aiplatform.v1beta1.MigrationService.SearchMigratableResources", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.SearchMigratableResourcesResponse", + "client": { + "shortName": "MigrationServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MigrationServiceClient" + }, + "method": { + "shortName": "SearchMigratableResources", + "fullName": "google.cloud.aiplatform.v1beta1.MigrationService.SearchMigratableResources", + "service": { + "shortName": "MigrationService", + "fullName": "google.cloud.aiplatform.v1beta1.MigrationService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MigrationService_BatchMigrateResources_async", + "title": "DatasetService batchMigrateResources Sample", + "origin": "API_DEFINITION", + "description": " Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI.", + "canonical": true, + "file": "migration_service.batch_migrate_resources.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchMigrateResources", + "fullName": "google.cloud.aiplatform.v1beta1.MigrationService.BatchMigrateResources", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "migrate_resource_requests", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "MigrationServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MigrationServiceClient" + }, + "method": { + "shortName": "BatchMigrateResources", + "fullName": "google.cloud.aiplatform.v1beta1.MigrationService.BatchMigrateResources", + "service": { + "shortName": "MigrationService", + "fullName": "google.cloud.aiplatform.v1beta1.MigrationService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_ModelGardenService_GetPublisherModel_async", + "title": "DatasetService getPublisherModel Sample", + "origin": "API_DEFINITION", + "description": " Gets a Model Garden publisher model.", + "canonical": true, + "file": "model_garden_service.get_publisher_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 64, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetPublisherModel", + "fullName": "google.cloud.aiplatform.v1beta1.ModelGardenService.GetPublisherModel", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "language_code", + "type": "TYPE_STRING" + }, + { + "name": "view", + "type": ".google.cloud.aiplatform.v1beta1.PublisherModelView" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.PublisherModel", + "client": { + "shortName": "ModelGardenServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.ModelGardenServiceClient" + }, + "method": { + "shortName": "GetPublisherModel", + "fullName": "google.cloud.aiplatform.v1beta1.ModelGardenService.GetPublisherModel", + "service": { + "shortName": "ModelGardenService", + "fullName": "google.cloud.aiplatform.v1beta1.ModelGardenService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_ModelService_UploadModel_async", + "title": "DatasetService uploadModel Sample", + "origin": "API_DEFINITION", + "description": " Uploads a Model artifact into Vertex AI.", + "canonical": true, + "file": "model_service.upload_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 82, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UploadModel", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.UploadModel", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "parent_model", + "type": "TYPE_STRING" + }, + { + "name": "model_id", + "type": "TYPE_STRING" + }, + { + "name": "model", + "type": ".google.cloud.aiplatform.v1beta1.Model" + }, + { + "name": "service_account", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.ModelServiceClient" + }, + "method": { + "shortName": "UploadModel", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.UploadModel", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_ModelService_GetModel_async", + "title": "DatasetService getModel Sample", + "origin": "API_DEFINITION", + "description": " Gets a Model.", + "canonical": true, + "file": "model_service.get_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetModel", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.GetModel", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Model", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.ModelServiceClient" + }, + "method": { + "shortName": "GetModel", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.GetModel", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_ModelService_ListModels_async", + "title": "DatasetService listModels Sample", + "origin": "API_DEFINITION", + "description": " Lists Models in a Location.", + "canonical": true, + "file": "model_service.list_models.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 90, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListModels", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.ListModels", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListModelsResponse", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.ModelServiceClient" + }, + "method": { + "shortName": "ListModels", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.ListModels", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_ModelService_ListModelVersions_async", + "title": "DatasetService listModelVersions Sample", + "origin": "API_DEFINITION", + "description": " Lists versions of the specified model.", + "canonical": true, + "file": "model_service.list_model_versions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 92, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListModelVersions", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.ListModelVersions", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListModelVersionsResponse", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.ModelServiceClient" + }, + "method": { + "shortName": "ListModelVersions", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.ListModelVersions", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_ModelService_UpdateModel_async", + "title": "DatasetService updateModel Sample", + "origin": "API_DEFINITION", + "description": " Updates a Model.", + "canonical": true, + "file": "model_service.update_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 77, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateModel", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.UpdateModel", + "async": true, + "parameters": [ + { + "name": "model", + "type": ".google.cloud.aiplatform.v1beta1.Model" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Model", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.ModelServiceClient" + }, + "method": { + "shortName": "UpdateModel", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.UpdateModel", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_ModelService_UpdateExplanationDataset_async", + "title": "DatasetService updateExplanationDataset Sample", + "origin": "API_DEFINITION", + "description": " Incrementally update the dataset used for an examples model.", + "canonical": true, + "file": "model_service.update_explanation_dataset.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateExplanationDataset", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.UpdateExplanationDataset", + "async": true, + "parameters": [ + { + "name": "model", + "type": "TYPE_STRING" + }, + { + "name": "examples", + "type": ".google.cloud.aiplatform.v1beta1.Examples" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.ModelServiceClient" + }, + "method": { + "shortName": "UpdateExplanationDataset", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.UpdateExplanationDataset", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_ModelService_DeleteModel_async", + "title": "DatasetService deleteModel Sample", + "origin": "API_DEFINITION", + "description": " Deletes a Model. A model cannot be deleted if any [Endpoint][google.cloud.aiplatform.v1beta1.Endpoint] resource has a [DeployedModel][google.cloud.aiplatform.v1beta1.DeployedModel] based on the model in its [deployed_models][google.cloud.aiplatform.v1beta1.Endpoint.deployed_models] field.", + "canonical": true, + "file": "model_service.delete_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteModel", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.DeleteModel", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.ModelServiceClient" + }, + "method": { + "shortName": "DeleteModel", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.DeleteModel", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_ModelService_DeleteModelVersion_async", + "title": "DatasetService deleteModelVersion Sample", + "origin": "API_DEFINITION", + "description": " Deletes a Model version. Model version can only be deleted if there are no [DeployedModels][google.cloud.aiplatform.v1beta1.DeployedModel] created from it. Deleting the only version in the Model is not allowed. Use [DeleteModel][google.cloud.aiplatform.v1beta1.ModelService.DeleteModel] for deleting the Model instead.", + "canonical": true, + "file": "model_service.delete_model_version.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteModelVersion", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.DeleteModelVersion", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.ModelServiceClient" + }, + "method": { + "shortName": "DeleteModelVersion", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.DeleteModelVersion", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_ModelService_MergeVersionAliases_async", + "title": "DatasetService mergeVersionAliases Sample", + "origin": "API_DEFINITION", + "description": " Merges a set of aliases for a Model version.", + "canonical": true, + "file": "model_service.merge_version_aliases.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 70, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "MergeVersionAliases", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.MergeVersionAliases", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "version_aliases", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Model", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.ModelServiceClient" + }, + "method": { + "shortName": "MergeVersionAliases", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.MergeVersionAliases", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_ModelService_ExportModel_async", + "title": "DatasetService exportModel Sample", + "origin": "API_DEFINITION", + "description": " Exports a trained, exportable Model to a location specified by the user. A Model is considered to be exportable if it has at least one [supported export format][google.cloud.aiplatform.v1beta1.Model.supported_export_formats].", + "canonical": true, + "file": "model_service.export_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ExportModel", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.ExportModel", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "output_config", + "type": ".google.cloud.aiplatform.v1beta1.ExportModelRequest.OutputConfig" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.ModelServiceClient" + }, + "method": { + "shortName": "ExportModel", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.ExportModel", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_ModelService_CopyModel_async", + "title": "DatasetService copyModel Sample", + "origin": "API_DEFINITION", + "description": " Copies an already existing Vertex AI Model into the specified Location. The source Model must exist in the same Project. When copying custom Models, the users themselves are responsible for [Model.metadata][google.cloud.aiplatform.v1beta1.Model.metadata] content to be region-agnostic, as well as making sure that any resources (e.g. files) it depends on remain accessible.", + "canonical": true, + "file": "model_service.copy_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CopyModel", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.CopyModel", + "async": true, + "parameters": [ + { + "name": "model_id", + "type": "TYPE_STRING" + }, + { + "name": "parent_model", + "type": "TYPE_STRING" + }, + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "source_model", + "type": "TYPE_STRING" + }, + { + "name": "encryption_spec", + "type": ".google.cloud.aiplatform.v1beta1.EncryptionSpec" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.ModelServiceClient" + }, + "method": { + "shortName": "CopyModel", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.CopyModel", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_ModelService_ImportModelEvaluation_async", + "title": "DatasetService importModelEvaluation Sample", + "origin": "API_DEFINITION", + "description": " Imports an externally generated ModelEvaluation.", + "canonical": true, + "file": "model_service.import_model_evaluation.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ImportModelEvaluation", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.ImportModelEvaluation", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "model_evaluation", + "type": ".google.cloud.aiplatform.v1beta1.ModelEvaluation" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ModelEvaluation", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.ModelServiceClient" + }, + "method": { + "shortName": "ImportModelEvaluation", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.ImportModelEvaluation", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_ModelService_BatchImportModelEvaluationSlices_async", + "title": "DatasetService batchImportModelEvaluationSlices Sample", + "origin": "API_DEFINITION", + "description": " Imports a list of externally generated ModelEvaluationSlice.", + "canonical": true, + "file": "model_service.batch_import_model_evaluation_slices.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchImportModelEvaluationSlices", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.BatchImportModelEvaluationSlices", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "model_evaluation_slices", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.BatchImportModelEvaluationSlicesResponse", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.ModelServiceClient" + }, + "method": { + "shortName": "BatchImportModelEvaluationSlices", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.BatchImportModelEvaluationSlices", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_ModelService_BatchImportEvaluatedAnnotations_async", + "title": "DatasetService batchImportEvaluatedAnnotations Sample", + "origin": "API_DEFINITION", + "description": " Imports a list of externally generated EvaluatedAnnotations.", + "canonical": true, + "file": "model_service.batch_import_evaluated_annotations.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchImportEvaluatedAnnotations", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.BatchImportEvaluatedAnnotations", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "evaluated_annotations", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.BatchImportEvaluatedAnnotationsResponse", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.ModelServiceClient" + }, + "method": { + "shortName": "BatchImportEvaluatedAnnotations", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.BatchImportEvaluatedAnnotations", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_ModelService_GetModelEvaluation_async", + "title": "DatasetService getModelEvaluation Sample", + "origin": "API_DEFINITION", + "description": " Gets a ModelEvaluation.", + "canonical": true, + "file": "model_service.get_model_evaluation.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetModelEvaluation", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.GetModelEvaluation", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ModelEvaluation", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.ModelServiceClient" + }, + "method": { + "shortName": "GetModelEvaluation", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.GetModelEvaluation", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_ModelService_ListModelEvaluations_async", + "title": "DatasetService listModelEvaluations Sample", + "origin": "API_DEFINITION", + "description": " Lists ModelEvaluations in a Model.", + "canonical": true, + "file": "model_service.list_model_evaluations.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 77, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListModelEvaluations", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluations", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListModelEvaluationsResponse", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.ModelServiceClient" + }, + "method": { + "shortName": "ListModelEvaluations", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluations", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_ModelService_GetModelEvaluationSlice_async", + "title": "DatasetService getModelEvaluationSlice Sample", + "origin": "API_DEFINITION", + "description": " Gets a ModelEvaluationSlice.", + "canonical": true, + "file": "model_service.get_model_evaluation_slice.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetModelEvaluationSlice", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.GetModelEvaluationSlice", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ModelEvaluationSlice", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.ModelServiceClient" + }, + "method": { + "shortName": "GetModelEvaluationSlice", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.GetModelEvaluationSlice", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_ModelService_ListModelEvaluationSlices_async", + "title": "DatasetService listModelEvaluationSlices Sample", + "origin": "API_DEFINITION", + "description": " Lists ModelEvaluationSlices in a ModelEvaluation.", + "canonical": true, + "file": "model_service.list_model_evaluation_slices.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListModelEvaluationSlices", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluationSlices", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListModelEvaluationSlicesResponse", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.ModelServiceClient" + }, + "method": { + "shortName": "ListModelEvaluationSlices", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluationSlices", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_PersistentResourceService_CreatePersistentResource_async", + "title": "DatasetService createPersistentResource Sample", + "origin": "API_DEFINITION", + "description": " Uploads a Model artifact into Vertex AI.", + "canonical": true, + "file": "persistent_resource_service.create_persistent_resource.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreatePersistentResource", + "fullName": "google.cloud.aiplatform.v1beta1.PersistentResourceService.CreatePersistentResource", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "persistent_resource", + "type": ".google.cloud.aiplatform.v1beta1.PersistentResource" + }, + { + "name": "persistent_resource_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "PersistentResourceServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.PersistentResourceServiceClient" + }, + "method": { + "shortName": "CreatePersistentResource", + "fullName": "google.cloud.aiplatform.v1beta1.PersistentResourceService.CreatePersistentResource", + "service": { + "shortName": "PersistentResourceService", + "fullName": "google.cloud.aiplatform.v1beta1.PersistentResourceService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_PersistentResourceService_GetPersistentResource_async", + "title": "DatasetService getPersistentResource Sample", + "origin": "API_DEFINITION", + "description": " Gets a PersistentResource.", + "canonical": true, + "file": "persistent_resource_service.get_persistent_resource.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetPersistentResource", + "fullName": "google.cloud.aiplatform.v1beta1.PersistentResourceService.GetPersistentResource", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.PersistentResource", + "client": { + "shortName": "PersistentResourceServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.PersistentResourceServiceClient" + }, + "method": { + "shortName": "GetPersistentResource", + "fullName": "google.cloud.aiplatform.v1beta1.PersistentResourceService.GetPersistentResource", + "service": { + "shortName": "PersistentResourceService", + "fullName": "google.cloud.aiplatform.v1beta1.PersistentResourceService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_PersistentResourceService_ListPersistentResources_async", + "title": "DatasetService listPersistentResources Sample", + "origin": "API_DEFINITION", + "description": " Lists PersistentResources in a Location.", + "canonical": true, + "file": "persistent_resource_service.list_persistent_resources.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListPersistentResources", + "fullName": "google.cloud.aiplatform.v1beta1.PersistentResourceService.ListPersistentResources", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListPersistentResourcesResponse", + "client": { + "shortName": "PersistentResourceServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.PersistentResourceServiceClient" + }, + "method": { + "shortName": "ListPersistentResources", + "fullName": "google.cloud.aiplatform.v1beta1.PersistentResourceService.ListPersistentResources", + "service": { + "shortName": "PersistentResourceService", + "fullName": "google.cloud.aiplatform.v1beta1.PersistentResourceService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_PersistentResourceService_DeletePersistentResource_async", + "title": "DatasetService deletePersistentResource Sample", + "origin": "API_DEFINITION", + "description": " Deletes a PersistentResource.", + "canonical": true, + "file": "persistent_resource_service.delete_persistent_resource.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeletePersistentResource", + "fullName": "google.cloud.aiplatform.v1beta1.PersistentResourceService.DeletePersistentResource", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "PersistentResourceServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.PersistentResourceServiceClient" + }, + "method": { + "shortName": "DeletePersistentResource", + "fullName": "google.cloud.aiplatform.v1beta1.PersistentResourceService.DeletePersistentResource", + "service": { + "shortName": "PersistentResourceService", + "fullName": "google.cloud.aiplatform.v1beta1.PersistentResourceService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_PipelineService_CreateTrainingPipeline_async", + "title": "DatasetService createTrainingPipeline Sample", + "origin": "API_DEFINITION", + "description": " Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.", + "canonical": true, + "file": "pipeline_service.create_training_pipeline.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateTrainingPipeline", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService.CreateTrainingPipeline", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "training_pipeline", + "type": ".google.cloud.aiplatform.v1beta1.TrainingPipeline" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.TrainingPipeline", + "client": { + "shortName": "PipelineServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineServiceClient" + }, + "method": { + "shortName": "CreateTrainingPipeline", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService.CreateTrainingPipeline", + "service": { + "shortName": "PipelineService", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_PipelineService_GetTrainingPipeline_async", + "title": "DatasetService getTrainingPipeline Sample", + "origin": "API_DEFINITION", + "description": " Gets a TrainingPipeline.", + "canonical": true, + "file": "pipeline_service.get_training_pipeline.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetTrainingPipeline", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService.GetTrainingPipeline", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.TrainingPipeline", + "client": { + "shortName": "PipelineServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineServiceClient" + }, + "method": { + "shortName": "GetTrainingPipeline", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService.GetTrainingPipeline", + "service": { + "shortName": "PipelineService", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_PipelineService_ListTrainingPipelines_async", + "title": "DatasetService listTrainingPipelines Sample", + "origin": "API_DEFINITION", + "description": " Lists TrainingPipelines in a Location.", + "canonical": true, + "file": "pipeline_service.list_training_pipelines.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 92, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListTrainingPipelines", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService.ListTrainingPipelines", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListTrainingPipelinesResponse", + "client": { + "shortName": "PipelineServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineServiceClient" + }, + "method": { + "shortName": "ListTrainingPipelines", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService.ListTrainingPipelines", + "service": { + "shortName": "PipelineService", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_PipelineService_DeleteTrainingPipeline_async", + "title": "DatasetService deleteTrainingPipeline Sample", + "origin": "API_DEFINITION", + "description": " Deletes a TrainingPipeline.", + "canonical": true, + "file": "pipeline_service.delete_training_pipeline.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteTrainingPipeline", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService.DeleteTrainingPipeline", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "PipelineServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineServiceClient" + }, + "method": { + "shortName": "DeleteTrainingPipeline", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService.DeleteTrainingPipeline", + "service": { + "shortName": "PipelineService", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_PipelineService_CancelTrainingPipeline_async", + "title": "DatasetService cancelTrainingPipeline Sample", + "origin": "API_DEFINITION", + "description": " Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use [PipelineService.GetTrainingPipeline][google.cloud.aiplatform.v1beta1.PipelineService.GetTrainingPipeline] or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead it becomes a pipeline with a [TrainingPipeline.error][google.cloud.aiplatform.v1beta1.TrainingPipeline.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [TrainingPipeline.state][google.cloud.aiplatform.v1beta1.TrainingPipeline.state] is set to `CANCELLED`.", + "canonical": true, + "file": "pipeline_service.cancel_training_pipeline.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CancelTrainingPipeline", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService.CancelTrainingPipeline", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "PipelineServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineServiceClient" + }, + "method": { + "shortName": "CancelTrainingPipeline", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService.CancelTrainingPipeline", + "service": { + "shortName": "PipelineService", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_PipelineService_CreatePipelineJob_async", + "title": "DatasetService createPipelineJob Sample", + "origin": "API_DEFINITION", + "description": " Creates a PipelineJob. A PipelineJob will run immediately when created.", + "canonical": true, + "file": "pipeline_service.create_pipeline_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreatePipelineJob", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService.CreatePipelineJob", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "pipeline_job", + "type": ".google.cloud.aiplatform.v1beta1.PipelineJob" + }, + { + "name": "pipeline_job_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.PipelineJob", + "client": { + "shortName": "PipelineServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineServiceClient" + }, + "method": { + "shortName": "CreatePipelineJob", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService.CreatePipelineJob", + "service": { + "shortName": "PipelineService", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_PipelineService_GetPipelineJob_async", + "title": "DatasetService getPipelineJob Sample", + "origin": "API_DEFINITION", + "description": " Gets a PipelineJob.", + "canonical": true, + "file": "pipeline_service.get_pipeline_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetPipelineJob", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService.GetPipelineJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.PipelineJob", + "client": { + "shortName": "PipelineServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineServiceClient" + }, + "method": { + "shortName": "GetPipelineJob", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService.GetPipelineJob", + "service": { + "shortName": "PipelineService", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_PipelineService_ListPipelineJobs_async", + "title": "DatasetService listPipelineJobs Sample", + "origin": "API_DEFINITION", + "description": " Lists PipelineJobs in a Location.", + "canonical": true, + "file": "pipeline_service.list_pipeline_jobs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 120, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListPipelineJobs", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService.ListPipelineJobs", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListPipelineJobsResponse", + "client": { + "shortName": "PipelineServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineServiceClient" + }, + "method": { + "shortName": "ListPipelineJobs", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService.ListPipelineJobs", + "service": { + "shortName": "PipelineService", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_PipelineService_DeletePipelineJob_async", + "title": "DatasetService deletePipelineJob Sample", + "origin": "API_DEFINITION", + "description": " Deletes a PipelineJob.", + "canonical": true, + "file": "pipeline_service.delete_pipeline_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeletePipelineJob", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService.DeletePipelineJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "PipelineServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineServiceClient" + }, + "method": { + "shortName": "DeletePipelineJob", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService.DeletePipelineJob", + "service": { + "shortName": "PipelineService", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_PipelineService_CancelPipelineJob_async", + "title": "DatasetService cancelPipelineJob Sample", + "origin": "API_DEFINITION", + "description": " Cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use [PipelineService.GetPipelineJob][google.cloud.aiplatform.v1beta1.PipelineService.GetPipelineJob] or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the PipelineJob is not deleted; instead it becomes a pipeline with a [PipelineJob.error][google.cloud.aiplatform.v1beta1.PipelineJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [PipelineJob.state][google.cloud.aiplatform.v1beta1.PipelineJob.state] is set to `CANCELLED`.", + "canonical": true, + "file": "pipeline_service.cancel_pipeline_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CancelPipelineJob", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService.CancelPipelineJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "PipelineServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineServiceClient" + }, + "method": { + "shortName": "CancelPipelineJob", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService.CancelPipelineJob", + "service": { + "shortName": "PipelineService", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_PredictionService_Predict_async", + "title": "DatasetService predict Sample", + "origin": "API_DEFINITION", + "description": " Perform an online prediction.", + "canonical": true, + "file": "prediction_service.predict.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 77, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Predict", + "fullName": "google.cloud.aiplatform.v1beta1.PredictionService.Predict", + "async": true, + "parameters": [ + { + "name": "endpoint", + "type": "TYPE_STRING" + }, + { + "name": "instances", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "parameters", + "type": ".google.protobuf.Value" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.PredictResponse", + "client": { + "shortName": "PredictionServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.PredictionServiceClient" + }, + "method": { + "shortName": "Predict", + "fullName": "google.cloud.aiplatform.v1beta1.PredictionService.Predict", + "service": { + "shortName": "PredictionService", + "fullName": "google.cloud.aiplatform.v1beta1.PredictionService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_PredictionService_RawPredict_async", + "title": "DatasetService rawPredict Sample", + "origin": "API_DEFINITION", + "description": " Perform an online prediction with an arbitrary HTTP payload. The response includes the following HTTP headers: * `X-Vertex-AI-Endpoint-Id`: ID of the [Endpoint][google.cloud.aiplatform.v1beta1.Endpoint] that served this prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's [DeployedModel][google.cloud.aiplatform.v1beta1.DeployedModel] that served this prediction.", + "canonical": true, + "file": "prediction_service.raw_predict.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RawPredict", + "fullName": "google.cloud.aiplatform.v1beta1.PredictionService.RawPredict", + "async": true, + "parameters": [ + { + "name": "endpoint", + "type": "TYPE_STRING" + }, + { + "name": "http_body", + "type": ".google.api.HttpBody" + } + ], + "resultType": ".google.api.HttpBody", + "client": { + "shortName": "PredictionServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.PredictionServiceClient" + }, + "method": { + "shortName": "RawPredict", + "fullName": "google.cloud.aiplatform.v1beta1.PredictionService.RawPredict", + "service": { + "shortName": "PredictionService", + "fullName": "google.cloud.aiplatform.v1beta1.PredictionService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_PredictionService_ServerStreamingPredict_async", + "title": "DatasetService serverStreamingPredict Sample", + "origin": "API_DEFINITION", + "description": " Perform a server-side streaming online prediction request for Vertex LLM streaming.", + "canonical": true, + "file": "prediction_service.server_streaming_predict.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ServerStreamingPredict", + "fullName": "google.cloud.aiplatform.v1beta1.PredictionService.ServerStreamingPredict", + "async": true, + "parameters": [ + { + "name": "endpoint", + "type": "TYPE_STRING" + }, + { + "name": "inputs", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "parameters", + "type": ".google.cloud.aiplatform.v1beta1.Tensor" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.StreamingPredictResponse", + "client": { + "shortName": "PredictionServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.PredictionServiceClient" + }, + "method": { + "shortName": "ServerStreamingPredict", + "fullName": "google.cloud.aiplatform.v1beta1.PredictionService.ServerStreamingPredict", + "service": { + "shortName": "PredictionService", + "fullName": "google.cloud.aiplatform.v1beta1.PredictionService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_PredictionService_Explain_async", + "title": "DatasetService explain Sample", + "origin": "API_DEFINITION", + "description": " Perform an online explanation. If [deployed_model_id][google.cloud.aiplatform.v1beta1.ExplainRequest.deployed_model_id] is specified, the corresponding DeployModel must have [explanation_spec][google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec] populated. If [deployed_model_id][google.cloud.aiplatform.v1beta1.ExplainRequest.deployed_model_id] is not specified, all DeployedModels must have [explanation_spec][google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec] populated.", + "canonical": true, + "file": "prediction_service.explain.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 94, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Explain", + "fullName": "google.cloud.aiplatform.v1beta1.PredictionService.Explain", + "async": true, + "parameters": [ + { + "name": "endpoint", + "type": "TYPE_STRING" + }, + { + "name": "instances", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "parameters", + "type": ".google.protobuf.Value" + }, + { + "name": "explanation_spec_override", + "type": ".google.cloud.aiplatform.v1beta1.ExplanationSpecOverride" + }, + { + "name": "deployed_model_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ExplainResponse", + "client": { + "shortName": "PredictionServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.PredictionServiceClient" + }, + "method": { + "shortName": "Explain", + "fullName": "google.cloud.aiplatform.v1beta1.PredictionService.Explain", + "service": { + "shortName": "PredictionService", + "fullName": "google.cloud.aiplatform.v1beta1.PredictionService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_ScheduleService_CreateSchedule_async", + "title": "DatasetService createSchedule Sample", + "origin": "API_DEFINITION", + "description": " Creates a Schedule.", + "canonical": true, + "file": "schedule_service.create_schedule.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateSchedule", + "fullName": "google.cloud.aiplatform.v1beta1.ScheduleService.CreateSchedule", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "schedule", + "type": ".google.cloud.aiplatform.v1beta1.Schedule" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Schedule", + "client": { + "shortName": "ScheduleServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.ScheduleServiceClient" + }, + "method": { + "shortName": "CreateSchedule", + "fullName": "google.cloud.aiplatform.v1beta1.ScheduleService.CreateSchedule", + "service": { + "shortName": "ScheduleService", + "fullName": "google.cloud.aiplatform.v1beta1.ScheduleService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_ScheduleService_DeleteSchedule_async", + "title": "DatasetService deleteSchedule Sample", + "origin": "API_DEFINITION", + "description": " Deletes a Schedule.", + "canonical": true, + "file": "schedule_service.delete_schedule.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteSchedule", + "fullName": "google.cloud.aiplatform.v1beta1.ScheduleService.DeleteSchedule", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ScheduleServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.ScheduleServiceClient" + }, + "method": { + "shortName": "DeleteSchedule", + "fullName": "google.cloud.aiplatform.v1beta1.ScheduleService.DeleteSchedule", + "service": { + "shortName": "ScheduleService", + "fullName": "google.cloud.aiplatform.v1beta1.ScheduleService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_ScheduleService_GetSchedule_async", + "title": "DatasetService getSchedule Sample", + "origin": "API_DEFINITION", + "description": " Gets a Schedule.", + "canonical": true, + "file": "schedule_service.get_schedule.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetSchedule", + "fullName": "google.cloud.aiplatform.v1beta1.ScheduleService.GetSchedule", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Schedule", + "client": { + "shortName": "ScheduleServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.ScheduleServiceClient" + }, + "method": { + "shortName": "GetSchedule", + "fullName": "google.cloud.aiplatform.v1beta1.ScheduleService.GetSchedule", + "service": { + "shortName": "ScheduleService", + "fullName": "google.cloud.aiplatform.v1beta1.ScheduleService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_ScheduleService_ListSchedules_async", + "title": "DatasetService listSchedules Sample", + "origin": "API_DEFINITION", + "description": " Lists Schedules in a Location.", + "canonical": true, + "file": "schedule_service.list_schedules.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 114, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListSchedules", + "fullName": "google.cloud.aiplatform.v1beta1.ScheduleService.ListSchedules", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListSchedulesResponse", + "client": { + "shortName": "ScheduleServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.ScheduleServiceClient" + }, + "method": { + "shortName": "ListSchedules", + "fullName": "google.cloud.aiplatform.v1beta1.ScheduleService.ListSchedules", + "service": { + "shortName": "ScheduleService", + "fullName": "google.cloud.aiplatform.v1beta1.ScheduleService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_ScheduleService_PauseSchedule_async", + "title": "DatasetService pauseSchedule Sample", + "origin": "API_DEFINITION", + "description": " Pauses a Schedule. Will mark [Schedule.state][google.cloud.aiplatform.v1beta1.Schedule.state] to 'PAUSED'. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled.", + "canonical": true, + "file": "schedule_service.pause_schedule.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "PauseSchedule", + "fullName": "google.cloud.aiplatform.v1beta1.ScheduleService.PauseSchedule", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "ScheduleServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.ScheduleServiceClient" + }, + "method": { + "shortName": "PauseSchedule", + "fullName": "google.cloud.aiplatform.v1beta1.ScheduleService.PauseSchedule", + "service": { + "shortName": "ScheduleService", + "fullName": "google.cloud.aiplatform.v1beta1.ScheduleService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_ScheduleService_ResumeSchedule_async", + "title": "DatasetService resumeSchedule Sample", + "origin": "API_DEFINITION", + "description": " Resumes a paused Schedule to start scheduling new runs. Will mark [Schedule.state][google.cloud.aiplatform.v1beta1.Schedule.state] to 'ACTIVE'. Only paused Schedule can be resumed. When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If [Schedule.catchUp][] is set up true, all missed runs will be scheduled for backfill first.", + "canonical": true, + "file": "schedule_service.resume_schedule.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ResumeSchedule", + "fullName": "google.cloud.aiplatform.v1beta1.ScheduleService.ResumeSchedule", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "catch_up", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "ScheduleServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.ScheduleServiceClient" + }, + "method": { + "shortName": "ResumeSchedule", + "fullName": "google.cloud.aiplatform.v1beta1.ScheduleService.ResumeSchedule", + "service": { + "shortName": "ScheduleService", + "fullName": "google.cloud.aiplatform.v1beta1.ScheduleService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_ScheduleService_UpdateSchedule_async", + "title": "DatasetService updateSchedule Sample", + "origin": "API_DEFINITION", + "description": " Updates an active or paused Schedule. When the Schedule is updated, new runs will be scheduled starting from the updated next execution time after the update time based on the time_specification in the updated Schedule. All unstarted runs before the update time will be skipped while already created runs will NOT be paused or canceled.", + "canonical": true, + "file": "schedule_service.update_schedule.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateSchedule", + "fullName": "google.cloud.aiplatform.v1beta1.ScheduleService.UpdateSchedule", + "async": true, + "parameters": [ + { + "name": "schedule", + "type": ".google.cloud.aiplatform.v1beta1.Schedule" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Schedule", + "client": { + "shortName": "ScheduleServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.ScheduleServiceClient" + }, + "method": { + "shortName": "UpdateSchedule", + "fullName": "google.cloud.aiplatform.v1beta1.ScheduleService.UpdateSchedule", + "service": { + "shortName": "ScheduleService", + "fullName": "google.cloud.aiplatform.v1beta1.ScheduleService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_SpecialistPoolService_CreateSpecialistPool_async", + "title": "DatasetService createSpecialistPool Sample", + "origin": "API_DEFINITION", + "description": " Creates a SpecialistPool.", + "canonical": true, + "file": "specialist_pool_service.create_specialist_pool.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateSpecialistPool", + "fullName": "google.cloud.aiplatform.v1beta1.SpecialistPoolService.CreateSpecialistPool", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "specialist_pool", + "type": ".google.cloud.aiplatform.v1beta1.SpecialistPool" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "SpecialistPoolServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.SpecialistPoolServiceClient" + }, + "method": { + "shortName": "CreateSpecialistPool", + "fullName": "google.cloud.aiplatform.v1beta1.SpecialistPoolService.CreateSpecialistPool", + "service": { + "shortName": "SpecialistPoolService", + "fullName": "google.cloud.aiplatform.v1beta1.SpecialistPoolService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_SpecialistPoolService_GetSpecialistPool_async", + "title": "DatasetService getSpecialistPool Sample", + "origin": "API_DEFINITION", + "description": " Gets a SpecialistPool.", + "canonical": true, + "file": "specialist_pool_service.get_specialist_pool.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetSpecialistPool", + "fullName": "google.cloud.aiplatform.v1beta1.SpecialistPoolService.GetSpecialistPool", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.SpecialistPool", + "client": { + "shortName": "SpecialistPoolServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.SpecialistPoolServiceClient" + }, + "method": { + "shortName": "GetSpecialistPool", + "fullName": "google.cloud.aiplatform.v1beta1.SpecialistPoolService.GetSpecialistPool", + "service": { + "shortName": "SpecialistPoolService", + "fullName": "google.cloud.aiplatform.v1beta1.SpecialistPoolService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_SpecialistPoolService_ListSpecialistPools_async", + "title": "DatasetService listSpecialistPools Sample", + "origin": "API_DEFINITION", + "description": " Lists SpecialistPools in a Location.", + "canonical": true, + "file": "specialist_pool_service.list_specialist_pools.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 73, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListSpecialistPools", + "fullName": "google.cloud.aiplatform.v1beta1.SpecialistPoolService.ListSpecialistPools", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListSpecialistPoolsResponse", + "client": { + "shortName": "SpecialistPoolServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.SpecialistPoolServiceClient" + }, + "method": { + "shortName": "ListSpecialistPools", + "fullName": "google.cloud.aiplatform.v1beta1.SpecialistPoolService.ListSpecialistPools", + "service": { + "shortName": "SpecialistPoolService", + "fullName": "google.cloud.aiplatform.v1beta1.SpecialistPoolService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_SpecialistPoolService_DeleteSpecialistPool_async", + "title": "DatasetService deleteSpecialistPool Sample", + "origin": "API_DEFINITION", + "description": " Deletes a SpecialistPool as well as all Specialists in the pool.", + "canonical": true, + "file": "specialist_pool_service.delete_specialist_pool.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteSpecialistPool", + "fullName": "google.cloud.aiplatform.v1beta1.SpecialistPoolService.DeleteSpecialistPool", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "SpecialistPoolServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.SpecialistPoolServiceClient" + }, + "method": { + "shortName": "DeleteSpecialistPool", + "fullName": "google.cloud.aiplatform.v1beta1.SpecialistPoolService.DeleteSpecialistPool", + "service": { + "shortName": "SpecialistPoolService", + "fullName": "google.cloud.aiplatform.v1beta1.SpecialistPoolService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_SpecialistPoolService_UpdateSpecialistPool_async", + "title": "DatasetService updateSpecialistPool Sample", + "origin": "API_DEFINITION", + "description": " Updates a SpecialistPool.", + "canonical": true, + "file": "specialist_pool_service.update_specialist_pool.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateSpecialistPool", + "fullName": "google.cloud.aiplatform.v1beta1.SpecialistPoolService.UpdateSpecialistPool", + "async": true, + "parameters": [ + { + "name": "specialist_pool", + "type": ".google.cloud.aiplatform.v1beta1.SpecialistPool" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "SpecialistPoolServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.SpecialistPoolServiceClient" + }, + "method": { + "shortName": "UpdateSpecialistPool", + "fullName": "google.cloud.aiplatform.v1beta1.SpecialistPoolService.UpdateSpecialistPool", + "service": { + "shortName": "SpecialistPoolService", + "fullName": "google.cloud.aiplatform.v1beta1.SpecialistPoolService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_CreateTensorboard_async", + "title": "DatasetService createTensorboard Sample", + "origin": "API_DEFINITION", + "description": " Creates a Tensorboard.", + "canonical": true, + "file": "tensorboard_service.create_tensorboard.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateTensorboard", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.CreateTensorboard", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "tensorboard", + "type": ".google.cloud.aiplatform.v1beta1.Tensorboard" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "CreateTensorboard", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.CreateTensorboard", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_GetTensorboard_async", + "title": "DatasetService getTensorboard Sample", + "origin": "API_DEFINITION", + "description": " Gets a Tensorboard.", + "canonical": true, + "file": "tensorboard_service.get_tensorboard.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetTensorboard", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.GetTensorboard", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Tensorboard", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "GetTensorboard", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.GetTensorboard", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_UpdateTensorboard_async", + "title": "DatasetService updateTensorboard Sample", + "origin": "API_DEFINITION", + "description": " Updates a Tensorboard.", + "canonical": true, + "file": "tensorboard_service.update_tensorboard.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateTensorboard", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.UpdateTensorboard", + "async": true, + "parameters": [ + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "tensorboard", + "type": ".google.cloud.aiplatform.v1beta1.Tensorboard" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "UpdateTensorboard", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.UpdateTensorboard", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_ListTensorboards_async", + "title": "DatasetService listTensorboards Sample", + "origin": "API_DEFINITION", + "description": " Lists Tensorboards in a Location.", + "canonical": true, + "file": "tensorboard_service.list_tensorboards.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 85, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListTensorboards", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListTensorboardsResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "ListTensorboards", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_DeleteTensorboard_async", + "title": "DatasetService deleteTensorboard Sample", + "origin": "API_DEFINITION", + "description": " Deletes a Tensorboard.", + "canonical": true, + "file": "tensorboard_service.delete_tensorboard.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteTensorboard", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.DeleteTensorboard", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "DeleteTensorboard", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.DeleteTensorboard", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_ReadTensorboardUsage_async", + "title": "DatasetService readTensorboardUsage Sample", + "origin": "API_DEFINITION", + "description": " Returns a list of monthly active users for a given TensorBoard instance.", + "canonical": true, + "file": "tensorboard_service.read_tensorboard_usage.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ReadTensorboardUsage", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ReadTensorboardUsage", + "async": true, + "parameters": [ + { + "name": "tensorboard", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "ReadTensorboardUsage", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ReadTensorboardUsage", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_ReadTensorboardSize_async", + "title": "DatasetService readTensorboardSize Sample", + "origin": "API_DEFINITION", + "description": " Returns the storage size for a given TensorBoard instance.", + "canonical": true, + "file": "tensorboard_service.read_tensorboard_size.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ReadTensorboardSize", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ReadTensorboardSize", + "async": true, + "parameters": [ + { + "name": "tensorboard", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ReadTensorboardSizeResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "ReadTensorboardSize", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ReadTensorboardSize", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_CreateTensorboardExperiment_async", + "title": "DatasetService createTensorboardExperiment Sample", + "origin": "API_DEFINITION", + "description": " Creates a TensorboardExperiment.", + "canonical": true, + "file": "tensorboard_service.create_tensorboard_experiment.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateTensorboardExperiment", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.CreateTensorboardExperiment", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "tensorboard_experiment", + "type": ".google.cloud.aiplatform.v1beta1.TensorboardExperiment" + }, + { + "name": "tensorboard_experiment_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.TensorboardExperiment", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "CreateTensorboardExperiment", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.CreateTensorboardExperiment", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_GetTensorboardExperiment_async", + "title": "DatasetService getTensorboardExperiment Sample", + "origin": "API_DEFINITION", + "description": " Gets a TensorboardExperiment.", + "canonical": true, + "file": "tensorboard_service.get_tensorboard_experiment.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetTensorboardExperiment", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.GetTensorboardExperiment", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.TensorboardExperiment", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "GetTensorboardExperiment", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.GetTensorboardExperiment", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_UpdateTensorboardExperiment_async", + "title": "DatasetService updateTensorboardExperiment Sample", + "origin": "API_DEFINITION", + "description": " Updates a TensorboardExperiment.", + "canonical": true, + "file": "tensorboard_service.update_tensorboard_experiment.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateTensorboardExperiment", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.UpdateTensorboardExperiment", + "async": true, + "parameters": [ + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "tensorboard_experiment", + "type": ".google.cloud.aiplatform.v1beta1.TensorboardExperiment" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.TensorboardExperiment", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "UpdateTensorboardExperiment", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.UpdateTensorboardExperiment", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_ListTensorboardExperiments_async", + "title": "DatasetService listTensorboardExperiments Sample", + "origin": "API_DEFINITION", + "description": " Lists TensorboardExperiments in a Location.", + "canonical": true, + "file": "tensorboard_service.list_tensorboard_experiments.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 85, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListTensorboardExperiments", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListTensorboardExperimentsResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "ListTensorboardExperiments", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_DeleteTensorboardExperiment_async", + "title": "DatasetService deleteTensorboardExperiment Sample", + "origin": "API_DEFINITION", + "description": " Deletes a TensorboardExperiment.", + "canonical": true, + "file": "tensorboard_service.delete_tensorboard_experiment.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteTensorboardExperiment", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.DeleteTensorboardExperiment", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "DeleteTensorboardExperiment", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.DeleteTensorboardExperiment", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_CreateTensorboardRun_async", + "title": "DatasetService createTensorboardRun Sample", + "origin": "API_DEFINITION", + "description": " Creates a TensorboardRun.", + "canonical": true, + "file": "tensorboard_service.create_tensorboard_run.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateTensorboardRun", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.CreateTensorboardRun", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "tensorboard_run", + "type": ".google.cloud.aiplatform.v1beta1.TensorboardRun" + }, + { + "name": "tensorboard_run_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.TensorboardRun", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "CreateTensorboardRun", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.CreateTensorboardRun", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_BatchCreateTensorboardRuns_async", + "title": "DatasetService batchCreateTensorboardRuns Sample", + "origin": "API_DEFINITION", + "description": " Batch create TensorboardRuns.", + "canonical": true, + "file": "tensorboard_service.batch_create_tensorboard_runs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchCreateTensorboardRuns", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.BatchCreateTensorboardRuns", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "requests", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.BatchCreateTensorboardRunsResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "BatchCreateTensorboardRuns", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.BatchCreateTensorboardRuns", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_GetTensorboardRun_async", + "title": "DatasetService getTensorboardRun Sample", + "origin": "API_DEFINITION", + "description": " Gets a TensorboardRun.", + "canonical": true, + "file": "tensorboard_service.get_tensorboard_run.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetTensorboardRun", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.GetTensorboardRun", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.TensorboardRun", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "GetTensorboardRun", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.GetTensorboardRun", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_UpdateTensorboardRun_async", + "title": "DatasetService updateTensorboardRun Sample", + "origin": "API_DEFINITION", + "description": " Updates a TensorboardRun.", + "canonical": true, + "file": "tensorboard_service.update_tensorboard_run.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateTensorboardRun", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.UpdateTensorboardRun", + "async": true, + "parameters": [ + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "tensorboard_run", + "type": ".google.cloud.aiplatform.v1beta1.TensorboardRun" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.TensorboardRun", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "UpdateTensorboardRun", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.UpdateTensorboardRun", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_ListTensorboardRuns_async", + "title": "DatasetService listTensorboardRuns Sample", + "origin": "API_DEFINITION", + "description": " Lists TensorboardRuns in a Location.", + "canonical": true, + "file": "tensorboard_service.list_tensorboard_runs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 85, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListTensorboardRuns", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListTensorboardRunsResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "ListTensorboardRuns", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_DeleteTensorboardRun_async", + "title": "DatasetService deleteTensorboardRun Sample", + "origin": "API_DEFINITION", + "description": " Deletes a TensorboardRun.", + "canonical": true, + "file": "tensorboard_service.delete_tensorboard_run.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteTensorboardRun", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.DeleteTensorboardRun", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "DeleteTensorboardRun", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.DeleteTensorboardRun", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_BatchCreateTensorboardTimeSeries_async", + "title": "DatasetService batchCreateTensorboardTimeSeries Sample", + "origin": "API_DEFINITION", + "description": " Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.", + "canonical": true, + "file": "tensorboard_service.batch_create_tensorboard_time_series.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchCreateTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.BatchCreateTensorboardTimeSeries", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "requests", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.BatchCreateTensorboardTimeSeriesResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "BatchCreateTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.BatchCreateTensorboardTimeSeries", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_CreateTensorboardTimeSeries_async", + "title": "DatasetService createTensorboardTimeSeries Sample", + "origin": "API_DEFINITION", + "description": " Creates a TensorboardTimeSeries.", + "canonical": true, + "file": "tensorboard_service.create_tensorboard_time_series.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.CreateTensorboardTimeSeries", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "tensorboard_time_series_id", + "type": "TYPE_STRING" + }, + { + "name": "tensorboard_time_series", + "type": ".google.cloud.aiplatform.v1beta1.TensorboardTimeSeries" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.TensorboardTimeSeries", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "CreateTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.CreateTensorboardTimeSeries", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_GetTensorboardTimeSeries_async", + "title": "DatasetService getTensorboardTimeSeries Sample", + "origin": "API_DEFINITION", + "description": " Gets a TensorboardTimeSeries.", + "canonical": true, + "file": "tensorboard_service.get_tensorboard_time_series.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.GetTensorboardTimeSeries", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.TensorboardTimeSeries", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "GetTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.GetTensorboardTimeSeries", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_UpdateTensorboardTimeSeries_async", + "title": "DatasetService updateTensorboardTimeSeries Sample", + "origin": "API_DEFINITION", + "description": " Updates a TensorboardTimeSeries.", + "canonical": true, + "file": "tensorboard_service.update_tensorboard_time_series.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.UpdateTensorboardTimeSeries", + "async": true, + "parameters": [ + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "tensorboard_time_series", + "type": ".google.cloud.aiplatform.v1beta1.TensorboardTimeSeries" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.TensorboardTimeSeries", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "UpdateTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.UpdateTensorboardTimeSeries", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_ListTensorboardTimeSeries_async", + "title": "DatasetService listTensorboardTimeSeries Sample", + "origin": "API_DEFINITION", + "description": " Lists TensorboardTimeSeries in a Location.", + "canonical": true, + "file": "tensorboard_service.list_tensorboard_time_series.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 85, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListTensorboardTimeSeriesResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "ListTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_DeleteTensorboardTimeSeries_async", + "title": "DatasetService deleteTensorboardTimeSeries Sample", + "origin": "API_DEFINITION", + "description": " Deletes a TensorboardTimeSeries.", + "canonical": true, + "file": "tensorboard_service.delete_tensorboard_time_series.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.DeleteTensorboardTimeSeries", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "DeleteTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.DeleteTensorboardTimeSeries", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_BatchReadTensorboardTimeSeriesData_async", + "title": "DatasetService batchReadTensorboardTimeSeriesData Sample", + "origin": "API_DEFINITION", + "description": " Reads multiple TensorboardTimeSeries' data. The data point number limit is 1000 for scalars, 100 for tensors and blob references. If the number of data points stored is less than the limit, all data is returned. Otherwise, the number limit of data points is randomly selected from this time series and returned.", + "canonical": true, + "file": "tensorboard_service.batch_read_tensorboard_time_series_data.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchReadTensorboardTimeSeriesData", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.BatchReadTensorboardTimeSeriesData", + "async": true, + "parameters": [ + { + "name": "tensorboard", + "type": "TYPE_STRING" + }, + { + "name": "time_series", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.BatchReadTensorboardTimeSeriesDataResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "BatchReadTensorboardTimeSeriesData", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.BatchReadTensorboardTimeSeriesData", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_ReadTensorboardTimeSeriesData_async", + "title": "DatasetService readTensorboardTimeSeriesData Sample", + "origin": "API_DEFINITION", + "description": " Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k.", + "canonical": true, + "file": "tensorboard_service.read_tensorboard_time_series_data.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ReadTensorboardTimeSeriesData", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ReadTensorboardTimeSeriesData", + "async": true, + "parameters": [ + { + "name": "tensorboard_time_series", + "type": "TYPE_STRING" + }, + { + "name": "max_data_points", + "type": "TYPE_INT32" + }, + { + "name": "filter", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ReadTensorboardTimeSeriesDataResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "ReadTensorboardTimeSeriesData", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ReadTensorboardTimeSeriesData", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_ReadTensorboardBlobData_async", + "title": "DatasetService readTensorboardBlobData Sample", + "origin": "API_DEFINITION", + "description": " Gets bytes of TensorboardBlobs. This is to allow reading blob data stored in consumer project's Cloud Storage bucket without users having to obtain Cloud Storage access permission.", + "canonical": true, + "file": "tensorboard_service.read_tensorboard_blob_data.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ReadTensorboardBlobData", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ReadTensorboardBlobData", + "async": true, + "parameters": [ + { + "name": "time_series", + "type": "TYPE_STRING" + }, + { + "name": "blob_ids", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ReadTensorboardBlobDataResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "ReadTensorboardBlobData", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ReadTensorboardBlobData", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_WriteTensorboardExperimentData_async", + "title": "DatasetService writeTensorboardExperimentData Sample", + "origin": "API_DEFINITION", + "description": " Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's. If any data fail to be ingested, an error is returned.", + "canonical": true, + "file": "tensorboard_service.write_tensorboard_experiment_data.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "WriteTensorboardExperimentData", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.WriteTensorboardExperimentData", + "async": true, + "parameters": [ + { + "name": "tensorboard_experiment", + "type": "TYPE_STRING" + }, + { + "name": "write_run_data_requests", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.WriteTensorboardExperimentDataResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "WriteTensorboardExperimentData", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.WriteTensorboardExperimentData", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_WriteTensorboardRunData_async", + "title": "DatasetService writeTensorboardRunData Sample", + "origin": "API_DEFINITION", + "description": " Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun. If any data fail to be ingested, an error is returned.", + "canonical": true, + "file": "tensorboard_service.write_tensorboard_run_data.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 64, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "WriteTensorboardRunData", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.WriteTensorboardRunData", + "async": true, + "parameters": [ + { + "name": "tensorboard_run", + "type": "TYPE_STRING" + }, + { + "name": "time_series_data", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.WriteTensorboardRunDataResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "WriteTensorboardRunData", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.WriteTensorboardRunData", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_ExportTensorboardTimeSeriesData_async", + "title": "DatasetService exportTensorboardTimeSeriesData Sample", + "origin": "API_DEFINITION", + "description": " Exports a TensorboardTimeSeries' data. Data is returned in paginated responses.", + "canonical": true, + "file": "tensorboard_service.export_tensorboard_time_series_data.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 82, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ExportTensorboardTimeSeriesData", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ExportTensorboardTimeSeriesData", + "async": true, + "parameters": [ + { + "name": "tensorboard_time_series", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ExportTensorboardTimeSeriesDataResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "ExportTensorboardTimeSeriesData", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ExportTensorboardTimeSeriesData", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_VizierService_CreateStudy_async", + "title": "DatasetService createStudy Sample", + "origin": "API_DEFINITION", + "description": " Creates a Study. A resource name will be generated after creation of the Study.", + "canonical": true, + "file": "vizier_service.create_study.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateStudy", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.CreateStudy", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "study", + "type": ".google.cloud.aiplatform.v1beta1.Study" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Study", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.VizierServiceClient" + }, + "method": { + "shortName": "CreateStudy", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.CreateStudy", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_VizierService_GetStudy_async", + "title": "DatasetService getStudy Sample", + "origin": "API_DEFINITION", + "description": " Gets a Study by name.", + "canonical": true, + "file": "vizier_service.get_study.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetStudy", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.GetStudy", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Study", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.VizierServiceClient" + }, + "method": { + "shortName": "GetStudy", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.GetStudy", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_VizierService_ListStudies_async", + "title": "DatasetService listStudies Sample", + "origin": "API_DEFINITION", + "description": " Lists all the studies in a region for an associated project.", + "canonical": true, + "file": "vizier_service.list_studies.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListStudies", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.ListStudies", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListStudiesResponse", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.VizierServiceClient" + }, + "method": { + "shortName": "ListStudies", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.ListStudies", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_VizierService_DeleteStudy_async", + "title": "DatasetService deleteStudy Sample", + "origin": "API_DEFINITION", + "description": " Deletes a Study.", + "canonical": true, + "file": "vizier_service.delete_study.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteStudy", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.DeleteStudy", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.VizierServiceClient" + }, + "method": { + "shortName": "DeleteStudy", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.DeleteStudy", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_VizierService_LookupStudy_async", + "title": "DatasetService lookupStudy Sample", + "origin": "API_DEFINITION", + "description": " Looks a study up using the user-defined display_name field instead of the fully qualified resource name.", + "canonical": true, + "file": "vizier_service.lookup_study.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "LookupStudy", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.LookupStudy", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "display_name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Study", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.VizierServiceClient" + }, + "method": { + "shortName": "LookupStudy", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.LookupStudy", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_VizierService_SuggestTrials_async", + "title": "DatasetService suggestTrials Sample", + "origin": "API_DEFINITION", + "description": " Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier. Returns a long-running operation associated with the generation of Trial suggestions. When this long-running operation succeeds, it will contain a [SuggestTrialsResponse][google.cloud.aiplatform.v1beta1.SuggestTrialsResponse].", + "canonical": true, + "file": "vizier_service.suggest_trials.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SuggestTrials", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.SuggestTrials", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "suggestion_count", + "type": "TYPE_INT32" + }, + { + "name": "client_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.VizierServiceClient" + }, + "method": { + "shortName": "SuggestTrials", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.SuggestTrials", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_VizierService_CreateTrial_async", + "title": "DatasetService createTrial Sample", + "origin": "API_DEFINITION", + "description": " Adds a user provided Trial to a Study.", + "canonical": true, + "file": "vizier_service.create_trial.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateTrial", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.CreateTrial", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "trial", + "type": ".google.cloud.aiplatform.v1beta1.Trial" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Trial", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.VizierServiceClient" + }, + "method": { + "shortName": "CreateTrial", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.CreateTrial", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_VizierService_GetTrial_async", + "title": "DatasetService getTrial Sample", + "origin": "API_DEFINITION", + "description": " Gets a Trial.", + "canonical": true, + "file": "vizier_service.get_trial.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetTrial", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.GetTrial", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Trial", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.VizierServiceClient" + }, + "method": { + "shortName": "GetTrial", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.GetTrial", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_VizierService_ListTrials_async", + "title": "DatasetService listTrials Sample", + "origin": "API_DEFINITION", + "description": " Lists the Trials associated with a Study.", + "canonical": true, + "file": "vizier_service.list_trials.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListTrials", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.ListTrials", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListTrialsResponse", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.VizierServiceClient" + }, + "method": { + "shortName": "ListTrials", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.ListTrials", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_VizierService_AddTrialMeasurement_async", + "title": "DatasetService addTrialMeasurement Sample", + "origin": "API_DEFINITION", + "description": " Adds a measurement of the objective metrics to a Trial. This measurement is assumed to have been taken before the Trial is complete.", + "canonical": true, + "file": "vizier_service.add_trial_measurement.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AddTrialMeasurement", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.AddTrialMeasurement", + "async": true, + "parameters": [ + { + "name": "trial_name", + "type": "TYPE_STRING" + }, + { + "name": "measurement", + "type": ".google.cloud.aiplatform.v1beta1.Measurement" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Trial", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.VizierServiceClient" + }, + "method": { + "shortName": "AddTrialMeasurement", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.AddTrialMeasurement", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_VizierService_CompleteTrial_async", + "title": "DatasetService completeTrial Sample", + "origin": "API_DEFINITION", + "description": " Marks a Trial as complete.", + "canonical": true, + "file": "vizier_service.complete_trial.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CompleteTrial", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.CompleteTrial", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "final_measurement", + "type": ".google.cloud.aiplatform.v1beta1.Measurement" + }, + { + "name": "trial_infeasible", + "type": "TYPE_BOOL" + }, + { + "name": "infeasible_reason", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Trial", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.VizierServiceClient" + }, + "method": { + "shortName": "CompleteTrial", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.CompleteTrial", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_VizierService_DeleteTrial_async", + "title": "DatasetService deleteTrial Sample", + "origin": "API_DEFINITION", + "description": " Deletes a Trial.", + "canonical": true, + "file": "vizier_service.delete_trial.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteTrial", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.DeleteTrial", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.VizierServiceClient" + }, + "method": { + "shortName": "DeleteTrial", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.DeleteTrial", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_VizierService_CheckTrialEarlyStoppingState_async", + "title": "DatasetService checkTrialEarlyStoppingState Sample", + "origin": "API_DEFINITION", + "description": " Checks whether a Trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a [CheckTrialEarlyStoppingStateResponse][google.cloud.aiplatform.v1beta1.CheckTrialEarlyStoppingStateResponse].", + "canonical": true, + "file": "vizier_service.check_trial_early_stopping_state.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CheckTrialEarlyStoppingState", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.CheckTrialEarlyStoppingState", + "async": true, + "parameters": [ + { + "name": "trial_name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.VizierServiceClient" + }, + "method": { + "shortName": "CheckTrialEarlyStoppingState", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.CheckTrialEarlyStoppingState", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_VizierService_StopTrial_async", + "title": "DatasetService stopTrial Sample", + "origin": "API_DEFINITION", + "description": " Stops a Trial.", + "canonical": true, + "file": "vizier_service.stop_trial.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "StopTrial", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.StopTrial", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Trial", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.VizierServiceClient" + }, + "method": { + "shortName": "StopTrial", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.StopTrial", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_VizierService_ListOptimalTrials_async", + "title": "DatasetService listOptimalTrials Sample", + "origin": "API_DEFINITION", + "description": " Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency", + "canonical": true, + "file": "vizier_service.list_optimal_trials.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListOptimalTrials", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.ListOptimalTrials", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListOptimalTrialsResponse", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.VizierServiceClient" + }, + "method": { + "shortName": "ListOptimalTrials", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.ListOptimalTrials", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.batch_create_tensorboard_runs.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.batch_create_tensorboard_runs.js index 822e4dc1852..f74ab3e70e9 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.batch_create_tensorboard_runs.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.batch_create_tensorboard_runs.js @@ -40,7 +40,7 @@ function main(parent, requests) { * Required. The request message specifying the TensorboardRuns to create. * A maximum of 1000 TensorboardRuns can be created in a batch. */ - // const requests = 1234 + // const requests = [1,2,3,4] // Imports the Aiplatform library const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1beta1; diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.batch_create_tensorboard_time_series.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.batch_create_tensorboard_time_series.js index 5fee512fad8..1dbadc25dd1 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.batch_create_tensorboard_time_series.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.batch_create_tensorboard_time_series.js @@ -42,7 +42,7 @@ function main(parent, requests) { * Required. The request message specifying the TensorboardTimeSeries to * create. A maximum of 1000 TensorboardTimeSeries can be created in a batch. */ - // const requests = 1234 + // const requests = [1,2,3,4] // Imports the Aiplatform library const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1beta1; diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.batch_read_tensorboard_time_series_data.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.batch_read_tensorboard_time_series_data.js index 8de21477d13..b67660a08d7 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.batch_read_tensorboard_time_series_data.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.batch_read_tensorboard_time_series_data.js @@ -42,7 +42,7 @@ function main(tensorboard, timeSeries) { * from. Format: * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}` */ - // const timeSeries = 'abc123' + // const timeSeries = ['abc','def'] // Imports the Aiplatform library const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1beta1; diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.read_tensorboard_blob_data.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.read_tensorboard_blob_data.js index 50eadd1b375..8bbccd9c08e 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.read_tensorboard_blob_data.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.read_tensorboard_blob_data.js @@ -37,7 +37,7 @@ function main(timeSeries) { /** * IDs of the blobs to read. */ - // const blobIds = 'abc123' + // const blobIds = ['abc','def'] // Imports the Aiplatform library const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1beta1; diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.write_tensorboard_experiment_data.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.write_tensorboard_experiment_data.js index fad54d33dd4..84b02ee9960 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.write_tensorboard_experiment_data.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.write_tensorboard_experiment_data.js @@ -37,7 +37,7 @@ function main(tensorboardExperiment, writeRunDataRequests) { /** * Required. Requests containing per-run TensorboardTimeSeries data to write. */ - // const writeRunDataRequests = 1234 + // const writeRunDataRequests = [1,2,3,4] // Imports the Aiplatform library const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1beta1; diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.write_tensorboard_run_data.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.write_tensorboard_run_data.js index bc09d512805..9559049c488 100644 --- a/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.write_tensorboard_run_data.js +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.write_tensorboard_run_data.js @@ -41,7 +41,7 @@ function main(tensorboardRun, timeSeriesData) { * step. * The upper limit of data points per write request is 5000. */ - // const timeSeriesData = 1234 + // const timeSeriesData = [1,2,3,4] // Imports the Aiplatform library const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1beta1; diff --git a/packages/google-cloud-aiplatform/samples/package.json b/packages/google-cloud-aiplatform/samples/package.json index 7728698843c..e7a7304cb64 100644 --- a/packages/google-cloud-aiplatform/samples/package.json +++ b/packages/google-cloud-aiplatform/samples/package.json @@ -4,7 +4,7 @@ "license": "Apache-2.0", "author": "Google LLC", "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" }, "files": [ "*.js" diff --git a/packages/google-cloud-aiplatform/src/index.ts b/packages/google-cloud-aiplatform/src/index.ts index f279e0ccb72..cb374e456ef 100644 --- a/packages/google-cloud-aiplatform/src/index.ts +++ b/packages/google-cloud-aiplatform/src/index.ts @@ -55,6 +55,8 @@ const MatchServiceClient = v1.MatchServiceClient; type MatchServiceClient = v1.MatchServiceClient; const ModelGardenServiceClient = v1.ModelGardenServiceClient; type ModelGardenServiceClient = v1.ModelGardenServiceClient; +const ScheduleServiceClient = v1.ScheduleServiceClient; +type ScheduleServiceClient = v1.ScheduleServiceClient; export { v1beta1, @@ -76,6 +78,7 @@ export { TensorboardServiceClient, MatchServiceClient, ModelGardenServiceClient, + ScheduleServiceClient, }; export default { v1beta1, @@ -97,6 +100,7 @@ export default { TensorboardServiceClient, MatchServiceClient, ModelGardenServiceClient, + ScheduleServiceClient, }; import * as protos from '../protos/protos'; export {protos}; diff --git a/packages/google-cloud-aiplatform/src/v1/dataset_service_client.ts b/packages/google-cloud-aiplatform/src/v1/dataset_service_client.ts index dc8d6786ba7..9de1fcdf30e 100644 --- a/packages/google-cloud-aiplatform/src/v1/dataset_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1/dataset_service_client.ts @@ -282,6 +282,9 @@ export class DatasetServiceClient { savedQueryPathTemplate: new this._gaxModule.PathTemplate( 'projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}' ), + schedulePathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/schedules/{schedule}' + ), specialistPoolPathTemplate: new this._gaxModule.PathTemplate( 'projects/{project}/locations/{location}/specialistPools/{specialist_pool}' ), @@ -1602,9 +1605,8 @@ export class DatasetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.Dataset | Dataset}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.Dataset|Dataset}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataset_service.get_dataset.js * region_tag:aiplatform_v1_generated_DatasetService_GetDataset_async @@ -1687,7 +1689,7 @@ export class DatasetServiceClient { * @param {google.protobuf.FieldMask} request.updateMask * Required. The update mask applies to the resource. * For the `FieldMask` definition, see - * {@link google.protobuf.FieldMask|google.protobuf.FieldMask}. Updatable fields: + * {@link protos.google.protobuf.FieldMask|google.protobuf.FieldMask}. Updatable fields: * * * `display_name` * * `description` @@ -1695,9 +1697,8 @@ export class DatasetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.Dataset | Dataset}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.Dataset|Dataset}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataset_service.update_dataset.js * region_tag:aiplatform_v1_generated_DatasetService_UpdateDataset_async @@ -1790,9 +1791,8 @@ export class DatasetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.AnnotationSpec | AnnotationSpec}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.AnnotationSpec|AnnotationSpec}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/dataset_service.get_annotation_spec.js * region_tag:aiplatform_v1_generated_DatasetService_GetAnnotationSpec_async @@ -1888,8 +1888,7 @@ export class DatasetServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/dataset_service.create_dataset.js * region_tag:aiplatform_v1_generated_DatasetService_CreateDataset_async @@ -1984,8 +1983,7 @@ export class DatasetServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/dataset_service.create_dataset.js * region_tag:aiplatform_v1_generated_DatasetService_CreateDataset_async @@ -2028,8 +2026,7 @@ export class DatasetServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/dataset_service.delete_dataset.js * region_tag:aiplatform_v1_generated_DatasetService_DeleteDataset_async @@ -2124,8 +2121,7 @@ export class DatasetServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/dataset_service.delete_dataset.js * region_tag:aiplatform_v1_generated_DatasetService_DeleteDataset_async @@ -2171,8 +2167,7 @@ export class DatasetServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/dataset_service.import_data.js * region_tag:aiplatform_v1_generated_DatasetService_ImportData_async @@ -2267,8 +2262,7 @@ export class DatasetServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/dataset_service.import_data.js * region_tag:aiplatform_v1_generated_DatasetService_ImportData_async @@ -2313,8 +2307,7 @@ export class DatasetServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/dataset_service.export_data.js * region_tag:aiplatform_v1_generated_DatasetService_ExportData_async @@ -2409,8 +2402,7 @@ export class DatasetServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/dataset_service.export_data.js * region_tag:aiplatform_v1_generated_DatasetService_ExportData_async @@ -2453,8 +2445,7 @@ export class DatasetServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/dataset_service.delete_saved_query.js * region_tag:aiplatform_v1_generated_DatasetService_DeleteSavedQuery_async @@ -2549,8 +2540,7 @@ export class DatasetServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/dataset_service.delete_saved_query.js * region_tag:aiplatform_v1_generated_DatasetService_DeleteSavedQuery_async @@ -2618,14 +2608,13 @@ export class DatasetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1.Dataset | Dataset}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.Dataset|Dataset}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listDatasetsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listDatasets( @@ -2742,13 +2731,12 @@ export class DatasetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1.Dataset | Dataset} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.Dataset|Dataset} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listDatasetsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listDatasetsStream( @@ -2814,12 +2802,11 @@ export class DatasetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1.Dataset | Dataset}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1.Dataset|Dataset}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/dataset_service.list_datasets.js * region_tag:aiplatform_v1_generated_DatasetService_ListDatasets_async @@ -2868,14 +2855,13 @@ export class DatasetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1.DataItem | DataItem}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.DataItem|DataItem}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listDataItemsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listDataItems( @@ -2975,13 +2961,12 @@ export class DatasetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1.DataItem | DataItem} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.DataItem|DataItem} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listDataItemsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listDataItemsStream( @@ -3030,12 +3015,11 @@ export class DatasetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1.DataItem | DataItem}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1.DataItem|DataItem}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/dataset_service.list_data_items.js * region_tag:aiplatform_v1_generated_DatasetService_ListDataItems_async @@ -3111,7 +3095,7 @@ export class DatasetServiceClient { * belong to. * @param {google.protobuf.FieldMask} request.fieldMask * Mask specifying which fields of - * {@link google.cloud.aiplatform.v1.DataItemView|DataItemView} to read. + * {@link protos.google.cloud.aiplatform.v1.DataItemView|DataItemView} to read. * @param {number} request.annotationsLimit * If set, only up to this many of Annotations will be returned per * DataItemView. The maximum value is 1000. If not set, the maximum value will @@ -3125,21 +3109,20 @@ export class DatasetServiceClient { * @param {string} request.pageToken * A token identifying a page of results for the server to return * Typically obtained via - * {@link google.cloud.aiplatform.v1.SearchDataItemsResponse.next_page_token|SearchDataItemsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1.SearchDataItemsResponse.next_page_token|SearchDataItemsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.DatasetService.SearchDataItems|DatasetService.SearchDataItems} + * {@link protos.google.cloud.aiplatform.v1.DatasetService.SearchDataItems|DatasetService.SearchDataItems} * call. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1.DataItemView | DataItemView}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.DataItemView|DataItemView}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `searchDataItemsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ searchDataItems( @@ -3266,7 +3249,7 @@ export class DatasetServiceClient { * belong to. * @param {google.protobuf.FieldMask} request.fieldMask * Mask specifying which fields of - * {@link google.cloud.aiplatform.v1.DataItemView|DataItemView} to read. + * {@link protos.google.cloud.aiplatform.v1.DataItemView|DataItemView} to read. * @param {number} request.annotationsLimit * If set, only up to this many of Annotations will be returned per * DataItemView. The maximum value is 1000. If not set, the maximum value will @@ -3280,20 +3263,19 @@ export class DatasetServiceClient { * @param {string} request.pageToken * A token identifying a page of results for the server to return * Typically obtained via - * {@link google.cloud.aiplatform.v1.SearchDataItemsResponse.next_page_token|SearchDataItemsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1.SearchDataItemsResponse.next_page_token|SearchDataItemsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.DatasetService.SearchDataItems|DatasetService.SearchDataItems} + * {@link protos.google.cloud.aiplatform.v1.DatasetService.SearchDataItems|DatasetService.SearchDataItems} * call. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1.DataItemView | DataItemView} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.DataItemView|DataItemView} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `searchDataItemsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ searchDataItemsStream( @@ -3369,7 +3351,7 @@ export class DatasetServiceClient { * belong to. * @param {google.protobuf.FieldMask} request.fieldMask * Mask specifying which fields of - * {@link google.cloud.aiplatform.v1.DataItemView|DataItemView} to read. + * {@link protos.google.cloud.aiplatform.v1.DataItemView|DataItemView} to read. * @param {number} request.annotationsLimit * If set, only up to this many of Annotations will be returned per * DataItemView. The maximum value is 1000. If not set, the maximum value will @@ -3383,19 +3365,18 @@ export class DatasetServiceClient { * @param {string} request.pageToken * A token identifying a page of results for the server to return * Typically obtained via - * {@link google.cloud.aiplatform.v1.SearchDataItemsResponse.next_page_token|SearchDataItemsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1.SearchDataItemsResponse.next_page_token|SearchDataItemsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.DatasetService.SearchDataItems|DatasetService.SearchDataItems} + * {@link protos.google.cloud.aiplatform.v1.DatasetService.SearchDataItems|DatasetService.SearchDataItems} * call. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1.DataItemView | DataItemView}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1.DataItemView|DataItemView}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/dataset_service.search_data_items.js * region_tag:aiplatform_v1_generated_DatasetService_SearchDataItems_async @@ -3444,14 +3425,13 @@ export class DatasetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1.SavedQuery | SavedQuery}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.SavedQuery|SavedQuery}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listSavedQueriesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listSavedQueries( @@ -3551,13 +3531,12 @@ export class DatasetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1.SavedQuery | SavedQuery} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.SavedQuery|SavedQuery} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listSavedQueriesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listSavedQueriesStream( @@ -3606,12 +3585,11 @@ export class DatasetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1.SavedQuery | SavedQuery}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1.SavedQuery|SavedQuery}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/dataset_service.list_saved_queries.js * region_tag:aiplatform_v1_generated_DatasetService_ListSavedQueries_async @@ -3660,14 +3638,13 @@ export class DatasetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1.Annotation | Annotation}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.Annotation|Annotation}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAnnotationsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listAnnotations( @@ -3767,13 +3744,12 @@ export class DatasetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1.Annotation | Annotation} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.Annotation|Annotation} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAnnotationsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listAnnotationsStream( @@ -3822,12 +3798,11 @@ export class DatasetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1.Annotation | Annotation}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1.Annotation|Annotation}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/dataset_service.list_annotations.js * region_tag:aiplatform_v1_generated_DatasetService_ListAnnotations_async @@ -3892,7 +3867,7 @@ export class DatasetServiceClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -3913,8 +3888,7 @@ export class DatasetServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -3940,7 +3914,7 @@ export class DatasetServiceClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -3961,8 +3935,7 @@ export class DatasetServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -3989,7 +3962,7 @@ export class DatasetServiceClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -4004,8 +3977,7 @@ export class DatasetServiceClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` @@ -4051,12 +4023,11 @@ export class DatasetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` @@ -6161,6 +6132,55 @@ export class DatasetServiceClient { .saved_query; } + /** + * Return a fully-qualified schedule resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} schedule + * @returns {string} Resource name string. + */ + schedulePath(project: string, location: string, schedule: string) { + return this.pathTemplates.schedulePathTemplate.render({ + project: project, + location: location, + schedule: schedule, + }); + } + + /** + * Parse the project from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the project. + */ + matchProjectFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).project; + } + + /** + * Parse the location from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the location. + */ + matchLocationFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).location; + } + + /** + * Parse the schedule from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the schedule. + */ + matchScheduleFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).schedule; + } + /** * Return a fully-qualified specialistPool resource name string. * diff --git a/packages/google-cloud-aiplatform/src/v1/dataset_service_proto_list.json b/packages/google-cloud-aiplatform/src/v1/dataset_service_proto_list.json index f987b709de8..2d74caf069f 100644 --- a/packages/google-cloud-aiplatform/src/v1/dataset_service_proto_list.json +++ b/packages/google-cloud-aiplatform/src/v1/dataset_service_proto_list.json @@ -63,6 +63,8 @@ "../../protos/google/cloud/aiplatform/v1/prediction_service.proto", "../../protos/google/cloud/aiplatform/v1/publisher_model.proto", "../../protos/google/cloud/aiplatform/v1/saved_query.proto", + "../../protos/google/cloud/aiplatform/v1/schedule.proto", + "../../protos/google/cloud/aiplatform/v1/schedule_service.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_classification.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_object_detection.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_segmentation.proto", diff --git a/packages/google-cloud-aiplatform/src/v1/endpoint_service_client.ts b/packages/google-cloud-aiplatform/src/v1/endpoint_service_client.ts index 85776c67e45..4fc471c0955 100644 --- a/packages/google-cloud-aiplatform/src/v1/endpoint_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1/endpoint_service_client.ts @@ -282,6 +282,9 @@ export class EndpointServiceClient { savedQueryPathTemplate: new this._gaxModule.PathTemplate( 'projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}' ), + schedulePathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/schedules/{schedule}' + ), specialistPoolPathTemplate: new this._gaxModule.PathTemplate( 'projects/{project}/locations/{location}/specialistPools/{specialist_pool}' ), @@ -1577,9 +1580,8 @@ export class EndpointServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.Endpoint | Endpoint}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.Endpoint|Endpoint}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/endpoint_service.get_endpoint.js * region_tag:aiplatform_v1_generated_EndpointService_GetEndpoint_async @@ -1661,13 +1663,12 @@ export class EndpointServiceClient { * Required. The Endpoint which replaces the resource on the server. * @param {google.protobuf.FieldMask} request.updateMask * Required. The update mask applies to the resource. See - * {@link google.protobuf.FieldMask|google.protobuf.FieldMask}. + * {@link protos.google.protobuf.FieldMask|google.protobuf.FieldMask}. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.Endpoint | Endpoint}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.Endpoint|Endpoint}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/endpoint_service.update_endpoint.js * region_tag:aiplatform_v1_generated_EndpointService_UpdateEndpoint_async @@ -1778,8 +1779,7 @@ export class EndpointServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/endpoint_service.create_endpoint.js * region_tag:aiplatform_v1_generated_EndpointService_CreateEndpoint_async @@ -1874,8 +1874,7 @@ export class EndpointServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/endpoint_service.create_endpoint.js * region_tag:aiplatform_v1_generated_EndpointService_CreateEndpoint_async @@ -1918,8 +1917,7 @@ export class EndpointServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/endpoint_service.delete_endpoint.js * region_tag:aiplatform_v1_generated_EndpointService_DeleteEndpoint_async @@ -2014,8 +2012,7 @@ export class EndpointServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/endpoint_service.delete_endpoint.js * region_tag:aiplatform_v1_generated_EndpointService_DeleteEndpoint_async @@ -2054,23 +2051,23 @@ export class EndpointServiceClient { * `projects/{project}/locations/{location}/endpoints/{endpoint}` * @param {google.cloud.aiplatform.v1.DeployedModel} request.deployedModel * Required. The DeployedModel to be created within the Endpoint. Note that - * {@link google.cloud.aiplatform.v1.Endpoint.traffic_split|Endpoint.traffic_split} + * {@link protos.google.cloud.aiplatform.v1.Endpoint.traffic_split|Endpoint.traffic_split} * must be updated for the DeployedModel to start receiving traffic, either as * part of this call, or via - * {@link google.cloud.aiplatform.v1.EndpointService.UpdateEndpoint|EndpointService.UpdateEndpoint}. + * {@link protos.google.cloud.aiplatform.v1.EndpointService.UpdateEndpoint|EndpointService.UpdateEndpoint}. * @param {number[]} request.trafficSplit * A map from a DeployedModel's ID to the percentage of this Endpoint's * traffic that should be forwarded to that DeployedModel. * * If this field is non-empty, then the Endpoint's - * {@link google.cloud.aiplatform.v1.Endpoint.traffic_split|traffic_split} will be + * {@link protos.google.cloud.aiplatform.v1.Endpoint.traffic_split|traffic_split} will be * overwritten with it. To refer to the ID of the just being deployed Model, a * "0" should be used, and the actual ID of the new DeployedModel will be * filled in its place by this method. The traffic percentage values must add * up to 100. * * If this field is empty, then the Endpoint's - * {@link google.cloud.aiplatform.v1.Endpoint.traffic_split|traffic_split} is not + * {@link protos.google.cloud.aiplatform.v1.Endpoint.traffic_split|traffic_split} is not * updated. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. @@ -2078,8 +2075,7 @@ export class EndpointServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/endpoint_service.deploy_model.js * region_tag:aiplatform_v1_generated_EndpointService_DeployModel_async @@ -2174,8 +2170,7 @@ export class EndpointServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/endpoint_service.deploy_model.js * region_tag:aiplatform_v1_generated_EndpointService_DeployModel_async @@ -2217,7 +2212,7 @@ export class EndpointServiceClient { * Required. The ID of the DeployedModel to be undeployed from the Endpoint. * @param {number[]} request.trafficSplit * If this field is provided, then the Endpoint's - * {@link google.cloud.aiplatform.v1.Endpoint.traffic_split|traffic_split} will be + * {@link protos.google.cloud.aiplatform.v1.Endpoint.traffic_split|traffic_split} will be * overwritten with it. If last DeployedModel is being undeployed from the * Endpoint, the [Endpoint.traffic_split] will always end up empty when this * call returns. A DeployedModel will be successfully undeployed only if it @@ -2229,8 +2224,7 @@ export class EndpointServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/endpoint_service.undeploy_model.js * region_tag:aiplatform_v1_generated_EndpointService_UndeployModel_async @@ -2325,8 +2319,7 @@ export class EndpointServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/endpoint_service.undeploy_model.js * region_tag:aiplatform_v1_generated_EndpointService_UndeployModel_async @@ -2371,25 +2364,24 @@ export class EndpointServiceClient { * following fields can be mutated: * * * `min_replica_count` in either - * {@link google.cloud.aiplatform.v1.DedicatedResources|DedicatedResources} or - * {@link google.cloud.aiplatform.v1.AutomaticResources|AutomaticResources} + * {@link protos.google.cloud.aiplatform.v1.DedicatedResources|DedicatedResources} or + * {@link protos.google.cloud.aiplatform.v1.AutomaticResources|AutomaticResources} * * `max_replica_count` in either - * {@link google.cloud.aiplatform.v1.DedicatedResources|DedicatedResources} or - * {@link google.cloud.aiplatform.v1.AutomaticResources|AutomaticResources} - * * {@link google.cloud.aiplatform.v1.DedicatedResources.autoscaling_metric_specs|autoscaling_metric_specs} + * {@link protos.google.cloud.aiplatform.v1.DedicatedResources|DedicatedResources} or + * {@link protos.google.cloud.aiplatform.v1.AutomaticResources|AutomaticResources} + * * {@link protos.google.cloud.aiplatform.v1.DedicatedResources.autoscaling_metric_specs|autoscaling_metric_specs} * * `disable_container_logging` (v1 only) * * `enable_container_logging` (v1beta1 only) * @param {google.protobuf.FieldMask} request.updateMask * Required. The update mask applies to the resource. See - * {@link google.protobuf.FieldMask|google.protobuf.FieldMask}. + * {@link protos.google.protobuf.FieldMask|google.protobuf.FieldMask}. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/endpoint_service.mutate_deployed_model.js * region_tag:aiplatform_v1_generated_EndpointService_MutateDeployedModel_async @@ -2484,8 +2476,7 @@ export class EndpointServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/endpoint_service.mutate_deployed_model.js * region_tag:aiplatform_v1_generated_EndpointService_MutateDeployedModel_async @@ -2543,9 +2534,9 @@ export class EndpointServiceClient { * @param {string} [request.pageToken] * Optional. The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListEndpointsResponse.next_page_token|ListEndpointsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1.ListEndpointsResponse.next_page_token|ListEndpointsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.EndpointService.ListEndpoints|EndpointService.ListEndpoints} + * {@link protos.google.cloud.aiplatform.v1.EndpointService.ListEndpoints|EndpointService.ListEndpoints} * call. * @param {google.protobuf.FieldMask} [request.readMask] * Optional. Mask specifying which fields to read. @@ -2561,14 +2552,13 @@ export class EndpointServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1.Endpoint | Endpoint}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.Endpoint|Endpoint}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listEndpointsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listEndpoints( @@ -2675,9 +2665,9 @@ export class EndpointServiceClient { * @param {string} [request.pageToken] * Optional. The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListEndpointsResponse.next_page_token|ListEndpointsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1.ListEndpointsResponse.next_page_token|ListEndpointsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.EndpointService.ListEndpoints|EndpointService.ListEndpoints} + * {@link protos.google.cloud.aiplatform.v1.EndpointService.ListEndpoints|EndpointService.ListEndpoints} * call. * @param {google.protobuf.FieldMask} [request.readMask] * Optional. Mask specifying which fields to read. @@ -2693,13 +2683,12 @@ export class EndpointServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1.Endpoint | Endpoint} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.Endpoint|Endpoint} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listEndpointsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listEndpointsStream( @@ -2755,9 +2744,9 @@ export class EndpointServiceClient { * @param {string} [request.pageToken] * Optional. The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListEndpointsResponse.next_page_token|ListEndpointsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1.ListEndpointsResponse.next_page_token|ListEndpointsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.EndpointService.ListEndpoints|EndpointService.ListEndpoints} + * {@link protos.google.cloud.aiplatform.v1.EndpointService.ListEndpoints|EndpointService.ListEndpoints} * call. * @param {google.protobuf.FieldMask} [request.readMask] * Optional. Mask specifying which fields to read. @@ -2773,12 +2762,11 @@ export class EndpointServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1.Endpoint | Endpoint}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1.Endpoint|Endpoint}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/endpoint_service.list_endpoints.js * region_tag:aiplatform_v1_generated_EndpointService_ListEndpoints_async @@ -2843,7 +2831,7 @@ export class EndpointServiceClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -2864,8 +2852,7 @@ export class EndpointServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -2891,7 +2878,7 @@ export class EndpointServiceClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -2912,8 +2899,7 @@ export class EndpointServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -2940,7 +2926,7 @@ export class EndpointServiceClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -2955,8 +2941,7 @@ export class EndpointServiceClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` @@ -3002,12 +2987,11 @@ export class EndpointServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` @@ -5112,6 +5096,55 @@ export class EndpointServiceClient { .saved_query; } + /** + * Return a fully-qualified schedule resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} schedule + * @returns {string} Resource name string. + */ + schedulePath(project: string, location: string, schedule: string) { + return this.pathTemplates.schedulePathTemplate.render({ + project: project, + location: location, + schedule: schedule, + }); + } + + /** + * Parse the project from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the project. + */ + matchProjectFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).project; + } + + /** + * Parse the location from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the location. + */ + matchLocationFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).location; + } + + /** + * Parse the schedule from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the schedule. + */ + matchScheduleFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).schedule; + } + /** * Return a fully-qualified specialistPool resource name string. * diff --git a/packages/google-cloud-aiplatform/src/v1/endpoint_service_proto_list.json b/packages/google-cloud-aiplatform/src/v1/endpoint_service_proto_list.json index f987b709de8..2d74caf069f 100644 --- a/packages/google-cloud-aiplatform/src/v1/endpoint_service_proto_list.json +++ b/packages/google-cloud-aiplatform/src/v1/endpoint_service_proto_list.json @@ -63,6 +63,8 @@ "../../protos/google/cloud/aiplatform/v1/prediction_service.proto", "../../protos/google/cloud/aiplatform/v1/publisher_model.proto", "../../protos/google/cloud/aiplatform/v1/saved_query.proto", + "../../protos/google/cloud/aiplatform/v1/schedule.proto", + "../../protos/google/cloud/aiplatform/v1/schedule_service.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_classification.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_object_detection.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_segmentation.proto", diff --git a/packages/google-cloud-aiplatform/src/v1/featurestore_online_serving_service_client.ts b/packages/google-cloud-aiplatform/src/v1/featurestore_online_serving_service_client.ts index 478b7364256..34af0481249 100644 --- a/packages/google-cloud-aiplatform/src/v1/featurestore_online_serving_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1/featurestore_online_serving_service_client.ts @@ -275,6 +275,9 @@ export class FeaturestoreOnlineServingServiceClient { savedQueryPathTemplate: new this._gaxModule.PathTemplate( 'projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}' ), + schedulePathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/schedules/{schedule}' + ), specialistPoolPathTemplate: new this._gaxModule.PathTemplate( 'projects/{project}/locations/{location}/specialistPools/{specialist_pool}' ), @@ -481,9 +484,8 @@ export class FeaturestoreOnlineServingServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.ReadFeatureValuesResponse | ReadFeatureValuesResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.ReadFeatureValuesResponse|ReadFeatureValuesResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/featurestore_online_serving_service.read_feature_values.js * region_tag:aiplatform_v1_generated_FeaturestoreOnlineServingService_ReadFeatureValues_async @@ -584,9 +586,8 @@ export class FeaturestoreOnlineServingServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.WriteFeatureValuesResponse | WriteFeatureValuesResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.WriteFeatureValuesResponse|WriteFeatureValuesResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/featurestore_online_serving_service.write_feature_values.js * region_tag:aiplatform_v1_generated_FeaturestoreOnlineServingService_WriteFeatureValues_async @@ -690,9 +691,8 @@ export class FeaturestoreOnlineServingServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits {@link google.cloud.aiplatform.v1.ReadFeatureValuesResponse | ReadFeatureValuesResponse} on 'data' event. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#server-streaming) + * An object stream which emits {@link protos.google.cloud.aiplatform.v1.ReadFeatureValuesResponse|ReadFeatureValuesResponse} on 'data' event. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#server-streaming | documentation } * for more details and examples. * @example include:samples/generated/v1/featurestore_online_serving_service.streaming_read_feature_values.js * region_tag:aiplatform_v1_generated_FeaturestoreOnlineServingService_StreamingReadFeatureValues_async @@ -752,7 +752,7 @@ export class FeaturestoreOnlineServingServiceClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -773,8 +773,7 @@ export class FeaturestoreOnlineServingServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -800,7 +799,7 @@ export class FeaturestoreOnlineServingServiceClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -821,8 +820,7 @@ export class FeaturestoreOnlineServingServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -849,7 +847,7 @@ export class FeaturestoreOnlineServingServiceClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -864,8 +862,7 @@ export class FeaturestoreOnlineServingServiceClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` @@ -911,12 +908,11 @@ export class FeaturestoreOnlineServingServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` @@ -2810,6 +2806,55 @@ export class FeaturestoreOnlineServingServiceClient { .saved_query; } + /** + * Return a fully-qualified schedule resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} schedule + * @returns {string} Resource name string. + */ + schedulePath(project: string, location: string, schedule: string) { + return this.pathTemplates.schedulePathTemplate.render({ + project: project, + location: location, + schedule: schedule, + }); + } + + /** + * Parse the project from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the project. + */ + matchProjectFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).project; + } + + /** + * Parse the location from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the location. + */ + matchLocationFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).location; + } + + /** + * Parse the schedule from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the schedule. + */ + matchScheduleFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).schedule; + } + /** * Return a fully-qualified specialistPool resource name string. * diff --git a/packages/google-cloud-aiplatform/src/v1/featurestore_online_serving_service_proto_list.json b/packages/google-cloud-aiplatform/src/v1/featurestore_online_serving_service_proto_list.json index f987b709de8..2d74caf069f 100644 --- a/packages/google-cloud-aiplatform/src/v1/featurestore_online_serving_service_proto_list.json +++ b/packages/google-cloud-aiplatform/src/v1/featurestore_online_serving_service_proto_list.json @@ -63,6 +63,8 @@ "../../protos/google/cloud/aiplatform/v1/prediction_service.proto", "../../protos/google/cloud/aiplatform/v1/publisher_model.proto", "../../protos/google/cloud/aiplatform/v1/saved_query.proto", + "../../protos/google/cloud/aiplatform/v1/schedule.proto", + "../../protos/google/cloud/aiplatform/v1/schedule_service.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_classification.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_object_detection.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_segmentation.proto", diff --git a/packages/google-cloud-aiplatform/src/v1/featurestore_service_client.ts b/packages/google-cloud-aiplatform/src/v1/featurestore_service_client.ts index 880fc45d19f..e9a7866c326 100644 --- a/packages/google-cloud-aiplatform/src/v1/featurestore_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1/featurestore_service_client.ts @@ -285,6 +285,9 @@ export class FeaturestoreServiceClient { savedQueryPathTemplate: new this._gaxModule.PathTemplate( 'projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}' ), + schedulePathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/schedules/{schedule}' + ), specialistPoolPathTemplate: new this._gaxModule.PathTemplate( 'projects/{project}/locations/{location}/specialistPools/{specialist_pool}' ), @@ -1687,9 +1690,8 @@ export class FeaturestoreServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.Featurestore | Featurestore}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.Featurestore|Featurestore}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/featurestore_service.get_featurestore.js * region_tag:aiplatform_v1_generated_FeaturestoreService_GetFeaturestore_async @@ -1780,9 +1782,8 @@ export class FeaturestoreServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.EntityType | EntityType}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.EntityType|EntityType}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/featurestore_service.get_entity_type.js * region_tag:aiplatform_v1_generated_FeaturestoreService_GetEntityType_async @@ -1894,9 +1895,8 @@ export class FeaturestoreServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.EntityType | EntityType}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.EntityType|EntityType}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/featurestore_service.update_entity_type.js * region_tag:aiplatform_v1_generated_FeaturestoreService_UpdateEntityType_async @@ -1987,9 +1987,8 @@ export class FeaturestoreServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.Feature | Feature}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.Feature|Feature}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/featurestore_service.get_feature.js * region_tag:aiplatform_v1_generated_FeaturestoreService_GetFeature_async @@ -2089,9 +2088,8 @@ export class FeaturestoreServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.Feature | Feature}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.Feature|Feature}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/featurestore_service.update_feature.js * region_tag:aiplatform_v1_generated_FeaturestoreService_UpdateFeature_async @@ -2196,8 +2194,7 @@ export class FeaturestoreServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/featurestore_service.create_featurestore.js * region_tag:aiplatform_v1_generated_FeaturestoreService_CreateFeaturestore_async @@ -2292,8 +2289,7 @@ export class FeaturestoreServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/featurestore_service.create_featurestore.js * region_tag:aiplatform_v1_generated_FeaturestoreService_CreateFeaturestore_async @@ -2351,8 +2347,7 @@ export class FeaturestoreServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/featurestore_service.update_featurestore.js * region_tag:aiplatform_v1_generated_FeaturestoreService_UpdateFeaturestore_async @@ -2447,8 +2442,7 @@ export class FeaturestoreServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/featurestore_service.update_featurestore.js * region_tag:aiplatform_v1_generated_FeaturestoreService_UpdateFeaturestore_async @@ -2496,8 +2490,7 @@ export class FeaturestoreServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/featurestore_service.delete_featurestore.js * region_tag:aiplatform_v1_generated_FeaturestoreService_DeleteFeaturestore_async @@ -2592,8 +2585,7 @@ export class FeaturestoreServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/featurestore_service.delete_featurestore.js * region_tag:aiplatform_v1_generated_FeaturestoreService_DeleteFeaturestore_async @@ -2646,8 +2638,7 @@ export class FeaturestoreServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/featurestore_service.create_entity_type.js * region_tag:aiplatform_v1_generated_FeaturestoreService_CreateEntityType_async @@ -2742,8 +2733,7 @@ export class FeaturestoreServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/featurestore_service.create_entity_type.js * region_tag:aiplatform_v1_generated_FeaturestoreService_CreateEntityType_async @@ -2790,8 +2780,7 @@ export class FeaturestoreServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/featurestore_service.delete_entity_type.js * region_tag:aiplatform_v1_generated_FeaturestoreService_DeleteEntityType_async @@ -2886,8 +2875,7 @@ export class FeaturestoreServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/featurestore_service.delete_entity_type.js * region_tag:aiplatform_v1_generated_FeaturestoreService_DeleteEntityType_async @@ -2940,8 +2928,7 @@ export class FeaturestoreServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/featurestore_service.create_feature.js * region_tag:aiplatform_v1_generated_FeaturestoreService_CreateFeature_async @@ -3036,8 +3023,7 @@ export class FeaturestoreServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/featurestore_service.create_feature.js * region_tag:aiplatform_v1_generated_FeaturestoreService_CreateFeature_async @@ -3086,8 +3072,7 @@ export class FeaturestoreServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/featurestore_service.batch_create_features.js * region_tag:aiplatform_v1_generated_FeaturestoreService_BatchCreateFeatures_async @@ -3182,8 +3167,7 @@ export class FeaturestoreServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/featurestore_service.batch_create_features.js * region_tag:aiplatform_v1_generated_FeaturestoreService_BatchCreateFeatures_async @@ -3226,8 +3210,7 @@ export class FeaturestoreServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/featurestore_service.delete_feature.js * region_tag:aiplatform_v1_generated_FeaturestoreService_DeleteFeature_async @@ -3322,8 +3305,7 @@ export class FeaturestoreServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/featurestore_service.delete_feature.js * region_tag:aiplatform_v1_generated_FeaturestoreService_DeleteFeature_async @@ -3414,8 +3396,7 @@ export class FeaturestoreServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/featurestore_service.import_feature_values.js * region_tag:aiplatform_v1_generated_FeaturestoreService_ImportFeatureValues_async @@ -3510,8 +3491,7 @@ export class FeaturestoreServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/featurestore_service.import_feature_values.js * region_tag:aiplatform_v1_generated_FeaturestoreService_ImportFeatureValues_async @@ -3603,8 +3583,7 @@ export class FeaturestoreServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/featurestore_service.batch_read_feature_values.js * region_tag:aiplatform_v1_generated_FeaturestoreService_BatchReadFeatureValues_async @@ -3703,8 +3682,7 @@ export class FeaturestoreServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/featurestore_service.batch_read_feature_values.js * region_tag:aiplatform_v1_generated_FeaturestoreService_BatchReadFeatureValues_async @@ -3759,8 +3737,7 @@ export class FeaturestoreServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/featurestore_service.export_feature_values.js * region_tag:aiplatform_v1_generated_FeaturestoreService_ExportFeatureValues_async @@ -3855,8 +3832,7 @@ export class FeaturestoreServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/featurestore_service.export_feature_values.js * region_tag:aiplatform_v1_generated_FeaturestoreService_ExportFeatureValues_async @@ -3913,8 +3889,7 @@ export class FeaturestoreServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/featurestore_service.delete_feature_values.js * region_tag:aiplatform_v1_generated_FeaturestoreService_DeleteFeatureValues_async @@ -4009,8 +3984,7 @@ export class FeaturestoreServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/featurestore_service.delete_feature_values.js * region_tag:aiplatform_v1_generated_FeaturestoreService_DeleteFeatureValues_async @@ -4074,11 +4048,11 @@ export class FeaturestoreServiceClient { * coerced to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} + * {@link protos.google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} + * {@link protos.google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} * must match the call that provided the page token. * @param {string} request.orderBy * A comma-separated list of fields to order by, sorted in ascending order. @@ -4093,14 +4067,13 @@ export class FeaturestoreServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1.Featurestore | Featurestore}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.Featurestore|Featurestore}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listFeaturestoresAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listFeaturestores( @@ -4213,11 +4186,11 @@ export class FeaturestoreServiceClient { * coerced to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} + * {@link protos.google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} + * {@link protos.google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} * must match the call that provided the page token. * @param {string} request.orderBy * A comma-separated list of fields to order by, sorted in ascending order. @@ -4232,13 +4205,12 @@ export class FeaturestoreServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1.Featurestore | Featurestore} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.Featurestore|Featurestore} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listFeaturestoresAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listFeaturestoresStream( @@ -4300,11 +4272,11 @@ export class FeaturestoreServiceClient { * coerced to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} + * {@link protos.google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} + * {@link protos.google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} * must match the call that provided the page token. * @param {string} request.orderBy * A comma-separated list of fields to order by, sorted in ascending order. @@ -4319,12 +4291,11 @@ export class FeaturestoreServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1.Featurestore | Featurestore}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1.Featurestore|Featurestore}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/featurestore_service.list_featurestores.js * region_tag:aiplatform_v1_generated_FeaturestoreService_ListFeaturestores_async @@ -4385,11 +4356,11 @@ export class FeaturestoreServiceClient { * 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} + * {@link protos.google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} + * {@link protos.google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} * must match the call that provided the page token. * @param {string} request.orderBy * A comma-separated list of fields to order by, sorted in ascending order. @@ -4405,14 +4376,13 @@ export class FeaturestoreServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1.EntityType | EntityType}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.EntityType|EntityType}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listEntityTypesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listEntityTypes( @@ -4524,11 +4494,11 @@ export class FeaturestoreServiceClient { * 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} + * {@link protos.google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} + * {@link protos.google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} * must match the call that provided the page token. * @param {string} request.orderBy * A comma-separated list of fields to order by, sorted in ascending order. @@ -4544,13 +4514,12 @@ export class FeaturestoreServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1.EntityType | EntityType} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.EntityType|EntityType} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listEntityTypesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listEntityTypesStream( @@ -4611,11 +4580,11 @@ export class FeaturestoreServiceClient { * 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} + * {@link protos.google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} + * {@link protos.google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} * must match the call that provided the page token. * @param {string} request.orderBy * A comma-separated list of fields to order by, sorted in ascending order. @@ -4631,12 +4600,11 @@ export class FeaturestoreServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1.EntityType | EntityType}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1.EntityType|EntityType}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/featurestore_service.list_entity_types.js * region_tag:aiplatform_v1_generated_FeaturestoreService_ListEntityTypes_async @@ -4699,11 +4667,11 @@ export class FeaturestoreServiceClient { * 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} + * {@link protos.google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} + * {@link protos.google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} * must match the call that provided the page token. * @param {string} request.orderBy * A comma-separated list of fields to order by, sorted in ascending order. @@ -4718,22 +4686,21 @@ export class FeaturestoreServiceClient { * Mask specifying which fields to read. * @param {number} request.latestStatsCount * If set, return the most recent - * {@link google.cloud.aiplatform.v1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count} + * {@link protos.google.cloud.aiplatform.v1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count} * of stats for each Feature in response. Valid value is [0, 10]. If number of * stats exists < - * {@link google.cloud.aiplatform.v1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count}, + * {@link protos.google.cloud.aiplatform.v1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count}, * return all existing stats. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1.Feature | Feature}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.Feature|Feature}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listFeaturesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listFeatures( @@ -4847,11 +4814,11 @@ export class FeaturestoreServiceClient { * 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} + * {@link protos.google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} + * {@link protos.google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} * must match the call that provided the page token. * @param {string} request.orderBy * A comma-separated list of fields to order by, sorted in ascending order. @@ -4866,21 +4833,20 @@ export class FeaturestoreServiceClient { * Mask specifying which fields to read. * @param {number} request.latestStatsCount * If set, return the most recent - * {@link google.cloud.aiplatform.v1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count} + * {@link protos.google.cloud.aiplatform.v1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count} * of stats for each Feature in response. Valid value is [0, 10]. If number of * stats exists < - * {@link google.cloud.aiplatform.v1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count}, + * {@link protos.google.cloud.aiplatform.v1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count}, * return all existing stats. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1.Feature | Feature} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.Feature|Feature} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listFeaturesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listFeaturesStream( @@ -4943,11 +4909,11 @@ export class FeaturestoreServiceClient { * 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} + * {@link protos.google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} + * {@link protos.google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} * must match the call that provided the page token. * @param {string} request.orderBy * A comma-separated list of fields to order by, sorted in ascending order. @@ -4962,20 +4928,19 @@ export class FeaturestoreServiceClient { * Mask specifying which fields to read. * @param {number} request.latestStatsCount * If set, return the most recent - * {@link google.cloud.aiplatform.v1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count} + * {@link protos.google.cloud.aiplatform.v1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count} * of stats for each Feature in response. Valid value is [0, 10]. If number of * stats exists < - * {@link google.cloud.aiplatform.v1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count}, + * {@link protos.google.cloud.aiplatform.v1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count}, * return all existing stats. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1.Feature | Feature}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1.Feature|Feature}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/featurestore_service.list_features.js * region_tag:aiplatform_v1_generated_FeaturestoreService_ListFeatures_async @@ -5078,23 +5043,22 @@ export class FeaturestoreServiceClient { * 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures} + * {@link protos.google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures}, + * {@link protos.google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures}, * except `page_size`, must match the call that provided the page token. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1.Feature | Feature}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.Feature|Feature}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `searchFeaturesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ searchFeatures( @@ -5248,22 +5212,21 @@ export class FeaturestoreServiceClient { * 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures} + * {@link protos.google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures}, + * {@link protos.google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures}, * except `page_size`, must match the call that provided the page token. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1.Feature | Feature} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.Feature|Feature} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `searchFeaturesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ searchFeaturesStream( @@ -5366,21 +5329,20 @@ export class FeaturestoreServiceClient { * 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures} + * {@link protos.google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures}, + * {@link protos.google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures}, * except `page_size`, must match the call that provided the page token. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1.Feature | Feature}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1.Feature|Feature}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/featurestore_service.search_features.js * region_tag:aiplatform_v1_generated_FeaturestoreService_SearchFeatures_async @@ -5445,7 +5407,7 @@ export class FeaturestoreServiceClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -5466,8 +5428,7 @@ export class FeaturestoreServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -5493,7 +5454,7 @@ export class FeaturestoreServiceClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -5514,8 +5475,7 @@ export class FeaturestoreServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -5542,7 +5502,7 @@ export class FeaturestoreServiceClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -5557,8 +5517,7 @@ export class FeaturestoreServiceClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` @@ -5604,12 +5563,11 @@ export class FeaturestoreServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` @@ -7737,6 +7695,55 @@ export class FeaturestoreServiceClient { .saved_query; } + /** + * Return a fully-qualified schedule resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} schedule + * @returns {string} Resource name string. + */ + schedulePath(project: string, location: string, schedule: string) { + return this.pathTemplates.schedulePathTemplate.render({ + project: project, + location: location, + schedule: schedule, + }); + } + + /** + * Parse the project from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the project. + */ + matchProjectFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).project; + } + + /** + * Parse the location from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the location. + */ + matchLocationFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).location; + } + + /** + * Parse the schedule from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the schedule. + */ + matchScheduleFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).schedule; + } + /** * Return a fully-qualified specialistPool resource name string. * diff --git a/packages/google-cloud-aiplatform/src/v1/featurestore_service_proto_list.json b/packages/google-cloud-aiplatform/src/v1/featurestore_service_proto_list.json index f987b709de8..2d74caf069f 100644 --- a/packages/google-cloud-aiplatform/src/v1/featurestore_service_proto_list.json +++ b/packages/google-cloud-aiplatform/src/v1/featurestore_service_proto_list.json @@ -63,6 +63,8 @@ "../../protos/google/cloud/aiplatform/v1/prediction_service.proto", "../../protos/google/cloud/aiplatform/v1/publisher_model.proto", "../../protos/google/cloud/aiplatform/v1/saved_query.proto", + "../../protos/google/cloud/aiplatform/v1/schedule.proto", + "../../protos/google/cloud/aiplatform/v1/schedule_service.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_classification.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_object_detection.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_segmentation.proto", diff --git a/packages/google-cloud-aiplatform/src/v1/gapic_metadata.json b/packages/google-cloud-aiplatform/src/v1/gapic_metadata.json index fe8c2d64e4f..d7f520549b7 100644 --- a/packages/google-cloud-aiplatform/src/v1/gapic_metadata.json +++ b/packages/google-cloud-aiplatform/src/v1/gapic_metadata.json @@ -1929,6 +1929,11 @@ "methods": [ "explain" ] + }, + "ServerStreamingPredict": { + "methods": [ + "serverStreamingPredict" + ] } } }, @@ -1954,6 +1959,94 @@ } } }, + "ScheduleService": { + "clients": { + "grpc": { + "libraryClient": "ScheduleServiceClient", + "rpcs": { + "CreateSchedule": { + "methods": [ + "createSchedule" + ] + }, + "GetSchedule": { + "methods": [ + "getSchedule" + ] + }, + "PauseSchedule": { + "methods": [ + "pauseSchedule" + ] + }, + "ResumeSchedule": { + "methods": [ + "resumeSchedule" + ] + }, + "UpdateSchedule": { + "methods": [ + "updateSchedule" + ] + }, + "DeleteSchedule": { + "methods": [ + "deleteSchedule" + ] + }, + "ListSchedules": { + "methods": [ + "listSchedules", + "listSchedulesStream", + "listSchedulesAsync" + ] + } + } + }, + "grpc-fallback": { + "libraryClient": "ScheduleServiceClient", + "rpcs": { + "CreateSchedule": { + "methods": [ + "createSchedule" + ] + }, + "GetSchedule": { + "methods": [ + "getSchedule" + ] + }, + "PauseSchedule": { + "methods": [ + "pauseSchedule" + ] + }, + "ResumeSchedule": { + "methods": [ + "resumeSchedule" + ] + }, + "UpdateSchedule": { + "methods": [ + "updateSchedule" + ] + }, + "DeleteSchedule": { + "methods": [ + "deleteSchedule" + ] + }, + "ListSchedules": { + "methods": [ + "listSchedules", + "listSchedulesStream", + "listSchedulesAsync" + ] + } + } + } + } + }, "SpecialistPoolService": { "clients": { "grpc": { diff --git a/packages/google-cloud-aiplatform/src/v1/index.ts b/packages/google-cloud-aiplatform/src/v1/index.ts index 71b7ed96c15..7284a96fa8d 100644 --- a/packages/google-cloud-aiplatform/src/v1/index.ts +++ b/packages/google-cloud-aiplatform/src/v1/index.ts @@ -30,6 +30,7 @@ export {ModelGardenServiceClient} from './model_garden_service_client'; export {ModelServiceClient} from './model_service_client'; export {PipelineServiceClient} from './pipeline_service_client'; export {PredictionServiceClient} from './prediction_service_client'; +export {ScheduleServiceClient} from './schedule_service_client'; export {SpecialistPoolServiceClient} from './specialist_pool_service_client'; export {TensorboardServiceClient} from './tensorboard_service_client'; export {VizierServiceClient} from './vizier_service_client'; diff --git a/packages/google-cloud-aiplatform/src/v1/index_endpoint_service_client.ts b/packages/google-cloud-aiplatform/src/v1/index_endpoint_service_client.ts index bc161d3e46d..4c8412c6dc8 100644 --- a/packages/google-cloud-aiplatform/src/v1/index_endpoint_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1/index_endpoint_service_client.ts @@ -282,6 +282,9 @@ export class IndexEndpointServiceClient { savedQueryPathTemplate: new this._gaxModule.PathTemplate( 'projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}' ), + schedulePathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/schedules/{schedule}' + ), specialistPoolPathTemplate: new this._gaxModule.PathTemplate( 'projects/{project}/locations/{location}/specialistPools/{specialist_pool}' ), @@ -1577,9 +1580,8 @@ export class IndexEndpointServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.IndexEndpoint | IndexEndpoint}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.IndexEndpoint|IndexEndpoint}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/index_endpoint_service.get_index_endpoint.js * region_tag:aiplatform_v1_generated_IndexEndpointService_GetIndexEndpoint_async @@ -1667,13 +1669,12 @@ export class IndexEndpointServiceClient { * Required. The IndexEndpoint which replaces the resource on the server. * @param {google.protobuf.FieldMask} request.updateMask * Required. The update mask applies to the resource. See - * {@link google.protobuf.FieldMask|google.protobuf.FieldMask}. + * {@link protos.google.protobuf.FieldMask|google.protobuf.FieldMask}. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.IndexEndpoint | IndexEndpoint}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.IndexEndpoint|IndexEndpoint}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/index_endpoint_service.update_index_endpoint.js * region_tag:aiplatform_v1_generated_IndexEndpointService_UpdateIndexEndpoint_async @@ -1769,8 +1770,7 @@ export class IndexEndpointServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/index_endpoint_service.create_index_endpoint.js * region_tag:aiplatform_v1_generated_IndexEndpointService_CreateIndexEndpoint_async @@ -1865,8 +1865,7 @@ export class IndexEndpointServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/index_endpoint_service.create_index_endpoint.js * region_tag:aiplatform_v1_generated_IndexEndpointService_CreateIndexEndpoint_async @@ -1909,8 +1908,7 @@ export class IndexEndpointServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/index_endpoint_service.delete_index_endpoint.js * region_tag:aiplatform_v1_generated_IndexEndpointService_DeleteIndexEndpoint_async @@ -2005,8 +2003,7 @@ export class IndexEndpointServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/index_endpoint_service.delete_index_endpoint.js * region_tag:aiplatform_v1_generated_IndexEndpointService_DeleteIndexEndpoint_async @@ -2053,8 +2050,7 @@ export class IndexEndpointServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/index_endpoint_service.deploy_index.js * region_tag:aiplatform_v1_generated_IndexEndpointService_DeployIndex_async @@ -2149,8 +2145,7 @@ export class IndexEndpointServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/index_endpoint_service.deploy_index.js * region_tag:aiplatform_v1_generated_IndexEndpointService_DeployIndex_async @@ -2197,8 +2192,7 @@ export class IndexEndpointServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/index_endpoint_service.undeploy_index.js * region_tag:aiplatform_v1_generated_IndexEndpointService_UndeployIndex_async @@ -2293,8 +2287,7 @@ export class IndexEndpointServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/index_endpoint_service.undeploy_index.js * region_tag:aiplatform_v1_generated_IndexEndpointService_UndeployIndex_async @@ -2333,16 +2326,15 @@ export class IndexEndpointServiceClient { * `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}` * @param {google.cloud.aiplatform.v1.DeployedIndex} request.deployedIndex * Required. The DeployedIndex to be updated within the IndexEndpoint. - * Currently, the updatable fields are {@link automatic_resources|DeployedIndex} - * and {@link dedicated_resources|DeployedIndex} + * Currently, the updatable fields are {@link protos.automatic_resources|DeployedIndex} + * and {@link protos.dedicated_resources|DeployedIndex} * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/index_endpoint_service.mutate_deployed_index.js * region_tag:aiplatform_v1_generated_IndexEndpointService_MutateDeployedIndex_async @@ -2437,8 +2429,7 @@ export class IndexEndpointServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/index_endpoint_service.mutate_deployed_index.js * region_tag:aiplatform_v1_generated_IndexEndpointService_MutateDeployedIndex_async @@ -2480,7 +2471,7 @@ export class IndexEndpointServiceClient { * * * `index_endpoint` supports = and !=. `index_endpoint` represents the * IndexEndpoint ID, ie. the last segment of the IndexEndpoint's - * {@link google.cloud.aiplatform.v1.IndexEndpoint.name|resourcename}. + * {@link protos.google.cloud.aiplatform.v1.IndexEndpoint.name|resourcename}. * * `display_name` supports =, != and regex() * (uses [re2](https://github.com/google/re2/wiki/Syntax) syntax) * * `labels` supports general map functions that is: @@ -2498,23 +2489,22 @@ export class IndexEndpointServiceClient { * @param {string} [request.pageToken] * Optional. The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListIndexEndpointsResponse.next_page_token|ListIndexEndpointsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1.ListIndexEndpointsResponse.next_page_token|ListIndexEndpointsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints|IndexEndpointService.ListIndexEndpoints} + * {@link protos.google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints|IndexEndpointService.ListIndexEndpoints} * call. * @param {google.protobuf.FieldMask} [request.readMask] * Optional. Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1.IndexEndpoint | IndexEndpoint}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.IndexEndpoint|IndexEndpoint}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listIndexEndpointsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listIndexEndpoints( @@ -2605,7 +2595,7 @@ export class IndexEndpointServiceClient { * * * `index_endpoint` supports = and !=. `index_endpoint` represents the * IndexEndpoint ID, ie. the last segment of the IndexEndpoint's - * {@link google.cloud.aiplatform.v1.IndexEndpoint.name|resourcename}. + * {@link protos.google.cloud.aiplatform.v1.IndexEndpoint.name|resourcename}. * * `display_name` supports =, != and regex() * (uses [re2](https://github.com/google/re2/wiki/Syntax) syntax) * * `labels` supports general map functions that is: @@ -2623,22 +2613,21 @@ export class IndexEndpointServiceClient { * @param {string} [request.pageToken] * Optional. The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListIndexEndpointsResponse.next_page_token|ListIndexEndpointsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1.ListIndexEndpointsResponse.next_page_token|ListIndexEndpointsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints|IndexEndpointService.ListIndexEndpoints} + * {@link protos.google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints|IndexEndpointService.ListIndexEndpoints} * call. * @param {google.protobuf.FieldMask} [request.readMask] * Optional. Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1.IndexEndpoint | IndexEndpoint} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.IndexEndpoint|IndexEndpoint} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listIndexEndpointsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listIndexEndpointsStream( @@ -2678,7 +2667,7 @@ export class IndexEndpointServiceClient { * * * `index_endpoint` supports = and !=. `index_endpoint` represents the * IndexEndpoint ID, ie. the last segment of the IndexEndpoint's - * {@link google.cloud.aiplatform.v1.IndexEndpoint.name|resourcename}. + * {@link protos.google.cloud.aiplatform.v1.IndexEndpoint.name|resourcename}. * * `display_name` supports =, != and regex() * (uses [re2](https://github.com/google/re2/wiki/Syntax) syntax) * * `labels` supports general map functions that is: @@ -2696,21 +2685,20 @@ export class IndexEndpointServiceClient { * @param {string} [request.pageToken] * Optional. The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListIndexEndpointsResponse.next_page_token|ListIndexEndpointsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1.ListIndexEndpointsResponse.next_page_token|ListIndexEndpointsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints|IndexEndpointService.ListIndexEndpoints} + * {@link protos.google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints|IndexEndpointService.ListIndexEndpoints} * call. * @param {google.protobuf.FieldMask} [request.readMask] * Optional. Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1.IndexEndpoint | IndexEndpoint}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1.IndexEndpoint|IndexEndpoint}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/index_endpoint_service.list_index_endpoints.js * region_tag:aiplatform_v1_generated_IndexEndpointService_ListIndexEndpoints_async @@ -2775,7 +2763,7 @@ export class IndexEndpointServiceClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -2796,8 +2784,7 @@ export class IndexEndpointServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -2823,7 +2810,7 @@ export class IndexEndpointServiceClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -2844,8 +2831,7 @@ export class IndexEndpointServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -2872,7 +2858,7 @@ export class IndexEndpointServiceClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -2887,8 +2873,7 @@ export class IndexEndpointServiceClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` @@ -2934,12 +2919,11 @@ export class IndexEndpointServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` @@ -5044,6 +5028,55 @@ export class IndexEndpointServiceClient { .saved_query; } + /** + * Return a fully-qualified schedule resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} schedule + * @returns {string} Resource name string. + */ + schedulePath(project: string, location: string, schedule: string) { + return this.pathTemplates.schedulePathTemplate.render({ + project: project, + location: location, + schedule: schedule, + }); + } + + /** + * Parse the project from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the project. + */ + matchProjectFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).project; + } + + /** + * Parse the location from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the location. + */ + matchLocationFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).location; + } + + /** + * Parse the schedule from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the schedule. + */ + matchScheduleFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).schedule; + } + /** * Return a fully-qualified specialistPool resource name string. * diff --git a/packages/google-cloud-aiplatform/src/v1/index_endpoint_service_proto_list.json b/packages/google-cloud-aiplatform/src/v1/index_endpoint_service_proto_list.json index f987b709de8..2d74caf069f 100644 --- a/packages/google-cloud-aiplatform/src/v1/index_endpoint_service_proto_list.json +++ b/packages/google-cloud-aiplatform/src/v1/index_endpoint_service_proto_list.json @@ -63,6 +63,8 @@ "../../protos/google/cloud/aiplatform/v1/prediction_service.proto", "../../protos/google/cloud/aiplatform/v1/publisher_model.proto", "../../protos/google/cloud/aiplatform/v1/saved_query.proto", + "../../protos/google/cloud/aiplatform/v1/schedule.proto", + "../../protos/google/cloud/aiplatform/v1/schedule_service.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_classification.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_object_detection.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_segmentation.proto", diff --git a/packages/google-cloud-aiplatform/src/v1/index_service_client.ts b/packages/google-cloud-aiplatform/src/v1/index_service_client.ts index a9e91b97afd..94c71a26647 100644 --- a/packages/google-cloud-aiplatform/src/v1/index_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1/index_service_client.ts @@ -282,6 +282,9 @@ export class IndexServiceClient { savedQueryPathTemplate: new this._gaxModule.PathTemplate( 'projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}' ), + schedulePathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/schedules/{schedule}' + ), specialistPoolPathTemplate: new this._gaxModule.PathTemplate( 'projects/{project}/locations/{location}/specialistPools/{specialist_pool}' ), @@ -1554,9 +1557,8 @@ export class IndexServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.Index | Index}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.Index|Index}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/index_service.get_index.js * region_tag:aiplatform_v1_generated_IndexService_GetIndex_async @@ -1641,9 +1643,8 @@ export class IndexServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.UpsertDatapointsResponse | UpsertDatapointsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.UpsertDatapointsResponse|UpsertDatapointsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/index_service.upsert_datapoints.js * region_tag:aiplatform_v1_generated_IndexService_UpsertDatapoints_async @@ -1736,9 +1737,8 @@ export class IndexServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.RemoveDatapointsResponse | RemoveDatapointsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.RemoveDatapointsResponse|RemoveDatapointsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/index_service.remove_datapoints.js * region_tag:aiplatform_v1_generated_IndexService_RemoveDatapoints_async @@ -1834,8 +1834,7 @@ export class IndexServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/index_service.create_index.js * region_tag:aiplatform_v1_generated_IndexService_CreateIndex_async @@ -1930,8 +1929,7 @@ export class IndexServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/index_service.create_index.js * region_tag:aiplatform_v1_generated_IndexService_CreateIndex_async @@ -1969,15 +1967,14 @@ export class IndexServiceClient { * @param {google.protobuf.FieldMask} request.updateMask * The update mask applies to the resource. * For the `FieldMask` definition, see - * {@link google.protobuf.FieldMask|google.protobuf.FieldMask}. + * {@link protos.google.protobuf.FieldMask|google.protobuf.FieldMask}. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/index_service.update_index.js * region_tag:aiplatform_v1_generated_IndexService_UpdateIndex_async @@ -2072,8 +2069,7 @@ export class IndexServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/index_service.update_index.js * region_tag:aiplatform_v1_generated_IndexService_UpdateIndex_async @@ -2104,7 +2100,7 @@ export class IndexServiceClient { /** * Deletes an Index. * An Index can only be deleted when all its - * {@link google.cloud.aiplatform.v1.Index.deployed_indexes|DeployedIndexes} had + * {@link protos.google.cloud.aiplatform.v1.Index.deployed_indexes|DeployedIndexes} had * been undeployed. * * @param {Object} request @@ -2119,8 +2115,7 @@ export class IndexServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/index_service.delete_index.js * region_tag:aiplatform_v1_generated_IndexService_DeleteIndex_async @@ -2215,8 +2210,7 @@ export class IndexServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/index_service.delete_index.js * region_tag:aiplatform_v1_generated_IndexService_DeleteIndex_async @@ -2259,23 +2253,22 @@ export class IndexServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListIndexesResponse.next_page_token|ListIndexesResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1.ListIndexesResponse.next_page_token|ListIndexesResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.IndexService.ListIndexes|IndexService.ListIndexes} + * {@link protos.google.cloud.aiplatform.v1.IndexService.ListIndexes|IndexService.ListIndexes} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1.Index | Index}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.Index|Index}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listIndexesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listIndexes( @@ -2361,22 +2354,21 @@ export class IndexServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListIndexesResponse.next_page_token|ListIndexesResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1.ListIndexesResponse.next_page_token|ListIndexesResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.IndexService.ListIndexes|IndexService.ListIndexes} + * {@link protos.google.cloud.aiplatform.v1.IndexService.ListIndexes|IndexService.ListIndexes} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1.Index | Index} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.Index|Index} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listIndexesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listIndexesStream( @@ -2417,21 +2409,20 @@ export class IndexServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListIndexesResponse.next_page_token|ListIndexesResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1.ListIndexesResponse.next_page_token|ListIndexesResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.IndexService.ListIndexes|IndexService.ListIndexes} + * {@link protos.google.cloud.aiplatform.v1.IndexService.ListIndexes|IndexService.ListIndexes} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1.Index | Index}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1.Index|Index}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/index_service.list_indexes.js * region_tag:aiplatform_v1_generated_IndexService_ListIndexes_async @@ -2496,7 +2487,7 @@ export class IndexServiceClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -2517,8 +2508,7 @@ export class IndexServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -2544,7 +2534,7 @@ export class IndexServiceClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -2565,8 +2555,7 @@ export class IndexServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -2593,7 +2582,7 @@ export class IndexServiceClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -2608,8 +2597,7 @@ export class IndexServiceClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` @@ -2655,12 +2643,11 @@ export class IndexServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` @@ -4765,6 +4752,55 @@ export class IndexServiceClient { .saved_query; } + /** + * Return a fully-qualified schedule resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} schedule + * @returns {string} Resource name string. + */ + schedulePath(project: string, location: string, schedule: string) { + return this.pathTemplates.schedulePathTemplate.render({ + project: project, + location: location, + schedule: schedule, + }); + } + + /** + * Parse the project from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the project. + */ + matchProjectFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).project; + } + + /** + * Parse the location from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the location. + */ + matchLocationFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).location; + } + + /** + * Parse the schedule from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the schedule. + */ + matchScheduleFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).schedule; + } + /** * Return a fully-qualified specialistPool resource name string. * diff --git a/packages/google-cloud-aiplatform/src/v1/index_service_proto_list.json b/packages/google-cloud-aiplatform/src/v1/index_service_proto_list.json index f987b709de8..2d74caf069f 100644 --- a/packages/google-cloud-aiplatform/src/v1/index_service_proto_list.json +++ b/packages/google-cloud-aiplatform/src/v1/index_service_proto_list.json @@ -63,6 +63,8 @@ "../../protos/google/cloud/aiplatform/v1/prediction_service.proto", "../../protos/google/cloud/aiplatform/v1/publisher_model.proto", "../../protos/google/cloud/aiplatform/v1/saved_query.proto", + "../../protos/google/cloud/aiplatform/v1/schedule.proto", + "../../protos/google/cloud/aiplatform/v1/schedule_service.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_classification.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_object_detection.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_segmentation.proto", diff --git a/packages/google-cloud-aiplatform/src/v1/job_service_client.ts b/packages/google-cloud-aiplatform/src/v1/job_service_client.ts index 38b82871e82..199456e4209 100644 --- a/packages/google-cloud-aiplatform/src/v1/job_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1/job_service_client.ts @@ -282,6 +282,9 @@ export class JobServiceClient { savedQueryPathTemplate: new this._gaxModule.PathTemplate( 'projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}' ), + schedulePathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/schedules/{schedule}' + ), specialistPoolPathTemplate: new this._gaxModule.PathTemplate( 'projects/{project}/locations/{location}/specialistPools/{specialist_pool}' ), @@ -1687,9 +1690,8 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.CustomJob | CustomJob}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.CustomJob|CustomJob}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.create_custom_job.js * region_tag:aiplatform_v1_generated_JobService_CreateCustomJob_async @@ -1780,9 +1782,8 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.CustomJob | CustomJob}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.CustomJob|CustomJob}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.get_custom_job.js * region_tag:aiplatform_v1_generated_JobService_GetCustomJob_async @@ -1860,14 +1861,14 @@ export class JobServiceClient { * Starts asynchronous cancellation on the CustomJob. The server * makes a best effort to cancel the job, but success is not * guaranteed. Clients can use - * {@link google.cloud.aiplatform.v1.JobService.GetCustomJob|JobService.GetCustomJob} + * {@link protos.google.cloud.aiplatform.v1.JobService.GetCustomJob|JobService.GetCustomJob} * or other methods to check whether the cancellation succeeded or whether the * job completed despite cancellation. On successful cancellation, * the CustomJob is not deleted; instead it becomes a job with - * a {@link google.cloud.aiplatform.v1.CustomJob.error|CustomJob.error} value with - * a {@link google.rpc.Status.code|google.rpc.Status.code} of 1, corresponding to + * a {@link protos.google.cloud.aiplatform.v1.CustomJob.error|CustomJob.error} value with + * a {@link protos.google.rpc.Status.code|google.rpc.Status.code} of 1, corresponding to * `Code.CANCELLED`, and - * {@link google.cloud.aiplatform.v1.CustomJob.state|CustomJob.state} is set to + * {@link protos.google.cloud.aiplatform.v1.CustomJob.state|CustomJob.state} is set to * `CANCELLED`. * * @param {Object} request @@ -1879,9 +1880,8 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.protobuf.Empty | Empty}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.cancel_custom_job.js * region_tag:aiplatform_v1_generated_JobService_CancelCustomJob_async @@ -1973,9 +1973,8 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.DataLabelingJob | DataLabelingJob}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.DataLabelingJob|DataLabelingJob}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.create_data_labeling_job.js * region_tag:aiplatform_v1_generated_JobService_CreateDataLabelingJob_async @@ -2072,9 +2071,8 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.DataLabelingJob | DataLabelingJob}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.DataLabelingJob|DataLabelingJob}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.get_data_labeling_job.js * region_tag:aiplatform_v1_generated_JobService_GetDataLabelingJob_async @@ -2165,9 +2163,8 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.protobuf.Empty | Empty}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.cancel_data_labeling_job.js * region_tag:aiplatform_v1_generated_JobService_CancelDataLabelingJob_async @@ -2266,9 +2263,8 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.HyperparameterTuningJob | HyperparameterTuningJob}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.HyperparameterTuningJob|HyperparameterTuningJob}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.create_hyperparameter_tuning_job.js * region_tag:aiplatform_v1_generated_JobService_CreateHyperparameterTuningJob_async @@ -2369,9 +2365,8 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.HyperparameterTuningJob | HyperparameterTuningJob}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.HyperparameterTuningJob|HyperparameterTuningJob}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.get_hyperparameter_tuning_job.js * region_tag:aiplatform_v1_generated_JobService_GetHyperparameterTuningJob_async @@ -2465,15 +2460,15 @@ export class JobServiceClient { * Starts asynchronous cancellation on the HyperparameterTuningJob. The server * makes a best effort to cancel the job, but success is not * guaranteed. Clients can use - * {@link google.cloud.aiplatform.v1.JobService.GetHyperparameterTuningJob|JobService.GetHyperparameterTuningJob} + * {@link protos.google.cloud.aiplatform.v1.JobService.GetHyperparameterTuningJob|JobService.GetHyperparameterTuningJob} * or other methods to check whether the cancellation succeeded or whether the * job completed despite cancellation. On successful cancellation, * the HyperparameterTuningJob is not deleted; instead it becomes a job with * a - * {@link google.cloud.aiplatform.v1.HyperparameterTuningJob.error|HyperparameterTuningJob.error} - * value with a {@link google.rpc.Status.code|google.rpc.Status.code} of 1, + * {@link protos.google.cloud.aiplatform.v1.HyperparameterTuningJob.error|HyperparameterTuningJob.error} + * value with a {@link protos.google.rpc.Status.code|google.rpc.Status.code} of 1, * corresponding to `Code.CANCELLED`, and - * {@link google.cloud.aiplatform.v1.HyperparameterTuningJob.state|HyperparameterTuningJob.state} + * {@link protos.google.cloud.aiplatform.v1.HyperparameterTuningJob.state|HyperparameterTuningJob.state} * is set to `CANCELLED`. * * @param {Object} request @@ -2485,9 +2480,8 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.protobuf.Empty | Empty}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.cancel_hyperparameter_tuning_job.js * region_tag:aiplatform_v1_generated_JobService_CancelHyperparameterTuningJob_async @@ -2589,9 +2583,8 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.NasJob | NasJob}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.NasJob|NasJob}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.create_nas_job.js * region_tag:aiplatform_v1_generated_JobService_CreateNasJob_async @@ -2676,9 +2669,8 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.NasJob | NasJob}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.NasJob|NasJob}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.get_nas_job.js * region_tag:aiplatform_v1_generated_JobService_GetNasJob_async @@ -2756,14 +2748,14 @@ export class JobServiceClient { * Starts asynchronous cancellation on the NasJob. The server * makes a best effort to cancel the job, but success is not * guaranteed. Clients can use - * {@link google.cloud.aiplatform.v1.JobService.GetNasJob|JobService.GetNasJob} or + * {@link protos.google.cloud.aiplatform.v1.JobService.GetNasJob|JobService.GetNasJob} or * other methods to check whether the cancellation succeeded or whether the * job completed despite cancellation. On successful cancellation, * the NasJob is not deleted; instead it becomes a job with - * a {@link google.cloud.aiplatform.v1.NasJob.error|NasJob.error} value with a - * {@link google.rpc.Status.code|google.rpc.Status.code} of 1, corresponding to + * a {@link protos.google.cloud.aiplatform.v1.NasJob.error|NasJob.error} value with a + * {@link protos.google.rpc.Status.code|google.rpc.Status.code} of 1, corresponding to * `Code.CANCELLED`, and - * {@link google.cloud.aiplatform.v1.NasJob.state|NasJob.state} is set to + * {@link protos.google.cloud.aiplatform.v1.NasJob.state|NasJob.state} is set to * `CANCELLED`. * * @param {Object} request @@ -2775,9 +2767,8 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.protobuf.Empty | Empty}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.cancel_nas_job.js * region_tag:aiplatform_v1_generated_JobService_CancelNasJob_async @@ -2862,9 +2853,8 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.NasTrialDetail | NasTrialDetail}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.NasTrialDetail|NasTrialDetail}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.get_nas_trial_detail.js * region_tag:aiplatform_v1_generated_JobService_GetNasTrialDetail_async @@ -2957,9 +2947,8 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.BatchPredictionJob | BatchPredictionJob}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.BatchPredictionJob|BatchPredictionJob}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.create_batch_prediction_job.js * region_tag:aiplatform_v1_generated_JobService_CreateBatchPredictionJob_async @@ -3060,9 +3049,8 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.BatchPredictionJob | BatchPredictionJob}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.BatchPredictionJob|BatchPredictionJob}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.get_batch_prediction_job.js * region_tag:aiplatform_v1_generated_JobService_GetBatchPredictionJob_async @@ -3153,11 +3141,11 @@ export class JobServiceClient { * Starts asynchronous cancellation on the BatchPredictionJob. The server * makes the best effort to cancel the job, but success is not * guaranteed. Clients can use - * {@link google.cloud.aiplatform.v1.JobService.GetBatchPredictionJob|JobService.GetBatchPredictionJob} + * {@link protos.google.cloud.aiplatform.v1.JobService.GetBatchPredictionJob|JobService.GetBatchPredictionJob} * or other methods to check whether the cancellation succeeded or whether the * job completed despite cancellation. On a successful cancellation, * the BatchPredictionJob is not deleted;instead its - * {@link google.cloud.aiplatform.v1.BatchPredictionJob.state|BatchPredictionJob.state} + * {@link protos.google.cloud.aiplatform.v1.BatchPredictionJob.state|BatchPredictionJob.state} * is set to `CANCELLED`. Any files already outputted by the job are not * deleted. * @@ -3170,9 +3158,8 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.protobuf.Empty | Empty}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.cancel_batch_prediction_job.js * region_tag:aiplatform_v1_generated_JobService_CancelBatchPredictionJob_async @@ -3275,9 +3262,8 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob | ModelDeploymentMonitoringJob}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob|ModelDeploymentMonitoringJob}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.create_model_deployment_monitoring_job.js * region_tag:aiplatform_v1_generated_JobService_CreateModelDeploymentMonitoringJob_async @@ -3378,9 +3364,8 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob | ModelDeploymentMonitoringJob}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob|ModelDeploymentMonitoringJob}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.get_model_deployment_monitoring_job.js * region_tag:aiplatform_v1_generated_JobService_GetModelDeploymentMonitoringJob_async @@ -3472,7 +3457,7 @@ export class JobServiceClient { /** * Pauses a ModelDeploymentMonitoringJob. If the job is running, the server * makes a best effort to cancel the job. Will mark - * {@link google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob.state|ModelDeploymentMonitoringJob.state} + * {@link protos.google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob.state|ModelDeploymentMonitoringJob.state} * to 'PAUSED'. * * @param {Object} request @@ -3484,9 +3469,8 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.protobuf.Empty | Empty}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.pause_model_deployment_monitoring_job.js * region_tag:aiplatform_v1_generated_JobService_PauseModelDeploymentMonitoringJob_async @@ -3589,9 +3573,8 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.protobuf.Empty | Empty}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.resume_model_deployment_monitoring_job.js * region_tag:aiplatform_v1_generated_JobService_ResumeModelDeploymentMonitoringJob_async @@ -3696,8 +3679,7 @@ export class JobServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.delete_custom_job.js * region_tag:aiplatform_v1_generated_JobService_DeleteCustomJob_async @@ -3792,8 +3774,7 @@ export class JobServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.delete_custom_job.js * region_tag:aiplatform_v1_generated_JobService_DeleteCustomJob_async @@ -3836,8 +3817,7 @@ export class JobServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.delete_data_labeling_job.js * region_tag:aiplatform_v1_generated_JobService_DeleteDataLabelingJob_async @@ -3932,8 +3912,7 @@ export class JobServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.delete_data_labeling_job.js * region_tag:aiplatform_v1_generated_JobService_DeleteDataLabelingJob_async @@ -3976,8 +3955,7 @@ export class JobServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.delete_hyperparameter_tuning_job.js * region_tag:aiplatform_v1_generated_JobService_DeleteHyperparameterTuningJob_async @@ -4076,8 +4054,7 @@ export class JobServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.delete_hyperparameter_tuning_job.js * region_tag:aiplatform_v1_generated_JobService_DeleteHyperparameterTuningJob_async @@ -4120,8 +4097,7 @@ export class JobServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.delete_nas_job.js * region_tag:aiplatform_v1_generated_JobService_DeleteNasJob_async @@ -4216,8 +4192,7 @@ export class JobServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.delete_nas_job.js * region_tag:aiplatform_v1_generated_JobService_DeleteNasJob_async @@ -4261,8 +4236,7 @@ export class JobServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.delete_batch_prediction_job.js * region_tag:aiplatform_v1_generated_JobService_DeleteBatchPredictionJob_async @@ -4361,8 +4335,7 @@ export class JobServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.delete_batch_prediction_job.js * region_tag:aiplatform_v1_generated_JobService_DeleteBatchPredictionJob_async @@ -4431,8 +4404,7 @@ export class JobServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.update_model_deployment_monitoring_job.js * region_tag:aiplatform_v1_generated_JobService_UpdateModelDeploymentMonitoringJob_async @@ -4532,8 +4504,7 @@ export class JobServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.update_model_deployment_monitoring_job.js * region_tag:aiplatform_v1_generated_JobService_UpdateModelDeploymentMonitoringJob_async @@ -4576,8 +4547,7 @@ export class JobServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.delete_model_deployment_monitoring_job.js * region_tag:aiplatform_v1_generated_JobService_DeleteModelDeploymentMonitoringJob_async @@ -4676,8 +4646,7 @@ export class JobServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.delete_model_deployment_monitoring_job.js * region_tag:aiplatform_v1_generated_JobService_DeleteModelDeploymentMonitoringJob_async @@ -4739,23 +4708,22 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListCustomJobsResponse.next_page_token|ListCustomJobsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1.ListCustomJobsResponse.next_page_token|ListCustomJobsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.JobService.ListCustomJobs|JobService.ListCustomJobs} + * {@link protos.google.cloud.aiplatform.v1.JobService.ListCustomJobs|JobService.ListCustomJobs} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1.CustomJob | CustomJob}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.CustomJob|CustomJob}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listCustomJobsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listCustomJobs( @@ -4866,22 +4834,21 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListCustomJobsResponse.next_page_token|ListCustomJobsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1.ListCustomJobsResponse.next_page_token|ListCustomJobsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.JobService.ListCustomJobs|JobService.ListCustomJobs} + * {@link protos.google.cloud.aiplatform.v1.JobService.ListCustomJobs|JobService.ListCustomJobs} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1.CustomJob | CustomJob} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.CustomJob|CustomJob} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listCustomJobsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listCustomJobsStream( @@ -4941,21 +4908,20 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListCustomJobsResponse.next_page_token|ListCustomJobsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1.ListCustomJobsResponse.next_page_token|ListCustomJobsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.JobService.ListCustomJobs|JobService.ListCustomJobs} + * {@link protos.google.cloud.aiplatform.v1.JobService.ListCustomJobs|JobService.ListCustomJobs} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1.CustomJob | CustomJob}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1.CustomJob|CustomJob}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.list_custom_jobs.js * region_tag:aiplatform_v1_generated_JobService_ListCustomJobs_async @@ -5026,14 +4992,13 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1.DataLabelingJob | DataLabelingJob}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.DataLabelingJob|DataLabelingJob}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listDataLabelingJobsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listDataLabelingJobs( @@ -5155,13 +5120,12 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1.DataLabelingJob | DataLabelingJob} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.DataLabelingJob|DataLabelingJob} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listDataLabelingJobsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listDataLabelingJobsStream( @@ -5232,12 +5196,11 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1.DataLabelingJob | DataLabelingJob}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1.DataLabelingJob|DataLabelingJob}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.list_data_labeling_jobs.js * region_tag:aiplatform_v1_generated_JobService_ListDataLabelingJobs_async @@ -5298,23 +5261,22 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListHyperparameterTuningJobsResponse.next_page_token|ListHyperparameterTuningJobsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1.ListHyperparameterTuningJobsResponse.next_page_token|ListHyperparameterTuningJobsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs|JobService.ListHyperparameterTuningJobs} + * {@link protos.google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs|JobService.ListHyperparameterTuningJobs} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1.HyperparameterTuningJob | HyperparameterTuningJob}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.HyperparameterTuningJob|HyperparameterTuningJob}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listHyperparameterTuningJobsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listHyperparameterTuningJobs( @@ -5430,22 +5392,21 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListHyperparameterTuningJobsResponse.next_page_token|ListHyperparameterTuningJobsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1.ListHyperparameterTuningJobsResponse.next_page_token|ListHyperparameterTuningJobsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs|JobService.ListHyperparameterTuningJobs} + * {@link protos.google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs|JobService.ListHyperparameterTuningJobs} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1.HyperparameterTuningJob | HyperparameterTuningJob} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.HyperparameterTuningJob|HyperparameterTuningJob} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listHyperparameterTuningJobsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listHyperparameterTuningJobsStream( @@ -5506,21 +5467,20 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListHyperparameterTuningJobsResponse.next_page_token|ListHyperparameterTuningJobsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1.ListHyperparameterTuningJobsResponse.next_page_token|ListHyperparameterTuningJobsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs|JobService.ListHyperparameterTuningJobs} + * {@link protos.google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs|JobService.ListHyperparameterTuningJobs} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1.HyperparameterTuningJob | HyperparameterTuningJob}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1.HyperparameterTuningJob|HyperparameterTuningJob}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.list_hyperparameter_tuning_jobs.js * region_tag:aiplatform_v1_generated_JobService_ListHyperparameterTuningJobs_async @@ -5580,23 +5540,22 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListNasJobsResponse.next_page_token|ListNasJobsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1.ListNasJobsResponse.next_page_token|ListNasJobsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.JobService.ListNasJobs|JobService.ListNasJobs} + * {@link protos.google.cloud.aiplatform.v1.JobService.ListNasJobs|JobService.ListNasJobs} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1.NasJob | NasJob}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.NasJob|NasJob}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listNasJobsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listNasJobs( @@ -5701,22 +5660,21 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListNasJobsResponse.next_page_token|ListNasJobsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1.ListNasJobsResponse.next_page_token|ListNasJobsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.JobService.ListNasJobs|JobService.ListNasJobs} + * {@link protos.google.cloud.aiplatform.v1.JobService.ListNasJobs|JobService.ListNasJobs} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1.NasJob | NasJob} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.NasJob|NasJob} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listNasJobsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listNasJobsStream( @@ -5776,21 +5734,20 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListNasJobsResponse.next_page_token|ListNasJobsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1.ListNasJobsResponse.next_page_token|ListNasJobsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.JobService.ListNasJobs|JobService.ListNasJobs} + * {@link protos.google.cloud.aiplatform.v1.JobService.ListNasJobs|JobService.ListNasJobs} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1.NasJob | NasJob}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1.NasJob|NasJob}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.list_nas_jobs.js * region_tag:aiplatform_v1_generated_JobService_ListNasJobs_async @@ -5830,21 +5787,20 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListNasTrialDetailsResponse.next_page_token|ListNasTrialDetailsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1.ListNasTrialDetailsResponse.next_page_token|ListNasTrialDetailsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.JobService.ListNasTrialDetails|JobService.ListNasTrialDetails} + * {@link protos.google.cloud.aiplatform.v1.JobService.ListNasTrialDetails|JobService.ListNasTrialDetails} * call. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1.NasTrialDetail | NasTrialDetail}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.NasTrialDetail|NasTrialDetail}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listNasTrialDetailsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listNasTrialDetails( @@ -5935,20 +5891,19 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListNasTrialDetailsResponse.next_page_token|ListNasTrialDetailsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1.ListNasTrialDetailsResponse.next_page_token|ListNasTrialDetailsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.JobService.ListNasTrialDetails|JobService.ListNasTrialDetails} + * {@link protos.google.cloud.aiplatform.v1.JobService.ListNasTrialDetails|JobService.ListNasTrialDetails} * call. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1.NasTrialDetail | NasTrialDetail} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.NasTrialDetail|NasTrialDetail} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listNasTrialDetailsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listNasTrialDetailsStream( @@ -5988,19 +5943,18 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListNasTrialDetailsResponse.next_page_token|ListNasTrialDetailsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1.ListNasTrialDetailsResponse.next_page_token|ListNasTrialDetailsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.JobService.ListNasTrialDetails|JobService.ListNasTrialDetails} + * {@link protos.google.cloud.aiplatform.v1.JobService.ListNasTrialDetails|JobService.ListNasTrialDetails} * call. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1.NasTrialDetail | NasTrialDetail}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1.NasTrialDetail|NasTrialDetail}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.list_nas_trial_details.js * region_tag:aiplatform_v1_generated_JobService_ListNasTrialDetails_async @@ -6061,23 +6015,22 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListBatchPredictionJobsResponse.next_page_token|ListBatchPredictionJobsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1.ListBatchPredictionJobsResponse.next_page_token|ListBatchPredictionJobsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.JobService.ListBatchPredictionJobs|JobService.ListBatchPredictionJobs} + * {@link protos.google.cloud.aiplatform.v1.JobService.ListBatchPredictionJobs|JobService.ListBatchPredictionJobs} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1.BatchPredictionJob | BatchPredictionJob}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.BatchPredictionJob|BatchPredictionJob}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listBatchPredictionJobsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listBatchPredictionJobs( @@ -6193,22 +6146,21 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListBatchPredictionJobsResponse.next_page_token|ListBatchPredictionJobsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1.ListBatchPredictionJobsResponse.next_page_token|ListBatchPredictionJobsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.JobService.ListBatchPredictionJobs|JobService.ListBatchPredictionJobs} + * {@link protos.google.cloud.aiplatform.v1.JobService.ListBatchPredictionJobs|JobService.ListBatchPredictionJobs} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1.BatchPredictionJob | BatchPredictionJob} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.BatchPredictionJob|BatchPredictionJob} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listBatchPredictionJobsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listBatchPredictionJobsStream( @@ -6269,21 +6221,20 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListBatchPredictionJobsResponse.next_page_token|ListBatchPredictionJobsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1.ListBatchPredictionJobsResponse.next_page_token|ListBatchPredictionJobsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.JobService.ListBatchPredictionJobs|JobService.ListBatchPredictionJobs} + * {@link protos.google.cloud.aiplatform.v1.JobService.ListBatchPredictionJobs|JobService.ListBatchPredictionJobs} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1.BatchPredictionJob | BatchPredictionJob}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1.BatchPredictionJob|BatchPredictionJob}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.list_batch_prediction_jobs.js * region_tag:aiplatform_v1_generated_JobService_ListBatchPredictionJobs_async @@ -6324,7 +6275,7 @@ export class JobServiceClient { * @param {string} request.featureDisplayName * The feature display name. If specified, only return the stats belonging to * this feature. Format: - * {@link google.cloud.aiplatform.v1.ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name|ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name}, + * {@link protos.google.cloud.aiplatform.v1.ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name|ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name}, * example: "user_destination". * @param {number[]} request.objectives * Required. Objectives of the stats to retrieve. @@ -6332,7 +6283,7 @@ export class JobServiceClient { * The standard list page size. * @param {string} request.pageToken * A page token received from a previous - * {@link google.cloud.aiplatform.v1.JobService.SearchModelDeploymentMonitoringStatsAnomalies|JobService.SearchModelDeploymentMonitoringStatsAnomalies} + * {@link protos.google.cloud.aiplatform.v1.JobService.SearchModelDeploymentMonitoringStatsAnomalies|JobService.SearchModelDeploymentMonitoringStatsAnomalies} * call. * @param {google.protobuf.Timestamp} request.startTime * The earliest timestamp of stats being generated. @@ -6343,14 +6294,13 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1.ModelMonitoringStatsAnomalies | ModelMonitoringStatsAnomalies}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.ModelMonitoringStatsAnomalies|ModelMonitoringStatsAnomalies}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `searchModelDeploymentMonitoringStatsAnomaliesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ searchModelDeploymentMonitoringStatsAnomalies( @@ -6447,7 +6397,7 @@ export class JobServiceClient { * @param {string} request.featureDisplayName * The feature display name. If specified, only return the stats belonging to * this feature. Format: - * {@link google.cloud.aiplatform.v1.ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name|ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name}, + * {@link protos.google.cloud.aiplatform.v1.ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name|ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name}, * example: "user_destination". * @param {number[]} request.objectives * Required. Objectives of the stats to retrieve. @@ -6455,7 +6405,7 @@ export class JobServiceClient { * The standard list page size. * @param {string} request.pageToken * A page token received from a previous - * {@link google.cloud.aiplatform.v1.JobService.SearchModelDeploymentMonitoringStatsAnomalies|JobService.SearchModelDeploymentMonitoringStatsAnomalies} + * {@link protos.google.cloud.aiplatform.v1.JobService.SearchModelDeploymentMonitoringStatsAnomalies|JobService.SearchModelDeploymentMonitoringStatsAnomalies} * call. * @param {google.protobuf.Timestamp} request.startTime * The earliest timestamp of stats being generated. @@ -6466,13 +6416,12 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1.ModelMonitoringStatsAnomalies | ModelMonitoringStatsAnomalies} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.ModelMonitoringStatsAnomalies|ModelMonitoringStatsAnomalies} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `searchModelDeploymentMonitoringStatsAnomaliesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ searchModelDeploymentMonitoringStatsAnomaliesStream( @@ -6516,7 +6465,7 @@ export class JobServiceClient { * @param {string} request.featureDisplayName * The feature display name. If specified, only return the stats belonging to * this feature. Format: - * {@link google.cloud.aiplatform.v1.ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name|ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name}, + * {@link protos.google.cloud.aiplatform.v1.ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name|ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name}, * example: "user_destination". * @param {number[]} request.objectives * Required. Objectives of the stats to retrieve. @@ -6524,7 +6473,7 @@ export class JobServiceClient { * The standard list page size. * @param {string} request.pageToken * A page token received from a previous - * {@link google.cloud.aiplatform.v1.JobService.SearchModelDeploymentMonitoringStatsAnomalies|JobService.SearchModelDeploymentMonitoringStatsAnomalies} + * {@link protos.google.cloud.aiplatform.v1.JobService.SearchModelDeploymentMonitoringStatsAnomalies|JobService.SearchModelDeploymentMonitoringStatsAnomalies} * call. * @param {google.protobuf.Timestamp} request.startTime * The earliest timestamp of stats being generated. @@ -6535,12 +6484,11 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1.ModelMonitoringStatsAnomalies | ModelMonitoringStatsAnomalies}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1.ModelMonitoringStatsAnomalies|ModelMonitoringStatsAnomalies}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.search_model_deployment_monitoring_stats_anomalies.js * region_tag:aiplatform_v1_generated_JobService_SearchModelDeploymentMonitoringStatsAnomalies_async @@ -6608,14 +6556,13 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob | ModelDeploymentMonitoringJob}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob|ModelDeploymentMonitoringJob}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listModelDeploymentMonitoringJobsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listModelDeploymentMonitoringJobs( @@ -6734,13 +6681,12 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob | ModelDeploymentMonitoringJob} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob|ModelDeploymentMonitoringJob} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listModelDeploymentMonitoringJobsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listModelDeploymentMonitoringJobsStream( @@ -6805,12 +6751,11 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob | ModelDeploymentMonitoringJob}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob|ModelDeploymentMonitoringJob}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/job_service.list_model_deployment_monitoring_jobs.js * region_tag:aiplatform_v1_generated_JobService_ListModelDeploymentMonitoringJobs_async @@ -6876,7 +6821,7 @@ export class JobServiceClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -6897,8 +6842,7 @@ export class JobServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -6924,7 +6868,7 @@ export class JobServiceClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -6945,8 +6889,7 @@ export class JobServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -6973,7 +6916,7 @@ export class JobServiceClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -6988,8 +6931,7 @@ export class JobServiceClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` @@ -7035,12 +6977,11 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` @@ -9145,6 +9086,55 @@ export class JobServiceClient { .saved_query; } + /** + * Return a fully-qualified schedule resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} schedule + * @returns {string} Resource name string. + */ + schedulePath(project: string, location: string, schedule: string) { + return this.pathTemplates.schedulePathTemplate.render({ + project: project, + location: location, + schedule: schedule, + }); + } + + /** + * Parse the project from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the project. + */ + matchProjectFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).project; + } + + /** + * Parse the location from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the location. + */ + matchLocationFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).location; + } + + /** + * Parse the schedule from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the schedule. + */ + matchScheduleFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).schedule; + } + /** * Return a fully-qualified specialistPool resource name string. * diff --git a/packages/google-cloud-aiplatform/src/v1/job_service_proto_list.json b/packages/google-cloud-aiplatform/src/v1/job_service_proto_list.json index f987b709de8..2d74caf069f 100644 --- a/packages/google-cloud-aiplatform/src/v1/job_service_proto_list.json +++ b/packages/google-cloud-aiplatform/src/v1/job_service_proto_list.json @@ -63,6 +63,8 @@ "../../protos/google/cloud/aiplatform/v1/prediction_service.proto", "../../protos/google/cloud/aiplatform/v1/publisher_model.proto", "../../protos/google/cloud/aiplatform/v1/saved_query.proto", + "../../protos/google/cloud/aiplatform/v1/schedule.proto", + "../../protos/google/cloud/aiplatform/v1/schedule_service.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_classification.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_object_detection.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_segmentation.proto", diff --git a/packages/google-cloud-aiplatform/src/v1/match_service_client.ts b/packages/google-cloud-aiplatform/src/v1/match_service_client.ts index d2a88144dd7..8c08ba21447 100644 --- a/packages/google-cloud-aiplatform/src/v1/match_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1/match_service_client.ts @@ -275,6 +275,9 @@ export class MatchServiceClient { savedQueryPathTemplate: new this._gaxModule.PathTemplate( 'projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}' ), + schedulePathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/schedules/{schedule}' + ), specialistPoolPathTemplate: new this._gaxModule.PathTemplate( 'projects/{project}/locations/{location}/specialistPools/{specialist_pool}' ), @@ -459,9 +462,8 @@ export class MatchServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.FindNeighborsResponse | FindNeighborsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.FindNeighborsResponse|FindNeighborsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/match_service.find_neighbors.js * region_tag:aiplatform_v1_generated_MatchService_FindNeighbors_async @@ -557,9 +559,8 @@ export class MatchServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.ReadIndexDatapointsResponse | ReadIndexDatapointsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.ReadIndexDatapointsResponse|ReadIndexDatapointsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/match_service.read_index_datapoints.js * region_tag:aiplatform_v1_generated_MatchService_ReadIndexDatapoints_async @@ -678,7 +679,7 @@ export class MatchServiceClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -699,8 +700,7 @@ export class MatchServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -726,7 +726,7 @@ export class MatchServiceClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -747,8 +747,7 @@ export class MatchServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -775,7 +774,7 @@ export class MatchServiceClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -790,8 +789,7 @@ export class MatchServiceClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` @@ -837,12 +835,11 @@ export class MatchServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` @@ -2736,6 +2733,55 @@ export class MatchServiceClient { .saved_query; } + /** + * Return a fully-qualified schedule resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} schedule + * @returns {string} Resource name string. + */ + schedulePath(project: string, location: string, schedule: string) { + return this.pathTemplates.schedulePathTemplate.render({ + project: project, + location: location, + schedule: schedule, + }); + } + + /** + * Parse the project from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the project. + */ + matchProjectFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).project; + } + + /** + * Parse the location from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the location. + */ + matchLocationFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).location; + } + + /** + * Parse the schedule from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the schedule. + */ + matchScheduleFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).schedule; + } + /** * Return a fully-qualified specialistPool resource name string. * diff --git a/packages/google-cloud-aiplatform/src/v1/match_service_proto_list.json b/packages/google-cloud-aiplatform/src/v1/match_service_proto_list.json index f987b709de8..2d74caf069f 100644 --- a/packages/google-cloud-aiplatform/src/v1/match_service_proto_list.json +++ b/packages/google-cloud-aiplatform/src/v1/match_service_proto_list.json @@ -63,6 +63,8 @@ "../../protos/google/cloud/aiplatform/v1/prediction_service.proto", "../../protos/google/cloud/aiplatform/v1/publisher_model.proto", "../../protos/google/cloud/aiplatform/v1/saved_query.proto", + "../../protos/google/cloud/aiplatform/v1/schedule.proto", + "../../protos/google/cloud/aiplatform/v1/schedule_service.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_classification.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_object_detection.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_segmentation.proto", diff --git a/packages/google-cloud-aiplatform/src/v1/metadata_service_client.ts b/packages/google-cloud-aiplatform/src/v1/metadata_service_client.ts index aa49975a75b..4bb4a90c75c 100644 --- a/packages/google-cloud-aiplatform/src/v1/metadata_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1/metadata_service_client.ts @@ -285,6 +285,9 @@ export class MetadataServiceClient { savedQueryPathTemplate: new this._gaxModule.PathTemplate( 'projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}' ), + schedulePathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/schedules/{schedule}' + ), specialistPoolPathTemplate: new this._gaxModule.PathTemplate( 'projects/{project}/locations/{location}/specialistPools/{specialist_pool}' ), @@ -1657,9 +1660,8 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.MetadataStore | MetadataStore}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.MetadataStore|MetadataStore}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/metadata_service.get_metadata_store.js * region_tag:aiplatform_v1_generated_MetadataService_GetMetadataStore_async @@ -1754,16 +1756,15 @@ export class MetadataServiceClient { * The {artifact} portion of the resource name with the format: * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` * If not provided, the Artifact's ID will be a UUID generated by the service. - * Must be 4-128 characters in length. Valid characters are `/{@link 0-9|a-z}-/`. + * Must be 4-128 characters in length. Valid characters are `/{@link protos.0-9|a-z}-/`. * Must be unique across all Artifacts in the parent MetadataStore. (Otherwise * the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the * caller can't view the preexisting Artifact.) * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.Artifact | Artifact}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.Artifact|Artifact}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/metadata_service.create_artifact.js * region_tag:aiplatform_v1_generated_MetadataService_CreateArtifact_async @@ -1854,9 +1855,8 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.Artifact | Artifact}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.Artifact|Artifact}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/metadata_service.get_artifact.js * region_tag:aiplatform_v1_generated_MetadataService_GetArtifact_async @@ -1936,21 +1936,20 @@ export class MetadataServiceClient { * The request object that will be sent. * @param {google.cloud.aiplatform.v1.Artifact} request.artifact * Required. The Artifact containing updates. - * The Artifact's {@link google.cloud.aiplatform.v1.Artifact.name|Artifact.name} + * The Artifact's {@link protos.google.cloud.aiplatform.v1.Artifact.name|Artifact.name} * field is used to identify the Artifact to be updated. Format: * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` * @param {google.protobuf.FieldMask} [request.updateMask] * Optional. A FieldMask indicating which fields should be updated. * @param {boolean} request.allowMissing - * If set to true, and the {@link google.cloud.aiplatform.v1.Artifact|Artifact} is - * not found, a new {@link google.cloud.aiplatform.v1.Artifact|Artifact} is + * If set to true, and the {@link protos.google.cloud.aiplatform.v1.Artifact|Artifact} is + * not found, a new {@link protos.google.cloud.aiplatform.v1.Artifact|Artifact} is * created. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.Artifact | Artifact}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.Artifact|Artifact}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/metadata_service.update_artifact.js * region_tag:aiplatform_v1_generated_MetadataService_UpdateArtifact_async @@ -2044,16 +2043,15 @@ export class MetadataServiceClient { * The {context} portion of the resource name with the format: * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`. * If not provided, the Context's ID will be a UUID generated by the service. - * Must be 4-128 characters in length. Valid characters are `/{@link 0-9|a-z}-/`. + * Must be 4-128 characters in length. Valid characters are `/{@link protos.0-9|a-z}-/`. * Must be unique across all Contexts in the parent MetadataStore. (Otherwise * the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the * caller can't view the preexisting Context.) * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.Context | Context}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.Context|Context}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/metadata_service.create_context.js * region_tag:aiplatform_v1_generated_MetadataService_CreateContext_async @@ -2144,9 +2142,8 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.Context | Context}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.Context|Context}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/metadata_service.get_context.js * region_tag:aiplatform_v1_generated_MetadataService_GetContext_async @@ -2226,20 +2223,19 @@ export class MetadataServiceClient { * The request object that will be sent. * @param {google.cloud.aiplatform.v1.Context} request.context * Required. The Context containing updates. - * The Context's {@link google.cloud.aiplatform.v1.Context.name|Context.name} field + * The Context's {@link protos.google.cloud.aiplatform.v1.Context.name|Context.name} field * is used to identify the Context to be updated. Format: * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}` * @param {google.protobuf.FieldMask} [request.updateMask] * Optional. A FieldMask indicating which fields should be updated. * @param {boolean} request.allowMissing - * If set to true, and the {@link google.cloud.aiplatform.v1.Context|Context} is - * not found, a new {@link google.cloud.aiplatform.v1.Context|Context} is created. + * If set to true, and the {@link protos.google.cloud.aiplatform.v1.Context|Context} is + * not found, a new {@link protos.google.cloud.aiplatform.v1.Context|Context} is created. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.Context | Context}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.Context|Context}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/metadata_service.update_context.js * region_tag:aiplatform_v1_generated_MetadataService_UpdateContext_async @@ -2343,9 +2339,8 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.AddContextArtifactsAndExecutionsResponse | AddContextArtifactsAndExecutionsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.AddContextArtifactsAndExecutionsResponse|AddContextArtifactsAndExecutionsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/metadata_service.add_context_artifacts_and_executions.js * region_tag:aiplatform_v1_generated_MetadataService_AddContextArtifactsAndExecutions_async @@ -2453,9 +2448,8 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.AddContextChildrenResponse | AddContextChildrenResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.AddContextChildrenResponse|AddContextChildrenResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/metadata_service.add_context_children.js * region_tag:aiplatform_v1_generated_MetadataService_AddContextChildren_async @@ -2551,9 +2545,8 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.RemoveContextChildrenResponse | RemoveContextChildrenResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.RemoveContextChildrenResponse|RemoveContextChildrenResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/metadata_service.remove_context_children.js * region_tag:aiplatform_v1_generated_MetadataService_RemoveContextChildren_async @@ -2656,9 +2649,8 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.LineageSubgraph | LineageSubgraph}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.LineageSubgraph|LineageSubgraph}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/metadata_service.query_context_lineage_subgraph.js * region_tag:aiplatform_v1_generated_MetadataService_QueryContextLineageSubgraph_async @@ -2764,16 +2756,15 @@ export class MetadataServiceClient { * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` * If not provided, the Execution's ID will be a UUID generated by the * service. - * Must be 4-128 characters in length. Valid characters are `/{@link 0-9|a-z}-/`. + * Must be 4-128 characters in length. Valid characters are `/{@link protos.0-9|a-z}-/`. * Must be unique across all Executions in the parent MetadataStore. * (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED * if the caller can't view the preexisting Execution.) * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.Execution | Execution}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.Execution|Execution}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/metadata_service.create_execution.js * region_tag:aiplatform_v1_generated_MetadataService_CreateExecution_async @@ -2864,9 +2855,8 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.Execution | Execution}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.Execution|Execution}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/metadata_service.get_execution.js * region_tag:aiplatform_v1_generated_MetadataService_GetExecution_async @@ -2946,21 +2936,20 @@ export class MetadataServiceClient { * The request object that will be sent. * @param {google.cloud.aiplatform.v1.Execution} request.execution * Required. The Execution containing updates. - * The Execution's {@link google.cloud.aiplatform.v1.Execution.name|Execution.name} + * The Execution's {@link protos.google.cloud.aiplatform.v1.Execution.name|Execution.name} * field is used to identify the Execution to be updated. Format: * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` * @param {google.protobuf.FieldMask} [request.updateMask] * Optional. A FieldMask indicating which fields should be updated. * @param {boolean} request.allowMissing - * If set to true, and the {@link google.cloud.aiplatform.v1.Execution|Execution} - * is not found, a new {@link google.cloud.aiplatform.v1.Execution|Execution} is + * If set to true, and the {@link protos.google.cloud.aiplatform.v1.Execution|Execution} + * is not found, a new {@link protos.google.cloud.aiplatform.v1.Execution|Execution} is * created. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.Execution | Execution}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.Execution|Execution}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/metadata_service.update_execution.js * region_tag:aiplatform_v1_generated_MetadataService_UpdateExecution_async @@ -3057,9 +3046,8 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.AddExecutionEventsResponse | AddExecutionEventsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.AddExecutionEventsResponse|AddExecutionEventsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/metadata_service.add_execution_events.js * region_tag:aiplatform_v1_generated_MetadataService_AddExecutionEvents_async @@ -3152,9 +3140,8 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.LineageSubgraph | LineageSubgraph}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.LineageSubgraph|LineageSubgraph}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/metadata_service.query_execution_inputs_and_outputs.js * region_tag:aiplatform_v1_generated_MetadataService_QueryExecutionInputsAndOutputs_async @@ -3259,16 +3246,15 @@ export class MetadataServiceClient { * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema}` * If not provided, the MetadataStore's ID will be a UUID generated by the * service. - * Must be 4-128 characters in length. Valid characters are `/{@link 0-9|a-z}-/`. + * Must be 4-128 characters in length. Valid characters are `/{@link protos.0-9|a-z}-/`. * Must be unique across all MetadataSchemas in the parent Location. * (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED * if the caller can't view the preexisting MetadataSchema.) * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.MetadataSchema | MetadataSchema}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.MetadataSchema|MetadataSchema}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/metadata_service.create_metadata_schema.js * region_tag:aiplatform_v1_generated_MetadataService_CreateMetadataSchema_async @@ -3365,9 +3351,8 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.MetadataSchema | MetadataSchema}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.MetadataSchema|MetadataSchema}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/metadata_service.get_metadata_schema.js * region_tag:aiplatform_v1_generated_MetadataService_GetMetadataSchema_async @@ -3495,9 +3480,8 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.LineageSubgraph | LineageSubgraph}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.LineageSubgraph|LineageSubgraph}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/metadata_service.query_artifact_lineage_subgraph.js * region_tag:aiplatform_v1_generated_MetadataService_QueryArtifactLineageSubgraph_async @@ -3603,7 +3587,7 @@ export class MetadataServiceClient { * `projects/{project}/locations/{location}/metadataStores/{metadatastore}` * If not provided, the MetadataStore's ID will be a UUID generated by the * service. - * Must be 4-128 characters in length. Valid characters are `/{@link 0-9|a-z}-/`. + * Must be 4-128 characters in length. Valid characters are `/{@link protos.0-9|a-z}-/`. * Must be unique across all MetadataStores in the parent Location. * (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED * if the caller can't view the preexisting MetadataStore.) @@ -3613,8 +3597,7 @@ export class MetadataServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/metadata_service.create_metadata_store.js * region_tag:aiplatform_v1_generated_MetadataService_CreateMetadataStore_async @@ -3709,8 +3692,7 @@ export class MetadataServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/metadata_service.create_metadata_store.js * region_tag:aiplatform_v1_generated_MetadataService_CreateMetadataStore_async @@ -3756,8 +3738,7 @@ export class MetadataServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/metadata_service.delete_metadata_store.js * region_tag:aiplatform_v1_generated_MetadataService_DeleteMetadataStore_async @@ -3852,8 +3833,7 @@ export class MetadataServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/metadata_service.delete_metadata_store.js * region_tag:aiplatform_v1_generated_MetadataService_DeleteMetadataStore_async @@ -3900,8 +3880,7 @@ export class MetadataServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/metadata_service.delete_artifact.js * region_tag:aiplatform_v1_generated_MetadataService_DeleteArtifact_async @@ -3996,8 +3975,7 @@ export class MetadataServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/metadata_service.delete_artifact.js * region_tag:aiplatform_v1_generated_MetadataService_DeleteArtifact_async @@ -4047,8 +4025,7 @@ export class MetadataServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/metadata_service.purge_artifacts.js * region_tag:aiplatform_v1_generated_MetadataService_PurgeArtifacts_async @@ -4143,8 +4120,7 @@ export class MetadataServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/metadata_service.purge_artifacts.js * region_tag:aiplatform_v1_generated_MetadataService_PurgeArtifacts_async @@ -4194,8 +4170,7 @@ export class MetadataServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/metadata_service.delete_context.js * region_tag:aiplatform_v1_generated_MetadataService_DeleteContext_async @@ -4290,8 +4265,7 @@ export class MetadataServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/metadata_service.delete_context.js * region_tag:aiplatform_v1_generated_MetadataService_DeleteContext_async @@ -4341,8 +4315,7 @@ export class MetadataServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/metadata_service.purge_contexts.js * region_tag:aiplatform_v1_generated_MetadataService_PurgeContexts_async @@ -4437,8 +4410,7 @@ export class MetadataServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/metadata_service.purge_contexts.js * region_tag:aiplatform_v1_generated_MetadataService_PurgeContexts_async @@ -4485,8 +4457,7 @@ export class MetadataServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/metadata_service.delete_execution.js * region_tag:aiplatform_v1_generated_MetadataService_DeleteExecution_async @@ -4581,8 +4552,7 @@ export class MetadataServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/metadata_service.delete_execution.js * region_tag:aiplatform_v1_generated_MetadataService_DeleteExecution_async @@ -4632,8 +4602,7 @@ export class MetadataServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/metadata_service.purge_executions.js * region_tag:aiplatform_v1_generated_MetadataService_PurgeExecutions_async @@ -4728,8 +4697,7 @@ export class MetadataServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/metadata_service.purge_executions.js * region_tag:aiplatform_v1_generated_MetadataService_PurgeExecutions_async @@ -4772,7 +4740,7 @@ export class MetadataServiceClient { * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.MetadataService.ListMetadataStores|MetadataService.ListMetadataStores} + * {@link protos.google.cloud.aiplatform.v1.MetadataService.ListMetadataStores|MetadataService.ListMetadataStores} * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that @@ -4781,14 +4749,13 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1.MetadataStore | MetadataStore}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.MetadataStore|MetadataStore}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listMetadataStoresAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listMetadataStores( @@ -4880,7 +4847,7 @@ export class MetadataServiceClient { * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.MetadataService.ListMetadataStores|MetadataService.ListMetadataStores} + * {@link protos.google.cloud.aiplatform.v1.MetadataService.ListMetadataStores|MetadataService.ListMetadataStores} * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that @@ -4889,13 +4856,12 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1.MetadataStore | MetadataStore} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.MetadataStore|MetadataStore} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listMetadataStoresAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listMetadataStoresStream( @@ -4936,7 +4902,7 @@ export class MetadataServiceClient { * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.MetadataService.ListMetadataStores|MetadataService.ListMetadataStores} + * {@link protos.google.cloud.aiplatform.v1.MetadataService.ListMetadataStores|MetadataService.ListMetadataStores} * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that @@ -4945,12 +4911,11 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1.MetadataStore | MetadataStore}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1.MetadataStore|MetadataStore}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/metadata_service.list_metadata_stores.js * region_tag:aiplatform_v1_generated_MetadataService_ListMetadataStores_async @@ -4990,7 +4955,7 @@ export class MetadataServiceClient { * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.MetadataService.ListArtifacts|MetadataService.ListArtifacts} + * {@link protos.google.cloud.aiplatform.v1.MetadataService.ListArtifacts|MetadataService.ListArtifacts} * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that @@ -5038,14 +5003,13 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1.Artifact | Artifact}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.Artifact|Artifact}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listArtifactsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listArtifacts( @@ -5136,7 +5100,7 @@ export class MetadataServiceClient { * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.MetadataService.ListArtifacts|MetadataService.ListArtifacts} + * {@link protos.google.cloud.aiplatform.v1.MetadataService.ListArtifacts|MetadataService.ListArtifacts} * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that @@ -5184,13 +5148,12 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1.Artifact | Artifact} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.Artifact|Artifact} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listArtifactsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listArtifactsStream( @@ -5230,7 +5193,7 @@ export class MetadataServiceClient { * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.MetadataService.ListArtifacts|MetadataService.ListArtifacts} + * {@link protos.google.cloud.aiplatform.v1.MetadataService.ListArtifacts|MetadataService.ListArtifacts} * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that @@ -5278,12 +5241,11 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1.Artifact | Artifact}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1.Artifact|Artifact}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/metadata_service.list_artifacts.js * region_tag:aiplatform_v1_generated_MetadataService_ListArtifacts_async @@ -5323,7 +5285,7 @@ export class MetadataServiceClient { * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.MetadataService.ListContexts|MetadataService.ListContexts} + * {@link protos.google.cloud.aiplatform.v1.MetadataService.ListContexts|MetadataService.ListContexts} * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that @@ -5375,14 +5337,13 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1.Context | Context}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.Context|Context}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listContextsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listContexts( @@ -5473,7 +5434,7 @@ export class MetadataServiceClient { * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.MetadataService.ListContexts|MetadataService.ListContexts} + * {@link protos.google.cloud.aiplatform.v1.MetadataService.ListContexts|MetadataService.ListContexts} * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that @@ -5525,13 +5486,12 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1.Context | Context} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.Context|Context} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listContextsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listContextsStream( @@ -5571,7 +5531,7 @@ export class MetadataServiceClient { * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.MetadataService.ListContexts|MetadataService.ListContexts} + * {@link protos.google.cloud.aiplatform.v1.MetadataService.ListContexts|MetadataService.ListContexts} * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that @@ -5623,12 +5583,11 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1.Context | Context}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1.Context|Context}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/metadata_service.list_contexts.js * region_tag:aiplatform_v1_generated_MetadataService_ListContexts_async @@ -5668,7 +5627,7 @@ export class MetadataServiceClient { * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.MetadataService.ListExecutions|MetadataService.ListExecutions} + * {@link protos.google.cloud.aiplatform.v1.MetadataService.ListExecutions|MetadataService.ListExecutions} * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that @@ -5716,14 +5675,13 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1.Execution | Execution}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.Execution|Execution}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listExecutionsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listExecutions( @@ -5814,7 +5772,7 @@ export class MetadataServiceClient { * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.MetadataService.ListExecutions|MetadataService.ListExecutions} + * {@link protos.google.cloud.aiplatform.v1.MetadataService.ListExecutions|MetadataService.ListExecutions} * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that @@ -5862,13 +5820,12 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1.Execution | Execution} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.Execution|Execution} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listExecutionsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listExecutionsStream( @@ -5908,7 +5865,7 @@ export class MetadataServiceClient { * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.MetadataService.ListExecutions|MetadataService.ListExecutions} + * {@link protos.google.cloud.aiplatform.v1.MetadataService.ListExecutions|MetadataService.ListExecutions} * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that @@ -5956,12 +5913,11 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1.Execution | Execution}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1.Execution|Execution}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/metadata_service.list_executions.js * region_tag:aiplatform_v1_generated_MetadataService_ListExecutions_async @@ -6002,7 +5958,7 @@ export class MetadataServiceClient { * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.MetadataService.ListMetadataSchemas|MetadataService.ListMetadataSchemas} + * {@link protos.google.cloud.aiplatform.v1.MetadataService.ListMetadataSchemas|MetadataService.ListMetadataSchemas} * call. Provide this to retrieve the next page. * * When paginating, all other provided parameters must match the call that @@ -6013,14 +5969,13 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1.MetadataSchema | MetadataSchema}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.MetadataSchema|MetadataSchema}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listMetadataSchemasAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listMetadataSchemas( @@ -6112,7 +6067,7 @@ export class MetadataServiceClient { * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.MetadataService.ListMetadataSchemas|MetadataService.ListMetadataSchemas} + * {@link protos.google.cloud.aiplatform.v1.MetadataService.ListMetadataSchemas|MetadataService.ListMetadataSchemas} * call. Provide this to retrieve the next page. * * When paginating, all other provided parameters must match the call that @@ -6123,13 +6078,12 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1.MetadataSchema | MetadataSchema} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.MetadataSchema|MetadataSchema} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listMetadataSchemasAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listMetadataSchemasStream( @@ -6170,7 +6124,7 @@ export class MetadataServiceClient { * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.MetadataService.ListMetadataSchemas|MetadataService.ListMetadataSchemas} + * {@link protos.google.cloud.aiplatform.v1.MetadataService.ListMetadataSchemas|MetadataService.ListMetadataSchemas} * call. Provide this to retrieve the next page. * * When paginating, all other provided parameters must match the call that @@ -6181,12 +6135,11 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1.MetadataSchema | MetadataSchema}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1.MetadataSchema|MetadataSchema}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/metadata_service.list_metadata_schemas.js * region_tag:aiplatform_v1_generated_MetadataService_ListMetadataSchemas_async @@ -6251,7 +6204,7 @@ export class MetadataServiceClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -6272,8 +6225,7 @@ export class MetadataServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -6299,7 +6251,7 @@ export class MetadataServiceClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -6320,8 +6272,7 @@ export class MetadataServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -6348,7 +6299,7 @@ export class MetadataServiceClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -6363,8 +6314,7 @@ export class MetadataServiceClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` @@ -6410,12 +6360,11 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` @@ -8543,6 +8492,55 @@ export class MetadataServiceClient { .saved_query; } + /** + * Return a fully-qualified schedule resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} schedule + * @returns {string} Resource name string. + */ + schedulePath(project: string, location: string, schedule: string) { + return this.pathTemplates.schedulePathTemplate.render({ + project: project, + location: location, + schedule: schedule, + }); + } + + /** + * Parse the project from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the project. + */ + matchProjectFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).project; + } + + /** + * Parse the location from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the location. + */ + matchLocationFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).location; + } + + /** + * Parse the schedule from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the schedule. + */ + matchScheduleFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).schedule; + } + /** * Return a fully-qualified specialistPool resource name string. * diff --git a/packages/google-cloud-aiplatform/src/v1/metadata_service_proto_list.json b/packages/google-cloud-aiplatform/src/v1/metadata_service_proto_list.json index f987b709de8..2d74caf069f 100644 --- a/packages/google-cloud-aiplatform/src/v1/metadata_service_proto_list.json +++ b/packages/google-cloud-aiplatform/src/v1/metadata_service_proto_list.json @@ -63,6 +63,8 @@ "../../protos/google/cloud/aiplatform/v1/prediction_service.proto", "../../protos/google/cloud/aiplatform/v1/publisher_model.proto", "../../protos/google/cloud/aiplatform/v1/saved_query.proto", + "../../protos/google/cloud/aiplatform/v1/schedule.proto", + "../../protos/google/cloud/aiplatform/v1/schedule_service.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_classification.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_object_detection.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_segmentation.proto", diff --git a/packages/google-cloud-aiplatform/src/v1/migration_service_client.ts b/packages/google-cloud-aiplatform/src/v1/migration_service_client.ts index 1f946a6e5c0..d2952b2819b 100644 --- a/packages/google-cloud-aiplatform/src/v1/migration_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1/migration_service_client.ts @@ -283,6 +283,9 @@ export class MigrationServiceClient { savedQueryPathTemplate: new this._gaxModule.PathTemplate( 'projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}' ), + schedulePathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/schedules/{schedule}' + ), specialistPoolPathTemplate: new this._gaxModule.PathTemplate( 'projects/{project}/locations/{location}/specialistPools/{specialist_pool}' ), @@ -1538,8 +1541,7 @@ export class MigrationServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/migration_service.batch_migrate_resources.js * region_tag:aiplatform_v1_generated_MigrationService_BatchMigrateResources_async @@ -1634,8 +1636,7 @@ export class MigrationServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/migration_service.batch_migrate_resources.js * region_tag:aiplatform_v1_generated_MigrationService_BatchMigrateResources_async @@ -1684,7 +1685,7 @@ export class MigrationServiceClient { * A filter for your search. You can use the following types of filters: * * * Resource type filters. The following strings filter for a specific type - * of {@link google.cloud.aiplatform.v1.MigratableResource|MigratableResource}: + * of {@link protos.google.cloud.aiplatform.v1.MigratableResource|MigratableResource}: * * `ml_engine_model_version:*` * * `automl_model:*` * * `automl_dataset:*` @@ -1696,14 +1697,13 @@ export class MigrationServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1.MigratableResource | MigratableResource}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.MigratableResource|MigratableResource}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `searchMigratableResourcesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ searchMigratableResources( @@ -1803,7 +1803,7 @@ export class MigrationServiceClient { * A filter for your search. You can use the following types of filters: * * * Resource type filters. The following strings filter for a specific type - * of {@link google.cloud.aiplatform.v1.MigratableResource|MigratableResource}: + * of {@link protos.google.cloud.aiplatform.v1.MigratableResource|MigratableResource}: * * `ml_engine_model_version:*` * * `automl_model:*` * * `automl_dataset:*` @@ -1815,13 +1815,12 @@ export class MigrationServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1.MigratableResource | MigratableResource} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.MigratableResource|MigratableResource} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `searchMigratableResourcesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ searchMigratableResourcesStream( @@ -1866,7 +1865,7 @@ export class MigrationServiceClient { * A filter for your search. You can use the following types of filters: * * * Resource type filters. The following strings filter for a specific type - * of {@link google.cloud.aiplatform.v1.MigratableResource|MigratableResource}: + * of {@link protos.google.cloud.aiplatform.v1.MigratableResource|MigratableResource}: * * `ml_engine_model_version:*` * * `automl_model:*` * * `automl_dataset:*` @@ -1878,12 +1877,11 @@ export class MigrationServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1.MigratableResource | MigratableResource}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1.MigratableResource|MigratableResource}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/migration_service.search_migratable_resources.js * region_tag:aiplatform_v1_generated_MigrationService_SearchMigratableResources_async @@ -1948,7 +1946,7 @@ export class MigrationServiceClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -1969,8 +1967,7 @@ export class MigrationServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -1996,7 +1993,7 @@ export class MigrationServiceClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -2017,8 +2014,7 @@ export class MigrationServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -2045,7 +2041,7 @@ export class MigrationServiceClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -2060,8 +2056,7 @@ export class MigrationServiceClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` @@ -2107,12 +2102,11 @@ export class MigrationServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` @@ -4217,6 +4211,55 @@ export class MigrationServiceClient { .saved_query; } + /** + * Return a fully-qualified schedule resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} schedule + * @returns {string} Resource name string. + */ + schedulePath(project: string, location: string, schedule: string) { + return this.pathTemplates.schedulePathTemplate.render({ + project: project, + location: location, + schedule: schedule, + }); + } + + /** + * Parse the project from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the project. + */ + matchProjectFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).project; + } + + /** + * Parse the location from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the location. + */ + matchLocationFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).location; + } + + /** + * Parse the schedule from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the schedule. + */ + matchScheduleFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).schedule; + } + /** * Return a fully-qualified specialistPool resource name string. * diff --git a/packages/google-cloud-aiplatform/src/v1/migration_service_proto_list.json b/packages/google-cloud-aiplatform/src/v1/migration_service_proto_list.json index f987b709de8..2d74caf069f 100644 --- a/packages/google-cloud-aiplatform/src/v1/migration_service_proto_list.json +++ b/packages/google-cloud-aiplatform/src/v1/migration_service_proto_list.json @@ -63,6 +63,8 @@ "../../protos/google/cloud/aiplatform/v1/prediction_service.proto", "../../protos/google/cloud/aiplatform/v1/publisher_model.proto", "../../protos/google/cloud/aiplatform/v1/saved_query.proto", + "../../protos/google/cloud/aiplatform/v1/schedule.proto", + "../../protos/google/cloud/aiplatform/v1/schedule_service.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_classification.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_object_detection.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_segmentation.proto", diff --git a/packages/google-cloud-aiplatform/src/v1/model_garden_service_client.ts b/packages/google-cloud-aiplatform/src/v1/model_garden_service_client.ts index 6ef58b4af07..bf8b9fce9c8 100644 --- a/packages/google-cloud-aiplatform/src/v1/model_garden_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1/model_garden_service_client.ts @@ -274,6 +274,9 @@ export class ModelGardenServiceClient { savedQueryPathTemplate: new this._gaxModule.PathTemplate( 'projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}' ), + schedulePathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/schedules/{schedule}' + ), specialistPoolPathTemplate: new this._gaxModule.PathTemplate( 'projects/{project}/locations/{location}/specialistPools/{specialist_pool}' ), @@ -449,9 +452,8 @@ export class ModelGardenServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.PublisherModel | PublisherModel}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.PublisherModel|PublisherModel}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/model_garden_service.get_publisher_model.js * region_tag:aiplatform_v1_generated_ModelGardenService_GetPublisherModel_async @@ -570,7 +572,7 @@ export class ModelGardenServiceClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -591,8 +593,7 @@ export class ModelGardenServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -618,7 +619,7 @@ export class ModelGardenServiceClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -639,8 +640,7 @@ export class ModelGardenServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -667,7 +667,7 @@ export class ModelGardenServiceClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -682,8 +682,7 @@ export class ModelGardenServiceClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` @@ -729,12 +728,11 @@ export class ModelGardenServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` @@ -2628,6 +2626,55 @@ export class ModelGardenServiceClient { .saved_query; } + /** + * Return a fully-qualified schedule resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} schedule + * @returns {string} Resource name string. + */ + schedulePath(project: string, location: string, schedule: string) { + return this.pathTemplates.schedulePathTemplate.render({ + project: project, + location: location, + schedule: schedule, + }); + } + + /** + * Parse the project from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the project. + */ + matchProjectFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).project; + } + + /** + * Parse the location from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the location. + */ + matchLocationFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).location; + } + + /** + * Parse the schedule from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the schedule. + */ + matchScheduleFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).schedule; + } + /** * Return a fully-qualified specialistPool resource name string. * diff --git a/packages/google-cloud-aiplatform/src/v1/model_garden_service_proto_list.json b/packages/google-cloud-aiplatform/src/v1/model_garden_service_proto_list.json index f987b709de8..2d74caf069f 100644 --- a/packages/google-cloud-aiplatform/src/v1/model_garden_service_proto_list.json +++ b/packages/google-cloud-aiplatform/src/v1/model_garden_service_proto_list.json @@ -63,6 +63,8 @@ "../../protos/google/cloud/aiplatform/v1/prediction_service.proto", "../../protos/google/cloud/aiplatform/v1/publisher_model.proto", "../../protos/google/cloud/aiplatform/v1/saved_query.proto", + "../../protos/google/cloud/aiplatform/v1/schedule.proto", + "../../protos/google/cloud/aiplatform/v1/schedule_service.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_classification.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_object_detection.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_segmentation.proto", diff --git a/packages/google-cloud-aiplatform/src/v1/model_service_client.ts b/packages/google-cloud-aiplatform/src/v1/model_service_client.ts index 0f7b1685076..8b3d45e7c2b 100644 --- a/packages/google-cloud-aiplatform/src/v1/model_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1/model_service_client.ts @@ -282,6 +282,9 @@ export class ModelServiceClient { savedQueryPathTemplate: new this._gaxModule.PathTemplate( 'projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}' ), + schedulePathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/schedules/{schedule}' + ), specialistPoolPathTemplate: new this._gaxModule.PathTemplate( 'projects/{project}/locations/{location}/specialistPools/{specialist_pool}' ), @@ -1626,9 +1629,8 @@ export class ModelServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.Model | Model}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.Model|Model}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/model_service.get_model.js * region_tag:aiplatform_v1_generated_ModelService_GetModel_async @@ -1726,13 +1728,12 @@ export class ModelServiceClient { * @param {google.protobuf.FieldMask} request.updateMask * Required. The update mask applies to the resource. * For the `FieldMask` definition, see - * {@link google.protobuf.FieldMask|google.protobuf.FieldMask}. + * {@link protos.google.protobuf.FieldMask|google.protobuf.FieldMask}. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.Model | Model}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.Model|Model}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/model_service.update_model.js * region_tag:aiplatform_v1_generated_ModelService_UpdateModel_async @@ -1818,7 +1819,7 @@ export class ModelServiceClient { * @param {string[]} request.versionAliases * Required. The set of version aliases to merge. * The alias should be at most 128 characters, and match - * `{@link a-zA-Z0-9-|a-z}{0,126}[a-z-0-9]`. + * `{@link protos.a-zA-Z0-9-|a-z}{0,126}[a-z-0-9]`. * Add the `-` prefix to an alias means removing that alias from the version. * `-` is NOT counted in the 128 characters. Example: `-golden` means removing * the `golden` alias from the version. @@ -1831,9 +1832,8 @@ export class ModelServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.Model | Model}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.Model|Model}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/model_service.merge_version_aliases.js * region_tag:aiplatform_v1_generated_ModelService_MergeVersionAliases_async @@ -1925,9 +1925,8 @@ export class ModelServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.ModelEvaluation | ModelEvaluation}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.ModelEvaluation|ModelEvaluation}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/model_service.import_model_evaluation.js * region_tag:aiplatform_v1_generated_ModelService_ImportModelEvaluation_async @@ -2026,9 +2025,8 @@ export class ModelServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.BatchImportModelEvaluationSlicesResponse | BatchImportModelEvaluationSlicesResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.BatchImportModelEvaluationSlicesResponse|BatchImportModelEvaluationSlicesResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/model_service.batch_import_model_evaluation_slices.js * region_tag:aiplatform_v1_generated_ModelService_BatchImportModelEvaluationSlices_async @@ -2131,9 +2129,8 @@ export class ModelServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.BatchImportEvaluatedAnnotationsResponse | BatchImportEvaluatedAnnotationsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.BatchImportEvaluatedAnnotationsResponse|BatchImportEvaluatedAnnotationsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/model_service.batch_import_evaluated_annotations.js * region_tag:aiplatform_v1_generated_ModelService_BatchImportEvaluatedAnnotations_async @@ -2234,9 +2231,8 @@ export class ModelServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.ModelEvaluation | ModelEvaluation}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.ModelEvaluation|ModelEvaluation}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/model_service.get_model_evaluation.js * region_tag:aiplatform_v1_generated_ModelService_GetModelEvaluation_async @@ -2327,9 +2323,8 @@ export class ModelServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.ModelEvaluationSlice | ModelEvaluationSlice}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.ModelEvaluationSlice|ModelEvaluationSlice}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/model_service.get_model_evaluation_slice.js * region_tag:aiplatform_v1_generated_ModelService_GetModelEvaluationSlice_async @@ -2452,8 +2447,7 @@ export class ModelServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/model_service.upload_model.js * region_tag:aiplatform_v1_generated_ModelService_UploadModel_async @@ -2548,8 +2542,7 @@ export class ModelServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/model_service.upload_model.js * region_tag:aiplatform_v1_generated_ModelService_UploadModel_async @@ -2593,8 +2586,7 @@ export class ModelServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/model_service.update_explanation_dataset.js * region_tag:aiplatform_v1_generated_ModelService_UpdateExplanationDataset_async @@ -2693,8 +2685,7 @@ export class ModelServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/model_service.update_explanation_dataset.js * region_tag:aiplatform_v1_generated_ModelService_UpdateExplanationDataset_async @@ -2726,10 +2717,10 @@ export class ModelServiceClient { * Deletes a Model. * * A model cannot be deleted if any - * {@link google.cloud.aiplatform.v1.Endpoint|Endpoint} resource has a - * {@link google.cloud.aiplatform.v1.DeployedModel|DeployedModel} based on the + * {@link protos.google.cloud.aiplatform.v1.Endpoint|Endpoint} resource has a + * {@link protos.google.cloud.aiplatform.v1.DeployedModel|DeployedModel} based on the * model in its - * {@link google.cloud.aiplatform.v1.Endpoint.deployed_models|deployed_models} + * {@link protos.google.cloud.aiplatform.v1.Endpoint.deployed_models|deployed_models} * field. * * @param {Object} request @@ -2743,8 +2734,7 @@ export class ModelServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/model_service.delete_model.js * region_tag:aiplatform_v1_generated_ModelService_DeleteModel_async @@ -2839,8 +2829,7 @@ export class ModelServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/model_service.delete_model.js * region_tag:aiplatform_v1_generated_ModelService_DeleteModel_async @@ -2872,9 +2861,9 @@ export class ModelServiceClient { * Deletes a Model version. * * Model version can only be deleted if there are no - * {@link google.cloud.aiplatform.v1.DeployedModel|DeployedModels} created from it. + * {@link protos.google.cloud.aiplatform.v1.DeployedModel|DeployedModels} created from it. * Deleting the only version in the Model is not allowed. Use - * {@link google.cloud.aiplatform.v1.ModelService.DeleteModel|DeleteModel} for + * {@link protos.google.cloud.aiplatform.v1.ModelService.DeleteModel|DeleteModel} for * deleting the Model instead. * * @param {Object} request @@ -2890,8 +2879,7 @@ export class ModelServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/model_service.delete_model_version.js * region_tag:aiplatform_v1_generated_ModelService_DeleteModelVersion_async @@ -2986,8 +2974,7 @@ export class ModelServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/model_service.delete_model_version.js * region_tag:aiplatform_v1_generated_ModelService_DeleteModelVersion_async @@ -3035,8 +3022,7 @@ export class ModelServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/model_service.export_model.js * region_tag:aiplatform_v1_generated_ModelService_ExportModel_async @@ -3131,8 +3117,7 @@ export class ModelServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/model_service.export_model.js * region_tag:aiplatform_v1_generated_ModelService_ExportModel_async @@ -3164,7 +3149,7 @@ export class ModelServiceClient { * Copies an already existing Vertex AI Model into the specified Location. * The source Model must exist in the same Project. * When copying custom Models, the users themselves are responsible for - * {@link google.cloud.aiplatform.v1.Model.metadata|Model.metadata} content to be + * {@link protos.google.cloud.aiplatform.v1.Model.metadata|Model.metadata} content to be * region-agnostic, as well as making sure that any resources (e.g. files) it * depends on remain accessible. * @@ -3196,8 +3181,7 @@ export class ModelServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/model_service.copy_model.js * region_tag:aiplatform_v1_generated_ModelService_CopyModel_async @@ -3292,8 +3276,7 @@ export class ModelServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/model_service.copy_model.js * region_tag:aiplatform_v1_generated_ModelService_CopyModel_async @@ -3352,9 +3335,9 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListModelsResponse.next_page_token|ListModelsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1.ListModelsResponse.next_page_token|ListModelsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.ModelService.ListModels|ModelService.ListModels} + * {@link protos.google.cloud.aiplatform.v1.ModelService.ListModels|ModelService.ListModels} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. @@ -3371,14 +3354,13 @@ export class ModelServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1.Model | Model}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.Model|Model}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listModelsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listModels( @@ -3480,9 +3462,9 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListModelsResponse.next_page_token|ListModelsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1.ListModelsResponse.next_page_token|ListModelsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.ModelService.ListModels|ModelService.ListModels} + * {@link protos.google.cloud.aiplatform.v1.ModelService.ListModels|ModelService.ListModels} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. @@ -3499,13 +3481,12 @@ export class ModelServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1.Model | Model} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.Model|Model} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listModelsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listModelsStream( @@ -3562,9 +3543,9 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListModelsResponse.next_page_token|ListModelsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1.ListModelsResponse.next_page_token|ListModelsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.ModelService.ListModels|ModelService.ListModels} + * {@link protos.google.cloud.aiplatform.v1.ModelService.ListModels|ModelService.ListModels} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. @@ -3581,12 +3562,11 @@ export class ModelServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1.Model | Model}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1.Model|Model}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/model_service.list_models.js * region_tag:aiplatform_v1_generated_ModelService_ListModels_async @@ -3624,9 +3604,9 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListModelVersionsResponse.next_page_token|next_page_token} + * {@link protos.google.cloud.aiplatform.v1.ListModelVersionsResponse.next_page_token|next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.ModelService.ListModelVersions|ListModelVersions} + * {@link protos.google.cloud.aiplatform.v1.ModelService.ListModelVersions|ListModelVersions} * call. * @param {string} request.filter * An expression for filtering the results of the request. For field names @@ -3654,14 +3634,13 @@ export class ModelServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1.Model | Model}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.Model|Model}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listModelVersionsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listModelVersions( @@ -3750,9 +3729,9 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListModelVersionsResponse.next_page_token|next_page_token} + * {@link protos.google.cloud.aiplatform.v1.ListModelVersionsResponse.next_page_token|next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.ModelService.ListModelVersions|ListModelVersions} + * {@link protos.google.cloud.aiplatform.v1.ModelService.ListModelVersions|ListModelVersions} * call. * @param {string} request.filter * An expression for filtering the results of the request. For field names @@ -3780,13 +3759,12 @@ export class ModelServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1.Model | Model} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.Model|Model} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listModelVersionsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listModelVersionsStream( @@ -3824,9 +3802,9 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListModelVersionsResponse.next_page_token|next_page_token} + * {@link protos.google.cloud.aiplatform.v1.ListModelVersionsResponse.next_page_token|next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.ModelService.ListModelVersions|ListModelVersions} + * {@link protos.google.cloud.aiplatform.v1.ModelService.ListModelVersions|ListModelVersions} * call. * @param {string} request.filter * An expression for filtering the results of the request. For field names @@ -3854,12 +3832,11 @@ export class ModelServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1.Model | Model}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1.Model|Model}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/model_service.list_model_versions.js * region_tag:aiplatform_v1_generated_ModelService_ListModelVersions_async @@ -3900,23 +3877,22 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListModelEvaluationsResponse.next_page_token|ListModelEvaluationsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1.ListModelEvaluationsResponse.next_page_token|ListModelEvaluationsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.ModelService.ListModelEvaluations|ModelService.ListModelEvaluations} + * {@link protos.google.cloud.aiplatform.v1.ModelService.ListModelEvaluations|ModelService.ListModelEvaluations} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1.ModelEvaluation | ModelEvaluation}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.ModelEvaluation|ModelEvaluation}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listModelEvaluationsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listModelEvaluations( @@ -4008,22 +3984,21 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListModelEvaluationsResponse.next_page_token|ListModelEvaluationsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1.ListModelEvaluationsResponse.next_page_token|ListModelEvaluationsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.ModelService.ListModelEvaluations|ModelService.ListModelEvaluations} + * {@link protos.google.cloud.aiplatform.v1.ModelService.ListModelEvaluations|ModelService.ListModelEvaluations} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1.ModelEvaluation | ModelEvaluation} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.ModelEvaluation|ModelEvaluation} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listModelEvaluationsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listModelEvaluationsStream( @@ -4064,21 +4039,20 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListModelEvaluationsResponse.next_page_token|ListModelEvaluationsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1.ListModelEvaluationsResponse.next_page_token|ListModelEvaluationsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.ModelService.ListModelEvaluations|ModelService.ListModelEvaluations} + * {@link protos.google.cloud.aiplatform.v1.ModelService.ListModelEvaluations|ModelService.ListModelEvaluations} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1.ModelEvaluation | ModelEvaluation}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1.ModelEvaluation|ModelEvaluation}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/model_service.list_model_evaluations.js * region_tag:aiplatform_v1_generated_ModelService_ListModelEvaluations_async @@ -4122,23 +4096,22 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListModelEvaluationSlicesResponse.next_page_token|ListModelEvaluationSlicesResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1.ListModelEvaluationSlicesResponse.next_page_token|ListModelEvaluationSlicesResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices|ModelService.ListModelEvaluationSlices} + * {@link protos.google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices|ModelService.ListModelEvaluationSlices} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1.ModelEvaluationSlice | ModelEvaluationSlice}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.ModelEvaluationSlice|ModelEvaluationSlice}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listModelEvaluationSlicesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listModelEvaluationSlices( @@ -4237,22 +4210,21 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListModelEvaluationSlicesResponse.next_page_token|ListModelEvaluationSlicesResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1.ListModelEvaluationSlicesResponse.next_page_token|ListModelEvaluationSlicesResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices|ModelService.ListModelEvaluationSlices} + * {@link protos.google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices|ModelService.ListModelEvaluationSlices} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1.ModelEvaluationSlice | ModelEvaluationSlice} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.ModelEvaluationSlice|ModelEvaluationSlice} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listModelEvaluationSlicesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listModelEvaluationSlicesStream( @@ -4296,21 +4268,20 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListModelEvaluationSlicesResponse.next_page_token|ListModelEvaluationSlicesResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1.ListModelEvaluationSlicesResponse.next_page_token|ListModelEvaluationSlicesResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices|ModelService.ListModelEvaluationSlices} + * {@link protos.google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices|ModelService.ListModelEvaluationSlices} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1.ModelEvaluationSlice | ModelEvaluationSlice}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1.ModelEvaluationSlice|ModelEvaluationSlice}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/model_service.list_model_evaluation_slices.js * region_tag:aiplatform_v1_generated_ModelService_ListModelEvaluationSlices_async @@ -4375,7 +4346,7 @@ export class ModelServiceClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -4396,8 +4367,7 @@ export class ModelServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -4423,7 +4393,7 @@ export class ModelServiceClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -4444,8 +4414,7 @@ export class ModelServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -4472,7 +4441,7 @@ export class ModelServiceClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -4487,8 +4456,7 @@ export class ModelServiceClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` @@ -4534,12 +4502,11 @@ export class ModelServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` @@ -6644,6 +6611,55 @@ export class ModelServiceClient { .saved_query; } + /** + * Return a fully-qualified schedule resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} schedule + * @returns {string} Resource name string. + */ + schedulePath(project: string, location: string, schedule: string) { + return this.pathTemplates.schedulePathTemplate.render({ + project: project, + location: location, + schedule: schedule, + }); + } + + /** + * Parse the project from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the project. + */ + matchProjectFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).project; + } + + /** + * Parse the location from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the location. + */ + matchLocationFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).location; + } + + /** + * Parse the schedule from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the schedule. + */ + matchScheduleFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).schedule; + } + /** * Return a fully-qualified specialistPool resource name string. * diff --git a/packages/google-cloud-aiplatform/src/v1/model_service_proto_list.json b/packages/google-cloud-aiplatform/src/v1/model_service_proto_list.json index f987b709de8..2d74caf069f 100644 --- a/packages/google-cloud-aiplatform/src/v1/model_service_proto_list.json +++ b/packages/google-cloud-aiplatform/src/v1/model_service_proto_list.json @@ -63,6 +63,8 @@ "../../protos/google/cloud/aiplatform/v1/prediction_service.proto", "../../protos/google/cloud/aiplatform/v1/publisher_model.proto", "../../protos/google/cloud/aiplatform/v1/saved_query.proto", + "../../protos/google/cloud/aiplatform/v1/schedule.proto", + "../../protos/google/cloud/aiplatform/v1/schedule_service.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_classification.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_object_detection.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_segmentation.proto", diff --git a/packages/google-cloud-aiplatform/src/v1/pipeline_service_client.ts b/packages/google-cloud-aiplatform/src/v1/pipeline_service_client.ts index a7ca18c0dd9..762cbfe0a7b 100644 --- a/packages/google-cloud-aiplatform/src/v1/pipeline_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1/pipeline_service_client.ts @@ -284,6 +284,9 @@ export class PipelineServiceClient { savedQueryPathTemplate: new this._gaxModule.PathTemplate( 'projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}' ), + schedulePathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/schedules/{schedule}' + ), specialistPoolPathTemplate: new this._gaxModule.PathTemplate( 'projects/{project}/locations/{location}/specialistPools/{specialist_pool}' ), @@ -1559,9 +1562,8 @@ export class PipelineServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.TrainingPipeline | TrainingPipeline}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.TrainingPipeline|TrainingPipeline}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/pipeline_service.create_training_pipeline.js * region_tag:aiplatform_v1_generated_PipelineService_CreateTrainingPipeline_async @@ -1662,9 +1664,8 @@ export class PipelineServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.TrainingPipeline | TrainingPipeline}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.TrainingPipeline|TrainingPipeline}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/pipeline_service.get_training_pipeline.js * region_tag:aiplatform_v1_generated_PipelineService_GetTrainingPipeline_async @@ -1748,15 +1749,15 @@ export class PipelineServiceClient { * Starts asynchronous cancellation on the TrainingPipeline. The server * makes a best effort to cancel the pipeline, but success is not * guaranteed. Clients can use - * {@link google.cloud.aiplatform.v1.PipelineService.GetTrainingPipeline|PipelineService.GetTrainingPipeline} + * {@link protos.google.cloud.aiplatform.v1.PipelineService.GetTrainingPipeline|PipelineService.GetTrainingPipeline} * or other methods to check whether the cancellation succeeded or whether the * pipeline completed despite cancellation. On successful cancellation, * the TrainingPipeline is not deleted; instead it becomes a pipeline with * a - * {@link google.cloud.aiplatform.v1.TrainingPipeline.error|TrainingPipeline.error} - * value with a {@link google.rpc.Status.code|google.rpc.Status.code} of 1, + * {@link protos.google.cloud.aiplatform.v1.TrainingPipeline.error|TrainingPipeline.error} + * value with a {@link protos.google.rpc.Status.code|google.rpc.Status.code} of 1, * corresponding to `Code.CANCELLED`, and - * {@link google.cloud.aiplatform.v1.TrainingPipeline.state|TrainingPipeline.state} + * {@link protos.google.cloud.aiplatform.v1.TrainingPipeline.state|TrainingPipeline.state} * is set to `CANCELLED`. * * @param {Object} request @@ -1768,9 +1769,8 @@ export class PipelineServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.protobuf.Empty | Empty}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/pipeline_service.cancel_training_pipeline.js * region_tag:aiplatform_v1_generated_PipelineService_CancelTrainingPipeline_async @@ -1875,13 +1875,12 @@ export class PipelineServiceClient { * generated. * * This value should be less than 128 characters, and valid characters - * are /{@link 0-9|a-z}-/. + * are /{@link protos.0-9|a-z}-/. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.PipelineJob | PipelineJob}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.PipelineJob|PipelineJob}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/pipeline_service.create_pipeline_job.js * region_tag:aiplatform_v1_generated_PipelineService_CreatePipelineJob_async @@ -1972,9 +1971,8 @@ export class PipelineServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.PipelineJob | PipelineJob}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.PipelineJob|PipelineJob}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/pipeline_service.get_pipeline_job.js * region_tag:aiplatform_v1_generated_PipelineService_GetPipelineJob_async @@ -2058,14 +2056,14 @@ export class PipelineServiceClient { * Starts asynchronous cancellation on the PipelineJob. The server * makes a best effort to cancel the pipeline, but success is not * guaranteed. Clients can use - * {@link google.cloud.aiplatform.v1.PipelineService.GetPipelineJob|PipelineService.GetPipelineJob} + * {@link protos.google.cloud.aiplatform.v1.PipelineService.GetPipelineJob|PipelineService.GetPipelineJob} * or other methods to check whether the cancellation succeeded or whether the * pipeline completed despite cancellation. On successful cancellation, * the PipelineJob is not deleted; instead it becomes a pipeline with - * a {@link google.cloud.aiplatform.v1.PipelineJob.error|PipelineJob.error} value - * with a {@link google.rpc.Status.code|google.rpc.Status.code} of 1, corresponding + * a {@link protos.google.cloud.aiplatform.v1.PipelineJob.error|PipelineJob.error} value + * with a {@link protos.google.rpc.Status.code|google.rpc.Status.code} of 1, corresponding * to `Code.CANCELLED`, and - * {@link google.cloud.aiplatform.v1.PipelineJob.state|PipelineJob.state} is set to + * {@link protos.google.cloud.aiplatform.v1.PipelineJob.state|PipelineJob.state} is set to * `CANCELLED`. * * @param {Object} request @@ -2077,9 +2075,8 @@ export class PipelineServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.protobuf.Empty | Empty}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/pipeline_service.cancel_pipeline_job.js * region_tag:aiplatform_v1_generated_PipelineService_CancelPipelineJob_async @@ -2174,8 +2171,7 @@ export class PipelineServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/pipeline_service.delete_training_pipeline.js * region_tag:aiplatform_v1_generated_PipelineService_DeleteTrainingPipeline_async @@ -2274,8 +2270,7 @@ export class PipelineServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/pipeline_service.delete_training_pipeline.js * region_tag:aiplatform_v1_generated_PipelineService_DeleteTrainingPipeline_async @@ -2318,8 +2313,7 @@ export class PipelineServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/pipeline_service.delete_pipeline_job.js * region_tag:aiplatform_v1_generated_PipelineService_DeletePipelineJob_async @@ -2414,8 +2408,7 @@ export class PipelineServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/pipeline_service.delete_pipeline_job.js * region_tag:aiplatform_v1_generated_PipelineService_DeletePipelineJob_async @@ -2477,23 +2470,22 @@ export class PipelineServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListTrainingPipelinesResponse.next_page_token|ListTrainingPipelinesResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1.ListTrainingPipelinesResponse.next_page_token|ListTrainingPipelinesResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.PipelineService.ListTrainingPipelines|PipelineService.ListTrainingPipelines} + * {@link protos.google.cloud.aiplatform.v1.PipelineService.ListTrainingPipelines|PipelineService.ListTrainingPipelines} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1.TrainingPipeline | TrainingPipeline}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.TrainingPipeline|TrainingPipeline}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listTrainingPipelinesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listTrainingPipelines( @@ -2604,22 +2596,21 @@ export class PipelineServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListTrainingPipelinesResponse.next_page_token|ListTrainingPipelinesResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1.ListTrainingPipelinesResponse.next_page_token|ListTrainingPipelinesResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.PipelineService.ListTrainingPipelines|PipelineService.ListTrainingPipelines} + * {@link protos.google.cloud.aiplatform.v1.PipelineService.ListTrainingPipelines|PipelineService.ListTrainingPipelines} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1.TrainingPipeline | TrainingPipeline} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.TrainingPipeline|TrainingPipeline} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listTrainingPipelinesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listTrainingPipelinesStream( @@ -2679,21 +2670,20 @@ export class PipelineServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListTrainingPipelinesResponse.next_page_token|ListTrainingPipelinesResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1.ListTrainingPipelinesResponse.next_page_token|ListTrainingPipelinesResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.PipelineService.ListTrainingPipelines|PipelineService.ListTrainingPipelines} + * {@link protos.google.cloud.aiplatform.v1.PipelineService.ListTrainingPipelines|PipelineService.ListTrainingPipelines} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1.TrainingPipeline | TrainingPipeline}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1.TrainingPipeline|TrainingPipeline}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/pipeline_service.list_training_pipelines.js * region_tag:aiplatform_v1_generated_PipelineService_ListTrainingPipelines_async @@ -2767,9 +2757,9 @@ export class PipelineServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListPipelineJobsResponse.next_page_token|ListPipelineJobsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1.ListPipelineJobsResponse.next_page_token|ListPipelineJobsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.PipelineService.ListPipelineJobs|PipelineService.ListPipelineJobs} + * {@link protos.google.cloud.aiplatform.v1.PipelineService.ListPipelineJobs|PipelineService.ListPipelineJobs} * call. * @param {string} request.orderBy * A comma-separated list of fields to order by. The default sort order is in @@ -2790,14 +2780,13 @@ export class PipelineServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1.PipelineJob | PipelineJob}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.PipelineJob|PipelineJob}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listPipelineJobsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listPipelineJobs( @@ -2922,9 +2911,9 @@ export class PipelineServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListPipelineJobsResponse.next_page_token|ListPipelineJobsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1.ListPipelineJobsResponse.next_page_token|ListPipelineJobsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.PipelineService.ListPipelineJobs|PipelineService.ListPipelineJobs} + * {@link protos.google.cloud.aiplatform.v1.PipelineService.ListPipelineJobs|PipelineService.ListPipelineJobs} * call. * @param {string} request.orderBy * A comma-separated list of fields to order by. The default sort order is in @@ -2945,13 +2934,12 @@ export class PipelineServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1.PipelineJob | PipelineJob} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.PipelineJob|PipelineJob} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listPipelineJobsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listPipelineJobsStream( @@ -3025,9 +3013,9 @@ export class PipelineServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListPipelineJobsResponse.next_page_token|ListPipelineJobsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1.ListPipelineJobsResponse.next_page_token|ListPipelineJobsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.PipelineService.ListPipelineJobs|PipelineService.ListPipelineJobs} + * {@link protos.google.cloud.aiplatform.v1.PipelineService.ListPipelineJobs|PipelineService.ListPipelineJobs} * call. * @param {string} request.orderBy * A comma-separated list of fields to order by. The default sort order is in @@ -3048,12 +3036,11 @@ export class PipelineServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1.PipelineJob | PipelineJob}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1.PipelineJob|PipelineJob}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/pipeline_service.list_pipeline_jobs.js * region_tag:aiplatform_v1_generated_PipelineService_ListPipelineJobs_async @@ -3118,7 +3105,7 @@ export class PipelineServiceClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -3139,8 +3126,7 @@ export class PipelineServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -3166,7 +3152,7 @@ export class PipelineServiceClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -3187,8 +3173,7 @@ export class PipelineServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -3215,7 +3200,7 @@ export class PipelineServiceClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -3230,8 +3215,7 @@ export class PipelineServiceClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` @@ -3277,12 +3261,11 @@ export class PipelineServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` @@ -5387,6 +5370,55 @@ export class PipelineServiceClient { .saved_query; } + /** + * Return a fully-qualified schedule resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} schedule + * @returns {string} Resource name string. + */ + schedulePath(project: string, location: string, schedule: string) { + return this.pathTemplates.schedulePathTemplate.render({ + project: project, + location: location, + schedule: schedule, + }); + } + + /** + * Parse the project from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the project. + */ + matchProjectFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).project; + } + + /** + * Parse the location from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the location. + */ + matchLocationFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).location; + } + + /** + * Parse the schedule from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the schedule. + */ + matchScheduleFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).schedule; + } + /** * Return a fully-qualified specialistPool resource name string. * diff --git a/packages/google-cloud-aiplatform/src/v1/pipeline_service_proto_list.json b/packages/google-cloud-aiplatform/src/v1/pipeline_service_proto_list.json index f987b709de8..2d74caf069f 100644 --- a/packages/google-cloud-aiplatform/src/v1/pipeline_service_proto_list.json +++ b/packages/google-cloud-aiplatform/src/v1/pipeline_service_proto_list.json @@ -63,6 +63,8 @@ "../../protos/google/cloud/aiplatform/v1/prediction_service.proto", "../../protos/google/cloud/aiplatform/v1/publisher_model.proto", "../../protos/google/cloud/aiplatform/v1/saved_query.proto", + "../../protos/google/cloud/aiplatform/v1/schedule.proto", + "../../protos/google/cloud/aiplatform/v1/schedule_service.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_classification.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_object_detection.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_segmentation.proto", diff --git a/packages/google-cloud-aiplatform/src/v1/prediction_service_client.ts b/packages/google-cloud-aiplatform/src/v1/prediction_service_client.ts index 558dce4c79f..934ddcce23e 100644 --- a/packages/google-cloud-aiplatform/src/v1/prediction_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1/prediction_service_client.ts @@ -28,7 +28,7 @@ import type { LocationsClient, LocationProtos, } from 'google-gax'; - +import {PassThrough} from 'stream'; import * as protos from '../../protos/protos'; import jsonProtos = require('../../protos/protos.json'); /** @@ -274,6 +274,9 @@ export class PredictionServiceClient { savedQueryPathTemplate: new this._gaxModule.PathTemplate( 'projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}' ), + schedulePathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/schedules/{schedule}' + ), specialistPoolPathTemplate: new this._gaxModule.PathTemplate( 'projects/{project}/locations/{location}/specialistPools/{specialist_pool}' ), @@ -300,6 +303,15 @@ export class PredictionServiceClient { ), }; + // Some of the methods on this service provide streaming responses. + // Provide descriptors for these. + this.descriptors.stream = { + serverStreamingPredict: new this._gaxModule.StreamDescriptor( + this._gaxModule.StreamType.SERVER_STREAMING, + opts.fallback === 'rest' + ), + }; + // Put together the default options sent with requests. this._defaults = this._gaxGrpc.constructSettings( 'google.cloud.aiplatform.v1.PredictionService', @@ -349,12 +361,29 @@ export class PredictionServiceClient { // Iterate over each of the methods that the service provides // and create an API call method for each. - const predictionServiceStubMethods = ['predict', 'rawPredict', 'explain']; + const predictionServiceStubMethods = [ + 'predict', + 'rawPredict', + 'serverStreamingPredict', + 'explain', + ]; for (const methodName of predictionServiceStubMethods) { const callPromise = this.predictionServiceStub.then( stub => (...args: Array<{}>) => { if (this._terminated) { + if (methodName in this.descriptors.stream) { + const stream = new PassThrough(); + setImmediate(() => { + stream.emit( + 'error', + new this._gaxModule.GoogleError( + 'The client has already been closed.' + ) + ); + }); + return stream; + } return Promise.reject('The client has already been closed.'); } const func = stub[methodName]; @@ -365,7 +394,7 @@ export class PredictionServiceClient { } ); - const descriptor = undefined; + const descriptor = this.descriptors.stream[methodName] || undefined; const apiCall = this._gaxModule.createApiCall( callPromise, this._defaults[methodName], @@ -448,21 +477,20 @@ export class PredictionServiceClient { * in case of AutoML Models, or, in case of customer created Models, the * behaviour is as documented by that Model. * The schema of any single instance may be specified via Endpoint's - * DeployedModels' {@link google.cloud.aiplatform.v1.DeployedModel.model|Model's} - * {@link google.cloud.aiplatform.v1.Model.predict_schemata|PredictSchemata's} - * {@link google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri|instance_schema_uri}. + * DeployedModels' {@link protos.google.cloud.aiplatform.v1.DeployedModel.model|Model's} + * {@link protos.google.cloud.aiplatform.v1.Model.predict_schemata|PredictSchemata's} + * {@link protos.google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri|instance_schema_uri}. * @param {google.protobuf.Value} request.parameters * The parameters that govern the prediction. The schema of the parameters may * be specified via Endpoint's DeployedModels' [Model's * ][google.cloud.aiplatform.v1.DeployedModel.model] - * {@link google.cloud.aiplatform.v1.Model.predict_schemata|PredictSchemata's} - * {@link google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri|parameters_schema_uri}. + * {@link protos.google.cloud.aiplatform.v1.Model.predict_schemata|PredictSchemata's} + * {@link protos.google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri|parameters_schema_uri}. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.PredictResponse | PredictResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.PredictResponse|PredictResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/prediction_service.predict.js * region_tag:aiplatform_v1_generated_PredictionService_Predict_async @@ -539,11 +567,11 @@ export class PredictionServiceClient { * The response includes the following HTTP headers: * * * `X-Vertex-AI-Endpoint-Id`: ID of the - * {@link google.cloud.aiplatform.v1.Endpoint|Endpoint} that served this + * {@link protos.google.cloud.aiplatform.v1.Endpoint|Endpoint} that served this * prediction. * * * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's - * {@link google.cloud.aiplatform.v1.DeployedModel|DeployedModel} that served this + * {@link protos.google.cloud.aiplatform.v1.DeployedModel|DeployedModel} that served this * prediction. * * @param {Object} request @@ -555,25 +583,24 @@ export class PredictionServiceClient { * @param {google.api.HttpBody} request.httpBody * The prediction input. Supports HTTP headers and arbitrary data payload. * - * A {@link google.cloud.aiplatform.v1.DeployedModel|DeployedModel} may have an + * A {@link protos.google.cloud.aiplatform.v1.DeployedModel|DeployedModel} may have an * upper limit on the number of instances it supports per request. When this * limit it is exceeded for an AutoML model, the - * {@link google.cloud.aiplatform.v1.PredictionService.RawPredict|RawPredict} + * {@link protos.google.cloud.aiplatform.v1.PredictionService.RawPredict|RawPredict} * method returns an error. When this limit is exceeded for a custom-trained * model, the behavior varies depending on the model. * * You can specify the schema for each instance in the - * {@link google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri|predict_schemata.instance_schema_uri} - * field when you create a {@link google.cloud.aiplatform.v1.Model|Model}. This + * {@link protos.google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri|predict_schemata.instance_schema_uri} + * field when you create a {@link protos.google.cloud.aiplatform.v1.Model|Model}. This * schema applies when you deploy the `Model` as a `DeployedModel` to an - * {@link google.cloud.aiplatform.v1.Endpoint|Endpoint} and use the `RawPredict` + * {@link protos.google.cloud.aiplatform.v1.Endpoint|Endpoint} and use the `RawPredict` * method. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.api.HttpBody | HttpBody}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.api.HttpBody|HttpBody}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/prediction_service.raw_predict.js * region_tag:aiplatform_v1_generated_PredictionService_RawPredict_async @@ -650,13 +677,13 @@ export class PredictionServiceClient { * Perform an online explanation. * * If - * {@link google.cloud.aiplatform.v1.ExplainRequest.deployed_model_id|deployed_model_id} + * {@link protos.google.cloud.aiplatform.v1.ExplainRequest.deployed_model_id|deployed_model_id} * is specified, the corresponding DeployModel must have - * {@link google.cloud.aiplatform.v1.DeployedModel.explanation_spec|explanation_spec} + * {@link protos.google.cloud.aiplatform.v1.DeployedModel.explanation_spec|explanation_spec} * populated. If - * {@link google.cloud.aiplatform.v1.ExplainRequest.deployed_model_id|deployed_model_id} + * {@link protos.google.cloud.aiplatform.v1.ExplainRequest.deployed_model_id|deployed_model_id} * is not specified, all DeployedModels must have - * {@link google.cloud.aiplatform.v1.DeployedModel.explanation_spec|explanation_spec} + * {@link protos.google.cloud.aiplatform.v1.DeployedModel.explanation_spec|explanation_spec} * populated. * * @param {Object} request @@ -672,18 +699,18 @@ export class PredictionServiceClient { * in case of AutoML Models, or, in case of customer created Models, the * behaviour is as documented by that Model. * The schema of any single instance may be specified via Endpoint's - * DeployedModels' {@link google.cloud.aiplatform.v1.DeployedModel.model|Model's} - * {@link google.cloud.aiplatform.v1.Model.predict_schemata|PredictSchemata's} - * {@link google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri|instance_schema_uri}. + * DeployedModels' {@link protos.google.cloud.aiplatform.v1.DeployedModel.model|Model's} + * {@link protos.google.cloud.aiplatform.v1.Model.predict_schemata|PredictSchemata's} + * {@link protos.google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri|instance_schema_uri}. * @param {google.protobuf.Value} request.parameters * The parameters that govern the prediction. The schema of the parameters may * be specified via Endpoint's DeployedModels' [Model's * ][google.cloud.aiplatform.v1.DeployedModel.model] - * {@link google.cloud.aiplatform.v1.Model.predict_schemata|PredictSchemata's} - * {@link google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri|parameters_schema_uri}. + * {@link protos.google.cloud.aiplatform.v1.Model.predict_schemata|PredictSchemata's} + * {@link protos.google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri|parameters_schema_uri}. * @param {google.cloud.aiplatform.v1.ExplanationSpecOverride} request.explanationSpecOverride * If specified, overrides the - * {@link google.cloud.aiplatform.v1.DeployedModel.explanation_spec|explanation_spec} + * {@link protos.google.cloud.aiplatform.v1.DeployedModel.explanation_spec|explanation_spec} * of the DeployedModel. Can be used for explaining prediction results with * different configurations, such as: * - Explaining top-5 predictions results as opposed to top-1; @@ -693,13 +720,12 @@ export class PredictionServiceClient { * @param {string} request.deployedModelId * If specified, this ExplainRequest will be served by the chosen * DeployedModel, overriding - * {@link google.cloud.aiplatform.v1.Endpoint.traffic_split|Endpoint.traffic_split}. + * {@link protos.google.cloud.aiplatform.v1.Endpoint.traffic_split|Endpoint.traffic_split}. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.ExplainResponse | ExplainResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.ExplainResponse|ExplainResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/prediction_service.explain.js * region_tag:aiplatform_v1_generated_PredictionService_Explain_async @@ -771,6 +797,45 @@ export class PredictionServiceClient { return this.innerApiCalls.explain(request, options, callback); } + /** + * Perform a server-side streaming online prediction request for Vertex + * LLM streaming. + * + * @param {Object} request + * The request object that will be sent. + * @param {string} request.endpoint + * Required. The name of the Endpoint requested to serve the prediction. + * Format: + * `projects/{project}/locations/{location}/endpoints/{endpoint}` + * @param {number[]} request.inputs + * The prediction input. + * @param {google.cloud.aiplatform.v1.Tensor} request.parameters + * The parameters that govern the prediction. + * @param {object} [options] + * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. + * @returns {Stream} + * An object stream which emits {@link protos.google.cloud.aiplatform.v1.StreamingPredictResponse|StreamingPredictResponse} on 'data' event. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#server-streaming | documentation } + * for more details and examples. + * @example include:samples/generated/v1/prediction_service.server_streaming_predict.js + * region_tag:aiplatform_v1_generated_PredictionService_ServerStreamingPredict_async + */ + serverStreamingPredict( + request?: protos.google.cloud.aiplatform.v1.IStreamingPredictRequest, + options?: CallOptions + ): gax.CancellableStream { + request = request || {}; + options = options || {}; + options.otherArgs = options.otherArgs || {}; + options.otherArgs.headers = options.otherArgs.headers || {}; + options.otherArgs.headers['x-goog-request-params'] = + this._gaxModule.routingHeader.fromParams({ + endpoint: request.endpoint ?? '', + }); + this.initialize(); + return this.innerApiCalls.serverStreamingPredict(request, options); + } + /** * Gets the access control policy for a resource. Returns an empty policy * if the resource exists and does not have a policy set. @@ -810,7 +875,7 @@ export class PredictionServiceClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -831,8 +896,7 @@ export class PredictionServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -858,7 +922,7 @@ export class PredictionServiceClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -879,8 +943,7 @@ export class PredictionServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -907,7 +970,7 @@ export class PredictionServiceClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -922,8 +985,7 @@ export class PredictionServiceClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` @@ -969,12 +1031,11 @@ export class PredictionServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` @@ -2868,6 +2929,55 @@ export class PredictionServiceClient { .saved_query; } + /** + * Return a fully-qualified schedule resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} schedule + * @returns {string} Resource name string. + */ + schedulePath(project: string, location: string, schedule: string) { + return this.pathTemplates.schedulePathTemplate.render({ + project: project, + location: location, + schedule: schedule, + }); + } + + /** + * Parse the project from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the project. + */ + matchProjectFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).project; + } + + /** + * Parse the location from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the location. + */ + matchLocationFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).location; + } + + /** + * Parse the schedule from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the schedule. + */ + matchScheduleFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).schedule; + } + /** * Return a fully-qualified specialistPool resource name string. * diff --git a/packages/google-cloud-aiplatform/src/v1/prediction_service_client_config.json b/packages/google-cloud-aiplatform/src/v1/prediction_service_client_config.json index e043161e514..94aad7f1d0d 100644 --- a/packages/google-cloud-aiplatform/src/v1/prediction_service_client_config.json +++ b/packages/google-cloud-aiplatform/src/v1/prediction_service_client_config.json @@ -28,6 +28,10 @@ "retry_codes_name": "non_idempotent", "retry_params_name": "default" }, + "ServerStreamingPredict": { + "retry_codes_name": "non_idempotent", + "retry_params_name": "default" + }, "Explain": { "retry_codes_name": "non_idempotent", "retry_params_name": "default" diff --git a/packages/google-cloud-aiplatform/src/v1/prediction_service_proto_list.json b/packages/google-cloud-aiplatform/src/v1/prediction_service_proto_list.json index f987b709de8..2d74caf069f 100644 --- a/packages/google-cloud-aiplatform/src/v1/prediction_service_proto_list.json +++ b/packages/google-cloud-aiplatform/src/v1/prediction_service_proto_list.json @@ -63,6 +63,8 @@ "../../protos/google/cloud/aiplatform/v1/prediction_service.proto", "../../protos/google/cloud/aiplatform/v1/publisher_model.proto", "../../protos/google/cloud/aiplatform/v1/saved_query.proto", + "../../protos/google/cloud/aiplatform/v1/schedule.proto", + "../../protos/google/cloud/aiplatform/v1/schedule_service.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_classification.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_object_detection.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_segmentation.proto", diff --git a/packages/google-cloud-aiplatform/src/v1/schedule_service_client.ts b/packages/google-cloud-aiplatform/src/v1/schedule_service_client.ts new file mode 100644 index 00000000000..a14c5beebe4 --- /dev/null +++ b/packages/google-cloud-aiplatform/src/v1/schedule_service_client.ts @@ -0,0 +1,5437 @@ +// Copyright 2023 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. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + +/* global window */ +import type * as gax from 'google-gax'; +import type { + Callback, + CallOptions, + Descriptors, + ClientOptions, + GrpcClientOptions, + LROperation, + PaginationCallback, + GaxCall, + IamClient, + IamProtos, + LocationsClient, + LocationProtos, +} from 'google-gax'; +import {Transform} from 'stream'; +import * as protos from '../../protos/protos'; +import jsonProtos = require('../../protos/protos.json'); +/** + * Client JSON configuration object, loaded from + * `src/v1/schedule_service_client_config.json`. + * This file defines retry strategy and timeouts for all API methods in this library. + */ +import * as gapicConfig from './schedule_service_client_config.json'; +const version = require('../../../package.json').version; + +/** + * A service for creating and managing Vertex AI's Schedule resources to + * periodically launch shceudled runs to make API calls. + * @class + * @memberof v1 + */ +export class ScheduleServiceClient { + private _terminated = false; + private _opts: ClientOptions; + private _providedCustomServicePath: boolean; + private _gaxModule: typeof gax | typeof gax.fallback; + private _gaxGrpc: gax.GrpcClient | gax.fallback.GrpcClient; + private _protos: {}; + private _defaults: {[method: string]: gax.CallSettings}; + auth: gax.GoogleAuth; + descriptors: Descriptors = { + page: {}, + stream: {}, + longrunning: {}, + batching: {}, + }; + warn: (code: string, message: string, warnType?: string) => void; + innerApiCalls: {[name: string]: Function}; + iamClient: IamClient; + locationsClient: LocationsClient; + pathTemplates: {[name: string]: gax.PathTemplate}; + operationsClient: gax.OperationsClient; + scheduleServiceStub?: Promise<{[name: string]: Function}>; + + /** + * Construct an instance of ScheduleServiceClient. + * + * @param {object} [options] - The configuration object. + * The options accepted by the constructor are described in detail + * in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance). + * The common options are: + * @param {object} [options.credentials] - Credentials object. + * @param {string} [options.credentials.client_email] + * @param {string} [options.credentials.private_key] + * @param {string} [options.email] - Account email address. Required when + * using a .pem or .p12 keyFilename. + * @param {string} [options.keyFilename] - Full path to the a .json, .pem, or + * .p12 key downloaded from the Google Developers Console. If you provide + * a path to a JSON file, the projectId option below is not necessary. + * NOTE: .pem and .p12 require you to specify options.email as well. + * @param {number} [options.port] - The port on which to connect to + * the remote host. + * @param {string} [options.projectId] - The project ID from the Google + * Developer's Console, e.g. 'grape-spaceship-123'. We will also check + * the environment variable GCLOUD_PROJECT for your project ID. If your + * app is running in an environment which supports + * {@link https://developers.google.com/identity/protocols/application-default-credentials Application Default Credentials}, + * your project ID will be detected automatically. + * @param {string} [options.apiEndpoint] - The domain name of the + * API remote host. + * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override. + * Follows the structure of {@link gapicConfig}. + * @param {boolean | "rest"} [options.fallback] - Use HTTP fallback mode. + * Pass "rest" to use HTTP/1.1 REST API instead of gRPC. + * For more information, please check the + * {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}. + * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you + * need to avoid loading the default gRPC version and want to use the fallback + * HTTP implementation. Load only fallback version and pass it to the constructor: + * ``` + * const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC + * const client = new ScheduleServiceClient({fallback: 'rest'}, gax); + * ``` + */ + constructor( + opts?: ClientOptions, + gaxInstance?: typeof gax | typeof gax.fallback + ) { + // Ensure that options include all the required fields. + const staticMembers = this.constructor as typeof ScheduleServiceClient; + const servicePath = + opts?.servicePath || opts?.apiEndpoint || staticMembers.servicePath; + this._providedCustomServicePath = !!( + opts?.servicePath || opts?.apiEndpoint + ); + const port = opts?.port || staticMembers.port; + const clientConfig = opts?.clientConfig ?? {}; + const fallback = + opts?.fallback ?? + (typeof window !== 'undefined' && typeof window?.fetch === 'function'); + opts = Object.assign({servicePath, port, clientConfig, fallback}, opts); + + // If scopes are unset in options and we're connecting to a non-default endpoint, set scopes just in case. + if (servicePath !== staticMembers.servicePath && !('scopes' in opts)) { + opts['scopes'] = staticMembers.scopes; + } + + // Load google-gax module synchronously if needed + if (!gaxInstance) { + gaxInstance = require('google-gax') as typeof gax; + } + + // Choose either gRPC or proto-over-HTTP implementation of google-gax. + this._gaxModule = opts.fallback ? gaxInstance.fallback : gaxInstance; + + // Create a `gaxGrpc` object, with any grpc-specific options sent to the client. + this._gaxGrpc = new this._gaxModule.GrpcClient(opts); + + // Save options to use in initialize() method. + this._opts = opts; + + // Save the auth object to the client, for use by other methods. + this.auth = this._gaxGrpc.auth as gax.GoogleAuth; + + // Set useJWTAccessWithScope on the auth object. + this.auth.useJWTAccessWithScope = true; + + // Set defaultServicePath on the auth object. + this.auth.defaultServicePath = staticMembers.servicePath; + + // Set the default scopes in auth client if needed. + if (servicePath === staticMembers.servicePath) { + this.auth.defaultScopes = staticMembers.scopes; + } + this.iamClient = new this._gaxModule.IamClient(this._gaxGrpc, opts); + + this.locationsClient = new this._gaxModule.LocationsClient( + this._gaxGrpc, + opts + ); + + // Determine the client header string. + const clientHeader = [`gax/${this._gaxModule.version}`, `gapic/${version}`]; + if (typeof process !== 'undefined' && 'versions' in process) { + clientHeader.push(`gl-node/${process.versions.node}`); + } else { + clientHeader.push(`gl-web/${this._gaxModule.version}`); + } + if (!opts.fallback) { + clientHeader.push(`grpc/${this._gaxGrpc.grpcVersion}`); + } else if (opts.fallback === 'rest') { + clientHeader.push(`rest/${this._gaxGrpc.grpcVersion}`); + } + if (opts.libName && opts.libVersion) { + clientHeader.push(`${opts.libName}/${opts.libVersion}`); + } + // Load the applicable protos. + this._protos = this._gaxGrpc.loadProtoJSON(jsonProtos); + + // This API contains "path templates"; forward-slash-separated + // identifiers to uniquely identify resources within the API. + // Create useful helper objects for these. + this.pathTemplates = { + annotationPathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}/annotations/{annotation}' + ), + annotationSpecPathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}' + ), + artifactPathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}' + ), + batchPredictionJobPathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}' + ), + contextPathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/metadataStores/{metadata_store}/contexts/{context}' + ), + customJobPathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/customJobs/{custom_job}' + ), + dataItemPathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}' + ), + dataLabelingJobPathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}' + ), + datasetPathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/datasets/{dataset}' + ), + entityTypePathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}' + ), + executionPathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/metadataStores/{metadata_store}/executions/{execution}' + ), + featurePathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}' + ), + featurestorePathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/featurestores/{featurestore}' + ), + hyperparameterTuningJobPathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}' + ), + indexPathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/indexes/{index}' + ), + indexEndpointPathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}' + ), + locationPathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}' + ), + metadataSchemaPathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/metadataStores/{metadata_store}/metadataSchemas/{metadata_schema}' + ), + metadataStorePathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/metadataStores/{metadata_store}' + ), + modelPathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/models/{model}' + ), + modelDeploymentMonitoringJobPathTemplate: + new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}' + ), + modelEvaluationPathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}' + ), + modelEvaluationSlicePathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}/slices/{slice}' + ), + nasJobPathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/nasJobs/{nas_job}' + ), + nasTrialDetailPathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/nasJobs/{nas_job}/nasTrialDetails/{nas_trial_detail}' + ), + pipelineJobPathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}' + ), + projectLocationEndpointPathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/endpoints/{endpoint}' + ), + projectLocationPublisherModelPathTemplate: + new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/publishers/{publisher}/models/{model}' + ), + publisherModelPathTemplate: new this._gaxModule.PathTemplate( + 'publishers/{publisher}/models/{model}' + ), + savedQueryPathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}' + ), + schedulePathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/schedules/{schedule}' + ), + specialistPoolPathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/specialistPools/{specialist_pool}' + ), + studyPathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/studies/{study}' + ), + tensorboardPathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/tensorboards/{tensorboard}' + ), + tensorboardExperimentPathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}' + ), + tensorboardRunPathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}' + ), + tensorboardTimeSeriesPathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}' + ), + trainingPipelinePathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}' + ), + trialPathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/studies/{study}/trials/{trial}' + ), + }; + + // Some of the methods on this service return "paged" results, + // (e.g. 50 results at a time, with tokens to get subsequent + // pages). Denote the keys used for pagination and results. + this.descriptors.page = { + listSchedules: new this._gaxModule.PageDescriptor( + 'pageToken', + 'nextPageToken', + 'schedules' + ), + }; + + const protoFilesRoot = this._gaxModule.protobuf.Root.fromJSON(jsonProtos); + // This API contains "long-running operations", which return a + // an Operation object that allows for tracking of the operation, + // rather than holding a request open. + const lroOptions: GrpcClientOptions = { + auth: this.auth, + grpc: 'grpc' in this._gaxGrpc ? this._gaxGrpc.grpc : undefined, + }; + if (opts.fallback === 'rest') { + lroOptions.protoJson = protoFilesRoot; + lroOptions.httpRules = [ + { + selector: 'google.cloud.location.Locations.GetLocation', + get: '/ui/{name=projects/*/locations/*}', + additional_bindings: [{get: '/v1/{name=projects/*/locations/*}'}], + }, + { + selector: 'google.cloud.location.Locations.ListLocations', + get: '/ui/{name=projects/*}/locations', + additional_bindings: [{get: '/v1/{name=projects/*}/locations'}], + }, + { + selector: 'google.iam.v1.IAMPolicy.GetIamPolicy', + post: '/v1/{resource=projects/*/locations/*/featurestores/*}:getIamPolicy', + additional_bindings: [ + { + post: '/v1/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:getIamPolicy', + }, + { + post: '/ui/{resource=projects/*/locations/*/featurestores/*}:getIamPolicy', + }, + { + post: '/ui/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:getIamPolicy', + }, + { + post: '/ui/{resource=projects/*/locations/*/models/*}:getIamPolicy', + }, + { + post: '/ui/{resource=projects/*/locations/*/endpoints/*}:getIamPolicy', + }, + { + post: '/ui/{resource=projects/*/locations/*/notebookRuntimeTemplates/*}:getIamPolicy', + }, + ], + }, + { + selector: 'google.iam.v1.IAMPolicy.SetIamPolicy', + post: '/v1/{resource=projects/*/locations/*/featurestores/*}:setIamPolicy', + body: '*', + additional_bindings: [ + { + post: '/v1/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:setIamPolicy', + body: '*', + }, + { + post: '/ui/{resource=projects/*/locations/*/featurestores/*}:setIamPolicy', + body: '*', + }, + { + post: '/ui/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:setIamPolicy', + body: '*', + }, + { + post: '/ui/{resource=projects/*/locations/*/models/*}:setIamPolicy', + body: '*', + }, + { + post: '/ui/{resource=projects/*/locations/*/endpoints/*}:setIamPolicy', + body: '*', + }, + { + post: '/ui/{resource=projects/*/locations/*/notebookRuntimeTemplates/*}:setIamPolicy', + body: '*', + }, + ], + }, + { + selector: 'google.iam.v1.IAMPolicy.TestIamPermissions', + post: '/v1/{resource=projects/*/locations/*/featurestores/*}:testIamPermissions', + additional_bindings: [ + { + post: '/v1/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:testIamPermissions', + }, + { + post: '/ui/{resource=projects/*/locations/*/featurestores/*}:testIamPermissions', + }, + { + post: '/ui/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:testIamPermissions', + }, + { + post: '/ui/{resource=projects/*/locations/*/models/*}:testIamPermissions', + }, + { + post: '/ui/{resource=projects/*/locations/*/endpoints/*}:testIamPermissions', + }, + { + post: '/ui/{resource=projects/*/locations/*/notebookRuntimeTemplates/*}:testIamPermissions', + }, + ], + }, + { + selector: 'google.longrunning.Operations.CancelOperation', + post: '/ui/{name=projects/*/locations/*/operations/*}:cancel', + additional_bindings: [ + { + post: '/ui/{name=projects/*/locations/*/datasets/*/operations/*}:cancel', + }, + { + post: '/ui/{name=projects/*/locations/*/datasets/*/dataItems/*/operations/*}:cancel', + }, + { + post: '/ui/{name=projects/*/locations/*/datasets/*/savedQueries/*/operations/*}:cancel', + }, + { + post: '/ui/{name=projects/*/locations/*/datasets/*/annotationSpecs/*/operations/*}:cancel', + }, + { + post: '/ui/{name=projects/*/locations/*/datasets/*/dataItems/*/annotations/*/operations/*}:cancel', + }, + { + post: '/ui/{name=projects/*/locations/*/deploymentResourcePools/*/operations/*}:cancel', + }, + { + post: '/ui/{name=projects/*/locations/*/edgeDevices/*/operations/*}:cancel', + }, + { + post: '/ui/{name=projects/*/locations/*/endpoints/*/operations/*}:cancel', + }, + { + post: '/ui/{name=projects/*/locations/*/featurestores/*/operations/*}:cancel', + }, + { + post: '/ui/{name=projects/*/locations/*/featurestores/*/entityTypes/*/operations/*}:cancel', + }, + { + post: '/ui/{name=projects/*/locations/*/featurestores/*/entityTypes/*/features/*/operations/*}:cancel', + }, + { + post: '/ui/{name=projects/*/locations/*/customJobs/*/operations/*}:cancel', + }, + { + post: '/ui/{name=projects/*/locations/*/dataLabelingJobs/*/operations/*}:cancel', + }, + { + post: '/ui/{name=projects/*/locations/*/hyperparameterTuningJobs/*/operations/*}:cancel', + }, + { + post: '/ui/{name=projects/*/locations/*/indexes/*/operations/*}:cancel', + }, + { + post: '/ui/{name=projects/*/locations/*/indexEndpoints/*/operations/*}:cancel', + }, + { + post: '/ui/{name=projects/*/locations/*/modelDeploymentMonitoringJobs/*/operations/*}:cancel', + }, + { + post: '/ui/{name=projects/*/locations/*/modelMonitors/*/operations/*}:cancel', + }, + { + post: '/ui/{name=projects/*/locations/*/migratableResources/*/operations/*}:cancel', + }, + { + post: '/ui/{name=projects/*/locations/*/models/*/operations/*}:cancel', + }, + { + post: '/ui/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}:cancel', + }, + { + post: '/ui/{name=projects/*/locations/*/studies/*/operations/*}:cancel', + }, + { + post: '/ui/{name=projects/*/locations/*/studies/*/trials/*/operations/*}:cancel', + }, + { + post: '/ui/{name=projects/*/locations/*/trainingPipelines/*/operations/*}:cancel', + }, + { + post: '/ui/{name=projects/*/locations/*/pipelineJobs/*/operations/*}:cancel', + }, + { + post: '/ui/{name=projects/*/locations/*/schedules/*/operations/*}:cancel', + }, + { + post: '/ui/{name=projects/*/locations/*/specialistPools/*/operations/*}:cancel', + }, + { + post: '/ui/{name=projects/*/locations/*/tensorboards/*/operations/*}:cancel', + }, + { + post: '/ui/{name=projects/*/locations/*/tensorboards/*/experiments/*/operations/*}:cancel', + }, + { + post: '/ui/{name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/operations/*}:cancel', + }, + { + post: '/ui/{name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*/operations/*}:cancel', + }, + {post: '/v1/{name=projects/*/locations/*/operations/*}:cancel'}, + { + post: '/v1/{name=projects/*/locations/*/datasets/*/operations/*}:cancel', + }, + { + post: '/v1/{name=projects/*/locations/*/datasets/*/dataItems/*/operations/*}:cancel', + }, + { + post: '/v1/{name=projects/*/locations/*/datasets/*/savedQueries/*/operations/*}:cancel', + }, + { + post: '/v1/{name=projects/*/locations/*/datasets/*/annotationSpecs/*/operations/*}:cancel', + }, + { + post: '/v1/{name=projects/*/locations/*/datasets/*/dataItems/*/annotations/*/operations/*}:cancel', + }, + { + post: '/v1/{name=projects/*/locations/*/deploymentResourcePools/*/operations/*}:cancel', + }, + { + post: '/v1/{name=projects/*/locations/*/endpoints/*/operations/*}:cancel', + }, + { + post: '/v1/{name=projects/*/locations/*/featurestores/*/operations/*}:cancel', + }, + { + post: '/v1/{name=projects/*/locations/*/featurestores/*/entityTypes/*/operations/*}:cancel', + }, + { + post: '/v1/{name=projects/*/locations/*/featurestores/*/entityTypes/*/features/*/operations/*}:cancel', + }, + { + post: '/v1/{name=projects/*/locations/*/customJobs/*/operations/*}:cancel', + }, + { + post: '/v1/{name=projects/*/locations/*/dataLabelingJobs/*/operations/*}:cancel', + }, + { + post: '/v1/{name=projects/*/locations/*/hyperparameterTuningJobs/*/operations/*}:cancel', + }, + { + post: '/v1/{name=projects/*/locations/*/indexes/*/operations/*}:cancel', + }, + { + post: '/v1/{name=projects/*/locations/*/indexEndpoints/*/operations/*}:cancel', + }, + { + post: '/v1/{name=projects/*/locations/*/modelDeploymentMonitoringJobs/*/operations/*}:cancel', + }, + { + post: '/v1/{name=projects/*/locations/*/migratableResources/*/operations/*}:cancel', + }, + { + post: '/v1/{name=projects/*/locations/*/models/*/operations/*}:cancel', + }, + { + post: '/v1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}:cancel', + }, + { + post: '/v1/{name=projects/*/locations/*/studies/*/operations/*}:cancel', + }, + { + post: '/v1/{name=projects/*/locations/*/studies/*/trials/*/operations/*}:cancel', + }, + { + post: '/v1/{name=projects/*/locations/*/trainingPipelines/*/operations/*}:cancel', + }, + { + post: '/v1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}:cancel', + }, + { + post: '/v1/{name=projects/*/locations/*/schedules/*/operations/*}:cancel', + }, + { + post: '/v1/{name=projects/*/locations/*/specialistPools/*/operations/*}:cancel', + }, + { + post: '/v1/{name=projects/*/locations/*/tensorboards/*/operations/*}:cancel', + }, + { + post: '/v1/{name=projects/*/locations/*/tensorboards/*/experiments/*/operations/*}:cancel', + }, + { + post: '/v1/{name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/operations/*}:cancel', + }, + { + post: '/v1/{name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*/operations/*}:cancel', + }, + ], + }, + { + selector: 'google.longrunning.Operations.DeleteOperation', + delete: '/ui/{name=projects/*/locations/*/operations/*}', + additional_bindings: [ + { + delete: + '/ui/{name=projects/*/locations/*/datasets/*/operations/*}', + }, + { + delete: + '/ui/{name=projects/*/locations/*/datasets/*/dataItems/*/operations/*}', + }, + { + delete: + '/ui/{name=projects/*/locations/*/datasets/*/savedQueries/*/operations/*}', + }, + { + delete: + '/ui/{name=projects/*/locations/*/datasets/*/annotationSpecs/*/operations/*}', + }, + { + delete: + '/ui/{name=projects/*/locations/*/datasets/*/dataItems/*/annotations/*/operations/*}', + }, + { + delete: + '/ui/{name=projects/*/locations/*/deploymentResourcePools/*/operations/*}', + }, + { + delete: + '/ui/{name=projects/*/locations/*/edgeDevices/*/operations/*}', + }, + { + delete: + '/ui/{name=projects/*/locations/*/endpoints/*/operations/*}', + }, + { + delete: + '/ui/{name=projects/*/locations/*/featurestores/*/operations/*}', + }, + { + delete: + '/ui/{name=projects/*/locations/*/featurestores/*/entityTypes/*/operations/*}', + }, + { + delete: + '/ui/{name=projects/*/locations/*/featurestores/*/entityTypes/*/features/*/operations/*}', + }, + { + delete: + '/ui/{name=projects/*/locations/*/customJobs/*/operations/*}', + }, + { + delete: + '/ui/{name=projects/*/locations/*/dataLabelingJobs/*/operations/*}', + }, + { + delete: + '/ui/{name=projects/*/locations/*/hyperparameterTuningJobs/*/operations/*}', + }, + { + delete: + '/ui/{name=projects/*/locations/*/indexes/*/operations/*}', + }, + { + delete: + '/ui/{name=projects/*/locations/*/indexEndpoints/*/operations/*}', + }, + { + delete: + '/ui/{name=projects/*/locations/*/modelDeploymentMonitoringJobs/*/operations/*}', + }, + { + delete: + '/ui/{name=projects/*/locations/*/modelMonitors/*/operations/*}', + }, + { + delete: + '/ui/{name=projects/*/locations/*/migratableResources/*/operations/*}', + }, + {delete: '/ui/{name=projects/*/locations/*/models/*/operations/*}'}, + { + delete: + '/ui/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}', + }, + { + delete: + '/ui/{name=projects/*/locations/*/studies/*/operations/*}', + }, + { + delete: + '/ui/{name=projects/*/locations/*/studies/*/trials/*/operations/*}', + }, + { + delete: + '/ui/{name=projects/*/locations/*/trainingPipelines/*/operations/*}', + }, + { + delete: + '/ui/{name=projects/*/locations/*/pipelineJobs/*/operations/*}', + }, + { + delete: + '/ui/{name=projects/*/locations/*/schedules/*/operations/*}', + }, + { + delete: + '/ui/{name=projects/*/locations/*/specialistPools/*/operations/*}', + }, + { + delete: + '/ui/{name=projects/*/locations/*/tensorboards/*/operations/*}', + }, + { + delete: + '/ui/{name=projects/*/locations/*/tensorboards/*/experiments/*/operations/*}', + }, + { + delete: + '/ui/{name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/operations/*}', + }, + { + delete: + '/ui/{name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*/operations/*}', + }, + {delete: '/v1/{name=projects/*/locations/*/operations/*}'}, + { + delete: + '/v1/{name=projects/*/locations/*/datasets/*/operations/*}', + }, + { + delete: + '/v1/{name=projects/*/locations/*/datasets/*/dataItems/*/operations/*}', + }, + { + delete: + '/v1/{name=projects/*/locations/*/datasets/*/savedQueries/*/operations/*}', + }, + { + delete: + '/v1/{name=projects/*/locations/*/datasets/*/annotationSpecs/*/operations/*}', + }, + { + delete: + '/v1/{name=projects/*/locations/*/datasets/*/dataItems/*/annotations/*/operations/*}', + }, + { + delete: + '/v1/{name=projects/*/locations/*/deploymentResourcePools/*/operations/*}', + }, + { + delete: + '/v1/{name=projects/*/locations/*/endpoints/*/operations/*}', + }, + { + delete: + '/v1/{name=projects/*/locations/*/featurestores/*/operations/*}', + }, + { + delete: + '/v1/{name=projects/*/locations/*/featurestores/*/entityTypes/*/operations/*}', + }, + { + delete: + '/v1/{name=projects/*/locations/*/featurestores/*/entityTypes/*/features/*/operations/*}', + }, + { + delete: + '/v1/{name=projects/*/locations/*/customJobs/*/operations/*}', + }, + { + delete: + '/v1/{name=projects/*/locations/*/dataLabelingJobs/*/operations/*}', + }, + { + delete: + '/v1/{name=projects/*/locations/*/hyperparameterTuningJobs/*/operations/*}', + }, + { + delete: + '/v1/{name=projects/*/locations/*/indexes/*/operations/*}', + }, + { + delete: + '/v1/{name=projects/*/locations/*/indexEndpoints/*/operations/*}', + }, + { + delete: + '/v1/{name=projects/*/locations/*/modelDeploymentMonitoringJobs/*/operations/*}', + }, + { + delete: + '/v1/{name=projects/*/locations/*/migratableResources/*/operations/*}', + }, + {delete: '/v1/{name=projects/*/locations/*/models/*/operations/*}'}, + { + delete: + '/v1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}', + }, + { + delete: + '/v1/{name=projects/*/locations/*/studies/*/operations/*}', + }, + { + delete: + '/v1/{name=projects/*/locations/*/studies/*/trials/*/operations/*}', + }, + { + delete: + '/v1/{name=projects/*/locations/*/trainingPipelines/*/operations/*}', + }, + { + delete: + '/v1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}', + }, + { + delete: + '/v1/{name=projects/*/locations/*/schedules/*/operations/*}', + }, + { + delete: + '/v1/{name=projects/*/locations/*/specialistPools/*/operations/*}', + }, + { + delete: + '/v1/{name=projects/*/locations/*/tensorboards/*/operations/*}', + }, + { + delete: + '/v1/{name=projects/*/locations/*/tensorboards/*/experiments/*/operations/*}', + }, + { + delete: + '/v1/{name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/operations/*}', + }, + { + delete: + '/v1/{name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*/operations/*}', + }, + ], + }, + { + selector: 'google.longrunning.Operations.GetOperation', + get: '/ui/{name=projects/*/locations/*/operations/*}', + additional_bindings: [ + {get: '/ui/{name=projects/*/locations/*/datasets/*/operations/*}'}, + { + get: '/ui/{name=projects/*/locations/*/datasets/*/dataItems/*/operations/*}', + }, + { + get: '/ui/{name=projects/*/locations/*/datasets/*/savedQueries/*/operations/*}', + }, + { + get: '/ui/{name=projects/*/locations/*/datasets/*/annotationSpecs/*/operations/*}', + }, + { + get: '/ui/{name=projects/*/locations/*/datasets/*/dataItems/*/annotations/*/operations/*}', + }, + { + get: '/ui/{name=projects/*/locations/*/deploymentResourcePools/*/operations/*}', + }, + { + get: '/ui/{name=projects/*/locations/*/edgeDeploymentJobs/*/operations/*}', + }, + { + get: '/ui/{name=projects/*/locations/*/edgeDevices/*/operations/*}', + }, + {get: '/ui/{name=projects/*/locations/*/endpoints/*/operations/*}'}, + { + get: '/ui/{name=projects/*/locations/*/featurestores/*/operations/*}', + }, + { + get: '/ui/{name=projects/*/locations/*/featurestores/*/entityTypes/*/operations/*}', + }, + { + get: '/ui/{name=projects/*/locations/*/featurestores/*/entityTypes/*/features/*/operations/*}', + }, + { + get: '/ui/{name=projects/*/locations/*/customJobs/*/operations/*}', + }, + { + get: '/ui/{name=projects/*/locations/*/dataLabelingJobs/*/operations/*}', + }, + { + get: '/ui/{name=projects/*/locations/*/hyperparameterTuningJobs/*/operations/*}', + }, + {get: '/ui/{name=projects/*/locations/*/indexes/*/operations/*}'}, + { + get: '/ui/{name=projects/*/locations/*/indexEndpoints/*/operations/*}', + }, + { + get: '/ui/{name=projects/*/locations/*/modelDeploymentMonitoringJobs/*/operations/*}', + }, + { + get: '/ui/{name=projects/*/locations/*/modelMonitors/*/operations/*}', + }, + { + get: '/ui/{name=projects/*/locations/*/migratableResources/*/operations/*}', + }, + {get: '/ui/{name=projects/*/locations/*/models/*/operations/*}'}, + { + get: '/ui/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}', + }, + {get: '/ui/{name=projects/*/locations/*/studies/*/operations/*}'}, + { + get: '/ui/{name=projects/*/locations/*/studies/*/trials/*/operations/*}', + }, + { + get: '/ui/{name=projects/*/locations/*/trainingPipelines/*/operations/*}', + }, + { + get: '/ui/{name=projects/*/locations/*/pipelineJobs/*/operations/*}', + }, + {get: '/ui/{name=projects/*/locations/*/schedules/*/operations/*}'}, + { + get: '/ui/{name=projects/*/locations/*/specialistPools/*/operations/*}', + }, + { + get: '/ui/{name=projects/*/locations/*/tensorboards/*/operations/*}', + }, + { + get: '/ui/{name=projects/*/locations/*/tensorboards/*/experiments/*/operations/*}', + }, + { + get: '/ui/{name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/operations/*}', + }, + { + get: '/ui/{name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*/operations/*}', + }, + {get: '/v1/{name=projects/*/locations/*/operations/*}'}, + {get: '/v1/{name=projects/*/locations/*/datasets/*/operations/*}'}, + { + get: '/v1/{name=projects/*/locations/*/datasets/*/dataItems/*/operations/*}', + }, + { + get: '/v1/{name=projects/*/locations/*/datasets/*/savedQueries/*/operations/*}', + }, + { + get: '/v1/{name=projects/*/locations/*/datasets/*/annotationSpecs/*/operations/*}', + }, + { + get: '/v1/{name=projects/*/locations/*/datasets/*/dataItems/*/annotations/*/operations/*}', + }, + { + get: '/v1/{name=projects/*/locations/*/deploymentResourcePools/*/operations/*}', + }, + {get: '/v1/{name=projects/*/locations/*/endpoints/*/operations/*}'}, + { + get: '/v1/{name=projects/*/locations/*/featurestores/*/operations/*}', + }, + { + get: '/v1/{name=projects/*/locations/*/featurestores/*/entityTypes/*/operations/*}', + }, + { + get: '/v1/{name=projects/*/locations/*/featurestores/*/entityTypes/*/features/*/operations/*}', + }, + { + get: '/v1/{name=projects/*/locations/*/customJobs/*/operations/*}', + }, + { + get: '/v1/{name=projects/*/locations/*/dataLabelingJobs/*/operations/*}', + }, + { + get: '/v1/{name=projects/*/locations/*/hyperparameterTuningJobs/*/operations/*}', + }, + {get: '/v1/{name=projects/*/locations/*/indexes/*/operations/*}'}, + { + get: '/v1/{name=projects/*/locations/*/indexEndpoints/*/operations/*}', + }, + { + get: '/v1/{name=projects/*/locations/*/modelDeploymentMonitoringJobs/*/operations/*}', + }, + { + get: '/v1/{name=projects/*/locations/*/migratableResources/*/operations/*}', + }, + {get: '/v1/{name=projects/*/locations/*/models/*/operations/*}'}, + { + get: '/v1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}', + }, + {get: '/v1/{name=projects/*/locations/*/studies/*/operations/*}'}, + { + get: '/v1/{name=projects/*/locations/*/studies/*/trials/*/operations/*}', + }, + { + get: '/v1/{name=projects/*/locations/*/trainingPipelines/*/operations/*}', + }, + { + get: '/v1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}', + }, + {get: '/v1/{name=projects/*/locations/*/schedules/*/operations/*}'}, + { + get: '/v1/{name=projects/*/locations/*/specialistPools/*/operations/*}', + }, + { + get: '/v1/{name=projects/*/locations/*/tensorboards/*/operations/*}', + }, + { + get: '/v1/{name=projects/*/locations/*/tensorboards/*/experiments/*/operations/*}', + }, + { + get: '/v1/{name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/operations/*}', + }, + { + get: '/v1/{name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*/operations/*}', + }, + ], + }, + { + selector: 'google.longrunning.Operations.ListOperations', + get: '/ui/{name=projects/*/locations/*}/operations', + additional_bindings: [ + {get: '/ui/{name=projects/*/locations/*/datasets/*}/operations'}, + { + get: '/ui/{name=projects/*/locations/*/datasets/*/dataItems/*}/operations', + }, + { + get: '/ui/{name=projects/*/locations/*/datasets/*/savedQueries/*}/operations', + }, + { + get: '/ui/{name=projects/*/locations/*/datasets/*/annotationSpecs/*}/operations', + }, + { + get: '/ui/{name=projects/*/locations/*/datasets/*/dataItems/*/annotations/*}/operations', + }, + { + get: '/ui/{name=projects/*/locations/*/deploymentResourcePools/*}/operations', + }, + {get: '/ui/{name=projects/*/locations/*/edgeDevices/*}/operations'}, + {get: '/ui/{name=projects/*/locations/*/endpoints/*}/operations'}, + { + get: '/ui/{name=projects/*/locations/*/featurestores/*}/operations', + }, + { + get: '/ui/{name=projects/*/locations/*/featurestores/*/entityTypes/*}/operations', + }, + { + get: '/ui/{name=projects/*/locations/*/featurestores/*/entityTypes/*/features/*}/operations', + }, + {get: '/ui/{name=projects/*/locations/*/customJobs/*}/operations'}, + { + get: '/ui/{name=projects/*/locations/*/dataLabelingJobs/*}/operations', + }, + { + get: '/ui/{name=projects/*/locations/*/hyperparameterTuningJobs/*}/operations', + }, + {get: '/ui/{name=projects/*/locations/*/indexes/*}/operations'}, + { + get: '/ui/{name=projects/*/locations/*/indexEndpoints/*}/operations', + }, + { + get: '/ui/{name=projects/*/locations/*/modelDeploymentMonitoringJobs/*}/operations', + }, + { + get: '/ui/{name=projects/*/locations/*/modelMonitors/*}/operations', + }, + { + get: '/ui/{name=projects/*/locations/*/migratableResources/*}/operations', + }, + {get: '/ui/{name=projects/*/locations/*/models/*}/operations'}, + { + get: '/ui/{name=projects/*/locations/*/models/*/evaluations/*}/operations', + }, + {get: '/ui/{name=projects/*/locations/*/studies/*}/operations'}, + { + get: '/ui/{name=projects/*/locations/*/studies/*/trials/*}/operations', + }, + { + get: '/ui/{name=projects/*/locations/*/trainingPipelines/*}/operations', + }, + { + get: '/ui/{name=projects/*/locations/*/pipelineJobs/*}/operations', + }, + {get: '/ui/{name=projects/*/locations/*/schedules/*}/operations'}, + { + get: '/ui/{name=projects/*/locations/*/specialistPools/*}/operations', + }, + { + get: '/ui/{name=projects/*/locations/*/tensorboards/*}/operations', + }, + { + get: '/ui/{name=projects/*/locations/*/tensorboards/*/experiments/*}/operations', + }, + { + get: '/ui/{name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*}/operations', + }, + { + get: '/ui/{name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*}/operations', + }, + {get: '/v1/{name=projects/*/locations/*}/operations'}, + {get: '/v1/{name=projects/*/locations/*/datasets/*}/operations'}, + { + get: '/v1/{name=projects/*/locations/*/datasets/*/dataItems/*}/operations', + }, + { + get: '/v1/{name=projects/*/locations/*/datasets/*/savedQueries/*}/operations', + }, + { + get: '/v1/{name=projects/*/locations/*/datasets/*/annotationSpecs/*}/operations', + }, + { + get: '/v1/{name=projects/*/locations/*/datasets/*/dataItems/*/annotations/*}/operations', + }, + { + get: '/v1/{name=projects/*/locations/*/deploymentResourcePools/*}/operations', + }, + {get: '/v1/{name=projects/*/locations/*/endpoints/*}/operations'}, + { + get: '/v1/{name=projects/*/locations/*/featurestores/*}/operations', + }, + { + get: '/v1/{name=projects/*/locations/*/featurestores/*/entityTypes/*}/operations', + }, + { + get: '/v1/{name=projects/*/locations/*/featurestores/*/entityTypes/*/features/*}/operations', + }, + {get: '/v1/{name=projects/*/locations/*/customJobs/*}/operations'}, + { + get: '/v1/{name=projects/*/locations/*/dataLabelingJobs/*}/operations', + }, + { + get: '/v1/{name=projects/*/locations/*/hyperparameterTuningJobs/*}/operations', + }, + {get: '/v1/{name=projects/*/locations/*/indexes/*}/operations'}, + { + get: '/v1/{name=projects/*/locations/*/indexEndpoints/*}/operations', + }, + { + get: '/v1/{name=projects/*/locations/*/modelDeploymentMonitoringJobs/*}/operations', + }, + { + get: '/v1/{name=projects/*/locations/*/migratableResources/*}/operations', + }, + {get: '/v1/{name=projects/*/locations/*/models/*}/operations'}, + { + get: '/v1/{name=projects/*/locations/*/models/*/evaluations/*}/operations', + }, + {get: '/v1/{name=projects/*/locations/*/studies/*}/operations'}, + { + get: '/v1/{name=projects/*/locations/*/studies/*/trials/*}/operations', + }, + { + get: '/v1/{name=projects/*/locations/*/trainingPipelines/*}/operations', + }, + { + get: '/v1/{name=projects/*/locations/*/pipelineJobs/*}/operations', + }, + {get: '/v1/{name=projects/*/locations/*/schedules/*}/operations'}, + { + get: '/v1/{name=projects/*/locations/*/specialistPools/*}/operations', + }, + { + get: '/v1/{name=projects/*/locations/*/tensorboards/*}/operations', + }, + { + get: '/v1/{name=projects/*/locations/*/tensorboards/*/experiments/*}/operations', + }, + { + get: '/v1/{name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*}/operations', + }, + { + get: '/v1/{name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*}/operations', + }, + ], + }, + { + selector: 'google.longrunning.Operations.WaitOperation', + post: '/ui/{name=projects/*/locations/*/operations/*}:wait', + additional_bindings: [ + { + post: '/ui/{name=projects/*/locations/*/datasets/*/operations/*}:wait', + }, + { + post: '/ui/{name=projects/*/locations/*/datasets/*/dataItems/*/operations/*}:wait', + }, + { + post: '/ui/{name=projects/*/locations/*/datasets/*/savedQueries/*/operations/*}:wait', + }, + { + post: '/ui/{name=projects/*/locations/*/datasets/*/annotationSpecs/*/operations/*}:wait', + }, + { + post: '/ui/{name=projects/*/locations/*/datasets/*/dataItems/*/annotations/*/operations/*}:wait', + }, + { + post: '/ui/{name=projects/*/locations/*/deploymentResourcePools/*/operations/*}:wait', + }, + { + post: '/ui/{name=projects/*/locations/*/edgeDevices/*/operations/*}:wait', + }, + { + post: '/ui/{name=projects/*/locations/*/endpoints/*/operations/*}:wait', + }, + { + post: '/ui/{name=projects/*/locations/*/featurestores/*/operations/*}:wait', + }, + { + post: '/ui/{name=projects/*/locations/*/featurestores/*/entityTypes/*/operations/*}:wait', + }, + { + post: '/ui/{name=projects/*/locations/*/featurestores/*/entityTypes/*/features/*/operations/*}:wait', + }, + { + post: '/ui/{name=projects/*/locations/*/customJobs/*/operations/*}:wait', + }, + { + post: '/ui/{name=projects/*/locations/*/dataLabelingJobs/*/operations/*}:wait', + }, + { + post: '/ui/{name=projects/*/locations/*/hyperparameterTuningJobs/*/operations/*}:wait', + }, + { + post: '/ui/{name=projects/*/locations/*/indexes/*/operations/*}:wait', + }, + { + post: '/ui/{name=projects/*/locations/*/indexEndpoints/*/operations/*}:wait', + }, + { + post: '/ui/{name=projects/*/locations/*/modelDeploymentMonitoringJobs/*/operations/*}:wait', + }, + { + post: '/ui/{name=projects/*/locations/*/modelMonitors/*/operations/*}:wait', + }, + { + post: '/ui/{name=projects/*/locations/*/migratableResources/*/operations/*}:wait', + }, + { + post: '/ui/{name=projects/*/locations/*/models/*/operations/*}:wait', + }, + { + post: '/ui/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}:wait', + }, + { + post: '/ui/{name=projects/*/locations/*/studies/*/operations/*}:wait', + }, + { + post: '/ui/{name=projects/*/locations/*/studies/*/trials/*/operations/*}:wait', + }, + { + post: '/ui/{name=projects/*/locations/*/trainingPipelines/*/operations/*}:wait', + }, + { + post: '/ui/{name=projects/*/locations/*/pipelineJobs/*/operations/*}:wait', + }, + { + post: '/ui/{name=projects/*/locations/*/schedules/*/operations/*}:wait', + }, + { + post: '/ui/{name=projects/*/locations/*/specialistPools/*/operations/*}:wait', + }, + { + post: '/ui/{name=projects/*/locations/*/tensorboards/*/operations/*}:wait', + }, + { + post: '/ui/{name=projects/*/locations/*/tensorboards/*/experiments/*/operations/*}:wait', + }, + { + post: '/ui/{name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/operations/*}:wait', + }, + { + post: '/ui/{name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*/operations/*}:wait', + }, + {post: '/v1/{name=projects/*/locations/*/operations/*}:wait'}, + { + post: '/v1/{name=projects/*/locations/*/datasets/*/operations/*}:wait', + }, + { + post: '/v1/{name=projects/*/locations/*/datasets/*/dataItems/*/operations/*}:wait', + }, + { + post: '/v1/{name=projects/*/locations/*/datasets/*/savedQueries/*/operations/*}:wait', + }, + { + post: '/v1/{name=projects/*/locations/*/datasets/*/annotationSpecs/*/operations/*}:wait', + }, + { + post: '/v1/{name=projects/*/locations/*/datasets/*/dataItems/*/annotations/*/operations/*}:wait', + }, + { + post: '/v1/{name=projects/*/locations/*/deploymentResourcePools/*/operations/*}:wait', + }, + { + post: '/v1/{name=projects/*/locations/*/endpoints/*/operations/*}:wait', + }, + { + post: '/v1/{name=projects/*/locations/*/featurestores/*/operations/*}:wait', + }, + { + post: '/v1/{name=projects/*/locations/*/featurestores/*/entityTypes/*/operations/*}:wait', + }, + { + post: '/v1/{name=projects/*/locations/*/featurestores/*/entityTypes/*/features/*/operations/*}:wait', + }, + { + post: '/v1/{name=projects/*/locations/*/customJobs/*/operations/*}:wait', + }, + { + post: '/v1/{name=projects/*/locations/*/dataLabelingJobs/*/operations/*}:wait', + }, + { + post: '/v1/{name=projects/*/locations/*/hyperparameterTuningJobs/*/operations/*}:wait', + }, + { + post: '/v1/{name=projects/*/locations/*/indexes/*/operations/*}:wait', + }, + { + post: '/v1/{name=projects/*/locations/*/indexEndpoints/*/operations/*}:wait', + }, + { + post: '/v1/{name=projects/*/locations/*/modelDeploymentMonitoringJobs/*/operations/*}:wait', + }, + { + post: '/v1/{name=projects/*/locations/*/migratableResources/*/operations/*}:wait', + }, + { + post: '/v1/{name=projects/*/locations/*/models/*/operations/*}:wait', + }, + { + post: '/v1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}:wait', + }, + { + post: '/v1/{name=projects/*/locations/*/studies/*/operations/*}:wait', + }, + { + post: '/v1/{name=projects/*/locations/*/studies/*/trials/*/operations/*}:wait', + }, + { + post: '/v1/{name=projects/*/locations/*/trainingPipelines/*/operations/*}:wait', + }, + { + post: '/v1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}:wait', + }, + { + post: '/v1/{name=projects/*/locations/*/schedules/*/operations/*}:wait', + }, + { + post: '/v1/{name=projects/*/locations/*/specialistPools/*/operations/*}:wait', + }, + { + post: '/v1/{name=projects/*/locations/*/tensorboards/*/operations/*}:wait', + }, + { + post: '/v1/{name=projects/*/locations/*/tensorboards/*/experiments/*/operations/*}:wait', + }, + { + post: '/v1/{name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/operations/*}:wait', + }, + { + post: '/v1/{name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*/operations/*}:wait', + }, + ], + }, + ]; + } + this.operationsClient = this._gaxModule + .lro(lroOptions) + .operationsClient(opts); + const deleteScheduleResponse = protoFilesRoot.lookup( + '.google.protobuf.Empty' + ) as gax.protobuf.Type; + const deleteScheduleMetadata = protoFilesRoot.lookup( + '.google.cloud.aiplatform.v1.DeleteOperationMetadata' + ) as gax.protobuf.Type; + + this.descriptors.longrunning = { + deleteSchedule: new this._gaxModule.LongrunningDescriptor( + this.operationsClient, + deleteScheduleResponse.decode.bind(deleteScheduleResponse), + deleteScheduleMetadata.decode.bind(deleteScheduleMetadata) + ), + }; + + // Put together the default options sent with requests. + this._defaults = this._gaxGrpc.constructSettings( + 'google.cloud.aiplatform.v1.ScheduleService', + gapicConfig as gax.ClientConfig, + opts.clientConfig || {}, + {'x-goog-api-client': clientHeader.join(' ')} + ); + + // Set up a dictionary of "inner API calls"; the core implementation + // of calling the API is handled in `google-gax`, with this code + // merely providing the destination and request information. + this.innerApiCalls = {}; + + // Add a warn function to the client constructor so it can be easily tested. + this.warn = this._gaxModule.warn; + } + + /** + * Initialize the client. + * Performs asynchronous operations (such as authentication) and prepares the client. + * This function will be called automatically when any class method is called for the + * first time, but if you need to initialize it before calling an actual method, + * feel free to call initialize() directly. + * + * You can await on this method if you want to make sure the client is initialized. + * + * @returns {Promise} A promise that resolves to an authenticated service stub. + */ + initialize() { + // If the client stub promise is already initialized, return immediately. + if (this.scheduleServiceStub) { + return this.scheduleServiceStub; + } + + // Put together the "service stub" for + // google.cloud.aiplatform.v1.ScheduleService. + this.scheduleServiceStub = this._gaxGrpc.createStub( + this._opts.fallback + ? (this._protos as protobuf.Root).lookupService( + 'google.cloud.aiplatform.v1.ScheduleService' + ) + : // eslint-disable-next-line @typescript-eslint/no-explicit-any + (this._protos as any).google.cloud.aiplatform.v1.ScheduleService, + this._opts, + this._providedCustomServicePath + ) as Promise<{[method: string]: Function}>; + + // Iterate over each of the methods that the service provides + // and create an API call method for each. + const scheduleServiceStubMethods = [ + 'createSchedule', + 'deleteSchedule', + 'getSchedule', + 'listSchedules', + 'pauseSchedule', + 'resumeSchedule', + 'updateSchedule', + ]; + for (const methodName of scheduleServiceStubMethods) { + const callPromise = this.scheduleServiceStub.then( + stub => + (...args: Array<{}>) => { + if (this._terminated) { + return Promise.reject('The client has already been closed.'); + } + const func = stub[methodName]; + return func.apply(stub, args); + }, + (err: Error | null | undefined) => () => { + throw err; + } + ); + + const descriptor = + this.descriptors.page[methodName] || + this.descriptors.longrunning[methodName] || + undefined; + const apiCall = this._gaxModule.createApiCall( + callPromise, + this._defaults[methodName], + descriptor, + this._opts.fallback + ); + + this.innerApiCalls[methodName] = apiCall; + } + + return this.scheduleServiceStub; + } + + /** + * The DNS address for this API service. + * @returns {string} The DNS address for this service. + */ + static get servicePath() { + return 'aiplatform.googleapis.com'; + } + + /** + * The DNS address for this API service - same as servicePath(), + * exists for compatibility reasons. + * @returns {string} The DNS address for this service. + */ + static get apiEndpoint() { + return 'aiplatform.googleapis.com'; + } + + /** + * The port for this API service. + * @returns {number} The default port for this service. + */ + static get port() { + return 443; + } + + /** + * The scopes needed to make gRPC calls for every method defined + * in this service. + * @returns {string[]} List of default scopes. + */ + static get scopes() { + return ['https://www.googleapis.com/auth/cloud-platform']; + } + + getProjectId(): Promise; + getProjectId(callback: Callback): void; + /** + * Return the project ID used by this class. + * @returns {Promise} A promise that resolves to string containing the project ID. + */ + getProjectId( + callback?: Callback + ): Promise | void { + if (callback) { + this.auth.getProjectId(callback); + return; + } + return this.auth.getProjectId(); + } + + // ------------------- + // -- Service calls -- + // ------------------- + /** + * Creates a Schedule. + * + * @param {Object} request + * The request object that will be sent. + * @param {string} request.parent + * Required. The resource name of the Location to create the Schedule in. + * Format: `projects/{project}/locations/{location}` + * @param {google.cloud.aiplatform.v1.Schedule} request.schedule + * Required. The Schedule to create. + * @param {object} [options] + * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. + * @returns {Promise} - The promise which resolves to an array. + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.Schedule|Schedule}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } + * for more details and examples. + * @example include:samples/generated/v1/schedule_service.create_schedule.js + * region_tag:aiplatform_v1_generated_ScheduleService_CreateSchedule_async + */ + createSchedule( + request?: protos.google.cloud.aiplatform.v1.ICreateScheduleRequest, + options?: CallOptions + ): Promise< + [ + protos.google.cloud.aiplatform.v1.ISchedule, + protos.google.cloud.aiplatform.v1.ICreateScheduleRequest | undefined, + {} | undefined + ] + >; + createSchedule( + request: protos.google.cloud.aiplatform.v1.ICreateScheduleRequest, + options: CallOptions, + callback: Callback< + protos.google.cloud.aiplatform.v1.ISchedule, + | protos.google.cloud.aiplatform.v1.ICreateScheduleRequest + | null + | undefined, + {} | null | undefined + > + ): void; + createSchedule( + request: protos.google.cloud.aiplatform.v1.ICreateScheduleRequest, + callback: Callback< + protos.google.cloud.aiplatform.v1.ISchedule, + | protos.google.cloud.aiplatform.v1.ICreateScheduleRequest + | null + | undefined, + {} | null | undefined + > + ): void; + createSchedule( + request?: protos.google.cloud.aiplatform.v1.ICreateScheduleRequest, + optionsOrCallback?: + | CallOptions + | Callback< + protos.google.cloud.aiplatform.v1.ISchedule, + | protos.google.cloud.aiplatform.v1.ICreateScheduleRequest + | null + | undefined, + {} | null | undefined + >, + callback?: Callback< + protos.google.cloud.aiplatform.v1.ISchedule, + | protos.google.cloud.aiplatform.v1.ICreateScheduleRequest + | null + | undefined, + {} | null | undefined + > + ): Promise< + [ + protos.google.cloud.aiplatform.v1.ISchedule, + protos.google.cloud.aiplatform.v1.ICreateScheduleRequest | undefined, + {} | undefined + ] + > | void { + request = request || {}; + let options: CallOptions; + if (typeof optionsOrCallback === 'function' && callback === undefined) { + callback = optionsOrCallback; + options = {}; + } else { + options = optionsOrCallback as CallOptions; + } + options = options || {}; + options.otherArgs = options.otherArgs || {}; + options.otherArgs.headers = options.otherArgs.headers || {}; + options.otherArgs.headers['x-goog-request-params'] = + this._gaxModule.routingHeader.fromParams({ + parent: request.parent ?? '', + }); + this.initialize(); + return this.innerApiCalls.createSchedule(request, options, callback); + } + /** + * Gets a Schedule. + * + * @param {Object} request + * The request object that will be sent. + * @param {string} request.name + * Required. The name of the Schedule resource. + * Format: + * `projects/{project}/locations/{location}/schedules/{schedule}` + * @param {object} [options] + * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. + * @returns {Promise} - The promise which resolves to an array. + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.Schedule|Schedule}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } + * for more details and examples. + * @example include:samples/generated/v1/schedule_service.get_schedule.js + * region_tag:aiplatform_v1_generated_ScheduleService_GetSchedule_async + */ + getSchedule( + request?: protos.google.cloud.aiplatform.v1.IGetScheduleRequest, + options?: CallOptions + ): Promise< + [ + protos.google.cloud.aiplatform.v1.ISchedule, + protos.google.cloud.aiplatform.v1.IGetScheduleRequest | undefined, + {} | undefined + ] + >; + getSchedule( + request: protos.google.cloud.aiplatform.v1.IGetScheduleRequest, + options: CallOptions, + callback: Callback< + protos.google.cloud.aiplatform.v1.ISchedule, + protos.google.cloud.aiplatform.v1.IGetScheduleRequest | null | undefined, + {} | null | undefined + > + ): void; + getSchedule( + request: protos.google.cloud.aiplatform.v1.IGetScheduleRequest, + callback: Callback< + protos.google.cloud.aiplatform.v1.ISchedule, + protos.google.cloud.aiplatform.v1.IGetScheduleRequest | null | undefined, + {} | null | undefined + > + ): void; + getSchedule( + request?: protos.google.cloud.aiplatform.v1.IGetScheduleRequest, + optionsOrCallback?: + | CallOptions + | Callback< + protos.google.cloud.aiplatform.v1.ISchedule, + | protos.google.cloud.aiplatform.v1.IGetScheduleRequest + | null + | undefined, + {} | null | undefined + >, + callback?: Callback< + protos.google.cloud.aiplatform.v1.ISchedule, + protos.google.cloud.aiplatform.v1.IGetScheduleRequest | null | undefined, + {} | null | undefined + > + ): Promise< + [ + protos.google.cloud.aiplatform.v1.ISchedule, + protos.google.cloud.aiplatform.v1.IGetScheduleRequest | undefined, + {} | undefined + ] + > | void { + request = request || {}; + let options: CallOptions; + if (typeof optionsOrCallback === 'function' && callback === undefined) { + callback = optionsOrCallback; + options = {}; + } else { + options = optionsOrCallback as CallOptions; + } + options = options || {}; + options.otherArgs = options.otherArgs || {}; + options.otherArgs.headers = options.otherArgs.headers || {}; + options.otherArgs.headers['x-goog-request-params'] = + this._gaxModule.routingHeader.fromParams({ + name: request.name ?? '', + }); + this.initialize(); + return this.innerApiCalls.getSchedule(request, options, callback); + } + /** + * Pauses a Schedule. Will mark + * {@link protos.google.cloud.aiplatform.v1.Schedule.state|Schedule.state} to 'PAUSED'. If + * the schedule is paused, no new runs will be created. Already created runs + * will NOT be paused or canceled. + * + * @param {Object} request + * The request object that will be sent. + * @param {string} request.name + * Required. The name of the Schedule resource to be paused. + * Format: + * `projects/{project}/locations/{location}/schedules/{schedule}` + * @param {object} [options] + * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. + * @returns {Promise} - The promise which resolves to an array. + * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } + * for more details and examples. + * @example include:samples/generated/v1/schedule_service.pause_schedule.js + * region_tag:aiplatform_v1_generated_ScheduleService_PauseSchedule_async + */ + pauseSchedule( + request?: protos.google.cloud.aiplatform.v1.IPauseScheduleRequest, + options?: CallOptions + ): Promise< + [ + protos.google.protobuf.IEmpty, + protos.google.cloud.aiplatform.v1.IPauseScheduleRequest | undefined, + {} | undefined + ] + >; + pauseSchedule( + request: protos.google.cloud.aiplatform.v1.IPauseScheduleRequest, + options: CallOptions, + callback: Callback< + protos.google.protobuf.IEmpty, + | protos.google.cloud.aiplatform.v1.IPauseScheduleRequest + | null + | undefined, + {} | null | undefined + > + ): void; + pauseSchedule( + request: protos.google.cloud.aiplatform.v1.IPauseScheduleRequest, + callback: Callback< + protos.google.protobuf.IEmpty, + | protos.google.cloud.aiplatform.v1.IPauseScheduleRequest + | null + | undefined, + {} | null | undefined + > + ): void; + pauseSchedule( + request?: protos.google.cloud.aiplatform.v1.IPauseScheduleRequest, + optionsOrCallback?: + | CallOptions + | Callback< + protos.google.protobuf.IEmpty, + | protos.google.cloud.aiplatform.v1.IPauseScheduleRequest + | null + | undefined, + {} | null | undefined + >, + callback?: Callback< + protos.google.protobuf.IEmpty, + | protos.google.cloud.aiplatform.v1.IPauseScheduleRequest + | null + | undefined, + {} | null | undefined + > + ): Promise< + [ + protos.google.protobuf.IEmpty, + protos.google.cloud.aiplatform.v1.IPauseScheduleRequest | undefined, + {} | undefined + ] + > | void { + request = request || {}; + let options: CallOptions; + if (typeof optionsOrCallback === 'function' && callback === undefined) { + callback = optionsOrCallback; + options = {}; + } else { + options = optionsOrCallback as CallOptions; + } + options = options || {}; + options.otherArgs = options.otherArgs || {}; + options.otherArgs.headers = options.otherArgs.headers || {}; + options.otherArgs.headers['x-goog-request-params'] = + this._gaxModule.routingHeader.fromParams({ + name: request.name ?? '', + }); + this.initialize(); + return this.innerApiCalls.pauseSchedule(request, options, callback); + } + /** + * Resumes a paused Schedule to start scheduling new runs. Will mark + * {@link protos.google.cloud.aiplatform.v1.Schedule.state|Schedule.state} to 'ACTIVE'. + * Only paused Schedule can be resumed. + * + * When the Schedule is resumed, new runs will be scheduled starting from the + * next execution time after the current time based on the time_specification + * in the Schedule. If {@link protos.|Schedule.catchUp} is set up true, all + * missed runs will be scheduled for backfill first. + * + * @param {Object} request + * The request object that will be sent. + * @param {string} request.name + * Required. The name of the Schedule resource to be resumed. + * Format: + * `projects/{project}/locations/{location}/schedules/{schedule}` + * @param {boolean} [request.catchUp] + * Optional. Whether to backfill missed runs when the schedule is resumed from + * PAUSED state. If set to true, all missed runs will be scheduled. New runs + * will be scheduled after the backfill is complete. This will also update + * {@link protos.google.cloud.aiplatform.v1.Schedule.catch_up|Schedule.catch_up} field. + * Default to false. + * @param {object} [options] + * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. + * @returns {Promise} - The promise which resolves to an array. + * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } + * for more details and examples. + * @example include:samples/generated/v1/schedule_service.resume_schedule.js + * region_tag:aiplatform_v1_generated_ScheduleService_ResumeSchedule_async + */ + resumeSchedule( + request?: protos.google.cloud.aiplatform.v1.IResumeScheduleRequest, + options?: CallOptions + ): Promise< + [ + protos.google.protobuf.IEmpty, + protos.google.cloud.aiplatform.v1.IResumeScheduleRequest | undefined, + {} | undefined + ] + >; + resumeSchedule( + request: protos.google.cloud.aiplatform.v1.IResumeScheduleRequest, + options: CallOptions, + callback: Callback< + protos.google.protobuf.IEmpty, + | protos.google.cloud.aiplatform.v1.IResumeScheduleRequest + | null + | undefined, + {} | null | undefined + > + ): void; + resumeSchedule( + request: protos.google.cloud.aiplatform.v1.IResumeScheduleRequest, + callback: Callback< + protos.google.protobuf.IEmpty, + | protos.google.cloud.aiplatform.v1.IResumeScheduleRequest + | null + | undefined, + {} | null | undefined + > + ): void; + resumeSchedule( + request?: protos.google.cloud.aiplatform.v1.IResumeScheduleRequest, + optionsOrCallback?: + | CallOptions + | Callback< + protos.google.protobuf.IEmpty, + | protos.google.cloud.aiplatform.v1.IResumeScheduleRequest + | null + | undefined, + {} | null | undefined + >, + callback?: Callback< + protos.google.protobuf.IEmpty, + | protos.google.cloud.aiplatform.v1.IResumeScheduleRequest + | null + | undefined, + {} | null | undefined + > + ): Promise< + [ + protos.google.protobuf.IEmpty, + protos.google.cloud.aiplatform.v1.IResumeScheduleRequest | undefined, + {} | undefined + ] + > | void { + request = request || {}; + let options: CallOptions; + if (typeof optionsOrCallback === 'function' && callback === undefined) { + callback = optionsOrCallback; + options = {}; + } else { + options = optionsOrCallback as CallOptions; + } + options = options || {}; + options.otherArgs = options.otherArgs || {}; + options.otherArgs.headers = options.otherArgs.headers || {}; + options.otherArgs.headers['x-goog-request-params'] = + this._gaxModule.routingHeader.fromParams({ + name: request.name ?? '', + }); + this.initialize(); + return this.innerApiCalls.resumeSchedule(request, options, callback); + } + /** + * Updates an active or paused Schedule. + * + * When the Schedule is updated, new runs will be scheduled starting from the + * updated next execution time after the update time based on the + * time_specification in the updated Schedule. All unstarted runs before the + * update time will be skipped while already created runs will NOT be paused + * or canceled. + * + * @param {Object} request + * The request object that will be sent. + * @param {google.cloud.aiplatform.v1.Schedule} request.schedule + * Required. The Schedule which replaces the resource on the server. + * The following restrictions will be applied: + * * The scheduled request type cannot be changed. + * * The output_only fields will be ignored if specified. + * @param {google.protobuf.FieldMask} request.updateMask + * Required. The update mask applies to the resource. See + * {@link protos.google.protobuf.FieldMask|google.protobuf.FieldMask}. + * @param {object} [options] + * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. + * @returns {Promise} - The promise which resolves to an array. + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.Schedule|Schedule}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } + * for more details and examples. + * @example include:samples/generated/v1/schedule_service.update_schedule.js + * region_tag:aiplatform_v1_generated_ScheduleService_UpdateSchedule_async + */ + updateSchedule( + request?: protos.google.cloud.aiplatform.v1.IUpdateScheduleRequest, + options?: CallOptions + ): Promise< + [ + protos.google.cloud.aiplatform.v1.ISchedule, + protos.google.cloud.aiplatform.v1.IUpdateScheduleRequest | undefined, + {} | undefined + ] + >; + updateSchedule( + request: protos.google.cloud.aiplatform.v1.IUpdateScheduleRequest, + options: CallOptions, + callback: Callback< + protos.google.cloud.aiplatform.v1.ISchedule, + | protos.google.cloud.aiplatform.v1.IUpdateScheduleRequest + | null + | undefined, + {} | null | undefined + > + ): void; + updateSchedule( + request: protos.google.cloud.aiplatform.v1.IUpdateScheduleRequest, + callback: Callback< + protos.google.cloud.aiplatform.v1.ISchedule, + | protos.google.cloud.aiplatform.v1.IUpdateScheduleRequest + | null + | undefined, + {} | null | undefined + > + ): void; + updateSchedule( + request?: protos.google.cloud.aiplatform.v1.IUpdateScheduleRequest, + optionsOrCallback?: + | CallOptions + | Callback< + protos.google.cloud.aiplatform.v1.ISchedule, + | protos.google.cloud.aiplatform.v1.IUpdateScheduleRequest + | null + | undefined, + {} | null | undefined + >, + callback?: Callback< + protos.google.cloud.aiplatform.v1.ISchedule, + | protos.google.cloud.aiplatform.v1.IUpdateScheduleRequest + | null + | undefined, + {} | null | undefined + > + ): Promise< + [ + protos.google.cloud.aiplatform.v1.ISchedule, + protos.google.cloud.aiplatform.v1.IUpdateScheduleRequest | undefined, + {} | undefined + ] + > | void { + request = request || {}; + let options: CallOptions; + if (typeof optionsOrCallback === 'function' && callback === undefined) { + callback = optionsOrCallback; + options = {}; + } else { + options = optionsOrCallback as CallOptions; + } + options = options || {}; + options.otherArgs = options.otherArgs || {}; + options.otherArgs.headers = options.otherArgs.headers || {}; + options.otherArgs.headers['x-goog-request-params'] = + this._gaxModule.routingHeader.fromParams({ + 'schedule.name': request.schedule!.name ?? '', + }); + this.initialize(); + return this.innerApiCalls.updateSchedule(request, options, callback); + } + + /** + * Deletes a Schedule. + * + * @param {Object} request + * The request object that will be sent. + * @param {string} request.name + * Required. The name of the Schedule resource to be deleted. + * Format: + * `projects/{project}/locations/{location}/schedules/{schedule}` + * @param {object} [options] + * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. + * @returns {Promise} - The promise which resolves to an array. + * The first element of the array is an object representing + * a long running operation. Its `promise()` method returns a promise + * you can `await` for. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } + * for more details and examples. + * @example include:samples/generated/v1/schedule_service.delete_schedule.js + * region_tag:aiplatform_v1_generated_ScheduleService_DeleteSchedule_async + */ + deleteSchedule( + request?: protos.google.cloud.aiplatform.v1.IDeleteScheduleRequest, + options?: CallOptions + ): Promise< + [ + LROperation< + protos.google.protobuf.IEmpty, + protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata + >, + protos.google.longrunning.IOperation | undefined, + {} | undefined + ] + >; + deleteSchedule( + request: protos.google.cloud.aiplatform.v1.IDeleteScheduleRequest, + options: CallOptions, + callback: Callback< + LROperation< + protos.google.protobuf.IEmpty, + protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata + >, + protos.google.longrunning.IOperation | null | undefined, + {} | null | undefined + > + ): void; + deleteSchedule( + request: protos.google.cloud.aiplatform.v1.IDeleteScheduleRequest, + callback: Callback< + LROperation< + protos.google.protobuf.IEmpty, + protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata + >, + protos.google.longrunning.IOperation | null | undefined, + {} | null | undefined + > + ): void; + deleteSchedule( + request?: protos.google.cloud.aiplatform.v1.IDeleteScheduleRequest, + optionsOrCallback?: + | CallOptions + | Callback< + LROperation< + protos.google.protobuf.IEmpty, + protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata + >, + protos.google.longrunning.IOperation | null | undefined, + {} | null | undefined + >, + callback?: Callback< + LROperation< + protos.google.protobuf.IEmpty, + protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata + >, + protos.google.longrunning.IOperation | null | undefined, + {} | null | undefined + > + ): Promise< + [ + LROperation< + protos.google.protobuf.IEmpty, + protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata + >, + protos.google.longrunning.IOperation | undefined, + {} | undefined + ] + > | void { + request = request || {}; + let options: CallOptions; + if (typeof optionsOrCallback === 'function' && callback === undefined) { + callback = optionsOrCallback; + options = {}; + } else { + options = optionsOrCallback as CallOptions; + } + options = options || {}; + options.otherArgs = options.otherArgs || {}; + options.otherArgs.headers = options.otherArgs.headers || {}; + options.otherArgs.headers['x-goog-request-params'] = + this._gaxModule.routingHeader.fromParams({ + name: request.name ?? '', + }); + this.initialize(); + return this.innerApiCalls.deleteSchedule(request, options, callback); + } + /** + * Check the status of the long running operation returned by `deleteSchedule()`. + * @param {String} name + * The operation name that will be passed. + * @returns {Promise} - The promise which resolves to an object. + * The decoded operation object has result and metadata field to get information from. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } + * for more details and examples. + * @example include:samples/generated/v1/schedule_service.delete_schedule.js + * region_tag:aiplatform_v1_generated_ScheduleService_DeleteSchedule_async + */ + async checkDeleteScheduleProgress( + name: string + ): Promise< + LROperation< + protos.google.protobuf.Empty, + protos.google.cloud.aiplatform.v1.DeleteOperationMetadata + > + > { + const request = + new this._gaxModule.operationsProtos.google.longrunning.GetOperationRequest( + {name} + ); + const [operation] = await this.operationsClient.getOperation(request); + const decodeOperation = new this._gaxModule.Operation( + operation, + this.descriptors.longrunning.deleteSchedule, + this._gaxModule.createDefaultBackoffSettings() + ); + return decodeOperation as LROperation< + protos.google.protobuf.Empty, + protos.google.cloud.aiplatform.v1.DeleteOperationMetadata + >; + } + /** + * Lists Schedules in a Location. + * + * @param {Object} request + * The request object that will be sent. + * @param {string} request.parent + * Required. The resource name of the Location to list the Schedules from. + * Format: `projects/{project}/locations/{location}` + * @param {string} request.filter + * Lists the Schedules that match the filter expression. The following + * fields are supported: + * + * * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. + * * `state`: Supports `=` and `!=` comparisons. + * * `request`: Supports existence of the check. + * (e.g. `create_pipeline_job_request:*` --> Schedule has + * create_pipeline_job_request). + * * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. + * Values must be in RFC 3339 format. + * * `start_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. + * Values must be in RFC 3339 format. + * * `end_time`: Supports `=`, `!=`, `<`, `>`, `<=`, `>=` comparisons and `:*` + * existence check. Values must be in RFC 3339 format. + * * `next_run_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` + * comparisons. Values must be in RFC 3339 format. + * + * + * Filter expressions can be combined together using logical operators + * (`NOT`, `AND` & `OR`). + * The syntax to define filter expression is based on + * https://google.aip.dev/160. + * + * Examples: + * + * * `state="ACTIVE" AND display_name:"my_schedule_*"` + * * `NOT display_name="my_schedule"` + * * `create_time>"2021-05-18T00:00:00Z"` + * * `end_time>"2021-05-18T00:00:00Z" OR NOT end_time:*` + * * `create_pipeline_job_request:*` + * @param {number} request.pageSize + * The standard list page size. + * Default to 100 if not specified. + * @param {string} request.pageToken + * The standard list page token. + * Typically obtained via + * {@link protos.google.cloud.aiplatform.v1.ListSchedulesResponse.next_page_token|ListSchedulesResponse.next_page_token} + * of the previous + * {@link protos.google.cloud.aiplatform.v1.ScheduleService.ListSchedules|ScheduleService.ListSchedules} + * call. + * @param {string} request.orderBy + * A comma-separated list of fields to order by. The default sort order is in + * ascending order. Use "desc" after a field name for descending. You can have + * multiple order_by fields provided. + * + * For example, using "create_time desc, end_time" will order results by + * create time in descending order, and if there are multiple schedules having + * the same create time, order them by the end time in ascending order. + * + * If order_by is not specified, it will order by default with create_time in + * descending order. + * + * Supported fields: + * * `create_time` + * * `start_time` + * * `end_time` + * * `next_run_time` + * @param {object} [options] + * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. + * @returns {Promise} - The promise which resolves to an array. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.Schedule|Schedule}. + * The client library will perform auto-pagination by default: it will call the API as many + * times as needed and will merge results from all the pages into this array. + * Note that it can affect your quota. + * We recommend using `listSchedulesAsync()` + * method described below for async iteration which you can stop as needed. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } + * for more details and examples. + */ + listSchedules( + request?: protos.google.cloud.aiplatform.v1.IListSchedulesRequest, + options?: CallOptions + ): Promise< + [ + protos.google.cloud.aiplatform.v1.ISchedule[], + protos.google.cloud.aiplatform.v1.IListSchedulesRequest | null, + protos.google.cloud.aiplatform.v1.IListSchedulesResponse + ] + >; + listSchedules( + request: protos.google.cloud.aiplatform.v1.IListSchedulesRequest, + options: CallOptions, + callback: PaginationCallback< + protos.google.cloud.aiplatform.v1.IListSchedulesRequest, + | protos.google.cloud.aiplatform.v1.IListSchedulesResponse + | null + | undefined, + protos.google.cloud.aiplatform.v1.ISchedule + > + ): void; + listSchedules( + request: protos.google.cloud.aiplatform.v1.IListSchedulesRequest, + callback: PaginationCallback< + protos.google.cloud.aiplatform.v1.IListSchedulesRequest, + | protos.google.cloud.aiplatform.v1.IListSchedulesResponse + | null + | undefined, + protos.google.cloud.aiplatform.v1.ISchedule + > + ): void; + listSchedules( + request?: protos.google.cloud.aiplatform.v1.IListSchedulesRequest, + optionsOrCallback?: + | CallOptions + | PaginationCallback< + protos.google.cloud.aiplatform.v1.IListSchedulesRequest, + | protos.google.cloud.aiplatform.v1.IListSchedulesResponse + | null + | undefined, + protos.google.cloud.aiplatform.v1.ISchedule + >, + callback?: PaginationCallback< + protos.google.cloud.aiplatform.v1.IListSchedulesRequest, + | protos.google.cloud.aiplatform.v1.IListSchedulesResponse + | null + | undefined, + protos.google.cloud.aiplatform.v1.ISchedule + > + ): Promise< + [ + protos.google.cloud.aiplatform.v1.ISchedule[], + protos.google.cloud.aiplatform.v1.IListSchedulesRequest | null, + protos.google.cloud.aiplatform.v1.IListSchedulesResponse + ] + > | void { + request = request || {}; + let options: CallOptions; + if (typeof optionsOrCallback === 'function' && callback === undefined) { + callback = optionsOrCallback; + options = {}; + } else { + options = optionsOrCallback as CallOptions; + } + options = options || {}; + options.otherArgs = options.otherArgs || {}; + options.otherArgs.headers = options.otherArgs.headers || {}; + options.otherArgs.headers['x-goog-request-params'] = + this._gaxModule.routingHeader.fromParams({ + parent: request.parent ?? '', + }); + this.initialize(); + return this.innerApiCalls.listSchedules(request, options, callback); + } + + /** + * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object. + * @param {Object} request + * The request object that will be sent. + * @param {string} request.parent + * Required. The resource name of the Location to list the Schedules from. + * Format: `projects/{project}/locations/{location}` + * @param {string} request.filter + * Lists the Schedules that match the filter expression. The following + * fields are supported: + * + * * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. + * * `state`: Supports `=` and `!=` comparisons. + * * `request`: Supports existence of the check. + * (e.g. `create_pipeline_job_request:*` --> Schedule has + * create_pipeline_job_request). + * * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. + * Values must be in RFC 3339 format. + * * `start_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. + * Values must be in RFC 3339 format. + * * `end_time`: Supports `=`, `!=`, `<`, `>`, `<=`, `>=` comparisons and `:*` + * existence check. Values must be in RFC 3339 format. + * * `next_run_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` + * comparisons. Values must be in RFC 3339 format. + * + * + * Filter expressions can be combined together using logical operators + * (`NOT`, `AND` & `OR`). + * The syntax to define filter expression is based on + * https://google.aip.dev/160. + * + * Examples: + * + * * `state="ACTIVE" AND display_name:"my_schedule_*"` + * * `NOT display_name="my_schedule"` + * * `create_time>"2021-05-18T00:00:00Z"` + * * `end_time>"2021-05-18T00:00:00Z" OR NOT end_time:*` + * * `create_pipeline_job_request:*` + * @param {number} request.pageSize + * The standard list page size. + * Default to 100 if not specified. + * @param {string} request.pageToken + * The standard list page token. + * Typically obtained via + * {@link protos.google.cloud.aiplatform.v1.ListSchedulesResponse.next_page_token|ListSchedulesResponse.next_page_token} + * of the previous + * {@link protos.google.cloud.aiplatform.v1.ScheduleService.ListSchedules|ScheduleService.ListSchedules} + * call. + * @param {string} request.orderBy + * A comma-separated list of fields to order by. The default sort order is in + * ascending order. Use "desc" after a field name for descending. You can have + * multiple order_by fields provided. + * + * For example, using "create_time desc, end_time" will order results by + * create time in descending order, and if there are multiple schedules having + * the same create time, order them by the end time in ascending order. + * + * If order_by is not specified, it will order by default with create_time in + * descending order. + * + * Supported fields: + * * `create_time` + * * `start_time` + * * `end_time` + * * `next_run_time` + * @param {object} [options] + * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. + * @returns {Stream} + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.Schedule|Schedule} on 'data' event. + * The client library will perform auto-pagination by default: it will call the API as many + * times as needed. Note that it can affect your quota. + * We recommend using `listSchedulesAsync()` + * method described below for async iteration which you can stop as needed. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } + * for more details and examples. + */ + listSchedulesStream( + request?: protos.google.cloud.aiplatform.v1.IListSchedulesRequest, + options?: CallOptions + ): Transform { + request = request || {}; + options = options || {}; + options.otherArgs = options.otherArgs || {}; + options.otherArgs.headers = options.otherArgs.headers || {}; + options.otherArgs.headers['x-goog-request-params'] = + this._gaxModule.routingHeader.fromParams({ + parent: request.parent ?? '', + }); + const defaultCallSettings = this._defaults['listSchedules']; + const callSettings = defaultCallSettings.merge(options); + this.initialize(); + return this.descriptors.page.listSchedules.createStream( + this.innerApiCalls.listSchedules as GaxCall, + request, + callSettings + ); + } + + /** + * Equivalent to `listSchedules`, but returns an iterable object. + * + * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand. + * @param {Object} request + * The request object that will be sent. + * @param {string} request.parent + * Required. The resource name of the Location to list the Schedules from. + * Format: `projects/{project}/locations/{location}` + * @param {string} request.filter + * Lists the Schedules that match the filter expression. The following + * fields are supported: + * + * * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. + * * `state`: Supports `=` and `!=` comparisons. + * * `request`: Supports existence of the check. + * (e.g. `create_pipeline_job_request:*` --> Schedule has + * create_pipeline_job_request). + * * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. + * Values must be in RFC 3339 format. + * * `start_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. + * Values must be in RFC 3339 format. + * * `end_time`: Supports `=`, `!=`, `<`, `>`, `<=`, `>=` comparisons and `:*` + * existence check. Values must be in RFC 3339 format. + * * `next_run_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` + * comparisons. Values must be in RFC 3339 format. + * + * + * Filter expressions can be combined together using logical operators + * (`NOT`, `AND` & `OR`). + * The syntax to define filter expression is based on + * https://google.aip.dev/160. + * + * Examples: + * + * * `state="ACTIVE" AND display_name:"my_schedule_*"` + * * `NOT display_name="my_schedule"` + * * `create_time>"2021-05-18T00:00:00Z"` + * * `end_time>"2021-05-18T00:00:00Z" OR NOT end_time:*` + * * `create_pipeline_job_request:*` + * @param {number} request.pageSize + * The standard list page size. + * Default to 100 if not specified. + * @param {string} request.pageToken + * The standard list page token. + * Typically obtained via + * {@link protos.google.cloud.aiplatform.v1.ListSchedulesResponse.next_page_token|ListSchedulesResponse.next_page_token} + * of the previous + * {@link protos.google.cloud.aiplatform.v1.ScheduleService.ListSchedules|ScheduleService.ListSchedules} + * call. + * @param {string} request.orderBy + * A comma-separated list of fields to order by. The default sort order is in + * ascending order. Use "desc" after a field name for descending. You can have + * multiple order_by fields provided. + * + * For example, using "create_time desc, end_time" will order results by + * create time in descending order, and if there are multiple schedules having + * the same create time, order them by the end time in ascending order. + * + * If order_by is not specified, it will order by default with create_time in + * descending order. + * + * Supported fields: + * * `create_time` + * * `start_time` + * * `end_time` + * * `next_run_time` + * @param {object} [options] + * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. + * @returns {Object} + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. + * When you iterate the returned iterable, each element will be an object representing + * {@link protos.google.cloud.aiplatform.v1.Schedule|Schedule}. The API will be called under the hood as needed, once per the page, + * so you can stop the iteration when you don't need more results. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } + * for more details and examples. + * @example include:samples/generated/v1/schedule_service.list_schedules.js + * region_tag:aiplatform_v1_generated_ScheduleService_ListSchedules_async + */ + listSchedulesAsync( + request?: protos.google.cloud.aiplatform.v1.IListSchedulesRequest, + options?: CallOptions + ): AsyncIterable { + request = request || {}; + options = options || {}; + options.otherArgs = options.otherArgs || {}; + options.otherArgs.headers = options.otherArgs.headers || {}; + options.otherArgs.headers['x-goog-request-params'] = + this._gaxModule.routingHeader.fromParams({ + parent: request.parent ?? '', + }); + const defaultCallSettings = this._defaults['listSchedules']; + const callSettings = defaultCallSettings.merge(options); + this.initialize(); + return this.descriptors.page.listSchedules.asyncIterate( + this.innerApiCalls['listSchedules'] as GaxCall, + request as {}, + callSettings + ) as AsyncIterable; + } + /** + * Gets the access control policy for a resource. Returns an empty policy + * if the resource exists and does not have a policy set. + * + * @param {Object} request + * The request object that will be sent. + * @param {string} request.resource + * REQUIRED: The resource for which the policy is being requested. + * See the operation documentation for the appropriate value for this field. + * @param {Object} [request.options] + * OPTIONAL: A `GetPolicyOptions` object for specifying options to + * `GetIamPolicy`. This field is only used by Cloud IAM. + * + * This object should have the same structure as {@link google.iam.v1.GetPolicyOptions | GetPolicyOptions}. + * @param {Object} [options] + * Optional parameters. You can override the default settings for this call, e.g, timeout, + * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. + * @param {function(?Error, ?Object)} [callback] + * The function which will be called with the result of the API call. + * + * The second parameter to the callback is an object representing {@link google.iam.v1.Policy | Policy}. + * @returns {Promise} - The promise which resolves to an array. + * The first element of the array is an object representing {@link google.iam.v1.Policy | Policy}. + * The promise has a method named "cancel" which cancels the ongoing API call. + */ + getIamPolicy( + request: IamProtos.google.iam.v1.GetIamPolicyRequest, + options?: + | gax.CallOptions + | Callback< + IamProtos.google.iam.v1.Policy, + IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, + {} | null | undefined + >, + callback?: Callback< + IamProtos.google.iam.v1.Policy, + IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, + {} | null | undefined + > + ): Promise<[IamProtos.google.iam.v1.Policy]> { + return this.iamClient.getIamPolicy(request, options, callback); + } + + /** + * Returns permissions that a caller has on the specified resource. If the + * resource does not exist, this will return an empty set of + * permissions, not a NOT_FOUND error. + * + * Note: This operation is designed to be used for building + * permission-aware UIs and command-line tools, not for authorization + * checking. This operation may "fail open" without warning. + * + * @param {Object} request + * The request object that will be sent. + * @param {string} request.resource + * REQUIRED: The resource for which the policy detail is being requested. + * See the operation documentation for the appropriate value for this field. + * @param {string[]} request.permissions + * The set of permissions to check for the `resource`. Permissions with + * wildcards (such as '*' or 'storage.*') are not allowed. For more + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. + * @param {Object} [options] + * Optional parameters. You can override the default settings for this call, e.g, timeout, + * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. + * @param {function(?Error, ?Object)} [callback] + * The function which will be called with the result of the API call. + * + * The second parameter to the callback is an object representing {@link google.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. + * @returns {Promise} - The promise which resolves to an array. + * The first element of the array is an object representing {@link google.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. + * The promise has a method named "cancel" which cancels the ongoing API call. + */ + setIamPolicy( + request: IamProtos.google.iam.v1.SetIamPolicyRequest, + options?: + | gax.CallOptions + | Callback< + IamProtos.google.iam.v1.Policy, + IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, + {} | null | undefined + >, + callback?: Callback< + IamProtos.google.iam.v1.Policy, + IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, + {} | null | undefined + > + ): Promise<[IamProtos.google.iam.v1.Policy]> { + return this.iamClient.setIamPolicy(request, options, callback); + } + + /** + * Returns permissions that a caller has on the specified resource. If the + * resource does not exist, this will return an empty set of + * permissions, not a NOT_FOUND error. + * + * Note: This operation is designed to be used for building + * permission-aware UIs and command-line tools, not for authorization + * checking. This operation may "fail open" without warning. + * + * @param {Object} request + * The request object that will be sent. + * @param {string} request.resource + * REQUIRED: The resource for which the policy detail is being requested. + * See the operation documentation for the appropriate value for this field. + * @param {string[]} request.permissions + * The set of permissions to check for the `resource`. Permissions with + * wildcards (such as '*' or 'storage.*') are not allowed. For more + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. + * @param {Object} [options] + * Optional parameters. You can override the default settings for this call, e.g, timeout, + * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. + * @param {function(?Error, ?Object)} [callback] + * The function which will be called with the result of the API call. + * + * The second parameter to the callback is an object representing {@link google.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. + * @returns {Promise} - The promise which resolves to an array. + * The first element of the array is an object representing {@link google.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. + * The promise has a method named "cancel" which cancels the ongoing API call. + * + */ + testIamPermissions( + request: IamProtos.google.iam.v1.TestIamPermissionsRequest, + options?: + | gax.CallOptions + | Callback< + IamProtos.google.iam.v1.TestIamPermissionsResponse, + IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, + {} | null | undefined + >, + callback?: Callback< + IamProtos.google.iam.v1.TestIamPermissionsResponse, + IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, + {} | null | undefined + > + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { + return this.iamClient.testIamPermissions(request, options, callback); + } + + /** + * Gets information about a location. + * + * @param {Object} request + * The request object that will be sent. + * @param {string} request.name + * Resource name for the location. + * @param {object} [options] + * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. + * @returns {Promise} - The promise which resolves to an array. + * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } + * for more details and examples. + * @example + * ``` + * const [response] = await client.getLocation(request); + * ``` + */ + getLocation( + request: LocationProtos.google.cloud.location.IGetLocationRequest, + options?: + | gax.CallOptions + | Callback< + LocationProtos.google.cloud.location.ILocation, + | LocationProtos.google.cloud.location.IGetLocationRequest + | null + | undefined, + {} | null | undefined + >, + callback?: Callback< + LocationProtos.google.cloud.location.ILocation, + | LocationProtos.google.cloud.location.IGetLocationRequest + | null + | undefined, + {} | null | undefined + > + ): Promise { + return this.locationsClient.getLocation(request, options, callback); + } + + /** + * Lists information about the supported locations for this service. Returns an iterable object. + * + * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand. + * @param {Object} request + * The request object that will be sent. + * @param {string} request.name + * The resource that owns the locations collection, if applicable. + * @param {string} request.filter + * The standard list filter. + * @param {number} request.pageSize + * The standard list page size. + * @param {string} request.pageToken + * The standard list page token. + * @param {object} [options] + * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. + * @returns {Object} + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. + * When you iterate the returned iterable, each element will be an object representing + * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, + * so you can stop the iteration when you don't need more results. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } + * for more details and examples. + * @example + * ``` + * const iterable = client.listLocationsAsync(request); + * for await (const response of iterable) { + * // process response + * } + * ``` + */ + listLocationsAsync( + request: LocationProtos.google.cloud.location.IListLocationsRequest, + options?: CallOptions + ): AsyncIterable { + return this.locationsClient.listLocationsAsync(request, options); + } + + /** + * Gets the latest state of a long-running operation. Clients can use this + * method to poll the operation result at intervals as recommended by the API + * service. + * + * @param {Object} request - The request object that will be sent. + * @param {string} request.name - The name of the operation resource. + * @param {Object=} options + * Optional parameters. You can override the default settings for this call, + * e.g, timeout, retries, paginations, etc. See {@link + * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} + * for the details. + * @param {function(?Error, ?Object)=} callback + * The function which will be called with the result of the API call. + * + * The second parameter to the callback is an object representing + * {@link google.longrunning.Operation | google.longrunning.Operation}. + * @return {Promise} - The promise which resolves to an array. + * The first element of the array is an object representing + * {@link google.longrunning.Operation | google.longrunning.Operation}. + * The promise has a method named "cancel" which cancels the ongoing API call. + * + * @example + * ``` + * const client = longrunning.operationsClient(); + * const name = ''; + * const [response] = await client.getOperation({name}); + * // doThingsWith(response) + * ``` + */ + getOperation( + request: protos.google.longrunning.GetOperationRequest, + options?: + | gax.CallOptions + | Callback< + protos.google.longrunning.Operation, + protos.google.longrunning.GetOperationRequest, + {} | null | undefined + >, + callback?: Callback< + protos.google.longrunning.Operation, + protos.google.longrunning.GetOperationRequest, + {} | null | undefined + > + ): Promise<[protos.google.longrunning.Operation]> { + return this.operationsClient.getOperation(request, options, callback); + } + /** + * Lists operations that match the specified filter in the request. If the + * server doesn't support this method, it returns `UNIMPLEMENTED`. Returns an iterable object. + * + * For-await-of syntax is used with the iterable to recursively get response element on-demand. + * + * @param {Object} request - The request object that will be sent. + * @param {string} request.name - The name of the operation collection. + * @param {string} request.filter - The standard list filter. + * @param {number=} request.pageSize - + * The maximum number of resources contained in the underlying API + * response. If page streaming is performed per-resource, this + * parameter does not affect the return value. If page streaming is + * performed per-page, this determines the maximum number of + * resources in a page. + * @param {Object=} options + * Optional parameters. You can override the default settings for this call, + * e.g, timeout, retries, paginations, etc. See {@link + * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the + * details. + * @returns {Object} + * An iterable Object that conforms to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | iteration protocols}. + * + * @example + * ``` + * const client = longrunning.operationsClient(); + * for await (const response of client.listOperationsAsync(request)); + * // doThingsWith(response) + * ``` + */ + listOperationsAsync( + request: protos.google.longrunning.ListOperationsRequest, + options?: gax.CallOptions + ): AsyncIterable { + return this.operationsClient.listOperationsAsync(request, options); + } + /** + * Starts asynchronous cancellation on a long-running operation. The server + * makes a best effort to cancel the operation, but success is not + * guaranteed. If the server doesn't support this method, it returns + * `google.rpc.Code.UNIMPLEMENTED`. Clients can use + * {@link Operations.GetOperation} or + * other methods to check whether the cancellation succeeded or whether the + * operation completed despite cancellation. On successful cancellation, + * the operation is not deleted; instead, it becomes an operation with + * an {@link Operation.error} value with a {@link google.rpc.Status.code} of + * 1, corresponding to `Code.CANCELLED`. + * + * @param {Object} request - The request object that will be sent. + * @param {string} request.name - The name of the operation resource to be cancelled. + * @param {Object=} options + * Optional parameters. You can override the default settings for this call, + * e.g, timeout, retries, paginations, etc. See {@link + * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the + * details. + * @param {function(?Error)=} callback + * The function which will be called with the result of the API call. + * @return {Promise} - The promise which resolves when API call finishes. + * The promise has a method named "cancel" which cancels the ongoing API + * call. + * + * @example + * ``` + * const client = longrunning.operationsClient(); + * await client.cancelOperation({name: ''}); + * ``` + */ + cancelOperation( + request: protos.google.longrunning.CancelOperationRequest, + options?: + | gax.CallOptions + | Callback< + protos.google.protobuf.Empty, + protos.google.longrunning.CancelOperationRequest, + {} | undefined | null + >, + callback?: Callback< + protos.google.longrunning.CancelOperationRequest, + protos.google.protobuf.Empty, + {} | undefined | null + > + ): Promise { + return this.operationsClient.cancelOperation(request, options, callback); + } + + /** + * Deletes a long-running operation. This method indicates that the client is + * no longer interested in the operation result. It does not cancel the + * operation. If the server doesn't support this method, it returns + * `google.rpc.Code.UNIMPLEMENTED`. + * + * @param {Object} request - The request object that will be sent. + * @param {string} request.name - The name of the operation resource to be deleted. + * @param {Object=} options + * Optional parameters. You can override the default settings for this call, + * e.g, timeout, retries, paginations, etc. See {@link + * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} + * for the details. + * @param {function(?Error)=} callback + * The function which will be called with the result of the API call. + * @return {Promise} - The promise which resolves when API call finishes. + * The promise has a method named "cancel" which cancels the ongoing API + * call. + * + * @example + * ``` + * const client = longrunning.operationsClient(); + * await client.deleteOperation({name: ''}); + * ``` + */ + deleteOperation( + request: protos.google.longrunning.DeleteOperationRequest, + options?: + | gax.CallOptions + | Callback< + protos.google.protobuf.Empty, + protos.google.longrunning.DeleteOperationRequest, + {} | null | undefined + >, + callback?: Callback< + protos.google.protobuf.Empty, + protos.google.longrunning.DeleteOperationRequest, + {} | null | undefined + > + ): Promise { + return this.operationsClient.deleteOperation(request, options, callback); + } + + // -------------------- + // -- Path templates -- + // -------------------- + + /** + * Return a fully-qualified annotation resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} dataset + * @param {string} data_item + * @param {string} annotation + * @returns {string} Resource name string. + */ + annotationPath( + project: string, + location: string, + dataset: string, + dataItem: string, + annotation: string + ) { + return this.pathTemplates.annotationPathTemplate.render({ + project: project, + location: location, + dataset: dataset, + data_item: dataItem, + annotation: annotation, + }); + } + + /** + * Parse the project from Annotation resource. + * + * @param {string} annotationName + * A fully-qualified path representing Annotation resource. + * @returns {string} A string representing the project. + */ + matchProjectFromAnnotationName(annotationName: string) { + return this.pathTemplates.annotationPathTemplate.match(annotationName) + .project; + } + + /** + * Parse the location from Annotation resource. + * + * @param {string} annotationName + * A fully-qualified path representing Annotation resource. + * @returns {string} A string representing the location. + */ + matchLocationFromAnnotationName(annotationName: string) { + return this.pathTemplates.annotationPathTemplate.match(annotationName) + .location; + } + + /** + * Parse the dataset from Annotation resource. + * + * @param {string} annotationName + * A fully-qualified path representing Annotation resource. + * @returns {string} A string representing the dataset. + */ + matchDatasetFromAnnotationName(annotationName: string) { + return this.pathTemplates.annotationPathTemplate.match(annotationName) + .dataset; + } + + /** + * Parse the data_item from Annotation resource. + * + * @param {string} annotationName + * A fully-qualified path representing Annotation resource. + * @returns {string} A string representing the data_item. + */ + matchDataItemFromAnnotationName(annotationName: string) { + return this.pathTemplates.annotationPathTemplate.match(annotationName) + .data_item; + } + + /** + * Parse the annotation from Annotation resource. + * + * @param {string} annotationName + * A fully-qualified path representing Annotation resource. + * @returns {string} A string representing the annotation. + */ + matchAnnotationFromAnnotationName(annotationName: string) { + return this.pathTemplates.annotationPathTemplate.match(annotationName) + .annotation; + } + + /** + * Return a fully-qualified annotationSpec resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} dataset + * @param {string} annotation_spec + * @returns {string} Resource name string. + */ + annotationSpecPath( + project: string, + location: string, + dataset: string, + annotationSpec: string + ) { + return this.pathTemplates.annotationSpecPathTemplate.render({ + project: project, + location: location, + dataset: dataset, + annotation_spec: annotationSpec, + }); + } + + /** + * Parse the project from AnnotationSpec resource. + * + * @param {string} annotationSpecName + * A fully-qualified path representing AnnotationSpec resource. + * @returns {string} A string representing the project. + */ + matchProjectFromAnnotationSpecName(annotationSpecName: string) { + return this.pathTemplates.annotationSpecPathTemplate.match( + annotationSpecName + ).project; + } + + /** + * Parse the location from AnnotationSpec resource. + * + * @param {string} annotationSpecName + * A fully-qualified path representing AnnotationSpec resource. + * @returns {string} A string representing the location. + */ + matchLocationFromAnnotationSpecName(annotationSpecName: string) { + return this.pathTemplates.annotationSpecPathTemplate.match( + annotationSpecName + ).location; + } + + /** + * Parse the dataset from AnnotationSpec resource. + * + * @param {string} annotationSpecName + * A fully-qualified path representing AnnotationSpec resource. + * @returns {string} A string representing the dataset. + */ + matchDatasetFromAnnotationSpecName(annotationSpecName: string) { + return this.pathTemplates.annotationSpecPathTemplate.match( + annotationSpecName + ).dataset; + } + + /** + * Parse the annotation_spec from AnnotationSpec resource. + * + * @param {string} annotationSpecName + * A fully-qualified path representing AnnotationSpec resource. + * @returns {string} A string representing the annotation_spec. + */ + matchAnnotationSpecFromAnnotationSpecName(annotationSpecName: string) { + return this.pathTemplates.annotationSpecPathTemplate.match( + annotationSpecName + ).annotation_spec; + } + + /** + * Return a fully-qualified artifact resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} metadata_store + * @param {string} artifact + * @returns {string} Resource name string. + */ + artifactPath( + project: string, + location: string, + metadataStore: string, + artifact: string + ) { + return this.pathTemplates.artifactPathTemplate.render({ + project: project, + location: location, + metadata_store: metadataStore, + artifact: artifact, + }); + } + + /** + * Parse the project from Artifact resource. + * + * @param {string} artifactName + * A fully-qualified path representing Artifact resource. + * @returns {string} A string representing the project. + */ + matchProjectFromArtifactName(artifactName: string) { + return this.pathTemplates.artifactPathTemplate.match(artifactName).project; + } + + /** + * Parse the location from Artifact resource. + * + * @param {string} artifactName + * A fully-qualified path representing Artifact resource. + * @returns {string} A string representing the location. + */ + matchLocationFromArtifactName(artifactName: string) { + return this.pathTemplates.artifactPathTemplate.match(artifactName).location; + } + + /** + * Parse the metadata_store from Artifact resource. + * + * @param {string} artifactName + * A fully-qualified path representing Artifact resource. + * @returns {string} A string representing the metadata_store. + */ + matchMetadataStoreFromArtifactName(artifactName: string) { + return this.pathTemplates.artifactPathTemplate.match(artifactName) + .metadata_store; + } + + /** + * Parse the artifact from Artifact resource. + * + * @param {string} artifactName + * A fully-qualified path representing Artifact resource. + * @returns {string} A string representing the artifact. + */ + matchArtifactFromArtifactName(artifactName: string) { + return this.pathTemplates.artifactPathTemplate.match(artifactName).artifact; + } + + /** + * Return a fully-qualified batchPredictionJob resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} batch_prediction_job + * @returns {string} Resource name string. + */ + batchPredictionJobPath( + project: string, + location: string, + batchPredictionJob: string + ) { + return this.pathTemplates.batchPredictionJobPathTemplate.render({ + project: project, + location: location, + batch_prediction_job: batchPredictionJob, + }); + } + + /** + * Parse the project from BatchPredictionJob resource. + * + * @param {string} batchPredictionJobName + * A fully-qualified path representing BatchPredictionJob resource. + * @returns {string} A string representing the project. + */ + matchProjectFromBatchPredictionJobName(batchPredictionJobName: string) { + return this.pathTemplates.batchPredictionJobPathTemplate.match( + batchPredictionJobName + ).project; + } + + /** + * Parse the location from BatchPredictionJob resource. + * + * @param {string} batchPredictionJobName + * A fully-qualified path representing BatchPredictionJob resource. + * @returns {string} A string representing the location. + */ + matchLocationFromBatchPredictionJobName(batchPredictionJobName: string) { + return this.pathTemplates.batchPredictionJobPathTemplate.match( + batchPredictionJobName + ).location; + } + + /** + * Parse the batch_prediction_job from BatchPredictionJob resource. + * + * @param {string} batchPredictionJobName + * A fully-qualified path representing BatchPredictionJob resource. + * @returns {string} A string representing the batch_prediction_job. + */ + matchBatchPredictionJobFromBatchPredictionJobName( + batchPredictionJobName: string + ) { + return this.pathTemplates.batchPredictionJobPathTemplate.match( + batchPredictionJobName + ).batch_prediction_job; + } + + /** + * Return a fully-qualified context resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} metadata_store + * @param {string} context + * @returns {string} Resource name string. + */ + contextPath( + project: string, + location: string, + metadataStore: string, + context: string + ) { + return this.pathTemplates.contextPathTemplate.render({ + project: project, + location: location, + metadata_store: metadataStore, + context: context, + }); + } + + /** + * Parse the project from Context resource. + * + * @param {string} contextName + * A fully-qualified path representing Context resource. + * @returns {string} A string representing the project. + */ + matchProjectFromContextName(contextName: string) { + return this.pathTemplates.contextPathTemplate.match(contextName).project; + } + + /** + * Parse the location from Context resource. + * + * @param {string} contextName + * A fully-qualified path representing Context resource. + * @returns {string} A string representing the location. + */ + matchLocationFromContextName(contextName: string) { + return this.pathTemplates.contextPathTemplate.match(contextName).location; + } + + /** + * Parse the metadata_store from Context resource. + * + * @param {string} contextName + * A fully-qualified path representing Context resource. + * @returns {string} A string representing the metadata_store. + */ + matchMetadataStoreFromContextName(contextName: string) { + return this.pathTemplates.contextPathTemplate.match(contextName) + .metadata_store; + } + + /** + * Parse the context from Context resource. + * + * @param {string} contextName + * A fully-qualified path representing Context resource. + * @returns {string} A string representing the context. + */ + matchContextFromContextName(contextName: string) { + return this.pathTemplates.contextPathTemplate.match(contextName).context; + } + + /** + * Return a fully-qualified customJob resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} custom_job + * @returns {string} Resource name string. + */ + customJobPath(project: string, location: string, customJob: string) { + return this.pathTemplates.customJobPathTemplate.render({ + project: project, + location: location, + custom_job: customJob, + }); + } + + /** + * Parse the project from CustomJob resource. + * + * @param {string} customJobName + * A fully-qualified path representing CustomJob resource. + * @returns {string} A string representing the project. + */ + matchProjectFromCustomJobName(customJobName: string) { + return this.pathTemplates.customJobPathTemplate.match(customJobName) + .project; + } + + /** + * Parse the location from CustomJob resource. + * + * @param {string} customJobName + * A fully-qualified path representing CustomJob resource. + * @returns {string} A string representing the location. + */ + matchLocationFromCustomJobName(customJobName: string) { + return this.pathTemplates.customJobPathTemplate.match(customJobName) + .location; + } + + /** + * Parse the custom_job from CustomJob resource. + * + * @param {string} customJobName + * A fully-qualified path representing CustomJob resource. + * @returns {string} A string representing the custom_job. + */ + matchCustomJobFromCustomJobName(customJobName: string) { + return this.pathTemplates.customJobPathTemplate.match(customJobName) + .custom_job; + } + + /** + * Return a fully-qualified dataItem resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} dataset + * @param {string} data_item + * @returns {string} Resource name string. + */ + dataItemPath( + project: string, + location: string, + dataset: string, + dataItem: string + ) { + return this.pathTemplates.dataItemPathTemplate.render({ + project: project, + location: location, + dataset: dataset, + data_item: dataItem, + }); + } + + /** + * Parse the project from DataItem resource. + * + * @param {string} dataItemName + * A fully-qualified path representing DataItem resource. + * @returns {string} A string representing the project. + */ + matchProjectFromDataItemName(dataItemName: string) { + return this.pathTemplates.dataItemPathTemplate.match(dataItemName).project; + } + + /** + * Parse the location from DataItem resource. + * + * @param {string} dataItemName + * A fully-qualified path representing DataItem resource. + * @returns {string} A string representing the location. + */ + matchLocationFromDataItemName(dataItemName: string) { + return this.pathTemplates.dataItemPathTemplate.match(dataItemName).location; + } + + /** + * Parse the dataset from DataItem resource. + * + * @param {string} dataItemName + * A fully-qualified path representing DataItem resource. + * @returns {string} A string representing the dataset. + */ + matchDatasetFromDataItemName(dataItemName: string) { + return this.pathTemplates.dataItemPathTemplate.match(dataItemName).dataset; + } + + /** + * Parse the data_item from DataItem resource. + * + * @param {string} dataItemName + * A fully-qualified path representing DataItem resource. + * @returns {string} A string representing the data_item. + */ + matchDataItemFromDataItemName(dataItemName: string) { + return this.pathTemplates.dataItemPathTemplate.match(dataItemName) + .data_item; + } + + /** + * Return a fully-qualified dataLabelingJob resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} data_labeling_job + * @returns {string} Resource name string. + */ + dataLabelingJobPath( + project: string, + location: string, + dataLabelingJob: string + ) { + return this.pathTemplates.dataLabelingJobPathTemplate.render({ + project: project, + location: location, + data_labeling_job: dataLabelingJob, + }); + } + + /** + * Parse the project from DataLabelingJob resource. + * + * @param {string} dataLabelingJobName + * A fully-qualified path representing DataLabelingJob resource. + * @returns {string} A string representing the project. + */ + matchProjectFromDataLabelingJobName(dataLabelingJobName: string) { + return this.pathTemplates.dataLabelingJobPathTemplate.match( + dataLabelingJobName + ).project; + } + + /** + * Parse the location from DataLabelingJob resource. + * + * @param {string} dataLabelingJobName + * A fully-qualified path representing DataLabelingJob resource. + * @returns {string} A string representing the location. + */ + matchLocationFromDataLabelingJobName(dataLabelingJobName: string) { + return this.pathTemplates.dataLabelingJobPathTemplate.match( + dataLabelingJobName + ).location; + } + + /** + * Parse the data_labeling_job from DataLabelingJob resource. + * + * @param {string} dataLabelingJobName + * A fully-qualified path representing DataLabelingJob resource. + * @returns {string} A string representing the data_labeling_job. + */ + matchDataLabelingJobFromDataLabelingJobName(dataLabelingJobName: string) { + return this.pathTemplates.dataLabelingJobPathTemplate.match( + dataLabelingJobName + ).data_labeling_job; + } + + /** + * Return a fully-qualified dataset resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} dataset + * @returns {string} Resource name string. + */ + datasetPath(project: string, location: string, dataset: string) { + return this.pathTemplates.datasetPathTemplate.render({ + project: project, + location: location, + dataset: dataset, + }); + } + + /** + * Parse the project from Dataset resource. + * + * @param {string} datasetName + * A fully-qualified path representing Dataset resource. + * @returns {string} A string representing the project. + */ + matchProjectFromDatasetName(datasetName: string) { + return this.pathTemplates.datasetPathTemplate.match(datasetName).project; + } + + /** + * Parse the location from Dataset resource. + * + * @param {string} datasetName + * A fully-qualified path representing Dataset resource. + * @returns {string} A string representing the location. + */ + matchLocationFromDatasetName(datasetName: string) { + return this.pathTemplates.datasetPathTemplate.match(datasetName).location; + } + + /** + * Parse the dataset from Dataset resource. + * + * @param {string} datasetName + * A fully-qualified path representing Dataset resource. + * @returns {string} A string representing the dataset. + */ + matchDatasetFromDatasetName(datasetName: string) { + return this.pathTemplates.datasetPathTemplate.match(datasetName).dataset; + } + + /** + * Return a fully-qualified entityType resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} featurestore + * @param {string} entity_type + * @returns {string} Resource name string. + */ + entityTypePath( + project: string, + location: string, + featurestore: string, + entityType: string + ) { + return this.pathTemplates.entityTypePathTemplate.render({ + project: project, + location: location, + featurestore: featurestore, + entity_type: entityType, + }); + } + + /** + * Parse the project from EntityType resource. + * + * @param {string} entityTypeName + * A fully-qualified path representing EntityType resource. + * @returns {string} A string representing the project. + */ + matchProjectFromEntityTypeName(entityTypeName: string) { + return this.pathTemplates.entityTypePathTemplate.match(entityTypeName) + .project; + } + + /** + * Parse the location from EntityType resource. + * + * @param {string} entityTypeName + * A fully-qualified path representing EntityType resource. + * @returns {string} A string representing the location. + */ + matchLocationFromEntityTypeName(entityTypeName: string) { + return this.pathTemplates.entityTypePathTemplate.match(entityTypeName) + .location; + } + + /** + * Parse the featurestore from EntityType resource. + * + * @param {string} entityTypeName + * A fully-qualified path representing EntityType resource. + * @returns {string} A string representing the featurestore. + */ + matchFeaturestoreFromEntityTypeName(entityTypeName: string) { + return this.pathTemplates.entityTypePathTemplate.match(entityTypeName) + .featurestore; + } + + /** + * Parse the entity_type from EntityType resource. + * + * @param {string} entityTypeName + * A fully-qualified path representing EntityType resource. + * @returns {string} A string representing the entity_type. + */ + matchEntityTypeFromEntityTypeName(entityTypeName: string) { + return this.pathTemplates.entityTypePathTemplate.match(entityTypeName) + .entity_type; + } + + /** + * Return a fully-qualified execution resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} metadata_store + * @param {string} execution + * @returns {string} Resource name string. + */ + executionPath( + project: string, + location: string, + metadataStore: string, + execution: string + ) { + return this.pathTemplates.executionPathTemplate.render({ + project: project, + location: location, + metadata_store: metadataStore, + execution: execution, + }); + } + + /** + * Parse the project from Execution resource. + * + * @param {string} executionName + * A fully-qualified path representing Execution resource. + * @returns {string} A string representing the project. + */ + matchProjectFromExecutionName(executionName: string) { + return this.pathTemplates.executionPathTemplate.match(executionName) + .project; + } + + /** + * Parse the location from Execution resource. + * + * @param {string} executionName + * A fully-qualified path representing Execution resource. + * @returns {string} A string representing the location. + */ + matchLocationFromExecutionName(executionName: string) { + return this.pathTemplates.executionPathTemplate.match(executionName) + .location; + } + + /** + * Parse the metadata_store from Execution resource. + * + * @param {string} executionName + * A fully-qualified path representing Execution resource. + * @returns {string} A string representing the metadata_store. + */ + matchMetadataStoreFromExecutionName(executionName: string) { + return this.pathTemplates.executionPathTemplate.match(executionName) + .metadata_store; + } + + /** + * Parse the execution from Execution resource. + * + * @param {string} executionName + * A fully-qualified path representing Execution resource. + * @returns {string} A string representing the execution. + */ + matchExecutionFromExecutionName(executionName: string) { + return this.pathTemplates.executionPathTemplate.match(executionName) + .execution; + } + + /** + * Return a fully-qualified feature resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} featurestore + * @param {string} entity_type + * @param {string} feature + * @returns {string} Resource name string. + */ + featurePath( + project: string, + location: string, + featurestore: string, + entityType: string, + feature: string + ) { + return this.pathTemplates.featurePathTemplate.render({ + project: project, + location: location, + featurestore: featurestore, + entity_type: entityType, + feature: feature, + }); + } + + /** + * Parse the project from Feature resource. + * + * @param {string} featureName + * A fully-qualified path representing Feature resource. + * @returns {string} A string representing the project. + */ + matchProjectFromFeatureName(featureName: string) { + return this.pathTemplates.featurePathTemplate.match(featureName).project; + } + + /** + * Parse the location from Feature resource. + * + * @param {string} featureName + * A fully-qualified path representing Feature resource. + * @returns {string} A string representing the location. + */ + matchLocationFromFeatureName(featureName: string) { + return this.pathTemplates.featurePathTemplate.match(featureName).location; + } + + /** + * Parse the featurestore from Feature resource. + * + * @param {string} featureName + * A fully-qualified path representing Feature resource. + * @returns {string} A string representing the featurestore. + */ + matchFeaturestoreFromFeatureName(featureName: string) { + return this.pathTemplates.featurePathTemplate.match(featureName) + .featurestore; + } + + /** + * Parse the entity_type from Feature resource. + * + * @param {string} featureName + * A fully-qualified path representing Feature resource. + * @returns {string} A string representing the entity_type. + */ + matchEntityTypeFromFeatureName(featureName: string) { + return this.pathTemplates.featurePathTemplate.match(featureName) + .entity_type; + } + + /** + * Parse the feature from Feature resource. + * + * @param {string} featureName + * A fully-qualified path representing Feature resource. + * @returns {string} A string representing the feature. + */ + matchFeatureFromFeatureName(featureName: string) { + return this.pathTemplates.featurePathTemplate.match(featureName).feature; + } + + /** + * Return a fully-qualified featurestore resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} featurestore + * @returns {string} Resource name string. + */ + featurestorePath(project: string, location: string, featurestore: string) { + return this.pathTemplates.featurestorePathTemplate.render({ + project: project, + location: location, + featurestore: featurestore, + }); + } + + /** + * Parse the project from Featurestore resource. + * + * @param {string} featurestoreName + * A fully-qualified path representing Featurestore resource. + * @returns {string} A string representing the project. + */ + matchProjectFromFeaturestoreName(featurestoreName: string) { + return this.pathTemplates.featurestorePathTemplate.match(featurestoreName) + .project; + } + + /** + * Parse the location from Featurestore resource. + * + * @param {string} featurestoreName + * A fully-qualified path representing Featurestore resource. + * @returns {string} A string representing the location. + */ + matchLocationFromFeaturestoreName(featurestoreName: string) { + return this.pathTemplates.featurestorePathTemplate.match(featurestoreName) + .location; + } + + /** + * Parse the featurestore from Featurestore resource. + * + * @param {string} featurestoreName + * A fully-qualified path representing Featurestore resource. + * @returns {string} A string representing the featurestore. + */ + matchFeaturestoreFromFeaturestoreName(featurestoreName: string) { + return this.pathTemplates.featurestorePathTemplate.match(featurestoreName) + .featurestore; + } + + /** + * Return a fully-qualified hyperparameterTuningJob resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} hyperparameter_tuning_job + * @returns {string} Resource name string. + */ + hyperparameterTuningJobPath( + project: string, + location: string, + hyperparameterTuningJob: string + ) { + return this.pathTemplates.hyperparameterTuningJobPathTemplate.render({ + project: project, + location: location, + hyperparameter_tuning_job: hyperparameterTuningJob, + }); + } + + /** + * Parse the project from HyperparameterTuningJob resource. + * + * @param {string} hyperparameterTuningJobName + * A fully-qualified path representing HyperparameterTuningJob resource. + * @returns {string} A string representing the project. + */ + matchProjectFromHyperparameterTuningJobName( + hyperparameterTuningJobName: string + ) { + return this.pathTemplates.hyperparameterTuningJobPathTemplate.match( + hyperparameterTuningJobName + ).project; + } + + /** + * Parse the location from HyperparameterTuningJob resource. + * + * @param {string} hyperparameterTuningJobName + * A fully-qualified path representing HyperparameterTuningJob resource. + * @returns {string} A string representing the location. + */ + matchLocationFromHyperparameterTuningJobName( + hyperparameterTuningJobName: string + ) { + return this.pathTemplates.hyperparameterTuningJobPathTemplate.match( + hyperparameterTuningJobName + ).location; + } + + /** + * Parse the hyperparameter_tuning_job from HyperparameterTuningJob resource. + * + * @param {string} hyperparameterTuningJobName + * A fully-qualified path representing HyperparameterTuningJob resource. + * @returns {string} A string representing the hyperparameter_tuning_job. + */ + matchHyperparameterTuningJobFromHyperparameterTuningJobName( + hyperparameterTuningJobName: string + ) { + return this.pathTemplates.hyperparameterTuningJobPathTemplate.match( + hyperparameterTuningJobName + ).hyperparameter_tuning_job; + } + + /** + * Return a fully-qualified index resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} index + * @returns {string} Resource name string. + */ + indexPath(project: string, location: string, index: string) { + return this.pathTemplates.indexPathTemplate.render({ + project: project, + location: location, + index: index, + }); + } + + /** + * Parse the project from Index resource. + * + * @param {string} indexName + * A fully-qualified path representing Index resource. + * @returns {string} A string representing the project. + */ + matchProjectFromIndexName(indexName: string) { + return this.pathTemplates.indexPathTemplate.match(indexName).project; + } + + /** + * Parse the location from Index resource. + * + * @param {string} indexName + * A fully-qualified path representing Index resource. + * @returns {string} A string representing the location. + */ + matchLocationFromIndexName(indexName: string) { + return this.pathTemplates.indexPathTemplate.match(indexName).location; + } + + /** + * Parse the index from Index resource. + * + * @param {string} indexName + * A fully-qualified path representing Index resource. + * @returns {string} A string representing the index. + */ + matchIndexFromIndexName(indexName: string) { + return this.pathTemplates.indexPathTemplate.match(indexName).index; + } + + /** + * Return a fully-qualified indexEndpoint resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} index_endpoint + * @returns {string} Resource name string. + */ + indexEndpointPath(project: string, location: string, indexEndpoint: string) { + return this.pathTemplates.indexEndpointPathTemplate.render({ + project: project, + location: location, + index_endpoint: indexEndpoint, + }); + } + + /** + * Parse the project from IndexEndpoint resource. + * + * @param {string} indexEndpointName + * A fully-qualified path representing IndexEndpoint resource. + * @returns {string} A string representing the project. + */ + matchProjectFromIndexEndpointName(indexEndpointName: string) { + return this.pathTemplates.indexEndpointPathTemplate.match(indexEndpointName) + .project; + } + + /** + * Parse the location from IndexEndpoint resource. + * + * @param {string} indexEndpointName + * A fully-qualified path representing IndexEndpoint resource. + * @returns {string} A string representing the location. + */ + matchLocationFromIndexEndpointName(indexEndpointName: string) { + return this.pathTemplates.indexEndpointPathTemplate.match(indexEndpointName) + .location; + } + + /** + * Parse the index_endpoint from IndexEndpoint resource. + * + * @param {string} indexEndpointName + * A fully-qualified path representing IndexEndpoint resource. + * @returns {string} A string representing the index_endpoint. + */ + matchIndexEndpointFromIndexEndpointName(indexEndpointName: string) { + return this.pathTemplates.indexEndpointPathTemplate.match(indexEndpointName) + .index_endpoint; + } + + /** + * Return a fully-qualified location resource name string. + * + * @param {string} project + * @param {string} location + * @returns {string} Resource name string. + */ + locationPath(project: string, location: string) { + return this.pathTemplates.locationPathTemplate.render({ + project: project, + location: location, + }); + } + + /** + * Parse the project from Location resource. + * + * @param {string} locationName + * A fully-qualified path representing Location resource. + * @returns {string} A string representing the project. + */ + matchProjectFromLocationName(locationName: string) { + return this.pathTemplates.locationPathTemplate.match(locationName).project; + } + + /** + * Parse the location from Location resource. + * + * @param {string} locationName + * A fully-qualified path representing Location resource. + * @returns {string} A string representing the location. + */ + matchLocationFromLocationName(locationName: string) { + return this.pathTemplates.locationPathTemplate.match(locationName).location; + } + + /** + * Return a fully-qualified metadataSchema resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} metadata_store + * @param {string} metadata_schema + * @returns {string} Resource name string. + */ + metadataSchemaPath( + project: string, + location: string, + metadataStore: string, + metadataSchema: string + ) { + return this.pathTemplates.metadataSchemaPathTemplate.render({ + project: project, + location: location, + metadata_store: metadataStore, + metadata_schema: metadataSchema, + }); + } + + /** + * Parse the project from MetadataSchema resource. + * + * @param {string} metadataSchemaName + * A fully-qualified path representing MetadataSchema resource. + * @returns {string} A string representing the project. + */ + matchProjectFromMetadataSchemaName(metadataSchemaName: string) { + return this.pathTemplates.metadataSchemaPathTemplate.match( + metadataSchemaName + ).project; + } + + /** + * Parse the location from MetadataSchema resource. + * + * @param {string} metadataSchemaName + * A fully-qualified path representing MetadataSchema resource. + * @returns {string} A string representing the location. + */ + matchLocationFromMetadataSchemaName(metadataSchemaName: string) { + return this.pathTemplates.metadataSchemaPathTemplate.match( + metadataSchemaName + ).location; + } + + /** + * Parse the metadata_store from MetadataSchema resource. + * + * @param {string} metadataSchemaName + * A fully-qualified path representing MetadataSchema resource. + * @returns {string} A string representing the metadata_store. + */ + matchMetadataStoreFromMetadataSchemaName(metadataSchemaName: string) { + return this.pathTemplates.metadataSchemaPathTemplate.match( + metadataSchemaName + ).metadata_store; + } + + /** + * Parse the metadata_schema from MetadataSchema resource. + * + * @param {string} metadataSchemaName + * A fully-qualified path representing MetadataSchema resource. + * @returns {string} A string representing the metadata_schema. + */ + matchMetadataSchemaFromMetadataSchemaName(metadataSchemaName: string) { + return this.pathTemplates.metadataSchemaPathTemplate.match( + metadataSchemaName + ).metadata_schema; + } + + /** + * Return a fully-qualified metadataStore resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} metadata_store + * @returns {string} Resource name string. + */ + metadataStorePath(project: string, location: string, metadataStore: string) { + return this.pathTemplates.metadataStorePathTemplate.render({ + project: project, + location: location, + metadata_store: metadataStore, + }); + } + + /** + * Parse the project from MetadataStore resource. + * + * @param {string} metadataStoreName + * A fully-qualified path representing MetadataStore resource. + * @returns {string} A string representing the project. + */ + matchProjectFromMetadataStoreName(metadataStoreName: string) { + return this.pathTemplates.metadataStorePathTemplate.match(metadataStoreName) + .project; + } + + /** + * Parse the location from MetadataStore resource. + * + * @param {string} metadataStoreName + * A fully-qualified path representing MetadataStore resource. + * @returns {string} A string representing the location. + */ + matchLocationFromMetadataStoreName(metadataStoreName: string) { + return this.pathTemplates.metadataStorePathTemplate.match(metadataStoreName) + .location; + } + + /** + * Parse the metadata_store from MetadataStore resource. + * + * @param {string} metadataStoreName + * A fully-qualified path representing MetadataStore resource. + * @returns {string} A string representing the metadata_store. + */ + matchMetadataStoreFromMetadataStoreName(metadataStoreName: string) { + return this.pathTemplates.metadataStorePathTemplate.match(metadataStoreName) + .metadata_store; + } + + /** + * Return a fully-qualified model resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} model + * @returns {string} Resource name string. + */ + modelPath(project: string, location: string, model: string) { + return this.pathTemplates.modelPathTemplate.render({ + project: project, + location: location, + model: model, + }); + } + + /** + * Parse the project from Model resource. + * + * @param {string} modelName + * A fully-qualified path representing Model resource. + * @returns {string} A string representing the project. + */ + matchProjectFromModelName(modelName: string) { + return this.pathTemplates.modelPathTemplate.match(modelName).project; + } + + /** + * Parse the location from Model resource. + * + * @param {string} modelName + * A fully-qualified path representing Model resource. + * @returns {string} A string representing the location. + */ + matchLocationFromModelName(modelName: string) { + return this.pathTemplates.modelPathTemplate.match(modelName).location; + } + + /** + * Parse the model from Model resource. + * + * @param {string} modelName + * A fully-qualified path representing Model resource. + * @returns {string} A string representing the model. + */ + matchModelFromModelName(modelName: string) { + return this.pathTemplates.modelPathTemplate.match(modelName).model; + } + + /** + * Return a fully-qualified modelDeploymentMonitoringJob resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} model_deployment_monitoring_job + * @returns {string} Resource name string. + */ + modelDeploymentMonitoringJobPath( + project: string, + location: string, + modelDeploymentMonitoringJob: string + ) { + return this.pathTemplates.modelDeploymentMonitoringJobPathTemplate.render({ + project: project, + location: location, + model_deployment_monitoring_job: modelDeploymentMonitoringJob, + }); + } + + /** + * Parse the project from ModelDeploymentMonitoringJob resource. + * + * @param {string} modelDeploymentMonitoringJobName + * A fully-qualified path representing ModelDeploymentMonitoringJob resource. + * @returns {string} A string representing the project. + */ + matchProjectFromModelDeploymentMonitoringJobName( + modelDeploymentMonitoringJobName: string + ) { + return this.pathTemplates.modelDeploymentMonitoringJobPathTemplate.match( + modelDeploymentMonitoringJobName + ).project; + } + + /** + * Parse the location from ModelDeploymentMonitoringJob resource. + * + * @param {string} modelDeploymentMonitoringJobName + * A fully-qualified path representing ModelDeploymentMonitoringJob resource. + * @returns {string} A string representing the location. + */ + matchLocationFromModelDeploymentMonitoringJobName( + modelDeploymentMonitoringJobName: string + ) { + return this.pathTemplates.modelDeploymentMonitoringJobPathTemplate.match( + modelDeploymentMonitoringJobName + ).location; + } + + /** + * Parse the model_deployment_monitoring_job from ModelDeploymentMonitoringJob resource. + * + * @param {string} modelDeploymentMonitoringJobName + * A fully-qualified path representing ModelDeploymentMonitoringJob resource. + * @returns {string} A string representing the model_deployment_monitoring_job. + */ + matchModelDeploymentMonitoringJobFromModelDeploymentMonitoringJobName( + modelDeploymentMonitoringJobName: string + ) { + return this.pathTemplates.modelDeploymentMonitoringJobPathTemplate.match( + modelDeploymentMonitoringJobName + ).model_deployment_monitoring_job; + } + + /** + * Return a fully-qualified modelEvaluation resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} model + * @param {string} evaluation + * @returns {string} Resource name string. + */ + modelEvaluationPath( + project: string, + location: string, + model: string, + evaluation: string + ) { + return this.pathTemplates.modelEvaluationPathTemplate.render({ + project: project, + location: location, + model: model, + evaluation: evaluation, + }); + } + + /** + * Parse the project from ModelEvaluation resource. + * + * @param {string} modelEvaluationName + * A fully-qualified path representing ModelEvaluation resource. + * @returns {string} A string representing the project. + */ + matchProjectFromModelEvaluationName(modelEvaluationName: string) { + return this.pathTemplates.modelEvaluationPathTemplate.match( + modelEvaluationName + ).project; + } + + /** + * Parse the location from ModelEvaluation resource. + * + * @param {string} modelEvaluationName + * A fully-qualified path representing ModelEvaluation resource. + * @returns {string} A string representing the location. + */ + matchLocationFromModelEvaluationName(modelEvaluationName: string) { + return this.pathTemplates.modelEvaluationPathTemplate.match( + modelEvaluationName + ).location; + } + + /** + * Parse the model from ModelEvaluation resource. + * + * @param {string} modelEvaluationName + * A fully-qualified path representing ModelEvaluation resource. + * @returns {string} A string representing the model. + */ + matchModelFromModelEvaluationName(modelEvaluationName: string) { + return this.pathTemplates.modelEvaluationPathTemplate.match( + modelEvaluationName + ).model; + } + + /** + * Parse the evaluation from ModelEvaluation resource. + * + * @param {string} modelEvaluationName + * A fully-qualified path representing ModelEvaluation resource. + * @returns {string} A string representing the evaluation. + */ + matchEvaluationFromModelEvaluationName(modelEvaluationName: string) { + return this.pathTemplates.modelEvaluationPathTemplate.match( + modelEvaluationName + ).evaluation; + } + + /** + * Return a fully-qualified modelEvaluationSlice resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} model + * @param {string} evaluation + * @param {string} slice + * @returns {string} Resource name string. + */ + modelEvaluationSlicePath( + project: string, + location: string, + model: string, + evaluation: string, + slice: string + ) { + return this.pathTemplates.modelEvaluationSlicePathTemplate.render({ + project: project, + location: location, + model: model, + evaluation: evaluation, + slice: slice, + }); + } + + /** + * Parse the project from ModelEvaluationSlice resource. + * + * @param {string} modelEvaluationSliceName + * A fully-qualified path representing ModelEvaluationSlice resource. + * @returns {string} A string representing the project. + */ + matchProjectFromModelEvaluationSliceName(modelEvaluationSliceName: string) { + return this.pathTemplates.modelEvaluationSlicePathTemplate.match( + modelEvaluationSliceName + ).project; + } + + /** + * Parse the location from ModelEvaluationSlice resource. + * + * @param {string} modelEvaluationSliceName + * A fully-qualified path representing ModelEvaluationSlice resource. + * @returns {string} A string representing the location. + */ + matchLocationFromModelEvaluationSliceName(modelEvaluationSliceName: string) { + return this.pathTemplates.modelEvaluationSlicePathTemplate.match( + modelEvaluationSliceName + ).location; + } + + /** + * Parse the model from ModelEvaluationSlice resource. + * + * @param {string} modelEvaluationSliceName + * A fully-qualified path representing ModelEvaluationSlice resource. + * @returns {string} A string representing the model. + */ + matchModelFromModelEvaluationSliceName(modelEvaluationSliceName: string) { + return this.pathTemplates.modelEvaluationSlicePathTemplate.match( + modelEvaluationSliceName + ).model; + } + + /** + * Parse the evaluation from ModelEvaluationSlice resource. + * + * @param {string} modelEvaluationSliceName + * A fully-qualified path representing ModelEvaluationSlice resource. + * @returns {string} A string representing the evaluation. + */ + matchEvaluationFromModelEvaluationSliceName( + modelEvaluationSliceName: string + ) { + return this.pathTemplates.modelEvaluationSlicePathTemplate.match( + modelEvaluationSliceName + ).evaluation; + } + + /** + * Parse the slice from ModelEvaluationSlice resource. + * + * @param {string} modelEvaluationSliceName + * A fully-qualified path representing ModelEvaluationSlice resource. + * @returns {string} A string representing the slice. + */ + matchSliceFromModelEvaluationSliceName(modelEvaluationSliceName: string) { + return this.pathTemplates.modelEvaluationSlicePathTemplate.match( + modelEvaluationSliceName + ).slice; + } + + /** + * Return a fully-qualified nasJob resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} nas_job + * @returns {string} Resource name string. + */ + nasJobPath(project: string, location: string, nasJob: string) { + return this.pathTemplates.nasJobPathTemplate.render({ + project: project, + location: location, + nas_job: nasJob, + }); + } + + /** + * Parse the project from NasJob resource. + * + * @param {string} nasJobName + * A fully-qualified path representing NasJob resource. + * @returns {string} A string representing the project. + */ + matchProjectFromNasJobName(nasJobName: string) { + return this.pathTemplates.nasJobPathTemplate.match(nasJobName).project; + } + + /** + * Parse the location from NasJob resource. + * + * @param {string} nasJobName + * A fully-qualified path representing NasJob resource. + * @returns {string} A string representing the location. + */ + matchLocationFromNasJobName(nasJobName: string) { + return this.pathTemplates.nasJobPathTemplate.match(nasJobName).location; + } + + /** + * Parse the nas_job from NasJob resource. + * + * @param {string} nasJobName + * A fully-qualified path representing NasJob resource. + * @returns {string} A string representing the nas_job. + */ + matchNasJobFromNasJobName(nasJobName: string) { + return this.pathTemplates.nasJobPathTemplate.match(nasJobName).nas_job; + } + + /** + * Return a fully-qualified nasTrialDetail resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} nas_job + * @param {string} nas_trial_detail + * @returns {string} Resource name string. + */ + nasTrialDetailPath( + project: string, + location: string, + nasJob: string, + nasTrialDetail: string + ) { + return this.pathTemplates.nasTrialDetailPathTemplate.render({ + project: project, + location: location, + nas_job: nasJob, + nas_trial_detail: nasTrialDetail, + }); + } + + /** + * Parse the project from NasTrialDetail resource. + * + * @param {string} nasTrialDetailName + * A fully-qualified path representing NasTrialDetail resource. + * @returns {string} A string representing the project. + */ + matchProjectFromNasTrialDetailName(nasTrialDetailName: string) { + return this.pathTemplates.nasTrialDetailPathTemplate.match( + nasTrialDetailName + ).project; + } + + /** + * Parse the location from NasTrialDetail resource. + * + * @param {string} nasTrialDetailName + * A fully-qualified path representing NasTrialDetail resource. + * @returns {string} A string representing the location. + */ + matchLocationFromNasTrialDetailName(nasTrialDetailName: string) { + return this.pathTemplates.nasTrialDetailPathTemplate.match( + nasTrialDetailName + ).location; + } + + /** + * Parse the nas_job from NasTrialDetail resource. + * + * @param {string} nasTrialDetailName + * A fully-qualified path representing NasTrialDetail resource. + * @returns {string} A string representing the nas_job. + */ + matchNasJobFromNasTrialDetailName(nasTrialDetailName: string) { + return this.pathTemplates.nasTrialDetailPathTemplate.match( + nasTrialDetailName + ).nas_job; + } + + /** + * Parse the nas_trial_detail from NasTrialDetail resource. + * + * @param {string} nasTrialDetailName + * A fully-qualified path representing NasTrialDetail resource. + * @returns {string} A string representing the nas_trial_detail. + */ + matchNasTrialDetailFromNasTrialDetailName(nasTrialDetailName: string) { + return this.pathTemplates.nasTrialDetailPathTemplate.match( + nasTrialDetailName + ).nas_trial_detail; + } + + /** + * Return a fully-qualified pipelineJob resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} pipeline_job + * @returns {string} Resource name string. + */ + pipelineJobPath(project: string, location: string, pipelineJob: string) { + return this.pathTemplates.pipelineJobPathTemplate.render({ + project: project, + location: location, + pipeline_job: pipelineJob, + }); + } + + /** + * Parse the project from PipelineJob resource. + * + * @param {string} pipelineJobName + * A fully-qualified path representing PipelineJob resource. + * @returns {string} A string representing the project. + */ + matchProjectFromPipelineJobName(pipelineJobName: string) { + return this.pathTemplates.pipelineJobPathTemplate.match(pipelineJobName) + .project; + } + + /** + * Parse the location from PipelineJob resource. + * + * @param {string} pipelineJobName + * A fully-qualified path representing PipelineJob resource. + * @returns {string} A string representing the location. + */ + matchLocationFromPipelineJobName(pipelineJobName: string) { + return this.pathTemplates.pipelineJobPathTemplate.match(pipelineJobName) + .location; + } + + /** + * Parse the pipeline_job from PipelineJob resource. + * + * @param {string} pipelineJobName + * A fully-qualified path representing PipelineJob resource. + * @returns {string} A string representing the pipeline_job. + */ + matchPipelineJobFromPipelineJobName(pipelineJobName: string) { + return this.pathTemplates.pipelineJobPathTemplate.match(pipelineJobName) + .pipeline_job; + } + + /** + * Return a fully-qualified projectLocationEndpoint resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} endpoint + * @returns {string} Resource name string. + */ + projectLocationEndpointPath( + project: string, + location: string, + endpoint: string + ) { + return this.pathTemplates.projectLocationEndpointPathTemplate.render({ + project: project, + location: location, + endpoint: endpoint, + }); + } + + /** + * Parse the project from ProjectLocationEndpoint resource. + * + * @param {string} projectLocationEndpointName + * A fully-qualified path representing project_location_endpoint resource. + * @returns {string} A string representing the project. + */ + matchProjectFromProjectLocationEndpointName( + projectLocationEndpointName: string + ) { + return this.pathTemplates.projectLocationEndpointPathTemplate.match( + projectLocationEndpointName + ).project; + } + + /** + * Parse the location from ProjectLocationEndpoint resource. + * + * @param {string} projectLocationEndpointName + * A fully-qualified path representing project_location_endpoint resource. + * @returns {string} A string representing the location. + */ + matchLocationFromProjectLocationEndpointName( + projectLocationEndpointName: string + ) { + return this.pathTemplates.projectLocationEndpointPathTemplate.match( + projectLocationEndpointName + ).location; + } + + /** + * Parse the endpoint from ProjectLocationEndpoint resource. + * + * @param {string} projectLocationEndpointName + * A fully-qualified path representing project_location_endpoint resource. + * @returns {string} A string representing the endpoint. + */ + matchEndpointFromProjectLocationEndpointName( + projectLocationEndpointName: string + ) { + return this.pathTemplates.projectLocationEndpointPathTemplate.match( + projectLocationEndpointName + ).endpoint; + } + + /** + * Return a fully-qualified projectLocationPublisherModel resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} publisher + * @param {string} model + * @returns {string} Resource name string. + */ + projectLocationPublisherModelPath( + project: string, + location: string, + publisher: string, + model: string + ) { + return this.pathTemplates.projectLocationPublisherModelPathTemplate.render({ + project: project, + location: location, + publisher: publisher, + model: model, + }); + } + + /** + * Parse the project from ProjectLocationPublisherModel resource. + * + * @param {string} projectLocationPublisherModelName + * A fully-qualified path representing project_location_publisher_model resource. + * @returns {string} A string representing the project. + */ + matchProjectFromProjectLocationPublisherModelName( + projectLocationPublisherModelName: string + ) { + return this.pathTemplates.projectLocationPublisherModelPathTemplate.match( + projectLocationPublisherModelName + ).project; + } + + /** + * Parse the location from ProjectLocationPublisherModel resource. + * + * @param {string} projectLocationPublisherModelName + * A fully-qualified path representing project_location_publisher_model resource. + * @returns {string} A string representing the location. + */ + matchLocationFromProjectLocationPublisherModelName( + projectLocationPublisherModelName: string + ) { + return this.pathTemplates.projectLocationPublisherModelPathTemplate.match( + projectLocationPublisherModelName + ).location; + } + + /** + * Parse the publisher from ProjectLocationPublisherModel resource. + * + * @param {string} projectLocationPublisherModelName + * A fully-qualified path representing project_location_publisher_model resource. + * @returns {string} A string representing the publisher. + */ + matchPublisherFromProjectLocationPublisherModelName( + projectLocationPublisherModelName: string + ) { + return this.pathTemplates.projectLocationPublisherModelPathTemplate.match( + projectLocationPublisherModelName + ).publisher; + } + + /** + * Parse the model from ProjectLocationPublisherModel resource. + * + * @param {string} projectLocationPublisherModelName + * A fully-qualified path representing project_location_publisher_model resource. + * @returns {string} A string representing the model. + */ + matchModelFromProjectLocationPublisherModelName( + projectLocationPublisherModelName: string + ) { + return this.pathTemplates.projectLocationPublisherModelPathTemplate.match( + projectLocationPublisherModelName + ).model; + } + + /** + * Return a fully-qualified publisherModel resource name string. + * + * @param {string} publisher + * @param {string} model + * @returns {string} Resource name string. + */ + publisherModelPath(publisher: string, model: string) { + return this.pathTemplates.publisherModelPathTemplate.render({ + publisher: publisher, + model: model, + }); + } + + /** + * Parse the publisher from PublisherModel resource. + * + * @param {string} publisherModelName + * A fully-qualified path representing PublisherModel resource. + * @returns {string} A string representing the publisher. + */ + matchPublisherFromPublisherModelName(publisherModelName: string) { + return this.pathTemplates.publisherModelPathTemplate.match( + publisherModelName + ).publisher; + } + + /** + * Parse the model from PublisherModel resource. + * + * @param {string} publisherModelName + * A fully-qualified path representing PublisherModel resource. + * @returns {string} A string representing the model. + */ + matchModelFromPublisherModelName(publisherModelName: string) { + return this.pathTemplates.publisherModelPathTemplate.match( + publisherModelName + ).model; + } + + /** + * Return a fully-qualified savedQuery resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} dataset + * @param {string} saved_query + * @returns {string} Resource name string. + */ + savedQueryPath( + project: string, + location: string, + dataset: string, + savedQuery: string + ) { + return this.pathTemplates.savedQueryPathTemplate.render({ + project: project, + location: location, + dataset: dataset, + saved_query: savedQuery, + }); + } + + /** + * Parse the project from SavedQuery resource. + * + * @param {string} savedQueryName + * A fully-qualified path representing SavedQuery resource. + * @returns {string} A string representing the project. + */ + matchProjectFromSavedQueryName(savedQueryName: string) { + return this.pathTemplates.savedQueryPathTemplate.match(savedQueryName) + .project; + } + + /** + * Parse the location from SavedQuery resource. + * + * @param {string} savedQueryName + * A fully-qualified path representing SavedQuery resource. + * @returns {string} A string representing the location. + */ + matchLocationFromSavedQueryName(savedQueryName: string) { + return this.pathTemplates.savedQueryPathTemplate.match(savedQueryName) + .location; + } + + /** + * Parse the dataset from SavedQuery resource. + * + * @param {string} savedQueryName + * A fully-qualified path representing SavedQuery resource. + * @returns {string} A string representing the dataset. + */ + matchDatasetFromSavedQueryName(savedQueryName: string) { + return this.pathTemplates.savedQueryPathTemplate.match(savedQueryName) + .dataset; + } + + /** + * Parse the saved_query from SavedQuery resource. + * + * @param {string} savedQueryName + * A fully-qualified path representing SavedQuery resource. + * @returns {string} A string representing the saved_query. + */ + matchSavedQueryFromSavedQueryName(savedQueryName: string) { + return this.pathTemplates.savedQueryPathTemplate.match(savedQueryName) + .saved_query; + } + + /** + * Return a fully-qualified schedule resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} schedule + * @returns {string} Resource name string. + */ + schedulePath(project: string, location: string, schedule: string) { + return this.pathTemplates.schedulePathTemplate.render({ + project: project, + location: location, + schedule: schedule, + }); + } + + /** + * Parse the project from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the project. + */ + matchProjectFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).project; + } + + /** + * Parse the location from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the location. + */ + matchLocationFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).location; + } + + /** + * Parse the schedule from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the schedule. + */ + matchScheduleFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).schedule; + } + + /** + * Return a fully-qualified specialistPool resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} specialist_pool + * @returns {string} Resource name string. + */ + specialistPoolPath( + project: string, + location: string, + specialistPool: string + ) { + return this.pathTemplates.specialistPoolPathTemplate.render({ + project: project, + location: location, + specialist_pool: specialistPool, + }); + } + + /** + * Parse the project from SpecialistPool resource. + * + * @param {string} specialistPoolName + * A fully-qualified path representing SpecialistPool resource. + * @returns {string} A string representing the project. + */ + matchProjectFromSpecialistPoolName(specialistPoolName: string) { + return this.pathTemplates.specialistPoolPathTemplate.match( + specialistPoolName + ).project; + } + + /** + * Parse the location from SpecialistPool resource. + * + * @param {string} specialistPoolName + * A fully-qualified path representing SpecialistPool resource. + * @returns {string} A string representing the location. + */ + matchLocationFromSpecialistPoolName(specialistPoolName: string) { + return this.pathTemplates.specialistPoolPathTemplate.match( + specialistPoolName + ).location; + } + + /** + * Parse the specialist_pool from SpecialistPool resource. + * + * @param {string} specialistPoolName + * A fully-qualified path representing SpecialistPool resource. + * @returns {string} A string representing the specialist_pool. + */ + matchSpecialistPoolFromSpecialistPoolName(specialistPoolName: string) { + return this.pathTemplates.specialistPoolPathTemplate.match( + specialistPoolName + ).specialist_pool; + } + + /** + * Return a fully-qualified study resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} study + * @returns {string} Resource name string. + */ + studyPath(project: string, location: string, study: string) { + return this.pathTemplates.studyPathTemplate.render({ + project: project, + location: location, + study: study, + }); + } + + /** + * Parse the project from Study resource. + * + * @param {string} studyName + * A fully-qualified path representing Study resource. + * @returns {string} A string representing the project. + */ + matchProjectFromStudyName(studyName: string) { + return this.pathTemplates.studyPathTemplate.match(studyName).project; + } + + /** + * Parse the location from Study resource. + * + * @param {string} studyName + * A fully-qualified path representing Study resource. + * @returns {string} A string representing the location. + */ + matchLocationFromStudyName(studyName: string) { + return this.pathTemplates.studyPathTemplate.match(studyName).location; + } + + /** + * Parse the study from Study resource. + * + * @param {string} studyName + * A fully-qualified path representing Study resource. + * @returns {string} A string representing the study. + */ + matchStudyFromStudyName(studyName: string) { + return this.pathTemplates.studyPathTemplate.match(studyName).study; + } + + /** + * Return a fully-qualified tensorboard resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} tensorboard + * @returns {string} Resource name string. + */ + tensorboardPath(project: string, location: string, tensorboard: string) { + return this.pathTemplates.tensorboardPathTemplate.render({ + project: project, + location: location, + tensorboard: tensorboard, + }); + } + + /** + * Parse the project from Tensorboard resource. + * + * @param {string} tensorboardName + * A fully-qualified path representing Tensorboard resource. + * @returns {string} A string representing the project. + */ + matchProjectFromTensorboardName(tensorboardName: string) { + return this.pathTemplates.tensorboardPathTemplate.match(tensorboardName) + .project; + } + + /** + * Parse the location from Tensorboard resource. + * + * @param {string} tensorboardName + * A fully-qualified path representing Tensorboard resource. + * @returns {string} A string representing the location. + */ + matchLocationFromTensorboardName(tensorboardName: string) { + return this.pathTemplates.tensorboardPathTemplate.match(tensorboardName) + .location; + } + + /** + * Parse the tensorboard from Tensorboard resource. + * + * @param {string} tensorboardName + * A fully-qualified path representing Tensorboard resource. + * @returns {string} A string representing the tensorboard. + */ + matchTensorboardFromTensorboardName(tensorboardName: string) { + return this.pathTemplates.tensorboardPathTemplate.match(tensorboardName) + .tensorboard; + } + + /** + * Return a fully-qualified tensorboardExperiment resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} tensorboard + * @param {string} experiment + * @returns {string} Resource name string. + */ + tensorboardExperimentPath( + project: string, + location: string, + tensorboard: string, + experiment: string + ) { + return this.pathTemplates.tensorboardExperimentPathTemplate.render({ + project: project, + location: location, + tensorboard: tensorboard, + experiment: experiment, + }); + } + + /** + * Parse the project from TensorboardExperiment resource. + * + * @param {string} tensorboardExperimentName + * A fully-qualified path representing TensorboardExperiment resource. + * @returns {string} A string representing the project. + */ + matchProjectFromTensorboardExperimentName(tensorboardExperimentName: string) { + return this.pathTemplates.tensorboardExperimentPathTemplate.match( + tensorboardExperimentName + ).project; + } + + /** + * Parse the location from TensorboardExperiment resource. + * + * @param {string} tensorboardExperimentName + * A fully-qualified path representing TensorboardExperiment resource. + * @returns {string} A string representing the location. + */ + matchLocationFromTensorboardExperimentName( + tensorboardExperimentName: string + ) { + return this.pathTemplates.tensorboardExperimentPathTemplate.match( + tensorboardExperimentName + ).location; + } + + /** + * Parse the tensorboard from TensorboardExperiment resource. + * + * @param {string} tensorboardExperimentName + * A fully-qualified path representing TensorboardExperiment resource. + * @returns {string} A string representing the tensorboard. + */ + matchTensorboardFromTensorboardExperimentName( + tensorboardExperimentName: string + ) { + return this.pathTemplates.tensorboardExperimentPathTemplate.match( + tensorboardExperimentName + ).tensorboard; + } + + /** + * Parse the experiment from TensorboardExperiment resource. + * + * @param {string} tensorboardExperimentName + * A fully-qualified path representing TensorboardExperiment resource. + * @returns {string} A string representing the experiment. + */ + matchExperimentFromTensorboardExperimentName( + tensorboardExperimentName: string + ) { + return this.pathTemplates.tensorboardExperimentPathTemplate.match( + tensorboardExperimentName + ).experiment; + } + + /** + * Return a fully-qualified tensorboardRun resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} tensorboard + * @param {string} experiment + * @param {string} run + * @returns {string} Resource name string. + */ + tensorboardRunPath( + project: string, + location: string, + tensorboard: string, + experiment: string, + run: string + ) { + return this.pathTemplates.tensorboardRunPathTemplate.render({ + project: project, + location: location, + tensorboard: tensorboard, + experiment: experiment, + run: run, + }); + } + + /** + * Parse the project from TensorboardRun resource. + * + * @param {string} tensorboardRunName + * A fully-qualified path representing TensorboardRun resource. + * @returns {string} A string representing the project. + */ + matchProjectFromTensorboardRunName(tensorboardRunName: string) { + return this.pathTemplates.tensorboardRunPathTemplate.match( + tensorboardRunName + ).project; + } + + /** + * Parse the location from TensorboardRun resource. + * + * @param {string} tensorboardRunName + * A fully-qualified path representing TensorboardRun resource. + * @returns {string} A string representing the location. + */ + matchLocationFromTensorboardRunName(tensorboardRunName: string) { + return this.pathTemplates.tensorboardRunPathTemplate.match( + tensorboardRunName + ).location; + } + + /** + * Parse the tensorboard from TensorboardRun resource. + * + * @param {string} tensorboardRunName + * A fully-qualified path representing TensorboardRun resource. + * @returns {string} A string representing the tensorboard. + */ + matchTensorboardFromTensorboardRunName(tensorboardRunName: string) { + return this.pathTemplates.tensorboardRunPathTemplate.match( + tensorboardRunName + ).tensorboard; + } + + /** + * Parse the experiment from TensorboardRun resource. + * + * @param {string} tensorboardRunName + * A fully-qualified path representing TensorboardRun resource. + * @returns {string} A string representing the experiment. + */ + matchExperimentFromTensorboardRunName(tensorboardRunName: string) { + return this.pathTemplates.tensorboardRunPathTemplate.match( + tensorboardRunName + ).experiment; + } + + /** + * Parse the run from TensorboardRun resource. + * + * @param {string} tensorboardRunName + * A fully-qualified path representing TensorboardRun resource. + * @returns {string} A string representing the run. + */ + matchRunFromTensorboardRunName(tensorboardRunName: string) { + return this.pathTemplates.tensorboardRunPathTemplate.match( + tensorboardRunName + ).run; + } + + /** + * Return a fully-qualified tensorboardTimeSeries resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} tensorboard + * @param {string} experiment + * @param {string} run + * @param {string} time_series + * @returns {string} Resource name string. + */ + tensorboardTimeSeriesPath( + project: string, + location: string, + tensorboard: string, + experiment: string, + run: string, + timeSeries: string + ) { + return this.pathTemplates.tensorboardTimeSeriesPathTemplate.render({ + project: project, + location: location, + tensorboard: tensorboard, + experiment: experiment, + run: run, + time_series: timeSeries, + }); + } + + /** + * Parse the project from TensorboardTimeSeries resource. + * + * @param {string} tensorboardTimeSeriesName + * A fully-qualified path representing TensorboardTimeSeries resource. + * @returns {string} A string representing the project. + */ + matchProjectFromTensorboardTimeSeriesName(tensorboardTimeSeriesName: string) { + return this.pathTemplates.tensorboardTimeSeriesPathTemplate.match( + tensorboardTimeSeriesName + ).project; + } + + /** + * Parse the location from TensorboardTimeSeries resource. + * + * @param {string} tensorboardTimeSeriesName + * A fully-qualified path representing TensorboardTimeSeries resource. + * @returns {string} A string representing the location. + */ + matchLocationFromTensorboardTimeSeriesName( + tensorboardTimeSeriesName: string + ) { + return this.pathTemplates.tensorboardTimeSeriesPathTemplate.match( + tensorboardTimeSeriesName + ).location; + } + + /** + * Parse the tensorboard from TensorboardTimeSeries resource. + * + * @param {string} tensorboardTimeSeriesName + * A fully-qualified path representing TensorboardTimeSeries resource. + * @returns {string} A string representing the tensorboard. + */ + matchTensorboardFromTensorboardTimeSeriesName( + tensorboardTimeSeriesName: string + ) { + return this.pathTemplates.tensorboardTimeSeriesPathTemplate.match( + tensorboardTimeSeriesName + ).tensorboard; + } + + /** + * Parse the experiment from TensorboardTimeSeries resource. + * + * @param {string} tensorboardTimeSeriesName + * A fully-qualified path representing TensorboardTimeSeries resource. + * @returns {string} A string representing the experiment. + */ + matchExperimentFromTensorboardTimeSeriesName( + tensorboardTimeSeriesName: string + ) { + return this.pathTemplates.tensorboardTimeSeriesPathTemplate.match( + tensorboardTimeSeriesName + ).experiment; + } + + /** + * Parse the run from TensorboardTimeSeries resource. + * + * @param {string} tensorboardTimeSeriesName + * A fully-qualified path representing TensorboardTimeSeries resource. + * @returns {string} A string representing the run. + */ + matchRunFromTensorboardTimeSeriesName(tensorboardTimeSeriesName: string) { + return this.pathTemplates.tensorboardTimeSeriesPathTemplate.match( + tensorboardTimeSeriesName + ).run; + } + + /** + * Parse the time_series from TensorboardTimeSeries resource. + * + * @param {string} tensorboardTimeSeriesName + * A fully-qualified path representing TensorboardTimeSeries resource. + * @returns {string} A string representing the time_series. + */ + matchTimeSeriesFromTensorboardTimeSeriesName( + tensorboardTimeSeriesName: string + ) { + return this.pathTemplates.tensorboardTimeSeriesPathTemplate.match( + tensorboardTimeSeriesName + ).time_series; + } + + /** + * Return a fully-qualified trainingPipeline resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} training_pipeline + * @returns {string} Resource name string. + */ + trainingPipelinePath( + project: string, + location: string, + trainingPipeline: string + ) { + return this.pathTemplates.trainingPipelinePathTemplate.render({ + project: project, + location: location, + training_pipeline: trainingPipeline, + }); + } + + /** + * Parse the project from TrainingPipeline resource. + * + * @param {string} trainingPipelineName + * A fully-qualified path representing TrainingPipeline resource. + * @returns {string} A string representing the project. + */ + matchProjectFromTrainingPipelineName(trainingPipelineName: string) { + return this.pathTemplates.trainingPipelinePathTemplate.match( + trainingPipelineName + ).project; + } + + /** + * Parse the location from TrainingPipeline resource. + * + * @param {string} trainingPipelineName + * A fully-qualified path representing TrainingPipeline resource. + * @returns {string} A string representing the location. + */ + matchLocationFromTrainingPipelineName(trainingPipelineName: string) { + return this.pathTemplates.trainingPipelinePathTemplate.match( + trainingPipelineName + ).location; + } + + /** + * Parse the training_pipeline from TrainingPipeline resource. + * + * @param {string} trainingPipelineName + * A fully-qualified path representing TrainingPipeline resource. + * @returns {string} A string representing the training_pipeline. + */ + matchTrainingPipelineFromTrainingPipelineName(trainingPipelineName: string) { + return this.pathTemplates.trainingPipelinePathTemplate.match( + trainingPipelineName + ).training_pipeline; + } + + /** + * Return a fully-qualified trial resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} study + * @param {string} trial + * @returns {string} Resource name string. + */ + trialPath(project: string, location: string, study: string, trial: string) { + return this.pathTemplates.trialPathTemplate.render({ + project: project, + location: location, + study: study, + trial: trial, + }); + } + + /** + * Parse the project from Trial resource. + * + * @param {string} trialName + * A fully-qualified path representing Trial resource. + * @returns {string} A string representing the project. + */ + matchProjectFromTrialName(trialName: string) { + return this.pathTemplates.trialPathTemplate.match(trialName).project; + } + + /** + * Parse the location from Trial resource. + * + * @param {string} trialName + * A fully-qualified path representing Trial resource. + * @returns {string} A string representing the location. + */ + matchLocationFromTrialName(trialName: string) { + return this.pathTemplates.trialPathTemplate.match(trialName).location; + } + + /** + * Parse the study from Trial resource. + * + * @param {string} trialName + * A fully-qualified path representing Trial resource. + * @returns {string} A string representing the study. + */ + matchStudyFromTrialName(trialName: string) { + return this.pathTemplates.trialPathTemplate.match(trialName).study; + } + + /** + * Parse the trial from Trial resource. + * + * @param {string} trialName + * A fully-qualified path representing Trial resource. + * @returns {string} A string representing the trial. + */ + matchTrialFromTrialName(trialName: string) { + return this.pathTemplates.trialPathTemplate.match(trialName).trial; + } + + /** + * Terminate the gRPC channel and close the client. + * + * The client will no longer be usable and all future behavior is undefined. + * @returns {Promise} A promise that resolves when the client is closed. + */ + close(): Promise { + if (this.scheduleServiceStub && !this._terminated) { + return this.scheduleServiceStub.then(stub => { + this._terminated = true; + stub.close(); + this.iamClient.close(); + this.locationsClient.close(); + this.operationsClient.close(); + }); + } + return Promise.resolve(); + } +} diff --git a/packages/google-cloud-aiplatform/src/v1/schedule_service_client_config.json b/packages/google-cloud-aiplatform/src/v1/schedule_service_client_config.json new file mode 100644 index 00000000000..b219436e4b7 --- /dev/null +++ b/packages/google-cloud-aiplatform/src/v1/schedule_service_client_config.json @@ -0,0 +1,54 @@ +{ + "interfaces": { + "google.cloud.aiplatform.v1.ScheduleService": { + "retry_codes": { + "non_idempotent": [], + "idempotent": [ + "DEADLINE_EXCEEDED", + "UNAVAILABLE" + ] + }, + "retry_params": { + "default": { + "initial_retry_delay_millis": 100, + "retry_delay_multiplier": 1.3, + "max_retry_delay_millis": 60000, + "initial_rpc_timeout_millis": 60000, + "rpc_timeout_multiplier": 1, + "max_rpc_timeout_millis": 60000, + "total_timeout_millis": 600000 + } + }, + "methods": { + "CreateSchedule": { + "retry_codes_name": "non_idempotent", + "retry_params_name": "default" + }, + "DeleteSchedule": { + "retry_codes_name": "non_idempotent", + "retry_params_name": "default" + }, + "GetSchedule": { + "retry_codes_name": "non_idempotent", + "retry_params_name": "default" + }, + "ListSchedules": { + "retry_codes_name": "non_idempotent", + "retry_params_name": "default" + }, + "PauseSchedule": { + "retry_codes_name": "non_idempotent", + "retry_params_name": "default" + }, + "ResumeSchedule": { + "retry_codes_name": "non_idempotent", + "retry_params_name": "default" + }, + "UpdateSchedule": { + "retry_codes_name": "non_idempotent", + "retry_params_name": "default" + } + } + } + } +} diff --git a/packages/google-cloud-aiplatform/src/v1/schedule_service_proto_list.json b/packages/google-cloud-aiplatform/src/v1/schedule_service_proto_list.json new file mode 100644 index 00000000000..2d74caf069f --- /dev/null +++ b/packages/google-cloud-aiplatform/src/v1/schedule_service_proto_list.json @@ -0,0 +1,120 @@ +[ + "../../protos/google/cloud/aiplatform/v1/accelerator_type.proto", + "../../protos/google/cloud/aiplatform/v1/annotation.proto", + "../../protos/google/cloud/aiplatform/v1/annotation_spec.proto", + "../../protos/google/cloud/aiplatform/v1/artifact.proto", + "../../protos/google/cloud/aiplatform/v1/batch_prediction_job.proto", + "../../protos/google/cloud/aiplatform/v1/completion_stats.proto", + "../../protos/google/cloud/aiplatform/v1/context.proto", + "../../protos/google/cloud/aiplatform/v1/custom_job.proto", + "../../protos/google/cloud/aiplatform/v1/data_item.proto", + "../../protos/google/cloud/aiplatform/v1/data_labeling_job.proto", + "../../protos/google/cloud/aiplatform/v1/dataset.proto", + "../../protos/google/cloud/aiplatform/v1/dataset_service.proto", + "../../protos/google/cloud/aiplatform/v1/deployed_index_ref.proto", + "../../protos/google/cloud/aiplatform/v1/deployed_model_ref.proto", + "../../protos/google/cloud/aiplatform/v1/encryption_spec.proto", + "../../protos/google/cloud/aiplatform/v1/endpoint.proto", + "../../protos/google/cloud/aiplatform/v1/endpoint_service.proto", + "../../protos/google/cloud/aiplatform/v1/entity_type.proto", + "../../protos/google/cloud/aiplatform/v1/env_var.proto", + "../../protos/google/cloud/aiplatform/v1/evaluated_annotation.proto", + "../../protos/google/cloud/aiplatform/v1/event.proto", + "../../protos/google/cloud/aiplatform/v1/execution.proto", + "../../protos/google/cloud/aiplatform/v1/explanation.proto", + "../../protos/google/cloud/aiplatform/v1/explanation_metadata.proto", + "../../protos/google/cloud/aiplatform/v1/feature.proto", + "../../protos/google/cloud/aiplatform/v1/feature_monitoring_stats.proto", + "../../protos/google/cloud/aiplatform/v1/feature_selector.proto", + "../../protos/google/cloud/aiplatform/v1/featurestore.proto", + "../../protos/google/cloud/aiplatform/v1/featurestore_monitoring.proto", + "../../protos/google/cloud/aiplatform/v1/featurestore_online_service.proto", + "../../protos/google/cloud/aiplatform/v1/featurestore_service.proto", + "../../protos/google/cloud/aiplatform/v1/hyperparameter_tuning_job.proto", + "../../protos/google/cloud/aiplatform/v1/index.proto", + "../../protos/google/cloud/aiplatform/v1/index_endpoint.proto", + "../../protos/google/cloud/aiplatform/v1/index_endpoint_service.proto", + "../../protos/google/cloud/aiplatform/v1/index_service.proto", + "../../protos/google/cloud/aiplatform/v1/io.proto", + "../../protos/google/cloud/aiplatform/v1/job_service.proto", + "../../protos/google/cloud/aiplatform/v1/job_state.proto", + "../../protos/google/cloud/aiplatform/v1/lineage_subgraph.proto", + "../../protos/google/cloud/aiplatform/v1/machine_resources.proto", + "../../protos/google/cloud/aiplatform/v1/manual_batch_tuning_parameters.proto", + "../../protos/google/cloud/aiplatform/v1/match_service.proto", + "../../protos/google/cloud/aiplatform/v1/metadata_schema.proto", + "../../protos/google/cloud/aiplatform/v1/metadata_service.proto", + "../../protos/google/cloud/aiplatform/v1/metadata_store.proto", + "../../protos/google/cloud/aiplatform/v1/migratable_resource.proto", + "../../protos/google/cloud/aiplatform/v1/migration_service.proto", + "../../protos/google/cloud/aiplatform/v1/model.proto", + "../../protos/google/cloud/aiplatform/v1/model_deployment_monitoring_job.proto", + "../../protos/google/cloud/aiplatform/v1/model_evaluation.proto", + "../../protos/google/cloud/aiplatform/v1/model_evaluation_slice.proto", + "../../protos/google/cloud/aiplatform/v1/model_garden_service.proto", + "../../protos/google/cloud/aiplatform/v1/model_monitoring.proto", + "../../protos/google/cloud/aiplatform/v1/model_service.proto", + "../../protos/google/cloud/aiplatform/v1/nas_job.proto", + "../../protos/google/cloud/aiplatform/v1/operation.proto", + "../../protos/google/cloud/aiplatform/v1/pipeline_failure_policy.proto", + "../../protos/google/cloud/aiplatform/v1/pipeline_job.proto", + "../../protos/google/cloud/aiplatform/v1/pipeline_service.proto", + "../../protos/google/cloud/aiplatform/v1/pipeline_state.proto", + "../../protos/google/cloud/aiplatform/v1/prediction_service.proto", + "../../protos/google/cloud/aiplatform/v1/publisher_model.proto", + "../../protos/google/cloud/aiplatform/v1/saved_query.proto", + "../../protos/google/cloud/aiplatform/v1/schedule.proto", + "../../protos/google/cloud/aiplatform/v1/schedule_service.proto", + "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_classification.proto", + "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_object_detection.proto", + "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_segmentation.proto", + "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/text_classification.proto", + "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/text_extraction.proto", + "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/text_sentiment.proto", + "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/video_action_recognition.proto", + "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/video_classification.proto", + "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/video_object_tracking.proto", + "../../protos/google/cloud/aiplatform/v1/schema/predict/params/image_classification.proto", + "../../protos/google/cloud/aiplatform/v1/schema/predict/params/image_object_detection.proto", + "../../protos/google/cloud/aiplatform/v1/schema/predict/params/image_segmentation.proto", + "../../protos/google/cloud/aiplatform/v1/schema/predict/params/video_action_recognition.proto", + "../../protos/google/cloud/aiplatform/v1/schema/predict/params/video_classification.proto", + "../../protos/google/cloud/aiplatform/v1/schema/predict/params/video_object_tracking.proto", + "../../protos/google/cloud/aiplatform/v1/schema/predict/prediction/classification.proto", + "../../protos/google/cloud/aiplatform/v1/schema/predict/prediction/image_object_detection.proto", + "../../protos/google/cloud/aiplatform/v1/schema/predict/prediction/image_segmentation.proto", + "../../protos/google/cloud/aiplatform/v1/schema/predict/prediction/tabular_classification.proto", + "../../protos/google/cloud/aiplatform/v1/schema/predict/prediction/tabular_regression.proto", + "../../protos/google/cloud/aiplatform/v1/schema/predict/prediction/text_extraction.proto", + "../../protos/google/cloud/aiplatform/v1/schema/predict/prediction/text_sentiment.proto", + "../../protos/google/cloud/aiplatform/v1/schema/predict/prediction/video_action_recognition.proto", + "../../protos/google/cloud/aiplatform/v1/schema/predict/prediction/video_classification.proto", + "../../protos/google/cloud/aiplatform/v1/schema/predict/prediction/video_object_tracking.proto", + "../../protos/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_image_classification.proto", + "../../protos/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_image_object_detection.proto", + "../../protos/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_image_segmentation.proto", + "../../protos/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_tables.proto", + "../../protos/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_text_classification.proto", + "../../protos/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_text_extraction.proto", + "../../protos/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_text_sentiment.proto", + "../../protos/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_video_action_recognition.proto", + "../../protos/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_video_classification.proto", + "../../protos/google/cloud/aiplatform/v1/schema/trainingjob/definition/automl_video_object_tracking.proto", + "../../protos/google/cloud/aiplatform/v1/schema/trainingjob/definition/export_evaluated_data_items_config.proto", + "../../protos/google/cloud/aiplatform/v1/service_networking.proto", + "../../protos/google/cloud/aiplatform/v1/specialist_pool.proto", + "../../protos/google/cloud/aiplatform/v1/specialist_pool_service.proto", + "../../protos/google/cloud/aiplatform/v1/study.proto", + "../../protos/google/cloud/aiplatform/v1/tensorboard.proto", + "../../protos/google/cloud/aiplatform/v1/tensorboard_data.proto", + "../../protos/google/cloud/aiplatform/v1/tensorboard_experiment.proto", + "../../protos/google/cloud/aiplatform/v1/tensorboard_run.proto", + "../../protos/google/cloud/aiplatform/v1/tensorboard_service.proto", + "../../protos/google/cloud/aiplatform/v1/tensorboard_time_series.proto", + "../../protos/google/cloud/aiplatform/v1/training_pipeline.proto", + "../../protos/google/cloud/aiplatform/v1/types.proto", + "../../protos/google/cloud/aiplatform/v1/unmanaged_container_model.proto", + "../../protos/google/cloud/aiplatform/v1/user_action_reference.proto", + "../../protos/google/cloud/aiplatform/v1/value.proto", + "../../protos/google/cloud/aiplatform/v1/vizier_service.proto" +] diff --git a/packages/google-cloud-aiplatform/src/v1/specialist_pool_service_client.ts b/packages/google-cloud-aiplatform/src/v1/specialist_pool_service_client.ts index 96fea0278f9..6171968544e 100644 --- a/packages/google-cloud-aiplatform/src/v1/specialist_pool_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1/specialist_pool_service_client.ts @@ -288,6 +288,9 @@ export class SpecialistPoolServiceClient { savedQueryPathTemplate: new this._gaxModule.PathTemplate( 'projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}' ), + schedulePathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/schedules/{schedule}' + ), specialistPoolPathTemplate: new this._gaxModule.PathTemplate( 'projects/{project}/locations/{location}/specialistPools/{specialist_pool}' ), @@ -1559,9 +1562,8 @@ export class SpecialistPoolServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.SpecialistPool | SpecialistPool}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.SpecialistPool|SpecialistPool}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/specialist_pool_service.get_specialist_pool.js * region_tag:aiplatform_v1_generated_SpecialistPoolService_GetSpecialistPool_async @@ -1657,8 +1659,7 @@ export class SpecialistPoolServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/specialist_pool_service.create_specialist_pool.js * region_tag:aiplatform_v1_generated_SpecialistPoolService_CreateSpecialistPool_async @@ -1753,8 +1754,7 @@ export class SpecialistPoolServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/specialist_pool_service.create_specialist_pool.js * region_tag:aiplatform_v1_generated_SpecialistPoolService_CreateSpecialistPool_async @@ -1800,8 +1800,7 @@ export class SpecialistPoolServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/specialist_pool_service.delete_specialist_pool.js * region_tag:aiplatform_v1_generated_SpecialistPoolService_DeleteSpecialistPool_async @@ -1896,8 +1895,7 @@ export class SpecialistPoolServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/specialist_pool_service.delete_specialist_pool.js * region_tag:aiplatform_v1_generated_SpecialistPoolService_DeleteSpecialistPool_async @@ -1940,8 +1938,7 @@ export class SpecialistPoolServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/specialist_pool_service.update_specialist_pool.js * region_tag:aiplatform_v1_generated_SpecialistPoolService_UpdateSpecialistPool_async @@ -2036,8 +2033,7 @@ export class SpecialistPoolServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/specialist_pool_service.update_specialist_pool.js * region_tag:aiplatform_v1_generated_SpecialistPoolService_UpdateSpecialistPool_async @@ -2078,23 +2074,22 @@ export class SpecialistPoolServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained by - * {@link google.cloud.aiplatform.v1.ListSpecialistPoolsResponse.next_page_token|ListSpecialistPoolsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1.ListSpecialistPoolsResponse.next_page_token|ListSpecialistPoolsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.SpecialistPoolService.ListSpecialistPools|SpecialistPoolService.ListSpecialistPools} + * {@link protos.google.cloud.aiplatform.v1.SpecialistPoolService.ListSpecialistPools|SpecialistPoolService.ListSpecialistPools} * call. Return first page if empty. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. FieldMask represents a set of * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1.SpecialistPool | SpecialistPool}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.SpecialistPool|SpecialistPool}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listSpecialistPoolsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listSpecialistPools( @@ -2184,22 +2179,21 @@ export class SpecialistPoolServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained by - * {@link google.cloud.aiplatform.v1.ListSpecialistPoolsResponse.next_page_token|ListSpecialistPoolsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1.ListSpecialistPoolsResponse.next_page_token|ListSpecialistPoolsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.SpecialistPoolService.ListSpecialistPools|SpecialistPoolService.ListSpecialistPools} + * {@link protos.google.cloud.aiplatform.v1.SpecialistPoolService.ListSpecialistPools|SpecialistPoolService.ListSpecialistPools} * call. Return first page if empty. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. FieldMask represents a set of * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1.SpecialistPool | SpecialistPool} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.SpecialistPool|SpecialistPool} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listSpecialistPoolsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listSpecialistPoolsStream( @@ -2238,21 +2232,20 @@ export class SpecialistPoolServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained by - * {@link google.cloud.aiplatform.v1.ListSpecialistPoolsResponse.next_page_token|ListSpecialistPoolsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1.ListSpecialistPoolsResponse.next_page_token|ListSpecialistPoolsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1.SpecialistPoolService.ListSpecialistPools|SpecialistPoolService.ListSpecialistPools} + * {@link protos.google.cloud.aiplatform.v1.SpecialistPoolService.ListSpecialistPools|SpecialistPoolService.ListSpecialistPools} * call. Return first page if empty. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. FieldMask represents a set of * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1.SpecialistPool | SpecialistPool}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1.SpecialistPool|SpecialistPool}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/specialist_pool_service.list_specialist_pools.js * region_tag:aiplatform_v1_generated_SpecialistPoolService_ListSpecialistPools_async @@ -2317,7 +2310,7 @@ export class SpecialistPoolServiceClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -2338,8 +2331,7 @@ export class SpecialistPoolServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -2365,7 +2357,7 @@ export class SpecialistPoolServiceClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -2386,8 +2378,7 @@ export class SpecialistPoolServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -2414,7 +2405,7 @@ export class SpecialistPoolServiceClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -2429,8 +2420,7 @@ export class SpecialistPoolServiceClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` @@ -2476,12 +2466,11 @@ export class SpecialistPoolServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` @@ -4586,6 +4575,55 @@ export class SpecialistPoolServiceClient { .saved_query; } + /** + * Return a fully-qualified schedule resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} schedule + * @returns {string} Resource name string. + */ + schedulePath(project: string, location: string, schedule: string) { + return this.pathTemplates.schedulePathTemplate.render({ + project: project, + location: location, + schedule: schedule, + }); + } + + /** + * Parse the project from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the project. + */ + matchProjectFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).project; + } + + /** + * Parse the location from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the location. + */ + matchLocationFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).location; + } + + /** + * Parse the schedule from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the schedule. + */ + matchScheduleFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).schedule; + } + /** * Return a fully-qualified specialistPool resource name string. * diff --git a/packages/google-cloud-aiplatform/src/v1/specialist_pool_service_proto_list.json b/packages/google-cloud-aiplatform/src/v1/specialist_pool_service_proto_list.json index f987b709de8..2d74caf069f 100644 --- a/packages/google-cloud-aiplatform/src/v1/specialist_pool_service_proto_list.json +++ b/packages/google-cloud-aiplatform/src/v1/specialist_pool_service_proto_list.json @@ -63,6 +63,8 @@ "../../protos/google/cloud/aiplatform/v1/prediction_service.proto", "../../protos/google/cloud/aiplatform/v1/publisher_model.proto", "../../protos/google/cloud/aiplatform/v1/saved_query.proto", + "../../protos/google/cloud/aiplatform/v1/schedule.proto", + "../../protos/google/cloud/aiplatform/v1/schedule_service.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_classification.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_object_detection.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_segmentation.proto", diff --git a/packages/google-cloud-aiplatform/src/v1/tensorboard_service_client.ts b/packages/google-cloud-aiplatform/src/v1/tensorboard_service_client.ts index 558a6bb220e..700022293fe 100644 --- a/packages/google-cloud-aiplatform/src/v1/tensorboard_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1/tensorboard_service_client.ts @@ -285,6 +285,9 @@ export class TensorboardServiceClient { savedQueryPathTemplate: new this._gaxModule.PathTemplate( 'projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}' ), + schedulePathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/schedules/{schedule}' + ), specialistPoolPathTemplate: new this._gaxModule.PathTemplate( 'projects/{project}/locations/{location}/specialistPools/{specialist_pool}' ), @@ -1665,9 +1668,8 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.Tensorboard | Tensorboard}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.Tensorboard|Tensorboard}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/tensorboard_service.get_tensorboard.js * region_tag:aiplatform_v1_generated_TensorboardService_GetTensorboard_async @@ -1758,9 +1760,8 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.ReadTensorboardUsageResponse | ReadTensorboardUsageResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.ReadTensorboardUsageResponse|ReadTensorboardUsageResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/tensorboard_service.read_tensorboard_usage.js * region_tag:aiplatform_v1_generated_TensorboardService_ReadTensorboardUsage_async @@ -1861,13 +1862,12 @@ export class TensorboardServiceClient { * final component of the Tensorboard experiment's resource name. * * This value should be 1-128 characters, and valid characters - * are /{@link 0-9|a-z}-/. + * are /{@link protos.0-9|a-z}-/. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.TensorboardExperiment | TensorboardExperiment}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.TensorboardExperiment|TensorboardExperiment}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/tensorboard_service.create_tensorboard_experiment.js * region_tag:aiplatform_v1_generated_TensorboardService_CreateTensorboardExperiment_async @@ -1968,9 +1968,8 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.TensorboardExperiment | TensorboardExperiment}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.TensorboardExperiment|TensorboardExperiment}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/tensorboard_service.get_tensorboard_experiment.js * region_tag:aiplatform_v1_generated_TensorboardService_GetTensorboardExperiment_async @@ -2078,9 +2077,8 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.TensorboardExperiment | TensorboardExperiment}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.TensorboardExperiment|TensorboardExperiment}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/tensorboard_service.update_tensorboard_experiment.js * region_tag:aiplatform_v1_generated_TensorboardService_UpdateTensorboardExperiment_async @@ -2186,13 +2184,12 @@ export class TensorboardServiceClient { * component of the Tensorboard run's resource name. * * This value should be 1-128 characters, and valid characters - * are /{@link 0-9|a-z}-/. + * are /{@link protos.0-9|a-z}-/. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.TensorboardRun | TensorboardRun}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.TensorboardRun|TensorboardRun}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/tensorboard_service.create_tensorboard_run.js * region_tag:aiplatform_v1_generated_TensorboardService_CreateTensorboardRun_async @@ -2294,9 +2291,8 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.BatchCreateTensorboardRunsResponse | BatchCreateTensorboardRunsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.BatchCreateTensorboardRunsResponse|BatchCreateTensorboardRunsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/tensorboard_service.batch_create_tensorboard_runs.js * region_tag:aiplatform_v1_generated_TensorboardService_BatchCreateTensorboardRuns_async @@ -2397,9 +2393,8 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.TensorboardRun | TensorboardRun}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.TensorboardRun|TensorboardRun}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/tensorboard_service.get_tensorboard_run.js * region_tag:aiplatform_v1_generated_TensorboardService_GetTensorboardRun_async @@ -2497,9 +2492,8 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.TensorboardRun | TensorboardRun}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.TensorboardRun|TensorboardRun}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/tensorboard_service.update_tensorboard_run.js * region_tag:aiplatform_v1_generated_TensorboardService_UpdateTensorboardRun_async @@ -2603,9 +2597,8 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.BatchCreateTensorboardTimeSeriesResponse | BatchCreateTensorboardTimeSeriesResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.BatchCreateTensorboardTimeSeriesResponse|BatchCreateTensorboardTimeSeriesResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/tensorboard_service.batch_create_tensorboard_time_series.js * region_tag:aiplatform_v1_generated_TensorboardService_BatchCreateTensorboardTimeSeries_async @@ -2708,15 +2701,14 @@ export class TensorboardServiceClient { * Optional. The user specified unique ID to use for the * TensorboardTimeSeries, which becomes the final component of the * TensorboardTimeSeries's resource name. This value should match - * "{@link a-z0-9-|a-z0-9}{0, 127}" + * "{@link protos.a-z0-9-|a-z0-9}{0, 127}" * @param {google.cloud.aiplatform.v1.TensorboardTimeSeries} request.tensorboardTimeSeries * Required. The TensorboardTimeSeries to create. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.TensorboardTimeSeries | TensorboardTimeSeries}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.TensorboardTimeSeries|TensorboardTimeSeries}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/tensorboard_service.create_tensorboard_time_series.js * region_tag:aiplatform_v1_generated_TensorboardService_CreateTensorboardTimeSeries_async @@ -2817,9 +2809,8 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.TensorboardTimeSeries | TensorboardTimeSeries}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.TensorboardTimeSeries|TensorboardTimeSeries}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/tensorboard_service.get_tensorboard_time_series.js * region_tag:aiplatform_v1_generated_TensorboardService_GetTensorboardTimeSeries_async @@ -2928,9 +2919,8 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.TensorboardTimeSeries | TensorboardTimeSeries}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.TensorboardTimeSeries|TensorboardTimeSeries}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/tensorboard_service.update_tensorboard_time_series.js * region_tag:aiplatform_v1_generated_TensorboardService_UpdateTensorboardTimeSeries_async @@ -3034,7 +3024,7 @@ export class TensorboardServiceClient { * TensorboardTimeSeries to read data from. Format: * `projects/{project}/locations/{location}/tensorboards/{tensorboard}`. * The TensorboardTimeSeries referenced by - * {@link google.cloud.aiplatform.v1.BatchReadTensorboardTimeSeriesDataRequest.time_series|time_series} + * {@link protos.google.cloud.aiplatform.v1.BatchReadTensorboardTimeSeriesDataRequest.time_series|time_series} * must be sub resources of this Tensorboard. * @param {string[]} request.timeSeries * Required. The resource names of the TensorboardTimeSeries to read data @@ -3043,9 +3033,8 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.BatchReadTensorboardTimeSeriesDataResponse | BatchReadTensorboardTimeSeriesDataResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.BatchReadTensorboardTimeSeriesDataResponse|BatchReadTensorboardTimeSeriesDataResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/tensorboard_service.batch_read_tensorboard_time_series_data.js * region_tag:aiplatform_v1_generated_TensorboardService_BatchReadTensorboardTimeSeriesData_async @@ -3157,9 +3146,8 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.ReadTensorboardTimeSeriesDataResponse | ReadTensorboardTimeSeriesDataResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.ReadTensorboardTimeSeriesDataResponse|ReadTensorboardTimeSeriesDataResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/tensorboard_service.read_tensorboard_time_series_data.js * region_tag:aiplatform_v1_generated_TensorboardService_ReadTensorboardTimeSeriesData_async @@ -3263,9 +3251,8 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.WriteTensorboardExperimentDataResponse | WriteTensorboardExperimentDataResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.WriteTensorboardExperimentDataResponse|WriteTensorboardExperimentDataResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/tensorboard_service.write_tensorboard_experiment_data.js * region_tag:aiplatform_v1_generated_TensorboardService_WriteTensorboardExperimentData_async @@ -3373,9 +3360,8 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.WriteTensorboardRunDataResponse | WriteTensorboardRunDataResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.WriteTensorboardRunDataResponse|WriteTensorboardRunDataResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/tensorboard_service.write_tensorboard_run_data.js * region_tag:aiplatform_v1_generated_TensorboardService_WriteTensorboardRunData_async @@ -3482,9 +3468,8 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits {@link google.cloud.aiplatform.v1.ReadTensorboardBlobDataResponse | ReadTensorboardBlobDataResponse} on 'data' event. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#server-streaming) + * An object stream which emits {@link protos.google.cloud.aiplatform.v1.ReadTensorboardBlobDataResponse|ReadTensorboardBlobDataResponse} on 'data' event. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#server-streaming | documentation } * for more details and examples. * @example include:samples/generated/v1/tensorboard_service.read_tensorboard_blob_data.js * region_tag:aiplatform_v1_generated_TensorboardService_ReadTensorboardBlobData_async @@ -3521,8 +3506,7 @@ export class TensorboardServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/tensorboard_service.create_tensorboard.js * region_tag:aiplatform_v1_generated_TensorboardService_CreateTensorboard_async @@ -3617,8 +3601,7 @@ export class TensorboardServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/tensorboard_service.create_tensorboard.js * region_tag:aiplatform_v1_generated_TensorboardService_CreateTensorboard_async @@ -3668,8 +3651,7 @@ export class TensorboardServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/tensorboard_service.update_tensorboard.js * region_tag:aiplatform_v1_generated_TensorboardService_UpdateTensorboard_async @@ -3764,8 +3746,7 @@ export class TensorboardServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/tensorboard_service.update_tensorboard.js * region_tag:aiplatform_v1_generated_TensorboardService_UpdateTensorboard_async @@ -3808,8 +3789,7 @@ export class TensorboardServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/tensorboard_service.delete_tensorboard.js * region_tag:aiplatform_v1_generated_TensorboardService_DeleteTensorboard_async @@ -3904,8 +3884,7 @@ export class TensorboardServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/tensorboard_service.delete_tensorboard.js * region_tag:aiplatform_v1_generated_TensorboardService_DeleteTensorboard_async @@ -3948,8 +3927,7 @@ export class TensorboardServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/tensorboard_service.delete_tensorboard_experiment.js * region_tag:aiplatform_v1_generated_TensorboardService_DeleteTensorboardExperiment_async @@ -4048,8 +4026,7 @@ export class TensorboardServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/tensorboard_service.delete_tensorboard_experiment.js * region_tag:aiplatform_v1_generated_TensorboardService_DeleteTensorboardExperiment_async @@ -4092,8 +4069,7 @@ export class TensorboardServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/tensorboard_service.delete_tensorboard_run.js * region_tag:aiplatform_v1_generated_TensorboardService_DeleteTensorboardRun_async @@ -4188,8 +4164,7 @@ export class TensorboardServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/tensorboard_service.delete_tensorboard_run.js * region_tag:aiplatform_v1_generated_TensorboardService_DeleteTensorboardRun_async @@ -4232,8 +4207,7 @@ export class TensorboardServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/tensorboard_service.delete_tensorboard_time_series.js * region_tag:aiplatform_v1_generated_TensorboardService_DeleteTensorboardTimeSeries_async @@ -4332,8 +4306,7 @@ export class TensorboardServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/tensorboard_service.delete_tensorboard_time_series.js * region_tag:aiplatform_v1_generated_TensorboardService_DeleteTensorboardTimeSeries_async @@ -4379,11 +4352,11 @@ export class TensorboardServiceClient { * 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} + * {@link protos.google.cloud.aiplatform.v1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} + * {@link protos.google.cloud.aiplatform.v1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. @@ -4392,14 +4365,13 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1.Tensorboard | Tensorboard}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.Tensorboard|Tensorboard}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listTensorboardsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listTensorboards( @@ -4494,11 +4466,11 @@ export class TensorboardServiceClient { * 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} + * {@link protos.google.cloud.aiplatform.v1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} + * {@link protos.google.cloud.aiplatform.v1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. @@ -4507,13 +4479,12 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1.Tensorboard | Tensorboard} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.Tensorboard|Tensorboard} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listTensorboardsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listTensorboardsStream( @@ -4557,11 +4528,11 @@ export class TensorboardServiceClient { * 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} + * {@link protos.google.cloud.aiplatform.v1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} + * {@link protos.google.cloud.aiplatform.v1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. @@ -4570,12 +4541,11 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1.Tensorboard | Tensorboard}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1.Tensorboard|Tensorboard}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/tensorboard_service.list_tensorboards.js * region_tag:aiplatform_v1_generated_TensorboardService_ListTensorboards_async @@ -4619,11 +4589,11 @@ export class TensorboardServiceClient { * above 1000 are coerced to 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} + * {@link protos.google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} + * {@link protos.google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. @@ -4632,14 +4602,13 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1.TensorboardExperiment | TensorboardExperiment}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.TensorboardExperiment|TensorboardExperiment}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listTensorboardExperimentsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listTensorboardExperiments( @@ -4738,11 +4707,11 @@ export class TensorboardServiceClient { * above 1000 are coerced to 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} + * {@link protos.google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} + * {@link protos.google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. @@ -4751,13 +4720,12 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1.TensorboardExperiment | TensorboardExperiment} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.TensorboardExperiment|TensorboardExperiment} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listTensorboardExperimentsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listTensorboardExperimentsStream( @@ -4801,11 +4769,11 @@ export class TensorboardServiceClient { * above 1000 are coerced to 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} + * {@link protos.google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} + * {@link protos.google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. @@ -4814,12 +4782,11 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1.TensorboardExperiment | TensorboardExperiment}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1.TensorboardExperiment|TensorboardExperiment}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/tensorboard_service.list_tensorboard_experiments.js * region_tag:aiplatform_v1_generated_TensorboardService_ListTensorboardExperiments_async @@ -4863,11 +4830,11 @@ export class TensorboardServiceClient { * 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} + * {@link protos.google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} + * {@link protos.google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. @@ -4876,14 +4843,13 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1.TensorboardRun | TensorboardRun}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.TensorboardRun|TensorboardRun}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listTensorboardRunsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listTensorboardRuns( @@ -4978,11 +4944,11 @@ export class TensorboardServiceClient { * 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} + * {@link protos.google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} + * {@link protos.google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. @@ -4991,13 +4957,12 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1.TensorboardRun | TensorboardRun} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.TensorboardRun|TensorboardRun} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listTensorboardRunsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listTensorboardRunsStream( @@ -5041,11 +5006,11 @@ export class TensorboardServiceClient { * 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} + * {@link protos.google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} + * {@link protos.google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. @@ -5054,12 +5019,11 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1.TensorboardRun | TensorboardRun}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1.TensorboardRun|TensorboardRun}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/tensorboard_service.list_tensorboard_runs.js * region_tag:aiplatform_v1_generated_TensorboardService_ListTensorboardRuns_async @@ -5103,11 +5067,11 @@ export class TensorboardServiceClient { * above 1000 are coerced to 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} + * {@link protos.google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} + * {@link protos.google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. @@ -5116,14 +5080,13 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1.TensorboardTimeSeries | TensorboardTimeSeries}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.TensorboardTimeSeries|TensorboardTimeSeries}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listTensorboardTimeSeriesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listTensorboardTimeSeries( @@ -5222,11 +5185,11 @@ export class TensorboardServiceClient { * above 1000 are coerced to 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} + * {@link protos.google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} + * {@link protos.google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. @@ -5235,13 +5198,12 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1.TensorboardTimeSeries | TensorboardTimeSeries} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.TensorboardTimeSeries|TensorboardTimeSeries} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listTensorboardTimeSeriesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listTensorboardTimeSeriesStream( @@ -5285,11 +5247,11 @@ export class TensorboardServiceClient { * above 1000 are coerced to 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} + * {@link protos.google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} + * {@link protos.google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. @@ -5298,12 +5260,11 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1.TensorboardTimeSeries | TensorboardTimeSeries}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1.TensorboardTimeSeries|TensorboardTimeSeries}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/tensorboard_service.list_tensorboard_time_series.js * region_tag:aiplatform_v1_generated_TensorboardService_ListTensorboardTimeSeries_async @@ -5347,11 +5308,11 @@ export class TensorboardServiceClient { * Values above 10000 are coerced to 10000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.TensorboardService.ExportTensorboardTimeSeriesData|ExportTensorboardTimeSeriesData} + * {@link protos.google.cloud.aiplatform.v1.TensorboardService.ExportTensorboardTimeSeriesData|ExportTensorboardTimeSeriesData} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.TensorboardService.ExportTensorboardTimeSeriesData|ExportTensorboardTimeSeriesData} + * {@link protos.google.cloud.aiplatform.v1.TensorboardService.ExportTensorboardTimeSeriesData|ExportTensorboardTimeSeriesData} * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the TensorboardTimeSeries' data. @@ -5360,14 +5321,13 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1.TimeSeriesDataPoint | TimeSeriesDataPoint}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.TimeSeriesDataPoint|TimeSeriesDataPoint}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `exportTensorboardTimeSeriesDataAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ exportTensorboardTimeSeriesData( @@ -5465,11 +5425,11 @@ export class TensorboardServiceClient { * Values above 10000 are coerced to 10000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.TensorboardService.ExportTensorboardTimeSeriesData|ExportTensorboardTimeSeriesData} + * {@link protos.google.cloud.aiplatform.v1.TensorboardService.ExportTensorboardTimeSeriesData|ExportTensorboardTimeSeriesData} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.TensorboardService.ExportTensorboardTimeSeriesData|ExportTensorboardTimeSeriesData} + * {@link protos.google.cloud.aiplatform.v1.TensorboardService.ExportTensorboardTimeSeriesData|ExportTensorboardTimeSeriesData} * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the TensorboardTimeSeries' data. @@ -5478,13 +5438,12 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1.TimeSeriesDataPoint | TimeSeriesDataPoint} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.TimeSeriesDataPoint|TimeSeriesDataPoint} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `exportTensorboardTimeSeriesDataAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ exportTensorboardTimeSeriesDataStream( @@ -5528,11 +5487,11 @@ export class TensorboardServiceClient { * Values above 10000 are coerced to 10000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.TensorboardService.ExportTensorboardTimeSeriesData|ExportTensorboardTimeSeriesData} + * {@link protos.google.cloud.aiplatform.v1.TensorboardService.ExportTensorboardTimeSeriesData|ExportTensorboardTimeSeriesData} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.TensorboardService.ExportTensorboardTimeSeriesData|ExportTensorboardTimeSeriesData} + * {@link protos.google.cloud.aiplatform.v1.TensorboardService.ExportTensorboardTimeSeriesData|ExportTensorboardTimeSeriesData} * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the TensorboardTimeSeries' data. @@ -5541,12 +5500,11 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1.TimeSeriesDataPoint | TimeSeriesDataPoint}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1.TimeSeriesDataPoint|TimeSeriesDataPoint}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/tensorboard_service.export_tensorboard_time_series_data.js * region_tag:aiplatform_v1_generated_TensorboardService_ExportTensorboardTimeSeriesData_async @@ -5612,7 +5570,7 @@ export class TensorboardServiceClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -5633,8 +5591,7 @@ export class TensorboardServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -5660,7 +5617,7 @@ export class TensorboardServiceClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -5681,8 +5638,7 @@ export class TensorboardServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -5709,7 +5665,7 @@ export class TensorboardServiceClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -5724,8 +5680,7 @@ export class TensorboardServiceClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` @@ -5771,12 +5726,11 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` @@ -7904,6 +7858,55 @@ export class TensorboardServiceClient { .saved_query; } + /** + * Return a fully-qualified schedule resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} schedule + * @returns {string} Resource name string. + */ + schedulePath(project: string, location: string, schedule: string) { + return this.pathTemplates.schedulePathTemplate.render({ + project: project, + location: location, + schedule: schedule, + }); + } + + /** + * Parse the project from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the project. + */ + matchProjectFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).project; + } + + /** + * Parse the location from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the location. + */ + matchLocationFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).location; + } + + /** + * Parse the schedule from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the schedule. + */ + matchScheduleFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).schedule; + } + /** * Return a fully-qualified specialistPool resource name string. * diff --git a/packages/google-cloud-aiplatform/src/v1/tensorboard_service_proto_list.json b/packages/google-cloud-aiplatform/src/v1/tensorboard_service_proto_list.json index f987b709de8..2d74caf069f 100644 --- a/packages/google-cloud-aiplatform/src/v1/tensorboard_service_proto_list.json +++ b/packages/google-cloud-aiplatform/src/v1/tensorboard_service_proto_list.json @@ -63,6 +63,8 @@ "../../protos/google/cloud/aiplatform/v1/prediction_service.proto", "../../protos/google/cloud/aiplatform/v1/publisher_model.proto", "../../protos/google/cloud/aiplatform/v1/saved_query.proto", + "../../protos/google/cloud/aiplatform/v1/schedule.proto", + "../../protos/google/cloud/aiplatform/v1/schedule_service.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_classification.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_object_detection.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_segmentation.proto", diff --git a/packages/google-cloud-aiplatform/src/v1/vizier_service_client.ts b/packages/google-cloud-aiplatform/src/v1/vizier_service_client.ts index 22fb738c0d3..ef35de07907 100644 --- a/packages/google-cloud-aiplatform/src/v1/vizier_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1/vizier_service_client.ts @@ -286,6 +286,9 @@ export class VizierServiceClient { savedQueryPathTemplate: new this._gaxModule.PathTemplate( 'projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}' ), + schedulePathTemplate: new this._gaxModule.PathTemplate( + 'projects/{project}/locations/{location}/schedules/{schedule}' + ), specialistPoolPathTemplate: new this._gaxModule.PathTemplate( 'projects/{project}/locations/{location}/specialistPools/{specialist_pool}' ), @@ -1566,9 +1569,8 @@ export class VizierServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.Study | Study}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.Study|Study}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/vizier_service.create_study.js * region_tag:aiplatform_v1_generated_VizierService_CreateStudy_async @@ -1652,9 +1654,8 @@ export class VizierServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.Study | Study}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.Study|Study}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/vizier_service.get_study.js * region_tag:aiplatform_v1_generated_VizierService_GetStudy_async @@ -1736,9 +1737,8 @@ export class VizierServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.protobuf.Empty | Empty}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/vizier_service.delete_study.js * region_tag:aiplatform_v1_generated_VizierService_DeleteStudy_async @@ -1825,9 +1825,8 @@ export class VizierServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.Study | Study}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.Study|Study}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/vizier_service.lookup_study.js * region_tag:aiplatform_v1_generated_VizierService_LookupStudy_async @@ -1913,9 +1912,8 @@ export class VizierServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.Trial | Trial}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.Trial|Trial}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/vizier_service.create_trial.js * region_tag:aiplatform_v1_generated_VizierService_CreateTrial_async @@ -2000,9 +1998,8 @@ export class VizierServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.Trial | Trial}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.Trial|Trial}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/vizier_service.get_trial.js * region_tag:aiplatform_v1_generated_VizierService_GetTrial_async @@ -2088,9 +2085,8 @@ export class VizierServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.Trial | Trial}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.Trial|Trial}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/vizier_service.add_trial_measurement.js * region_tag:aiplatform_v1_generated_VizierService_AddTrialMeasurement_async @@ -2191,9 +2187,8 @@ export class VizierServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.Trial | Trial}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.Trial|Trial}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/vizier_service.complete_trial.js * region_tag:aiplatform_v1_generated_VizierService_CompleteTrial_async @@ -2284,9 +2279,8 @@ export class VizierServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.protobuf.Empty | Empty}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/vizier_service.delete_trial.js * region_tag:aiplatform_v1_generated_VizierService_DeleteTrial_async @@ -2371,9 +2365,8 @@ export class VizierServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.Trial | Trial}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.Trial|Trial}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/vizier_service.stop_trial.js * region_tag:aiplatform_v1_generated_VizierService_StopTrial_async @@ -2459,9 +2452,8 @@ export class VizierServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1.ListOptimalTrialsResponse | ListOptimalTrialsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1.ListOptimalTrialsResponse|ListOptimalTrialsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/vizier_service.list_optimal_trials.js * region_tag:aiplatform_v1_generated_VizierService_ListOptimalTrials_async @@ -2547,7 +2539,7 @@ export class VizierServiceClient { * operation associated with the generation of Trial suggestions. * When this long-running operation succeeds, it will contain * a - * {@link google.cloud.aiplatform.v1.SuggestTrialsResponse|SuggestTrialsResponse}. + * {@link protos.google.cloud.aiplatform.v1.SuggestTrialsResponse|SuggestTrialsResponse}. * * @param {Object} request * The request object that will be sent. @@ -2568,8 +2560,7 @@ export class VizierServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/vizier_service.suggest_trials.js * region_tag:aiplatform_v1_generated_VizierService_SuggestTrials_async @@ -2664,8 +2655,7 @@ export class VizierServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/vizier_service.suggest_trials.js * region_tag:aiplatform_v1_generated_VizierService_SuggestTrials_async @@ -2697,7 +2687,7 @@ export class VizierServiceClient { * Checks whether a Trial should stop or not. Returns a * long-running operation. When the operation is successful, * it will contain a - * {@link google.cloud.aiplatform.v1.CheckTrialEarlyStoppingStateResponse|CheckTrialEarlyStoppingStateResponse}. + * {@link protos.google.cloud.aiplatform.v1.CheckTrialEarlyStoppingStateResponse|CheckTrialEarlyStoppingStateResponse}. * * @param {Object} request * The request object that will be sent. @@ -2711,8 +2701,7 @@ export class VizierServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/vizier_service.check_trial_early_stopping_state.js * region_tag:aiplatform_v1_generated_VizierService_CheckTrialEarlyStoppingState_async @@ -2811,8 +2800,7 @@ export class VizierServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/vizier_service.check_trial_early_stopping_state.js * region_tag:aiplatform_v1_generated_VizierService_CheckTrialEarlyStoppingState_async @@ -2857,14 +2845,13 @@ export class VizierServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1.Study | Study}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.Study|Study}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listStudiesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStudies( @@ -2952,13 +2939,12 @@ export class VizierServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1.Study | Study} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.Study|Study} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listStudiesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStudiesStream( @@ -3001,12 +2987,11 @@ export class VizierServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1.Study | Study}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1.Study|Study}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/vizier_service.list_studies.js * region_tag:aiplatform_v1_generated_VizierService_ListStudies_async @@ -3049,14 +3034,13 @@ export class VizierServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1.Trial | Trial}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1.Trial|Trial}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listTrialsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listTrials( @@ -3144,13 +3128,12 @@ export class VizierServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1.Trial | Trial} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1.Trial|Trial} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listTrialsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listTrialsStream( @@ -3193,12 +3176,11 @@ export class VizierServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1.Trial | Trial}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1.Trial|Trial}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/vizier_service.list_trials.js * region_tag:aiplatform_v1_generated_VizierService_ListTrials_async @@ -3263,7 +3245,7 @@ export class VizierServiceClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -3284,8 +3266,7 @@ export class VizierServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -3311,7 +3292,7 @@ export class VizierServiceClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -3332,8 +3313,7 @@ export class VizierServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -3360,7 +3340,7 @@ export class VizierServiceClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -3375,8 +3355,7 @@ export class VizierServiceClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` @@ -3422,12 +3401,11 @@ export class VizierServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` @@ -5532,6 +5510,55 @@ export class VizierServiceClient { .saved_query; } + /** + * Return a fully-qualified schedule resource name string. + * + * @param {string} project + * @param {string} location + * @param {string} schedule + * @returns {string} Resource name string. + */ + schedulePath(project: string, location: string, schedule: string) { + return this.pathTemplates.schedulePathTemplate.render({ + project: project, + location: location, + schedule: schedule, + }); + } + + /** + * Parse the project from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the project. + */ + matchProjectFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).project; + } + + /** + * Parse the location from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the location. + */ + matchLocationFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).location; + } + + /** + * Parse the schedule from Schedule resource. + * + * @param {string} scheduleName + * A fully-qualified path representing Schedule resource. + * @returns {string} A string representing the schedule. + */ + matchScheduleFromScheduleName(scheduleName: string) { + return this.pathTemplates.schedulePathTemplate.match(scheduleName).schedule; + } + /** * Return a fully-qualified specialistPool resource name string. * diff --git a/packages/google-cloud-aiplatform/src/v1/vizier_service_proto_list.json b/packages/google-cloud-aiplatform/src/v1/vizier_service_proto_list.json index f987b709de8..2d74caf069f 100644 --- a/packages/google-cloud-aiplatform/src/v1/vizier_service_proto_list.json +++ b/packages/google-cloud-aiplatform/src/v1/vizier_service_proto_list.json @@ -63,6 +63,8 @@ "../../protos/google/cloud/aiplatform/v1/prediction_service.proto", "../../protos/google/cloud/aiplatform/v1/publisher_model.proto", "../../protos/google/cloud/aiplatform/v1/saved_query.proto", + "../../protos/google/cloud/aiplatform/v1/schedule.proto", + "../../protos/google/cloud/aiplatform/v1/schedule_service.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_classification.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_object_detection.proto", "../../protos/google/cloud/aiplatform/v1/schema/predict/instance/image_segmentation.proto", diff --git a/packages/google-cloud-aiplatform/src/v1beta1/dataset_service_client.ts b/packages/google-cloud-aiplatform/src/v1beta1/dataset_service_client.ts index 424322c6113..0d59a496c42 100644 --- a/packages/google-cloud-aiplatform/src/v1beta1/dataset_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1beta1/dataset_service_client.ts @@ -1758,9 +1758,8 @@ export class DatasetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.Dataset | Dataset}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.Dataset|Dataset}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/dataset_service.get_dataset.js * region_tag:aiplatform_v1beta1_generated_DatasetService_GetDataset_async @@ -1849,7 +1848,7 @@ export class DatasetServiceClient { * @param {google.protobuf.FieldMask} request.updateMask * Required. The update mask applies to the resource. * For the `FieldMask` definition, see - * {@link google.protobuf.FieldMask|google.protobuf.FieldMask}. Updatable fields: + * {@link protos.google.protobuf.FieldMask|google.protobuf.FieldMask}. Updatable fields: * * * `display_name` * * `description` @@ -1857,9 +1856,8 @@ export class DatasetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.Dataset | Dataset}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.Dataset|Dataset}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/dataset_service.update_dataset.js * region_tag:aiplatform_v1beta1_generated_DatasetService_UpdateDataset_async @@ -1952,9 +1950,8 @@ export class DatasetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.AnnotationSpec | AnnotationSpec}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.AnnotationSpec|AnnotationSpec}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/dataset_service.get_annotation_spec.js * region_tag:aiplatform_v1beta1_generated_DatasetService_GetAnnotationSpec_async @@ -2056,8 +2053,7 @@ export class DatasetServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/dataset_service.create_dataset.js * region_tag:aiplatform_v1beta1_generated_DatasetService_CreateDataset_async @@ -2152,8 +2148,7 @@ export class DatasetServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/dataset_service.create_dataset.js * region_tag:aiplatform_v1beta1_generated_DatasetService_CreateDataset_async @@ -2196,8 +2191,7 @@ export class DatasetServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/dataset_service.delete_dataset.js * region_tag:aiplatform_v1beta1_generated_DatasetService_DeleteDataset_async @@ -2292,8 +2286,7 @@ export class DatasetServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/dataset_service.delete_dataset.js * region_tag:aiplatform_v1beta1_generated_DatasetService_DeleteDataset_async @@ -2339,8 +2332,7 @@ export class DatasetServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/dataset_service.import_data.js * region_tag:aiplatform_v1beta1_generated_DatasetService_ImportData_async @@ -2435,8 +2427,7 @@ export class DatasetServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/dataset_service.import_data.js * region_tag:aiplatform_v1beta1_generated_DatasetService_ImportData_async @@ -2481,8 +2472,7 @@ export class DatasetServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/dataset_service.export_data.js * region_tag:aiplatform_v1beta1_generated_DatasetService_ExportData_async @@ -2577,8 +2567,7 @@ export class DatasetServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/dataset_service.export_data.js * region_tag:aiplatform_v1beta1_generated_DatasetService_ExportData_async @@ -2621,8 +2610,7 @@ export class DatasetServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/dataset_service.delete_saved_query.js * region_tag:aiplatform_v1beta1_generated_DatasetService_DeleteSavedQuery_async @@ -2717,8 +2705,7 @@ export class DatasetServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/dataset_service.delete_saved_query.js * region_tag:aiplatform_v1beta1_generated_DatasetService_DeleteSavedQuery_async @@ -2786,14 +2773,13 @@ export class DatasetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1beta1.Dataset | Dataset}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1beta1.Dataset|Dataset}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listDatasetsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listDatasets( @@ -2910,13 +2896,12 @@ export class DatasetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1beta1.Dataset | Dataset} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1beta1.Dataset|Dataset} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listDatasetsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listDatasetsStream( @@ -2982,12 +2967,11 @@ export class DatasetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1beta1.Dataset | Dataset}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1beta1.Dataset|Dataset}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/dataset_service.list_datasets.js * region_tag:aiplatform_v1beta1_generated_DatasetService_ListDatasets_async @@ -3036,14 +3020,13 @@ export class DatasetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1beta1.DataItem | DataItem}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1beta1.DataItem|DataItem}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listDataItemsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listDataItems( @@ -3143,13 +3126,12 @@ export class DatasetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1beta1.DataItem | DataItem} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1beta1.DataItem|DataItem} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listDataItemsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listDataItemsStream( @@ -3198,12 +3180,11 @@ export class DatasetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1beta1.DataItem | DataItem}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1beta1.DataItem|DataItem}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/dataset_service.list_data_items.js * region_tag:aiplatform_v1beta1_generated_DatasetService_ListDataItems_async @@ -3279,7 +3260,7 @@ export class DatasetServiceClient { * belong to. * @param {google.protobuf.FieldMask} request.fieldMask * Mask specifying which fields of - * {@link google.cloud.aiplatform.v1beta1.DataItemView|DataItemView} to read. + * {@link protos.google.cloud.aiplatform.v1beta1.DataItemView|DataItemView} to read. * @param {number} request.annotationsLimit * If set, only up to this many of Annotations will be returned per * DataItemView. The maximum value is 1000. If not set, the maximum value will @@ -3293,21 +3274,20 @@ export class DatasetServiceClient { * @param {string} request.pageToken * A token identifying a page of results for the server to return * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.SearchDataItemsResponse.next_page_token|SearchDataItemsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.SearchDataItemsResponse.next_page_token|SearchDataItemsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.DatasetService.SearchDataItems|DatasetService.SearchDataItems} + * {@link protos.google.cloud.aiplatform.v1beta1.DatasetService.SearchDataItems|DatasetService.SearchDataItems} * call. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1beta1.DataItemView | DataItemView}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1beta1.DataItemView|DataItemView}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `searchDataItemsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ searchDataItems( @@ -3434,7 +3414,7 @@ export class DatasetServiceClient { * belong to. * @param {google.protobuf.FieldMask} request.fieldMask * Mask specifying which fields of - * {@link google.cloud.aiplatform.v1beta1.DataItemView|DataItemView} to read. + * {@link protos.google.cloud.aiplatform.v1beta1.DataItemView|DataItemView} to read. * @param {number} request.annotationsLimit * If set, only up to this many of Annotations will be returned per * DataItemView. The maximum value is 1000. If not set, the maximum value will @@ -3448,20 +3428,19 @@ export class DatasetServiceClient { * @param {string} request.pageToken * A token identifying a page of results for the server to return * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.SearchDataItemsResponse.next_page_token|SearchDataItemsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.SearchDataItemsResponse.next_page_token|SearchDataItemsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.DatasetService.SearchDataItems|DatasetService.SearchDataItems} + * {@link protos.google.cloud.aiplatform.v1beta1.DatasetService.SearchDataItems|DatasetService.SearchDataItems} * call. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1beta1.DataItemView | DataItemView} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1beta1.DataItemView|DataItemView} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `searchDataItemsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ searchDataItemsStream( @@ -3537,7 +3516,7 @@ export class DatasetServiceClient { * belong to. * @param {google.protobuf.FieldMask} request.fieldMask * Mask specifying which fields of - * {@link google.cloud.aiplatform.v1beta1.DataItemView|DataItemView} to read. + * {@link protos.google.cloud.aiplatform.v1beta1.DataItemView|DataItemView} to read. * @param {number} request.annotationsLimit * If set, only up to this many of Annotations will be returned per * DataItemView. The maximum value is 1000. If not set, the maximum value will @@ -3551,19 +3530,18 @@ export class DatasetServiceClient { * @param {string} request.pageToken * A token identifying a page of results for the server to return * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.SearchDataItemsResponse.next_page_token|SearchDataItemsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.SearchDataItemsResponse.next_page_token|SearchDataItemsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.DatasetService.SearchDataItems|DatasetService.SearchDataItems} + * {@link protos.google.cloud.aiplatform.v1beta1.DatasetService.SearchDataItems|DatasetService.SearchDataItems} * call. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1beta1.DataItemView | DataItemView}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1beta1.DataItemView|DataItemView}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/dataset_service.search_data_items.js * region_tag:aiplatform_v1beta1_generated_DatasetService_SearchDataItems_async @@ -3612,14 +3590,13 @@ export class DatasetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1beta1.SavedQuery | SavedQuery}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1beta1.SavedQuery|SavedQuery}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listSavedQueriesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listSavedQueries( @@ -3719,13 +3696,12 @@ export class DatasetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1beta1.SavedQuery | SavedQuery} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1beta1.SavedQuery|SavedQuery} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listSavedQueriesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listSavedQueriesStream( @@ -3774,12 +3750,11 @@ export class DatasetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1beta1.SavedQuery | SavedQuery}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1beta1.SavedQuery|SavedQuery}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/dataset_service.list_saved_queries.js * region_tag:aiplatform_v1beta1_generated_DatasetService_ListSavedQueries_async @@ -3828,14 +3803,13 @@ export class DatasetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1beta1.Annotation | Annotation}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1beta1.Annotation|Annotation}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listAnnotationsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listAnnotations( @@ -3935,13 +3909,12 @@ export class DatasetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1beta1.Annotation | Annotation} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1beta1.Annotation|Annotation} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listAnnotationsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listAnnotationsStream( @@ -3990,12 +3963,11 @@ export class DatasetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1beta1.Annotation | Annotation}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1beta1.Annotation|Annotation}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/dataset_service.list_annotations.js * region_tag:aiplatform_v1beta1_generated_DatasetService_ListAnnotations_async @@ -4060,7 +4032,7 @@ export class DatasetServiceClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -4081,8 +4053,7 @@ export class DatasetServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -4108,7 +4079,7 @@ export class DatasetServiceClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -4129,8 +4100,7 @@ export class DatasetServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -4157,7 +4127,7 @@ export class DatasetServiceClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -4172,8 +4142,7 @@ export class DatasetServiceClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` @@ -4219,12 +4188,11 @@ export class DatasetServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` diff --git a/packages/google-cloud-aiplatform/src/v1beta1/deployment_resource_pool_service_client.ts b/packages/google-cloud-aiplatform/src/v1beta1/deployment_resource_pool_service_client.ts index 46c1b19aa8d..e62349e73d6 100644 --- a/packages/google-cloud-aiplatform/src/v1beta1/deployment_resource_pool_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1beta1/deployment_resource_pool_service_client.ts @@ -1715,9 +1715,8 @@ export class DeploymentResourcePoolServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.DeploymentResourcePool | DeploymentResourcePool}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.DeploymentResourcePool|DeploymentResourcePool}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/deployment_resource_pool_service.get_deployment_resource_pool.js * region_tag:aiplatform_v1beta1_generated_DeploymentResourcePoolService_GetDeploymentResourcePool_async @@ -1830,8 +1829,7 @@ export class DeploymentResourcePoolServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/deployment_resource_pool_service.create_deployment_resource_pool.js * region_tag:aiplatform_v1beta1_generated_DeploymentResourcePoolService_CreateDeploymentResourcePool_async @@ -1930,8 +1928,7 @@ export class DeploymentResourcePoolServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/deployment_resource_pool_service.create_deployment_resource_pool.js * region_tag:aiplatform_v1beta1_generated_DeploymentResourcePoolService_CreateDeploymentResourcePool_async @@ -1974,8 +1971,7 @@ export class DeploymentResourcePoolServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/deployment_resource_pool_service.delete_deployment_resource_pool.js * region_tag:aiplatform_v1beta1_generated_DeploymentResourcePoolService_DeleteDeploymentResourcePool_async @@ -2074,8 +2070,7 @@ export class DeploymentResourcePoolServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/deployment_resource_pool_service.delete_deployment_resource_pool.js * region_tag:aiplatform_v1beta1_generated_DeploymentResourcePoolService_DeleteDeploymentResourcePool_async @@ -2124,14 +2119,13 @@ export class DeploymentResourcePoolServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1beta1.DeploymentResourcePool | DeploymentResourcePool}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1beta1.DeploymentResourcePool|DeploymentResourcePool}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listDeploymentResourcePoolsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listDeploymentResourcePools( @@ -2233,13 +2227,12 @@ export class DeploymentResourcePoolServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1beta1.DeploymentResourcePool | DeploymentResourcePool} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1beta1.DeploymentResourcePool|DeploymentResourcePool} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listDeploymentResourcePoolsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listDeploymentResourcePoolsStream( @@ -2286,12 +2279,11 @@ export class DeploymentResourcePoolServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1beta1.DeploymentResourcePool | DeploymentResourcePool}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1beta1.DeploymentResourcePool|DeploymentResourcePool}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/deployment_resource_pool_service.list_deployment_resource_pools.js * region_tag:aiplatform_v1beta1_generated_DeploymentResourcePoolService_ListDeploymentResourcePools_async @@ -2339,14 +2331,13 @@ export class DeploymentResourcePoolServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1beta1.DeployedModel | DeployedModel}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1beta1.DeployedModel|DeployedModel}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `queryDeployedModelsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ queryDeployedModels( @@ -2445,13 +2436,12 @@ export class DeploymentResourcePoolServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1beta1.DeployedModel | DeployedModel} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1beta1.DeployedModel|DeployedModel} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `queryDeployedModelsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ queryDeployedModelsStream( @@ -2499,12 +2489,11 @@ export class DeploymentResourcePoolServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1beta1.DeployedModel | DeployedModel}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1beta1.DeployedModel|DeployedModel}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/deployment_resource_pool_service.query_deployed_models.js * region_tag:aiplatform_v1beta1_generated_DeploymentResourcePoolService_QueryDeployedModels_async @@ -2569,7 +2558,7 @@ export class DeploymentResourcePoolServiceClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -2590,8 +2579,7 @@ export class DeploymentResourcePoolServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -2617,7 +2605,7 @@ export class DeploymentResourcePoolServiceClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -2638,8 +2626,7 @@ export class DeploymentResourcePoolServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -2666,7 +2653,7 @@ export class DeploymentResourcePoolServiceClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -2681,8 +2668,7 @@ export class DeploymentResourcePoolServiceClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` @@ -2728,12 +2714,11 @@ export class DeploymentResourcePoolServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` diff --git a/packages/google-cloud-aiplatform/src/v1beta1/endpoint_service_client.ts b/packages/google-cloud-aiplatform/src/v1beta1/endpoint_service_client.ts index af7783e3865..56af27b858e 100644 --- a/packages/google-cloud-aiplatform/src/v1beta1/endpoint_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1beta1/endpoint_service_client.ts @@ -1733,9 +1733,8 @@ export class EndpointServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.Endpoint | Endpoint}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.Endpoint|Endpoint}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/endpoint_service.get_endpoint.js * region_tag:aiplatform_v1beta1_generated_EndpointService_GetEndpoint_async @@ -1823,13 +1822,12 @@ export class EndpointServiceClient { * Required. The Endpoint which replaces the resource on the server. * @param {google.protobuf.FieldMask} request.updateMask * Required. The update mask applies to the resource. See - * {@link google.protobuf.FieldMask|google.protobuf.FieldMask}. + * {@link protos.google.protobuf.FieldMask|google.protobuf.FieldMask}. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.Endpoint | Endpoint}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.Endpoint|Endpoint}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/endpoint_service.update_endpoint.js * region_tag:aiplatform_v1beta1_generated_EndpointService_UpdateEndpoint_async @@ -1940,8 +1938,7 @@ export class EndpointServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/endpoint_service.create_endpoint.js * region_tag:aiplatform_v1beta1_generated_EndpointService_CreateEndpoint_async @@ -2036,8 +2033,7 @@ export class EndpointServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/endpoint_service.create_endpoint.js * region_tag:aiplatform_v1beta1_generated_EndpointService_CreateEndpoint_async @@ -2080,8 +2076,7 @@ export class EndpointServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/endpoint_service.delete_endpoint.js * region_tag:aiplatform_v1beta1_generated_EndpointService_DeleteEndpoint_async @@ -2176,8 +2171,7 @@ export class EndpointServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/endpoint_service.delete_endpoint.js * region_tag:aiplatform_v1beta1_generated_EndpointService_DeleteEndpoint_async @@ -2216,23 +2210,23 @@ export class EndpointServiceClient { * `projects/{project}/locations/{location}/endpoints/{endpoint}` * @param {google.cloud.aiplatform.v1beta1.DeployedModel} request.deployedModel * Required. The DeployedModel to be created within the Endpoint. Note that - * {@link google.cloud.aiplatform.v1beta1.Endpoint.traffic_split|Endpoint.traffic_split} + * {@link protos.google.cloud.aiplatform.v1beta1.Endpoint.traffic_split|Endpoint.traffic_split} * must be updated for the DeployedModel to start receiving traffic, either as * part of this call, or via - * {@link google.cloud.aiplatform.v1beta1.EndpointService.UpdateEndpoint|EndpointService.UpdateEndpoint}. + * {@link protos.google.cloud.aiplatform.v1beta1.EndpointService.UpdateEndpoint|EndpointService.UpdateEndpoint}. * @param {number[]} request.trafficSplit * A map from a DeployedModel's ID to the percentage of this Endpoint's * traffic that should be forwarded to that DeployedModel. * * If this field is non-empty, then the Endpoint's - * {@link google.cloud.aiplatform.v1beta1.Endpoint.traffic_split|traffic_split} + * {@link protos.google.cloud.aiplatform.v1beta1.Endpoint.traffic_split|traffic_split} * will be overwritten with it. To refer to the ID of the just being deployed * Model, a "0" should be used, and the actual ID of the new DeployedModel * will be filled in its place by this method. The traffic percentage values * must add up to 100. * * If this field is empty, then the Endpoint's - * {@link google.cloud.aiplatform.v1beta1.Endpoint.traffic_split|traffic_split} is + * {@link protos.google.cloud.aiplatform.v1beta1.Endpoint.traffic_split|traffic_split} is * not updated. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. @@ -2240,8 +2234,7 @@ export class EndpointServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/endpoint_service.deploy_model.js * region_tag:aiplatform_v1beta1_generated_EndpointService_DeployModel_async @@ -2336,8 +2329,7 @@ export class EndpointServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/endpoint_service.deploy_model.js * region_tag:aiplatform_v1beta1_generated_EndpointService_DeployModel_async @@ -2379,7 +2371,7 @@ export class EndpointServiceClient { * Required. The ID of the DeployedModel to be undeployed from the Endpoint. * @param {number[]} request.trafficSplit * If this field is provided, then the Endpoint's - * {@link google.cloud.aiplatform.v1beta1.Endpoint.traffic_split|traffic_split} + * {@link protos.google.cloud.aiplatform.v1beta1.Endpoint.traffic_split|traffic_split} * will be overwritten with it. If last DeployedModel is being undeployed from * the Endpoint, the [Endpoint.traffic_split] will always end up empty when * this call returns. A DeployedModel will be successfully undeployed only if @@ -2391,8 +2383,7 @@ export class EndpointServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/endpoint_service.undeploy_model.js * region_tag:aiplatform_v1beta1_generated_EndpointService_UndeployModel_async @@ -2487,8 +2478,7 @@ export class EndpointServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/endpoint_service.undeploy_model.js * region_tag:aiplatform_v1beta1_generated_EndpointService_UndeployModel_async @@ -2533,25 +2523,24 @@ export class EndpointServiceClient { * following fields can be mutated: * * * `min_replica_count` in either - * {@link google.cloud.aiplatform.v1beta1.DedicatedResources|DedicatedResources} or - * {@link google.cloud.aiplatform.v1beta1.AutomaticResources|AutomaticResources} + * {@link protos.google.cloud.aiplatform.v1beta1.DedicatedResources|DedicatedResources} or + * {@link protos.google.cloud.aiplatform.v1beta1.AutomaticResources|AutomaticResources} * * `max_replica_count` in either - * {@link google.cloud.aiplatform.v1beta1.DedicatedResources|DedicatedResources} or - * {@link google.cloud.aiplatform.v1beta1.AutomaticResources|AutomaticResources} - * * {@link google.cloud.aiplatform.v1beta1.DedicatedResources.autoscaling_metric_specs|autoscaling_metric_specs} + * {@link protos.google.cloud.aiplatform.v1beta1.DedicatedResources|DedicatedResources} or + * {@link protos.google.cloud.aiplatform.v1beta1.AutomaticResources|AutomaticResources} + * * {@link protos.google.cloud.aiplatform.v1beta1.DedicatedResources.autoscaling_metric_specs|autoscaling_metric_specs} * * `disable_container_logging` (v1 only) * * `enable_container_logging` (v1beta1 only) * @param {google.protobuf.FieldMask} request.updateMask * Required. The update mask applies to the resource. See - * {@link google.protobuf.FieldMask|google.protobuf.FieldMask}. + * {@link protos.google.protobuf.FieldMask|google.protobuf.FieldMask}. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/endpoint_service.mutate_deployed_model.js * region_tag:aiplatform_v1beta1_generated_EndpointService_MutateDeployedModel_async @@ -2646,8 +2635,7 @@ export class EndpointServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/endpoint_service.mutate_deployed_model.js * region_tag:aiplatform_v1beta1_generated_EndpointService_MutateDeployedModel_async @@ -2705,23 +2693,22 @@ export class EndpointServiceClient { * @param {string} [request.pageToken] * Optional. The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListEndpointsResponse.next_page_token|ListEndpointsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListEndpointsResponse.next_page_token|ListEndpointsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.EndpointService.ListEndpoints|EndpointService.ListEndpoints} + * {@link protos.google.cloud.aiplatform.v1beta1.EndpointService.ListEndpoints|EndpointService.ListEndpoints} * call. * @param {google.protobuf.FieldMask} [request.readMask] * Optional. Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1beta1.Endpoint | Endpoint}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1beta1.Endpoint|Endpoint}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listEndpointsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listEndpoints( @@ -2828,22 +2815,21 @@ export class EndpointServiceClient { * @param {string} [request.pageToken] * Optional. The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListEndpointsResponse.next_page_token|ListEndpointsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListEndpointsResponse.next_page_token|ListEndpointsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.EndpointService.ListEndpoints|EndpointService.ListEndpoints} + * {@link protos.google.cloud.aiplatform.v1beta1.EndpointService.ListEndpoints|EndpointService.ListEndpoints} * call. * @param {google.protobuf.FieldMask} [request.readMask] * Optional. Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1beta1.Endpoint | Endpoint} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1beta1.Endpoint|Endpoint} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listEndpointsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listEndpointsStream( @@ -2899,21 +2885,20 @@ export class EndpointServiceClient { * @param {string} [request.pageToken] * Optional. The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListEndpointsResponse.next_page_token|ListEndpointsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListEndpointsResponse.next_page_token|ListEndpointsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.EndpointService.ListEndpoints|EndpointService.ListEndpoints} + * {@link protos.google.cloud.aiplatform.v1beta1.EndpointService.ListEndpoints|EndpointService.ListEndpoints} * call. * @param {google.protobuf.FieldMask} [request.readMask] * Optional. Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1beta1.Endpoint | Endpoint}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1beta1.Endpoint|Endpoint}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/endpoint_service.list_endpoints.js * region_tag:aiplatform_v1beta1_generated_EndpointService_ListEndpoints_async @@ -2978,7 +2963,7 @@ export class EndpointServiceClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -2999,8 +2984,7 @@ export class EndpointServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -3026,7 +3010,7 @@ export class EndpointServiceClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -3047,8 +3031,7 @@ export class EndpointServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -3075,7 +3058,7 @@ export class EndpointServiceClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -3090,8 +3073,7 @@ export class EndpointServiceClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` @@ -3137,12 +3119,11 @@ export class EndpointServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` diff --git a/packages/google-cloud-aiplatform/src/v1beta1/featurestore_online_serving_service_client.ts b/packages/google-cloud-aiplatform/src/v1beta1/featurestore_online_serving_service_client.ts index a74921df8f9..63ee0e31373 100644 --- a/packages/google-cloud-aiplatform/src/v1beta1/featurestore_online_serving_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1beta1/featurestore_online_serving_service_client.ts @@ -490,9 +490,8 @@ export class FeaturestoreOnlineServingServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.ReadFeatureValuesResponse | ReadFeatureValuesResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.ReadFeatureValuesResponse|ReadFeatureValuesResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/featurestore_online_serving_service.read_feature_values.js * region_tag:aiplatform_v1beta1_generated_FeaturestoreOnlineServingService_ReadFeatureValues_async @@ -599,9 +598,8 @@ export class FeaturestoreOnlineServingServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.WriteFeatureValuesResponse | WriteFeatureValuesResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.WriteFeatureValuesResponse|WriteFeatureValuesResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/featurestore_online_serving_service.write_feature_values.js * region_tag:aiplatform_v1beta1_generated_FeaturestoreOnlineServingService_WriteFeatureValues_async @@ -711,9 +709,8 @@ export class FeaturestoreOnlineServingServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits {@link google.cloud.aiplatform.v1beta1.ReadFeatureValuesResponse | ReadFeatureValuesResponse} on 'data' event. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#server-streaming) + * An object stream which emits {@link protos.google.cloud.aiplatform.v1beta1.ReadFeatureValuesResponse|ReadFeatureValuesResponse} on 'data' event. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#server-streaming | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/featurestore_online_serving_service.streaming_read_feature_values.js * region_tag:aiplatform_v1beta1_generated_FeaturestoreOnlineServingService_StreamingReadFeatureValues_async @@ -773,7 +770,7 @@ export class FeaturestoreOnlineServingServiceClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -794,8 +791,7 @@ export class FeaturestoreOnlineServingServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -821,7 +817,7 @@ export class FeaturestoreOnlineServingServiceClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -842,8 +838,7 @@ export class FeaturestoreOnlineServingServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -870,7 +865,7 @@ export class FeaturestoreOnlineServingServiceClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -885,8 +880,7 @@ export class FeaturestoreOnlineServingServiceClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` @@ -932,12 +926,11 @@ export class FeaturestoreOnlineServingServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` diff --git a/packages/google-cloud-aiplatform/src/v1beta1/featurestore_service_client.ts b/packages/google-cloud-aiplatform/src/v1beta1/featurestore_service_client.ts index a72afc3fbd1..1e61810a270 100644 --- a/packages/google-cloud-aiplatform/src/v1beta1/featurestore_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1beta1/featurestore_service_client.ts @@ -1844,9 +1844,8 @@ export class FeaturestoreServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.Featurestore | Featurestore}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.Featurestore|Featurestore}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/featurestore_service.get_featurestore.js * region_tag:aiplatform_v1beta1_generated_FeaturestoreService_GetFeaturestore_async @@ -1943,9 +1942,8 @@ export class FeaturestoreServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.EntityType | EntityType}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.EntityType|EntityType}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/featurestore_service.get_entity_type.js * region_tag:aiplatform_v1beta1_generated_FeaturestoreService_GetEntityType_async @@ -2057,9 +2055,8 @@ export class FeaturestoreServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.EntityType | EntityType}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.EntityType|EntityType}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/featurestore_service.update_entity_type.js * region_tag:aiplatform_v1beta1_generated_FeaturestoreService_UpdateEntityType_async @@ -2156,9 +2153,8 @@ export class FeaturestoreServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.Feature | Feature}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.Feature|Feature}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/featurestore_service.get_feature.js * region_tag:aiplatform_v1beta1_generated_FeaturestoreService_GetFeature_async @@ -2264,9 +2260,8 @@ export class FeaturestoreServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.Feature | Feature}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.Feature|Feature}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/featurestore_service.update_feature.js * region_tag:aiplatform_v1beta1_generated_FeaturestoreService_UpdateFeature_async @@ -2371,8 +2366,7 @@ export class FeaturestoreServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/featurestore_service.create_featurestore.js * region_tag:aiplatform_v1beta1_generated_FeaturestoreService_CreateFeaturestore_async @@ -2467,8 +2461,7 @@ export class FeaturestoreServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/featurestore_service.create_featurestore.js * region_tag:aiplatform_v1beta1_generated_FeaturestoreService_CreateFeaturestore_async @@ -2526,8 +2519,7 @@ export class FeaturestoreServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/featurestore_service.update_featurestore.js * region_tag:aiplatform_v1beta1_generated_FeaturestoreService_UpdateFeaturestore_async @@ -2622,8 +2614,7 @@ export class FeaturestoreServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/featurestore_service.update_featurestore.js * region_tag:aiplatform_v1beta1_generated_FeaturestoreService_UpdateFeaturestore_async @@ -2671,8 +2662,7 @@ export class FeaturestoreServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/featurestore_service.delete_featurestore.js * region_tag:aiplatform_v1beta1_generated_FeaturestoreService_DeleteFeaturestore_async @@ -2767,8 +2757,7 @@ export class FeaturestoreServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/featurestore_service.delete_featurestore.js * region_tag:aiplatform_v1beta1_generated_FeaturestoreService_DeleteFeaturestore_async @@ -2821,8 +2810,7 @@ export class FeaturestoreServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/featurestore_service.create_entity_type.js * region_tag:aiplatform_v1beta1_generated_FeaturestoreService_CreateEntityType_async @@ -2917,8 +2905,7 @@ export class FeaturestoreServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/featurestore_service.create_entity_type.js * region_tag:aiplatform_v1beta1_generated_FeaturestoreService_CreateEntityType_async @@ -2965,8 +2952,7 @@ export class FeaturestoreServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/featurestore_service.delete_entity_type.js * region_tag:aiplatform_v1beta1_generated_FeaturestoreService_DeleteEntityType_async @@ -3061,8 +3047,7 @@ export class FeaturestoreServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/featurestore_service.delete_entity_type.js * region_tag:aiplatform_v1beta1_generated_FeaturestoreService_DeleteEntityType_async @@ -3115,8 +3100,7 @@ export class FeaturestoreServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/featurestore_service.create_feature.js * region_tag:aiplatform_v1beta1_generated_FeaturestoreService_CreateFeature_async @@ -3211,8 +3195,7 @@ export class FeaturestoreServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/featurestore_service.create_feature.js * region_tag:aiplatform_v1beta1_generated_FeaturestoreService_CreateFeature_async @@ -3261,8 +3244,7 @@ export class FeaturestoreServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/featurestore_service.batch_create_features.js * region_tag:aiplatform_v1beta1_generated_FeaturestoreService_BatchCreateFeatures_async @@ -3357,8 +3339,7 @@ export class FeaturestoreServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/featurestore_service.batch_create_features.js * region_tag:aiplatform_v1beta1_generated_FeaturestoreService_BatchCreateFeatures_async @@ -3401,8 +3382,7 @@ export class FeaturestoreServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/featurestore_service.delete_feature.js * region_tag:aiplatform_v1beta1_generated_FeaturestoreService_DeleteFeature_async @@ -3497,8 +3477,7 @@ export class FeaturestoreServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/featurestore_service.delete_feature.js * region_tag:aiplatform_v1beta1_generated_FeaturestoreService_DeleteFeature_async @@ -3589,8 +3568,7 @@ export class FeaturestoreServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/featurestore_service.import_feature_values.js * region_tag:aiplatform_v1beta1_generated_FeaturestoreService_ImportFeatureValues_async @@ -3685,8 +3663,7 @@ export class FeaturestoreServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/featurestore_service.import_feature_values.js * region_tag:aiplatform_v1beta1_generated_FeaturestoreService_ImportFeatureValues_async @@ -3778,8 +3755,7 @@ export class FeaturestoreServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/featurestore_service.batch_read_feature_values.js * region_tag:aiplatform_v1beta1_generated_FeaturestoreService_BatchReadFeatureValues_async @@ -3878,8 +3854,7 @@ export class FeaturestoreServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/featurestore_service.batch_read_feature_values.js * region_tag:aiplatform_v1beta1_generated_FeaturestoreService_BatchReadFeatureValues_async @@ -3934,8 +3909,7 @@ export class FeaturestoreServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/featurestore_service.export_feature_values.js * region_tag:aiplatform_v1beta1_generated_FeaturestoreService_ExportFeatureValues_async @@ -4030,8 +4004,7 @@ export class FeaturestoreServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/featurestore_service.export_feature_values.js * region_tag:aiplatform_v1beta1_generated_FeaturestoreService_ExportFeatureValues_async @@ -4088,8 +4061,7 @@ export class FeaturestoreServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/featurestore_service.delete_feature_values.js * region_tag:aiplatform_v1beta1_generated_FeaturestoreService_DeleteFeatureValues_async @@ -4184,8 +4156,7 @@ export class FeaturestoreServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/featurestore_service.delete_feature_values.js * region_tag:aiplatform_v1beta1_generated_FeaturestoreService_DeleteFeatureValues_async @@ -4249,11 +4220,11 @@ export class FeaturestoreServiceClient { * coerced to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} + * {@link protos.google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} + * {@link protos.google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} * must match the call that provided the page token. * @param {string} request.orderBy * A comma-separated list of fields to order by, sorted in ascending order. @@ -4268,14 +4239,13 @@ export class FeaturestoreServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1beta1.Featurestore | Featurestore}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1beta1.Featurestore|Featurestore}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listFeaturestoresAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listFeaturestores( @@ -4388,11 +4358,11 @@ export class FeaturestoreServiceClient { * coerced to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} + * {@link protos.google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} + * {@link protos.google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} * must match the call that provided the page token. * @param {string} request.orderBy * A comma-separated list of fields to order by, sorted in ascending order. @@ -4407,13 +4377,12 @@ export class FeaturestoreServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1beta1.Featurestore | Featurestore} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1beta1.Featurestore|Featurestore} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listFeaturestoresAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listFeaturestoresStream( @@ -4475,11 +4444,11 @@ export class FeaturestoreServiceClient { * coerced to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} + * {@link protos.google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} + * {@link protos.google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} * must match the call that provided the page token. * @param {string} request.orderBy * A comma-separated list of fields to order by, sorted in ascending order. @@ -4494,12 +4463,11 @@ export class FeaturestoreServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1beta1.Featurestore | Featurestore}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1beta1.Featurestore|Featurestore}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/featurestore_service.list_featurestores.js * region_tag:aiplatform_v1beta1_generated_FeaturestoreService_ListFeaturestores_async @@ -4560,11 +4528,11 @@ export class FeaturestoreServiceClient { * 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} + * {@link protos.google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} + * {@link protos.google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} * must match the call that provided the page token. * @param {string} request.orderBy * A comma-separated list of fields to order by, sorted in ascending order. @@ -4580,14 +4548,13 @@ export class FeaturestoreServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1beta1.EntityType | EntityType}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1beta1.EntityType|EntityType}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listEntityTypesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listEntityTypes( @@ -4699,11 +4666,11 @@ export class FeaturestoreServiceClient { * 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} + * {@link protos.google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} + * {@link protos.google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} * must match the call that provided the page token. * @param {string} request.orderBy * A comma-separated list of fields to order by, sorted in ascending order. @@ -4719,13 +4686,12 @@ export class FeaturestoreServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1beta1.EntityType | EntityType} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1beta1.EntityType|EntityType} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listEntityTypesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listEntityTypesStream( @@ -4786,11 +4752,11 @@ export class FeaturestoreServiceClient { * 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} + * {@link protos.google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} + * {@link protos.google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} * must match the call that provided the page token. * @param {string} request.orderBy * A comma-separated list of fields to order by, sorted in ascending order. @@ -4806,12 +4772,11 @@ export class FeaturestoreServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1beta1.EntityType | EntityType}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1beta1.EntityType|EntityType}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/featurestore_service.list_entity_types.js * region_tag:aiplatform_v1beta1_generated_FeaturestoreService_ListEntityTypes_async @@ -4874,11 +4839,11 @@ export class FeaturestoreServiceClient { * 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} + * {@link protos.google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} + * {@link protos.google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} * must match the call that provided the page token. * @param {string} request.orderBy * A comma-separated list of fields to order by, sorted in ascending order. @@ -4893,22 +4858,21 @@ export class FeaturestoreServiceClient { * Mask specifying which fields to read. * @param {number} request.latestStatsCount * If set, return the most recent - * {@link google.cloud.aiplatform.v1beta1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count} + * {@link protos.google.cloud.aiplatform.v1beta1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count} * of stats for each Feature in response. Valid value is [0, 10]. If number of * stats exists < - * {@link google.cloud.aiplatform.v1beta1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count}, + * {@link protos.google.cloud.aiplatform.v1beta1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count}, * return all existing stats. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1beta1.Feature | Feature}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1beta1.Feature|Feature}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listFeaturesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listFeatures( @@ -5022,11 +4986,11 @@ export class FeaturestoreServiceClient { * 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} + * {@link protos.google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} + * {@link protos.google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} * must match the call that provided the page token. * @param {string} request.orderBy * A comma-separated list of fields to order by, sorted in ascending order. @@ -5041,21 +5005,20 @@ export class FeaturestoreServiceClient { * Mask specifying which fields to read. * @param {number} request.latestStatsCount * If set, return the most recent - * {@link google.cloud.aiplatform.v1beta1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count} + * {@link protos.google.cloud.aiplatform.v1beta1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count} * of stats for each Feature in response. Valid value is [0, 10]. If number of * stats exists < - * {@link google.cloud.aiplatform.v1beta1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count}, + * {@link protos.google.cloud.aiplatform.v1beta1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count}, * return all existing stats. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1beta1.Feature | Feature} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1beta1.Feature|Feature} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listFeaturesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listFeaturesStream( @@ -5118,11 +5081,11 @@ export class FeaturestoreServiceClient { * 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} + * {@link protos.google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} + * {@link protos.google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} * must match the call that provided the page token. * @param {string} request.orderBy * A comma-separated list of fields to order by, sorted in ascending order. @@ -5137,20 +5100,19 @@ export class FeaturestoreServiceClient { * Mask specifying which fields to read. * @param {number} request.latestStatsCount * If set, return the most recent - * {@link google.cloud.aiplatform.v1beta1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count} + * {@link protos.google.cloud.aiplatform.v1beta1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count} * of stats for each Feature in response. Valid value is [0, 10]. If number of * stats exists < - * {@link google.cloud.aiplatform.v1beta1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count}, + * {@link protos.google.cloud.aiplatform.v1beta1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count}, * return all existing stats. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1beta1.Feature | Feature}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1beta1.Feature|Feature}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/featurestore_service.list_features.js * region_tag:aiplatform_v1beta1_generated_FeaturestoreService_ListFeatures_async @@ -5253,23 +5215,22 @@ export class FeaturestoreServiceClient { * 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures} + * {@link protos.google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures}, + * {@link protos.google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures}, * except `page_size`, must match the call that provided the page token. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1beta1.Feature | Feature}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1beta1.Feature|Feature}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `searchFeaturesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ searchFeatures( @@ -5423,22 +5384,21 @@ export class FeaturestoreServiceClient { * 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures} + * {@link protos.google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures}, + * {@link protos.google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures}, * except `page_size`, must match the call that provided the page token. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1beta1.Feature | Feature} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1beta1.Feature|Feature} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `searchFeaturesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ searchFeaturesStream( @@ -5541,21 +5501,20 @@ export class FeaturestoreServiceClient { * 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures} + * {@link protos.google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures}, + * {@link protos.google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures}, * except `page_size`, must match the call that provided the page token. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1beta1.Feature | Feature}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1beta1.Feature|Feature}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/featurestore_service.search_features.js * region_tag:aiplatform_v1beta1_generated_FeaturestoreService_SearchFeatures_async @@ -5620,7 +5579,7 @@ export class FeaturestoreServiceClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -5641,8 +5600,7 @@ export class FeaturestoreServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -5668,7 +5626,7 @@ export class FeaturestoreServiceClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -5689,8 +5647,7 @@ export class FeaturestoreServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -5717,7 +5674,7 @@ export class FeaturestoreServiceClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -5732,8 +5689,7 @@ export class FeaturestoreServiceClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` @@ -5779,12 +5735,11 @@ export class FeaturestoreServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` diff --git a/packages/google-cloud-aiplatform/src/v1beta1/gapic_metadata.json b/packages/google-cloud-aiplatform/src/v1beta1/gapic_metadata.json index babc223c07f..4d2d8f366a4 100644 --- a/packages/google-cloud-aiplatform/src/v1beta1/gapic_metadata.json +++ b/packages/google-cloud-aiplatform/src/v1beta1/gapic_metadata.json @@ -2059,6 +2059,11 @@ "methods": [ "explain" ] + }, + "ServerStreamingPredict": { + "methods": [ + "serverStreamingPredict" + ] } } }, diff --git a/packages/google-cloud-aiplatform/src/v1beta1/index_endpoint_service_client.ts b/packages/google-cloud-aiplatform/src/v1beta1/index_endpoint_service_client.ts index 515fa216fa0..03117470489 100644 --- a/packages/google-cloud-aiplatform/src/v1beta1/index_endpoint_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1beta1/index_endpoint_service_client.ts @@ -1734,9 +1734,8 @@ export class IndexEndpointServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.IndexEndpoint | IndexEndpoint}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.IndexEndpoint|IndexEndpoint}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/index_endpoint_service.get_index_endpoint.js * region_tag:aiplatform_v1beta1_generated_IndexEndpointService_GetIndexEndpoint_async @@ -1830,13 +1829,12 @@ export class IndexEndpointServiceClient { * Required. The IndexEndpoint which replaces the resource on the server. * @param {google.protobuf.FieldMask} request.updateMask * Required. The update mask applies to the resource. See - * {@link google.protobuf.FieldMask|google.protobuf.FieldMask}. + * {@link protos.google.protobuf.FieldMask|google.protobuf.FieldMask}. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.IndexEndpoint | IndexEndpoint}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.IndexEndpoint|IndexEndpoint}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/index_endpoint_service.update_index_endpoint.js * region_tag:aiplatform_v1beta1_generated_IndexEndpointService_UpdateIndexEndpoint_async @@ -1938,8 +1936,7 @@ export class IndexEndpointServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/index_endpoint_service.create_index_endpoint.js * region_tag:aiplatform_v1beta1_generated_IndexEndpointService_CreateIndexEndpoint_async @@ -2034,8 +2031,7 @@ export class IndexEndpointServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/index_endpoint_service.create_index_endpoint.js * region_tag:aiplatform_v1beta1_generated_IndexEndpointService_CreateIndexEndpoint_async @@ -2078,8 +2074,7 @@ export class IndexEndpointServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/index_endpoint_service.delete_index_endpoint.js * region_tag:aiplatform_v1beta1_generated_IndexEndpointService_DeleteIndexEndpoint_async @@ -2174,8 +2169,7 @@ export class IndexEndpointServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/index_endpoint_service.delete_index_endpoint.js * region_tag:aiplatform_v1beta1_generated_IndexEndpointService_DeleteIndexEndpoint_async @@ -2222,8 +2216,7 @@ export class IndexEndpointServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/index_endpoint_service.deploy_index.js * region_tag:aiplatform_v1beta1_generated_IndexEndpointService_DeployIndex_async @@ -2318,8 +2311,7 @@ export class IndexEndpointServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/index_endpoint_service.deploy_index.js * region_tag:aiplatform_v1beta1_generated_IndexEndpointService_DeployIndex_async @@ -2366,8 +2358,7 @@ export class IndexEndpointServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/index_endpoint_service.undeploy_index.js * region_tag:aiplatform_v1beta1_generated_IndexEndpointService_UndeployIndex_async @@ -2462,8 +2453,7 @@ export class IndexEndpointServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/index_endpoint_service.undeploy_index.js * region_tag:aiplatform_v1beta1_generated_IndexEndpointService_UndeployIndex_async @@ -2502,16 +2492,15 @@ export class IndexEndpointServiceClient { * `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}` * @param {google.cloud.aiplatform.v1beta1.DeployedIndex} request.deployedIndex * Required. The DeployedIndex to be updated within the IndexEndpoint. - * Currently, the updatable fields are {@link automatic_resources|DeployedIndex} - * and {@link dedicated_resources|DeployedIndex} + * Currently, the updatable fields are {@link protos.automatic_resources|DeployedIndex} + * and {@link protos.dedicated_resources|DeployedIndex} * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/index_endpoint_service.mutate_deployed_index.js * region_tag:aiplatform_v1beta1_generated_IndexEndpointService_MutateDeployedIndex_async @@ -2606,8 +2595,7 @@ export class IndexEndpointServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/index_endpoint_service.mutate_deployed_index.js * region_tag:aiplatform_v1beta1_generated_IndexEndpointService_MutateDeployedIndex_async @@ -2649,7 +2637,7 @@ export class IndexEndpointServiceClient { * * * `index_endpoint` supports = and !=. `index_endpoint` represents the * IndexEndpoint ID, ie. the last segment of the IndexEndpoint's - * {@link google.cloud.aiplatform.v1beta1.IndexEndpoint.name|resourcename}. + * {@link protos.google.cloud.aiplatform.v1beta1.IndexEndpoint.name|resourcename}. * * `display_name` supports =, != and regex() * (uses [re2](https://github.com/google/re2/wiki/Syntax) syntax) * * `labels` supports general map functions that is: @@ -2667,23 +2655,22 @@ export class IndexEndpointServiceClient { * @param {string} [request.pageToken] * Optional. The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListIndexEndpointsResponse.next_page_token|ListIndexEndpointsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListIndexEndpointsResponse.next_page_token|ListIndexEndpointsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.IndexEndpointService.ListIndexEndpoints|IndexEndpointService.ListIndexEndpoints} + * {@link protos.google.cloud.aiplatform.v1beta1.IndexEndpointService.ListIndexEndpoints|IndexEndpointService.ListIndexEndpoints} * call. * @param {google.protobuf.FieldMask} [request.readMask] * Optional. Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1beta1.IndexEndpoint | IndexEndpoint}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1beta1.IndexEndpoint|IndexEndpoint}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listIndexEndpointsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listIndexEndpoints( @@ -2774,7 +2761,7 @@ export class IndexEndpointServiceClient { * * * `index_endpoint` supports = and !=. `index_endpoint` represents the * IndexEndpoint ID, ie. the last segment of the IndexEndpoint's - * {@link google.cloud.aiplatform.v1beta1.IndexEndpoint.name|resourcename}. + * {@link protos.google.cloud.aiplatform.v1beta1.IndexEndpoint.name|resourcename}. * * `display_name` supports =, != and regex() * (uses [re2](https://github.com/google/re2/wiki/Syntax) syntax) * * `labels` supports general map functions that is: @@ -2792,22 +2779,21 @@ export class IndexEndpointServiceClient { * @param {string} [request.pageToken] * Optional. The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListIndexEndpointsResponse.next_page_token|ListIndexEndpointsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListIndexEndpointsResponse.next_page_token|ListIndexEndpointsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.IndexEndpointService.ListIndexEndpoints|IndexEndpointService.ListIndexEndpoints} + * {@link protos.google.cloud.aiplatform.v1beta1.IndexEndpointService.ListIndexEndpoints|IndexEndpointService.ListIndexEndpoints} * call. * @param {google.protobuf.FieldMask} [request.readMask] * Optional. Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1beta1.IndexEndpoint | IndexEndpoint} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1beta1.IndexEndpoint|IndexEndpoint} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listIndexEndpointsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listIndexEndpointsStream( @@ -2847,7 +2833,7 @@ export class IndexEndpointServiceClient { * * * `index_endpoint` supports = and !=. `index_endpoint` represents the * IndexEndpoint ID, ie. the last segment of the IndexEndpoint's - * {@link google.cloud.aiplatform.v1beta1.IndexEndpoint.name|resourcename}. + * {@link protos.google.cloud.aiplatform.v1beta1.IndexEndpoint.name|resourcename}. * * `display_name` supports =, != and regex() * (uses [re2](https://github.com/google/re2/wiki/Syntax) syntax) * * `labels` supports general map functions that is: @@ -2865,21 +2851,20 @@ export class IndexEndpointServiceClient { * @param {string} [request.pageToken] * Optional. The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListIndexEndpointsResponse.next_page_token|ListIndexEndpointsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListIndexEndpointsResponse.next_page_token|ListIndexEndpointsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.IndexEndpointService.ListIndexEndpoints|IndexEndpointService.ListIndexEndpoints} + * {@link protos.google.cloud.aiplatform.v1beta1.IndexEndpointService.ListIndexEndpoints|IndexEndpointService.ListIndexEndpoints} * call. * @param {google.protobuf.FieldMask} [request.readMask] * Optional. Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1beta1.IndexEndpoint | IndexEndpoint}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1beta1.IndexEndpoint|IndexEndpoint}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/index_endpoint_service.list_index_endpoints.js * region_tag:aiplatform_v1beta1_generated_IndexEndpointService_ListIndexEndpoints_async @@ -2944,7 +2929,7 @@ export class IndexEndpointServiceClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -2965,8 +2950,7 @@ export class IndexEndpointServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -2992,7 +2976,7 @@ export class IndexEndpointServiceClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -3013,8 +2997,7 @@ export class IndexEndpointServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -3041,7 +3024,7 @@ export class IndexEndpointServiceClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -3056,8 +3039,7 @@ export class IndexEndpointServiceClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` @@ -3103,12 +3085,11 @@ export class IndexEndpointServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` diff --git a/packages/google-cloud-aiplatform/src/v1beta1/index_service_client.ts b/packages/google-cloud-aiplatform/src/v1beta1/index_service_client.ts index 46640b484a2..27ee36e544b 100644 --- a/packages/google-cloud-aiplatform/src/v1beta1/index_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1beta1/index_service_client.ts @@ -1710,9 +1710,8 @@ export class IndexServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.Index | Index}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.Index|Index}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/index_service.get_index.js * region_tag:aiplatform_v1beta1_generated_IndexService_GetIndex_async @@ -1805,9 +1804,8 @@ export class IndexServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.UpsertDatapointsResponse | UpsertDatapointsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.UpsertDatapointsResponse|UpsertDatapointsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/index_service.upsert_datapoints.js * region_tag:aiplatform_v1beta1_generated_IndexService_UpsertDatapoints_async @@ -1906,9 +1904,8 @@ export class IndexServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.RemoveDatapointsResponse | RemoveDatapointsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.RemoveDatapointsResponse|RemoveDatapointsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/index_service.remove_datapoints.js * region_tag:aiplatform_v1beta1_generated_IndexService_RemoveDatapoints_async @@ -2010,8 +2007,7 @@ export class IndexServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/index_service.create_index.js * region_tag:aiplatform_v1beta1_generated_IndexService_CreateIndex_async @@ -2106,8 +2102,7 @@ export class IndexServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/index_service.create_index.js * region_tag:aiplatform_v1beta1_generated_IndexService_CreateIndex_async @@ -2145,15 +2140,14 @@ export class IndexServiceClient { * @param {google.protobuf.FieldMask} request.updateMask * The update mask applies to the resource. * For the `FieldMask` definition, see - * {@link google.protobuf.FieldMask|google.protobuf.FieldMask}. + * {@link protos.google.protobuf.FieldMask|google.protobuf.FieldMask}. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/index_service.update_index.js * region_tag:aiplatform_v1beta1_generated_IndexService_UpdateIndex_async @@ -2248,8 +2242,7 @@ export class IndexServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/index_service.update_index.js * region_tag:aiplatform_v1beta1_generated_IndexService_UpdateIndex_async @@ -2280,7 +2273,7 @@ export class IndexServiceClient { /** * Deletes an Index. * An Index can only be deleted when all its - * {@link google.cloud.aiplatform.v1beta1.Index.deployed_indexes|DeployedIndexes} + * {@link protos.google.cloud.aiplatform.v1beta1.Index.deployed_indexes|DeployedIndexes} * had been undeployed. * * @param {Object} request @@ -2295,8 +2288,7 @@ export class IndexServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/index_service.delete_index.js * region_tag:aiplatform_v1beta1_generated_IndexService_DeleteIndex_async @@ -2391,8 +2383,7 @@ export class IndexServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/index_service.delete_index.js * region_tag:aiplatform_v1beta1_generated_IndexService_DeleteIndex_async @@ -2435,23 +2426,22 @@ export class IndexServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListIndexesResponse.next_page_token|ListIndexesResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListIndexesResponse.next_page_token|ListIndexesResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.IndexService.ListIndexes|IndexService.ListIndexes} + * {@link protos.google.cloud.aiplatform.v1beta1.IndexService.ListIndexes|IndexService.ListIndexes} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1beta1.Index | Index}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1beta1.Index|Index}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listIndexesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listIndexes( @@ -2543,22 +2533,21 @@ export class IndexServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListIndexesResponse.next_page_token|ListIndexesResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListIndexesResponse.next_page_token|ListIndexesResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.IndexService.ListIndexes|IndexService.ListIndexes} + * {@link protos.google.cloud.aiplatform.v1beta1.IndexService.ListIndexes|IndexService.ListIndexes} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1beta1.Index | Index} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1beta1.Index|Index} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listIndexesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listIndexesStream( @@ -2599,21 +2588,20 @@ export class IndexServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListIndexesResponse.next_page_token|ListIndexesResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListIndexesResponse.next_page_token|ListIndexesResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.IndexService.ListIndexes|IndexService.ListIndexes} + * {@link protos.google.cloud.aiplatform.v1beta1.IndexService.ListIndexes|IndexService.ListIndexes} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1beta1.Index | Index}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1beta1.Index|Index}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/index_service.list_indexes.js * region_tag:aiplatform_v1beta1_generated_IndexService_ListIndexes_async @@ -2678,7 +2666,7 @@ export class IndexServiceClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -2699,8 +2687,7 @@ export class IndexServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -2726,7 +2713,7 @@ export class IndexServiceClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -2747,8 +2734,7 @@ export class IndexServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -2775,7 +2761,7 @@ export class IndexServiceClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -2790,8 +2776,7 @@ export class IndexServiceClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` @@ -2837,12 +2822,11 @@ export class IndexServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` diff --git a/packages/google-cloud-aiplatform/src/v1beta1/job_service_client.ts b/packages/google-cloud-aiplatform/src/v1beta1/job_service_client.ts index 8731ac8ec0a..bbae69008ff 100644 --- a/packages/google-cloud-aiplatform/src/v1beta1/job_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1beta1/job_service_client.ts @@ -1843,9 +1843,8 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.CustomJob | CustomJob}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.CustomJob|CustomJob}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/job_service.create_custom_job.js * region_tag:aiplatform_v1beta1_generated_JobService_CreateCustomJob_async @@ -1942,9 +1941,8 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.CustomJob | CustomJob}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.CustomJob|CustomJob}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/job_service.get_custom_job.js * region_tag:aiplatform_v1beta1_generated_JobService_GetCustomJob_async @@ -2028,14 +2026,14 @@ export class JobServiceClient { * Starts asynchronous cancellation on the CustomJob. The server * makes a best effort to cancel the job, but success is not * guaranteed. Clients can use - * {@link google.cloud.aiplatform.v1beta1.JobService.GetCustomJob|JobService.GetCustomJob} + * {@link protos.google.cloud.aiplatform.v1beta1.JobService.GetCustomJob|JobService.GetCustomJob} * or other methods to check whether the cancellation succeeded or whether the * job completed despite cancellation. On successful cancellation, * the CustomJob is not deleted; instead it becomes a job with - * a {@link google.cloud.aiplatform.v1beta1.CustomJob.error|CustomJob.error} value - * with a {@link google.rpc.Status.code|google.rpc.Status.code} of 1, corresponding + * a {@link protos.google.cloud.aiplatform.v1beta1.CustomJob.error|CustomJob.error} value + * with a {@link protos.google.rpc.Status.code|google.rpc.Status.code} of 1, corresponding * to `Code.CANCELLED`, and - * {@link google.cloud.aiplatform.v1beta1.CustomJob.state|CustomJob.state} is set + * {@link protos.google.cloud.aiplatform.v1beta1.CustomJob.state|CustomJob.state} is set * to `CANCELLED`. * * @param {Object} request @@ -2047,9 +2045,8 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.protobuf.Empty | Empty}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/job_service.cancel_custom_job.js * region_tag:aiplatform_v1beta1_generated_JobService_CancelCustomJob_async @@ -2147,9 +2144,8 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.DataLabelingJob | DataLabelingJob}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.DataLabelingJob|DataLabelingJob}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/job_service.create_data_labeling_job.js * region_tag:aiplatform_v1beta1_generated_JobService_CreateDataLabelingJob_async @@ -2246,9 +2242,8 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.DataLabelingJob | DataLabelingJob}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.DataLabelingJob|DataLabelingJob}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/job_service.get_data_labeling_job.js * region_tag:aiplatform_v1beta1_generated_JobService_GetDataLabelingJob_async @@ -2345,9 +2340,8 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.protobuf.Empty | Empty}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/job_service.cancel_data_labeling_job.js * region_tag:aiplatform_v1beta1_generated_JobService_CancelDataLabelingJob_async @@ -2446,9 +2440,8 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.HyperparameterTuningJob | HyperparameterTuningJob}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.HyperparameterTuningJob|HyperparameterTuningJob}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/job_service.create_hyperparameter_tuning_job.js * region_tag:aiplatform_v1beta1_generated_JobService_CreateHyperparameterTuningJob_async @@ -2549,9 +2542,8 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.HyperparameterTuningJob | HyperparameterTuningJob}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.HyperparameterTuningJob|HyperparameterTuningJob}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/job_service.get_hyperparameter_tuning_job.js * region_tag:aiplatform_v1beta1_generated_JobService_GetHyperparameterTuningJob_async @@ -2645,15 +2637,15 @@ export class JobServiceClient { * Starts asynchronous cancellation on the HyperparameterTuningJob. The server * makes a best effort to cancel the job, but success is not * guaranteed. Clients can use - * {@link google.cloud.aiplatform.v1beta1.JobService.GetHyperparameterTuningJob|JobService.GetHyperparameterTuningJob} + * {@link protos.google.cloud.aiplatform.v1beta1.JobService.GetHyperparameterTuningJob|JobService.GetHyperparameterTuningJob} * or other methods to check whether the cancellation succeeded or whether the * job completed despite cancellation. On successful cancellation, * the HyperparameterTuningJob is not deleted; instead it becomes a job with * a - * {@link google.cloud.aiplatform.v1beta1.HyperparameterTuningJob.error|HyperparameterTuningJob.error} - * value with a {@link google.rpc.Status.code|google.rpc.Status.code} of 1, + * {@link protos.google.cloud.aiplatform.v1beta1.HyperparameterTuningJob.error|HyperparameterTuningJob.error} + * value with a {@link protos.google.rpc.Status.code|google.rpc.Status.code} of 1, * corresponding to `Code.CANCELLED`, and - * {@link google.cloud.aiplatform.v1beta1.HyperparameterTuningJob.state|HyperparameterTuningJob.state} + * {@link protos.google.cloud.aiplatform.v1beta1.HyperparameterTuningJob.state|HyperparameterTuningJob.state} * is set to `CANCELLED`. * * @param {Object} request @@ -2665,9 +2657,8 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.protobuf.Empty | Empty}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/job_service.cancel_hyperparameter_tuning_job.js * region_tag:aiplatform_v1beta1_generated_JobService_CancelHyperparameterTuningJob_async @@ -2769,9 +2760,8 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.NasJob | NasJob}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.NasJob|NasJob}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/job_service.create_nas_job.js * region_tag:aiplatform_v1beta1_generated_JobService_CreateNasJob_async @@ -2862,9 +2852,8 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.NasJob | NasJob}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.NasJob|NasJob}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/job_service.get_nas_job.js * region_tag:aiplatform_v1beta1_generated_JobService_GetNasJob_async @@ -2948,14 +2937,14 @@ export class JobServiceClient { * Starts asynchronous cancellation on the NasJob. The server * makes a best effort to cancel the job, but success is not * guaranteed. Clients can use - * {@link google.cloud.aiplatform.v1beta1.JobService.GetNasJob|JobService.GetNasJob} + * {@link protos.google.cloud.aiplatform.v1beta1.JobService.GetNasJob|JobService.GetNasJob} * or other methods to check whether the cancellation succeeded or whether the * job completed despite cancellation. On successful cancellation, * the NasJob is not deleted; instead it becomes a job with - * a {@link google.cloud.aiplatform.v1beta1.NasJob.error|NasJob.error} value with a - * {@link google.rpc.Status.code|google.rpc.Status.code} of 1, corresponding to + * a {@link protos.google.cloud.aiplatform.v1beta1.NasJob.error|NasJob.error} value with a + * {@link protos.google.rpc.Status.code|google.rpc.Status.code} of 1, corresponding to * `Code.CANCELLED`, and - * {@link google.cloud.aiplatform.v1beta1.NasJob.state|NasJob.state} is set to + * {@link protos.google.cloud.aiplatform.v1beta1.NasJob.state|NasJob.state} is set to * `CANCELLED`. * * @param {Object} request @@ -2967,9 +2956,8 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.protobuf.Empty | Empty}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/job_service.cancel_nas_job.js * region_tag:aiplatform_v1beta1_generated_JobService_CancelNasJob_async @@ -3060,9 +3048,8 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.NasTrialDetail | NasTrialDetail}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.NasTrialDetail|NasTrialDetail}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/job_service.get_nas_trial_detail.js * region_tag:aiplatform_v1beta1_generated_JobService_GetNasTrialDetail_async @@ -3161,9 +3148,8 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.BatchPredictionJob | BatchPredictionJob}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.BatchPredictionJob|BatchPredictionJob}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/job_service.create_batch_prediction_job.js * region_tag:aiplatform_v1beta1_generated_JobService_CreateBatchPredictionJob_async @@ -3264,9 +3250,8 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.BatchPredictionJob | BatchPredictionJob}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.BatchPredictionJob|BatchPredictionJob}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/job_service.get_batch_prediction_job.js * region_tag:aiplatform_v1beta1_generated_JobService_GetBatchPredictionJob_async @@ -3357,11 +3342,11 @@ export class JobServiceClient { * Starts asynchronous cancellation on the BatchPredictionJob. The server * makes the best effort to cancel the job, but success is not * guaranteed. Clients can use - * {@link google.cloud.aiplatform.v1beta1.JobService.GetBatchPredictionJob|JobService.GetBatchPredictionJob} + * {@link protos.google.cloud.aiplatform.v1beta1.JobService.GetBatchPredictionJob|JobService.GetBatchPredictionJob} * or other methods to check whether the cancellation succeeded or whether the * job completed despite cancellation. On a successful cancellation, * the BatchPredictionJob is not deleted;instead its - * {@link google.cloud.aiplatform.v1beta1.BatchPredictionJob.state|BatchPredictionJob.state} + * {@link protos.google.cloud.aiplatform.v1beta1.BatchPredictionJob.state|BatchPredictionJob.state} * is set to `CANCELLED`. Any files already outputted by the job are not * deleted. * @@ -3374,9 +3359,8 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.protobuf.Empty | Empty}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/job_service.cancel_batch_prediction_job.js * region_tag:aiplatform_v1beta1_generated_JobService_CancelBatchPredictionJob_async @@ -3479,9 +3463,8 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob | ModelDeploymentMonitoringJob}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob|ModelDeploymentMonitoringJob}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/job_service.create_model_deployment_monitoring_job.js * region_tag:aiplatform_v1beta1_generated_JobService_CreateModelDeploymentMonitoringJob_async @@ -3582,9 +3565,8 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob | ModelDeploymentMonitoringJob}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob|ModelDeploymentMonitoringJob}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/job_service.get_model_deployment_monitoring_job.js * region_tag:aiplatform_v1beta1_generated_JobService_GetModelDeploymentMonitoringJob_async @@ -3676,7 +3658,7 @@ export class JobServiceClient { /** * Pauses a ModelDeploymentMonitoringJob. If the job is running, the server * makes a best effort to cancel the job. Will mark - * {@link google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob.state|ModelDeploymentMonitoringJob.state} + * {@link protos.google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob.state|ModelDeploymentMonitoringJob.state} * to 'PAUSED'. * * @param {Object} request @@ -3688,9 +3670,8 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.protobuf.Empty | Empty}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/job_service.pause_model_deployment_monitoring_job.js * region_tag:aiplatform_v1beta1_generated_JobService_PauseModelDeploymentMonitoringJob_async @@ -3793,9 +3774,8 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.protobuf.Empty | Empty}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/job_service.resume_model_deployment_monitoring_job.js * region_tag:aiplatform_v1beta1_generated_JobService_ResumeModelDeploymentMonitoringJob_async @@ -3900,8 +3880,7 @@ export class JobServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/job_service.delete_custom_job.js * region_tag:aiplatform_v1beta1_generated_JobService_DeleteCustomJob_async @@ -3996,8 +3975,7 @@ export class JobServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/job_service.delete_custom_job.js * region_tag:aiplatform_v1beta1_generated_JobService_DeleteCustomJob_async @@ -4040,8 +4018,7 @@ export class JobServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/job_service.delete_data_labeling_job.js * region_tag:aiplatform_v1beta1_generated_JobService_DeleteDataLabelingJob_async @@ -4136,8 +4113,7 @@ export class JobServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/job_service.delete_data_labeling_job.js * region_tag:aiplatform_v1beta1_generated_JobService_DeleteDataLabelingJob_async @@ -4180,8 +4156,7 @@ export class JobServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/job_service.delete_hyperparameter_tuning_job.js * region_tag:aiplatform_v1beta1_generated_JobService_DeleteHyperparameterTuningJob_async @@ -4280,8 +4255,7 @@ export class JobServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/job_service.delete_hyperparameter_tuning_job.js * region_tag:aiplatform_v1beta1_generated_JobService_DeleteHyperparameterTuningJob_async @@ -4324,8 +4298,7 @@ export class JobServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/job_service.delete_nas_job.js * region_tag:aiplatform_v1beta1_generated_JobService_DeleteNasJob_async @@ -4420,8 +4393,7 @@ export class JobServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/job_service.delete_nas_job.js * region_tag:aiplatform_v1beta1_generated_JobService_DeleteNasJob_async @@ -4465,8 +4437,7 @@ export class JobServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/job_service.delete_batch_prediction_job.js * region_tag:aiplatform_v1beta1_generated_JobService_DeleteBatchPredictionJob_async @@ -4565,8 +4536,7 @@ export class JobServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/job_service.delete_batch_prediction_job.js * region_tag:aiplatform_v1beta1_generated_JobService_DeleteBatchPredictionJob_async @@ -4635,8 +4605,7 @@ export class JobServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/job_service.update_model_deployment_monitoring_job.js * region_tag:aiplatform_v1beta1_generated_JobService_UpdateModelDeploymentMonitoringJob_async @@ -4736,8 +4705,7 @@ export class JobServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/job_service.update_model_deployment_monitoring_job.js * region_tag:aiplatform_v1beta1_generated_JobService_UpdateModelDeploymentMonitoringJob_async @@ -4780,8 +4748,7 @@ export class JobServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/job_service.delete_model_deployment_monitoring_job.js * region_tag:aiplatform_v1beta1_generated_JobService_DeleteModelDeploymentMonitoringJob_async @@ -4880,8 +4847,7 @@ export class JobServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/job_service.delete_model_deployment_monitoring_job.js * region_tag:aiplatform_v1beta1_generated_JobService_DeleteModelDeploymentMonitoringJob_async @@ -4943,23 +4909,22 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListCustomJobsResponse.next_page_token|ListCustomJobsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListCustomJobsResponse.next_page_token|ListCustomJobsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.JobService.ListCustomJobs|JobService.ListCustomJobs} + * {@link protos.google.cloud.aiplatform.v1beta1.JobService.ListCustomJobs|JobService.ListCustomJobs} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1beta1.CustomJob | CustomJob}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1beta1.CustomJob|CustomJob}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listCustomJobsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listCustomJobs( @@ -5070,22 +5035,21 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListCustomJobsResponse.next_page_token|ListCustomJobsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListCustomJobsResponse.next_page_token|ListCustomJobsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.JobService.ListCustomJobs|JobService.ListCustomJobs} + * {@link protos.google.cloud.aiplatform.v1beta1.JobService.ListCustomJobs|JobService.ListCustomJobs} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1beta1.CustomJob | CustomJob} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1beta1.CustomJob|CustomJob} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listCustomJobsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listCustomJobsStream( @@ -5145,21 +5109,20 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListCustomJobsResponse.next_page_token|ListCustomJobsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListCustomJobsResponse.next_page_token|ListCustomJobsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.JobService.ListCustomJobs|JobService.ListCustomJobs} + * {@link protos.google.cloud.aiplatform.v1beta1.JobService.ListCustomJobs|JobService.ListCustomJobs} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1beta1.CustomJob | CustomJob}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1beta1.CustomJob|CustomJob}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/job_service.list_custom_jobs.js * region_tag:aiplatform_v1beta1_generated_JobService_ListCustomJobs_async @@ -5230,14 +5193,13 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1beta1.DataLabelingJob | DataLabelingJob}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1beta1.DataLabelingJob|DataLabelingJob}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listDataLabelingJobsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listDataLabelingJobs( @@ -5359,13 +5321,12 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1beta1.DataLabelingJob | DataLabelingJob} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1beta1.DataLabelingJob|DataLabelingJob} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listDataLabelingJobsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listDataLabelingJobsStream( @@ -5436,12 +5397,11 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1beta1.DataLabelingJob | DataLabelingJob}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1beta1.DataLabelingJob|DataLabelingJob}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/job_service.list_data_labeling_jobs.js * region_tag:aiplatform_v1beta1_generated_JobService_ListDataLabelingJobs_async @@ -5502,23 +5462,22 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListHyperparameterTuningJobsResponse.next_page_token|ListHyperparameterTuningJobsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListHyperparameterTuningJobsResponse.next_page_token|ListHyperparameterTuningJobsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.JobService.ListHyperparameterTuningJobs|JobService.ListHyperparameterTuningJobs} + * {@link protos.google.cloud.aiplatform.v1beta1.JobService.ListHyperparameterTuningJobs|JobService.ListHyperparameterTuningJobs} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1beta1.HyperparameterTuningJob | HyperparameterTuningJob}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1beta1.HyperparameterTuningJob|HyperparameterTuningJob}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listHyperparameterTuningJobsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listHyperparameterTuningJobs( @@ -5634,22 +5593,21 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListHyperparameterTuningJobsResponse.next_page_token|ListHyperparameterTuningJobsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListHyperparameterTuningJobsResponse.next_page_token|ListHyperparameterTuningJobsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.JobService.ListHyperparameterTuningJobs|JobService.ListHyperparameterTuningJobs} + * {@link protos.google.cloud.aiplatform.v1beta1.JobService.ListHyperparameterTuningJobs|JobService.ListHyperparameterTuningJobs} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1beta1.HyperparameterTuningJob | HyperparameterTuningJob} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1beta1.HyperparameterTuningJob|HyperparameterTuningJob} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listHyperparameterTuningJobsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listHyperparameterTuningJobsStream( @@ -5710,21 +5668,20 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListHyperparameterTuningJobsResponse.next_page_token|ListHyperparameterTuningJobsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListHyperparameterTuningJobsResponse.next_page_token|ListHyperparameterTuningJobsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.JobService.ListHyperparameterTuningJobs|JobService.ListHyperparameterTuningJobs} + * {@link protos.google.cloud.aiplatform.v1beta1.JobService.ListHyperparameterTuningJobs|JobService.ListHyperparameterTuningJobs} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1beta1.HyperparameterTuningJob | HyperparameterTuningJob}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1beta1.HyperparameterTuningJob|HyperparameterTuningJob}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/job_service.list_hyperparameter_tuning_jobs.js * region_tag:aiplatform_v1beta1_generated_JobService_ListHyperparameterTuningJobs_async @@ -5784,23 +5741,22 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListNasJobsResponse.next_page_token|ListNasJobsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListNasJobsResponse.next_page_token|ListNasJobsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.JobService.ListNasJobs|JobService.ListNasJobs} + * {@link protos.google.cloud.aiplatform.v1beta1.JobService.ListNasJobs|JobService.ListNasJobs} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1beta1.NasJob | NasJob}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1beta1.NasJob|NasJob}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listNasJobsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listNasJobs( @@ -5911,22 +5867,21 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListNasJobsResponse.next_page_token|ListNasJobsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListNasJobsResponse.next_page_token|ListNasJobsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.JobService.ListNasJobs|JobService.ListNasJobs} + * {@link protos.google.cloud.aiplatform.v1beta1.JobService.ListNasJobs|JobService.ListNasJobs} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1beta1.NasJob | NasJob} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1beta1.NasJob|NasJob} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listNasJobsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listNasJobsStream( @@ -5986,21 +5941,20 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListNasJobsResponse.next_page_token|ListNasJobsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListNasJobsResponse.next_page_token|ListNasJobsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.JobService.ListNasJobs|JobService.ListNasJobs} + * {@link protos.google.cloud.aiplatform.v1beta1.JobService.ListNasJobs|JobService.ListNasJobs} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1beta1.NasJob | NasJob}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1beta1.NasJob|NasJob}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/job_service.list_nas_jobs.js * region_tag:aiplatform_v1beta1_generated_JobService_ListNasJobs_async @@ -6040,21 +5994,20 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListNasTrialDetailsResponse.next_page_token|ListNasTrialDetailsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListNasTrialDetailsResponse.next_page_token|ListNasTrialDetailsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.JobService.ListNasTrialDetails|JobService.ListNasTrialDetails} + * {@link protos.google.cloud.aiplatform.v1beta1.JobService.ListNasTrialDetails|JobService.ListNasTrialDetails} * call. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1beta1.NasTrialDetail | NasTrialDetail}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1beta1.NasTrialDetail|NasTrialDetail}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listNasTrialDetailsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listNasTrialDetails( @@ -6145,20 +6098,19 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListNasTrialDetailsResponse.next_page_token|ListNasTrialDetailsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListNasTrialDetailsResponse.next_page_token|ListNasTrialDetailsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.JobService.ListNasTrialDetails|JobService.ListNasTrialDetails} + * {@link protos.google.cloud.aiplatform.v1beta1.JobService.ListNasTrialDetails|JobService.ListNasTrialDetails} * call. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1beta1.NasTrialDetail | NasTrialDetail} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1beta1.NasTrialDetail|NasTrialDetail} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listNasTrialDetailsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listNasTrialDetailsStream( @@ -6198,19 +6150,18 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListNasTrialDetailsResponse.next_page_token|ListNasTrialDetailsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListNasTrialDetailsResponse.next_page_token|ListNasTrialDetailsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.JobService.ListNasTrialDetails|JobService.ListNasTrialDetails} + * {@link protos.google.cloud.aiplatform.v1beta1.JobService.ListNasTrialDetails|JobService.ListNasTrialDetails} * call. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1beta1.NasTrialDetail | NasTrialDetail}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1beta1.NasTrialDetail|NasTrialDetail}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/job_service.list_nas_trial_details.js * region_tag:aiplatform_v1beta1_generated_JobService_ListNasTrialDetails_async @@ -6271,23 +6222,22 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListBatchPredictionJobsResponse.next_page_token|ListBatchPredictionJobsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListBatchPredictionJobsResponse.next_page_token|ListBatchPredictionJobsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.JobService.ListBatchPredictionJobs|JobService.ListBatchPredictionJobs} + * {@link protos.google.cloud.aiplatform.v1beta1.JobService.ListBatchPredictionJobs|JobService.ListBatchPredictionJobs} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1beta1.BatchPredictionJob | BatchPredictionJob}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1beta1.BatchPredictionJob|BatchPredictionJob}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listBatchPredictionJobsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listBatchPredictionJobs( @@ -6403,22 +6353,21 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListBatchPredictionJobsResponse.next_page_token|ListBatchPredictionJobsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListBatchPredictionJobsResponse.next_page_token|ListBatchPredictionJobsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.JobService.ListBatchPredictionJobs|JobService.ListBatchPredictionJobs} + * {@link protos.google.cloud.aiplatform.v1beta1.JobService.ListBatchPredictionJobs|JobService.ListBatchPredictionJobs} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1beta1.BatchPredictionJob | BatchPredictionJob} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1beta1.BatchPredictionJob|BatchPredictionJob} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listBatchPredictionJobsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listBatchPredictionJobsStream( @@ -6479,21 +6428,20 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListBatchPredictionJobsResponse.next_page_token|ListBatchPredictionJobsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListBatchPredictionJobsResponse.next_page_token|ListBatchPredictionJobsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.JobService.ListBatchPredictionJobs|JobService.ListBatchPredictionJobs} + * {@link protos.google.cloud.aiplatform.v1beta1.JobService.ListBatchPredictionJobs|JobService.ListBatchPredictionJobs} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1beta1.BatchPredictionJob | BatchPredictionJob}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1beta1.BatchPredictionJob|BatchPredictionJob}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/job_service.list_batch_prediction_jobs.js * region_tag:aiplatform_v1beta1_generated_JobService_ListBatchPredictionJobs_async @@ -6534,7 +6482,7 @@ export class JobServiceClient { * @param {string} request.featureDisplayName * The feature display name. If specified, only return the stats belonging to * this feature. Format: - * {@link google.cloud.aiplatform.v1beta1.ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name|ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name}, + * {@link protos.google.cloud.aiplatform.v1beta1.ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name|ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name}, * example: "user_destination". * @param {number[]} request.objectives * Required. Objectives of the stats to retrieve. @@ -6542,7 +6490,7 @@ export class JobServiceClient { * The standard list page size. * @param {string} request.pageToken * A page token received from a previous - * {@link google.cloud.aiplatform.v1beta1.JobService.SearchModelDeploymentMonitoringStatsAnomalies|JobService.SearchModelDeploymentMonitoringStatsAnomalies} + * {@link protos.google.cloud.aiplatform.v1beta1.JobService.SearchModelDeploymentMonitoringStatsAnomalies|JobService.SearchModelDeploymentMonitoringStatsAnomalies} * call. * @param {google.protobuf.Timestamp} request.startTime * The earliest timestamp of stats being generated. @@ -6553,14 +6501,13 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1beta1.ModelMonitoringStatsAnomalies | ModelMonitoringStatsAnomalies}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1beta1.ModelMonitoringStatsAnomalies|ModelMonitoringStatsAnomalies}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `searchModelDeploymentMonitoringStatsAnomaliesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ searchModelDeploymentMonitoringStatsAnomalies( @@ -6657,7 +6604,7 @@ export class JobServiceClient { * @param {string} request.featureDisplayName * The feature display name. If specified, only return the stats belonging to * this feature. Format: - * {@link google.cloud.aiplatform.v1beta1.ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name|ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name}, + * {@link protos.google.cloud.aiplatform.v1beta1.ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name|ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name}, * example: "user_destination". * @param {number[]} request.objectives * Required. Objectives of the stats to retrieve. @@ -6665,7 +6612,7 @@ export class JobServiceClient { * The standard list page size. * @param {string} request.pageToken * A page token received from a previous - * {@link google.cloud.aiplatform.v1beta1.JobService.SearchModelDeploymentMonitoringStatsAnomalies|JobService.SearchModelDeploymentMonitoringStatsAnomalies} + * {@link protos.google.cloud.aiplatform.v1beta1.JobService.SearchModelDeploymentMonitoringStatsAnomalies|JobService.SearchModelDeploymentMonitoringStatsAnomalies} * call. * @param {google.protobuf.Timestamp} request.startTime * The earliest timestamp of stats being generated. @@ -6676,13 +6623,12 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1beta1.ModelMonitoringStatsAnomalies | ModelMonitoringStatsAnomalies} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1beta1.ModelMonitoringStatsAnomalies|ModelMonitoringStatsAnomalies} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `searchModelDeploymentMonitoringStatsAnomaliesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ searchModelDeploymentMonitoringStatsAnomaliesStream( @@ -6726,7 +6672,7 @@ export class JobServiceClient { * @param {string} request.featureDisplayName * The feature display name. If specified, only return the stats belonging to * this feature. Format: - * {@link google.cloud.aiplatform.v1beta1.ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name|ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name}, + * {@link protos.google.cloud.aiplatform.v1beta1.ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name|ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name}, * example: "user_destination". * @param {number[]} request.objectives * Required. Objectives of the stats to retrieve. @@ -6734,7 +6680,7 @@ export class JobServiceClient { * The standard list page size. * @param {string} request.pageToken * A page token received from a previous - * {@link google.cloud.aiplatform.v1beta1.JobService.SearchModelDeploymentMonitoringStatsAnomalies|JobService.SearchModelDeploymentMonitoringStatsAnomalies} + * {@link protos.google.cloud.aiplatform.v1beta1.JobService.SearchModelDeploymentMonitoringStatsAnomalies|JobService.SearchModelDeploymentMonitoringStatsAnomalies} * call. * @param {google.protobuf.Timestamp} request.startTime * The earliest timestamp of stats being generated. @@ -6745,12 +6691,11 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1beta1.ModelMonitoringStatsAnomalies | ModelMonitoringStatsAnomalies}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1beta1.ModelMonitoringStatsAnomalies|ModelMonitoringStatsAnomalies}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/job_service.search_model_deployment_monitoring_stats_anomalies.js * region_tag:aiplatform_v1beta1_generated_JobService_SearchModelDeploymentMonitoringStatsAnomalies_async @@ -6818,14 +6763,13 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob | ModelDeploymentMonitoringJob}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob|ModelDeploymentMonitoringJob}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listModelDeploymentMonitoringJobsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listModelDeploymentMonitoringJobs( @@ -6944,13 +6888,12 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob | ModelDeploymentMonitoringJob} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob|ModelDeploymentMonitoringJob} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listModelDeploymentMonitoringJobsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listModelDeploymentMonitoringJobsStream( @@ -7015,12 +6958,11 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob | ModelDeploymentMonitoringJob}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob|ModelDeploymentMonitoringJob}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/job_service.list_model_deployment_monitoring_jobs.js * region_tag:aiplatform_v1beta1_generated_JobService_ListModelDeploymentMonitoringJobs_async @@ -7086,7 +7028,7 @@ export class JobServiceClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -7107,8 +7049,7 @@ export class JobServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -7134,7 +7075,7 @@ export class JobServiceClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -7155,8 +7096,7 @@ export class JobServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -7183,7 +7123,7 @@ export class JobServiceClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -7198,8 +7138,7 @@ export class JobServiceClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` @@ -7245,12 +7184,11 @@ export class JobServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` diff --git a/packages/google-cloud-aiplatform/src/v1beta1/match_service_client.ts b/packages/google-cloud-aiplatform/src/v1beta1/match_service_client.ts index cf31ab4635d..f310392facd 100644 --- a/packages/google-cloud-aiplatform/src/v1beta1/match_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1beta1/match_service_client.ts @@ -468,9 +468,8 @@ export class MatchServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.FindNeighborsResponse | FindNeighborsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.FindNeighborsResponse|FindNeighborsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/match_service.find_neighbors.js * region_tag:aiplatform_v1beta1_generated_MatchService_FindNeighbors_async @@ -566,9 +565,8 @@ export class MatchServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.ReadIndexDatapointsResponse | ReadIndexDatapointsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.ReadIndexDatapointsResponse|ReadIndexDatapointsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/match_service.read_index_datapoints.js * region_tag:aiplatform_v1beta1_generated_MatchService_ReadIndexDatapoints_async @@ -693,7 +691,7 @@ export class MatchServiceClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -714,8 +712,7 @@ export class MatchServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -741,7 +738,7 @@ export class MatchServiceClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -762,8 +759,7 @@ export class MatchServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -790,7 +786,7 @@ export class MatchServiceClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -805,8 +801,7 @@ export class MatchServiceClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` @@ -852,12 +847,11 @@ export class MatchServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` diff --git a/packages/google-cloud-aiplatform/src/v1beta1/metadata_service_client.ts b/packages/google-cloud-aiplatform/src/v1beta1/metadata_service_client.ts index cefe019c5e8..4e0f58d3032 100644 --- a/packages/google-cloud-aiplatform/src/v1beta1/metadata_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1beta1/metadata_service_client.ts @@ -1813,9 +1813,8 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.MetadataStore | MetadataStore}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.MetadataStore|MetadataStore}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/metadata_service.get_metadata_store.js * region_tag:aiplatform_v1beta1_generated_MetadataService_GetMetadataStore_async @@ -1916,16 +1915,15 @@ export class MetadataServiceClient { * The {artifact} portion of the resource name with the format: * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` * If not provided, the Artifact's ID will be a UUID generated by the service. - * Must be 4-128 characters in length. Valid characters are `/{@link 0-9|a-z}-/`. + * Must be 4-128 characters in length. Valid characters are `/{@link protos.0-9|a-z}-/`. * Must be unique across all Artifacts in the parent MetadataStore. (Otherwise * the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the * caller can't view the preexisting Artifact.) * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.Artifact | Artifact}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.Artifact|Artifact}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/metadata_service.create_artifact.js * region_tag:aiplatform_v1beta1_generated_MetadataService_CreateArtifact_async @@ -2016,9 +2014,8 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.Artifact | Artifact}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.Artifact|Artifact}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/metadata_service.get_artifact.js * region_tag:aiplatform_v1beta1_generated_MetadataService_GetArtifact_async @@ -2105,21 +2102,20 @@ export class MetadataServiceClient { * @param {google.cloud.aiplatform.v1beta1.Artifact} request.artifact * Required. The Artifact containing updates. * The Artifact's - * {@link google.cloud.aiplatform.v1beta1.Artifact.name|Artifact.name} field is + * {@link protos.google.cloud.aiplatform.v1beta1.Artifact.name|Artifact.name} field is * used to identify the Artifact to be updated. Format: * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` * @param {google.protobuf.FieldMask} [request.updateMask] * Optional. A FieldMask indicating which fields should be updated. * @param {boolean} request.allowMissing * If set to true, and the - * {@link google.cloud.aiplatform.v1beta1.Artifact|Artifact} is not found, a new - * {@link google.cloud.aiplatform.v1beta1.Artifact|Artifact} is created. + * {@link protos.google.cloud.aiplatform.v1beta1.Artifact|Artifact} is not found, a new + * {@link protos.google.cloud.aiplatform.v1beta1.Artifact|Artifact} is created. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.Artifact | Artifact}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.Artifact|Artifact}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/metadata_service.update_artifact.js * region_tag:aiplatform_v1beta1_generated_MetadataService_UpdateArtifact_async @@ -2213,16 +2209,15 @@ export class MetadataServiceClient { * The {context} portion of the resource name with the format: * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`. * If not provided, the Context's ID will be a UUID generated by the service. - * Must be 4-128 characters in length. Valid characters are `/{@link 0-9|a-z}-/`. + * Must be 4-128 characters in length. Valid characters are `/{@link protos.0-9|a-z}-/`. * Must be unique across all Contexts in the parent MetadataStore. (Otherwise * the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the * caller can't view the preexisting Context.) * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.Context | Context}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.Context|Context}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/metadata_service.create_context.js * region_tag:aiplatform_v1beta1_generated_MetadataService_CreateContext_async @@ -2313,9 +2308,8 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.Context | Context}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.Context|Context}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/metadata_service.get_context.js * region_tag:aiplatform_v1beta1_generated_MetadataService_GetContext_async @@ -2401,21 +2395,20 @@ export class MetadataServiceClient { * The request object that will be sent. * @param {google.cloud.aiplatform.v1beta1.Context} request.context * Required. The Context containing updates. - * The Context's {@link google.cloud.aiplatform.v1beta1.Context.name|Context.name} + * The Context's {@link protos.google.cloud.aiplatform.v1beta1.Context.name|Context.name} * field is used to identify the Context to be updated. Format: * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}` * @param {google.protobuf.FieldMask} [request.updateMask] * Optional. A FieldMask indicating which fields should be updated. * @param {boolean} request.allowMissing - * If set to true, and the {@link google.cloud.aiplatform.v1beta1.Context|Context} - * is not found, a new {@link google.cloud.aiplatform.v1beta1.Context|Context} is + * If set to true, and the {@link protos.google.cloud.aiplatform.v1beta1.Context|Context} + * is not found, a new {@link protos.google.cloud.aiplatform.v1beta1.Context|Context} is * created. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.Context | Context}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.Context|Context}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/metadata_service.update_context.js * region_tag:aiplatform_v1beta1_generated_MetadataService_UpdateContext_async @@ -2519,9 +2512,8 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.AddContextArtifactsAndExecutionsResponse | AddContextArtifactsAndExecutionsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.AddContextArtifactsAndExecutionsResponse|AddContextArtifactsAndExecutionsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/metadata_service.add_context_artifacts_and_executions.js * region_tag:aiplatform_v1beta1_generated_MetadataService_AddContextArtifactsAndExecutions_async @@ -2629,9 +2621,8 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.AddContextChildrenResponse | AddContextChildrenResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.AddContextChildrenResponse|AddContextChildrenResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/metadata_service.add_context_children.js * region_tag:aiplatform_v1beta1_generated_MetadataService_AddContextChildren_async @@ -2733,9 +2724,8 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.RemoveContextChildrenResponse | RemoveContextChildrenResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.RemoveContextChildrenResponse|RemoveContextChildrenResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/metadata_service.remove_context_children.js * region_tag:aiplatform_v1beta1_generated_MetadataService_RemoveContextChildren_async @@ -2838,9 +2828,8 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.LineageSubgraph | LineageSubgraph}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.LineageSubgraph|LineageSubgraph}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/metadata_service.query_context_lineage_subgraph.js * region_tag:aiplatform_v1beta1_generated_MetadataService_QueryContextLineageSubgraph_async @@ -2946,16 +2935,15 @@ export class MetadataServiceClient { * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` * If not provided, the Execution's ID will be a UUID generated by the * service. - * Must be 4-128 characters in length. Valid characters are `/{@link 0-9|a-z}-/`. + * Must be 4-128 characters in length. Valid characters are `/{@link protos.0-9|a-z}-/`. * Must be unique across all Executions in the parent MetadataStore. * (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED * if the caller can't view the preexisting Execution.) * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.Execution | Execution}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.Execution|Execution}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/metadata_service.create_execution.js * region_tag:aiplatform_v1beta1_generated_MetadataService_CreateExecution_async @@ -3052,9 +3040,8 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.Execution | Execution}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.Execution|Execution}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/metadata_service.get_execution.js * region_tag:aiplatform_v1beta1_generated_MetadataService_GetExecution_async @@ -3141,21 +3128,20 @@ export class MetadataServiceClient { * @param {google.cloud.aiplatform.v1beta1.Execution} request.execution * Required. The Execution containing updates. * The Execution's - * {@link google.cloud.aiplatform.v1beta1.Execution.name|Execution.name} field is + * {@link protos.google.cloud.aiplatform.v1beta1.Execution.name|Execution.name} field is * used to identify the Execution to be updated. Format: * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` * @param {google.protobuf.FieldMask} [request.updateMask] * Optional. A FieldMask indicating which fields should be updated. * @param {boolean} request.allowMissing * If set to true, and the - * {@link google.cloud.aiplatform.v1beta1.Execution|Execution} is not found, a new - * {@link google.cloud.aiplatform.v1beta1.Execution|Execution} is created. + * {@link protos.google.cloud.aiplatform.v1beta1.Execution|Execution} is not found, a new + * {@link protos.google.cloud.aiplatform.v1beta1.Execution|Execution} is created. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.Execution | Execution}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.Execution|Execution}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/metadata_service.update_execution.js * region_tag:aiplatform_v1beta1_generated_MetadataService_UpdateExecution_async @@ -3258,9 +3244,8 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.AddExecutionEventsResponse | AddExecutionEventsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.AddExecutionEventsResponse|AddExecutionEventsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/metadata_service.add_execution_events.js * region_tag:aiplatform_v1beta1_generated_MetadataService_AddExecutionEvents_async @@ -3359,9 +3344,8 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.LineageSubgraph | LineageSubgraph}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.LineageSubgraph|LineageSubgraph}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/metadata_service.query_execution_inputs_and_outputs.js * region_tag:aiplatform_v1beta1_generated_MetadataService_QueryExecutionInputsAndOutputs_async @@ -3466,16 +3450,15 @@ export class MetadataServiceClient { * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema}` * If not provided, the MetadataStore's ID will be a UUID generated by the * service. - * Must be 4-128 characters in length. Valid characters are `/{@link 0-9|a-z}-/`. + * Must be 4-128 characters in length. Valid characters are `/{@link protos.0-9|a-z}-/`. * Must be unique across all MetadataSchemas in the parent Location. * (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED * if the caller can't view the preexisting MetadataSchema.) * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.MetadataSchema | MetadataSchema}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.MetadataSchema|MetadataSchema}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/metadata_service.create_metadata_schema.js * region_tag:aiplatform_v1beta1_generated_MetadataService_CreateMetadataSchema_async @@ -3572,9 +3555,8 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.MetadataSchema | MetadataSchema}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.MetadataSchema|MetadataSchema}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/metadata_service.get_metadata_schema.js * region_tag:aiplatform_v1beta1_generated_MetadataService_GetMetadataSchema_async @@ -3708,9 +3690,8 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.LineageSubgraph | LineageSubgraph}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.LineageSubgraph|LineageSubgraph}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/metadata_service.query_artifact_lineage_subgraph.js * region_tag:aiplatform_v1beta1_generated_MetadataService_QueryArtifactLineageSubgraph_async @@ -3816,7 +3797,7 @@ export class MetadataServiceClient { * `projects/{project}/locations/{location}/metadataStores/{metadatastore}` * If not provided, the MetadataStore's ID will be a UUID generated by the * service. - * Must be 4-128 characters in length. Valid characters are `/{@link 0-9|a-z}-/`. + * Must be 4-128 characters in length. Valid characters are `/{@link protos.0-9|a-z}-/`. * Must be unique across all MetadataStores in the parent Location. * (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED * if the caller can't view the preexisting MetadataStore.) @@ -3826,8 +3807,7 @@ export class MetadataServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/metadata_service.create_metadata_store.js * region_tag:aiplatform_v1beta1_generated_MetadataService_CreateMetadataStore_async @@ -3922,8 +3902,7 @@ export class MetadataServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/metadata_service.create_metadata_store.js * region_tag:aiplatform_v1beta1_generated_MetadataService_CreateMetadataStore_async @@ -3969,8 +3948,7 @@ export class MetadataServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/metadata_service.delete_metadata_store.js * region_tag:aiplatform_v1beta1_generated_MetadataService_DeleteMetadataStore_async @@ -4065,8 +4043,7 @@ export class MetadataServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/metadata_service.delete_metadata_store.js * region_tag:aiplatform_v1beta1_generated_MetadataService_DeleteMetadataStore_async @@ -4113,8 +4090,7 @@ export class MetadataServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/metadata_service.delete_artifact.js * region_tag:aiplatform_v1beta1_generated_MetadataService_DeleteArtifact_async @@ -4209,8 +4185,7 @@ export class MetadataServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/metadata_service.delete_artifact.js * region_tag:aiplatform_v1beta1_generated_MetadataService_DeleteArtifact_async @@ -4260,8 +4235,7 @@ export class MetadataServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/metadata_service.purge_artifacts.js * region_tag:aiplatform_v1beta1_generated_MetadataService_PurgeArtifacts_async @@ -4356,8 +4330,7 @@ export class MetadataServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/metadata_service.purge_artifacts.js * region_tag:aiplatform_v1beta1_generated_MetadataService_PurgeArtifacts_async @@ -4407,8 +4380,7 @@ export class MetadataServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/metadata_service.delete_context.js * region_tag:aiplatform_v1beta1_generated_MetadataService_DeleteContext_async @@ -4503,8 +4475,7 @@ export class MetadataServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/metadata_service.delete_context.js * region_tag:aiplatform_v1beta1_generated_MetadataService_DeleteContext_async @@ -4554,8 +4525,7 @@ export class MetadataServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/metadata_service.purge_contexts.js * region_tag:aiplatform_v1beta1_generated_MetadataService_PurgeContexts_async @@ -4650,8 +4620,7 @@ export class MetadataServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/metadata_service.purge_contexts.js * region_tag:aiplatform_v1beta1_generated_MetadataService_PurgeContexts_async @@ -4698,8 +4667,7 @@ export class MetadataServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/metadata_service.delete_execution.js * region_tag:aiplatform_v1beta1_generated_MetadataService_DeleteExecution_async @@ -4794,8 +4762,7 @@ export class MetadataServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/metadata_service.delete_execution.js * region_tag:aiplatform_v1beta1_generated_MetadataService_DeleteExecution_async @@ -4845,8 +4812,7 @@ export class MetadataServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/metadata_service.purge_executions.js * region_tag:aiplatform_v1beta1_generated_MetadataService_PurgeExecutions_async @@ -4941,8 +4907,7 @@ export class MetadataServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/metadata_service.purge_executions.js * region_tag:aiplatform_v1beta1_generated_MetadataService_PurgeExecutions_async @@ -4985,7 +4950,7 @@ export class MetadataServiceClient { * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataStores|MetadataService.ListMetadataStores} + * {@link protos.google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataStores|MetadataService.ListMetadataStores} * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that @@ -4994,14 +4959,13 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1beta1.MetadataStore | MetadataStore}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1beta1.MetadataStore|MetadataStore}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listMetadataStoresAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listMetadataStores( @@ -5093,7 +5057,7 @@ export class MetadataServiceClient { * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataStores|MetadataService.ListMetadataStores} + * {@link protos.google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataStores|MetadataService.ListMetadataStores} * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that @@ -5102,13 +5066,12 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1beta1.MetadataStore | MetadataStore} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1beta1.MetadataStore|MetadataStore} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listMetadataStoresAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listMetadataStoresStream( @@ -5149,7 +5112,7 @@ export class MetadataServiceClient { * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataStores|MetadataService.ListMetadataStores} + * {@link protos.google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataStores|MetadataService.ListMetadataStores} * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that @@ -5158,12 +5121,11 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1beta1.MetadataStore | MetadataStore}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1beta1.MetadataStore|MetadataStore}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/metadata_service.list_metadata_stores.js * region_tag:aiplatform_v1beta1_generated_MetadataService_ListMetadataStores_async @@ -5203,7 +5165,7 @@ export class MetadataServiceClient { * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.MetadataService.ListArtifacts|MetadataService.ListArtifacts} + * {@link protos.google.cloud.aiplatform.v1beta1.MetadataService.ListArtifacts|MetadataService.ListArtifacts} * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that @@ -5251,14 +5213,13 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1beta1.Artifact | Artifact}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1beta1.Artifact|Artifact}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listArtifactsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listArtifacts( @@ -5349,7 +5310,7 @@ export class MetadataServiceClient { * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.MetadataService.ListArtifacts|MetadataService.ListArtifacts} + * {@link protos.google.cloud.aiplatform.v1beta1.MetadataService.ListArtifacts|MetadataService.ListArtifacts} * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that @@ -5397,13 +5358,12 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1beta1.Artifact | Artifact} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1beta1.Artifact|Artifact} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listArtifactsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listArtifactsStream( @@ -5443,7 +5403,7 @@ export class MetadataServiceClient { * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.MetadataService.ListArtifacts|MetadataService.ListArtifacts} + * {@link protos.google.cloud.aiplatform.v1beta1.MetadataService.ListArtifacts|MetadataService.ListArtifacts} * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that @@ -5491,12 +5451,11 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1beta1.Artifact | Artifact}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1beta1.Artifact|Artifact}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/metadata_service.list_artifacts.js * region_tag:aiplatform_v1beta1_generated_MetadataService_ListArtifacts_async @@ -5536,7 +5495,7 @@ export class MetadataServiceClient { * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.MetadataService.ListContexts|MetadataService.ListContexts} + * {@link protos.google.cloud.aiplatform.v1beta1.MetadataService.ListContexts|MetadataService.ListContexts} * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that @@ -5588,14 +5547,13 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1beta1.Context | Context}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1beta1.Context|Context}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listContextsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listContexts( @@ -5686,7 +5644,7 @@ export class MetadataServiceClient { * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.MetadataService.ListContexts|MetadataService.ListContexts} + * {@link protos.google.cloud.aiplatform.v1beta1.MetadataService.ListContexts|MetadataService.ListContexts} * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that @@ -5738,13 +5696,12 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1beta1.Context | Context} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1beta1.Context|Context} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listContextsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listContextsStream( @@ -5784,7 +5741,7 @@ export class MetadataServiceClient { * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.MetadataService.ListContexts|MetadataService.ListContexts} + * {@link protos.google.cloud.aiplatform.v1beta1.MetadataService.ListContexts|MetadataService.ListContexts} * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that @@ -5836,12 +5793,11 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1beta1.Context | Context}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1beta1.Context|Context}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/metadata_service.list_contexts.js * region_tag:aiplatform_v1beta1_generated_MetadataService_ListContexts_async @@ -5881,7 +5837,7 @@ export class MetadataServiceClient { * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.MetadataService.ListExecutions|MetadataService.ListExecutions} + * {@link protos.google.cloud.aiplatform.v1beta1.MetadataService.ListExecutions|MetadataService.ListExecutions} * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that @@ -5929,14 +5885,13 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1beta1.Execution | Execution}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1beta1.Execution|Execution}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listExecutionsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listExecutions( @@ -6027,7 +5982,7 @@ export class MetadataServiceClient { * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.MetadataService.ListExecutions|MetadataService.ListExecutions} + * {@link protos.google.cloud.aiplatform.v1beta1.MetadataService.ListExecutions|MetadataService.ListExecutions} * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that @@ -6075,13 +6030,12 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1beta1.Execution | Execution} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1beta1.Execution|Execution} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listExecutionsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listExecutionsStream( @@ -6121,7 +6075,7 @@ export class MetadataServiceClient { * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.MetadataService.ListExecutions|MetadataService.ListExecutions} + * {@link protos.google.cloud.aiplatform.v1beta1.MetadataService.ListExecutions|MetadataService.ListExecutions} * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that @@ -6169,12 +6123,11 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1beta1.Execution | Execution}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1beta1.Execution|Execution}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/metadata_service.list_executions.js * region_tag:aiplatform_v1beta1_generated_MetadataService_ListExecutions_async @@ -6215,7 +6168,7 @@ export class MetadataServiceClient { * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataSchemas|MetadataService.ListMetadataSchemas} + * {@link protos.google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataSchemas|MetadataService.ListMetadataSchemas} * call. Provide this to retrieve the next page. * * When paginating, all other provided parameters must match the call that @@ -6226,14 +6179,13 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1beta1.MetadataSchema | MetadataSchema}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1beta1.MetadataSchema|MetadataSchema}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listMetadataSchemasAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listMetadataSchemas( @@ -6325,7 +6277,7 @@ export class MetadataServiceClient { * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataSchemas|MetadataService.ListMetadataSchemas} + * {@link protos.google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataSchemas|MetadataService.ListMetadataSchemas} * call. Provide this to retrieve the next page. * * When paginating, all other provided parameters must match the call that @@ -6336,13 +6288,12 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1beta1.MetadataSchema | MetadataSchema} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1beta1.MetadataSchema|MetadataSchema} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listMetadataSchemasAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listMetadataSchemasStream( @@ -6383,7 +6334,7 @@ export class MetadataServiceClient { * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataSchemas|MetadataService.ListMetadataSchemas} + * {@link protos.google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataSchemas|MetadataService.ListMetadataSchemas} * call. Provide this to retrieve the next page. * * When paginating, all other provided parameters must match the call that @@ -6394,12 +6345,11 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1beta1.MetadataSchema | MetadataSchema}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1beta1.MetadataSchema|MetadataSchema}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/metadata_service.list_metadata_schemas.js * region_tag:aiplatform_v1beta1_generated_MetadataService_ListMetadataSchemas_async @@ -6464,7 +6414,7 @@ export class MetadataServiceClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -6485,8 +6435,7 @@ export class MetadataServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -6512,7 +6461,7 @@ export class MetadataServiceClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -6533,8 +6482,7 @@ export class MetadataServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -6561,7 +6509,7 @@ export class MetadataServiceClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -6576,8 +6524,7 @@ export class MetadataServiceClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` @@ -6623,12 +6570,11 @@ export class MetadataServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` diff --git a/packages/google-cloud-aiplatform/src/v1beta1/migration_service_client.ts b/packages/google-cloud-aiplatform/src/v1beta1/migration_service_client.ts index 92ccd0d4dbd..8f73e2df982 100644 --- a/packages/google-cloud-aiplatform/src/v1beta1/migration_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1beta1/migration_service_client.ts @@ -1695,8 +1695,7 @@ export class MigrationServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/migration_service.batch_migrate_resources.js * region_tag:aiplatform_v1beta1_generated_MigrationService_BatchMigrateResources_async @@ -1791,8 +1790,7 @@ export class MigrationServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/migration_service.batch_migrate_resources.js * region_tag:aiplatform_v1beta1_generated_MigrationService_BatchMigrateResources_async @@ -1842,7 +1840,7 @@ export class MigrationServiceClient { * * * Resource type filters. The following strings filter for a specific type * of - * {@link google.cloud.aiplatform.v1beta1.MigratableResource|MigratableResource}: + * {@link protos.google.cloud.aiplatform.v1beta1.MigratableResource|MigratableResource}: * * `ml_engine_model_version:*` * * `automl_model:*` * * `automl_dataset:*` @@ -1854,14 +1852,13 @@ export class MigrationServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1beta1.MigratableResource | MigratableResource}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1beta1.MigratableResource|MigratableResource}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `searchMigratableResourcesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ searchMigratableResources( @@ -1962,7 +1959,7 @@ export class MigrationServiceClient { * * * Resource type filters. The following strings filter for a specific type * of - * {@link google.cloud.aiplatform.v1beta1.MigratableResource|MigratableResource}: + * {@link protos.google.cloud.aiplatform.v1beta1.MigratableResource|MigratableResource}: * * `ml_engine_model_version:*` * * `automl_model:*` * * `automl_dataset:*` @@ -1974,13 +1971,12 @@ export class MigrationServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1beta1.MigratableResource | MigratableResource} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1beta1.MigratableResource|MigratableResource} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `searchMigratableResourcesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ searchMigratableResourcesStream( @@ -2026,7 +2022,7 @@ export class MigrationServiceClient { * * * Resource type filters. The following strings filter for a specific type * of - * {@link google.cloud.aiplatform.v1beta1.MigratableResource|MigratableResource}: + * {@link protos.google.cloud.aiplatform.v1beta1.MigratableResource|MigratableResource}: * * `ml_engine_model_version:*` * * `automl_model:*` * * `automl_dataset:*` @@ -2038,12 +2034,11 @@ export class MigrationServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1beta1.MigratableResource | MigratableResource}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1beta1.MigratableResource|MigratableResource}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/migration_service.search_migratable_resources.js * region_tag:aiplatform_v1beta1_generated_MigrationService_SearchMigratableResources_async @@ -2108,7 +2103,7 @@ export class MigrationServiceClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -2129,8 +2124,7 @@ export class MigrationServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -2156,7 +2150,7 @@ export class MigrationServiceClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -2177,8 +2171,7 @@ export class MigrationServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -2205,7 +2198,7 @@ export class MigrationServiceClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -2220,8 +2213,7 @@ export class MigrationServiceClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` @@ -2267,12 +2259,11 @@ export class MigrationServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` diff --git a/packages/google-cloud-aiplatform/src/v1beta1/model_garden_service_client.ts b/packages/google-cloud-aiplatform/src/v1beta1/model_garden_service_client.ts index 292d037a94f..5d0208d9687 100644 --- a/packages/google-cloud-aiplatform/src/v1beta1/model_garden_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1beta1/model_garden_service_client.ts @@ -459,9 +459,8 @@ export class ModelGardenServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.PublisherModel | PublisherModel}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.PublisherModel|PublisherModel}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/model_garden_service.get_publisher_model.js * region_tag:aiplatform_v1beta1_generated_ModelGardenService_GetPublisherModel_async @@ -586,7 +585,7 @@ export class ModelGardenServiceClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -607,8 +606,7 @@ export class ModelGardenServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -634,7 +632,7 @@ export class ModelGardenServiceClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -655,8 +653,7 @@ export class ModelGardenServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -683,7 +680,7 @@ export class ModelGardenServiceClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -698,8 +695,7 @@ export class ModelGardenServiceClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` @@ -745,12 +741,11 @@ export class ModelGardenServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` diff --git a/packages/google-cloud-aiplatform/src/v1beta1/model_service_client.ts b/packages/google-cloud-aiplatform/src/v1beta1/model_service_client.ts index 50283fe54cc..21af9c062fd 100644 --- a/packages/google-cloud-aiplatform/src/v1beta1/model_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1beta1/model_service_client.ts @@ -1782,9 +1782,8 @@ export class ModelServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.Model | Model}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.Model|Model}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/model_service.get_model.js * region_tag:aiplatform_v1beta1_generated_ModelService_GetModel_async @@ -1890,13 +1889,12 @@ export class ModelServiceClient { * @param {google.protobuf.FieldMask} request.updateMask * Required. The update mask applies to the resource. * For the `FieldMask` definition, see - * {@link google.protobuf.FieldMask|google.protobuf.FieldMask}. + * {@link protos.google.protobuf.FieldMask|google.protobuf.FieldMask}. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.Model | Model}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.Model|Model}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/model_service.update_model.js * region_tag:aiplatform_v1beta1_generated_ModelService_UpdateModel_async @@ -1988,7 +1986,7 @@ export class ModelServiceClient { * @param {string[]} request.versionAliases * Required. The set of version aliases to merge. * The alias should be at most 128 characters, and match - * `{@link a-zA-Z0-9-|a-z}{0,126}[a-z-0-9]`. + * `{@link protos.a-zA-Z0-9-|a-z}{0,126}[a-z-0-9]`. * Add the `-` prefix to an alias means removing that alias from the version. * `-` is NOT counted in the 128 characters. Example: `-golden` means removing * the `golden` alias from the version. @@ -2001,9 +1999,8 @@ export class ModelServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.Model | Model}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.Model|Model}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/model_service.merge_version_aliases.js * region_tag:aiplatform_v1beta1_generated_ModelService_MergeVersionAliases_async @@ -2101,9 +2098,8 @@ export class ModelServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.ModelEvaluation | ModelEvaluation}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.ModelEvaluation|ModelEvaluation}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/model_service.import_model_evaluation.js * region_tag:aiplatform_v1beta1_generated_ModelService_ImportModelEvaluation_async @@ -2202,9 +2198,8 @@ export class ModelServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.BatchImportModelEvaluationSlicesResponse | BatchImportModelEvaluationSlicesResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.BatchImportModelEvaluationSlicesResponse|BatchImportModelEvaluationSlicesResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/model_service.batch_import_model_evaluation_slices.js * region_tag:aiplatform_v1beta1_generated_ModelService_BatchImportModelEvaluationSlices_async @@ -2307,9 +2302,8 @@ export class ModelServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.BatchImportEvaluatedAnnotationsResponse | BatchImportEvaluatedAnnotationsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.BatchImportEvaluatedAnnotationsResponse|BatchImportEvaluatedAnnotationsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/model_service.batch_import_evaluated_annotations.js * region_tag:aiplatform_v1beta1_generated_ModelService_BatchImportEvaluatedAnnotations_async @@ -2410,9 +2404,8 @@ export class ModelServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.ModelEvaluation | ModelEvaluation}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.ModelEvaluation|ModelEvaluation}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/model_service.get_model_evaluation.js * region_tag:aiplatform_v1beta1_generated_ModelService_GetModelEvaluation_async @@ -2509,9 +2502,8 @@ export class ModelServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.ModelEvaluationSlice | ModelEvaluationSlice}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.ModelEvaluationSlice|ModelEvaluationSlice}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/model_service.get_model_evaluation_slice.js * region_tag:aiplatform_v1beta1_generated_ModelService_GetModelEvaluationSlice_async @@ -2634,8 +2626,7 @@ export class ModelServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/model_service.upload_model.js * region_tag:aiplatform_v1beta1_generated_ModelService_UploadModel_async @@ -2730,8 +2721,7 @@ export class ModelServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/model_service.upload_model.js * region_tag:aiplatform_v1beta1_generated_ModelService_UploadModel_async @@ -2775,8 +2765,7 @@ export class ModelServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/model_service.update_explanation_dataset.js * region_tag:aiplatform_v1beta1_generated_ModelService_UpdateExplanationDataset_async @@ -2875,8 +2864,7 @@ export class ModelServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/model_service.update_explanation_dataset.js * region_tag:aiplatform_v1beta1_generated_ModelService_UpdateExplanationDataset_async @@ -2908,10 +2896,10 @@ export class ModelServiceClient { * Deletes a Model. * * A model cannot be deleted if any - * {@link google.cloud.aiplatform.v1beta1.Endpoint|Endpoint} resource has a - * {@link google.cloud.aiplatform.v1beta1.DeployedModel|DeployedModel} based on the + * {@link protos.google.cloud.aiplatform.v1beta1.Endpoint|Endpoint} resource has a + * {@link protos.google.cloud.aiplatform.v1beta1.DeployedModel|DeployedModel} based on the * model in its - * {@link google.cloud.aiplatform.v1beta1.Endpoint.deployed_models|deployed_models} + * {@link protos.google.cloud.aiplatform.v1beta1.Endpoint.deployed_models|deployed_models} * field. * * @param {Object} request @@ -2925,8 +2913,7 @@ export class ModelServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/model_service.delete_model.js * region_tag:aiplatform_v1beta1_generated_ModelService_DeleteModel_async @@ -3021,8 +3008,7 @@ export class ModelServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/model_service.delete_model.js * region_tag:aiplatform_v1beta1_generated_ModelService_DeleteModel_async @@ -3054,9 +3040,9 @@ export class ModelServiceClient { * Deletes a Model version. * * Model version can only be deleted if there are no - * {@link google.cloud.aiplatform.v1beta1.DeployedModel|DeployedModels} created + * {@link protos.google.cloud.aiplatform.v1beta1.DeployedModel|DeployedModels} created * from it. Deleting the only version in the Model is not allowed. Use - * {@link google.cloud.aiplatform.v1beta1.ModelService.DeleteModel|DeleteModel} for + * {@link protos.google.cloud.aiplatform.v1beta1.ModelService.DeleteModel|DeleteModel} for * deleting the Model instead. * * @param {Object} request @@ -3072,8 +3058,7 @@ export class ModelServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/model_service.delete_model_version.js * region_tag:aiplatform_v1beta1_generated_ModelService_DeleteModelVersion_async @@ -3168,8 +3153,7 @@ export class ModelServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/model_service.delete_model_version.js * region_tag:aiplatform_v1beta1_generated_ModelService_DeleteModelVersion_async @@ -3217,8 +3201,7 @@ export class ModelServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/model_service.export_model.js * region_tag:aiplatform_v1beta1_generated_ModelService_ExportModel_async @@ -3313,8 +3296,7 @@ export class ModelServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/model_service.export_model.js * region_tag:aiplatform_v1beta1_generated_ModelService_ExportModel_async @@ -3346,7 +3328,7 @@ export class ModelServiceClient { * Copies an already existing Vertex AI Model into the specified Location. * The source Model must exist in the same Project. * When copying custom Models, the users themselves are responsible for - * {@link google.cloud.aiplatform.v1beta1.Model.metadata|Model.metadata} content to + * {@link protos.google.cloud.aiplatform.v1beta1.Model.metadata|Model.metadata} content to * be region-agnostic, as well as making sure that any resources (e.g. files) * it depends on remain accessible. * @@ -3378,8 +3360,7 @@ export class ModelServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/model_service.copy_model.js * region_tag:aiplatform_v1beta1_generated_ModelService_CopyModel_async @@ -3474,8 +3455,7 @@ export class ModelServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/model_service.copy_model.js * region_tag:aiplatform_v1beta1_generated_ModelService_CopyModel_async @@ -3534,23 +3514,22 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListModelsResponse.next_page_token|ListModelsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListModelsResponse.next_page_token|ListModelsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.ModelService.ListModels|ModelService.ListModels} + * {@link protos.google.cloud.aiplatform.v1beta1.ModelService.ListModels|ModelService.ListModels} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1beta1.Model | Model}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1beta1.Model|Model}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listModelsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listModels( @@ -3658,22 +3637,21 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListModelsResponse.next_page_token|ListModelsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListModelsResponse.next_page_token|ListModelsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.ModelService.ListModels|ModelService.ListModels} + * {@link protos.google.cloud.aiplatform.v1beta1.ModelService.ListModels|ModelService.ListModels} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1beta1.Model | Model} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1beta1.Model|Model} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listModelsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listModelsStream( @@ -3730,21 +3708,20 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListModelsResponse.next_page_token|ListModelsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListModelsResponse.next_page_token|ListModelsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.ModelService.ListModels|ModelService.ListModels} + * {@link protos.google.cloud.aiplatform.v1beta1.ModelService.ListModels|ModelService.ListModels} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1beta1.Model | Model}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1beta1.Model|Model}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/model_service.list_models.js * region_tag:aiplatform_v1beta1_generated_ModelService_ListModels_async @@ -3782,9 +3759,9 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListModelVersionsResponse.next_page_token|next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListModelVersionsResponse.next_page_token|next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.ModelService.ListModelVersions|ListModelVersions} + * {@link protos.google.cloud.aiplatform.v1beta1.ModelService.ListModelVersions|ListModelVersions} * call. * @param {string} request.filter * An expression for filtering the results of the request. For field names @@ -3812,14 +3789,13 @@ export class ModelServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1beta1.Model | Model}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1beta1.Model|Model}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listModelVersionsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listModelVersions( @@ -3908,9 +3884,9 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListModelVersionsResponse.next_page_token|next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListModelVersionsResponse.next_page_token|next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.ModelService.ListModelVersions|ListModelVersions} + * {@link protos.google.cloud.aiplatform.v1beta1.ModelService.ListModelVersions|ListModelVersions} * call. * @param {string} request.filter * An expression for filtering the results of the request. For field names @@ -3938,13 +3914,12 @@ export class ModelServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1beta1.Model | Model} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1beta1.Model|Model} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listModelVersionsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listModelVersionsStream( @@ -3982,9 +3957,9 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListModelVersionsResponse.next_page_token|next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListModelVersionsResponse.next_page_token|next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.ModelService.ListModelVersions|ListModelVersions} + * {@link protos.google.cloud.aiplatform.v1beta1.ModelService.ListModelVersions|ListModelVersions} * call. * @param {string} request.filter * An expression for filtering the results of the request. For field names @@ -4012,12 +3987,11 @@ export class ModelServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1beta1.Model | Model}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1beta1.Model|Model}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/model_service.list_model_versions.js * region_tag:aiplatform_v1beta1_generated_ModelService_ListModelVersions_async @@ -4058,23 +4032,22 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListModelEvaluationsResponse.next_page_token|ListModelEvaluationsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListModelEvaluationsResponse.next_page_token|ListModelEvaluationsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluations|ModelService.ListModelEvaluations} + * {@link protos.google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluations|ModelService.ListModelEvaluations} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1beta1.ModelEvaluation | ModelEvaluation}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1beta1.ModelEvaluation|ModelEvaluation}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listModelEvaluationsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listModelEvaluations( @@ -4166,22 +4139,21 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListModelEvaluationsResponse.next_page_token|ListModelEvaluationsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListModelEvaluationsResponse.next_page_token|ListModelEvaluationsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluations|ModelService.ListModelEvaluations} + * {@link protos.google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluations|ModelService.ListModelEvaluations} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1beta1.ModelEvaluation | ModelEvaluation} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1beta1.ModelEvaluation|ModelEvaluation} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listModelEvaluationsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listModelEvaluationsStream( @@ -4222,21 +4194,20 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListModelEvaluationsResponse.next_page_token|ListModelEvaluationsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListModelEvaluationsResponse.next_page_token|ListModelEvaluationsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluations|ModelService.ListModelEvaluations} + * {@link protos.google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluations|ModelService.ListModelEvaluations} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1beta1.ModelEvaluation | ModelEvaluation}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1beta1.ModelEvaluation|ModelEvaluation}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/model_service.list_model_evaluations.js * region_tag:aiplatform_v1beta1_generated_ModelService_ListModelEvaluations_async @@ -4280,23 +4251,22 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListModelEvaluationSlicesResponse.next_page_token|ListModelEvaluationSlicesResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListModelEvaluationSlicesResponse.next_page_token|ListModelEvaluationSlicesResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluationSlices|ModelService.ListModelEvaluationSlices} + * {@link protos.google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluationSlices|ModelService.ListModelEvaluationSlices} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1beta1.ModelEvaluationSlice | ModelEvaluationSlice}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1beta1.ModelEvaluationSlice|ModelEvaluationSlice}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listModelEvaluationSlicesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listModelEvaluationSlices( @@ -4395,22 +4365,21 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListModelEvaluationSlicesResponse.next_page_token|ListModelEvaluationSlicesResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListModelEvaluationSlicesResponse.next_page_token|ListModelEvaluationSlicesResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluationSlices|ModelService.ListModelEvaluationSlices} + * {@link protos.google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluationSlices|ModelService.ListModelEvaluationSlices} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1beta1.ModelEvaluationSlice | ModelEvaluationSlice} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1beta1.ModelEvaluationSlice|ModelEvaluationSlice} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listModelEvaluationSlicesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listModelEvaluationSlicesStream( @@ -4454,21 +4423,20 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListModelEvaluationSlicesResponse.next_page_token|ListModelEvaluationSlicesResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListModelEvaluationSlicesResponse.next_page_token|ListModelEvaluationSlicesResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluationSlices|ModelService.ListModelEvaluationSlices} + * {@link protos.google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluationSlices|ModelService.ListModelEvaluationSlices} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1beta1.ModelEvaluationSlice | ModelEvaluationSlice}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1beta1.ModelEvaluationSlice|ModelEvaluationSlice}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/model_service.list_model_evaluation_slices.js * region_tag:aiplatform_v1beta1_generated_ModelService_ListModelEvaluationSlices_async @@ -4533,7 +4501,7 @@ export class ModelServiceClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -4554,8 +4522,7 @@ export class ModelServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -4581,7 +4548,7 @@ export class ModelServiceClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -4602,8 +4569,7 @@ export class ModelServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -4630,7 +4596,7 @@ export class ModelServiceClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -4645,8 +4611,7 @@ export class ModelServiceClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` @@ -4692,12 +4657,11 @@ export class ModelServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` diff --git a/packages/google-cloud-aiplatform/src/v1beta1/persistent_resource_service_client.ts b/packages/google-cloud-aiplatform/src/v1beta1/persistent_resource_service_client.ts index 83c30e1bca6..30b6c401dbf 100644 --- a/packages/google-cloud-aiplatform/src/v1beta1/persistent_resource_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1beta1/persistent_resource_service_client.ts @@ -1706,9 +1706,8 @@ export class PersistentResourceServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.PersistentResource | PersistentResource}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.PersistentResource|PersistentResource}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/persistent_resource_service.get_persistent_resource.js * region_tag:aiplatform_v1beta1_generated_PersistentResourceService_GetPersistentResource_async @@ -1816,8 +1815,7 @@ export class PersistentResourceServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/persistent_resource_service.create_persistent_resource.js * region_tag:aiplatform_v1beta1_generated_PersistentResourceService_CreatePersistentResource_async @@ -1916,8 +1914,7 @@ export class PersistentResourceServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/persistent_resource_service.create_persistent_resource.js * region_tag:aiplatform_v1beta1_generated_PersistentResourceService_CreatePersistentResource_async @@ -1960,8 +1957,7 @@ export class PersistentResourceServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/persistent_resource_service.delete_persistent_resource.js * region_tag:aiplatform_v1beta1_generated_PersistentResourceService_DeletePersistentResource_async @@ -2060,8 +2056,7 @@ export class PersistentResourceServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/persistent_resource_service.delete_persistent_resource.js * region_tag:aiplatform_v1beta1_generated_PersistentResourceService_DeletePersistentResource_async @@ -2102,19 +2097,18 @@ export class PersistentResourceServiceClient { * @param {string} [request.pageToken] * Optional. The standard list page token. * Typically obtained via - * {@link |ListPersistentResourceResponse.next_page_token} of the previous - * {@link |PersistentResourceService.ListPersistentResource} call. + * {@link protos.|ListPersistentResourceResponse.next_page_token} of the previous + * {@link protos.|PersistentResourceService.ListPersistentResource} call. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1beta1.PersistentResource | PersistentResource}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1beta1.PersistentResource|PersistentResource}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listPersistentResourcesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listPersistentResources( @@ -2208,18 +2202,17 @@ export class PersistentResourceServiceClient { * @param {string} [request.pageToken] * Optional. The standard list page token. * Typically obtained via - * {@link |ListPersistentResourceResponse.next_page_token} of the previous - * {@link |PersistentResourceService.ListPersistentResource} call. + * {@link protos.|ListPersistentResourceResponse.next_page_token} of the previous + * {@link protos.|PersistentResourceService.ListPersistentResource} call. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1beta1.PersistentResource | PersistentResource} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1beta1.PersistentResource|PersistentResource} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listPersistentResourcesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listPersistentResourcesStream( @@ -2258,17 +2251,16 @@ export class PersistentResourceServiceClient { * @param {string} [request.pageToken] * Optional. The standard list page token. * Typically obtained via - * {@link |ListPersistentResourceResponse.next_page_token} of the previous - * {@link |PersistentResourceService.ListPersistentResource} call. + * {@link protos.|ListPersistentResourceResponse.next_page_token} of the previous + * {@link protos.|PersistentResourceService.ListPersistentResource} call. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1beta1.PersistentResource | PersistentResource}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1beta1.PersistentResource|PersistentResource}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/persistent_resource_service.list_persistent_resources.js * region_tag:aiplatform_v1beta1_generated_PersistentResourceService_ListPersistentResources_async @@ -2333,7 +2325,7 @@ export class PersistentResourceServiceClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -2354,8 +2346,7 @@ export class PersistentResourceServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -2381,7 +2372,7 @@ export class PersistentResourceServiceClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -2402,8 +2393,7 @@ export class PersistentResourceServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -2430,7 +2420,7 @@ export class PersistentResourceServiceClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -2445,8 +2435,7 @@ export class PersistentResourceServiceClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` @@ -2492,12 +2481,11 @@ export class PersistentResourceServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` diff --git a/packages/google-cloud-aiplatform/src/v1beta1/pipeline_service_client.ts b/packages/google-cloud-aiplatform/src/v1beta1/pipeline_service_client.ts index 6b3f2031d28..6387f279eae 100644 --- a/packages/google-cloud-aiplatform/src/v1beta1/pipeline_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1beta1/pipeline_service_client.ts @@ -1715,9 +1715,8 @@ export class PipelineServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.TrainingPipeline | TrainingPipeline}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.TrainingPipeline|TrainingPipeline}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/pipeline_service.create_training_pipeline.js * region_tag:aiplatform_v1beta1_generated_PipelineService_CreateTrainingPipeline_async @@ -1818,9 +1817,8 @@ export class PipelineServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.TrainingPipeline | TrainingPipeline}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.TrainingPipeline|TrainingPipeline}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/pipeline_service.get_training_pipeline.js * region_tag:aiplatform_v1beta1_generated_PipelineService_GetTrainingPipeline_async @@ -1910,15 +1908,15 @@ export class PipelineServiceClient { * Starts asynchronous cancellation on the TrainingPipeline. The server * makes a best effort to cancel the pipeline, but success is not * guaranteed. Clients can use - * {@link google.cloud.aiplatform.v1beta1.PipelineService.GetTrainingPipeline|PipelineService.GetTrainingPipeline} + * {@link protos.google.cloud.aiplatform.v1beta1.PipelineService.GetTrainingPipeline|PipelineService.GetTrainingPipeline} * or other methods to check whether the cancellation succeeded or whether the * pipeline completed despite cancellation. On successful cancellation, * the TrainingPipeline is not deleted; instead it becomes a pipeline with * a - * {@link google.cloud.aiplatform.v1beta1.TrainingPipeline.error|TrainingPipeline.error} - * value with a {@link google.rpc.Status.code|google.rpc.Status.code} of 1, + * {@link protos.google.cloud.aiplatform.v1beta1.TrainingPipeline.error|TrainingPipeline.error} + * value with a {@link protos.google.rpc.Status.code|google.rpc.Status.code} of 1, * corresponding to `Code.CANCELLED`, and - * {@link google.cloud.aiplatform.v1beta1.TrainingPipeline.state|TrainingPipeline.state} + * {@link protos.google.cloud.aiplatform.v1beta1.TrainingPipeline.state|TrainingPipeline.state} * is set to `CANCELLED`. * * @param {Object} request @@ -1930,9 +1928,8 @@ export class PipelineServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.protobuf.Empty | Empty}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/pipeline_service.cancel_training_pipeline.js * region_tag:aiplatform_v1beta1_generated_PipelineService_CancelTrainingPipeline_async @@ -2037,13 +2034,12 @@ export class PipelineServiceClient { * generated. * * This value should be less than 128 characters, and valid characters - * are /{@link 0-9|a-z}-/. + * are /{@link protos.0-9|a-z}-/. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.PipelineJob | PipelineJob}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.PipelineJob|PipelineJob}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/pipeline_service.create_pipeline_job.js * region_tag:aiplatform_v1beta1_generated_PipelineService_CreatePipelineJob_async @@ -2140,9 +2136,8 @@ export class PipelineServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.PipelineJob | PipelineJob}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.PipelineJob|PipelineJob}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/pipeline_service.get_pipeline_job.js * region_tag:aiplatform_v1beta1_generated_PipelineService_GetPipelineJob_async @@ -2226,14 +2221,14 @@ export class PipelineServiceClient { * Starts asynchronous cancellation on the PipelineJob. The server * makes a best effort to cancel the pipeline, but success is not * guaranteed. Clients can use - * {@link google.cloud.aiplatform.v1beta1.PipelineService.GetPipelineJob|PipelineService.GetPipelineJob} + * {@link protos.google.cloud.aiplatform.v1beta1.PipelineService.GetPipelineJob|PipelineService.GetPipelineJob} * or other methods to check whether the cancellation succeeded or whether the * pipeline completed despite cancellation. On successful cancellation, * the PipelineJob is not deleted; instead it becomes a pipeline with - * a {@link google.cloud.aiplatform.v1beta1.PipelineJob.error|PipelineJob.error} - * value with a {@link google.rpc.Status.code|google.rpc.Status.code} of 1, + * a {@link protos.google.cloud.aiplatform.v1beta1.PipelineJob.error|PipelineJob.error} + * value with a {@link protos.google.rpc.Status.code|google.rpc.Status.code} of 1, * corresponding to `Code.CANCELLED`, and - * {@link google.cloud.aiplatform.v1beta1.PipelineJob.state|PipelineJob.state} is + * {@link protos.google.cloud.aiplatform.v1beta1.PipelineJob.state|PipelineJob.state} is * set to `CANCELLED`. * * @param {Object} request @@ -2245,9 +2240,8 @@ export class PipelineServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.protobuf.Empty | Empty}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/pipeline_service.cancel_pipeline_job.js * region_tag:aiplatform_v1beta1_generated_PipelineService_CancelPipelineJob_async @@ -2348,8 +2342,7 @@ export class PipelineServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/pipeline_service.delete_training_pipeline.js * region_tag:aiplatform_v1beta1_generated_PipelineService_DeleteTrainingPipeline_async @@ -2448,8 +2441,7 @@ export class PipelineServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/pipeline_service.delete_training_pipeline.js * region_tag:aiplatform_v1beta1_generated_PipelineService_DeleteTrainingPipeline_async @@ -2492,8 +2484,7 @@ export class PipelineServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/pipeline_service.delete_pipeline_job.js * region_tag:aiplatform_v1beta1_generated_PipelineService_DeletePipelineJob_async @@ -2588,8 +2579,7 @@ export class PipelineServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/pipeline_service.delete_pipeline_job.js * region_tag:aiplatform_v1beta1_generated_PipelineService_DeletePipelineJob_async @@ -2651,23 +2641,22 @@ export class PipelineServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListTrainingPipelinesResponse.next_page_token|ListTrainingPipelinesResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListTrainingPipelinesResponse.next_page_token|ListTrainingPipelinesResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.PipelineService.ListTrainingPipelines|PipelineService.ListTrainingPipelines} + * {@link protos.google.cloud.aiplatform.v1beta1.PipelineService.ListTrainingPipelines|PipelineService.ListTrainingPipelines} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1beta1.TrainingPipeline | TrainingPipeline}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1beta1.TrainingPipeline|TrainingPipeline}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listTrainingPipelinesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listTrainingPipelines( @@ -2778,22 +2767,21 @@ export class PipelineServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListTrainingPipelinesResponse.next_page_token|ListTrainingPipelinesResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListTrainingPipelinesResponse.next_page_token|ListTrainingPipelinesResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.PipelineService.ListTrainingPipelines|PipelineService.ListTrainingPipelines} + * {@link protos.google.cloud.aiplatform.v1beta1.PipelineService.ListTrainingPipelines|PipelineService.ListTrainingPipelines} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1beta1.TrainingPipeline | TrainingPipeline} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1beta1.TrainingPipeline|TrainingPipeline} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listTrainingPipelinesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listTrainingPipelinesStream( @@ -2853,21 +2841,20 @@ export class PipelineServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListTrainingPipelinesResponse.next_page_token|ListTrainingPipelinesResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListTrainingPipelinesResponse.next_page_token|ListTrainingPipelinesResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.PipelineService.ListTrainingPipelines|PipelineService.ListTrainingPipelines} + * {@link protos.google.cloud.aiplatform.v1beta1.PipelineService.ListTrainingPipelines|PipelineService.ListTrainingPipelines} * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1beta1.TrainingPipeline | TrainingPipeline}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1beta1.TrainingPipeline|TrainingPipeline}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/pipeline_service.list_training_pipelines.js * region_tag:aiplatform_v1beta1_generated_PipelineService_ListTrainingPipelines_async @@ -2941,9 +2928,9 @@ export class PipelineServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListPipelineJobsResponse.next_page_token|ListPipelineJobsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListPipelineJobsResponse.next_page_token|ListPipelineJobsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.PipelineService.ListPipelineJobs|PipelineService.ListPipelineJobs} + * {@link protos.google.cloud.aiplatform.v1beta1.PipelineService.ListPipelineJobs|PipelineService.ListPipelineJobs} * call. * @param {string} request.orderBy * A comma-separated list of fields to order by. The default sort order is in @@ -2964,14 +2951,13 @@ export class PipelineServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1beta1.PipelineJob | PipelineJob}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1beta1.PipelineJob|PipelineJob}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listPipelineJobsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listPipelineJobs( @@ -3096,9 +3082,9 @@ export class PipelineServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListPipelineJobsResponse.next_page_token|ListPipelineJobsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListPipelineJobsResponse.next_page_token|ListPipelineJobsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.PipelineService.ListPipelineJobs|PipelineService.ListPipelineJobs} + * {@link protos.google.cloud.aiplatform.v1beta1.PipelineService.ListPipelineJobs|PipelineService.ListPipelineJobs} * call. * @param {string} request.orderBy * A comma-separated list of fields to order by. The default sort order is in @@ -3119,13 +3105,12 @@ export class PipelineServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1beta1.PipelineJob | PipelineJob} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1beta1.PipelineJob|PipelineJob} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listPipelineJobsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listPipelineJobsStream( @@ -3199,9 +3184,9 @@ export class PipelineServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListPipelineJobsResponse.next_page_token|ListPipelineJobsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListPipelineJobsResponse.next_page_token|ListPipelineJobsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.PipelineService.ListPipelineJobs|PipelineService.ListPipelineJobs} + * {@link protos.google.cloud.aiplatform.v1beta1.PipelineService.ListPipelineJobs|PipelineService.ListPipelineJobs} * call. * @param {string} request.orderBy * A comma-separated list of fields to order by. The default sort order is in @@ -3222,12 +3207,11 @@ export class PipelineServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1beta1.PipelineJob | PipelineJob}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1beta1.PipelineJob|PipelineJob}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/pipeline_service.list_pipeline_jobs.js * region_tag:aiplatform_v1beta1_generated_PipelineService_ListPipelineJobs_async @@ -3292,7 +3276,7 @@ export class PipelineServiceClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -3313,8 +3297,7 @@ export class PipelineServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -3340,7 +3323,7 @@ export class PipelineServiceClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -3361,8 +3344,7 @@ export class PipelineServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -3389,7 +3371,7 @@ export class PipelineServiceClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -3404,8 +3386,7 @@ export class PipelineServiceClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` @@ -3451,12 +3432,11 @@ export class PipelineServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` diff --git a/packages/google-cloud-aiplatform/src/v1beta1/prediction_service_client.ts b/packages/google-cloud-aiplatform/src/v1beta1/prediction_service_client.ts index 2fbbb6f703a..a665792d991 100644 --- a/packages/google-cloud-aiplatform/src/v1beta1/prediction_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1beta1/prediction_service_client.ts @@ -28,7 +28,7 @@ import type { LocationsClient, LocationProtos, } from 'google-gax'; - +import {PassThrough} from 'stream'; import * as protos from '../../protos/protos'; import jsonProtos = require('../../protos/protos.json'); /** @@ -309,6 +309,15 @@ export class PredictionServiceClient { ), }; + // Some of the methods on this service provide streaming responses. + // Provide descriptors for these. + this.descriptors.stream = { + serverStreamingPredict: new this._gaxModule.StreamDescriptor( + this._gaxModule.StreamType.SERVER_STREAMING, + opts.fallback === 'rest' + ), + }; + // Put together the default options sent with requests. this._defaults = this._gaxGrpc.constructSettings( 'google.cloud.aiplatform.v1beta1.PredictionService', @@ -359,12 +368,29 @@ export class PredictionServiceClient { // Iterate over each of the methods that the service provides // and create an API call method for each. - const predictionServiceStubMethods = ['predict', 'rawPredict', 'explain']; + const predictionServiceStubMethods = [ + 'predict', + 'rawPredict', + 'serverStreamingPredict', + 'explain', + ]; for (const methodName of predictionServiceStubMethods) { const callPromise = this.predictionServiceStub.then( stub => (...args: Array<{}>) => { if (this._terminated) { + if (methodName in this.descriptors.stream) { + const stream = new PassThrough(); + setImmediate(() => { + stream.emit( + 'error', + new this._gaxModule.GoogleError( + 'The client has already been closed.' + ) + ); + }); + return stream; + } return Promise.reject('The client has already been closed.'); } const func = stub[methodName]; @@ -375,7 +401,7 @@ export class PredictionServiceClient { } ); - const descriptor = undefined; + const descriptor = this.descriptors.stream[methodName] || undefined; const apiCall = this._gaxModule.createApiCall( callPromise, this._defaults[methodName], @@ -459,21 +485,20 @@ export class PredictionServiceClient { * behaviour is as documented by that Model. * The schema of any single instance may be specified via Endpoint's * DeployedModels' - * {@link google.cloud.aiplatform.v1beta1.DeployedModel.model|Model's} - * {@link google.cloud.aiplatform.v1beta1.Model.predict_schemata|PredictSchemata's} - * {@link google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri|instance_schema_uri}. + * {@link protos.google.cloud.aiplatform.v1beta1.DeployedModel.model|Model's} + * {@link protos.google.cloud.aiplatform.v1beta1.Model.predict_schemata|PredictSchemata's} + * {@link protos.google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri|instance_schema_uri}. * @param {google.protobuf.Value} request.parameters * The parameters that govern the prediction. The schema of the parameters may * be specified via Endpoint's DeployedModels' [Model's * ][google.cloud.aiplatform.v1beta1.DeployedModel.model] - * {@link google.cloud.aiplatform.v1beta1.Model.predict_schemata|PredictSchemata's} - * {@link google.cloud.aiplatform.v1beta1.PredictSchemata.parameters_schema_uri|parameters_schema_uri}. + * {@link protos.google.cloud.aiplatform.v1beta1.Model.predict_schemata|PredictSchemata's} + * {@link protos.google.cloud.aiplatform.v1beta1.PredictSchemata.parameters_schema_uri|parameters_schema_uri}. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.PredictResponse | PredictResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.PredictResponse|PredictResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/prediction_service.predict.js * region_tag:aiplatform_v1beta1_generated_PredictionService_Predict_async @@ -552,11 +577,11 @@ export class PredictionServiceClient { * The response includes the following HTTP headers: * * * `X-Vertex-AI-Endpoint-Id`: ID of the - * {@link google.cloud.aiplatform.v1beta1.Endpoint|Endpoint} that served this + * {@link protos.google.cloud.aiplatform.v1beta1.Endpoint|Endpoint} that served this * prediction. * * * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's - * {@link google.cloud.aiplatform.v1beta1.DeployedModel|DeployedModel} that served + * {@link protos.google.cloud.aiplatform.v1beta1.DeployedModel|DeployedModel} that served * this prediction. * * @param {Object} request @@ -568,25 +593,24 @@ export class PredictionServiceClient { * @param {google.api.HttpBody} request.httpBody * The prediction input. Supports HTTP headers and arbitrary data payload. * - * A {@link google.cloud.aiplatform.v1beta1.DeployedModel|DeployedModel} may have + * A {@link protos.google.cloud.aiplatform.v1beta1.DeployedModel|DeployedModel} may have * an upper limit on the number of instances it supports per request. When * this limit it is exceeded for an AutoML model, the - * {@link google.cloud.aiplatform.v1beta1.PredictionService.RawPredict|RawPredict} + * {@link protos.google.cloud.aiplatform.v1beta1.PredictionService.RawPredict|RawPredict} * method returns an error. When this limit is exceeded for a custom-trained * model, the behavior varies depending on the model. * * You can specify the schema for each instance in the - * {@link google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri|predict_schemata.instance_schema_uri} - * field when you create a {@link google.cloud.aiplatform.v1beta1.Model|Model}. + * {@link protos.google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri|predict_schemata.instance_schema_uri} + * field when you create a {@link protos.google.cloud.aiplatform.v1beta1.Model|Model}. * This schema applies when you deploy the `Model` as a `DeployedModel` to an - * {@link google.cloud.aiplatform.v1beta1.Endpoint|Endpoint} and use the + * {@link protos.google.cloud.aiplatform.v1beta1.Endpoint|Endpoint} and use the * `RawPredict` method. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.api.HttpBody | HttpBody}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.api.HttpBody|HttpBody}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/prediction_service.raw_predict.js * region_tag:aiplatform_v1beta1_generated_PredictionService_RawPredict_async @@ -669,13 +693,13 @@ export class PredictionServiceClient { * Perform an online explanation. * * If - * {@link google.cloud.aiplatform.v1beta1.ExplainRequest.deployed_model_id|deployed_model_id} + * {@link protos.google.cloud.aiplatform.v1beta1.ExplainRequest.deployed_model_id|deployed_model_id} * is specified, the corresponding DeployModel must have - * {@link google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec|explanation_spec} + * {@link protos.google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec|explanation_spec} * populated. If - * {@link google.cloud.aiplatform.v1beta1.ExplainRequest.deployed_model_id|deployed_model_id} + * {@link protos.google.cloud.aiplatform.v1beta1.ExplainRequest.deployed_model_id|deployed_model_id} * is not specified, all DeployedModels must have - * {@link google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec|explanation_spec} + * {@link protos.google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec|explanation_spec} * populated. * * @param {Object} request @@ -692,18 +716,18 @@ export class PredictionServiceClient { * behaviour is as documented by that Model. * The schema of any single instance may be specified via Endpoint's * DeployedModels' - * {@link google.cloud.aiplatform.v1beta1.DeployedModel.model|Model's} - * {@link google.cloud.aiplatform.v1beta1.Model.predict_schemata|PredictSchemata's} - * {@link google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri|instance_schema_uri}. + * {@link protos.google.cloud.aiplatform.v1beta1.DeployedModel.model|Model's} + * {@link protos.google.cloud.aiplatform.v1beta1.Model.predict_schemata|PredictSchemata's} + * {@link protos.google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri|instance_schema_uri}. * @param {google.protobuf.Value} request.parameters * The parameters that govern the prediction. The schema of the parameters may * be specified via Endpoint's DeployedModels' [Model's * ][google.cloud.aiplatform.v1beta1.DeployedModel.model] - * {@link google.cloud.aiplatform.v1beta1.Model.predict_schemata|PredictSchemata's} - * {@link google.cloud.aiplatform.v1beta1.PredictSchemata.parameters_schema_uri|parameters_schema_uri}. + * {@link protos.google.cloud.aiplatform.v1beta1.Model.predict_schemata|PredictSchemata's} + * {@link protos.google.cloud.aiplatform.v1beta1.PredictSchemata.parameters_schema_uri|parameters_schema_uri}. * @param {google.cloud.aiplatform.v1beta1.ExplanationSpecOverride} request.explanationSpecOverride * If specified, overrides the - * {@link google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec|explanation_spec} + * {@link protos.google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec|explanation_spec} * of the DeployedModel. Can be used for explaining prediction results with * different configurations, such as: * - Explaining top-5 predictions results as opposed to top-1; @@ -713,13 +737,12 @@ export class PredictionServiceClient { * @param {string} request.deployedModelId * If specified, this ExplainRequest will be served by the chosen * DeployedModel, overriding - * {@link google.cloud.aiplatform.v1beta1.Endpoint.traffic_split|Endpoint.traffic_split}. + * {@link protos.google.cloud.aiplatform.v1beta1.Endpoint.traffic_split|Endpoint.traffic_split}. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.ExplainResponse | ExplainResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.ExplainResponse|ExplainResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/prediction_service.explain.js * region_tag:aiplatform_v1beta1_generated_PredictionService_Explain_async @@ -793,6 +816,45 @@ export class PredictionServiceClient { return this.innerApiCalls.explain(request, options, callback); } + /** + * Perform a server-side streaming online prediction request for Vertex + * LLM streaming. + * + * @param {Object} request + * The request object that will be sent. + * @param {string} request.endpoint + * Required. The name of the Endpoint requested to serve the prediction. + * Format: + * `projects/{project}/locations/{location}/endpoints/{endpoint}` + * @param {number[]} request.inputs + * The prediction input. + * @param {google.cloud.aiplatform.v1beta1.Tensor} request.parameters + * The parameters that govern the prediction. + * @param {object} [options] + * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. + * @returns {Stream} + * An object stream which emits {@link protos.google.cloud.aiplatform.v1beta1.StreamingPredictResponse|StreamingPredictResponse} on 'data' event. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#server-streaming | documentation } + * for more details and examples. + * @example include:samples/generated/v1beta1/prediction_service.server_streaming_predict.js + * region_tag:aiplatform_v1beta1_generated_PredictionService_ServerStreamingPredict_async + */ + serverStreamingPredict( + request?: protos.google.cloud.aiplatform.v1beta1.IStreamingPredictRequest, + options?: CallOptions + ): gax.CancellableStream { + request = request || {}; + options = options || {}; + options.otherArgs = options.otherArgs || {}; + options.otherArgs.headers = options.otherArgs.headers || {}; + options.otherArgs.headers['x-goog-request-params'] = + this._gaxModule.routingHeader.fromParams({ + endpoint: request.endpoint ?? '', + }); + this.initialize(); + return this.innerApiCalls.serverStreamingPredict(request, options); + } + /** * Gets the access control policy for a resource. Returns an empty policy * if the resource exists and does not have a policy set. @@ -832,7 +894,7 @@ export class PredictionServiceClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -853,8 +915,7 @@ export class PredictionServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -880,7 +941,7 @@ export class PredictionServiceClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -901,8 +962,7 @@ export class PredictionServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -929,7 +989,7 @@ export class PredictionServiceClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -944,8 +1004,7 @@ export class PredictionServiceClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` @@ -991,12 +1050,11 @@ export class PredictionServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` diff --git a/packages/google-cloud-aiplatform/src/v1beta1/prediction_service_client_config.json b/packages/google-cloud-aiplatform/src/v1beta1/prediction_service_client_config.json index 475b31fcf31..12951f8814e 100644 --- a/packages/google-cloud-aiplatform/src/v1beta1/prediction_service_client_config.json +++ b/packages/google-cloud-aiplatform/src/v1beta1/prediction_service_client_config.json @@ -29,6 +29,10 @@ "retry_codes_name": "non_idempotent", "retry_params_name": "default" }, + "ServerStreamingPredict": { + "retry_codes_name": "non_idempotent", + "retry_params_name": "default" + }, "Explain": { "timeout_millis": 5000, "retry_codes_name": "non_idempotent", diff --git a/packages/google-cloud-aiplatform/src/v1beta1/schedule_service_client.ts b/packages/google-cloud-aiplatform/src/v1beta1/schedule_service_client.ts index 7f8bb1c63a0..b1646403493 100644 --- a/packages/google-cloud-aiplatform/src/v1beta1/schedule_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1beta1/schedule_service_client.ts @@ -1690,9 +1690,8 @@ export class ScheduleServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.Schedule | Schedule}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.Schedule|Schedule}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/schedule_service.create_schedule.js * region_tag:aiplatform_v1beta1_generated_ScheduleService_CreateSchedule_async @@ -1783,9 +1782,8 @@ export class ScheduleServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.Schedule | Schedule}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.Schedule|Schedule}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/schedule_service.get_schedule.js * region_tag:aiplatform_v1beta1_generated_ScheduleService_GetSchedule_async @@ -1866,7 +1864,7 @@ export class ScheduleServiceClient { } /** * Pauses a Schedule. Will mark - * {@link google.cloud.aiplatform.v1beta1.Schedule.state|Schedule.state} to + * {@link protos.google.cloud.aiplatform.v1beta1.Schedule.state|Schedule.state} to * 'PAUSED'. If the schedule is paused, no new runs will be created. Already * created runs will NOT be paused or canceled. * @@ -1879,9 +1877,8 @@ export class ScheduleServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.protobuf.Empty | Empty}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/schedule_service.pause_schedule.js * region_tag:aiplatform_v1beta1_generated_ScheduleService_PauseSchedule_async @@ -1962,12 +1959,12 @@ export class ScheduleServiceClient { } /** * Resumes a paused Schedule to start scheduling new runs. Will mark - * {@link google.cloud.aiplatform.v1beta1.Schedule.state|Schedule.state} to + * {@link protos.google.cloud.aiplatform.v1beta1.Schedule.state|Schedule.state} to * 'ACTIVE'. Only paused Schedule can be resumed. * * When the Schedule is resumed, new runs will be scheduled starting from the * next execution time after the current time based on the time_specification - * in the Schedule. If {@link |Schedule.catchUp} is set up true, all + * in the Schedule. If {@link protos.|Schedule.catchUp} is set up true, all * missed runs will be scheduled for backfill first. * * @param {Object} request @@ -1980,14 +1977,13 @@ export class ScheduleServiceClient { * Optional. Whether to backfill missed runs when the schedule is resumed from * PAUSED state. If set to true, all missed runs will be scheduled. New runs * will be scheduled after the backfill is complete. This will also update - * {@link google.cloud.aiplatform.v1beta1.Schedule.catch_up|Schedule.catch_up} + * {@link protos.google.cloud.aiplatform.v1beta1.Schedule.catch_up|Schedule.catch_up} * field. Default to false. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.protobuf.Empty | Empty}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/schedule_service.resume_schedule.js * region_tag:aiplatform_v1beta1_generated_ScheduleService_ResumeSchedule_async @@ -2084,13 +2080,12 @@ export class ScheduleServiceClient { * * The output_only fields will be ignored if specified. * @param {google.protobuf.FieldMask} request.updateMask * Required. The update mask applies to the resource. See - * {@link google.protobuf.FieldMask|google.protobuf.FieldMask}. + * {@link protos.google.protobuf.FieldMask|google.protobuf.FieldMask}. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.Schedule | Schedule}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.Schedule|Schedule}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/schedule_service.update_schedule.js * region_tag:aiplatform_v1beta1_generated_ScheduleService_UpdateSchedule_async @@ -2185,8 +2180,7 @@ export class ScheduleServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/schedule_service.delete_schedule.js * region_tag:aiplatform_v1beta1_generated_ScheduleService_DeleteSchedule_async @@ -2281,8 +2275,7 @@ export class ScheduleServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/schedule_service.delete_schedule.js * region_tag:aiplatform_v1beta1_generated_ScheduleService_DeleteSchedule_async @@ -2355,9 +2348,9 @@ export class ScheduleServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListSchedulesResponse.next_page_token|ListSchedulesResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListSchedulesResponse.next_page_token|ListSchedulesResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.ScheduleService.ListSchedules|ScheduleService.ListSchedules} + * {@link protos.google.cloud.aiplatform.v1beta1.ScheduleService.ListSchedules|ScheduleService.ListSchedules} * call. * @param {string} request.orderBy * A comma-separated list of fields to order by. The default sort order is in @@ -2379,14 +2372,13 @@ export class ScheduleServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1beta1.Schedule | Schedule}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1beta1.Schedule|Schedule}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listSchedulesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listSchedules( @@ -2508,9 +2500,9 @@ export class ScheduleServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListSchedulesResponse.next_page_token|ListSchedulesResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListSchedulesResponse.next_page_token|ListSchedulesResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.ScheduleService.ListSchedules|ScheduleService.ListSchedules} + * {@link protos.google.cloud.aiplatform.v1beta1.ScheduleService.ListSchedules|ScheduleService.ListSchedules} * call. * @param {string} request.orderBy * A comma-separated list of fields to order by. The default sort order is in @@ -2532,13 +2524,12 @@ export class ScheduleServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1beta1.Schedule | Schedule} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1beta1.Schedule|Schedule} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listSchedulesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listSchedulesStream( @@ -2609,9 +2600,9 @@ export class ScheduleServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListSchedulesResponse.next_page_token|ListSchedulesResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListSchedulesResponse.next_page_token|ListSchedulesResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.ScheduleService.ListSchedules|ScheduleService.ListSchedules} + * {@link protos.google.cloud.aiplatform.v1beta1.ScheduleService.ListSchedules|ScheduleService.ListSchedules} * call. * @param {string} request.orderBy * A comma-separated list of fields to order by. The default sort order is in @@ -2633,12 +2624,11 @@ export class ScheduleServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1beta1.Schedule | Schedule}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1beta1.Schedule|Schedule}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/schedule_service.list_schedules.js * region_tag:aiplatform_v1beta1_generated_ScheduleService_ListSchedules_async @@ -2703,7 +2693,7 @@ export class ScheduleServiceClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -2724,8 +2714,7 @@ export class ScheduleServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -2751,7 +2740,7 @@ export class ScheduleServiceClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -2772,8 +2761,7 @@ export class ScheduleServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -2800,7 +2788,7 @@ export class ScheduleServiceClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -2815,8 +2803,7 @@ export class ScheduleServiceClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` @@ -2862,12 +2849,11 @@ export class ScheduleServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` diff --git a/packages/google-cloud-aiplatform/src/v1beta1/specialist_pool_service_client.ts b/packages/google-cloud-aiplatform/src/v1beta1/specialist_pool_service_client.ts index 7b35cd3df7a..2677e7ea5b4 100644 --- a/packages/google-cloud-aiplatform/src/v1beta1/specialist_pool_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1beta1/specialist_pool_service_client.ts @@ -1715,9 +1715,8 @@ export class SpecialistPoolServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.SpecialistPool | SpecialistPool}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.SpecialistPool|SpecialistPool}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/specialist_pool_service.get_specialist_pool.js * region_tag:aiplatform_v1beta1_generated_SpecialistPoolService_GetSpecialistPool_async @@ -1819,8 +1818,7 @@ export class SpecialistPoolServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/specialist_pool_service.create_specialist_pool.js * region_tag:aiplatform_v1beta1_generated_SpecialistPoolService_CreateSpecialistPool_async @@ -1915,8 +1913,7 @@ export class SpecialistPoolServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/specialist_pool_service.create_specialist_pool.js * region_tag:aiplatform_v1beta1_generated_SpecialistPoolService_CreateSpecialistPool_async @@ -1962,8 +1959,7 @@ export class SpecialistPoolServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/specialist_pool_service.delete_specialist_pool.js * region_tag:aiplatform_v1beta1_generated_SpecialistPoolService_DeleteSpecialistPool_async @@ -2058,8 +2054,7 @@ export class SpecialistPoolServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/specialist_pool_service.delete_specialist_pool.js * region_tag:aiplatform_v1beta1_generated_SpecialistPoolService_DeleteSpecialistPool_async @@ -2102,8 +2097,7 @@ export class SpecialistPoolServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/specialist_pool_service.update_specialist_pool.js * region_tag:aiplatform_v1beta1_generated_SpecialistPoolService_UpdateSpecialistPool_async @@ -2198,8 +2192,7 @@ export class SpecialistPoolServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/specialist_pool_service.update_specialist_pool.js * region_tag:aiplatform_v1beta1_generated_SpecialistPoolService_UpdateSpecialistPool_async @@ -2240,23 +2233,22 @@ export class SpecialistPoolServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained by - * {@link google.cloud.aiplatform.v1beta1.ListSpecialistPoolsResponse.next_page_token|ListSpecialistPoolsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListSpecialistPoolsResponse.next_page_token|ListSpecialistPoolsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.SpecialistPoolService.ListSpecialistPools|SpecialistPoolService.ListSpecialistPools} + * {@link protos.google.cloud.aiplatform.v1beta1.SpecialistPoolService.ListSpecialistPools|SpecialistPoolService.ListSpecialistPools} * call. Return first page if empty. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. FieldMask represents a set of * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1beta1.SpecialistPool | SpecialistPool}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1beta1.SpecialistPool|SpecialistPool}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listSpecialistPoolsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listSpecialistPools( @@ -2346,22 +2338,21 @@ export class SpecialistPoolServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained by - * {@link google.cloud.aiplatform.v1beta1.ListSpecialistPoolsResponse.next_page_token|ListSpecialistPoolsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListSpecialistPoolsResponse.next_page_token|ListSpecialistPoolsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.SpecialistPoolService.ListSpecialistPools|SpecialistPoolService.ListSpecialistPools} + * {@link protos.google.cloud.aiplatform.v1beta1.SpecialistPoolService.ListSpecialistPools|SpecialistPoolService.ListSpecialistPools} * call. Return first page if empty. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. FieldMask represents a set of * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1beta1.SpecialistPool | SpecialistPool} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1beta1.SpecialistPool|SpecialistPool} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listSpecialistPoolsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listSpecialistPoolsStream( @@ -2400,21 +2391,20 @@ export class SpecialistPoolServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained by - * {@link google.cloud.aiplatform.v1beta1.ListSpecialistPoolsResponse.next_page_token|ListSpecialistPoolsResponse.next_page_token} + * {@link protos.google.cloud.aiplatform.v1beta1.ListSpecialistPoolsResponse.next_page_token|ListSpecialistPoolsResponse.next_page_token} * of the previous - * {@link google.cloud.aiplatform.v1beta1.SpecialistPoolService.ListSpecialistPools|SpecialistPoolService.ListSpecialistPools} + * {@link protos.google.cloud.aiplatform.v1beta1.SpecialistPoolService.ListSpecialistPools|SpecialistPoolService.ListSpecialistPools} * call. Return first page if empty. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. FieldMask represents a set of * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1beta1.SpecialistPool | SpecialistPool}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1beta1.SpecialistPool|SpecialistPool}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/specialist_pool_service.list_specialist_pools.js * region_tag:aiplatform_v1beta1_generated_SpecialistPoolService_ListSpecialistPools_async @@ -2479,7 +2469,7 @@ export class SpecialistPoolServiceClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -2500,8 +2490,7 @@ export class SpecialistPoolServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -2527,7 +2516,7 @@ export class SpecialistPoolServiceClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -2548,8 +2537,7 @@ export class SpecialistPoolServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -2576,7 +2564,7 @@ export class SpecialistPoolServiceClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -2591,8 +2579,7 @@ export class SpecialistPoolServiceClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` @@ -2638,12 +2625,11 @@ export class SpecialistPoolServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` diff --git a/packages/google-cloud-aiplatform/src/v1beta1/tensorboard_service_client.ts b/packages/google-cloud-aiplatform/src/v1beta1/tensorboard_service_client.ts index e8255c654c1..26da3975f4b 100644 --- a/packages/google-cloud-aiplatform/src/v1beta1/tensorboard_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1beta1/tensorboard_service_client.ts @@ -1820,9 +1820,8 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.Tensorboard | Tensorboard}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.Tensorboard|Tensorboard}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/tensorboard_service.get_tensorboard.js * region_tag:aiplatform_v1beta1_generated_TensorboardService_GetTensorboard_async @@ -1913,9 +1912,8 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse | ReadTensorboardUsageResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse|ReadTensorboardUsageResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/tensorboard_service.read_tensorboard_usage.js * region_tag:aiplatform_v1beta1_generated_TensorboardService_ReadTensorboardUsage_async @@ -2012,9 +2010,8 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.ReadTensorboardSizeResponse | ReadTensorboardSizeResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.ReadTensorboardSizeResponse|ReadTensorboardSizeResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/tensorboard_service.read_tensorboard_size.js * region_tag:aiplatform_v1beta1_generated_TensorboardService_ReadTensorboardSize_async @@ -2115,13 +2112,12 @@ export class TensorboardServiceClient { * final component of the Tensorboard experiment's resource name. * * This value should be 1-128 characters, and valid characters - * are /{@link 0-9|a-z}-/. + * are /{@link protos.0-9|a-z}-/. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.TensorboardExperiment | TensorboardExperiment}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.TensorboardExperiment|TensorboardExperiment}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/tensorboard_service.create_tensorboard_experiment.js * region_tag:aiplatform_v1beta1_generated_TensorboardService_CreateTensorboardExperiment_async @@ -2222,9 +2218,8 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.TensorboardExperiment | TensorboardExperiment}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.TensorboardExperiment|TensorboardExperiment}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/tensorboard_service.get_tensorboard_experiment.js * region_tag:aiplatform_v1beta1_generated_TensorboardService_GetTensorboardExperiment_async @@ -2332,9 +2327,8 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.TensorboardExperiment | TensorboardExperiment}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.TensorboardExperiment|TensorboardExperiment}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/tensorboard_service.update_tensorboard_experiment.js * region_tag:aiplatform_v1beta1_generated_TensorboardService_UpdateTensorboardExperiment_async @@ -2440,13 +2434,12 @@ export class TensorboardServiceClient { * component of the Tensorboard run's resource name. * * This value should be 1-128 characters, and valid characters - * are /{@link 0-9|a-z}-/. + * are /{@link protos.0-9|a-z}-/. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.TensorboardRun | TensorboardRun}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.TensorboardRun|TensorboardRun}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/tensorboard_service.create_tensorboard_run.js * region_tag:aiplatform_v1beta1_generated_TensorboardService_CreateTensorboardRun_async @@ -2548,9 +2541,8 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.BatchCreateTensorboardRunsResponse | BatchCreateTensorboardRunsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.BatchCreateTensorboardRunsResponse|BatchCreateTensorboardRunsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/tensorboard_service.batch_create_tensorboard_runs.js * region_tag:aiplatform_v1beta1_generated_TensorboardService_BatchCreateTensorboardRuns_async @@ -2651,9 +2643,8 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.TensorboardRun | TensorboardRun}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.TensorboardRun|TensorboardRun}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/tensorboard_service.get_tensorboard_run.js * region_tag:aiplatform_v1beta1_generated_TensorboardService_GetTensorboardRun_async @@ -2757,9 +2748,8 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.TensorboardRun | TensorboardRun}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.TensorboardRun|TensorboardRun}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/tensorboard_service.update_tensorboard_run.js * region_tag:aiplatform_v1beta1_generated_TensorboardService_UpdateTensorboardRun_async @@ -2863,9 +2853,8 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.BatchCreateTensorboardTimeSeriesResponse | BatchCreateTensorboardTimeSeriesResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.BatchCreateTensorboardTimeSeriesResponse|BatchCreateTensorboardTimeSeriesResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/tensorboard_service.batch_create_tensorboard_time_series.js * region_tag:aiplatform_v1beta1_generated_TensorboardService_BatchCreateTensorboardTimeSeries_async @@ -2968,15 +2957,14 @@ export class TensorboardServiceClient { * Optional. The user specified unique ID to use for the * TensorboardTimeSeries, which becomes the final component of the * TensorboardTimeSeries's resource name. This value should match - * "{@link a-z0-9-|a-z0-9}{0, 127}" + * "{@link protos.a-z0-9-|a-z0-9}{0, 127}" * @param {google.cloud.aiplatform.v1beta1.TensorboardTimeSeries} request.tensorboardTimeSeries * Required. The TensorboardTimeSeries to create. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.TensorboardTimeSeries | TensorboardTimeSeries}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.TensorboardTimeSeries|TensorboardTimeSeries}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/tensorboard_service.create_tensorboard_time_series.js * region_tag:aiplatform_v1beta1_generated_TensorboardService_CreateTensorboardTimeSeries_async @@ -3077,9 +3065,8 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.TensorboardTimeSeries | TensorboardTimeSeries}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.TensorboardTimeSeries|TensorboardTimeSeries}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/tensorboard_service.get_tensorboard_time_series.js * region_tag:aiplatform_v1beta1_generated_TensorboardService_GetTensorboardTimeSeries_async @@ -3188,9 +3175,8 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.TensorboardTimeSeries | TensorboardTimeSeries}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.TensorboardTimeSeries|TensorboardTimeSeries}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/tensorboard_service.update_tensorboard_time_series.js * region_tag:aiplatform_v1beta1_generated_TensorboardService_UpdateTensorboardTimeSeries_async @@ -3294,7 +3280,7 @@ export class TensorboardServiceClient { * TensorboardTimeSeries to read data from. Format: * `projects/{project}/locations/{location}/tensorboards/{tensorboard}`. * The TensorboardTimeSeries referenced by - * {@link google.cloud.aiplatform.v1beta1.BatchReadTensorboardTimeSeriesDataRequest.time_series|time_series} + * {@link protos.google.cloud.aiplatform.v1beta1.BatchReadTensorboardTimeSeriesDataRequest.time_series|time_series} * must be sub resources of this Tensorboard. * @param {string[]} request.timeSeries * Required. The resource names of the TensorboardTimeSeries to read data @@ -3303,9 +3289,8 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.BatchReadTensorboardTimeSeriesDataResponse | BatchReadTensorboardTimeSeriesDataResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.BatchReadTensorboardTimeSeriesDataResponse|BatchReadTensorboardTimeSeriesDataResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/tensorboard_service.batch_read_tensorboard_time_series_data.js * region_tag:aiplatform_v1beta1_generated_TensorboardService_BatchReadTensorboardTimeSeriesData_async @@ -3417,9 +3402,8 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.ReadTensorboardTimeSeriesDataResponse | ReadTensorboardTimeSeriesDataResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.ReadTensorboardTimeSeriesDataResponse|ReadTensorboardTimeSeriesDataResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/tensorboard_service.read_tensorboard_time_series_data.js * region_tag:aiplatform_v1beta1_generated_TensorboardService_ReadTensorboardTimeSeriesData_async @@ -3523,9 +3507,8 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.WriteTensorboardExperimentDataResponse | WriteTensorboardExperimentDataResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.WriteTensorboardExperimentDataResponse|WriteTensorboardExperimentDataResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/tensorboard_service.write_tensorboard_experiment_data.js * region_tag:aiplatform_v1beta1_generated_TensorboardService_WriteTensorboardExperimentData_async @@ -3633,9 +3616,8 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.WriteTensorboardRunDataResponse | WriteTensorboardRunDataResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.WriteTensorboardRunDataResponse|WriteTensorboardRunDataResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/tensorboard_service.write_tensorboard_run_data.js * region_tag:aiplatform_v1beta1_generated_TensorboardService_WriteTensorboardRunData_async @@ -3742,9 +3724,8 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits {@link google.cloud.aiplatform.v1beta1.ReadTensorboardBlobDataResponse | ReadTensorboardBlobDataResponse} on 'data' event. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#server-streaming) + * An object stream which emits {@link protos.google.cloud.aiplatform.v1beta1.ReadTensorboardBlobDataResponse|ReadTensorboardBlobDataResponse} on 'data' event. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#server-streaming | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/tensorboard_service.read_tensorboard_blob_data.js * region_tag:aiplatform_v1beta1_generated_TensorboardService_ReadTensorboardBlobData_async @@ -3781,8 +3762,7 @@ export class TensorboardServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/tensorboard_service.create_tensorboard.js * region_tag:aiplatform_v1beta1_generated_TensorboardService_CreateTensorboard_async @@ -3877,8 +3857,7 @@ export class TensorboardServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/tensorboard_service.create_tensorboard.js * region_tag:aiplatform_v1beta1_generated_TensorboardService_CreateTensorboard_async @@ -3928,8 +3907,7 @@ export class TensorboardServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/tensorboard_service.update_tensorboard.js * region_tag:aiplatform_v1beta1_generated_TensorboardService_UpdateTensorboard_async @@ -4024,8 +4002,7 @@ export class TensorboardServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/tensorboard_service.update_tensorboard.js * region_tag:aiplatform_v1beta1_generated_TensorboardService_UpdateTensorboard_async @@ -4068,8 +4045,7 @@ export class TensorboardServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/tensorboard_service.delete_tensorboard.js * region_tag:aiplatform_v1beta1_generated_TensorboardService_DeleteTensorboard_async @@ -4164,8 +4140,7 @@ export class TensorboardServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/tensorboard_service.delete_tensorboard.js * region_tag:aiplatform_v1beta1_generated_TensorboardService_DeleteTensorboard_async @@ -4208,8 +4183,7 @@ export class TensorboardServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/tensorboard_service.delete_tensorboard_experiment.js * region_tag:aiplatform_v1beta1_generated_TensorboardService_DeleteTensorboardExperiment_async @@ -4308,8 +4282,7 @@ export class TensorboardServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/tensorboard_service.delete_tensorboard_experiment.js * region_tag:aiplatform_v1beta1_generated_TensorboardService_DeleteTensorboardExperiment_async @@ -4352,8 +4325,7 @@ export class TensorboardServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/tensorboard_service.delete_tensorboard_run.js * region_tag:aiplatform_v1beta1_generated_TensorboardService_DeleteTensorboardRun_async @@ -4448,8 +4420,7 @@ export class TensorboardServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/tensorboard_service.delete_tensorboard_run.js * region_tag:aiplatform_v1beta1_generated_TensorboardService_DeleteTensorboardRun_async @@ -4492,8 +4463,7 @@ export class TensorboardServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/tensorboard_service.delete_tensorboard_time_series.js * region_tag:aiplatform_v1beta1_generated_TensorboardService_DeleteTensorboardTimeSeries_async @@ -4592,8 +4562,7 @@ export class TensorboardServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/tensorboard_service.delete_tensorboard_time_series.js * region_tag:aiplatform_v1beta1_generated_TensorboardService_DeleteTensorboardTimeSeries_async @@ -4639,11 +4608,11 @@ export class TensorboardServiceClient { * 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} + * {@link protos.google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} + * {@link protos.google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. @@ -4652,14 +4621,13 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1beta1.Tensorboard | Tensorboard}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1beta1.Tensorboard|Tensorboard}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listTensorboardsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listTensorboards( @@ -4754,11 +4722,11 @@ export class TensorboardServiceClient { * 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} + * {@link protos.google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} + * {@link protos.google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. @@ -4767,13 +4735,12 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1beta1.Tensorboard | Tensorboard} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1beta1.Tensorboard|Tensorboard} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listTensorboardsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listTensorboardsStream( @@ -4817,11 +4784,11 @@ export class TensorboardServiceClient { * 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} + * {@link protos.google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} + * {@link protos.google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. @@ -4830,12 +4797,11 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1beta1.Tensorboard | Tensorboard}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1beta1.Tensorboard|Tensorboard}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/tensorboard_service.list_tensorboards.js * region_tag:aiplatform_v1beta1_generated_TensorboardService_ListTensorboards_async @@ -4879,11 +4845,11 @@ export class TensorboardServiceClient { * above 1000 are coerced to 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} + * {@link protos.google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} + * {@link protos.google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. @@ -4892,14 +4858,13 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1beta1.TensorboardExperiment | TensorboardExperiment}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1beta1.TensorboardExperiment|TensorboardExperiment}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listTensorboardExperimentsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listTensorboardExperiments( @@ -4998,11 +4963,11 @@ export class TensorboardServiceClient { * above 1000 are coerced to 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} + * {@link protos.google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} + * {@link protos.google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. @@ -5011,13 +4976,12 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1beta1.TensorboardExperiment | TensorboardExperiment} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1beta1.TensorboardExperiment|TensorboardExperiment} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listTensorboardExperimentsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listTensorboardExperimentsStream( @@ -5061,11 +5025,11 @@ export class TensorboardServiceClient { * above 1000 are coerced to 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} + * {@link protos.google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} + * {@link protos.google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. @@ -5074,12 +5038,11 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1beta1.TensorboardExperiment | TensorboardExperiment}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1beta1.TensorboardExperiment|TensorboardExperiment}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/tensorboard_service.list_tensorboard_experiments.js * region_tag:aiplatform_v1beta1_generated_TensorboardService_ListTensorboardExperiments_async @@ -5123,11 +5086,11 @@ export class TensorboardServiceClient { * 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} + * {@link protos.google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} + * {@link protos.google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. @@ -5136,14 +5099,13 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1beta1.TensorboardRun | TensorboardRun}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1beta1.TensorboardRun|TensorboardRun}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listTensorboardRunsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listTensorboardRuns( @@ -5238,11 +5200,11 @@ export class TensorboardServiceClient { * 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} + * {@link protos.google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} + * {@link protos.google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. @@ -5251,13 +5213,12 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1beta1.TensorboardRun | TensorboardRun} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1beta1.TensorboardRun|TensorboardRun} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listTensorboardRunsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listTensorboardRunsStream( @@ -5301,11 +5262,11 @@ export class TensorboardServiceClient { * 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} + * {@link protos.google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} + * {@link protos.google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. @@ -5314,12 +5275,11 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1beta1.TensorboardRun | TensorboardRun}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1beta1.TensorboardRun|TensorboardRun}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/tensorboard_service.list_tensorboard_runs.js * region_tag:aiplatform_v1beta1_generated_TensorboardService_ListTensorboardRuns_async @@ -5363,11 +5323,11 @@ export class TensorboardServiceClient { * above 1000 are coerced to 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} + * {@link protos.google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} + * {@link protos.google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. @@ -5376,14 +5336,13 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1beta1.TensorboardTimeSeries | TensorboardTimeSeries}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1beta1.TensorboardTimeSeries|TensorboardTimeSeries}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listTensorboardTimeSeriesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listTensorboardTimeSeries( @@ -5482,11 +5441,11 @@ export class TensorboardServiceClient { * above 1000 are coerced to 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} + * {@link protos.google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} + * {@link protos.google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. @@ -5495,13 +5454,12 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1beta1.TensorboardTimeSeries | TensorboardTimeSeries} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1beta1.TensorboardTimeSeries|TensorboardTimeSeries} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listTensorboardTimeSeriesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listTensorboardTimeSeriesStream( @@ -5545,11 +5503,11 @@ export class TensorboardServiceClient { * above 1000 are coerced to 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} + * {@link protos.google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} + * {@link protos.google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. @@ -5558,12 +5516,11 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1beta1.TensorboardTimeSeries | TensorboardTimeSeries}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1beta1.TensorboardTimeSeries|TensorboardTimeSeries}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/tensorboard_service.list_tensorboard_time_series.js * region_tag:aiplatform_v1beta1_generated_TensorboardService_ListTensorboardTimeSeries_async @@ -5607,11 +5564,11 @@ export class TensorboardServiceClient { * Values above 10000 are coerced to 10000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ExportTensorboardTimeSeriesData|ExportTensorboardTimeSeriesData} + * {@link protos.google.cloud.aiplatform.v1beta1.TensorboardService.ExportTensorboardTimeSeriesData|ExportTensorboardTimeSeriesData} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ExportTensorboardTimeSeriesData|ExportTensorboardTimeSeriesData} + * {@link protos.google.cloud.aiplatform.v1beta1.TensorboardService.ExportTensorboardTimeSeriesData|ExportTensorboardTimeSeriesData} * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the TensorboardTimeSeries' data. @@ -5620,14 +5577,13 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1beta1.TimeSeriesDataPoint | TimeSeriesDataPoint}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1beta1.TimeSeriesDataPoint|TimeSeriesDataPoint}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `exportTensorboardTimeSeriesDataAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ exportTensorboardTimeSeriesData( @@ -5725,11 +5681,11 @@ export class TensorboardServiceClient { * Values above 10000 are coerced to 10000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ExportTensorboardTimeSeriesData|ExportTensorboardTimeSeriesData} + * {@link protos.google.cloud.aiplatform.v1beta1.TensorboardService.ExportTensorboardTimeSeriesData|ExportTensorboardTimeSeriesData} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ExportTensorboardTimeSeriesData|ExportTensorboardTimeSeriesData} + * {@link protos.google.cloud.aiplatform.v1beta1.TensorboardService.ExportTensorboardTimeSeriesData|ExportTensorboardTimeSeriesData} * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the TensorboardTimeSeries' data. @@ -5738,13 +5694,12 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1beta1.TimeSeriesDataPoint | TimeSeriesDataPoint} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1beta1.TimeSeriesDataPoint|TimeSeriesDataPoint} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `exportTensorboardTimeSeriesDataAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ exportTensorboardTimeSeriesDataStream( @@ -5788,11 +5743,11 @@ export class TensorboardServiceClient { * Values above 10000 are coerced to 10000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ExportTensorboardTimeSeriesData|ExportTensorboardTimeSeriesData} + * {@link protos.google.cloud.aiplatform.v1beta1.TensorboardService.ExportTensorboardTimeSeriesData|ExportTensorboardTimeSeriesData} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ExportTensorboardTimeSeriesData|ExportTensorboardTimeSeriesData} + * {@link protos.google.cloud.aiplatform.v1beta1.TensorboardService.ExportTensorboardTimeSeriesData|ExportTensorboardTimeSeriesData} * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the TensorboardTimeSeries' data. @@ -5801,12 +5756,11 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1beta1.TimeSeriesDataPoint | TimeSeriesDataPoint}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1beta1.TimeSeriesDataPoint|TimeSeriesDataPoint}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/tensorboard_service.export_tensorboard_time_series_data.js * region_tag:aiplatform_v1beta1_generated_TensorboardService_ExportTensorboardTimeSeriesData_async @@ -5872,7 +5826,7 @@ export class TensorboardServiceClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -5893,8 +5847,7 @@ export class TensorboardServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -5920,7 +5873,7 @@ export class TensorboardServiceClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -5941,8 +5894,7 @@ export class TensorboardServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -5969,7 +5921,7 @@ export class TensorboardServiceClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -5984,8 +5936,7 @@ export class TensorboardServiceClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` @@ -6031,12 +5982,11 @@ export class TensorboardServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` diff --git a/packages/google-cloud-aiplatform/src/v1beta1/vizier_service_client.ts b/packages/google-cloud-aiplatform/src/v1beta1/vizier_service_client.ts index 671b2b26cf6..cbc1d37c031 100644 --- a/packages/google-cloud-aiplatform/src/v1beta1/vizier_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1beta1/vizier_service_client.ts @@ -1722,9 +1722,8 @@ export class VizierServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.Study | Study}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.Study|Study}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/vizier_service.create_study.js * region_tag:aiplatform_v1beta1_generated_VizierService_CreateStudy_async @@ -1814,9 +1813,8 @@ export class VizierServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.Study | Study}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.Study|Study}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/vizier_service.get_study.js * region_tag:aiplatform_v1beta1_generated_VizierService_GetStudy_async @@ -1906,9 +1904,8 @@ export class VizierServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.protobuf.Empty | Empty}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/vizier_service.delete_study.js * region_tag:aiplatform_v1beta1_generated_VizierService_DeleteStudy_async @@ -2001,9 +1998,8 @@ export class VizierServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.Study | Study}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.Study|Study}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/vizier_service.lookup_study.js * region_tag:aiplatform_v1beta1_generated_VizierService_LookupStudy_async @@ -2095,9 +2091,8 @@ export class VizierServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.Trial | Trial}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.Trial|Trial}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/vizier_service.create_trial.js * region_tag:aiplatform_v1beta1_generated_VizierService_CreateTrial_async @@ -2188,9 +2183,8 @@ export class VizierServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.Trial | Trial}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.Trial|Trial}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/vizier_service.get_trial.js * region_tag:aiplatform_v1beta1_generated_VizierService_GetTrial_async @@ -2284,9 +2278,8 @@ export class VizierServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.Trial | Trial}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.Trial|Trial}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/vizier_service.add_trial_measurement.js * region_tag:aiplatform_v1beta1_generated_VizierService_AddTrialMeasurement_async @@ -2393,9 +2386,8 @@ export class VizierServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.Trial | Trial}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.Trial|Trial}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/vizier_service.complete_trial.js * region_tag:aiplatform_v1beta1_generated_VizierService_CompleteTrial_async @@ -2486,9 +2478,8 @@ export class VizierServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.protobuf.Empty | Empty}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/vizier_service.delete_trial.js * region_tag:aiplatform_v1beta1_generated_VizierService_DeleteTrial_async @@ -2579,9 +2570,8 @@ export class VizierServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.Trial | Trial}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.Trial|Trial}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/vizier_service.stop_trial.js * region_tag:aiplatform_v1beta1_generated_VizierService_StopTrial_async @@ -2673,9 +2663,8 @@ export class VizierServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.aiplatform.v1beta1.ListOptimalTrialsResponse | ListOptimalTrialsResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.aiplatform.v1beta1.ListOptimalTrialsResponse|ListOptimalTrialsResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/vizier_service.list_optimal_trials.js * region_tag:aiplatform_v1beta1_generated_VizierService_ListOptimalTrials_async @@ -2767,7 +2756,7 @@ export class VizierServiceClient { * operation associated with the generation of Trial suggestions. * When this long-running operation succeeds, it will contain * a - * {@link google.cloud.aiplatform.v1beta1.SuggestTrialsResponse|SuggestTrialsResponse}. + * {@link protos.google.cloud.aiplatform.v1beta1.SuggestTrialsResponse|SuggestTrialsResponse}. * * @param {Object} request * The request object that will be sent. @@ -2788,8 +2777,7 @@ export class VizierServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/vizier_service.suggest_trials.js * region_tag:aiplatform_v1beta1_generated_VizierService_SuggestTrials_async @@ -2884,8 +2872,7 @@ export class VizierServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/vizier_service.suggest_trials.js * region_tag:aiplatform_v1beta1_generated_VizierService_SuggestTrials_async @@ -2917,7 +2904,7 @@ export class VizierServiceClient { * Checks whether a Trial should stop or not. Returns a * long-running operation. When the operation is successful, * it will contain a - * {@link google.cloud.aiplatform.v1beta1.CheckTrialEarlyStoppingStateResponse|CheckTrialEarlyStoppingStateResponse}. + * {@link protos.google.cloud.aiplatform.v1beta1.CheckTrialEarlyStoppingStateResponse|CheckTrialEarlyStoppingStateResponse}. * * @param {Object} request * The request object that will be sent. @@ -2931,8 +2918,7 @@ export class VizierServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/vizier_service.check_trial_early_stopping_state.js * region_tag:aiplatform_v1beta1_generated_VizierService_CheckTrialEarlyStoppingState_async @@ -3031,8 +3017,7 @@ export class VizierServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/vizier_service.check_trial_early_stopping_state.js * region_tag:aiplatform_v1beta1_generated_VizierService_CheckTrialEarlyStoppingState_async @@ -3077,14 +3062,13 @@ export class VizierServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1beta1.Study | Study}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1beta1.Study|Study}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listStudiesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStudies( @@ -3178,13 +3162,12 @@ export class VizierServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1beta1.Study | Study} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1beta1.Study|Study} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listStudiesAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listStudiesStream( @@ -3227,12 +3210,11 @@ export class VizierServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1beta1.Study | Study}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1beta1.Study|Study}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/vizier_service.list_studies.js * region_tag:aiplatform_v1beta1_generated_VizierService_ListStudies_async @@ -3275,14 +3257,13 @@ export class VizierServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.aiplatform.v1beta1.Trial | Trial}. + * The first element of the array is Array of {@link protos.google.cloud.aiplatform.v1beta1.Trial|Trial}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listTrialsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listTrials( @@ -3376,13 +3357,12 @@ export class VizierServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.aiplatform.v1beta1.Trial | Trial} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.aiplatform.v1beta1.Trial|Trial} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listTrialsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listTrialsStream( @@ -3425,12 +3405,11 @@ export class VizierServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.aiplatform.v1beta1.Trial | Trial}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.aiplatform.v1beta1.Trial|Trial}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/vizier_service.list_trials.js * region_tag:aiplatform_v1beta1_generated_VizierService_ListTrials_async @@ -3495,7 +3474,7 @@ export class VizierServiceClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -3516,8 +3495,7 @@ export class VizierServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -3543,7 +3521,7 @@ export class VizierServiceClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -3564,8 +3542,7 @@ export class VizierServiceClient { * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more - * information see - * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. @@ -3592,7 +3569,7 @@ export class VizierServiceClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -3607,8 +3584,7 @@ export class VizierServiceClient { * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` @@ -3654,12 +3630,11 @@ export class VizierServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` diff --git a/packages/google-cloud-aiplatform/system-test/fixtures/sample/src/index.js b/packages/google-cloud-aiplatform/system-test/fixtures/sample/src/index.js index c260f42662a..2cf228bcfb9 100644 --- a/packages/google-cloud-aiplatform/system-test/fixtures/sample/src/index.js +++ b/packages/google-cloud-aiplatform/system-test/fixtures/sample/src/index.js @@ -36,6 +36,7 @@ function main() { const modelServiceClient = new aiplatform.ModelServiceClient(); const pipelineServiceClient = new aiplatform.PipelineServiceClient(); const predictionServiceClient = new aiplatform.PredictionServiceClient(); + const scheduleServiceClient = new aiplatform.ScheduleServiceClient(); const specialistPoolServiceClient = new aiplatform.SpecialistPoolServiceClient(); const tensorboardServiceClient = new aiplatform.TensorboardServiceClient(); diff --git a/packages/google-cloud-aiplatform/system-test/fixtures/sample/src/index.ts b/packages/google-cloud-aiplatform/system-test/fixtures/sample/src/index.ts index e8fee7c77c2..31b7eada05f 100644 --- a/packages/google-cloud-aiplatform/system-test/fixtures/sample/src/index.ts +++ b/packages/google-cloud-aiplatform/system-test/fixtures/sample/src/index.ts @@ -31,6 +31,7 @@ import { ModelServiceClient, PipelineServiceClient, PredictionServiceClient, + ScheduleServiceClient, SpecialistPoolServiceClient, TensorboardServiceClient, VizierServiceClient, @@ -85,6 +86,9 @@ function doStuffWithPipelineServiceClient(client: PipelineServiceClient) { function doStuffWithPredictionServiceClient(client: PredictionServiceClient) { client.close(); } +function doStuffWithScheduleServiceClient(client: ScheduleServiceClient) { + client.close(); +} function doStuffWithSpecialistPoolServiceClient( client: SpecialistPoolServiceClient ) { @@ -144,6 +148,9 @@ function main() { const predictionServiceClient = new PredictionServiceClient(); doStuffWithPredictionServiceClient(predictionServiceClient); // check that the client instance can be created + const scheduleServiceClient = new ScheduleServiceClient(); + doStuffWithScheduleServiceClient(scheduleServiceClient); + // check that the client instance can be created const specialistPoolServiceClient = new SpecialistPoolServiceClient(); doStuffWithSpecialistPoolServiceClient(specialistPoolServiceClient); // check that the client instance can be created diff --git a/packages/google-cloud-aiplatform/test/gapic_dataset_service_v1.ts b/packages/google-cloud-aiplatform/test/gapic_dataset_service_v1.ts index 8fa370ac42c..abd3a3c7014 100644 --- a/packages/google-cloud-aiplatform/test/gapic_dataset_service_v1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_dataset_service_v1.ts @@ -6228,6 +6228,70 @@ describe('v1.DatasetServiceClient', () => { }); }); + describe('schedule', () => { + const fakePath = '/rendered/path/schedule'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + schedule: 'scheduleValue', + }; + const client = new datasetserviceModule.v1.DatasetServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.schedulePathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.schedulePathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('schedulePath', () => { + const result = client.schedulePath( + 'projectValue', + 'locationValue', + 'scheduleValue' + ); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.schedulePathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromScheduleName', () => { + const result = client.matchProjectFromScheduleName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromScheduleName', () => { + const result = client.matchLocationFromScheduleName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchScheduleFromScheduleName', () => { + const result = client.matchScheduleFromScheduleName(fakePath); + assert.strictEqual(result, 'scheduleValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + describe('specialistPool', () => { const fakePath = '/rendered/path/specialistPool'; const expectedParameters = { diff --git a/packages/google-cloud-aiplatform/test/gapic_endpoint_service_v1.ts b/packages/google-cloud-aiplatform/test/gapic_endpoint_service_v1.ts index be5086d6be3..e84507a0e17 100644 --- a/packages/google-cloud-aiplatform/test/gapic_endpoint_service_v1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_endpoint_service_v1.ts @@ -4824,6 +4824,70 @@ describe('v1.EndpointServiceClient', () => { }); }); + describe('schedule', () => { + const fakePath = '/rendered/path/schedule'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + schedule: 'scheduleValue', + }; + const client = new endpointserviceModule.v1.EndpointServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.schedulePathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.schedulePathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('schedulePath', () => { + const result = client.schedulePath( + 'projectValue', + 'locationValue', + 'scheduleValue' + ); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.schedulePathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromScheduleName', () => { + const result = client.matchProjectFromScheduleName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromScheduleName', () => { + const result = client.matchLocationFromScheduleName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchScheduleFromScheduleName', () => { + const result = client.matchScheduleFromScheduleName(fakePath); + assert.strictEqual(result, 'scheduleValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + describe('specialistPool', () => { const fakePath = '/rendered/path/specialistPool'; const expectedParameters = { diff --git a/packages/google-cloud-aiplatform/test/gapic_featurestore_online_serving_service_v1.ts b/packages/google-cloud-aiplatform/test/gapic_featurestore_online_serving_service_v1.ts index 888b9187074..7774fecff67 100644 --- a/packages/google-cloud-aiplatform/test/gapic_featurestore_online_serving_service_v1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_featurestore_online_serving_service_v1.ts @@ -3462,6 +3462,73 @@ describe('v1.FeaturestoreOnlineServingServiceClient', () => { }); }); + describe('schedule', () => { + const fakePath = '/rendered/path/schedule'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + schedule: 'scheduleValue', + }; + const client = + new featurestoreonlineservingserviceModule.v1.FeaturestoreOnlineServingServiceClient( + { + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + } + ); + client.initialize(); + client.pathTemplates.schedulePathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.schedulePathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('schedulePath', () => { + const result = client.schedulePath( + 'projectValue', + 'locationValue', + 'scheduleValue' + ); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.schedulePathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromScheduleName', () => { + const result = client.matchProjectFromScheduleName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromScheduleName', () => { + const result = client.matchLocationFromScheduleName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchScheduleFromScheduleName', () => { + const result = client.matchScheduleFromScheduleName(fakePath); + assert.strictEqual(result, 'scheduleValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + describe('specialistPool', () => { const fakePath = '/rendered/path/specialistPool'; const expectedParameters = { diff --git a/packages/google-cloud-aiplatform/test/gapic_featurestore_service_v1.ts b/packages/google-cloud-aiplatform/test/gapic_featurestore_service_v1.ts index 48f48a0d21a..a1a7bb210a5 100644 --- a/packages/google-cloud-aiplatform/test/gapic_featurestore_service_v1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_featurestore_service_v1.ts @@ -7943,6 +7943,72 @@ describe('v1.FeaturestoreServiceClient', () => { }); }); + describe('schedule', () => { + const fakePath = '/rendered/path/schedule'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + schedule: 'scheduleValue', + }; + const client = new featurestoreserviceModule.v1.FeaturestoreServiceClient( + { + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + } + ); + client.initialize(); + client.pathTemplates.schedulePathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.schedulePathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('schedulePath', () => { + const result = client.schedulePath( + 'projectValue', + 'locationValue', + 'scheduleValue' + ); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.schedulePathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromScheduleName', () => { + const result = client.matchProjectFromScheduleName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromScheduleName', () => { + const result = client.matchLocationFromScheduleName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchScheduleFromScheduleName', () => { + const result = client.matchScheduleFromScheduleName(fakePath); + assert.strictEqual(result, 'scheduleValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + describe('specialistPool', () => { const fakePath = '/rendered/path/specialistPool'; const expectedParameters = { diff --git a/packages/google-cloud-aiplatform/test/gapic_index_endpoint_service_v1.ts b/packages/google-cloud-aiplatform/test/gapic_index_endpoint_service_v1.ts index aa724fe6eab..3dcb70393b9 100644 --- a/packages/google-cloud-aiplatform/test/gapic_index_endpoint_service_v1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_index_endpoint_service_v1.ts @@ -4959,6 +4959,71 @@ describe('v1.IndexEndpointServiceClient', () => { }); }); + describe('schedule', () => { + const fakePath = '/rendered/path/schedule'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + schedule: 'scheduleValue', + }; + const client = + new indexendpointserviceModule.v1.IndexEndpointServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.schedulePathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.schedulePathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('schedulePath', () => { + const result = client.schedulePath( + 'projectValue', + 'locationValue', + 'scheduleValue' + ); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.schedulePathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromScheduleName', () => { + const result = client.matchProjectFromScheduleName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromScheduleName', () => { + const result = client.matchLocationFromScheduleName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchScheduleFromScheduleName', () => { + const result = client.matchScheduleFromScheduleName(fakePath); + assert.strictEqual(result, 'scheduleValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + describe('specialistPool', () => { const fakePath = '/rendered/path/specialistPool'; const expectedParameters = { diff --git a/packages/google-cloud-aiplatform/test/gapic_index_service_v1.ts b/packages/google-cloud-aiplatform/test/gapic_index_service_v1.ts index cd5e8bb3a63..17f23df33f3 100644 --- a/packages/google-cloud-aiplatform/test/gapic_index_service_v1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_index_service_v1.ts @@ -4557,6 +4557,70 @@ describe('v1.IndexServiceClient', () => { }); }); + describe('schedule', () => { + const fakePath = '/rendered/path/schedule'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + schedule: 'scheduleValue', + }; + const client = new indexserviceModule.v1.IndexServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.schedulePathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.schedulePathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('schedulePath', () => { + const result = client.schedulePath( + 'projectValue', + 'locationValue', + 'scheduleValue' + ); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.schedulePathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromScheduleName', () => { + const result = client.matchProjectFromScheduleName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromScheduleName', () => { + const result = client.matchLocationFromScheduleName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchScheduleFromScheduleName', () => { + const result = client.matchScheduleFromScheduleName(fakePath); + assert.strictEqual(result, 'scheduleValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + describe('specialistPool', () => { const fakePath = '/rendered/path/specialistPool'; const expectedParameters = { diff --git a/packages/google-cloud-aiplatform/test/gapic_job_service_v1.ts b/packages/google-cloud-aiplatform/test/gapic_job_service_v1.ts index 8f4eb0049cc..e2539f7c0e9 100644 --- a/packages/google-cloud-aiplatform/test/gapic_job_service_v1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_job_service_v1.ts @@ -10104,6 +10104,70 @@ describe('v1.JobServiceClient', () => { }); }); + describe('schedule', () => { + const fakePath = '/rendered/path/schedule'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + schedule: 'scheduleValue', + }; + const client = new jobserviceModule.v1.JobServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.schedulePathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.schedulePathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('schedulePath', () => { + const result = client.schedulePath( + 'projectValue', + 'locationValue', + 'scheduleValue' + ); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.schedulePathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromScheduleName', () => { + const result = client.matchProjectFromScheduleName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromScheduleName', () => { + const result = client.matchLocationFromScheduleName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchScheduleFromScheduleName', () => { + const result = client.matchScheduleFromScheduleName(fakePath); + assert.strictEqual(result, 'scheduleValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + describe('specialistPool', () => { const fakePath = '/rendered/path/specialistPool'; const expectedParameters = { diff --git a/packages/google-cloud-aiplatform/test/gapic_match_service_v1.ts b/packages/google-cloud-aiplatform/test/gapic_match_service_v1.ts index 2658d322796..74bfe5bc6fc 100644 --- a/packages/google-cloud-aiplatform/test/gapic_match_service_v1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_match_service_v1.ts @@ -3120,6 +3120,70 @@ describe('v1.MatchServiceClient', () => { }); }); + describe('schedule', () => { + const fakePath = '/rendered/path/schedule'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + schedule: 'scheduleValue', + }; + const client = new matchserviceModule.v1.MatchServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.schedulePathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.schedulePathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('schedulePath', () => { + const result = client.schedulePath( + 'projectValue', + 'locationValue', + 'scheduleValue' + ); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.schedulePathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromScheduleName', () => { + const result = client.matchProjectFromScheduleName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromScheduleName', () => { + const result = client.matchLocationFromScheduleName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchScheduleFromScheduleName', () => { + const result = client.matchScheduleFromScheduleName(fakePath); + assert.strictEqual(result, 'scheduleValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + describe('specialistPool', () => { const fakePath = '/rendered/path/specialistPool'; const expectedParameters = { diff --git a/packages/google-cloud-aiplatform/test/gapic_metadata_service_v1.ts b/packages/google-cloud-aiplatform/test/gapic_metadata_service_v1.ts index 37d63d39af2..47c05935765 100644 --- a/packages/google-cloud-aiplatform/test/gapic_metadata_service_v1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_metadata_service_v1.ts @@ -8988,6 +8988,70 @@ describe('v1.MetadataServiceClient', () => { }); }); + describe('schedule', () => { + const fakePath = '/rendered/path/schedule'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + schedule: 'scheduleValue', + }; + const client = new metadataserviceModule.v1.MetadataServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.schedulePathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.schedulePathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('schedulePath', () => { + const result = client.schedulePath( + 'projectValue', + 'locationValue', + 'scheduleValue' + ); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.schedulePathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromScheduleName', () => { + const result = client.matchProjectFromScheduleName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromScheduleName', () => { + const result = client.matchLocationFromScheduleName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchScheduleFromScheduleName', () => { + const result = client.matchScheduleFromScheduleName(fakePath); + assert.strictEqual(result, 'scheduleValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + describe('specialistPool', () => { const fakePath = '/rendered/path/specialistPool'; const expectedParameters = { diff --git a/packages/google-cloud-aiplatform/test/gapic_migration_service_v1.ts b/packages/google-cloud-aiplatform/test/gapic_migration_service_v1.ts index 8ebf2bed673..77b514b74b3 100644 --- a/packages/google-cloud-aiplatform/test/gapic_migration_service_v1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_migration_service_v1.ts @@ -3845,6 +3845,70 @@ describe('v1.MigrationServiceClient', () => { }); }); + describe('schedule', () => { + const fakePath = '/rendered/path/schedule'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + schedule: 'scheduleValue', + }; + const client = new migrationserviceModule.v1.MigrationServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.schedulePathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.schedulePathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('schedulePath', () => { + const result = client.schedulePath( + 'projectValue', + 'locationValue', + 'scheduleValue' + ); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.schedulePathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromScheduleName', () => { + const result = client.matchProjectFromScheduleName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromScheduleName', () => { + const result = client.matchLocationFromScheduleName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchScheduleFromScheduleName', () => { + const result = client.matchScheduleFromScheduleName(fakePath); + assert.strictEqual(result, 'scheduleValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + describe('specialistPool', () => { const fakePath = '/rendered/path/specialistPool'; const expectedParameters = { diff --git a/packages/google-cloud-aiplatform/test/gapic_model_garden_service_v1.ts b/packages/google-cloud-aiplatform/test/gapic_model_garden_service_v1.ts index 12c59502a70..48b98eb2aae 100644 --- a/packages/google-cloud-aiplatform/test/gapic_model_garden_service_v1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_model_garden_service_v1.ts @@ -2991,6 +2991,70 @@ describe('v1.ModelGardenServiceClient', () => { }); }); + describe('schedule', () => { + const fakePath = '/rendered/path/schedule'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + schedule: 'scheduleValue', + }; + const client = new modelgardenserviceModule.v1.ModelGardenServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.schedulePathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.schedulePathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('schedulePath', () => { + const result = client.schedulePath( + 'projectValue', + 'locationValue', + 'scheduleValue' + ); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.schedulePathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromScheduleName', () => { + const result = client.matchProjectFromScheduleName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromScheduleName', () => { + const result = client.matchLocationFromScheduleName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchScheduleFromScheduleName', () => { + const result = client.matchScheduleFromScheduleName(fakePath); + assert.strictEqual(result, 'scheduleValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + describe('specialistPool', () => { const fakePath = '/rendered/path/specialistPool'; const expectedParameters = { diff --git a/packages/google-cloud-aiplatform/test/gapic_model_service_v1.ts b/packages/google-cloud-aiplatform/test/gapic_model_service_v1.ts index 3859802e971..5aacdc7d44f 100644 --- a/packages/google-cloud-aiplatform/test/gapic_model_service_v1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_model_service_v1.ts @@ -6809,6 +6809,70 @@ describe('v1.ModelServiceClient', () => { }); }); + describe('schedule', () => { + const fakePath = '/rendered/path/schedule'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + schedule: 'scheduleValue', + }; + const client = new modelserviceModule.v1.ModelServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.schedulePathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.schedulePathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('schedulePath', () => { + const result = client.schedulePath( + 'projectValue', + 'locationValue', + 'scheduleValue' + ); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.schedulePathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromScheduleName', () => { + const result = client.matchProjectFromScheduleName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromScheduleName', () => { + const result = client.matchLocationFromScheduleName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchScheduleFromScheduleName', () => { + const result = client.matchScheduleFromScheduleName(fakePath); + assert.strictEqual(result, 'scheduleValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + describe('specialistPool', () => { const fakePath = '/rendered/path/specialistPool'; const expectedParameters = { diff --git a/packages/google-cloud-aiplatform/test/gapic_pipeline_service_v1.ts b/packages/google-cloud-aiplatform/test/gapic_pipeline_service_v1.ts index 3a6cbf4fcef..058582ee712 100644 --- a/packages/google-cloud-aiplatform/test/gapic_pipeline_service_v1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_pipeline_service_v1.ts @@ -5159,6 +5159,70 @@ describe('v1.PipelineServiceClient', () => { }); }); + describe('schedule', () => { + const fakePath = '/rendered/path/schedule'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + schedule: 'scheduleValue', + }; + const client = new pipelineserviceModule.v1.PipelineServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.schedulePathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.schedulePathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('schedulePath', () => { + const result = client.schedulePath( + 'projectValue', + 'locationValue', + 'scheduleValue' + ); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.schedulePathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromScheduleName', () => { + const result = client.matchProjectFromScheduleName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromScheduleName', () => { + const result = client.matchLocationFromScheduleName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchScheduleFromScheduleName', () => { + const result = client.matchScheduleFromScheduleName(fakePath); + assert.strictEqual(result, 'scheduleValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + describe('specialistPool', () => { const fakePath = '/rendered/path/specialistPool'; const expectedParameters = { diff --git a/packages/google-cloud-aiplatform/test/gapic_prediction_service_v1.ts b/packages/google-cloud-aiplatform/test/gapic_prediction_service_v1.ts index a2888a3ed87..f114579cd16 100644 --- a/packages/google-cloud-aiplatform/test/gapic_prediction_service_v1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_prediction_service_v1.ts @@ -23,6 +23,8 @@ import {SinonStub} from 'sinon'; import {describe, it} from 'mocha'; import * as predictionserviceModule from '../src'; +import {PassThrough} from 'stream'; + import {protobuf, IamProtos, LocationProtos} from 'google-gax'; // Dynamically loaded proto JSON is needed to get the type information @@ -64,6 +66,27 @@ function stubSimpleCallWithCallback( : sinon.stub().callsArgWith(2, null, response); } +function stubServerStreamingCall( + response?: ResponseType, + error?: Error +) { + const transformStub = error + ? sinon.stub().callsArgWith(2, error) + : sinon.stub().callsArgWith(2, null, response); + const mockStream = new PassThrough({ + objectMode: true, + transform: transformStub, + }); + // write something to the stream to trigger transformStub and send the response back to the client + setImmediate(() => { + mockStream.write({}); + }); + setImmediate(() => { + mockStream.end(); + }); + return sinon.stub().returns(mockStream); +} + function stubAsyncIterationCall( responses?: ResponseType[], error?: Error @@ -567,6 +590,132 @@ describe('v1.PredictionServiceClient', () => { await assert.rejects(client.explain(request), expectedError); }); }); + + describe('serverStreamingPredict', () => { + it('invokes serverStreamingPredict without error', async () => { + const client = new predictionserviceModule.v1.PredictionServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.StreamingPredictRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.StreamingPredictRequest', + ['endpoint'] + ); + request.endpoint = defaultValue1; + const expectedHeaderRequestParams = `endpoint=${defaultValue1}`; + const expectedResponse = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.StreamingPredictResponse() + ); + client.innerApiCalls.serverStreamingPredict = + stubServerStreamingCall(expectedResponse); + const stream = client.serverStreamingPredict(request); + const promise = new Promise((resolve, reject) => { + stream.on( + 'data', + ( + response: protos.google.cloud.aiplatform.v1.StreamingPredictResponse + ) => { + resolve(response); + } + ); + stream.on('error', (err: Error) => { + reject(err); + }); + }); + const response = await promise; + assert.deepStrictEqual(response, expectedResponse); + const actualRequest = ( + client.innerApiCalls.serverStreamingPredict as SinonStub + ).getCall(0).args[0]; + assert.deepStrictEqual(actualRequest, request); + const actualHeaderRequestParams = ( + client.innerApiCalls.serverStreamingPredict as SinonStub + ).getCall(0).args[1].otherArgs.headers['x-goog-request-params']; + assert(actualHeaderRequestParams.includes(expectedHeaderRequestParams)); + }); + + it('invokes serverStreamingPredict with error', async () => { + const client = new predictionserviceModule.v1.PredictionServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.StreamingPredictRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.StreamingPredictRequest', + ['endpoint'] + ); + request.endpoint = defaultValue1; + const expectedHeaderRequestParams = `endpoint=${defaultValue1}`; + const expectedError = new Error('expected'); + client.innerApiCalls.serverStreamingPredict = stubServerStreamingCall( + undefined, + expectedError + ); + const stream = client.serverStreamingPredict(request); + const promise = new Promise((resolve, reject) => { + stream.on( + 'data', + ( + response: protos.google.cloud.aiplatform.v1.StreamingPredictResponse + ) => { + resolve(response); + } + ); + stream.on('error', (err: Error) => { + reject(err); + }); + }); + await assert.rejects(promise, expectedError); + const actualRequest = ( + client.innerApiCalls.serverStreamingPredict as SinonStub + ).getCall(0).args[0]; + assert.deepStrictEqual(actualRequest, request); + const actualHeaderRequestParams = ( + client.innerApiCalls.serverStreamingPredict as SinonStub + ).getCall(0).args[1].otherArgs.headers['x-goog-request-params']; + assert(actualHeaderRequestParams.includes(expectedHeaderRequestParams)); + }); + + it('invokes serverStreamingPredict with closed client', async () => { + const client = new predictionserviceModule.v1.PredictionServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.StreamingPredictRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.StreamingPredictRequest', + ['endpoint'] + ); + request.endpoint = defaultValue1; + const expectedError = new Error('The client has already been closed.'); + client.close(); + const stream = client.serverStreamingPredict(request); + const promise = new Promise((resolve, reject) => { + stream.on( + 'data', + ( + response: protos.google.cloud.aiplatform.v1.StreamingPredictResponse + ) => { + resolve(response); + } + ); + stream.on('error', (err: Error) => { + reject(err); + }); + }); + await assert.rejects(promise, expectedError); + }); + }); describe('getIamPolicy', () => { it('invokes getIamPolicy without error', async () => { const client = new predictionserviceModule.v1.PredictionServiceClient({ @@ -3242,6 +3391,70 @@ describe('v1.PredictionServiceClient', () => { }); }); + describe('schedule', () => { + const fakePath = '/rendered/path/schedule'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + schedule: 'scheduleValue', + }; + const client = new predictionserviceModule.v1.PredictionServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.schedulePathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.schedulePathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('schedulePath', () => { + const result = client.schedulePath( + 'projectValue', + 'locationValue', + 'scheduleValue' + ); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.schedulePathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromScheduleName', () => { + const result = client.matchProjectFromScheduleName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromScheduleName', () => { + const result = client.matchLocationFromScheduleName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchScheduleFromScheduleName', () => { + const result = client.matchScheduleFromScheduleName(fakePath); + assert.strictEqual(result, 'scheduleValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + describe('specialistPool', () => { const fakePath = '/rendered/path/specialistPool'; const expectedParameters = { diff --git a/packages/google-cloud-aiplatform/test/gapic_prediction_service_v1beta1.ts b/packages/google-cloud-aiplatform/test/gapic_prediction_service_v1beta1.ts index 36147d684d3..0e6b730cff5 100644 --- a/packages/google-cloud-aiplatform/test/gapic_prediction_service_v1beta1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_prediction_service_v1beta1.ts @@ -23,6 +23,8 @@ import {SinonStub} from 'sinon'; import {describe, it} from 'mocha'; import * as predictionserviceModule from '../src'; +import {PassThrough} from 'stream'; + import {protobuf, IamProtos, LocationProtos} from 'google-gax'; // Dynamically loaded proto JSON is needed to get the type information @@ -64,6 +66,27 @@ function stubSimpleCallWithCallback( : sinon.stub().callsArgWith(2, null, response); } +function stubServerStreamingCall( + response?: ResponseType, + error?: Error +) { + const transformStub = error + ? sinon.stub().callsArgWith(2, error) + : sinon.stub().callsArgWith(2, null, response); + const mockStream = new PassThrough({ + objectMode: true, + transform: transformStub, + }); + // write something to the stream to trigger transformStub and send the response back to the client + setImmediate(() => { + mockStream.write({}); + }); + setImmediate(() => { + mockStream.end(); + }); + return sinon.stub().returns(mockStream); +} + function stubAsyncIterationCall( responses?: ResponseType[], error?: Error @@ -586,6 +609,135 @@ describe('v1beta1.PredictionServiceClient', () => { await assert.rejects(client.explain(request), expectedError); }); }); + + describe('serverStreamingPredict', () => { + it('invokes serverStreamingPredict without error', async () => { + const client = + new predictionserviceModule.v1beta1.PredictionServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1beta1.StreamingPredictRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1beta1.StreamingPredictRequest', + ['endpoint'] + ); + request.endpoint = defaultValue1; + const expectedHeaderRequestParams = `endpoint=${defaultValue1}`; + const expectedResponse = generateSampleMessage( + new protos.google.cloud.aiplatform.v1beta1.StreamingPredictResponse() + ); + client.innerApiCalls.serverStreamingPredict = + stubServerStreamingCall(expectedResponse); + const stream = client.serverStreamingPredict(request); + const promise = new Promise((resolve, reject) => { + stream.on( + 'data', + ( + response: protos.google.cloud.aiplatform.v1beta1.StreamingPredictResponse + ) => { + resolve(response); + } + ); + stream.on('error', (err: Error) => { + reject(err); + }); + }); + const response = await promise; + assert.deepStrictEqual(response, expectedResponse); + const actualRequest = ( + client.innerApiCalls.serverStreamingPredict as SinonStub + ).getCall(0).args[0]; + assert.deepStrictEqual(actualRequest, request); + const actualHeaderRequestParams = ( + client.innerApiCalls.serverStreamingPredict as SinonStub + ).getCall(0).args[1].otherArgs.headers['x-goog-request-params']; + assert(actualHeaderRequestParams.includes(expectedHeaderRequestParams)); + }); + + it('invokes serverStreamingPredict with error', async () => { + const client = + new predictionserviceModule.v1beta1.PredictionServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1beta1.StreamingPredictRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1beta1.StreamingPredictRequest', + ['endpoint'] + ); + request.endpoint = defaultValue1; + const expectedHeaderRequestParams = `endpoint=${defaultValue1}`; + const expectedError = new Error('expected'); + client.innerApiCalls.serverStreamingPredict = stubServerStreamingCall( + undefined, + expectedError + ); + const stream = client.serverStreamingPredict(request); + const promise = new Promise((resolve, reject) => { + stream.on( + 'data', + ( + response: protos.google.cloud.aiplatform.v1beta1.StreamingPredictResponse + ) => { + resolve(response); + } + ); + stream.on('error', (err: Error) => { + reject(err); + }); + }); + await assert.rejects(promise, expectedError); + const actualRequest = ( + client.innerApiCalls.serverStreamingPredict as SinonStub + ).getCall(0).args[0]; + assert.deepStrictEqual(actualRequest, request); + const actualHeaderRequestParams = ( + client.innerApiCalls.serverStreamingPredict as SinonStub + ).getCall(0).args[1].otherArgs.headers['x-goog-request-params']; + assert(actualHeaderRequestParams.includes(expectedHeaderRequestParams)); + }); + + it('invokes serverStreamingPredict with closed client', async () => { + const client = + new predictionserviceModule.v1beta1.PredictionServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1beta1.StreamingPredictRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1beta1.StreamingPredictRequest', + ['endpoint'] + ); + request.endpoint = defaultValue1; + const expectedError = new Error('The client has already been closed.'); + client.close(); + const stream = client.serverStreamingPredict(request); + const promise = new Promise((resolve, reject) => { + stream.on( + 'data', + ( + response: protos.google.cloud.aiplatform.v1beta1.StreamingPredictResponse + ) => { + resolve(response); + } + ); + stream.on('error', (err: Error) => { + reject(err); + }); + }); + await assert.rejects(promise, expectedError); + }); + }); describe('getIamPolicy', () => { it('invokes getIamPolicy without error', async () => { const client = diff --git a/packages/google-cloud-aiplatform/test/gapic_schedule_service_v1.ts b/packages/google-cloud-aiplatform/test/gapic_schedule_service_v1.ts new file mode 100644 index 00000000000..c0462918f92 --- /dev/null +++ b/packages/google-cloud-aiplatform/test/gapic_schedule_service_v1.ts @@ -0,0 +1,5155 @@ +// Copyright 2023 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. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + +import * as protos from '../protos/protos'; +import * as assert from 'assert'; +import * as sinon from 'sinon'; +import {SinonStub} from 'sinon'; +import {describe, it} from 'mocha'; +import * as scheduleserviceModule from '../src'; + +import {PassThrough} from 'stream'; + +import { + protobuf, + LROperation, + operationsProtos, + IamProtos, + LocationProtos, +} from 'google-gax'; + +// Dynamically loaded proto JSON is needed to get the type information +// to fill in default values for request objects +const root = protobuf.Root.fromJSON( + require('../protos/protos.json') +).resolveAll(); + +// eslint-disable-next-line @typescript-eslint/no-unused-vars +function getTypeDefaultValue(typeName: string, fields: string[]) { + let type = root.lookupType(typeName) as protobuf.Type; + for (const field of fields.slice(0, -1)) { + type = type.fields[field]?.resolvedType as protobuf.Type; + } + return type.fields[fields[fields.length - 1]]?.defaultValue; +} + +function generateSampleMessage(instance: T) { + const filledObject = ( + instance.constructor as typeof protobuf.Message + ).toObject(instance as protobuf.Message, {defaults: true}); + return (instance.constructor as typeof protobuf.Message).fromObject( + filledObject + ) as T; +} + +function stubSimpleCall(response?: ResponseType, error?: Error) { + return error + ? sinon.stub().rejects(error) + : sinon.stub().resolves([response]); +} + +function stubSimpleCallWithCallback( + response?: ResponseType, + error?: Error +) { + return error + ? sinon.stub().callsArgWith(2, error) + : sinon.stub().callsArgWith(2, null, response); +} + +function stubLongRunningCall( + response?: ResponseType, + callError?: Error, + lroError?: Error +) { + const innerStub = lroError + ? sinon.stub().rejects(lroError) + : sinon.stub().resolves([response]); + const mockOperation = { + promise: innerStub, + }; + return callError + ? sinon.stub().rejects(callError) + : sinon.stub().resolves([mockOperation]); +} + +function stubLongRunningCallWithCallback( + response?: ResponseType, + callError?: Error, + lroError?: Error +) { + const innerStub = lroError + ? sinon.stub().rejects(lroError) + : sinon.stub().resolves([response]); + const mockOperation = { + promise: innerStub, + }; + return callError + ? sinon.stub().callsArgWith(2, callError) + : sinon.stub().callsArgWith(2, null, mockOperation); +} + +function stubPageStreamingCall( + responses?: ResponseType[], + error?: Error +) { + const pagingStub = sinon.stub(); + if (responses) { + for (let i = 0; i < responses.length; ++i) { + pagingStub.onCall(i).callsArgWith(2, null, responses[i]); + } + } + const transformStub = error + ? sinon.stub().callsArgWith(2, error) + : pagingStub; + const mockStream = new PassThrough({ + objectMode: true, + transform: transformStub, + }); + // trigger as many responses as needed + if (responses) { + for (let i = 0; i < responses.length; ++i) { + setImmediate(() => { + mockStream.write({}); + }); + } + setImmediate(() => { + mockStream.end(); + }); + } else { + setImmediate(() => { + mockStream.write({}); + }); + setImmediate(() => { + mockStream.end(); + }); + } + return sinon.stub().returns(mockStream); +} + +function stubAsyncIterationCall( + responses?: ResponseType[], + error?: Error +) { + let counter = 0; + const asyncIterable = { + [Symbol.asyncIterator]() { + return { + async next() { + if (error) { + return Promise.reject(error); + } + if (counter >= responses!.length) { + return Promise.resolve({done: true, value: undefined}); + } + return Promise.resolve({done: false, value: responses![counter++]}); + }, + }; + }, + }; + return sinon.stub().returns(asyncIterable); +} + +describe('v1.ScheduleServiceClient', () => { + describe('Common methods', () => { + it('has servicePath', () => { + const servicePath = + scheduleserviceModule.v1.ScheduleServiceClient.servicePath; + assert(servicePath); + }); + + it('has apiEndpoint', () => { + const apiEndpoint = + scheduleserviceModule.v1.ScheduleServiceClient.apiEndpoint; + assert(apiEndpoint); + }); + + it('has port', () => { + const port = scheduleserviceModule.v1.ScheduleServiceClient.port; + assert(port); + assert(typeof port === 'number'); + }); + + it('should create a client with no option', () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient(); + assert(client); + }); + + it('should create a client with gRPC fallback', () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + fallback: true, + }); + assert(client); + }); + + it('has initialize method and supports deferred initialization', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + assert.strictEqual(client.scheduleServiceStub, undefined); + await client.initialize(); + assert(client.scheduleServiceStub); + }); + + it('has close method for the initialized client', done => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + assert(client.scheduleServiceStub); + client.close().then(() => { + done(); + }); + }); + + it('has close method for the non-initialized client', done => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + assert.strictEqual(client.scheduleServiceStub, undefined); + client.close().then(() => { + done(); + }); + }); + + it('has getProjectId method', async () => { + const fakeProjectId = 'fake-project-id'; + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.auth.getProjectId = sinon.stub().resolves(fakeProjectId); + const result = await client.getProjectId(); + assert.strictEqual(result, fakeProjectId); + assert((client.auth.getProjectId as SinonStub).calledWithExactly()); + }); + + it('has getProjectId method with callback', async () => { + const fakeProjectId = 'fake-project-id'; + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.auth.getProjectId = sinon + .stub() + .callsArgWith(0, null, fakeProjectId); + const promise = new Promise((resolve, reject) => { + client.getProjectId((err?: Error | null, projectId?: string | null) => { + if (err) { + reject(err); + } else { + resolve(projectId); + } + }); + }); + const result = await promise; + assert.strictEqual(result, fakeProjectId); + }); + }); + + describe('createSchedule', () => { + it('invokes createSchedule without error', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.CreateScheduleRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.CreateScheduleRequest', + ['parent'] + ); + request.parent = defaultValue1; + const expectedHeaderRequestParams = `parent=${defaultValue1}`; + const expectedResponse = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.Schedule() + ); + client.innerApiCalls.createSchedule = stubSimpleCall(expectedResponse); + const [response] = await client.createSchedule(request); + assert.deepStrictEqual(response, expectedResponse); + const actualRequest = ( + client.innerApiCalls.createSchedule as SinonStub + ).getCall(0).args[0]; + assert.deepStrictEqual(actualRequest, request); + const actualHeaderRequestParams = ( + client.innerApiCalls.createSchedule as SinonStub + ).getCall(0).args[1].otherArgs.headers['x-goog-request-params']; + assert(actualHeaderRequestParams.includes(expectedHeaderRequestParams)); + }); + + it('invokes createSchedule without error using callback', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.CreateScheduleRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.CreateScheduleRequest', + ['parent'] + ); + request.parent = defaultValue1; + const expectedHeaderRequestParams = `parent=${defaultValue1}`; + const expectedResponse = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.Schedule() + ); + client.innerApiCalls.createSchedule = + stubSimpleCallWithCallback(expectedResponse); + const promise = new Promise((resolve, reject) => { + client.createSchedule( + request, + ( + err?: Error | null, + result?: protos.google.cloud.aiplatform.v1.ISchedule | null + ) => { + if (err) { + reject(err); + } else { + resolve(result); + } + } + ); + }); + const response = await promise; + assert.deepStrictEqual(response, expectedResponse); + const actualRequest = ( + client.innerApiCalls.createSchedule as SinonStub + ).getCall(0).args[0]; + assert.deepStrictEqual(actualRequest, request); + const actualHeaderRequestParams = ( + client.innerApiCalls.createSchedule as SinonStub + ).getCall(0).args[1].otherArgs.headers['x-goog-request-params']; + assert(actualHeaderRequestParams.includes(expectedHeaderRequestParams)); + }); + + it('invokes createSchedule with error', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.CreateScheduleRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.CreateScheduleRequest', + ['parent'] + ); + request.parent = defaultValue1; + const expectedHeaderRequestParams = `parent=${defaultValue1}`; + const expectedError = new Error('expected'); + client.innerApiCalls.createSchedule = stubSimpleCall( + undefined, + expectedError + ); + await assert.rejects(client.createSchedule(request), expectedError); + const actualRequest = ( + client.innerApiCalls.createSchedule as SinonStub + ).getCall(0).args[0]; + assert.deepStrictEqual(actualRequest, request); + const actualHeaderRequestParams = ( + client.innerApiCalls.createSchedule as SinonStub + ).getCall(0).args[1].otherArgs.headers['x-goog-request-params']; + assert(actualHeaderRequestParams.includes(expectedHeaderRequestParams)); + }); + + it('invokes createSchedule with closed client', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.CreateScheduleRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.CreateScheduleRequest', + ['parent'] + ); + request.parent = defaultValue1; + const expectedError = new Error('The client has already been closed.'); + client.close(); + await assert.rejects(client.createSchedule(request), expectedError); + }); + }); + + describe('getSchedule', () => { + it('invokes getSchedule without error', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.GetScheduleRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.GetScheduleRequest', + ['name'] + ); + request.name = defaultValue1; + const expectedHeaderRequestParams = `name=${defaultValue1}`; + const expectedResponse = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.Schedule() + ); + client.innerApiCalls.getSchedule = stubSimpleCall(expectedResponse); + const [response] = await client.getSchedule(request); + assert.deepStrictEqual(response, expectedResponse); + const actualRequest = ( + client.innerApiCalls.getSchedule as SinonStub + ).getCall(0).args[0]; + assert.deepStrictEqual(actualRequest, request); + const actualHeaderRequestParams = ( + client.innerApiCalls.getSchedule as SinonStub + ).getCall(0).args[1].otherArgs.headers['x-goog-request-params']; + assert(actualHeaderRequestParams.includes(expectedHeaderRequestParams)); + }); + + it('invokes getSchedule without error using callback', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.GetScheduleRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.GetScheduleRequest', + ['name'] + ); + request.name = defaultValue1; + const expectedHeaderRequestParams = `name=${defaultValue1}`; + const expectedResponse = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.Schedule() + ); + client.innerApiCalls.getSchedule = + stubSimpleCallWithCallback(expectedResponse); + const promise = new Promise((resolve, reject) => { + client.getSchedule( + request, + ( + err?: Error | null, + result?: protos.google.cloud.aiplatform.v1.ISchedule | null + ) => { + if (err) { + reject(err); + } else { + resolve(result); + } + } + ); + }); + const response = await promise; + assert.deepStrictEqual(response, expectedResponse); + const actualRequest = ( + client.innerApiCalls.getSchedule as SinonStub + ).getCall(0).args[0]; + assert.deepStrictEqual(actualRequest, request); + const actualHeaderRequestParams = ( + client.innerApiCalls.getSchedule as SinonStub + ).getCall(0).args[1].otherArgs.headers['x-goog-request-params']; + assert(actualHeaderRequestParams.includes(expectedHeaderRequestParams)); + }); + + it('invokes getSchedule with error', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.GetScheduleRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.GetScheduleRequest', + ['name'] + ); + request.name = defaultValue1; + const expectedHeaderRequestParams = `name=${defaultValue1}`; + const expectedError = new Error('expected'); + client.innerApiCalls.getSchedule = stubSimpleCall( + undefined, + expectedError + ); + await assert.rejects(client.getSchedule(request), expectedError); + const actualRequest = ( + client.innerApiCalls.getSchedule as SinonStub + ).getCall(0).args[0]; + assert.deepStrictEqual(actualRequest, request); + const actualHeaderRequestParams = ( + client.innerApiCalls.getSchedule as SinonStub + ).getCall(0).args[1].otherArgs.headers['x-goog-request-params']; + assert(actualHeaderRequestParams.includes(expectedHeaderRequestParams)); + }); + + it('invokes getSchedule with closed client', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.GetScheduleRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.GetScheduleRequest', + ['name'] + ); + request.name = defaultValue1; + const expectedError = new Error('The client has already been closed.'); + client.close(); + await assert.rejects(client.getSchedule(request), expectedError); + }); + }); + + describe('pauseSchedule', () => { + it('invokes pauseSchedule without error', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.PauseScheduleRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.PauseScheduleRequest', + ['name'] + ); + request.name = defaultValue1; + const expectedHeaderRequestParams = `name=${defaultValue1}`; + const expectedResponse = generateSampleMessage( + new protos.google.protobuf.Empty() + ); + client.innerApiCalls.pauseSchedule = stubSimpleCall(expectedResponse); + const [response] = await client.pauseSchedule(request); + assert.deepStrictEqual(response, expectedResponse); + const actualRequest = ( + client.innerApiCalls.pauseSchedule as SinonStub + ).getCall(0).args[0]; + assert.deepStrictEqual(actualRequest, request); + const actualHeaderRequestParams = ( + client.innerApiCalls.pauseSchedule as SinonStub + ).getCall(0).args[1].otherArgs.headers['x-goog-request-params']; + assert(actualHeaderRequestParams.includes(expectedHeaderRequestParams)); + }); + + it('invokes pauseSchedule without error using callback', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.PauseScheduleRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.PauseScheduleRequest', + ['name'] + ); + request.name = defaultValue1; + const expectedHeaderRequestParams = `name=${defaultValue1}`; + const expectedResponse = generateSampleMessage( + new protos.google.protobuf.Empty() + ); + client.innerApiCalls.pauseSchedule = + stubSimpleCallWithCallback(expectedResponse); + const promise = new Promise((resolve, reject) => { + client.pauseSchedule( + request, + ( + err?: Error | null, + result?: protos.google.protobuf.IEmpty | null + ) => { + if (err) { + reject(err); + } else { + resolve(result); + } + } + ); + }); + const response = await promise; + assert.deepStrictEqual(response, expectedResponse); + const actualRequest = ( + client.innerApiCalls.pauseSchedule as SinonStub + ).getCall(0).args[0]; + assert.deepStrictEqual(actualRequest, request); + const actualHeaderRequestParams = ( + client.innerApiCalls.pauseSchedule as SinonStub + ).getCall(0).args[1].otherArgs.headers['x-goog-request-params']; + assert(actualHeaderRequestParams.includes(expectedHeaderRequestParams)); + }); + + it('invokes pauseSchedule with error', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.PauseScheduleRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.PauseScheduleRequest', + ['name'] + ); + request.name = defaultValue1; + const expectedHeaderRequestParams = `name=${defaultValue1}`; + const expectedError = new Error('expected'); + client.innerApiCalls.pauseSchedule = stubSimpleCall( + undefined, + expectedError + ); + await assert.rejects(client.pauseSchedule(request), expectedError); + const actualRequest = ( + client.innerApiCalls.pauseSchedule as SinonStub + ).getCall(0).args[0]; + assert.deepStrictEqual(actualRequest, request); + const actualHeaderRequestParams = ( + client.innerApiCalls.pauseSchedule as SinonStub + ).getCall(0).args[1].otherArgs.headers['x-goog-request-params']; + assert(actualHeaderRequestParams.includes(expectedHeaderRequestParams)); + }); + + it('invokes pauseSchedule with closed client', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.PauseScheduleRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.PauseScheduleRequest', + ['name'] + ); + request.name = defaultValue1; + const expectedError = new Error('The client has already been closed.'); + client.close(); + await assert.rejects(client.pauseSchedule(request), expectedError); + }); + }); + + describe('resumeSchedule', () => { + it('invokes resumeSchedule without error', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.ResumeScheduleRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.ResumeScheduleRequest', + ['name'] + ); + request.name = defaultValue1; + const expectedHeaderRequestParams = `name=${defaultValue1}`; + const expectedResponse = generateSampleMessage( + new protos.google.protobuf.Empty() + ); + client.innerApiCalls.resumeSchedule = stubSimpleCall(expectedResponse); + const [response] = await client.resumeSchedule(request); + assert.deepStrictEqual(response, expectedResponse); + const actualRequest = ( + client.innerApiCalls.resumeSchedule as SinonStub + ).getCall(0).args[0]; + assert.deepStrictEqual(actualRequest, request); + const actualHeaderRequestParams = ( + client.innerApiCalls.resumeSchedule as SinonStub + ).getCall(0).args[1].otherArgs.headers['x-goog-request-params']; + assert(actualHeaderRequestParams.includes(expectedHeaderRequestParams)); + }); + + it('invokes resumeSchedule without error using callback', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.ResumeScheduleRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.ResumeScheduleRequest', + ['name'] + ); + request.name = defaultValue1; + const expectedHeaderRequestParams = `name=${defaultValue1}`; + const expectedResponse = generateSampleMessage( + new protos.google.protobuf.Empty() + ); + client.innerApiCalls.resumeSchedule = + stubSimpleCallWithCallback(expectedResponse); + const promise = new Promise((resolve, reject) => { + client.resumeSchedule( + request, + ( + err?: Error | null, + result?: protos.google.protobuf.IEmpty | null + ) => { + if (err) { + reject(err); + } else { + resolve(result); + } + } + ); + }); + const response = await promise; + assert.deepStrictEqual(response, expectedResponse); + const actualRequest = ( + client.innerApiCalls.resumeSchedule as SinonStub + ).getCall(0).args[0]; + assert.deepStrictEqual(actualRequest, request); + const actualHeaderRequestParams = ( + client.innerApiCalls.resumeSchedule as SinonStub + ).getCall(0).args[1].otherArgs.headers['x-goog-request-params']; + assert(actualHeaderRequestParams.includes(expectedHeaderRequestParams)); + }); + + it('invokes resumeSchedule with error', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.ResumeScheduleRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.ResumeScheduleRequest', + ['name'] + ); + request.name = defaultValue1; + const expectedHeaderRequestParams = `name=${defaultValue1}`; + const expectedError = new Error('expected'); + client.innerApiCalls.resumeSchedule = stubSimpleCall( + undefined, + expectedError + ); + await assert.rejects(client.resumeSchedule(request), expectedError); + const actualRequest = ( + client.innerApiCalls.resumeSchedule as SinonStub + ).getCall(0).args[0]; + assert.deepStrictEqual(actualRequest, request); + const actualHeaderRequestParams = ( + client.innerApiCalls.resumeSchedule as SinonStub + ).getCall(0).args[1].otherArgs.headers['x-goog-request-params']; + assert(actualHeaderRequestParams.includes(expectedHeaderRequestParams)); + }); + + it('invokes resumeSchedule with closed client', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.ResumeScheduleRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.ResumeScheduleRequest', + ['name'] + ); + request.name = defaultValue1; + const expectedError = new Error('The client has already been closed.'); + client.close(); + await assert.rejects(client.resumeSchedule(request), expectedError); + }); + }); + + describe('updateSchedule', () => { + it('invokes updateSchedule without error', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.UpdateScheduleRequest() + ); + request.schedule ??= {}; + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.UpdateScheduleRequest', + ['schedule', 'name'] + ); + request.schedule.name = defaultValue1; + const expectedHeaderRequestParams = `schedule.name=${defaultValue1}`; + const expectedResponse = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.Schedule() + ); + client.innerApiCalls.updateSchedule = stubSimpleCall(expectedResponse); + const [response] = await client.updateSchedule(request); + assert.deepStrictEqual(response, expectedResponse); + const actualRequest = ( + client.innerApiCalls.updateSchedule as SinonStub + ).getCall(0).args[0]; + assert.deepStrictEqual(actualRequest, request); + const actualHeaderRequestParams = ( + client.innerApiCalls.updateSchedule as SinonStub + ).getCall(0).args[1].otherArgs.headers['x-goog-request-params']; + assert(actualHeaderRequestParams.includes(expectedHeaderRequestParams)); + }); + + it('invokes updateSchedule without error using callback', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.UpdateScheduleRequest() + ); + request.schedule ??= {}; + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.UpdateScheduleRequest', + ['schedule', 'name'] + ); + request.schedule.name = defaultValue1; + const expectedHeaderRequestParams = `schedule.name=${defaultValue1}`; + const expectedResponse = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.Schedule() + ); + client.innerApiCalls.updateSchedule = + stubSimpleCallWithCallback(expectedResponse); + const promise = new Promise((resolve, reject) => { + client.updateSchedule( + request, + ( + err?: Error | null, + result?: protos.google.cloud.aiplatform.v1.ISchedule | null + ) => { + if (err) { + reject(err); + } else { + resolve(result); + } + } + ); + }); + const response = await promise; + assert.deepStrictEqual(response, expectedResponse); + const actualRequest = ( + client.innerApiCalls.updateSchedule as SinonStub + ).getCall(0).args[0]; + assert.deepStrictEqual(actualRequest, request); + const actualHeaderRequestParams = ( + client.innerApiCalls.updateSchedule as SinonStub + ).getCall(0).args[1].otherArgs.headers['x-goog-request-params']; + assert(actualHeaderRequestParams.includes(expectedHeaderRequestParams)); + }); + + it('invokes updateSchedule with error', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.UpdateScheduleRequest() + ); + request.schedule ??= {}; + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.UpdateScheduleRequest', + ['schedule', 'name'] + ); + request.schedule.name = defaultValue1; + const expectedHeaderRequestParams = `schedule.name=${defaultValue1}`; + const expectedError = new Error('expected'); + client.innerApiCalls.updateSchedule = stubSimpleCall( + undefined, + expectedError + ); + await assert.rejects(client.updateSchedule(request), expectedError); + const actualRequest = ( + client.innerApiCalls.updateSchedule as SinonStub + ).getCall(0).args[0]; + assert.deepStrictEqual(actualRequest, request); + const actualHeaderRequestParams = ( + client.innerApiCalls.updateSchedule as SinonStub + ).getCall(0).args[1].otherArgs.headers['x-goog-request-params']; + assert(actualHeaderRequestParams.includes(expectedHeaderRequestParams)); + }); + + it('invokes updateSchedule with closed client', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.UpdateScheduleRequest() + ); + request.schedule ??= {}; + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.UpdateScheduleRequest', + ['schedule', 'name'] + ); + request.schedule.name = defaultValue1; + const expectedError = new Error('The client has already been closed.'); + client.close(); + await assert.rejects(client.updateSchedule(request), expectedError); + }); + }); + + describe('deleteSchedule', () => { + it('invokes deleteSchedule without error', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.DeleteScheduleRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.DeleteScheduleRequest', + ['name'] + ); + request.name = defaultValue1; + const expectedHeaderRequestParams = `name=${defaultValue1}`; + const expectedResponse = generateSampleMessage( + new protos.google.longrunning.Operation() + ); + client.innerApiCalls.deleteSchedule = + stubLongRunningCall(expectedResponse); + const [operation] = await client.deleteSchedule(request); + const [response] = await operation.promise(); + assert.deepStrictEqual(response, expectedResponse); + const actualRequest = ( + client.innerApiCalls.deleteSchedule as SinonStub + ).getCall(0).args[0]; + assert.deepStrictEqual(actualRequest, request); + const actualHeaderRequestParams = ( + client.innerApiCalls.deleteSchedule as SinonStub + ).getCall(0).args[1].otherArgs.headers['x-goog-request-params']; + assert(actualHeaderRequestParams.includes(expectedHeaderRequestParams)); + }); + + it('invokes deleteSchedule without error using callback', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.DeleteScheduleRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.DeleteScheduleRequest', + ['name'] + ); + request.name = defaultValue1; + const expectedHeaderRequestParams = `name=${defaultValue1}`; + const expectedResponse = generateSampleMessage( + new protos.google.longrunning.Operation() + ); + client.innerApiCalls.deleteSchedule = + stubLongRunningCallWithCallback(expectedResponse); + const promise = new Promise((resolve, reject) => { + client.deleteSchedule( + request, + ( + err?: Error | null, + result?: LROperation< + protos.google.protobuf.IEmpty, + protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata + > | null + ) => { + if (err) { + reject(err); + } else { + resolve(result); + } + } + ); + }); + const operation = (await promise) as LROperation< + protos.google.protobuf.IEmpty, + protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata + >; + const [response] = await operation.promise(); + assert.deepStrictEqual(response, expectedResponse); + const actualRequest = ( + client.innerApiCalls.deleteSchedule as SinonStub + ).getCall(0).args[0]; + assert.deepStrictEqual(actualRequest, request); + const actualHeaderRequestParams = ( + client.innerApiCalls.deleteSchedule as SinonStub + ).getCall(0).args[1].otherArgs.headers['x-goog-request-params']; + assert(actualHeaderRequestParams.includes(expectedHeaderRequestParams)); + }); + + it('invokes deleteSchedule with call error', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.DeleteScheduleRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.DeleteScheduleRequest', + ['name'] + ); + request.name = defaultValue1; + const expectedHeaderRequestParams = `name=${defaultValue1}`; + const expectedError = new Error('expected'); + client.innerApiCalls.deleteSchedule = stubLongRunningCall( + undefined, + expectedError + ); + await assert.rejects(client.deleteSchedule(request), expectedError); + const actualRequest = ( + client.innerApiCalls.deleteSchedule as SinonStub + ).getCall(0).args[0]; + assert.deepStrictEqual(actualRequest, request); + const actualHeaderRequestParams = ( + client.innerApiCalls.deleteSchedule as SinonStub + ).getCall(0).args[1].otherArgs.headers['x-goog-request-params']; + assert(actualHeaderRequestParams.includes(expectedHeaderRequestParams)); + }); + + it('invokes deleteSchedule with LRO error', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.DeleteScheduleRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.DeleteScheduleRequest', + ['name'] + ); + request.name = defaultValue1; + const expectedHeaderRequestParams = `name=${defaultValue1}`; + const expectedError = new Error('expected'); + client.innerApiCalls.deleteSchedule = stubLongRunningCall( + undefined, + undefined, + expectedError + ); + const [operation] = await client.deleteSchedule(request); + await assert.rejects(operation.promise(), expectedError); + const actualRequest = ( + client.innerApiCalls.deleteSchedule as SinonStub + ).getCall(0).args[0]; + assert.deepStrictEqual(actualRequest, request); + const actualHeaderRequestParams = ( + client.innerApiCalls.deleteSchedule as SinonStub + ).getCall(0).args[1].otherArgs.headers['x-goog-request-params']; + assert(actualHeaderRequestParams.includes(expectedHeaderRequestParams)); + }); + + it('invokes checkDeleteScheduleProgress without error', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const expectedResponse = generateSampleMessage( + new operationsProtos.google.longrunning.Operation() + ); + expectedResponse.name = 'test'; + expectedResponse.response = {type_url: 'url', value: Buffer.from('')}; + expectedResponse.metadata = {type_url: 'url', value: Buffer.from('')}; + + client.operationsClient.getOperation = stubSimpleCall(expectedResponse); + const decodedOperation = await client.checkDeleteScheduleProgress( + expectedResponse.name + ); + assert.deepStrictEqual(decodedOperation.name, expectedResponse.name); + assert(decodedOperation.metadata); + assert((client.operationsClient.getOperation as SinonStub).getCall(0)); + }); + + it('invokes checkDeleteScheduleProgress with error', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const expectedError = new Error('expected'); + + client.operationsClient.getOperation = stubSimpleCall( + undefined, + expectedError + ); + await assert.rejects( + client.checkDeleteScheduleProgress(''), + expectedError + ); + assert((client.operationsClient.getOperation as SinonStub).getCall(0)); + }); + }); + + describe('listSchedules', () => { + it('invokes listSchedules without error', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.ListSchedulesRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.ListSchedulesRequest', + ['parent'] + ); + request.parent = defaultValue1; + const expectedHeaderRequestParams = `parent=${defaultValue1}`; + const expectedResponse = [ + generateSampleMessage(new protos.google.cloud.aiplatform.v1.Schedule()), + generateSampleMessage(new protos.google.cloud.aiplatform.v1.Schedule()), + generateSampleMessage(new protos.google.cloud.aiplatform.v1.Schedule()), + ]; + client.innerApiCalls.listSchedules = stubSimpleCall(expectedResponse); + const [response] = await client.listSchedules(request); + assert.deepStrictEqual(response, expectedResponse); + const actualRequest = ( + client.innerApiCalls.listSchedules as SinonStub + ).getCall(0).args[0]; + assert.deepStrictEqual(actualRequest, request); + const actualHeaderRequestParams = ( + client.innerApiCalls.listSchedules as SinonStub + ).getCall(0).args[1].otherArgs.headers['x-goog-request-params']; + assert(actualHeaderRequestParams.includes(expectedHeaderRequestParams)); + }); + + it('invokes listSchedules without error using callback', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.ListSchedulesRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.ListSchedulesRequest', + ['parent'] + ); + request.parent = defaultValue1; + const expectedHeaderRequestParams = `parent=${defaultValue1}`; + const expectedResponse = [ + generateSampleMessage(new protos.google.cloud.aiplatform.v1.Schedule()), + generateSampleMessage(new protos.google.cloud.aiplatform.v1.Schedule()), + generateSampleMessage(new protos.google.cloud.aiplatform.v1.Schedule()), + ]; + client.innerApiCalls.listSchedules = + stubSimpleCallWithCallback(expectedResponse); + const promise = new Promise((resolve, reject) => { + client.listSchedules( + request, + ( + err?: Error | null, + result?: protos.google.cloud.aiplatform.v1.ISchedule[] | null + ) => { + if (err) { + reject(err); + } else { + resolve(result); + } + } + ); + }); + const response = await promise; + assert.deepStrictEqual(response, expectedResponse); + const actualRequest = ( + client.innerApiCalls.listSchedules as SinonStub + ).getCall(0).args[0]; + assert.deepStrictEqual(actualRequest, request); + const actualHeaderRequestParams = ( + client.innerApiCalls.listSchedules as SinonStub + ).getCall(0).args[1].otherArgs.headers['x-goog-request-params']; + assert(actualHeaderRequestParams.includes(expectedHeaderRequestParams)); + }); + + it('invokes listSchedules with error', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.ListSchedulesRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.ListSchedulesRequest', + ['parent'] + ); + request.parent = defaultValue1; + const expectedHeaderRequestParams = `parent=${defaultValue1}`; + const expectedError = new Error('expected'); + client.innerApiCalls.listSchedules = stubSimpleCall( + undefined, + expectedError + ); + await assert.rejects(client.listSchedules(request), expectedError); + const actualRequest = ( + client.innerApiCalls.listSchedules as SinonStub + ).getCall(0).args[0]; + assert.deepStrictEqual(actualRequest, request); + const actualHeaderRequestParams = ( + client.innerApiCalls.listSchedules as SinonStub + ).getCall(0).args[1].otherArgs.headers['x-goog-request-params']; + assert(actualHeaderRequestParams.includes(expectedHeaderRequestParams)); + }); + + it('invokes listSchedulesStream without error', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.ListSchedulesRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.ListSchedulesRequest', + ['parent'] + ); + request.parent = defaultValue1; + const expectedHeaderRequestParams = `parent=${defaultValue1}`; + const expectedResponse = [ + generateSampleMessage(new protos.google.cloud.aiplatform.v1.Schedule()), + generateSampleMessage(new protos.google.cloud.aiplatform.v1.Schedule()), + generateSampleMessage(new protos.google.cloud.aiplatform.v1.Schedule()), + ]; + client.descriptors.page.listSchedules.createStream = + stubPageStreamingCall(expectedResponse); + const stream = client.listSchedulesStream(request); + const promise = new Promise((resolve, reject) => { + const responses: protos.google.cloud.aiplatform.v1.Schedule[] = []; + stream.on( + 'data', + (response: protos.google.cloud.aiplatform.v1.Schedule) => { + responses.push(response); + } + ); + stream.on('end', () => { + resolve(responses); + }); + stream.on('error', (err: Error) => { + reject(err); + }); + }); + const responses = await promise; + assert.deepStrictEqual(responses, expectedResponse); + assert( + (client.descriptors.page.listSchedules.createStream as SinonStub) + .getCall(0) + .calledWith(client.innerApiCalls.listSchedules, request) + ); + assert( + (client.descriptors.page.listSchedules.createStream as SinonStub) + .getCall(0) + .args[2].otherArgs.headers['x-goog-request-params'].includes( + expectedHeaderRequestParams + ) + ); + }); + + it('invokes listSchedulesStream with error', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.ListSchedulesRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.ListSchedulesRequest', + ['parent'] + ); + request.parent = defaultValue1; + const expectedHeaderRequestParams = `parent=${defaultValue1}`; + const expectedError = new Error('expected'); + client.descriptors.page.listSchedules.createStream = + stubPageStreamingCall(undefined, expectedError); + const stream = client.listSchedulesStream(request); + const promise = new Promise((resolve, reject) => { + const responses: protos.google.cloud.aiplatform.v1.Schedule[] = []; + stream.on( + 'data', + (response: protos.google.cloud.aiplatform.v1.Schedule) => { + responses.push(response); + } + ); + stream.on('end', () => { + resolve(responses); + }); + stream.on('error', (err: Error) => { + reject(err); + }); + }); + await assert.rejects(promise, expectedError); + assert( + (client.descriptors.page.listSchedules.createStream as SinonStub) + .getCall(0) + .calledWith(client.innerApiCalls.listSchedules, request) + ); + assert( + (client.descriptors.page.listSchedules.createStream as SinonStub) + .getCall(0) + .args[2].otherArgs.headers['x-goog-request-params'].includes( + expectedHeaderRequestParams + ) + ); + }); + + it('uses async iteration with listSchedules without error', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.ListSchedulesRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.ListSchedulesRequest', + ['parent'] + ); + request.parent = defaultValue1; + const expectedHeaderRequestParams = `parent=${defaultValue1}`; + const expectedResponse = [ + generateSampleMessage(new protos.google.cloud.aiplatform.v1.Schedule()), + generateSampleMessage(new protos.google.cloud.aiplatform.v1.Schedule()), + generateSampleMessage(new protos.google.cloud.aiplatform.v1.Schedule()), + ]; + client.descriptors.page.listSchedules.asyncIterate = + stubAsyncIterationCall(expectedResponse); + const responses: protos.google.cloud.aiplatform.v1.ISchedule[] = []; + const iterable = client.listSchedulesAsync(request); + for await (const resource of iterable) { + responses.push(resource!); + } + assert.deepStrictEqual(responses, expectedResponse); + assert.deepStrictEqual( + ( + client.descriptors.page.listSchedules.asyncIterate as SinonStub + ).getCall(0).args[1], + request + ); + assert( + (client.descriptors.page.listSchedules.asyncIterate as SinonStub) + .getCall(0) + .args[2].otherArgs.headers['x-goog-request-params'].includes( + expectedHeaderRequestParams + ) + ); + }); + + it('uses async iteration with listSchedules with error', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.ListSchedulesRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.ListSchedulesRequest', + ['parent'] + ); + request.parent = defaultValue1; + const expectedHeaderRequestParams = `parent=${defaultValue1}`; + const expectedError = new Error('expected'); + client.descriptors.page.listSchedules.asyncIterate = + stubAsyncIterationCall(undefined, expectedError); + const iterable = client.listSchedulesAsync(request); + await assert.rejects(async () => { + const responses: protos.google.cloud.aiplatform.v1.ISchedule[] = []; + for await (const resource of iterable) { + responses.push(resource!); + } + }); + assert.deepStrictEqual( + ( + client.descriptors.page.listSchedules.asyncIterate as SinonStub + ).getCall(0).args[1], + request + ); + assert( + (client.descriptors.page.listSchedules.asyncIterate as SinonStub) + .getCall(0) + .args[2].otherArgs.headers['x-goog-request-params'].includes( + expectedHeaderRequestParams + ) + ); + }); + }); + describe('getIamPolicy', () => { + it('invokes getIamPolicy without error', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new IamProtos.google.iam.v1.GetIamPolicyRequest() + ); + request.resource = ''; + const expectedHeaderRequestParams = 'resource='; + const expectedOptions = { + otherArgs: { + headers: { + 'x-goog-request-params': expectedHeaderRequestParams, + }, + }, + }; + const expectedResponse = generateSampleMessage( + new IamProtos.google.iam.v1.Policy() + ); + client.iamClient.getIamPolicy = stubSimpleCall(expectedResponse); + const response = await client.getIamPolicy(request, expectedOptions); + assert.deepStrictEqual(response, [expectedResponse]); + assert( + (client.iamClient.getIamPolicy as SinonStub) + .getCall(0) + .calledWith(request, expectedOptions, undefined) + ); + }); + it('invokes getIamPolicy without error using callback', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new IamProtos.google.iam.v1.GetIamPolicyRequest() + ); + request.resource = ''; + const expectedHeaderRequestParams = 'resource='; + const expectedOptions = { + otherArgs: { + headers: { + 'x-goog-request-params': expectedHeaderRequestParams, + }, + }, + }; + const expectedResponse = generateSampleMessage( + new IamProtos.google.iam.v1.Policy() + ); + client.iamClient.getIamPolicy = sinon + .stub() + .callsArgWith(2, null, expectedResponse); + const promise = new Promise((resolve, reject) => { + client.getIamPolicy( + request, + expectedOptions, + ( + err?: Error | null, + result?: IamProtos.google.iam.v1.Policy | null + ) => { + if (err) { + reject(err); + } else { + resolve(result); + } + } + ); + }); + const response = await promise; + assert.deepStrictEqual(response, expectedResponse); + assert((client.iamClient.getIamPolicy as SinonStub).getCall(0)); + }); + it('invokes getIamPolicy with error', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new IamProtos.google.iam.v1.GetIamPolicyRequest() + ); + request.resource = ''; + const expectedHeaderRequestParams = 'resource='; + const expectedOptions = { + otherArgs: { + headers: { + 'x-goog-request-params': expectedHeaderRequestParams, + }, + }, + }; + const expectedError = new Error('expected'); + client.iamClient.getIamPolicy = stubSimpleCall(undefined, expectedError); + await assert.rejects( + client.getIamPolicy(request, expectedOptions), + expectedError + ); + assert( + (client.iamClient.getIamPolicy as SinonStub) + .getCall(0) + .calledWith(request, expectedOptions, undefined) + ); + }); + }); + describe('setIamPolicy', () => { + it('invokes setIamPolicy without error', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new IamProtos.google.iam.v1.SetIamPolicyRequest() + ); + request.resource = ''; + const expectedHeaderRequestParams = 'resource='; + const expectedOptions = { + otherArgs: { + headers: { + 'x-goog-request-params': expectedHeaderRequestParams, + }, + }, + }; + const expectedResponse = generateSampleMessage( + new IamProtos.google.iam.v1.Policy() + ); + client.iamClient.setIamPolicy = stubSimpleCall(expectedResponse); + const response = await client.setIamPolicy(request, expectedOptions); + assert.deepStrictEqual(response, [expectedResponse]); + assert( + (client.iamClient.setIamPolicy as SinonStub) + .getCall(0) + .calledWith(request, expectedOptions, undefined) + ); + }); + it('invokes setIamPolicy without error using callback', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new IamProtos.google.iam.v1.SetIamPolicyRequest() + ); + request.resource = ''; + const expectedHeaderRequestParams = 'resource='; + const expectedOptions = { + otherArgs: { + headers: { + 'x-goog-request-params': expectedHeaderRequestParams, + }, + }, + }; + const expectedResponse = generateSampleMessage( + new IamProtos.google.iam.v1.Policy() + ); + client.iamClient.setIamPolicy = sinon + .stub() + .callsArgWith(2, null, expectedResponse); + const promise = new Promise((resolve, reject) => { + client.setIamPolicy( + request, + expectedOptions, + ( + err?: Error | null, + result?: IamProtos.google.iam.v1.Policy | null + ) => { + if (err) { + reject(err); + } else { + resolve(result); + } + } + ); + }); + const response = await promise; + assert.deepStrictEqual(response, expectedResponse); + assert((client.iamClient.setIamPolicy as SinonStub).getCall(0)); + }); + it('invokes setIamPolicy with error', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new IamProtos.google.iam.v1.SetIamPolicyRequest() + ); + request.resource = ''; + const expectedHeaderRequestParams = 'resource='; + const expectedOptions = { + otherArgs: { + headers: { + 'x-goog-request-params': expectedHeaderRequestParams, + }, + }, + }; + const expectedError = new Error('expected'); + client.iamClient.setIamPolicy = stubSimpleCall(undefined, expectedError); + await assert.rejects( + client.setIamPolicy(request, expectedOptions), + expectedError + ); + assert( + (client.iamClient.setIamPolicy as SinonStub) + .getCall(0) + .calledWith(request, expectedOptions, undefined) + ); + }); + }); + describe('testIamPermissions', () => { + it('invokes testIamPermissions without error', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new IamProtos.google.iam.v1.TestIamPermissionsRequest() + ); + request.resource = ''; + const expectedHeaderRequestParams = 'resource='; + const expectedOptions = { + otherArgs: { + headers: { + 'x-goog-request-params': expectedHeaderRequestParams, + }, + }, + }; + const expectedResponse = generateSampleMessage( + new IamProtos.google.iam.v1.TestIamPermissionsResponse() + ); + client.iamClient.testIamPermissions = stubSimpleCall(expectedResponse); + const response = await client.testIamPermissions( + request, + expectedOptions + ); + assert.deepStrictEqual(response, [expectedResponse]); + assert( + (client.iamClient.testIamPermissions as SinonStub) + .getCall(0) + .calledWith(request, expectedOptions, undefined) + ); + }); + it('invokes testIamPermissions without error using callback', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new IamProtos.google.iam.v1.TestIamPermissionsRequest() + ); + request.resource = ''; + const expectedHeaderRequestParams = 'resource='; + const expectedOptions = { + otherArgs: { + headers: { + 'x-goog-request-params': expectedHeaderRequestParams, + }, + }, + }; + const expectedResponse = generateSampleMessage( + new IamProtos.google.iam.v1.TestIamPermissionsResponse() + ); + client.iamClient.testIamPermissions = sinon + .stub() + .callsArgWith(2, null, expectedResponse); + const promise = new Promise((resolve, reject) => { + client.testIamPermissions( + request, + expectedOptions, + ( + err?: Error | null, + result?: IamProtos.google.iam.v1.TestIamPermissionsResponse | null + ) => { + if (err) { + reject(err); + } else { + resolve(result); + } + } + ); + }); + const response = await promise; + assert.deepStrictEqual(response, expectedResponse); + assert((client.iamClient.testIamPermissions as SinonStub).getCall(0)); + }); + it('invokes testIamPermissions with error', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new IamProtos.google.iam.v1.TestIamPermissionsRequest() + ); + request.resource = ''; + const expectedHeaderRequestParams = 'resource='; + const expectedOptions = { + otherArgs: { + headers: { + 'x-goog-request-params': expectedHeaderRequestParams, + }, + }, + }; + const expectedError = new Error('expected'); + client.iamClient.testIamPermissions = stubSimpleCall( + undefined, + expectedError + ); + await assert.rejects( + client.testIamPermissions(request, expectedOptions), + expectedError + ); + assert( + (client.iamClient.testIamPermissions as SinonStub) + .getCall(0) + .calledWith(request, expectedOptions, undefined) + ); + }); + }); + describe('getLocation', () => { + it('invokes getLocation without error', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new LocationProtos.google.cloud.location.GetLocationRequest() + ); + request.name = ''; + const expectedHeaderRequestParams = 'name='; + const expectedOptions = { + otherArgs: { + headers: { + 'x-goog-request-params': expectedHeaderRequestParams, + }, + }, + }; + const expectedResponse = generateSampleMessage( + new LocationProtos.google.cloud.location.Location() + ); + client.locationsClient.getLocation = stubSimpleCall(expectedResponse); + const response = await client.getLocation(request, expectedOptions); + assert.deepStrictEqual(response, [expectedResponse]); + assert( + (client.locationsClient.getLocation as SinonStub) + .getCall(0) + .calledWith(request, expectedOptions, undefined) + ); + }); + it('invokes getLocation without error using callback', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new LocationProtos.google.cloud.location.GetLocationRequest() + ); + request.name = ''; + const expectedHeaderRequestParams = 'name='; + const expectedOptions = { + otherArgs: { + headers: { + 'x-goog-request-params': expectedHeaderRequestParams, + }, + }, + }; + const expectedResponse = generateSampleMessage( + new LocationProtos.google.cloud.location.Location() + ); + client.locationsClient.getLocation = sinon + .stub() + .callsArgWith(2, null, expectedResponse); + const promise = new Promise((resolve, reject) => { + client.getLocation( + request, + expectedOptions, + ( + err?: Error | null, + result?: LocationProtos.google.cloud.location.ILocation | null + ) => { + if (err) { + reject(err); + } else { + resolve(result); + } + } + ); + }); + const response = await promise; + assert.deepStrictEqual(response, expectedResponse); + assert((client.locationsClient.getLocation as SinonStub).getCall(0)); + }); + it('invokes getLocation with error', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new LocationProtos.google.cloud.location.GetLocationRequest() + ); + request.name = ''; + const expectedHeaderRequestParams = 'name='; + const expectedOptions = { + otherArgs: { + headers: { + 'x-goog-request-params': expectedHeaderRequestParams, + }, + }, + }; + const expectedError = new Error('expected'); + client.locationsClient.getLocation = stubSimpleCall( + undefined, + expectedError + ); + await assert.rejects( + client.getLocation(request, expectedOptions), + expectedError + ); + assert( + (client.locationsClient.getLocation as SinonStub) + .getCall(0) + .calledWith(request, expectedOptions, undefined) + ); + }); + }); + describe('listLocationsAsync', () => { + it('uses async iteration with listLocations without error', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new LocationProtos.google.cloud.location.ListLocationsRequest() + ); + request.name = ''; + const expectedHeaderRequestParams = 'name='; + const expectedResponse = [ + generateSampleMessage( + new LocationProtos.google.cloud.location.Location() + ), + generateSampleMessage( + new LocationProtos.google.cloud.location.Location() + ), + generateSampleMessage( + new LocationProtos.google.cloud.location.Location() + ), + ]; + client.locationsClient.descriptors.page.listLocations.asyncIterate = + stubAsyncIterationCall(expectedResponse); + const responses: LocationProtos.google.cloud.location.ILocation[] = []; + const iterable = client.listLocationsAsync(request); + for await (const resource of iterable) { + responses.push(resource!); + } + assert.deepStrictEqual(responses, expectedResponse); + assert.deepStrictEqual( + ( + client.locationsClient.descriptors.page.listLocations + .asyncIterate as SinonStub + ).getCall(0).args[1], + request + ); + assert( + ( + client.locationsClient.descriptors.page.listLocations + .asyncIterate as SinonStub + ) + .getCall(0) + .args[2].otherArgs.headers['x-goog-request-params'].includes( + expectedHeaderRequestParams + ) + ); + }); + it('uses async iteration with listLocations with error', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new LocationProtos.google.cloud.location.ListLocationsRequest() + ); + request.name = ''; + const expectedHeaderRequestParams = 'name='; + const expectedError = new Error('expected'); + client.locationsClient.descriptors.page.listLocations.asyncIterate = + stubAsyncIterationCall(undefined, expectedError); + const iterable = client.listLocationsAsync(request); + await assert.rejects(async () => { + const responses: LocationProtos.google.cloud.location.ILocation[] = []; + for await (const resource of iterable) { + responses.push(resource!); + } + }); + assert.deepStrictEqual( + ( + client.locationsClient.descriptors.page.listLocations + .asyncIterate as SinonStub + ).getCall(0).args[1], + request + ); + assert( + ( + client.locationsClient.descriptors.page.listLocations + .asyncIterate as SinonStub + ) + .getCall(0) + .args[2].otherArgs.headers['x-goog-request-params'].includes( + expectedHeaderRequestParams + ) + ); + }); + }); + describe('getOperation', () => { + it('invokes getOperation without error', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new operationsProtos.google.longrunning.GetOperationRequest() + ); + const expectedResponse = generateSampleMessage( + new operationsProtos.google.longrunning.Operation() + ); + client.operationsClient.getOperation = stubSimpleCall(expectedResponse); + const response = await client.getOperation(request); + assert.deepStrictEqual(response, [expectedResponse]); + assert( + (client.operationsClient.getOperation as SinonStub) + .getCall(0) + .calledWith(request) + ); + }); + it('invokes getOperation without error using callback', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + const request = generateSampleMessage( + new operationsProtos.google.longrunning.GetOperationRequest() + ); + const expectedResponse = generateSampleMessage( + new operationsProtos.google.longrunning.Operation() + ); + client.operationsClient.getOperation = sinon + .stub() + .callsArgWith(2, null, expectedResponse); + const promise = new Promise((resolve, reject) => { + client.operationsClient.getOperation( + request, + undefined, + ( + err?: Error | null, + result?: operationsProtos.google.longrunning.Operation | null + ) => { + if (err) { + reject(err); + } else { + resolve(result); + } + } + ); + }); + const response = await promise; + assert.deepStrictEqual(response, expectedResponse); + assert((client.operationsClient.getOperation as SinonStub).getCall(0)); + }); + it('invokes getOperation with error', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + const request = generateSampleMessage( + new operationsProtos.google.longrunning.GetOperationRequest() + ); + const expectedError = new Error('expected'); + client.operationsClient.getOperation = stubSimpleCall( + undefined, + expectedError + ); + await assert.rejects(async () => { + await client.getOperation(request); + }, expectedError); + assert( + (client.operationsClient.getOperation as SinonStub) + .getCall(0) + .calledWith(request) + ); + }); + }); + describe('cancelOperation', () => { + it('invokes cancelOperation without error', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new operationsProtos.google.longrunning.CancelOperationRequest() + ); + const expectedResponse = generateSampleMessage( + new protos.google.protobuf.Empty() + ); + client.operationsClient.cancelOperation = + stubSimpleCall(expectedResponse); + const response = await client.cancelOperation(request); + assert.deepStrictEqual(response, [expectedResponse]); + assert( + (client.operationsClient.cancelOperation as SinonStub) + .getCall(0) + .calledWith(request) + ); + }); + it('invokes cancelOperation without error using callback', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + const request = generateSampleMessage( + new operationsProtos.google.longrunning.CancelOperationRequest() + ); + const expectedResponse = generateSampleMessage( + new protos.google.protobuf.Empty() + ); + client.operationsClient.cancelOperation = sinon + .stub() + .callsArgWith(2, null, expectedResponse); + const promise = new Promise((resolve, reject) => { + client.operationsClient.cancelOperation( + request, + undefined, + ( + err?: Error | null, + result?: protos.google.protobuf.Empty | null + ) => { + if (err) { + reject(err); + } else { + resolve(result); + } + } + ); + }); + const response = await promise; + assert.deepStrictEqual(response, expectedResponse); + assert((client.operationsClient.cancelOperation as SinonStub).getCall(0)); + }); + it('invokes cancelOperation with error', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + const request = generateSampleMessage( + new operationsProtos.google.longrunning.CancelOperationRequest() + ); + const expectedError = new Error('expected'); + client.operationsClient.cancelOperation = stubSimpleCall( + undefined, + expectedError + ); + await assert.rejects(async () => { + await client.cancelOperation(request); + }, expectedError); + assert( + (client.operationsClient.cancelOperation as SinonStub) + .getCall(0) + .calledWith(request) + ); + }); + }); + describe('deleteOperation', () => { + it('invokes deleteOperation without error', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new operationsProtos.google.longrunning.DeleteOperationRequest() + ); + const expectedResponse = generateSampleMessage( + new protos.google.protobuf.Empty() + ); + client.operationsClient.deleteOperation = + stubSimpleCall(expectedResponse); + const response = await client.deleteOperation(request); + assert.deepStrictEqual(response, [expectedResponse]); + assert( + (client.operationsClient.deleteOperation as SinonStub) + .getCall(0) + .calledWith(request) + ); + }); + it('invokes deleteOperation without error using callback', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + const request = generateSampleMessage( + new operationsProtos.google.longrunning.DeleteOperationRequest() + ); + const expectedResponse = generateSampleMessage( + new protos.google.protobuf.Empty() + ); + client.operationsClient.deleteOperation = sinon + .stub() + .callsArgWith(2, null, expectedResponse); + const promise = new Promise((resolve, reject) => { + client.operationsClient.deleteOperation( + request, + undefined, + ( + err?: Error | null, + result?: protos.google.protobuf.Empty | null + ) => { + if (err) { + reject(err); + } else { + resolve(result); + } + } + ); + }); + const response = await promise; + assert.deepStrictEqual(response, expectedResponse); + assert((client.operationsClient.deleteOperation as SinonStub).getCall(0)); + }); + it('invokes deleteOperation with error', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + const request = generateSampleMessage( + new operationsProtos.google.longrunning.DeleteOperationRequest() + ); + const expectedError = new Error('expected'); + client.operationsClient.deleteOperation = stubSimpleCall( + undefined, + expectedError + ); + await assert.rejects(async () => { + await client.deleteOperation(request); + }, expectedError); + assert( + (client.operationsClient.deleteOperation as SinonStub) + .getCall(0) + .calledWith(request) + ); + }); + }); + describe('listOperationsAsync', () => { + it('uses async iteration with listOperations without error', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + const request = generateSampleMessage( + new operationsProtos.google.longrunning.ListOperationsRequest() + ); + const expectedResponse = [ + generateSampleMessage( + new operationsProtos.google.longrunning.ListOperationsResponse() + ), + generateSampleMessage( + new operationsProtos.google.longrunning.ListOperationsResponse() + ), + generateSampleMessage( + new operationsProtos.google.longrunning.ListOperationsResponse() + ), + ]; + client.operationsClient.descriptor.listOperations.asyncIterate = + stubAsyncIterationCall(expectedResponse); + const responses: operationsProtos.google.longrunning.ListOperationsResponse[] = + []; + const iterable = client.operationsClient.listOperationsAsync(request); + for await (const resource of iterable) { + responses.push(resource!); + } + assert.deepStrictEqual(responses, expectedResponse); + assert.deepStrictEqual( + ( + client.operationsClient.descriptor.listOperations + .asyncIterate as SinonStub + ).getCall(0).args[1], + request + ); + }); + it('uses async iteration with listOperations with error', async () => { + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new operationsProtos.google.longrunning.ListOperationsRequest() + ); + const expectedError = new Error('expected'); + client.operationsClient.descriptor.listOperations.asyncIterate = + stubAsyncIterationCall(undefined, expectedError); + const iterable = client.operationsClient.listOperationsAsync(request); + await assert.rejects(async () => { + const responses: operationsProtos.google.longrunning.ListOperationsResponse[] = + []; + for await (const resource of iterable) { + responses.push(resource!); + } + }); + assert.deepStrictEqual( + ( + client.operationsClient.descriptor.listOperations + .asyncIterate as SinonStub + ).getCall(0).args[1], + request + ); + }); + }); + + describe('Path templates', () => { + describe('annotation', () => { + const fakePath = '/rendered/path/annotation'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + dataset: 'datasetValue', + data_item: 'dataItemValue', + annotation: 'annotationValue', + }; + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.annotationPathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.annotationPathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('annotationPath', () => { + const result = client.annotationPath( + 'projectValue', + 'locationValue', + 'datasetValue', + 'dataItemValue', + 'annotationValue' + ); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.annotationPathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromAnnotationName', () => { + const result = client.matchProjectFromAnnotationName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.annotationPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromAnnotationName', () => { + const result = client.matchLocationFromAnnotationName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.annotationPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchDatasetFromAnnotationName', () => { + const result = client.matchDatasetFromAnnotationName(fakePath); + assert.strictEqual(result, 'datasetValue'); + assert( + (client.pathTemplates.annotationPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchDataItemFromAnnotationName', () => { + const result = client.matchDataItemFromAnnotationName(fakePath); + assert.strictEqual(result, 'dataItemValue'); + assert( + (client.pathTemplates.annotationPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchAnnotationFromAnnotationName', () => { + const result = client.matchAnnotationFromAnnotationName(fakePath); + assert.strictEqual(result, 'annotationValue'); + assert( + (client.pathTemplates.annotationPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + + describe('annotationSpec', () => { + const fakePath = '/rendered/path/annotationSpec'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + dataset: 'datasetValue', + annotation_spec: 'annotationSpecValue', + }; + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.annotationSpecPathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.annotationSpecPathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('annotationSpecPath', () => { + const result = client.annotationSpecPath( + 'projectValue', + 'locationValue', + 'datasetValue', + 'annotationSpecValue' + ); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.annotationSpecPathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromAnnotationSpecName', () => { + const result = client.matchProjectFromAnnotationSpecName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.annotationSpecPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromAnnotationSpecName', () => { + const result = client.matchLocationFromAnnotationSpecName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.annotationSpecPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchDatasetFromAnnotationSpecName', () => { + const result = client.matchDatasetFromAnnotationSpecName(fakePath); + assert.strictEqual(result, 'datasetValue'); + assert( + (client.pathTemplates.annotationSpecPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchAnnotationSpecFromAnnotationSpecName', () => { + const result = + client.matchAnnotationSpecFromAnnotationSpecName(fakePath); + assert.strictEqual(result, 'annotationSpecValue'); + assert( + (client.pathTemplates.annotationSpecPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + + describe('artifact', () => { + const fakePath = '/rendered/path/artifact'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + metadata_store: 'metadataStoreValue', + artifact: 'artifactValue', + }; + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.artifactPathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.artifactPathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('artifactPath', () => { + const result = client.artifactPath( + 'projectValue', + 'locationValue', + 'metadataStoreValue', + 'artifactValue' + ); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.artifactPathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromArtifactName', () => { + const result = client.matchProjectFromArtifactName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.artifactPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromArtifactName', () => { + const result = client.matchLocationFromArtifactName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.artifactPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchMetadataStoreFromArtifactName', () => { + const result = client.matchMetadataStoreFromArtifactName(fakePath); + assert.strictEqual(result, 'metadataStoreValue'); + assert( + (client.pathTemplates.artifactPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchArtifactFromArtifactName', () => { + const result = client.matchArtifactFromArtifactName(fakePath); + assert.strictEqual(result, 'artifactValue'); + assert( + (client.pathTemplates.artifactPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + + describe('batchPredictionJob', () => { + const fakePath = '/rendered/path/batchPredictionJob'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + batch_prediction_job: 'batchPredictionJobValue', + }; + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.batchPredictionJobPathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.batchPredictionJobPathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('batchPredictionJobPath', () => { + const result = client.batchPredictionJobPath( + 'projectValue', + 'locationValue', + 'batchPredictionJobValue' + ); + assert.strictEqual(result, fakePath); + assert( + ( + client.pathTemplates.batchPredictionJobPathTemplate + .render as SinonStub + ) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromBatchPredictionJobName', () => { + const result = client.matchProjectFromBatchPredictionJobName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + ( + client.pathTemplates.batchPredictionJobPathTemplate + .match as SinonStub + ) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromBatchPredictionJobName', () => { + const result = client.matchLocationFromBatchPredictionJobName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + ( + client.pathTemplates.batchPredictionJobPathTemplate + .match as SinonStub + ) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchBatchPredictionJobFromBatchPredictionJobName', () => { + const result = + client.matchBatchPredictionJobFromBatchPredictionJobName(fakePath); + assert.strictEqual(result, 'batchPredictionJobValue'); + assert( + ( + client.pathTemplates.batchPredictionJobPathTemplate + .match as SinonStub + ) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + + describe('context', () => { + const fakePath = '/rendered/path/context'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + metadata_store: 'metadataStoreValue', + context: 'contextValue', + }; + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.contextPathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.contextPathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('contextPath', () => { + const result = client.contextPath( + 'projectValue', + 'locationValue', + 'metadataStoreValue', + 'contextValue' + ); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.contextPathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromContextName', () => { + const result = client.matchProjectFromContextName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.contextPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromContextName', () => { + const result = client.matchLocationFromContextName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.contextPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchMetadataStoreFromContextName', () => { + const result = client.matchMetadataStoreFromContextName(fakePath); + assert.strictEqual(result, 'metadataStoreValue'); + assert( + (client.pathTemplates.contextPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchContextFromContextName', () => { + const result = client.matchContextFromContextName(fakePath); + assert.strictEqual(result, 'contextValue'); + assert( + (client.pathTemplates.contextPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + + describe('customJob', () => { + const fakePath = '/rendered/path/customJob'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + custom_job: 'customJobValue', + }; + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.customJobPathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.customJobPathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('customJobPath', () => { + const result = client.customJobPath( + 'projectValue', + 'locationValue', + 'customJobValue' + ); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.customJobPathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromCustomJobName', () => { + const result = client.matchProjectFromCustomJobName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.customJobPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromCustomJobName', () => { + const result = client.matchLocationFromCustomJobName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.customJobPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchCustomJobFromCustomJobName', () => { + const result = client.matchCustomJobFromCustomJobName(fakePath); + assert.strictEqual(result, 'customJobValue'); + assert( + (client.pathTemplates.customJobPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + + describe('dataItem', () => { + const fakePath = '/rendered/path/dataItem'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + dataset: 'datasetValue', + data_item: 'dataItemValue', + }; + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.dataItemPathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.dataItemPathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('dataItemPath', () => { + const result = client.dataItemPath( + 'projectValue', + 'locationValue', + 'datasetValue', + 'dataItemValue' + ); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.dataItemPathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromDataItemName', () => { + const result = client.matchProjectFromDataItemName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.dataItemPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromDataItemName', () => { + const result = client.matchLocationFromDataItemName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.dataItemPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchDatasetFromDataItemName', () => { + const result = client.matchDatasetFromDataItemName(fakePath); + assert.strictEqual(result, 'datasetValue'); + assert( + (client.pathTemplates.dataItemPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchDataItemFromDataItemName', () => { + const result = client.matchDataItemFromDataItemName(fakePath); + assert.strictEqual(result, 'dataItemValue'); + assert( + (client.pathTemplates.dataItemPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + + describe('dataLabelingJob', () => { + const fakePath = '/rendered/path/dataLabelingJob'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + data_labeling_job: 'dataLabelingJobValue', + }; + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.dataLabelingJobPathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.dataLabelingJobPathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('dataLabelingJobPath', () => { + const result = client.dataLabelingJobPath( + 'projectValue', + 'locationValue', + 'dataLabelingJobValue' + ); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.dataLabelingJobPathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromDataLabelingJobName', () => { + const result = client.matchProjectFromDataLabelingJobName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.dataLabelingJobPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromDataLabelingJobName', () => { + const result = client.matchLocationFromDataLabelingJobName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.dataLabelingJobPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchDataLabelingJobFromDataLabelingJobName', () => { + const result = + client.matchDataLabelingJobFromDataLabelingJobName(fakePath); + assert.strictEqual(result, 'dataLabelingJobValue'); + assert( + (client.pathTemplates.dataLabelingJobPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + + describe('dataset', () => { + const fakePath = '/rendered/path/dataset'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + dataset: 'datasetValue', + }; + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.datasetPathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.datasetPathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('datasetPath', () => { + const result = client.datasetPath( + 'projectValue', + 'locationValue', + 'datasetValue' + ); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.datasetPathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromDatasetName', () => { + const result = client.matchProjectFromDatasetName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.datasetPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromDatasetName', () => { + const result = client.matchLocationFromDatasetName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.datasetPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchDatasetFromDatasetName', () => { + const result = client.matchDatasetFromDatasetName(fakePath); + assert.strictEqual(result, 'datasetValue'); + assert( + (client.pathTemplates.datasetPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + + describe('entityType', () => { + const fakePath = '/rendered/path/entityType'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + featurestore: 'featurestoreValue', + entity_type: 'entityTypeValue', + }; + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.entityTypePathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.entityTypePathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('entityTypePath', () => { + const result = client.entityTypePath( + 'projectValue', + 'locationValue', + 'featurestoreValue', + 'entityTypeValue' + ); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.entityTypePathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromEntityTypeName', () => { + const result = client.matchProjectFromEntityTypeName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.entityTypePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromEntityTypeName', () => { + const result = client.matchLocationFromEntityTypeName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.entityTypePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchFeaturestoreFromEntityTypeName', () => { + const result = client.matchFeaturestoreFromEntityTypeName(fakePath); + assert.strictEqual(result, 'featurestoreValue'); + assert( + (client.pathTemplates.entityTypePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchEntityTypeFromEntityTypeName', () => { + const result = client.matchEntityTypeFromEntityTypeName(fakePath); + assert.strictEqual(result, 'entityTypeValue'); + assert( + (client.pathTemplates.entityTypePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + + describe('execution', () => { + const fakePath = '/rendered/path/execution'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + metadata_store: 'metadataStoreValue', + execution: 'executionValue', + }; + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.executionPathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.executionPathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('executionPath', () => { + const result = client.executionPath( + 'projectValue', + 'locationValue', + 'metadataStoreValue', + 'executionValue' + ); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.executionPathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromExecutionName', () => { + const result = client.matchProjectFromExecutionName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.executionPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromExecutionName', () => { + const result = client.matchLocationFromExecutionName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.executionPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchMetadataStoreFromExecutionName', () => { + const result = client.matchMetadataStoreFromExecutionName(fakePath); + assert.strictEqual(result, 'metadataStoreValue'); + assert( + (client.pathTemplates.executionPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchExecutionFromExecutionName', () => { + const result = client.matchExecutionFromExecutionName(fakePath); + assert.strictEqual(result, 'executionValue'); + assert( + (client.pathTemplates.executionPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + + describe('feature', () => { + const fakePath = '/rendered/path/feature'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + featurestore: 'featurestoreValue', + entity_type: 'entityTypeValue', + feature: 'featureValue', + }; + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.featurePathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.featurePathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('featurePath', () => { + const result = client.featurePath( + 'projectValue', + 'locationValue', + 'featurestoreValue', + 'entityTypeValue', + 'featureValue' + ); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.featurePathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromFeatureName', () => { + const result = client.matchProjectFromFeatureName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.featurePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromFeatureName', () => { + const result = client.matchLocationFromFeatureName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.featurePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchFeaturestoreFromFeatureName', () => { + const result = client.matchFeaturestoreFromFeatureName(fakePath); + assert.strictEqual(result, 'featurestoreValue'); + assert( + (client.pathTemplates.featurePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchEntityTypeFromFeatureName', () => { + const result = client.matchEntityTypeFromFeatureName(fakePath); + assert.strictEqual(result, 'entityTypeValue'); + assert( + (client.pathTemplates.featurePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchFeatureFromFeatureName', () => { + const result = client.matchFeatureFromFeatureName(fakePath); + assert.strictEqual(result, 'featureValue'); + assert( + (client.pathTemplates.featurePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + + describe('featurestore', () => { + const fakePath = '/rendered/path/featurestore'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + featurestore: 'featurestoreValue', + }; + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.featurestorePathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.featurestorePathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('featurestorePath', () => { + const result = client.featurestorePath( + 'projectValue', + 'locationValue', + 'featurestoreValue' + ); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.featurestorePathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromFeaturestoreName', () => { + const result = client.matchProjectFromFeaturestoreName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.featurestorePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromFeaturestoreName', () => { + const result = client.matchLocationFromFeaturestoreName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.featurestorePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchFeaturestoreFromFeaturestoreName', () => { + const result = client.matchFeaturestoreFromFeaturestoreName(fakePath); + assert.strictEqual(result, 'featurestoreValue'); + assert( + (client.pathTemplates.featurestorePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + + describe('hyperparameterTuningJob', () => { + const fakePath = '/rendered/path/hyperparameterTuningJob'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + hyperparameter_tuning_job: 'hyperparameterTuningJobValue', + }; + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.hyperparameterTuningJobPathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.hyperparameterTuningJobPathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('hyperparameterTuningJobPath', () => { + const result = client.hyperparameterTuningJobPath( + 'projectValue', + 'locationValue', + 'hyperparameterTuningJobValue' + ); + assert.strictEqual(result, fakePath); + assert( + ( + client.pathTemplates.hyperparameterTuningJobPathTemplate + .render as SinonStub + ) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromHyperparameterTuningJobName', () => { + const result = + client.matchProjectFromHyperparameterTuningJobName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + ( + client.pathTemplates.hyperparameterTuningJobPathTemplate + .match as SinonStub + ) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromHyperparameterTuningJobName', () => { + const result = + client.matchLocationFromHyperparameterTuningJobName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + ( + client.pathTemplates.hyperparameterTuningJobPathTemplate + .match as SinonStub + ) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchHyperparameterTuningJobFromHyperparameterTuningJobName', () => { + const result = + client.matchHyperparameterTuningJobFromHyperparameterTuningJobName( + fakePath + ); + assert.strictEqual(result, 'hyperparameterTuningJobValue'); + assert( + ( + client.pathTemplates.hyperparameterTuningJobPathTemplate + .match as SinonStub + ) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + + describe('index', () => { + const fakePath = '/rendered/path/index'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + index: 'indexValue', + }; + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.indexPathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.indexPathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('indexPath', () => { + const result = client.indexPath( + 'projectValue', + 'locationValue', + 'indexValue' + ); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.indexPathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromIndexName', () => { + const result = client.matchProjectFromIndexName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.indexPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromIndexName', () => { + const result = client.matchLocationFromIndexName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.indexPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchIndexFromIndexName', () => { + const result = client.matchIndexFromIndexName(fakePath); + assert.strictEqual(result, 'indexValue'); + assert( + (client.pathTemplates.indexPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + + describe('indexEndpoint', () => { + const fakePath = '/rendered/path/indexEndpoint'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + index_endpoint: 'indexEndpointValue', + }; + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.indexEndpointPathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.indexEndpointPathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('indexEndpointPath', () => { + const result = client.indexEndpointPath( + 'projectValue', + 'locationValue', + 'indexEndpointValue' + ); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.indexEndpointPathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromIndexEndpointName', () => { + const result = client.matchProjectFromIndexEndpointName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.indexEndpointPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromIndexEndpointName', () => { + const result = client.matchLocationFromIndexEndpointName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.indexEndpointPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchIndexEndpointFromIndexEndpointName', () => { + const result = client.matchIndexEndpointFromIndexEndpointName(fakePath); + assert.strictEqual(result, 'indexEndpointValue'); + assert( + (client.pathTemplates.indexEndpointPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + + describe('location', () => { + const fakePath = '/rendered/path/location'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + }; + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.locationPathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.locationPathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('locationPath', () => { + const result = client.locationPath('projectValue', 'locationValue'); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.locationPathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromLocationName', () => { + const result = client.matchProjectFromLocationName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.locationPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromLocationName', () => { + const result = client.matchLocationFromLocationName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.locationPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + + describe('metadataSchema', () => { + const fakePath = '/rendered/path/metadataSchema'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + metadata_store: 'metadataStoreValue', + metadata_schema: 'metadataSchemaValue', + }; + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.metadataSchemaPathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.metadataSchemaPathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('metadataSchemaPath', () => { + const result = client.metadataSchemaPath( + 'projectValue', + 'locationValue', + 'metadataStoreValue', + 'metadataSchemaValue' + ); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.metadataSchemaPathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromMetadataSchemaName', () => { + const result = client.matchProjectFromMetadataSchemaName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.metadataSchemaPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromMetadataSchemaName', () => { + const result = client.matchLocationFromMetadataSchemaName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.metadataSchemaPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchMetadataStoreFromMetadataSchemaName', () => { + const result = + client.matchMetadataStoreFromMetadataSchemaName(fakePath); + assert.strictEqual(result, 'metadataStoreValue'); + assert( + (client.pathTemplates.metadataSchemaPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchMetadataSchemaFromMetadataSchemaName', () => { + const result = + client.matchMetadataSchemaFromMetadataSchemaName(fakePath); + assert.strictEqual(result, 'metadataSchemaValue'); + assert( + (client.pathTemplates.metadataSchemaPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + + describe('metadataStore', () => { + const fakePath = '/rendered/path/metadataStore'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + metadata_store: 'metadataStoreValue', + }; + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.metadataStorePathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.metadataStorePathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('metadataStorePath', () => { + const result = client.metadataStorePath( + 'projectValue', + 'locationValue', + 'metadataStoreValue' + ); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.metadataStorePathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromMetadataStoreName', () => { + const result = client.matchProjectFromMetadataStoreName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.metadataStorePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromMetadataStoreName', () => { + const result = client.matchLocationFromMetadataStoreName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.metadataStorePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchMetadataStoreFromMetadataStoreName', () => { + const result = client.matchMetadataStoreFromMetadataStoreName(fakePath); + assert.strictEqual(result, 'metadataStoreValue'); + assert( + (client.pathTemplates.metadataStorePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + + describe('model', () => { + const fakePath = '/rendered/path/model'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + model: 'modelValue', + }; + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.modelPathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.modelPathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('modelPath', () => { + const result = client.modelPath( + 'projectValue', + 'locationValue', + 'modelValue' + ); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.modelPathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromModelName', () => { + const result = client.matchProjectFromModelName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.modelPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromModelName', () => { + const result = client.matchLocationFromModelName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.modelPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchModelFromModelName', () => { + const result = client.matchModelFromModelName(fakePath); + assert.strictEqual(result, 'modelValue'); + assert( + (client.pathTemplates.modelPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + + describe('modelDeploymentMonitoringJob', () => { + const fakePath = '/rendered/path/modelDeploymentMonitoringJob'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + model_deployment_monitoring_job: 'modelDeploymentMonitoringJobValue', + }; + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.modelDeploymentMonitoringJobPathTemplate.render = + sinon.stub().returns(fakePath); + client.pathTemplates.modelDeploymentMonitoringJobPathTemplate.match = + sinon.stub().returns(expectedParameters); + + it('modelDeploymentMonitoringJobPath', () => { + const result = client.modelDeploymentMonitoringJobPath( + 'projectValue', + 'locationValue', + 'modelDeploymentMonitoringJobValue' + ); + assert.strictEqual(result, fakePath); + assert( + ( + client.pathTemplates.modelDeploymentMonitoringJobPathTemplate + .render as SinonStub + ) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromModelDeploymentMonitoringJobName', () => { + const result = + client.matchProjectFromModelDeploymentMonitoringJobName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + ( + client.pathTemplates.modelDeploymentMonitoringJobPathTemplate + .match as SinonStub + ) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromModelDeploymentMonitoringJobName', () => { + const result = + client.matchLocationFromModelDeploymentMonitoringJobName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + ( + client.pathTemplates.modelDeploymentMonitoringJobPathTemplate + .match as SinonStub + ) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchModelDeploymentMonitoringJobFromModelDeploymentMonitoringJobName', () => { + const result = + client.matchModelDeploymentMonitoringJobFromModelDeploymentMonitoringJobName( + fakePath + ); + assert.strictEqual(result, 'modelDeploymentMonitoringJobValue'); + assert( + ( + client.pathTemplates.modelDeploymentMonitoringJobPathTemplate + .match as SinonStub + ) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + + describe('modelEvaluation', () => { + const fakePath = '/rendered/path/modelEvaluation'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + model: 'modelValue', + evaluation: 'evaluationValue', + }; + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.modelEvaluationPathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.modelEvaluationPathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('modelEvaluationPath', () => { + const result = client.modelEvaluationPath( + 'projectValue', + 'locationValue', + 'modelValue', + 'evaluationValue' + ); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.modelEvaluationPathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromModelEvaluationName', () => { + const result = client.matchProjectFromModelEvaluationName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.modelEvaluationPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromModelEvaluationName', () => { + const result = client.matchLocationFromModelEvaluationName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.modelEvaluationPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchModelFromModelEvaluationName', () => { + const result = client.matchModelFromModelEvaluationName(fakePath); + assert.strictEqual(result, 'modelValue'); + assert( + (client.pathTemplates.modelEvaluationPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchEvaluationFromModelEvaluationName', () => { + const result = client.matchEvaluationFromModelEvaluationName(fakePath); + assert.strictEqual(result, 'evaluationValue'); + assert( + (client.pathTemplates.modelEvaluationPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + + describe('modelEvaluationSlice', () => { + const fakePath = '/rendered/path/modelEvaluationSlice'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + model: 'modelValue', + evaluation: 'evaluationValue', + slice: 'sliceValue', + }; + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.modelEvaluationSlicePathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.modelEvaluationSlicePathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('modelEvaluationSlicePath', () => { + const result = client.modelEvaluationSlicePath( + 'projectValue', + 'locationValue', + 'modelValue', + 'evaluationValue', + 'sliceValue' + ); + assert.strictEqual(result, fakePath); + assert( + ( + client.pathTemplates.modelEvaluationSlicePathTemplate + .render as SinonStub + ) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromModelEvaluationSliceName', () => { + const result = + client.matchProjectFromModelEvaluationSliceName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + ( + client.pathTemplates.modelEvaluationSlicePathTemplate + .match as SinonStub + ) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromModelEvaluationSliceName', () => { + const result = + client.matchLocationFromModelEvaluationSliceName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + ( + client.pathTemplates.modelEvaluationSlicePathTemplate + .match as SinonStub + ) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchModelFromModelEvaluationSliceName', () => { + const result = client.matchModelFromModelEvaluationSliceName(fakePath); + assert.strictEqual(result, 'modelValue'); + assert( + ( + client.pathTemplates.modelEvaluationSlicePathTemplate + .match as SinonStub + ) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchEvaluationFromModelEvaluationSliceName', () => { + const result = + client.matchEvaluationFromModelEvaluationSliceName(fakePath); + assert.strictEqual(result, 'evaluationValue'); + assert( + ( + client.pathTemplates.modelEvaluationSlicePathTemplate + .match as SinonStub + ) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchSliceFromModelEvaluationSliceName', () => { + const result = client.matchSliceFromModelEvaluationSliceName(fakePath); + assert.strictEqual(result, 'sliceValue'); + assert( + ( + client.pathTemplates.modelEvaluationSlicePathTemplate + .match as SinonStub + ) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + + describe('nasJob', () => { + const fakePath = '/rendered/path/nasJob'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + nas_job: 'nasJobValue', + }; + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.nasJobPathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.nasJobPathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('nasJobPath', () => { + const result = client.nasJobPath( + 'projectValue', + 'locationValue', + 'nasJobValue' + ); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.nasJobPathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromNasJobName', () => { + const result = client.matchProjectFromNasJobName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.nasJobPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromNasJobName', () => { + const result = client.matchLocationFromNasJobName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.nasJobPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchNasJobFromNasJobName', () => { + const result = client.matchNasJobFromNasJobName(fakePath); + assert.strictEqual(result, 'nasJobValue'); + assert( + (client.pathTemplates.nasJobPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + + describe('nasTrialDetail', () => { + const fakePath = '/rendered/path/nasTrialDetail'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + nas_job: 'nasJobValue', + nas_trial_detail: 'nasTrialDetailValue', + }; + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.nasTrialDetailPathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.nasTrialDetailPathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('nasTrialDetailPath', () => { + const result = client.nasTrialDetailPath( + 'projectValue', + 'locationValue', + 'nasJobValue', + 'nasTrialDetailValue' + ); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.nasTrialDetailPathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromNasTrialDetailName', () => { + const result = client.matchProjectFromNasTrialDetailName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.nasTrialDetailPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromNasTrialDetailName', () => { + const result = client.matchLocationFromNasTrialDetailName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.nasTrialDetailPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchNasJobFromNasTrialDetailName', () => { + const result = client.matchNasJobFromNasTrialDetailName(fakePath); + assert.strictEqual(result, 'nasJobValue'); + assert( + (client.pathTemplates.nasTrialDetailPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchNasTrialDetailFromNasTrialDetailName', () => { + const result = + client.matchNasTrialDetailFromNasTrialDetailName(fakePath); + assert.strictEqual(result, 'nasTrialDetailValue'); + assert( + (client.pathTemplates.nasTrialDetailPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + + describe('pipelineJob', () => { + const fakePath = '/rendered/path/pipelineJob'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + pipeline_job: 'pipelineJobValue', + }; + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.pipelineJobPathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.pipelineJobPathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('pipelineJobPath', () => { + const result = client.pipelineJobPath( + 'projectValue', + 'locationValue', + 'pipelineJobValue' + ); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.pipelineJobPathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromPipelineJobName', () => { + const result = client.matchProjectFromPipelineJobName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.pipelineJobPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromPipelineJobName', () => { + const result = client.matchLocationFromPipelineJobName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.pipelineJobPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchPipelineJobFromPipelineJobName', () => { + const result = client.matchPipelineJobFromPipelineJobName(fakePath); + assert.strictEqual(result, 'pipelineJobValue'); + assert( + (client.pathTemplates.pipelineJobPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + + describe('projectLocationEndpoint', () => { + const fakePath = '/rendered/path/projectLocationEndpoint'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + endpoint: 'endpointValue', + }; + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.projectLocationEndpointPathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.projectLocationEndpointPathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('projectLocationEndpointPath', () => { + const result = client.projectLocationEndpointPath( + 'projectValue', + 'locationValue', + 'endpointValue' + ); + assert.strictEqual(result, fakePath); + assert( + ( + client.pathTemplates.projectLocationEndpointPathTemplate + .render as SinonStub + ) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromProjectLocationEndpointName', () => { + const result = + client.matchProjectFromProjectLocationEndpointName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + ( + client.pathTemplates.projectLocationEndpointPathTemplate + .match as SinonStub + ) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromProjectLocationEndpointName', () => { + const result = + client.matchLocationFromProjectLocationEndpointName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + ( + client.pathTemplates.projectLocationEndpointPathTemplate + .match as SinonStub + ) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchEndpointFromProjectLocationEndpointName', () => { + const result = + client.matchEndpointFromProjectLocationEndpointName(fakePath); + assert.strictEqual(result, 'endpointValue'); + assert( + ( + client.pathTemplates.projectLocationEndpointPathTemplate + .match as SinonStub + ) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + + describe('projectLocationPublisherModel', () => { + const fakePath = '/rendered/path/projectLocationPublisherModel'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + publisher: 'publisherValue', + model: 'modelValue', + }; + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.projectLocationPublisherModelPathTemplate.render = + sinon.stub().returns(fakePath); + client.pathTemplates.projectLocationPublisherModelPathTemplate.match = + sinon.stub().returns(expectedParameters); + + it('projectLocationPublisherModelPath', () => { + const result = client.projectLocationPublisherModelPath( + 'projectValue', + 'locationValue', + 'publisherValue', + 'modelValue' + ); + assert.strictEqual(result, fakePath); + assert( + ( + client.pathTemplates.projectLocationPublisherModelPathTemplate + .render as SinonStub + ) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromProjectLocationPublisherModelName', () => { + const result = + client.matchProjectFromProjectLocationPublisherModelName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + ( + client.pathTemplates.projectLocationPublisherModelPathTemplate + .match as SinonStub + ) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromProjectLocationPublisherModelName', () => { + const result = + client.matchLocationFromProjectLocationPublisherModelName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + ( + client.pathTemplates.projectLocationPublisherModelPathTemplate + .match as SinonStub + ) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchPublisherFromProjectLocationPublisherModelName', () => { + const result = + client.matchPublisherFromProjectLocationPublisherModelName(fakePath); + assert.strictEqual(result, 'publisherValue'); + assert( + ( + client.pathTemplates.projectLocationPublisherModelPathTemplate + .match as SinonStub + ) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchModelFromProjectLocationPublisherModelName', () => { + const result = + client.matchModelFromProjectLocationPublisherModelName(fakePath); + assert.strictEqual(result, 'modelValue'); + assert( + ( + client.pathTemplates.projectLocationPublisherModelPathTemplate + .match as SinonStub + ) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + + describe('publisherModel', () => { + const fakePath = '/rendered/path/publisherModel'; + const expectedParameters = { + publisher: 'publisherValue', + model: 'modelValue', + }; + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.publisherModelPathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.publisherModelPathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('publisherModelPath', () => { + const result = client.publisherModelPath( + 'publisherValue', + 'modelValue' + ); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.publisherModelPathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchPublisherFromPublisherModelName', () => { + const result = client.matchPublisherFromPublisherModelName(fakePath); + assert.strictEqual(result, 'publisherValue'); + assert( + (client.pathTemplates.publisherModelPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchModelFromPublisherModelName', () => { + const result = client.matchModelFromPublisherModelName(fakePath); + assert.strictEqual(result, 'modelValue'); + assert( + (client.pathTemplates.publisherModelPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + + describe('savedQuery', () => { + const fakePath = '/rendered/path/savedQuery'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + dataset: 'datasetValue', + saved_query: 'savedQueryValue', + }; + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.savedQueryPathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.savedQueryPathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('savedQueryPath', () => { + const result = client.savedQueryPath( + 'projectValue', + 'locationValue', + 'datasetValue', + 'savedQueryValue' + ); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.savedQueryPathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromSavedQueryName', () => { + const result = client.matchProjectFromSavedQueryName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.savedQueryPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromSavedQueryName', () => { + const result = client.matchLocationFromSavedQueryName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.savedQueryPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchDatasetFromSavedQueryName', () => { + const result = client.matchDatasetFromSavedQueryName(fakePath); + assert.strictEqual(result, 'datasetValue'); + assert( + (client.pathTemplates.savedQueryPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchSavedQueryFromSavedQueryName', () => { + const result = client.matchSavedQueryFromSavedQueryName(fakePath); + assert.strictEqual(result, 'savedQueryValue'); + assert( + (client.pathTemplates.savedQueryPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + + describe('schedule', () => { + const fakePath = '/rendered/path/schedule'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + schedule: 'scheduleValue', + }; + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.schedulePathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.schedulePathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('schedulePath', () => { + const result = client.schedulePath( + 'projectValue', + 'locationValue', + 'scheduleValue' + ); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.schedulePathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromScheduleName', () => { + const result = client.matchProjectFromScheduleName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromScheduleName', () => { + const result = client.matchLocationFromScheduleName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchScheduleFromScheduleName', () => { + const result = client.matchScheduleFromScheduleName(fakePath); + assert.strictEqual(result, 'scheduleValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + + describe('specialistPool', () => { + const fakePath = '/rendered/path/specialistPool'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + specialist_pool: 'specialistPoolValue', + }; + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.specialistPoolPathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.specialistPoolPathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('specialistPoolPath', () => { + const result = client.specialistPoolPath( + 'projectValue', + 'locationValue', + 'specialistPoolValue' + ); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.specialistPoolPathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromSpecialistPoolName', () => { + const result = client.matchProjectFromSpecialistPoolName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.specialistPoolPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromSpecialistPoolName', () => { + const result = client.matchLocationFromSpecialistPoolName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.specialistPoolPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchSpecialistPoolFromSpecialistPoolName', () => { + const result = + client.matchSpecialistPoolFromSpecialistPoolName(fakePath); + assert.strictEqual(result, 'specialistPoolValue'); + assert( + (client.pathTemplates.specialistPoolPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + + describe('study', () => { + const fakePath = '/rendered/path/study'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + study: 'studyValue', + }; + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.studyPathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.studyPathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('studyPath', () => { + const result = client.studyPath( + 'projectValue', + 'locationValue', + 'studyValue' + ); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.studyPathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromStudyName', () => { + const result = client.matchProjectFromStudyName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.studyPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromStudyName', () => { + const result = client.matchLocationFromStudyName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.studyPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchStudyFromStudyName', () => { + const result = client.matchStudyFromStudyName(fakePath); + assert.strictEqual(result, 'studyValue'); + assert( + (client.pathTemplates.studyPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + + describe('tensorboard', () => { + const fakePath = '/rendered/path/tensorboard'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + tensorboard: 'tensorboardValue', + }; + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.tensorboardPathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.tensorboardPathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('tensorboardPath', () => { + const result = client.tensorboardPath( + 'projectValue', + 'locationValue', + 'tensorboardValue' + ); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.tensorboardPathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromTensorboardName', () => { + const result = client.matchProjectFromTensorboardName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.tensorboardPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromTensorboardName', () => { + const result = client.matchLocationFromTensorboardName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.tensorboardPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchTensorboardFromTensorboardName', () => { + const result = client.matchTensorboardFromTensorboardName(fakePath); + assert.strictEqual(result, 'tensorboardValue'); + assert( + (client.pathTemplates.tensorboardPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + + describe('tensorboardExperiment', () => { + const fakePath = '/rendered/path/tensorboardExperiment'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + tensorboard: 'tensorboardValue', + experiment: 'experimentValue', + }; + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.tensorboardExperimentPathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.tensorboardExperimentPathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('tensorboardExperimentPath', () => { + const result = client.tensorboardExperimentPath( + 'projectValue', + 'locationValue', + 'tensorboardValue', + 'experimentValue' + ); + assert.strictEqual(result, fakePath); + assert( + ( + client.pathTemplates.tensorboardExperimentPathTemplate + .render as SinonStub + ) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromTensorboardExperimentName', () => { + const result = + client.matchProjectFromTensorboardExperimentName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + ( + client.pathTemplates.tensorboardExperimentPathTemplate + .match as SinonStub + ) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromTensorboardExperimentName', () => { + const result = + client.matchLocationFromTensorboardExperimentName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + ( + client.pathTemplates.tensorboardExperimentPathTemplate + .match as SinonStub + ) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchTensorboardFromTensorboardExperimentName', () => { + const result = + client.matchTensorboardFromTensorboardExperimentName(fakePath); + assert.strictEqual(result, 'tensorboardValue'); + assert( + ( + client.pathTemplates.tensorboardExperimentPathTemplate + .match as SinonStub + ) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchExperimentFromTensorboardExperimentName', () => { + const result = + client.matchExperimentFromTensorboardExperimentName(fakePath); + assert.strictEqual(result, 'experimentValue'); + assert( + ( + client.pathTemplates.tensorboardExperimentPathTemplate + .match as SinonStub + ) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + + describe('tensorboardRun', () => { + const fakePath = '/rendered/path/tensorboardRun'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + tensorboard: 'tensorboardValue', + experiment: 'experimentValue', + run: 'runValue', + }; + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.tensorboardRunPathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.tensorboardRunPathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('tensorboardRunPath', () => { + const result = client.tensorboardRunPath( + 'projectValue', + 'locationValue', + 'tensorboardValue', + 'experimentValue', + 'runValue' + ); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.tensorboardRunPathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromTensorboardRunName', () => { + const result = client.matchProjectFromTensorboardRunName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.tensorboardRunPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromTensorboardRunName', () => { + const result = client.matchLocationFromTensorboardRunName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.tensorboardRunPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchTensorboardFromTensorboardRunName', () => { + const result = client.matchTensorboardFromTensorboardRunName(fakePath); + assert.strictEqual(result, 'tensorboardValue'); + assert( + (client.pathTemplates.tensorboardRunPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchExperimentFromTensorboardRunName', () => { + const result = client.matchExperimentFromTensorboardRunName(fakePath); + assert.strictEqual(result, 'experimentValue'); + assert( + (client.pathTemplates.tensorboardRunPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchRunFromTensorboardRunName', () => { + const result = client.matchRunFromTensorboardRunName(fakePath); + assert.strictEqual(result, 'runValue'); + assert( + (client.pathTemplates.tensorboardRunPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + + describe('tensorboardTimeSeries', () => { + const fakePath = '/rendered/path/tensorboardTimeSeries'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + tensorboard: 'tensorboardValue', + experiment: 'experimentValue', + run: 'runValue', + time_series: 'timeSeriesValue', + }; + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.tensorboardTimeSeriesPathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.tensorboardTimeSeriesPathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('tensorboardTimeSeriesPath', () => { + const result = client.tensorboardTimeSeriesPath( + 'projectValue', + 'locationValue', + 'tensorboardValue', + 'experimentValue', + 'runValue', + 'timeSeriesValue' + ); + assert.strictEqual(result, fakePath); + assert( + ( + client.pathTemplates.tensorboardTimeSeriesPathTemplate + .render as SinonStub + ) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromTensorboardTimeSeriesName', () => { + const result = + client.matchProjectFromTensorboardTimeSeriesName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + ( + client.pathTemplates.tensorboardTimeSeriesPathTemplate + .match as SinonStub + ) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromTensorboardTimeSeriesName', () => { + const result = + client.matchLocationFromTensorboardTimeSeriesName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + ( + client.pathTemplates.tensorboardTimeSeriesPathTemplate + .match as SinonStub + ) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchTensorboardFromTensorboardTimeSeriesName', () => { + const result = + client.matchTensorboardFromTensorboardTimeSeriesName(fakePath); + assert.strictEqual(result, 'tensorboardValue'); + assert( + ( + client.pathTemplates.tensorboardTimeSeriesPathTemplate + .match as SinonStub + ) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchExperimentFromTensorboardTimeSeriesName', () => { + const result = + client.matchExperimentFromTensorboardTimeSeriesName(fakePath); + assert.strictEqual(result, 'experimentValue'); + assert( + ( + client.pathTemplates.tensorboardTimeSeriesPathTemplate + .match as SinonStub + ) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchRunFromTensorboardTimeSeriesName', () => { + const result = client.matchRunFromTensorboardTimeSeriesName(fakePath); + assert.strictEqual(result, 'runValue'); + assert( + ( + client.pathTemplates.tensorboardTimeSeriesPathTemplate + .match as SinonStub + ) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchTimeSeriesFromTensorboardTimeSeriesName', () => { + const result = + client.matchTimeSeriesFromTensorboardTimeSeriesName(fakePath); + assert.strictEqual(result, 'timeSeriesValue'); + assert( + ( + client.pathTemplates.tensorboardTimeSeriesPathTemplate + .match as SinonStub + ) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + + describe('trainingPipeline', () => { + const fakePath = '/rendered/path/trainingPipeline'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + training_pipeline: 'trainingPipelineValue', + }; + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.trainingPipelinePathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.trainingPipelinePathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('trainingPipelinePath', () => { + const result = client.trainingPipelinePath( + 'projectValue', + 'locationValue', + 'trainingPipelineValue' + ); + assert.strictEqual(result, fakePath); + assert( + ( + client.pathTemplates.trainingPipelinePathTemplate + .render as SinonStub + ) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromTrainingPipelineName', () => { + const result = client.matchProjectFromTrainingPipelineName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.trainingPipelinePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromTrainingPipelineName', () => { + const result = client.matchLocationFromTrainingPipelineName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.trainingPipelinePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchTrainingPipelineFromTrainingPipelineName', () => { + const result = + client.matchTrainingPipelineFromTrainingPipelineName(fakePath); + assert.strictEqual(result, 'trainingPipelineValue'); + assert( + (client.pathTemplates.trainingPipelinePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + + describe('trial', () => { + const fakePath = '/rendered/path/trial'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + study: 'studyValue', + trial: 'trialValue', + }; + const client = new scheduleserviceModule.v1.ScheduleServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.trialPathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.trialPathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('trialPath', () => { + const result = client.trialPath( + 'projectValue', + 'locationValue', + 'studyValue', + 'trialValue' + ); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.trialPathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromTrialName', () => { + const result = client.matchProjectFromTrialName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.trialPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromTrialName', () => { + const result = client.matchLocationFromTrialName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.trialPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchStudyFromTrialName', () => { + const result = client.matchStudyFromTrialName(fakePath); + assert.strictEqual(result, 'studyValue'); + assert( + (client.pathTemplates.trialPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchTrialFromTrialName', () => { + const result = client.matchTrialFromTrialName(fakePath); + assert.strictEqual(result, 'trialValue'); + assert( + (client.pathTemplates.trialPathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + }); +}); diff --git a/packages/google-cloud-aiplatform/test/gapic_specialist_pool_service_v1.ts b/packages/google-cloud-aiplatform/test/gapic_specialist_pool_service_v1.ts index d2cc2b369dc..2dd3d6de549 100644 --- a/packages/google-cloud-aiplatform/test/gapic_specialist_pool_service_v1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_specialist_pool_service_v1.ts @@ -4430,6 +4430,71 @@ describe('v1.SpecialistPoolServiceClient', () => { }); }); + describe('schedule', () => { + const fakePath = '/rendered/path/schedule'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + schedule: 'scheduleValue', + }; + const client = + new specialistpoolserviceModule.v1.SpecialistPoolServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.schedulePathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.schedulePathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('schedulePath', () => { + const result = client.schedulePath( + 'projectValue', + 'locationValue', + 'scheduleValue' + ); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.schedulePathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromScheduleName', () => { + const result = client.matchProjectFromScheduleName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromScheduleName', () => { + const result = client.matchLocationFromScheduleName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchScheduleFromScheduleName', () => { + const result = client.matchScheduleFromScheduleName(fakePath); + assert.strictEqual(result, 'scheduleValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + describe('specialistPool', () => { const fakePath = '/rendered/path/specialistPool'; const expectedParameters = { diff --git a/packages/google-cloud-aiplatform/test/gapic_tensorboard_service_v1.ts b/packages/google-cloud-aiplatform/test/gapic_tensorboard_service_v1.ts index 3c8d5305369..eaf983622ab 100644 --- a/packages/google-cloud-aiplatform/test/gapic_tensorboard_service_v1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_tensorboard_service_v1.ts @@ -8698,6 +8698,70 @@ describe('v1.TensorboardServiceClient', () => { }); }); + describe('schedule', () => { + const fakePath = '/rendered/path/schedule'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + schedule: 'scheduleValue', + }; + const client = new tensorboardserviceModule.v1.TensorboardServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.schedulePathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.schedulePathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('schedulePath', () => { + const result = client.schedulePath( + 'projectValue', + 'locationValue', + 'scheduleValue' + ); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.schedulePathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromScheduleName', () => { + const result = client.matchProjectFromScheduleName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromScheduleName', () => { + const result = client.matchLocationFromScheduleName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchScheduleFromScheduleName', () => { + const result = client.matchScheduleFromScheduleName(fakePath); + assert.strictEqual(result, 'scheduleValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + describe('specialistPool', () => { const fakePath = '/rendered/path/specialistPool'; const expectedParameters = { diff --git a/packages/google-cloud-aiplatform/test/gapic_vizier_service_v1.ts b/packages/google-cloud-aiplatform/test/gapic_vizier_service_v1.ts index 54ee79a9cde..0ff4e20cf44 100644 --- a/packages/google-cloud-aiplatform/test/gapic_vizier_service_v1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_vizier_service_v1.ts @@ -5717,6 +5717,70 @@ describe('v1.VizierServiceClient', () => { }); }); + describe('schedule', () => { + const fakePath = '/rendered/path/schedule'; + const expectedParameters = { + project: 'projectValue', + location: 'locationValue', + schedule: 'scheduleValue', + }; + const client = new vizierserviceModule.v1.VizierServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + client.pathTemplates.schedulePathTemplate.render = sinon + .stub() + .returns(fakePath); + client.pathTemplates.schedulePathTemplate.match = sinon + .stub() + .returns(expectedParameters); + + it('schedulePath', () => { + const result = client.schedulePath( + 'projectValue', + 'locationValue', + 'scheduleValue' + ); + assert.strictEqual(result, fakePath); + assert( + (client.pathTemplates.schedulePathTemplate.render as SinonStub) + .getCall(-1) + .calledWith(expectedParameters) + ); + }); + + it('matchProjectFromScheduleName', () => { + const result = client.matchProjectFromScheduleName(fakePath); + assert.strictEqual(result, 'projectValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchLocationFromScheduleName', () => { + const result = client.matchLocationFromScheduleName(fakePath); + assert.strictEqual(result, 'locationValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + + it('matchScheduleFromScheduleName', () => { + const result = client.matchScheduleFromScheduleName(fakePath); + assert.strictEqual(result, 'scheduleValue'); + assert( + (client.pathTemplates.schedulePathTemplate.match as SinonStub) + .getCall(-1) + .calledWith(fakePath) + ); + }); + }); + describe('specialistPool', () => { const fakePath = '/rendered/path/specialistPool'; const expectedParameters = {