From fca2108d73d61edd262ea0c51fcdfdf69bf61a8a Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Wed, 20 Apr 2022 18:42:45 +0000 Subject: [PATCH] build(node): update client library version in samples metadata (#1356) (#290) * build(node): add feat in node post-processor to add client library version number in snippet metadata Co-authored-by: Benjamin E. Coe Source-Link: https://github.com/googleapis/synthtool/commit/d337b88dd1494365183718a2de0b7b4056b6fdfe Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-nodejs:latest@sha256:d106724ad2a96daa1b8d88de101ba50bdb30b8df62ffa0aa2b451d93b4556641 --- ...t_metadata.google.cloud.aiplatform.v1.json | 17106 +++++++-------- ...adata.google.cloud.aiplatform.v1beta1.json | 17386 ++++++++-------- 2 files changed, 17246 insertions(+), 17246 deletions(-) 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 08b2cefdf59..d02d4bb91f2 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 @@ -1,8555 +1,8555 @@ { - "clientLibrary": { - "name": "nodejs-aiplatform", - "version": "0.1.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": 57, - "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": 54, - "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": 60, - "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": 88, - "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": 53, - "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": 59, - "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": 58, - "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": 75, - "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_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": 56, - "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": 75, - "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": 68, - "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": 52, - "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": 94, - "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": 55, - "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": 53, - "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": 73, - "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": 68, - "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_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": 66, - "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": 70, - "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_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": 67, - "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": 50, - "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": 102, - "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": 67, - "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": 59, - "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": 66, - "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": 52, - "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": 101, - "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": 73, - "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": 58, - "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": 67, - "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": 61, - "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": 52, - "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": 111, - "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": 67, - "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": 53, - "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": 103, - "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": 100, - "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[]" - } - ], - "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": 77, - "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_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": 121, - "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": 57, - "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": 52, - "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": 87, - "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": 55, - "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": 53, - "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": 58, - "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": 58, - "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": 60, - "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": 57, - "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": 52, - "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": 72, - "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": 56, - "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": 53, - "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_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": 56, - "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": 52, - "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": 80, - "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": 53, - "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": 52, - "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": 56, - "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": 52, - "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": 86, - "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": 53, - "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": 52, - "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": 56, - "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": 52, - "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": 80, - "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": 53, - "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": 52, - "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_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": 56, - "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": 52, - "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": 81, - "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": 53, - "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": 52, - "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": 56, - "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": 92, - "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": 52, - "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": 69, - "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": 81, - "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": 53, - "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": 52, - "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": 52, - "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_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": 69, - "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": 52, - "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": 69, - "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": 53, - "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": 68, - "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": 52, - "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": 94, - "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" - } - ], - "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": 64, - "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": 59, - "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": 65, - "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": 68, - "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": 52, - "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": 97, - "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" - } - ], - "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": 64, - "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": 64, - "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": 65, - "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": 66, - "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": 56, - "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_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": 56, - "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": 69, - "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" - } + "clientLibrary": { + "name": "nodejs-aiplatform", + "version": "1.19.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": 57, + "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": 54, + "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": 60, + "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": 88, + "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": 53, + "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": 59, + "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": 58, + "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": 75, + "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_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": 56, + "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": 75, + "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": 68, + "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": 52, + "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": 94, + "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": 55, + "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": 53, + "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": 73, + "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": 68, + "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_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": 66, + "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": 70, + "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_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": 67, + "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": 50, + "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": 102, + "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": 67, + "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": 59, + "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": 66, + "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": 52, + "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": 101, + "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": 73, + "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": 58, + "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": 67, + "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": 61, + "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": 52, + "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": 111, + "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": 67, + "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": 53, + "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": 103, + "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": 100, + "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[]" + } + ], + "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": 77, + "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_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": 121, + "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": 57, + "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": 52, + "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": 87, + "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": 55, + "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": 53, + "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": 58, + "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": 58, + "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": 60, + "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": 57, + "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": 52, + "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": 72, + "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": 56, + "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": 53, + "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_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": 56, + "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": 52, + "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": 80, + "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": 53, + "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": 52, + "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": 56, + "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": 52, + "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": 86, + "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": 53, + "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": 52, + "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": 56, + "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": 52, + "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": 80, + "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": 53, + "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": 52, + "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_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": 56, + "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": 52, + "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": 81, + "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": 53, + "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": 52, + "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": 56, + "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": 92, + "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": 52, + "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": 69, + "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": 81, + "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": 53, + "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": 52, + "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": 52, + "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_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": 69, + "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": 52, + "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": 69, + "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": 53, + "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": 68, + "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": 52, + "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": 94, + "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" + } + ], + "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": 64, + "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": 59, + "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": 65, + "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": 68, + "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": 52, + "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": 97, + "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" + } + ], + "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": 64, + "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": 64, + "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": 65, + "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": 66, + "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": 56, + "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_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": 56, + "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": 69, + "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": 52, + "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": 94, + "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" + } + ], + "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": 64, + "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": 59, + "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": 65, + "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": 57, + "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": 53, + "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": 69, + "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": 52, + "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": 73, + "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": 85, + "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": 79, + "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": 59, + "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_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": 57, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UploadModel", + "fullName": "google.cloud.aiplatform.v1.ModelService.UploadModel", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "model", + "type": ".google.cloud.aiplatform.v1.Model" + } + ], + "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": 51, + "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": 94, + "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_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": 73, + "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_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": 52, + "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_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": 56, + "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_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": 56, + "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_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": 52, + "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": 72, + "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": 52, + "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": 74, + "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": 56, + "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": 52, + "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": 80, + "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": 53, + "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": 52, + "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": 64, + "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": 52, + "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": 111, + "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" + } + ], + "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": 53, + "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": 52, + "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": 72, + "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": 66, + "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_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. Only deployed AutoML tabular Models have explanation_spec.", + "canonical": true, + "file": "prediction_service.explain.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 88, + "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_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": 57, + "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": 52, + "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": 68, + "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": 58, + "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": 56, + "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": 57, + "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": 52, + "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": 63, + "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": 82, + "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": 53, + "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_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": 64, + "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": 52, + "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": 62, + "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": 82, + "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": 53, + "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": 65, + "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": 60, + "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": 52, + "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": 62, + "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": 82, + "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": 53, + "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": 62, + "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": 65, + "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": 52, + "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": 63, + "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": 82, + "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": 53, + "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 will be returned. Otherwise, that limit number of data points will be 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": 60, + "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 will be returned. Otherwise, 1000 data points will be 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": 62, + "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": 58, + "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 will be returned.", + "canonical": true, + "file": "tensorboard_service.write_tensorboard_experiment_data.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 57, + "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 will be returned.", + "canonical": true, + "file": "tensorboard_service.write_tensorboard_run_data.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "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": 79, + "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": 56, + "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": 51, + "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": 63, + "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": 51, + "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": 56, + "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.ml.v1.SuggestTrialsResponse].", + "canonical": true, + "file": "vizier_service.suggest_trials.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "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": 56, + "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": 52, + "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": 63, + "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": 57, + "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": 68, + "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": 52, + "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.ml.v1.CheckTrialEarlyStoppingStateResponse].", + "canonical": true, + "file": "vizier_service.check_trial_early_stopping_state.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "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": 52, + "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": 50, + "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" + } + } + } } - } - }, - { - "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": 52, - "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": 94, - "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" - } - ], - "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": 64, - "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": 59, - "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": 65, - "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": 57, - "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": 53, - "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": 69, - "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": 52, - "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": 73, - "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": 85, - "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": 79, - "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": 59, - "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_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": 57, - "type": "FULL" - } - ], - "clientMethod": { - "shortName": "UploadModel", - "fullName": "google.cloud.aiplatform.v1.ModelService.UploadModel", - "async": true, - "parameters": [ - { - "name": "parent", - "type": "TYPE_STRING" - }, - { - "name": "model", - "type": ".google.cloud.aiplatform.v1.Model" - } - ], - "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": 51, - "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": 94, - "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_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": 73, - "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_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": 52, - "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_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": 56, - "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_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": 56, - "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_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": 52, - "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": 72, - "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": 52, - "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": 74, - "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": 56, - "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": 52, - "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": 80, - "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": 53, - "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": 52, - "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": 64, - "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": 52, - "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": 111, - "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" - } - ], - "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": 53, - "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": 52, - "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": 72, - "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": 66, - "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_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. Only deployed AutoML tabular Models have explanation_spec.", - "canonical": true, - "file": "prediction_service.explain.js", - "language": "JAVASCRIPT", - "segments": [ - { - "start": 25, - "end": 88, - "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_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": 57, - "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": 52, - "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": 68, - "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": 58, - "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": 56, - "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": 57, - "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": 52, - "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": 63, - "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": 82, - "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": 53, - "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_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": 64, - "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": 52, - "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": 62, - "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": 82, - "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": 53, - "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": 65, - "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": 60, - "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": 52, - "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": 62, - "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": 82, - "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": 53, - "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": 62, - "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": 65, - "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": 52, - "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": 63, - "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": 82, - "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": 53, - "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 will be returned. Otherwise, that limit number of data points will be 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": 60, - "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 will be returned. Otherwise, 1000 data points will be 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": 62, - "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": 58, - "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 will be returned.", - "canonical": true, - "file": "tensorboard_service.write_tensorboard_experiment_data.js", - "language": "JAVASCRIPT", - "segments": [ - { - "start": 25, - "end": 57, - "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 will be returned.", - "canonical": true, - "file": "tensorboard_service.write_tensorboard_run_data.js", - "language": "JAVASCRIPT", - "segments": [ - { - "start": 25, - "end": 61, - "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": 79, - "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": 56, - "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": 51, - "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": 63, - "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": 51, - "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": 56, - "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.ml.v1.SuggestTrialsResponse].", - "canonical": true, - "file": "vizier_service.suggest_trials.js", - "language": "JAVASCRIPT", - "segments": [ - { - "start": 25, - "end": 65, - "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": 56, - "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": 52, - "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": 63, - "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": 57, - "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": 68, - "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": 52, - "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.ml.v1.CheckTrialEarlyStoppingStateResponse].", - "canonical": true, - "file": "vizier_service.check_trial_early_stopping_state.js", - "language": "JAVASCRIPT", - "segments": [ - { - "start": 25, - "end": 53, - "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": 52, - "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": 50, - "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/v1beta1/snippet_metadata.google.cloud.aiplatform.v1beta1.json b/packages/google-cloud-aiplatform/samples/generated/v1beta1/snippet_metadata.google.cloud.aiplatform.v1beta1.json index 2abadddb8b4..5e087b4eafb 100644 --- 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 @@ -1,8695 +1,8695 @@ { - "clientLibrary": { - "name": "nodejs-aiplatform", - "version": "0.1.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": 57, - "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": 54, - "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": 60, - "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": 88, - "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": 53, - "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": 59, - "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": 58, - "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": 75, - "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_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": 56, - "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": 75, - "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_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": 68, - "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": 52, - "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": 84, - "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": 55, - "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": 53, - "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": 73, - "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": 68, - "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_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": 66, - "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": 70, - "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_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": 67, - "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": 50, - "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": 102, - "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": 67, - "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": 59, - "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": 66, - "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": 52, - "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": 101, - "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": 73, - "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": 58, - "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": 67, - "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": 61, - "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": 52, - "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": 111, - "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": 67, - "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": 53, - "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": 103, - "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": 100, - "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[]" - } - ], - "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": 77, - "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_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": 121, - "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": 57, - "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": 52, - "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": 87, - "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": 55, - "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": 53, - "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": 58, - "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": 58, - "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": 60, - "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": 57, - "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": 52, - "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": 72, - "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": 56, - "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": 53, - "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_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": 56, - "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": 52, - "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": 80, - "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": 53, - "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": 52, - "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": 56, - "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": 52, - "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": 86, - "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": 53, - "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": 52, - "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": 56, - "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": 52, - "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": 80, - "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": 53, - "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": 52, - "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_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": 56, - "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": 52, - "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": 81, - "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": 53, - "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": 52, - "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": 56, - "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": 92, - "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": 52, - "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": 69, - "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": 81, - "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": 53, - "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": 52, - "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": 52, - "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_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": 69, - "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": 52, - "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": 69, - "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": 53, - "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": 68, - "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": 52, - "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": 94, - "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" - } - ], - "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": 64, - "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": 59, - "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": 65, - "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": 68, - "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": 52, - "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": 97, - "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" - } - ], - "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": 64, - "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": 64, - "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": 65, - "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": 66, - "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": 56, - "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_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": 56, - "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": 69, - "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": 52, - "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": 94, - "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" - } - ], - "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": 64, - "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" - } + "clientLibrary": { + "name": "nodejs-aiplatform", + "version": "1.19.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": 57, + "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": 54, + "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": 60, + "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": 88, + "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": 53, + "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": 59, + "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": 58, + "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": 75, + "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_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": 56, + "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": 75, + "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_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": 68, + "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": 52, + "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": 84, + "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": 55, + "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": 53, + "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": 73, + "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": 68, + "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_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": 66, + "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": 70, + "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_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": 67, + "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": 50, + "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": 102, + "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": 67, + "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": 59, + "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": 66, + "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": 52, + "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": 101, + "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": 73, + "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": 58, + "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": 67, + "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": 61, + "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": 52, + "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": 111, + "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": 67, + "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": 53, + "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": 103, + "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": 100, + "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[]" + } + ], + "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": 77, + "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_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": 121, + "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": 57, + "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": 52, + "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": 87, + "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": 55, + "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": 53, + "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": 58, + "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": 58, + "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": 60, + "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": 57, + "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": 52, + "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": 72, + "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": 56, + "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": 53, + "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_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": 56, + "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": 52, + "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": 80, + "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": 53, + "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": 52, + "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": 56, + "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": 52, + "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": 86, + "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": 53, + "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": 52, + "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": 56, + "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": 52, + "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": 80, + "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": 53, + "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": 52, + "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_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": 56, + "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": 52, + "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": 81, + "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": 53, + "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": 52, + "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": 56, + "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": 92, + "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": 52, + "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": 69, + "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": 81, + "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": 53, + "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": 52, + "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": 52, + "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_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": 69, + "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": 52, + "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": 69, + "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": 53, + "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": 68, + "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": 52, + "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": 94, + "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" + } + ], + "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": 64, + "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": 59, + "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": 65, + "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": 68, + "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": 52, + "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": 97, + "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" + } + ], + "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": 64, + "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": 64, + "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": 65, + "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": 66, + "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": 56, + "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_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": 56, + "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": 69, + "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": 52, + "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": 94, + "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" + } + ], + "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": 64, + "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": 59, + "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": 65, + "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": 57, + "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": 53, + "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": 69, + "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": 52, + "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": 73, + "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": 85, + "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": 79, + "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": 59, + "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_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": 69, + "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" + } + ], + "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": 51, + "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": 84, + "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": 78, + "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" + } + ], + "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": 73, + "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_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": 52, + "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][] 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": 53, + "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": 67, + "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": 56, + "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_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": 56, + "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_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": 52, + "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": 72, + "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": 52, + "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": 74, + "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_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": 56, + "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": 52, + "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": 80, + "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": 53, + "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": 52, + "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": 64, + "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": 52, + "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": 111, + "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" + } + ], + "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": 53, + "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": 52, + "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": 72, + "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": 66, + "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_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. Only deployed AutoML tabular Models have explanation_spec.", + "canonical": true, + "file": "prediction_service.explain.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 88, + "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_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": 57, + "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": 52, + "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": 68, + "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": 58, + "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": 56, + "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": 57, + "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": 52, + "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": 63, + "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": 82, + "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": 53, + "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_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": 64, + "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": 52, + "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": 62, + "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": 82, + "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": 53, + "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": 65, + "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": 60, + "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": 52, + "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": 62, + "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": 82, + "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": 53, + "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": 62, + "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": 65, + "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": 52, + "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": 63, + "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": 82, + "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": 53, + "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 will be returned. Otherwise, that limit number of data points will be 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": 60, + "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 will be returned. Otherwise, 1000 data points will be 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": 62, + "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": 58, + "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 will be returned.", + "canonical": true, + "file": "tensorboard_service.write_tensorboard_experiment_data.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 57, + "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 will be returned.", + "canonical": true, + "file": "tensorboard_service.write_tensorboard_run_data.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "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": 79, + "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": 56, + "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": 51, + "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": 63, + "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": 51, + "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": 56, + "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.ml.v1.SuggestTrialsResponse].", + "canonical": true, + "file": "vizier_service.suggest_trials.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "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": 56, + "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": 52, + "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": 63, + "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": 57, + "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": 68, + "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": 52, + "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.ml.v1.CheckTrialEarlyStoppingStateResponse].", + "canonical": true, + "file": "vizier_service.check_trial_early_stopping_state.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "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": 52, + "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": 50, + "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" + } + } + } } - } - }, - { - "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": 59, - "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": 65, - "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": 57, - "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": 53, - "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": 69, - "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": 52, - "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": 73, - "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": 85, - "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": 79, - "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": 59, - "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_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": 69, - "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" - } - ], - "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": 51, - "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": 84, - "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": 78, - "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" - } - ], - "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": 73, - "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_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": 52, - "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][] 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": 53, - "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": 67, - "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": 56, - "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_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": 56, - "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_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": 52, - "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": 72, - "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": 52, - "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": 74, - "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_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": 56, - "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": 52, - "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": 80, - "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": 53, - "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": 52, - "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": 64, - "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": 52, - "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": 111, - "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" - } - ], - "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": 53, - "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": 52, - "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": 72, - "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": 66, - "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_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. Only deployed AutoML tabular Models have explanation_spec.", - "canonical": true, - "file": "prediction_service.explain.js", - "language": "JAVASCRIPT", - "segments": [ - { - "start": 25, - "end": 88, - "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_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": 57, - "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": 52, - "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": 68, - "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": 58, - "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": 56, - "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": 57, - "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": 52, - "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": 63, - "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": 82, - "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": 53, - "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_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": 64, - "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": 52, - "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": 62, - "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": 82, - "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": 53, - "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": 65, - "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": 60, - "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": 52, - "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": 62, - "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": 82, - "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": 53, - "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": 62, - "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": 65, - "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": 52, - "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": 63, - "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": 82, - "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": 53, - "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 will be returned. Otherwise, that limit number of data points will be 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": 60, - "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 will be returned. Otherwise, 1000 data points will be 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": 62, - "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": 58, - "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 will be returned.", - "canonical": true, - "file": "tensorboard_service.write_tensorboard_experiment_data.js", - "language": "JAVASCRIPT", - "segments": [ - { - "start": 25, - "end": 57, - "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 will be returned.", - "canonical": true, - "file": "tensorboard_service.write_tensorboard_run_data.js", - "language": "JAVASCRIPT", - "segments": [ - { - "start": 25, - "end": 61, - "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": 79, - "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": 56, - "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": 51, - "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": 63, - "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": 51, - "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": 56, - "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.ml.v1.SuggestTrialsResponse].", - "canonical": true, - "file": "vizier_service.suggest_trials.js", - "language": "JAVASCRIPT", - "segments": [ - { - "start": 25, - "end": 65, - "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": 56, - "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": 52, - "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": 63, - "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": 57, - "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": 68, - "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": 52, - "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.ml.v1.CheckTrialEarlyStoppingStateResponse].", - "canonical": true, - "file": "vizier_service.check_trial_early_stopping_state.js", - "language": "JAVASCRIPT", - "segments": [ - { - "start": 25, - "end": 53, - "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": 52, - "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": 50, - "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