diff --git a/packages/google-cloud-aiplatform/.jsdoc.js b/packages/google-cloud-aiplatform/.jsdoc.js index a5ec80d793e..c805f17d6a9 100644 --- a/packages/google-cloud-aiplatform/.jsdoc.js +++ b/packages/google-cloud-aiplatform/.jsdoc.js @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -40,7 +40,7 @@ module.exports = { includePattern: '\\.js$' }, templates: { - copyright: 'Copyright 2022 Google LLC', + copyright: 'Copyright 2023 Google LLC', includeDate: false, sourceFiles: false, systemName: '@google-cloud/aiplatform', diff --git a/packages/google-cloud-aiplatform/README.md b/packages/google-cloud-aiplatform/README.md index 074c3752445..691c1827c0c 100644 --- a/packages/google-cloud-aiplatform/README.md +++ b/packages/google-cloud-aiplatform/README.md @@ -34,8 +34,8 @@ Google APIs Client Libraries, in [Client Libraries Explained][explained]. * [Quickstart](#quickstart) * [Before you begin](#before-you-begin) * [Installing the client library](#installing-the-client-library) - - + * [Using the client library](#using-the-client-library) +* [Samples](#samples) * [Versioning](#versioning) * [Contributing](#contributing) * [License](#license) @@ -57,6 +57,55 @@ npm install @google-cloud/aiplatform ``` +### Using the client library + +```javascript +/** + * TODO(developer): Uncomment these variables before running the sample. + */ +// const projectId = 'YOUR_PROJECT_ID'; +// const location = 'YOUR_PROJECT_LOCATION'; + +const {EndpointServiceClient} = require('@google-cloud/aiplatform'); + +// Specifies the location of the api endpoint +const clientOptions = { + apiEndpoint: 'us-central1-aiplatform.googleapis.com', +}; +const client = new EndpointServiceClient(clientOptions); + +async function listEndpoints() { + // Configure the parent resource + const parent = `projects/${projectId}/locations/${location}`; + const request = { + parent, + }; + + // Get and print out a list of all the endpoints for this resource + const [result] = await client.listEndpoints(request); + for (const endpoint of result) { + console.log(`\nEndpoint name: ${endpoint.name}`); + console.log(`Display name: ${endpoint.displayName}`); + if (endpoint.deployedModels[0]) { + console.log( + `First deployed model: ${endpoint.deployedModels[0].model}` + ); + } + } +} +listEndpoints(); + +``` + + + +## Samples + +Samples are in the [`samples/`](https://github.com/googleapis/nodejs-ai-platform/tree/main/samples) directory. Each sample's `README.md` has instructions for running its sample. + +| Sample | Source Code | Try it | +| --------------------------- | --------------------------------- | ------ | +| Quickstart | [source code](https://github.com/googleapis/nodejs-ai-platform/blob/main/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-ai-platform&page=editor&open_in_editor=samples/quickstart.js,samples/README.md) | diff --git a/packages/google-cloud-aiplatform/package.json b/packages/google-cloud-aiplatform/package.json index d063d3bc10a..f8f9089379b 100644 --- a/packages/google-cloud-aiplatform/package.json +++ b/packages/google-cloud-aiplatform/package.json @@ -43,6 +43,7 @@ "prelint": "cd samples; npm link ../; npm i", "prepare": "npm run compile-protos && npm run compile", "system-test": "c8 mocha build/system-test", + "samples-test": "cd samples/ && npm link ../ && npm test", "test": "c8 node build/test/run.js" }, "dependencies": { diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/annotation.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/annotation.proto index 3a1048090be..c490f955b80 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/annotation.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/annotation.proto @@ -41,8 +41,9 @@ message Annotation { // Output only. Resource name of the Annotation. string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Required. Google Cloud Storage URI points to a YAML file describing [payload][google.cloud.aiplatform.v1.Annotation.payload]. The - // schema is defined as an [OpenAPI 3.0.2 Schema + // Required. Google Cloud Storage URI points to a YAML file describing + // [payload][google.cloud.aiplatform.v1.Annotation.payload]. The schema is + // defined as an [OpenAPI 3.0.2 Schema // Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). // The schema files that can be used here are found in // gs://google-cloud-aiplatform/schema/dataset/annotation/, note that the @@ -55,19 +56,23 @@ message Annotation { google.protobuf.Value payload = 3 [(google.api.field_behavior) = REQUIRED]; // Output only. Timestamp when this Annotation was created. - google.protobuf.Timestamp create_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this Annotation was last updated. - google.protobuf.Timestamp update_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 7 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Optional. Used to perform consistent read-modify-write updates. If not set, a blind - // "overwrite" update happens. + // Optional. Used to perform consistent read-modify-write updates. If not set, + // a blind "overwrite" update happens. string etag = 8 [(google.api.field_behavior) = OPTIONAL]; // Output only. The source of the Annotation. - UserActionReference annotation_source = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + UserActionReference annotation_source = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Optional. The labels with user-defined metadata to organize your Annotations. + // Optional. The labels with user-defined metadata to organize your + // Annotations. // // Label keys and values can be no longer than 64 characters // (Unicode codepoints), can only contain lowercase letters, numeric @@ -84,7 +89,8 @@ message Annotation { // If not set, the Annotation is not visible in the UI. // // * "aiplatform.googleapis.com/payload_schema": - // output only, its value is the [payload_schema's][google.cloud.aiplatform.v1.Annotation.payload_schema_uri] + // output only, its value is the + // [payload_schema's][google.cloud.aiplatform.v1.Annotation.payload_schema_uri] // title. map labels = 6 [(google.api.field_behavior) = OPTIONAL]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/annotation_spec.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/annotation_spec.proto index 3082e3ee94a..e4bffcccd3b 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/annotation_spec.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/annotation_spec.proto @@ -39,17 +39,19 @@ message AnnotationSpec { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. The user-defined name of the AnnotationSpec. - // The name can be up to 128 characters long and can be consist of any UTF-8 + // The name can be up to 128 characters long and can consist of any UTF-8 // characters. string display_name = 2 [(google.api.field_behavior) = REQUIRED]; // Output only. Timestamp when this AnnotationSpec was created. - google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when AnnotationSpec was last updated. - google.protobuf.Timestamp update_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Optional. Used to perform consistent read-modify-write updates. If not set, a blind - // "overwrite" update happens. + // Optional. Used to perform consistent read-modify-write updates. If not set, + // a blind "overwrite" update happens. string etag = 5 [(google.api.field_behavior) = OPTIONAL]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/artifact.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/artifact.proto index d7ef997ad68..2dbe5f5dd93 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/artifact.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/artifact.proto @@ -75,10 +75,12 @@ message Artifact { map labels = 10; // Output only. Timestamp when this Artifact was created. - google.protobuf.Timestamp create_time = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 11 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this Artifact was last updated. - google.protobuf.Timestamp update_time = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 12 + [(google.api.field_behavior) = OUTPUT_ONLY]; // The state of this Artifact. This is a property of the Artifact, and does // not imply or capture any ongoing process. This property is managed by @@ -101,6 +103,7 @@ message Artifact { string schema_version = 15; // Properties of the Artifact. + // Top level metadata keys' heading and trailing spaces will be trimmed. // The size of this field should not exceed 200KB. google.protobuf.Struct metadata = 16; diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/batch_prediction_job.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/batch_prediction_job.proto index 21568cee04d..5ab6fe98746 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/batch_prediction_job.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/batch_prediction_job.proto @@ -38,8 +38,10 @@ option java_package = "com.google.cloud.aiplatform.v1"; option php_namespace = "Google\\Cloud\\AIPlatform\\V1"; option ruby_package = "Google::Cloud::AIPlatform::V1"; -// A job that uses a [Model][google.cloud.aiplatform.v1.BatchPredictionJob.model] to produce predictions -// on multiple [input instances][google.cloud.aiplatform.v1.BatchPredictionJob.input_config]. If +// A job that uses a +// [Model][google.cloud.aiplatform.v1.BatchPredictionJob.model] to produce +// predictions on multiple [input +// instances][google.cloud.aiplatform.v1.BatchPredictionJob.input_config]. If // predictions for significant portion of the instances fail, the job may finish // without attempting predictions for all remaining instances. message BatchPredictionJob { @@ -48,9 +50,11 @@ message BatchPredictionJob { pattern: "projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}" }; - // Configures the input to [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob]. - // See [Model.supported_input_storage_formats][google.cloud.aiplatform.v1.Model.supported_input_storage_formats] for Model's supported input - // formats, and how instances should be expressed via any of them. + // Configures the input to + // [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob]. See + // [Model.supported_input_storage_formats][google.cloud.aiplatform.v1.Model.supported_input_storage_formats] + // for Model's supported input formats, and how instances should be expressed + // via any of them. message InputConfig { // Required. The source of the input. oneof source { @@ -71,9 +75,109 @@ message BatchPredictionJob { string instances_format = 1 [(google.api.field_behavior) = REQUIRED]; } - // Configures the output of [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob]. - // See [Model.supported_output_storage_formats][google.cloud.aiplatform.v1.Model.supported_output_storage_formats] for supported output - // formats, and how predictions are expressed via any of them. + // Configuration defining how to transform batch prediction input instances to + // the instances that the Model accepts. + message InstanceConfig { + // The format of the instance that the Model accepts. Vertex AI will + // convert compatible + // [batch prediction input instance + // formats][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.instances_format] + // to the specified format. + // + // Supported values are: + // + // * `object`: Each input is converted to JSON object format. + // * For `bigquery`, each row is converted to an object. + // * For `jsonl`, each line of the JSONL input must be an object. + // * Does not apply to `csv`, `file-list`, `tf-record`, or + // `tf-record-gzip`. + // + // * `array`: Each input is converted to JSON array format. + // * For `bigquery`, each row is converted to an array. The order + // of columns is determined by the BigQuery column order, unless + // [included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields] + // is populated. + // [included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields] + // must be populated for specifying field orders. + // * For `jsonl`, if each line of the JSONL input is an object, + // [included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields] + // must be populated for specifying field orders. + // * Does not apply to `csv`, `file-list`, `tf-record`, or + // `tf-record-gzip`. + // + // If not specified, Vertex AI converts the batch prediction input as + // follows: + // + // * For `bigquery` and `csv`, the behavior is the same as `array`. The + // order of columns is the same as defined in the file or table, unless + // [included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields] + // is populated. + // * For `jsonl`, the prediction instance format is determined by + // each line of the input. + // * For `tf-record`/`tf-record-gzip`, each record will be converted to + // an object in the format of `{"b64": }`, where `` is + // the Base64-encoded string of the content of the record. + // * For `file-list`, each file in the list will be converted to an + // object in the format of `{"b64": }`, where `` is + // the Base64-encoded string of the content of the file. + string instance_type = 1; + + // The name of the field that is considered as a key. + // + // The values identified by the key field is not included in the transformed + // instances that is sent to the Model. This is similar to + // specifying this name of the field in + // [excluded_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.excluded_fields]. + // In addition, the batch prediction output will not include the instances. + // Instead the output will only include the value of the key field, in a + // field named `key` in the output: + // + // * For `jsonl` output format, the output will have a `key` field + // instead of the `instance` field. + // * For `csv`/`bigquery` output format, the output will have have a `key` + // column instead of the instance feature columns. + // + // The input must be JSONL with objects at each line, CSV, BigQuery + // or TfRecord. + string key_field = 2; + + // Fields that will be included in the prediction instance that is + // sent to the Model. + // + // If + // [instance_type][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.instance_type] + // is `array`, the order of field names in included_fields also determines + // the order of the values in the array. + // + // When included_fields is populated, + // [excluded_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.excluded_fields] + // must be empty. + // + // The input must be JSONL with objects at each line, CSV, BigQuery + // or TfRecord. + repeated string included_fields = 3; + + // Fields that will be excluded in the prediction instance that is + // sent to the Model. + // + // Excluded will be attached to the batch prediction output if + // [key_field][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.key_field] + // is not specified. + // + // When excluded_fields is populated, + // [included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields] + // must be empty. + // + // The input must be JSONL with objects at each line, CSV, BigQuery + // or TfRecord. + repeated string excluded_fields = 4; + } + + // Configures the output of + // [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob]. See + // [Model.supported_output_storage_formats][google.cloud.aiplatform.v1.Model.supported_output_storage_formats] + // for supported output formats, and how predictions are expressed via any of + // them. message OutputConfig { // Required. The destination of the output. oneof destination { @@ -84,11 +188,13 @@ message BatchPredictionJob { // Inside of it files `predictions_0001.`, // `predictions_0002.`, ..., `predictions_N.` // are created where `` depends on chosen - // [predictions_format][google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig.predictions_format], and N may equal 0001 and depends on the total - // number of successfully predicted instances. - // If the Model has both [instance][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri] - // and [prediction][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri] schemata - // defined then each such file contains predictions as per the + // [predictions_format][google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig.predictions_format], + // and N may equal 0001 and depends on the total number of successfully + // predicted instances. If the Model has both + // [instance][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri] + // and + // [prediction][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri] + // schemata defined then each such file contains predictions as per the // [predictions_format][google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig.predictions_format]. // If prediction for any instance failed (partially or completely), then // an additional `errors_0001.`, `errors_0002.`,..., @@ -107,45 +213,51 @@ message BatchPredictionJob { // become underscores), and timestamp is in // YYYY_MM_DDThh_mm_ss_sssZ "based on ISO-8601" format. In the dataset // two tables will be created, `predictions`, and `errors`. - // If the Model has both [instance][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri] - // and [prediction][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri] schemata - // defined then the tables have columns as follows: The `predictions` - // table contains instances for which the prediction succeeded, it - // has columns as per a concatenation of the Model's instance and - // prediction schemata. The `errors` table contains rows for which the - // prediction has failed, it has instance columns, as per the + // If the Model has both + // [instance][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri] + // and + // [prediction][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri] + // schemata defined then the tables have columns as follows: The + // `predictions` table contains instances for which the prediction + // succeeded, it has columns as per a concatenation of the Model's + // instance and prediction schemata. The `errors` table contains rows for + // which the prediction has failed, it has instance columns, as per the // instance schema, followed by a single "errors" column, which as values // has [google.rpc.Status][google.rpc.Status] // represented as a STRUCT, and containing only `code` and `message`. BigQueryDestination bigquery_destination = 3; } - // Required. The format in which Vertex AI gives the predictions, must be one of the - // [Model's][google.cloud.aiplatform.v1.BatchPredictionJob.model] + // Required. The format in which Vertex AI gives the predictions, must be + // one of the [Model's][google.cloud.aiplatform.v1.BatchPredictionJob.model] // [supported_output_storage_formats][google.cloud.aiplatform.v1.Model.supported_output_storage_formats]. string predictions_format = 1 [(google.api.field_behavior) = REQUIRED]; } // Further describes this job's output. - // Supplements [output_config][google.cloud.aiplatform.v1.BatchPredictionJob.output_config]. + // Supplements + // [output_config][google.cloud.aiplatform.v1.BatchPredictionJob.output_config]. message OutputInfo { // The output location into which prediction output is written. oneof output_location { - // Output only. The full path of the Cloud Storage directory created, into which - // the prediction output is written. - string gcs_output_directory = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. The full path of the Cloud Storage directory created, into + // which the prediction output is written. + string gcs_output_directory = 1 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The path of the BigQuery dataset created, in // `bq://projectId.bqDatasetId` // format, into which the prediction output is written. - string bigquery_output_dataset = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + string bigquery_output_dataset = 2 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // Output only. The name of the BigQuery table created, in // `predictions_` // format, into which the prediction output is written. // Can be used by UI to generate the BigQuery output path, for example. - string bigquery_output_table = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + string bigquery_output_table = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // Output only. Resource name of the BatchPredictionJob. @@ -163,10 +275,11 @@ message BatchPredictionJob { // The model resource name may contain version id or version alias to specify // the version, if no version is specified, the default version will be used. string model = 3 [(google.api.resource_reference) = { - type: "aiplatform.googleapis.com/Model" - }]; + type: "aiplatform.googleapis.com/Model" + }]; - // Output only. The version ID of the Model that produces the predictions via this job. + // Output only. The version ID of the Model that produces the predictions via + // this job. string model_version_id = 30 [(google.api.field_behavior) = OUTPUT_ONLY]; // Contains model information necessary to perform batch prediction without @@ -174,15 +287,20 @@ message BatchPredictionJob { // Exactly one of model and unmanaged_container_model must be set. UnmanagedContainerModel unmanaged_container_model = 28; - // Required. Input configuration of the instances on which predictions are performed. - // The schema of any single instance may be specified via - // the [Model's][google.cloud.aiplatform.v1.BatchPredictionJob.model] + // Required. Input configuration of the instances on which predictions are + // performed. The schema of any single instance may be specified via the + // [Model's][google.cloud.aiplatform.v1.BatchPredictionJob.model] // [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata] // [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri]. InputConfig input_config = 4 [(google.api.field_behavior) = REQUIRED]; + // Configuration for how to convert batch prediction input instances to the + // prediction instances that are sent to the Model. + InstanceConfig instance_config = 27; + // The parameters that govern the predictions. The schema of the parameters - // may be specified via the [Model's][google.cloud.aiplatform.v1.BatchPredictionJob.model] + // may be specified via the + // [Model's][google.cloud.aiplatform.v1.BatchPredictionJob.model] // [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata] // [parameters_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri]. google.protobuf.Value model_parameters = 5; @@ -198,41 +316,66 @@ message BatchPredictionJob { OutputConfig output_config = 6 [(google.api.field_behavior) = REQUIRED]; // The config of resources used by the Model during the batch prediction. If - // the Model [supports][google.cloud.aiplatform.v1.Model.supported_deployment_resources_types] + // the Model + // [supports][google.cloud.aiplatform.v1.Model.supported_deployment_resources_types] // DEDICATED_RESOURCES this config may be provided (and the job will use these // resources), if the Model doesn't support AUTOMATIC_RESOURCES, this config // must be provided. BatchDedicatedResources dedicated_resources = 7; - // Immutable. Parameters configuring the batch behavior. Currently only applicable when - // [dedicated_resources][google.cloud.aiplatform.v1.BatchPredictionJob.dedicated_resources] are used (in other cases Vertex AI does - // the tuning itself). - ManualBatchTuningParameters manual_batch_tuning_parameters = 8 [(google.api.field_behavior) = IMMUTABLE]; + // The service account that the DeployedModel's container runs as. If not + // specified, a system generated one will be used, which + // has minimal permissions and the custom container, if used, may not have + // enough permission to access other Google Cloud resources. + // + // Users deploying the Model must have the `iam.serviceAccounts.actAs` + // permission on this service account. + string service_account = 29; + + // Immutable. Parameters configuring the batch behavior. Currently only + // applicable when + // [dedicated_resources][google.cloud.aiplatform.v1.BatchPredictionJob.dedicated_resources] + // are used (in other cases Vertex AI does the tuning itself). + ManualBatchTuningParameters manual_batch_tuning_parameters = 8 + [(google.api.field_behavior) = IMMUTABLE]; // Generate explanation with the batch prediction results. // // When set to `true`, the batch prediction output changes based on the // `predictions_format` field of the - // [BatchPredictionJob.output_config][google.cloud.aiplatform.v1.BatchPredictionJob.output_config] object: + // [BatchPredictionJob.output_config][google.cloud.aiplatform.v1.BatchPredictionJob.output_config] + // object: // // * `bigquery`: output includes a column named `explanation`. The value - // is a struct that conforms to the [Explanation][google.cloud.aiplatform.v1.Explanation] object. + // is a struct that conforms to the + // [Explanation][google.cloud.aiplatform.v1.Explanation] object. // * `jsonl`: The JSON objects on each line include an additional entry // keyed `explanation`. The value of the entry is a JSON object that - // conforms to the [Explanation][google.cloud.aiplatform.v1.Explanation] object. + // conforms to the [Explanation][google.cloud.aiplatform.v1.Explanation] + // object. // * `csv`: Generating explanations for CSV format is not supported. // - // If this field is set to true, either the [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec] or - // [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec] must be populated. + // If this field is set to true, either the + // [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec] + // or + // [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec] + // must be populated. bool generate_explanation = 23; // Explanation configuration for this BatchPredictionJob. Can be - // specified only if [generate_explanation][google.cloud.aiplatform.v1.BatchPredictionJob.generate_explanation] is set to `true`. + // specified only if + // [generate_explanation][google.cloud.aiplatform.v1.BatchPredictionJob.generate_explanation] + // is set to `true`. // - // This value overrides the value of [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec]. All fields of - // [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec] are optional in the request. If a field of the - // [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec] object is not populated, the corresponding field of - // the [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec] object is inherited. + // This value overrides the value of + // [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec]. + // All fields of + // [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec] + // are optional in the request. If a field of the + // [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec] + // object is not populated, the corresponding field of the + // [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec] + // object is inherited. ExplanationSpec explanation_spec = 25; // Output only. Information further describing the output of this job. @@ -248,33 +391,40 @@ message BatchPredictionJob { // Output only. Partial failures encountered. // For example, single files that can't be read. // This field never exceeds 20 entries. - // Status details fields contain standard GCP error details. - repeated google.rpc.Status partial_failures = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Status details fields contain standard Google Cloud error details. + repeated google.rpc.Status partial_failures = 12 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. Information about resources that had been consumed by this job. - // Provided in real time at best effort basis, as well as a final value + // Output only. Information about resources that had been consumed by this + // job. Provided in real time at best effort basis, as well as a final value // once the job completes. // // Note: This field currently may be not populated for batch predictions that // use AutoML Models. - ResourcesConsumed resources_consumed = 13 [(google.api.field_behavior) = OUTPUT_ONLY]; + ResourcesConsumed resources_consumed = 13 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Statistics on completed and failed prediction instances. - CompletionStats completion_stats = 14 [(google.api.field_behavior) = OUTPUT_ONLY]; + CompletionStats completion_stats = 14 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Time when the BatchPredictionJob was created. - google.protobuf.Timestamp create_time = 15 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 15 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. Time when the BatchPredictionJob for the first time entered the - // `JOB_STATE_RUNNING` state. - google.protobuf.Timestamp start_time = 16 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. Time when the BatchPredictionJob for the first time entered + // the `JOB_STATE_RUNNING` state. + google.protobuf.Timestamp start_time = 16 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. Time when the BatchPredictionJob entered any of the following states: - // `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`. - google.protobuf.Timestamp end_time = 17 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. Time when the BatchPredictionJob entered any of the following + // states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`. + google.protobuf.Timestamp end_time = 17 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Time when the BatchPredictionJob was most recently updated. - google.protobuf.Timestamp update_time = 18 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 18 + [(google.api.field_behavior) = OUTPUT_ONLY]; // The labels with user-defined metadata to organize BatchPredictionJobs. // diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/completion_stats.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/completion_stats.proto index a1d7b3238b7..a098e914e28 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/completion_stats.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/completion_stats.proto @@ -35,14 +35,16 @@ message CompletionStats { // Output only. The number of entities for which any error was encountered. int64 failed_count = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. In cases when enough errors are encountered a job, pipeline, or operation - // may be failed as a whole. Below is the number of entities for which the - // processing had not been finished (either in successful or failed state). - // Set to -1 if the number is unknown (for example, the operation failed - // before the total entity number could be collected). + // Output only. In cases when enough errors are encountered a job, pipeline, + // or operation may be failed as a whole. Below is the number of entities for + // which the processing had not been finished (either in successful or failed + // state). Set to -1 if the number is unknown (for example, the operation + // failed before the total entity number could be collected). int64 incomplete_count = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. The number of the successful forecast points that are generated by the - // forecasting model. This is ONLY used by the forecasting batch prediction. - int64 successful_forecast_point_count = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. The number of the successful forecast points that are + // generated by the forecasting model. This is ONLY used by the forecasting + // batch prediction. + int64 successful_forecast_point_count = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/context.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/context.proto index b602a55044e..fcf423e5540 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/context.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/context.proto @@ -57,13 +57,15 @@ message Context { map labels = 9; // Output only. Timestamp when this Context was created. - google.protobuf.Timestamp create_time = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 10 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this Context was last updated. - google.protobuf.Timestamp update_time = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 11 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. A list of resource names of Contexts that are parents of this Context. - // A Context may have at most 10 parent_contexts. + // Output only. A list of resource names of Contexts that are parents of this + // Context. A Context may have at most 10 parent_contexts. repeated string parent_contexts = 12 [ (google.api.field_behavior) = OUTPUT_ONLY, (google.api.resource_reference) = { @@ -86,6 +88,7 @@ message Context { string schema_version = 14; // Properties of the Context. + // Top level metadata keys' heading and trailing spaces will be trimmed. // The size of this field should not exceed 200KB. google.protobuf.Struct metadata = 15; diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/custom_job.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/custom_job.proto index af3de68b773..4c372da1b10 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/custom_job.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/custom_job.proto @@ -49,7 +49,7 @@ message CustomJob { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. The display name of the CustomJob. - // The name can be up to 128 characters long and can be consist of any UTF-8 + // The name can be up to 128 characters long and can consist of any UTF-8 // characters. string display_name = 2 [(google.api.field_behavior) = REQUIRED]; @@ -60,18 +60,22 @@ message CustomJob { JobState state = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Time when the CustomJob was created. - google.protobuf.Timestamp create_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 6 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Time when the CustomJob for the first time entered the // `JOB_STATE_RUNNING` state. - google.protobuf.Timestamp start_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp start_time = 7 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Time when the CustomJob entered any of the following states: // `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`. - google.protobuf.Timestamp end_time = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp end_time = 8 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Time when the CustomJob was most recently updated. - google.protobuf.Timestamp update_time = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 9 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Only populated when job's state is `JOB_STATE_FAILED` or // `JOB_STATE_CANCELLED`. @@ -94,7 +98,8 @@ message CustomJob { // Output only. URIs for accessing [interactive // shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) // (one URI for each training node). Only available if - // [job_spec.enable_web_access][google.cloud.aiplatform.v1.CustomJobSpec.enable_web_access] is `true`. + // [job_spec.enable_web_access][google.cloud.aiplatform.v1.CustomJobSpec.enable_web_access] + // is `true`. // // The keys are names of each node in the training job; for example, // `workerpool0-0` for the primary node, `workerpool1-0` for the first node in @@ -102,15 +107,17 @@ message CustomJob { // second worker pool. // // The values are the URIs for each node's interactive shell. - map web_access_uris = 16 [(google.api.field_behavior) = OUTPUT_ONLY]; + map web_access_uris = 16 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // Represents the spec of a CustomJob. message CustomJobSpec { - // Required. The spec of the worker pools including machine type and Docker image. - // All worker pools except the first one are optional and can be skipped by - // providing an empty value. - repeated WorkerPoolSpec worker_pool_specs = 1 [(google.api.field_behavior) = REQUIRED]; + // Required. The spec of the worker pools including machine type and Docker + // image. All worker pools except the first one are optional and can be + // skipped by providing an empty value. + repeated WorkerPoolSpec worker_pool_specs = 1 + [(google.api.field_behavior) = REQUIRED]; // Scheduling options for a CustomJob. Scheduling scheduling = 3; @@ -137,9 +144,7 @@ message CustomJobSpec { // If this field is left unspecified, the job is not peered with any network. string network = 5 [ (google.api.field_behavior) = OPTIONAL, - (google.api.resource_reference) = { - type: "compute.googleapis.com/Network" - } + (google.api.resource_reference) = { type: "compute.googleapis.com/Network" } ]; // Optional. A list of names for the reserved ip ranges under the VPC network @@ -150,14 +155,15 @@ message CustomJobSpec { // network. // // Example: ['vertex-ai-ip-range']. - repeated string reserved_ip_ranges = 13 [(google.api.field_behavior) = OPTIONAL]; + repeated string reserved_ip_ranges = 13 + [(google.api.field_behavior) = OPTIONAL]; // The Cloud Storage location to store the output of this CustomJob or // HyperparameterTuningJob. For HyperparameterTuningJob, // the baseOutputDirectory of // each child CustomJob backing a Trial is set to a subdirectory of name - // [id][google.cloud.aiplatform.v1.Trial.id] under its parent HyperparameterTuningJob's - // baseOutputDirectory. + // [id][google.cloud.aiplatform.v1.Trial.id] under its parent + // HyperparameterTuningJob's baseOutputDirectory. // // The following Vertex AI environment variables will be passed to // containers or python modules when this field is set: @@ -175,9 +181,9 @@ message CustomJobSpec { // * AIP_TENSORBOARD_LOG_DIR = `//logs/` GcsDestination base_output_directory = 6; - // Optional. The name of a Vertex AI [Tensorboard][google.cloud.aiplatform.v1.Tensorboard] resource to which this CustomJob - // will upload Tensorboard logs. - // Format: + // Optional. The name of a Vertex AI + // [Tensorboard][google.cloud.aiplatform.v1.Tensorboard] resource to which + // this CustomJob will upload Tensorboard logs. Format: // `projects/{project}/locations/{location}/tensorboards/{tensorboard}` string tensorboard = 7 [ (google.api.field_behavior) = OPTIONAL, @@ -191,9 +197,25 @@ message CustomJobSpec { // to training containers. // // If set to `true`, you can access interactive shells at the URIs given - // by [CustomJob.web_access_uris][google.cloud.aiplatform.v1.CustomJob.web_access_uris] or [Trial.web_access_uris][google.cloud.aiplatform.v1.Trial.web_access_uris] (within + // by + // [CustomJob.web_access_uris][google.cloud.aiplatform.v1.CustomJob.web_access_uris] + // or + // [Trial.web_access_uris][google.cloud.aiplatform.v1.Trial.web_access_uris] + // (within // [HyperparameterTuningJob.trials][google.cloud.aiplatform.v1.HyperparameterTuningJob.trials]). bool enable_web_access = 10 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Whether you want Vertex AI to enable access to the customized + // dashboard in training chief container. + // + // If set to `true`, you can access the dashboard at the URIs given + // by + // [CustomJob.web_access_uris][google.cloud.aiplatform.v1.CustomJob.web_access_uris] + // or + // [Trial.web_access_uris][google.cloud.aiplatform.v1.Trial.web_access_uris] + // (within + // [HyperparameterTuningJob.trials][google.cloud.aiplatform.v1.HyperparameterTuningJob.trials]). + bool enable_dashboard_access = 16 [(google.api.field_behavior) = OPTIONAL]; } // Represents the spec of a worker pool in a job. @@ -225,8 +247,8 @@ message WorkerPoolSpec { // The spec of a Container. message ContainerSpec { - // Required. The URI of a container image in the Container Registry that is to be run on - // each worker replica. + // Required. The URI of a container image in the Container Registry that is to + // be run on each worker replica. string image_uri = 1 [(google.api.field_behavior) = REQUIRED]; // The command to be invoked when the container is started. @@ -243,17 +265,17 @@ message ContainerSpec { // The spec of a Python packaged code. message PythonPackageSpec { - // Required. The URI of a container image in Artifact Registry that will run the - // provided Python package. Vertex AI provides a wide range of executor + // Required. The URI of a container image in Artifact Registry that will run + // the provided Python package. Vertex AI provides a wide range of executor // images with pre-installed packages to meet users' various use cases. See // the list of [pre-built containers for // training](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). // You must use an image from this list. string executor_image_uri = 1 [(google.api.field_behavior) = REQUIRED]; - // Required. The Google Cloud Storage location of the Python package files which are - // the training program and its dependent packages. - // The maximum number of package URIs is 100. + // Required. The Google Cloud Storage location of the Python package files + // which are the training program and its dependent packages. The maximum + // number of package URIs is 100. repeated string package_uris = 2 [(google.api.field_behavior) = REQUIRED]; // Required. The Python module name to run after installing the packages. diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/data_item.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/data_item.proto index 10431e74396..ef2117c6445 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/data_item.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/data_item.proto @@ -41,10 +41,12 @@ message DataItem { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this DataItem was created. - google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 2 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this DataItem was last updated. - google.protobuf.Timestamp update_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 6 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Optional. The labels with user-defined metadata to organize your DataItems. // @@ -59,12 +61,13 @@ message DataItem { // and are immutable. map labels = 3 [(google.api.field_behavior) = OPTIONAL]; - // Required. The data that the DataItem represents (for example, an image or a text - // snippet). The schema of the payload is stored in the parent Dataset's - // [metadata schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri] dataItemSchemaUri field. + // Required. The data that the DataItem represents (for example, an image or a + // text snippet). The schema of the payload is stored in the parent Dataset's + // [metadata schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri] + // dataItemSchemaUri field. google.protobuf.Value payload = 4 [(google.api.field_behavior) = REQUIRED]; - // Optional. Used to perform consistent read-modify-write updates. If not set, a blind - // "overwrite" update happens. + // Optional. Used to perform consistent read-modify-write updates. If not set, + // a blind "overwrite" update happens. string etag = 7 [(google.api.field_behavior) = OPTIONAL]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/data_labeling_job.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/data_labeling_job.proto index f136190ba3e..58c328fb13a 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/data_labeling_job.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/data_labeling_job.proto @@ -45,14 +45,13 @@ message DataLabelingJob { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. The user-defined name of the DataLabelingJob. - // The name can be up to 128 characters long and can be consist of any UTF-8 + // The name can be up to 128 characters long and can consist of any UTF-8 // characters. // Display name of a DataLabelingJob. string display_name = 2 [(google.api.field_behavior) = REQUIRED]; - // Required. Dataset resource names. Right now we only support labeling from a single - // Dataset. - // Format: + // Required. Dataset resource names. Right now we only support labeling from a + // single Dataset. Format: // `projects/{project}/locations/{location}/datasets/{dataset}` repeated string datasets = 3 [ (google.api.field_behavior) = REQUIRED, @@ -74,14 +73,14 @@ message DataLabelingJob { // Required. Number of labelers to work on each DataItem. int32 labeler_count = 4 [(google.api.field_behavior) = REQUIRED]; - // Required. The Google Cloud Storage location of the instruction pdf. This pdf is - // shared with labelers, and provides detailed description on how to label - // DataItems in Datasets. + // Required. The Google Cloud Storage location of the instruction pdf. This + // pdf is shared with labelers, and provides detailed description on how to + // label DataItems in Datasets. string instruction_uri = 5 [(google.api.field_behavior) = REQUIRED]; - // Required. Points to a YAML file stored on Google Cloud Storage describing the - // config for a specific type of DataLabelingJob. - // The schema files that can be used here are found in the + // Required. Points to a YAML file stored on Google Cloud Storage describing + // the config for a specific type of DataLabelingJob. The schema files that + // can be used here are found in the // https://storage.googleapis.com/google-cloud-aiplatform bucket in the // /schema/datalabelingjob/inputs/ folder. string inputs_schema_uri = 6 [(google.api.field_behavior) = REQUIRED]; @@ -92,22 +91,25 @@ message DataLabelingJob { // Output only. The detailed state of the job. JobState state = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. Current labeling job progress percentage scaled in interval [0, 100], - // indicating the percentage of DataItems that has been finished. + // Output only. Current labeling job progress percentage scaled in interval + // [0, 100], indicating the percentage of DataItems that has been finished. int32 labeling_progress = 13 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. Estimated cost(in US dollars) that the DataLabelingJob has incurred to - // date. - google.type.Money current_spend = 14 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. Estimated cost(in US dollars) that the DataLabelingJob has + // incurred to date. + google.type.Money current_spend = 14 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this DataLabelingJob was created. - google.protobuf.Timestamp create_time = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 9 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this DataLabelingJob was updated most recently. - google.protobuf.Timestamp update_time = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 10 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. DataLabelingJob errors. It is only populated when job's state is - // `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`. + // Output only. DataLabelingJob errors. It is only populated when job's state + // is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`. google.rpc.Status error = 22 [(google.api.field_behavior) = OUTPUT_ONLY]; // The labels with user-defined metadata to organize your DataLabelingJobs. @@ -121,7 +123,8 @@ message DataLabelingJob { // and are immutable. Following system labels exist for each DataLabelingJob: // // * "aiplatform.googleapis.com/schema": output only, its value is the - // [inputs_schema][google.cloud.aiplatform.v1.DataLabelingJob.inputs_schema_uri]'s title. + // [inputs_schema][google.cloud.aiplatform.v1.DataLabelingJob.inputs_schema_uri]'s + // title. map labels = 11; // The SpecialistPools' resource names associated with this job. diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/dataset.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/dataset.proto index 6c686986a2c..25fbbc31341 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/dataset.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/dataset.proto @@ -20,6 +20,7 @@ import "google/api/field_behavior.proto"; import "google/api/resource.proto"; import "google/cloud/aiplatform/v1/encryption_spec.proto"; import "google/cloud/aiplatform/v1/io.proto"; +import "google/cloud/aiplatform/v1/saved_query.proto"; import "google/protobuf/struct.proto"; import "google/protobuf/timestamp.proto"; @@ -42,28 +43,29 @@ message Dataset { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. The user-defined name of the Dataset. - // The name can be up to 128 characters long and can be consist of any UTF-8 + // The name can be up to 128 characters long and can consist of any UTF-8 // characters. string display_name = 2 [(google.api.field_behavior) = REQUIRED]; - // Optional. The description of the Dataset. - string description = 16 [(google.api.field_behavior) = OPTIONAL]; + // The description of the Dataset. + string description = 16; - // Required. Points to a YAML file stored on Google Cloud Storage describing additional - // information about the Dataset. - // The schema is defined as an OpenAPI 3.0.2 Schema Object. - // The schema files that can be used here are found in - // gs://google-cloud-aiplatform/schema/dataset/metadata/. + // Required. Points to a YAML file stored on Google Cloud Storage describing + // additional information about the Dataset. The schema is defined as an + // OpenAPI 3.0.2 Schema Object. The schema files that can be used here are + // found in gs://google-cloud-aiplatform/schema/dataset/metadata/. string metadata_schema_uri = 3 [(google.api.field_behavior) = REQUIRED]; // Required. Additional information about the Dataset. google.protobuf.Value metadata = 8 [(google.api.field_behavior) = REQUIRED]; // Output only. Timestamp when this Dataset was created. - google.protobuf.Timestamp create_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this Dataset was last updated. - google.protobuf.Timestamp update_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Used to perform consistent read-modify-write updates. If not set, a blind // "overwrite" update happens. @@ -82,12 +84,29 @@ message Dataset { // and are immutable. Following system labels exist for each Dataset: // // * "aiplatform.googleapis.com/dataset_metadata_schema": output only, its - // value is the [metadata_schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri] title. + // value is the + // [metadata_schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri] + // title. map labels = 7; + // All SavedQueries belong to the Dataset will be returned in List/Get + // Dataset response. The [annotation_specs][SavedQuery.annotation_specs] field + // will not be populated except for UI cases which will only use + // [annotation_spec_count][google.cloud.aiplatform.v1.SavedQuery.annotation_spec_count]. + // In CreateDataset request, a SavedQuery is created together if + // this field is set, up to one SavedQuery can be set in CreateDatasetRequest. + // The SavedQuery should not contain any AnnotationSpec. + repeated SavedQuery saved_queries = 9; + // Customer-managed encryption key spec for a Dataset. If set, this Dataset // and all sub-resources of this Dataset will be secured by this key. EncryptionSpec encryption_spec = 11; + + // Output only. The resource name of the Artifact that was created in + // MetadataStore when creating the Dataset. The Artifact resource name pattern + // is + // `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. + string metadata_artifact = 17 [(google.api.field_behavior) = OUTPUT_ONLY]; } // Describes the location from where we import data into a Dataset, together @@ -109,12 +128,26 @@ message ImportDataConfig { // considered identical if their content bytes are identical (e.g. image bytes // or pdf bytes). // These labels will be overridden by Annotation labels specified inside index - // file referenced by [import_schema_uri][google.cloud.aiplatform.v1.ImportDataConfig.import_schema_uri], e.g. jsonl file. + // file referenced by + // [import_schema_uri][google.cloud.aiplatform.v1.ImportDataConfig.import_schema_uri], + // e.g. jsonl file. map data_item_labels = 2; - // Required. Points to a YAML file stored on Google Cloud Storage describing the import - // format. Validation will be done against the schema. The schema is defined - // as an [OpenAPI 3.0.2 Schema + // Labels that will be applied to newly imported Annotations. If two + // Annotations are identical, one of them will be deduped. Two Annotations are + // considered identical if their + // [payload][google.cloud.aiplatform.v1.Annotation.payload], + // [payload_schema_uri][google.cloud.aiplatform.v1.Annotation.payload_schema_uri] + // and all of their [labels][google.cloud.aiplatform.v1.Annotation.labels] are + // the same. These labels will be overridden by Annotation labels specified + // inside index file referenced by + // [import_schema_uri][google.cloud.aiplatform.v1.ImportDataConfig.import_schema_uri], + // e.g. jsonl file. + map annotation_labels = 3; + + // Required. Points to a YAML file stored on Google Cloud Storage describing + // the import format. Validation will be done against the schema. The schema + // is defined as an [OpenAPI 3.0.2 Schema // Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). string import_schema_uri = 4 [(google.api.field_behavior) = REQUIRED]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/dataset_service.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/dataset_service.proto index c26f60e331e..f6e7ba9238c 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/dataset_service.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/dataset_service.proto @@ -41,10 +41,12 @@ option ruby_package = "Google::Cloud::AIPlatform::V1"; // resources. service DatasetService { option (google.api.default_host) = "aiplatform.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/cloud-platform"; // Creates a Dataset. - rpc CreateDataset(CreateDatasetRequest) returns (google.longrunning.Operation) { + rpc CreateDataset(CreateDatasetRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{parent=projects/*/locations/*}/datasets" body: "dataset" @@ -82,7 +84,8 @@ service DatasetService { } // Deletes a Dataset. - rpc DeleteDataset(DeleteDatasetRequest) returns (google.longrunning.Operation) { + rpc DeleteDataset(DeleteDatasetRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1/{name=projects/*/locations/*/datasets/*}" }; @@ -127,8 +130,17 @@ service DatasetService { option (google.api.method_signature) = "parent"; } + // Searches DataItems in a Dataset. + rpc SearchDataItems(SearchDataItemsRequest) + returns (SearchDataItemsResponse) { + option (google.api.http) = { + get: "/v1/{dataset=projects/*/locations/*/datasets/*}:searchDataItems" + }; + } + // Lists SavedQueries in a Dataset. - rpc ListSavedQueries(ListSavedQueriesRequest) returns (ListSavedQueriesResponse) { + rpc ListSavedQueries(ListSavedQueriesRequest) + returns (ListSavedQueriesResponse) { option (google.api.http) = { get: "/v1/{parent=projects/*/locations/*/datasets/*}/savedQueries" }; @@ -144,7 +156,8 @@ service DatasetService { } // Lists Annotations belongs to a dataitem - rpc ListAnnotations(ListAnnotationsRequest) returns (ListAnnotationsResponse) { + rpc ListAnnotations(ListAnnotationsRequest) + returns (ListAnnotationsResponse) { option (google.api.http) = { get: "/v1/{parent=projects/*/locations/*/datasets/*/dataItems/*}/annotations" }; @@ -152,7 +165,8 @@ service DatasetService { } } -// Request message for [DatasetService.CreateDataset][google.cloud.aiplatform.v1.DatasetService.CreateDataset]. +// Request message for +// [DatasetService.CreateDataset][google.cloud.aiplatform.v1.DatasetService.CreateDataset]. message CreateDatasetRequest { // Required. The resource name of the Location to create the Dataset in. // Format: `projects/{project}/locations/{location}` @@ -167,13 +181,15 @@ message CreateDatasetRequest { Dataset dataset = 2 [(google.api.field_behavior) = REQUIRED]; } -// Runtime operation information for [DatasetService.CreateDataset][google.cloud.aiplatform.v1.DatasetService.CreateDataset]. +// Runtime operation information for +// [DatasetService.CreateDataset][google.cloud.aiplatform.v1.DatasetService.CreateDataset]. message CreateDatasetOperationMetadata { // The operation generic information. GenericOperationMetadata generic_metadata = 1; } -// Request message for [DatasetService.GetDataset][google.cloud.aiplatform.v1.DatasetService.GetDataset]. +// Request message for +// [DatasetService.GetDataset][google.cloud.aiplatform.v1.DatasetService.GetDataset]. message GetDatasetRequest { // Required. The name of the Dataset resource. string name = 1 [ @@ -187,22 +203,25 @@ message GetDatasetRequest { google.protobuf.FieldMask read_mask = 2; } -// Request message for [DatasetService.UpdateDataset][google.cloud.aiplatform.v1.DatasetService.UpdateDataset]. +// Request message for +// [DatasetService.UpdateDataset][google.cloud.aiplatform.v1.DatasetService.UpdateDataset]. message UpdateDatasetRequest { // Required. The Dataset which replaces the resource on the server. Dataset dataset = 1 [(google.api.field_behavior) = REQUIRED]; // Required. The update mask applies to the resource. - // For the `FieldMask` definition, see [google.protobuf.FieldMask][google.protobuf.FieldMask]. - // Updatable fields: + // For the `FieldMask` definition, see + // [google.protobuf.FieldMask][google.protobuf.FieldMask]. Updatable fields: // // * `display_name` // * `description` // * `labels` - google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.FieldMask update_mask = 2 + [(google.api.field_behavior) = REQUIRED]; } -// Request message for [DatasetService.ListDatasets][google.cloud.aiplatform.v1.DatasetService.ListDatasets]. +// Request message for +// [DatasetService.ListDatasets][google.cloud.aiplatform.v1.DatasetService.ListDatasets]. message ListDatasetsRequest { // Required. The name of the Dataset's parent resource. // Format: `projects/{project}/locations/{location}` @@ -248,7 +267,8 @@ message ListDatasetsRequest { string order_by = 6; } -// Response message for [DatasetService.ListDatasets][google.cloud.aiplatform.v1.DatasetService.ListDatasets]. +// Response message for +// [DatasetService.ListDatasets][google.cloud.aiplatform.v1.DatasetService.ListDatasets]. message ListDatasetsResponse { // A list of Datasets that matches the specified filter in the request. repeated Dataset datasets = 1; @@ -257,7 +277,8 @@ message ListDatasetsResponse { string next_page_token = 2; } -// Request message for [DatasetService.DeleteDataset][google.cloud.aiplatform.v1.DatasetService.DeleteDataset]. +// Request message for +// [DatasetService.DeleteDataset][google.cloud.aiplatform.v1.DatasetService.DeleteDataset]. message DeleteDatasetRequest { // Required. The resource name of the Dataset to delete. // Format: @@ -270,7 +291,8 @@ message DeleteDatasetRequest { ]; } -// Request message for [DatasetService.ImportData][google.cloud.aiplatform.v1.DatasetService.ImportData]. +// Request message for +// [DatasetService.ImportData][google.cloud.aiplatform.v1.DatasetService.ImportData]. message ImportDataRequest { // Required. The name of the Dataset resource. // Format: @@ -282,23 +304,25 @@ message ImportDataRequest { } ]; - // Required. The desired input locations. The contents of all input locations will be - // imported in one batch. - repeated ImportDataConfig import_configs = 2 [(google.api.field_behavior) = REQUIRED]; + // Required. The desired input locations. The contents of all input locations + // will be imported in one batch. + repeated ImportDataConfig import_configs = 2 + [(google.api.field_behavior) = REQUIRED]; } -// Response message for [DatasetService.ImportData][google.cloud.aiplatform.v1.DatasetService.ImportData]. -message ImportDataResponse { - -} +// Response message for +// [DatasetService.ImportData][google.cloud.aiplatform.v1.DatasetService.ImportData]. +message ImportDataResponse {} -// Runtime operation information for [DatasetService.ImportData][google.cloud.aiplatform.v1.DatasetService.ImportData]. +// Runtime operation information for +// [DatasetService.ImportData][google.cloud.aiplatform.v1.DatasetService.ImportData]. message ImportDataOperationMetadata { // The common part of the operation metadata. GenericOperationMetadata generic_metadata = 1; } -// Request message for [DatasetService.ExportData][google.cloud.aiplatform.v1.DatasetService.ExportData]. +// Request message for +// [DatasetService.ExportData][google.cloud.aiplatform.v1.DatasetService.ExportData]. message ExportDataRequest { // Required. The name of the Dataset resource. // Format: @@ -314,13 +338,15 @@ message ExportDataRequest { ExportDataConfig export_config = 2 [(google.api.field_behavior) = REQUIRED]; } -// Response message for [DatasetService.ExportData][google.cloud.aiplatform.v1.DatasetService.ExportData]. +// Response message for +// [DatasetService.ExportData][google.cloud.aiplatform.v1.DatasetService.ExportData]. message ExportDataResponse { // All of the files that are exported in this export operation. repeated string exported_files = 1; } -// Runtime operation information for [DatasetService.ExportData][google.cloud.aiplatform.v1.DatasetService.ExportData]. +// Runtime operation information for +// [DatasetService.ExportData][google.cloud.aiplatform.v1.DatasetService.ExportData]. message ExportDataOperationMetadata { // The common part of the operation metadata. GenericOperationMetadata generic_metadata = 1; @@ -330,7 +356,8 @@ message ExportDataOperationMetadata { string gcs_output_directory = 2; } -// Request message for [DatasetService.ListDataItems][google.cloud.aiplatform.v1.DatasetService.ListDataItems]. +// Request message for +// [DatasetService.ListDataItems][google.cloud.aiplatform.v1.DatasetService.ListDataItems]. message ListDataItemsRequest { // Required. The resource name of the Dataset to list DataItems from. // Format: @@ -359,7 +386,8 @@ message ListDataItemsRequest { string order_by = 6; } -// Response message for [DatasetService.ListDataItems][google.cloud.aiplatform.v1.DatasetService.ListDataItems]. +// Response message for +// [DatasetService.ListDataItems][google.cloud.aiplatform.v1.DatasetService.ListDataItems]. message ListDataItemsResponse { // A list of DataItems that matches the specified filter in the request. repeated DataItem data_items = 1; @@ -368,7 +396,144 @@ message ListDataItemsResponse { string next_page_token = 2; } -// Request message for [DatasetService.ListSavedQueries][google.cloud.aiplatform.v1.DatasetService.ListSavedQueries]. +// Request message for +// [DatasetService.SearchDataItems][google.cloud.aiplatform.v1.DatasetService.SearchDataItems]. +message SearchDataItemsRequest { + // Expression that allows ranking results based on annotation's property. + message OrderByAnnotation { + // Required. Saved query of the Annotation. Only Annotations belong to this + // saved query will be considered for ordering. + string saved_query = 1 [(google.api.field_behavior) = REQUIRED]; + + // A comma-separated list of annotation fields to order by, sorted in + // ascending order. Use "desc" after a field name for descending. Must also + // specify saved_query. + string order_by = 2; + } + + oneof order { + // A comma-separated list of data item fields to order by, sorted in + // ascending order. Use "desc" after a field name for descending. + string order_by_data_item = 12; + + // Expression that allows ranking results based on annotation's property. + OrderByAnnotation order_by_annotation = 13; + } + + // Required. The resource name of the Dataset from which to search DataItems. + // Format: + // `projects/{project}/locations/{location}/datasets/{dataset}` + string dataset = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "aiplatform.googleapis.com/Dataset" + } + ]; + + // The resource name of a SavedQuery(annotation set in UI). + // Format: + // `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}` + // All of the search will be done in the context of this SavedQuery. + string saved_query = 2 [ + deprecated = true, + (google.api.resource_reference) = { + type: "aiplatform.googleapis.com/SavedQuery" + } + ]; + + // The resource name of a DataLabelingJob. + // Format: + // `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` + // If this field is set, all of the search will be done in the context of + // this DataLabelingJob. + string data_labeling_job = 3; + + // An expression for filtering the DataItem that will be returned. + // + // * `data_item_id` - for = or !=. + // * `labeled` - for = or !=. + // * `has_annotation(ANNOTATION_SPEC_ID)` - true only for DataItem that + // have at least one annotation with annotation_spec_id = + // `ANNOTATION_SPEC_ID` in the context of SavedQuery or DataLabelingJob. + // + // For example: + // + // * `data_item=1` + // * `has_annotation(5)` + string data_item_filter = 4; + + // An expression for filtering the Annotations that will be returned per + // DataItem. + // * `annotation_spec_id` - for = or !=. + string annotations_filter = 5 [deprecated = true]; + + // An expression that specifies what Annotations will be returned per + // DataItem. Annotations satisfied either of the conditions will be returned. + // * `annotation_spec_id` - for = or !=. + // Must specify `saved_query_id=` - saved query id that annotations should + // belong to. + repeated string annotation_filters = 11; + + // Mask specifying which fields of + // [DataItemView][google.cloud.aiplatform.v1.DataItemView] to read. + google.protobuf.FieldMask field_mask = 6; + + // If set, only up to this many of Annotations will be returned per + // DataItemView. The maximum value is 1000. If not set, the maximum value will + // be used. + int32 annotations_limit = 7; + + // Requested page size. Server may return fewer results than requested. + // Default and maximum page size is 100. + int32 page_size = 8; + + // A comma-separated list of fields to order by, sorted in ascending order. + // Use "desc" after a field name for descending. + string order_by = 9 [deprecated = true]; + + // A token identifying a page of results for the server to return + // Typically obtained via + // [SearchDataItemsResponse.next_page_token][google.cloud.aiplatform.v1.SearchDataItemsResponse.next_page_token] + // of the previous + // [DatasetService.SearchDataItems][google.cloud.aiplatform.v1.DatasetService.SearchDataItems] + // call. + string page_token = 10; +} + +// Response message for +// [DatasetService.SearchDataItems][google.cloud.aiplatform.v1.DatasetService.SearchDataItems]. +message SearchDataItemsResponse { + // The DataItemViews read. + repeated DataItemView data_item_views = 1; + + // A token to retrieve next page of results. + // Pass to + // [SearchDataItemsRequest.page_token][google.cloud.aiplatform.v1.SearchDataItemsRequest.page_token] + // to obtain that page. + string next_page_token = 2; +} + +// A container for a single DataItem and Annotations on it. +message DataItemView { + // The DataItem. + DataItem data_item = 1; + + // The Annotations on the DataItem. If too many Annotations should be returned + // for the DataItem, this field will be truncated per annotations_limit in + // request. If it was, then the has_truncated_annotations will be set to true. + repeated Annotation annotations = 2; + + // True if and only if the Annotations field has been truncated. It happens if + // more Annotations for this DataItem met the request's annotation_filter than + // are allowed to be returned by annotations_limit. + // Note that if Annotations field is not being returned due to field mask, + // then this field will not be set to true no matter how many Annotations are + // there. + bool has_truncated_annotations = 3; +} + +// Request message for +// [DatasetService.ListSavedQueries][google.cloud.aiplatform.v1.DatasetService.ListSavedQueries]. message ListSavedQueriesRequest { // Required. The resource name of the Dataset to list SavedQueries from. // Format: @@ -397,7 +562,8 @@ message ListSavedQueriesRequest { string order_by = 6; } -// Response message for [DatasetService.ListSavedQueries][google.cloud.aiplatform.v1.DatasetService.ListSavedQueries]. +// Response message for +// [DatasetService.ListSavedQueries][google.cloud.aiplatform.v1.DatasetService.ListSavedQueries]. message ListSavedQueriesResponse { // A list of SavedQueries that match the specified filter in the request. repeated SavedQuery saved_queries = 1; @@ -406,7 +572,8 @@ message ListSavedQueriesResponse { string next_page_token = 2; } -// Request message for [DatasetService.GetAnnotationSpec][google.cloud.aiplatform.v1.DatasetService.GetAnnotationSpec]. +// Request message for +// [DatasetService.GetAnnotationSpec][google.cloud.aiplatform.v1.DatasetService.GetAnnotationSpec]. message GetAnnotationSpecRequest { // Required. The name of the AnnotationSpec resource. // Format: @@ -422,7 +589,8 @@ message GetAnnotationSpecRequest { google.protobuf.FieldMask read_mask = 2; } -// Request message for [DatasetService.ListAnnotations][google.cloud.aiplatform.v1.DatasetService.ListAnnotations]. +// Request message for +// [DatasetService.ListAnnotations][google.cloud.aiplatform.v1.DatasetService.ListAnnotations]. message ListAnnotationsRequest { // Required. The resource name of the DataItem to list Annotations from. // Format: @@ -451,7 +619,8 @@ message ListAnnotationsRequest { string order_by = 6; } -// Response message for [DatasetService.ListAnnotations][google.cloud.aiplatform.v1.DatasetService.ListAnnotations]. +// Response message for +// [DatasetService.ListAnnotations][google.cloud.aiplatform.v1.DatasetService.ListAnnotations]. message ListAnnotationsResponse { // A list of Annotations that matches the specified filter in the request. repeated Annotation annotations = 1; diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/encryption_spec.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/encryption_spec.proto index 15a79901925..4eae114f07f 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/encryption_spec.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/encryption_spec.proto @@ -29,8 +29,8 @@ option ruby_package = "Google::Cloud::AIPlatform::V1"; // Represents a customer-managed encryption key spec that can be applied to // a top-level resource. message EncryptionSpec { - // Required. The Cloud KMS resource identifier of the customer managed encryption key - // used to protect a resource. Has the form: + // Required. The Cloud KMS resource identifier of the customer managed + // encryption key used to protect a resource. Has the form: // `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. // The key needs to be in the same region as where the compute resource is // created. diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/endpoint.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/endpoint.proto index 6d48f8f220c..6c1a23b8b93 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/endpoint.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/endpoint.proto @@ -44,7 +44,7 @@ message Endpoint { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. The display name of the Endpoint. - // The name can be up to 128 characters long and can be consist of any UTF-8 + // The name can be up to 128 characters long and can consist of any UTF-8 // characters. string display_name = 2 [(google.api.field_behavior) = REQUIRED]; @@ -52,9 +52,13 @@ message Endpoint { string description = 3; // Output only. The models deployed in this Endpoint. - // To add or remove DeployedModels use [EndpointService.DeployModel][google.cloud.aiplatform.v1.EndpointService.DeployModel] and - // [EndpointService.UndeployModel][google.cloud.aiplatform.v1.EndpointService.UndeployModel] respectively. - repeated DeployedModel deployed_models = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + // To add or remove DeployedModels use + // [EndpointService.DeployModel][google.cloud.aiplatform.v1.EndpointService.DeployModel] + // and + // [EndpointService.UndeployModel][google.cloud.aiplatform.v1.EndpointService.UndeployModel] + // respectively. + repeated DeployedModel deployed_models = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; // A map from a DeployedModel's ID to the percentage of this Endpoint's // traffic that should be forwarded to that DeployedModel. @@ -80,10 +84,12 @@ message Endpoint { map labels = 7; // Output only. Timestamp when this Endpoint was created. - google.protobuf.Timestamp create_time = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 8 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this Endpoint was last updated. - google.protobuf.Timestamp update_time = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 9 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Customer-managed encryption key spec for an Endpoint. If set, this // Endpoint and all sub-resources of this Endpoint will be secured by @@ -97,7 +103,8 @@ message Endpoint { // Private services access must already be configured for the network. If left // unspecified, the Endpoint is not peered with any network. // - // Only one of the fields, [network][google.cloud.aiplatform.v1.Endpoint.network] or + // Only one of the fields, + // [network][google.cloud.aiplatform.v1.Endpoint.network] or // [enable_private_service_connect][google.cloud.aiplatform.v1.Endpoint.enable_private_service_connect], // can be set. // @@ -105,20 +112,21 @@ message Endpoint { // `projects/{project}/global/networks/{network}`. // Where `{project}` is a project number, as in `12345`, and `{network}` is // network name. - string network = 13 [(google.api.resource_reference) = { - type: "compute.googleapis.com/Network" - }]; + string network = 13 [ + (google.api.resource_reference) = { type: "compute.googleapis.com/Network" } + ]; // Deprecated: If true, expose the Endpoint via private service connect. // - // Only one of the fields, [network][google.cloud.aiplatform.v1.Endpoint.network] or + // Only one of the fields, + // [network][google.cloud.aiplatform.v1.Endpoint.network] or // [enable_private_service_connect][google.cloud.aiplatform.v1.Endpoint.enable_private_service_connect], // can be set. bool enable_private_service_connect = 17 [deprecated = true]; - // Output only. Resource name of the Model Monitoring job associated with this Endpoint - // if monitoring is enabled by [CreateModelDeploymentMonitoringJob][]. - // Format: + // Output only. Resource name of the Model Monitoring job associated with this + // Endpoint if monitoring is enabled by + // [CreateModelDeploymentMonitoringJob][]. Format: // `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}` string model_deployment_monitoring_job = 14 [ (google.api.field_behavior) = OUTPUT_ONLY, @@ -128,7 +136,8 @@ message Endpoint { ]; // Configures the request-response logging for online prediction. - PredictRequestResponseLoggingConfig predict_request_response_logging_config = 18; + PredictRequestResponseLoggingConfig predict_request_response_logging_config = + 18; } // A deployment of a Model. Endpoints contain one or more DeployedModels. @@ -148,14 +157,15 @@ message DeployedModel { AutomaticResources automatic_resources = 8; } - // Immutable. The ID of the DeployedModel. If not provided upon deployment, Vertex AI - // will generate a value for this ID. + // Immutable. The ID of the DeployedModel. If not provided upon deployment, + // Vertex AI will generate a value for this ID. // // This value should be 1-10 characters, and valid characters are /[0-9]/. string id = 1 [(google.api.field_behavior) = IMMUTABLE]; - // Required. The resource name of the Model that this is the deployment of. Note that - // the Model may be in a different location than the DeployedModel's Endpoint. + // Required. The resource name of the Model that this is the deployment of. + // Note that the Model may be in a different location than the DeployedModel's + // Endpoint. // // The resource name may contain version id or version alias to specify the // version, if no version is specified, the default version will be deployed. @@ -174,17 +184,26 @@ message DeployedModel { string display_name = 3; // Output only. Timestamp when the DeployedModel was created. - google.protobuf.Timestamp create_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 6 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Explanation configuration for this DeployedModel. // - // When deploying a Model using [EndpointService.DeployModel][google.cloud.aiplatform.v1.EndpointService.DeployModel], this value - // overrides the value of [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec]. All fields of - // [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] are optional in the request. If a field of - // [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] is not populated, the value of the same field of - // [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec] is inherited. If the corresponding - // [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec] is not populated, all fields of the - // [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] will be used for the explanation configuration. + // When deploying a Model using + // [EndpointService.DeployModel][google.cloud.aiplatform.v1.EndpointService.DeployModel], + // this value overrides the value of + // [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec]. + // All fields of + // [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] + // are optional in the request. If a field of + // [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] + // is not populated, the value of the same field of + // [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec] + // is inherited. If the corresponding + // [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec] + // is not populated, all fields of the + // [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] + // will be used for the explanation configuration. ExplanationSpec explanation_spec = 9; // The service account that the DeployedModel's container runs as. Specify the @@ -213,10 +232,12 @@ message DeployedModel { // Estimate your costs before enabling this option. bool enable_access_logging = 13; - // Output only. Provide paths for users to send predict/explain/health requests directly to - // the deployed model services running on Cloud via private services access. - // This field is populated if [network][google.cloud.aiplatform.v1.Endpoint.network] is configured. - PrivateEndpoints private_endpoints = 14 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. Provide paths for users to send predict/explain/health + // requests directly to the deployed model services running on Cloud via + // private services access. This field is populated if + // [network][google.cloud.aiplatform.v1.Endpoint.network] is configured. + PrivateEndpoints private_endpoints = 14 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // PrivateEndpoints proto is used to provide paths for users to send @@ -234,8 +255,8 @@ message PrivateEndpoints { // Output only. Http(s) path to send health check requests. string health_http_uri = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. The name of the service attachment resource. Populated if private service - // connect is enabled. + // Output only. The name of the service attachment resource. Populated if + // private service connect is enabled. string service_attachment = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/endpoint_service.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/endpoint_service.proto index 0108728ccd3..324fd9204ec 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/endpoint_service.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/endpoint_service.proto @@ -36,10 +36,12 @@ option ruby_package = "Google::Cloud::AIPlatform::V1"; // A service for managing Vertex AI's Endpoints. service EndpointService { option (google.api.default_host) = "aiplatform.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/cloud-platform"; // Creates an Endpoint. - rpc CreateEndpoint(CreateEndpointRequest) returns (google.longrunning.Operation) { + rpc CreateEndpoint(CreateEndpointRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{parent=projects/*/locations/*}/endpoints" body: "endpoint" @@ -78,7 +80,8 @@ service EndpointService { } // Deletes an Endpoint. - rpc DeleteEndpoint(DeleteEndpointRequest) returns (google.longrunning.Operation) { + rpc DeleteEndpoint(DeleteEndpointRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1/{name=projects/*/locations/*/endpoints/*}" }; @@ -95,7 +98,8 @@ service EndpointService { post: "/v1/{endpoint=projects/*/locations/*/endpoints/*}:deployModel" body: "*" }; - option (google.api.method_signature) = "endpoint,deployed_model,traffic_split"; + option (google.api.method_signature) = + "endpoint,deployed_model,traffic_split"; option (google.longrunning.operation_info) = { response_type: "DeployModelResponse" metadata_type: "DeployModelOperationMetadata" @@ -104,12 +108,14 @@ service EndpointService { // Undeploys a Model from an Endpoint, removing a DeployedModel from it, and // freeing all resources it's using. - rpc UndeployModel(UndeployModelRequest) returns (google.longrunning.Operation) { + rpc UndeployModel(UndeployModelRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{endpoint=projects/*/locations/*/endpoints/*}:undeployModel" body: "*" }; - option (google.api.method_signature) = "endpoint,deployed_model_id,traffic_split"; + option (google.api.method_signature) = + "endpoint,deployed_model_id,traffic_split"; option (google.longrunning.operation_info) = { response_type: "UndeployModelResponse" metadata_type: "UndeployModelOperationMetadata" @@ -117,7 +123,8 @@ service EndpointService { } } -// Request message for [EndpointService.CreateEndpoint][google.cloud.aiplatform.v1.EndpointService.CreateEndpoint]. +// Request message for +// [EndpointService.CreateEndpoint][google.cloud.aiplatform.v1.EndpointService.CreateEndpoint]. message CreateEndpointRequest { // Required. The resource name of the Location to create the Endpoint in. // Format: `projects/{project}/locations/{location}` @@ -142,13 +149,15 @@ message CreateEndpointRequest { string endpoint_id = 4 [(google.api.field_behavior) = IMMUTABLE]; } -// Runtime operation information for [EndpointService.CreateEndpoint][google.cloud.aiplatform.v1.EndpointService.CreateEndpoint]. +// Runtime operation information for +// [EndpointService.CreateEndpoint][google.cloud.aiplatform.v1.EndpointService.CreateEndpoint]. message CreateEndpointOperationMetadata { // The operation generic information. GenericOperationMetadata generic_metadata = 1; } -// Request message for [EndpointService.GetEndpoint][google.cloud.aiplatform.v1.EndpointService.GetEndpoint] +// Request message for +// [EndpointService.GetEndpoint][google.cloud.aiplatform.v1.EndpointService.GetEndpoint] message GetEndpointRequest { // Required. The name of the Endpoint resource. // Format: @@ -161,10 +170,11 @@ message GetEndpointRequest { ]; } -// Request message for [EndpointService.ListEndpoints][google.cloud.aiplatform.v1.EndpointService.ListEndpoints]. +// Request message for +// [EndpointService.ListEndpoints][google.cloud.aiplatform.v1.EndpointService.ListEndpoints]. message ListEndpointsRequest { - // Required. The resource name of the Location from which to list the Endpoints. - // Format: `projects/{project}/locations/{location}` + // Required. The resource name of the Location from which to list the + // Endpoints. Format: `projects/{project}/locations/{location}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -172,11 +182,12 @@ message ListEndpointsRequest { } ]; - // Optional. An expression for filtering the results of the request. For field names - // both snake_case and camelCase are supported. + // Optional. An expression for filtering the results of the request. For field + // names both snake_case and camelCase are supported. // // * `endpoint` supports = and !=. `endpoint` represents the Endpoint ID, - // i.e. the last segment of the Endpoint's [resource name][google.cloud.aiplatform.v1.Endpoint.name]. + // i.e. the last segment of the Endpoint's [resource + // name][google.cloud.aiplatform.v1.Endpoint.name]. // * `display_name` supports = and, != // * `labels` supports general map functions that is: // * `labels.key=value` - key:value equality @@ -194,12 +205,15 @@ message ListEndpointsRequest { // Optional. The standard list page token. // Typically obtained via - // [ListEndpointsResponse.next_page_token][google.cloud.aiplatform.v1.ListEndpointsResponse.next_page_token] of the previous - // [EndpointService.ListEndpoints][google.cloud.aiplatform.v1.EndpointService.ListEndpoints] call. + // [ListEndpointsResponse.next_page_token][google.cloud.aiplatform.v1.ListEndpointsResponse.next_page_token] + // of the previous + // [EndpointService.ListEndpoints][google.cloud.aiplatform.v1.EndpointService.ListEndpoints] + // call. string page_token = 4 [(google.api.field_behavior) = OPTIONAL]; // Optional. Mask specifying which fields to read. - google.protobuf.FieldMask read_mask = 5 [(google.api.field_behavior) = OPTIONAL]; + google.protobuf.FieldMask read_mask = 5 + [(google.api.field_behavior) = OPTIONAL]; // A comma-separated list of fields to order by, sorted in ascending order. // Use "desc" after a field name for descending. @@ -212,26 +226,33 @@ message ListEndpointsRequest { string order_by = 6; } -// Response message for [EndpointService.ListEndpoints][google.cloud.aiplatform.v1.EndpointService.ListEndpoints]. +// Response message for +// [EndpointService.ListEndpoints][google.cloud.aiplatform.v1.EndpointService.ListEndpoints]. message ListEndpointsResponse { // List of Endpoints in the requested page. repeated Endpoint endpoints = 1; // A token to retrieve the next page of results. - // Pass to [ListEndpointsRequest.page_token][google.cloud.aiplatform.v1.ListEndpointsRequest.page_token] to obtain that page. + // Pass to + // [ListEndpointsRequest.page_token][google.cloud.aiplatform.v1.ListEndpointsRequest.page_token] + // to obtain that page. string next_page_token = 2; } -// Request message for [EndpointService.UpdateEndpoint][google.cloud.aiplatform.v1.EndpointService.UpdateEndpoint]. +// Request message for +// [EndpointService.UpdateEndpoint][google.cloud.aiplatform.v1.EndpointService.UpdateEndpoint]. message UpdateEndpointRequest { // Required. The Endpoint which replaces the resource on the server. Endpoint endpoint = 1 [(google.api.field_behavior) = REQUIRED]; - // Required. The update mask applies to the resource. See [google.protobuf.FieldMask][google.protobuf.FieldMask]. - google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED]; + // Required. The update mask applies to the resource. See + // [google.protobuf.FieldMask][google.protobuf.FieldMask]. + google.protobuf.FieldMask update_mask = 2 + [(google.api.field_behavior) = REQUIRED]; } -// Request message for [EndpointService.DeleteEndpoint][google.cloud.aiplatform.v1.EndpointService.DeleteEndpoint]. +// Request message for +// [EndpointService.DeleteEndpoint][google.cloud.aiplatform.v1.EndpointService.DeleteEndpoint]. message DeleteEndpointRequest { // Required. The name of the Endpoint resource to be deleted. // Format: @@ -244,7 +265,8 @@ message DeleteEndpointRequest { ]; } -// Request message for [EndpointService.DeployModel][google.cloud.aiplatform.v1.EndpointService.DeployModel]. +// Request message for +// [EndpointService.DeployModel][google.cloud.aiplatform.v1.EndpointService.DeployModel]. message DeployModelRequest { // Required. The name of the Endpoint resource into which to deploy a Model. // Format: @@ -257,8 +279,9 @@ message DeployModelRequest { ]; // Required. The DeployedModel to be created within the Endpoint. Note that - // [Endpoint.traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split] must be updated for the DeployedModel to start - // receiving traffic, either as part of this call, or via + // [Endpoint.traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split] + // must be updated for the DeployedModel to start receiving traffic, either as + // part of this call, or via // [EndpointService.UpdateEndpoint][google.cloud.aiplatform.v1.EndpointService.UpdateEndpoint]. DeployedModel deployed_model = 2 [(google.api.field_behavior) = REQUIRED]; @@ -266,29 +289,34 @@ message DeployModelRequest { // traffic that should be forwarded to that DeployedModel. // // If this field is non-empty, then the Endpoint's - // [traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split] will be overwritten with it. - // To refer to the ID of the just being deployed Model, a "0" should be used, - // and the actual ID of the new DeployedModel will be filled in its place by - // this method. The traffic percentage values must add up to 100. + // [traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split] will be + // overwritten with it. To refer to the ID of the just being deployed Model, a + // "0" should be used, and the actual ID of the new DeployedModel will be + // filled in its place by this method. The traffic percentage values must add + // up to 100. // // If this field is empty, then the Endpoint's - // [traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split] is not updated. + // [traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split] is not + // updated. map traffic_split = 3; } -// Response message for [EndpointService.DeployModel][google.cloud.aiplatform.v1.EndpointService.DeployModel]. +// Response message for +// [EndpointService.DeployModel][google.cloud.aiplatform.v1.EndpointService.DeployModel]. message DeployModelResponse { // The DeployedModel that had been deployed in the Endpoint. DeployedModel deployed_model = 1; } -// Runtime operation information for [EndpointService.DeployModel][google.cloud.aiplatform.v1.EndpointService.DeployModel]. +// Runtime operation information for +// [EndpointService.DeployModel][google.cloud.aiplatform.v1.EndpointService.DeployModel]. message DeployModelOperationMetadata { // The operation generic information. GenericOperationMetadata generic_metadata = 1; } -// Request message for [EndpointService.UndeployModel][google.cloud.aiplatform.v1.EndpointService.UndeployModel]. +// Request message for +// [EndpointService.UndeployModel][google.cloud.aiplatform.v1.EndpointService.UndeployModel]. message UndeployModelRequest { // Required. The name of the Endpoint resource from which to undeploy a Model. // Format: @@ -304,21 +332,21 @@ message UndeployModelRequest { string deployed_model_id = 2 [(google.api.field_behavior) = REQUIRED]; // If this field is provided, then the Endpoint's - // [traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split] will be overwritten with it. If - // last DeployedModel is being undeployed from the Endpoint, the - // [Endpoint.traffic_split] will always end up empty when this call returns. - // A DeployedModel will be successfully undeployed only if it doesn't have - // any traffic assigned to it when this method executes, or if this field - // unassigns any traffic to it. + // [traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split] will be + // overwritten with it. If last DeployedModel is being undeployed from the + // Endpoint, the [Endpoint.traffic_split] will always end up empty when this + // call returns. A DeployedModel will be successfully undeployed only if it + // doesn't have any traffic assigned to it when this method executes, or if + // this field unassigns any traffic to it. map traffic_split = 3; } -// Response message for [EndpointService.UndeployModel][google.cloud.aiplatform.v1.EndpointService.UndeployModel]. -message UndeployModelResponse { - -} +// Response message for +// [EndpointService.UndeployModel][google.cloud.aiplatform.v1.EndpointService.UndeployModel]. +message UndeployModelResponse {} -// Runtime operation information for [EndpointService.UndeployModel][google.cloud.aiplatform.v1.EndpointService.UndeployModel]. +// Runtime operation information for +// [EndpointService.UndeployModel][google.cloud.aiplatform.v1.EndpointService.UndeployModel]. message UndeployModelOperationMetadata { // The operation generic information. GenericOperationMetadata generic_metadata = 1; diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/entity_type.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/entity_type.proto index 073b5339827..dcdea9645e1 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/entity_type.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/entity_type.proto @@ -52,12 +52,15 @@ message EntityType { string description = 2 [(google.api.field_behavior) = OPTIONAL]; // Output only. Timestamp when this EntityType was created. - google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this EntityType was most recently updated. - google.protobuf.Timestamp update_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Optional. The labels with user-defined metadata to organize your EntityTypes. + // Optional. The labels with user-defined metadata to organize your + // EntityTypes. // // Label keys and values can be no longer than 64 characters // (Unicode codepoints), can only contain lowercase letters, numeric @@ -70,17 +73,19 @@ message EntityType { // and are immutable. map labels = 6 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Used to perform a consistent read-modify-write updates. If not set, a blind - // "overwrite" update happens. + // Optional. Used to perform a consistent read-modify-write updates. If not + // set, a blind "overwrite" update happens. string etag = 7 [(google.api.field_behavior) = OPTIONAL]; - // Optional. The default monitoring configuration for all Features with value type - // ([Feature.ValueType][google.cloud.aiplatform.v1.Feature.ValueType]) BOOL, STRING, DOUBLE or INT64 under this - // EntityType. + // Optional. The default monitoring configuration for all Features with value + // type + // ([Feature.ValueType][google.cloud.aiplatform.v1.Feature.ValueType]) BOOL, + // STRING, DOUBLE or INT64 under this EntityType. // // If this is populated with // [FeaturestoreMonitoringConfig.monitoring_interval] specified, snapshot // analysis monitoring is enabled. Otherwise, snapshot analysis monitoring is // disabled. - FeaturestoreMonitoringConfig monitoring_config = 8 [(google.api.field_behavior) = OPTIONAL]; + FeaturestoreMonitoringConfig monitoring_config = 8 + [(google.api.field_behavior) = OPTIONAL]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/event.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/event.proto index f9f925db59c..0056445bb2e 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/event.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/event.proto @@ -60,7 +60,8 @@ message Event { ]; // Output only. Time the Event occurred. - google.protobuf.Timestamp event_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp event_time = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. The type of the Event. Type type = 4 [(google.api.field_behavior) = REQUIRED]; diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/execution.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/execution.proto index a2b7c2b9052..5af5c2aca85 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/execution.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/execution.proto @@ -87,10 +87,12 @@ message Execution { map labels = 10; // Output only. Timestamp when this Execution was created. - google.protobuf.Timestamp create_time = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 11 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this Execution was last updated. - google.protobuf.Timestamp update_time = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 12 + [(google.api.field_behavior) = OUTPUT_ONLY]; // The title of the schema describing the metadata. // @@ -107,6 +109,7 @@ message Execution { string schema_version = 14; // Properties of the Execution. + // Top level metadata keys' heading and trailing spaces will be trimmed. // The size of this field should not exceed 200KB. google.protobuf.Struct metadata = 15; diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/explanation.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/explanation.proto index 0c00d8a2268..24d9e28f72a 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/explanation.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/explanation.proto @@ -28,8 +28,10 @@ option java_package = "com.google.cloud.aiplatform.v1"; option php_namespace = "Google\\Cloud\\AIPlatform\\V1"; option ruby_package = "Google::Cloud::AIPlatform::V1"; -// Explanation of a prediction (provided in [PredictResponse.predictions][google.cloud.aiplatform.v1.PredictResponse.predictions]) -// produced by the Model on a given [instance][google.cloud.aiplatform.v1.ExplainRequest.instances]. +// Explanation of a prediction (provided in +// [PredictResponse.predictions][google.cloud.aiplatform.v1.PredictResponse.predictions]) +// produced by the Model on a given +// [instance][google.cloud.aiplatform.v1.ExplainRequest.instances]. message Explanation { // Output only. Feature attributions grouped by predicted outputs. // @@ -37,15 +39,21 @@ message Explanation { // predict only one score, there is only one attibution that explains the // predicted output. For Models that predict multiple outputs, such as // multiclass Models that predict multiple classes, each element explains one - // specific item. [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index] can be used to identify which - // output this attribution is explaining. + // specific item. + // [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index] + // can be used to identify which output this attribution is explaining. // - // If users set [ExplanationParameters.top_k][google.cloud.aiplatform.v1.ExplanationParameters.top_k], the attributions are sorted - // by [instance_output_value][Attributions.instance_output_value] in - // descending order. If [ExplanationParameters.output_indices][google.cloud.aiplatform.v1.ExplanationParameters.output_indices] is specified, - // the attributions are stored by [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index] in the same - // order as they appear in the output_indices. - repeated Attribution attributions = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + // If users set + // [ExplanationParameters.top_k][google.cloud.aiplatform.v1.ExplanationParameters.top_k], + // the attributions are sorted by + // [instance_output_value][Attributions.instance_output_value] in descending + // order. If + // [ExplanationParameters.output_indices][google.cloud.aiplatform.v1.ExplanationParameters.output_indices] + // is specified, the attributions are stored by + // [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index] + // in the same order as they appear in the output_indices. + repeated Attribution attributions = 1 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. List of the nearest neighbors for example-based explanations. // @@ -56,55 +64,67 @@ message Explanation { // Aggregated explanation metrics for a Model over a set of instances. message ModelExplanation { - // Output only. Aggregated attributions explaining the Model's prediction outputs over the - // set of instances. The attributions are grouped by outputs. + // Output only. Aggregated attributions explaining the Model's prediction + // outputs over the set of instances. The attributions are grouped by outputs. // // For Models that predict only one output, such as regression Models that // predict only one score, there is only one attibution that explains the // predicted output. For Models that predict multiple outputs, such as // multiclass Models that predict multiple classes, each element explains one - // specific item. [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index] can be used to identify which - // output this attribution is explaining. + // specific item. + // [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index] + // can be used to identify which output this attribution is explaining. // - // The [baselineOutputValue][google.cloud.aiplatform.v1.Attribution.baseline_output_value], - // [instanceOutputValue][google.cloud.aiplatform.v1.Attribution.instance_output_value] and - // [featureAttributions][google.cloud.aiplatform.v1.Attribution.feature_attributions] fields are - // averaged over the test data. + // The + // [baselineOutputValue][google.cloud.aiplatform.v1.Attribution.baseline_output_value], + // [instanceOutputValue][google.cloud.aiplatform.v1.Attribution.instance_output_value] + // and + // [featureAttributions][google.cloud.aiplatform.v1.Attribution.feature_attributions] + // fields are averaged over the test data. // // NOTE: Currently AutoML tabular classification Models produce only one // attribution, which averages attributions over all the classes it predicts. - // [Attribution.approximation_error][google.cloud.aiplatform.v1.Attribution.approximation_error] is not populated. - repeated Attribution mean_attributions = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + // [Attribution.approximation_error][google.cloud.aiplatform.v1.Attribution.approximation_error] + // is not populated. + repeated Attribution mean_attributions = 1 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // Attribution that explains a particular prediction output. message Attribution { - // Output only. Model predicted output if the input instance is constructed from the - // baselines of all the features defined in [ExplanationMetadata.inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs]. + // Output only. Model predicted output if the input instance is constructed + // from the baselines of all the features defined in + // [ExplanationMetadata.inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs]. // The field name of the output is determined by the key in // [ExplanationMetadata.outputs][google.cloud.aiplatform.v1.ExplanationMetadata.outputs]. // // If the Model's predicted output has multiple dimensions (rank > 1), this is - // the value in the output located by [output_index][google.cloud.aiplatform.v1.Attribution.output_index]. + // the value in the output located by + // [output_index][google.cloud.aiplatform.v1.Attribution.output_index]. // // If there are multiple baselines, their output values are averaged. double baseline_output_value = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Model predicted output on the corresponding [explanation // instance][ExplainRequest.instances]. The field name of the output is - // determined by the key in [ExplanationMetadata.outputs][google.cloud.aiplatform.v1.ExplanationMetadata.outputs]. + // determined by the key in + // [ExplanationMetadata.outputs][google.cloud.aiplatform.v1.ExplanationMetadata.outputs]. // // If the Model predicted output has multiple dimensions, this is the value in - // the output located by [output_index][google.cloud.aiplatform.v1.Attribution.output_index]. + // the output located by + // [output_index][google.cloud.aiplatform.v1.Attribution.output_index]. double instance_output_value = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. Attributions of each explained feature. Features are extracted from - // the [prediction instances][google.cloud.aiplatform.v1.ExplainRequest.instances] according to - // [explanation metadata for inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs]. + // Output only. Attributions of each explained feature. Features are extracted + // from the [prediction + // instances][google.cloud.aiplatform.v1.ExplainRequest.instances] according + // to [explanation metadata for + // inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs]. // // The value is a struct, whose keys are the name of the feature. The values - // are how much the feature in the [instance][google.cloud.aiplatform.v1.ExplainRequest.instances] - // contributed to the predicted result. + // are how much the feature in the + // [instance][google.cloud.aiplatform.v1.ExplainRequest.instances] contributed + // to the predicted result. // // The format of the value is determined by the feature's input format: // @@ -120,11 +140,15 @@ message Attribution { // struct. The formats of the values in the attribution struct are // determined by the formats of the values in the feature struct. // - // The [ExplanationMetadata.feature_attributions_schema_uri][google.cloud.aiplatform.v1.ExplanationMetadata.feature_attributions_schema_uri] field, - // pointed to by the [ExplanationSpec][google.cloud.aiplatform.v1.ExplanationSpec] field of the - // [Endpoint.deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models] object, points to the schema file that - // describes the features and their attribution values (if it is populated). - google.protobuf.Value feature_attributions = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + // The + // [ExplanationMetadata.feature_attributions_schema_uri][google.cloud.aiplatform.v1.ExplanationMetadata.feature_attributions_schema_uri] + // field, pointed to by the + // [ExplanationSpec][google.cloud.aiplatform.v1.ExplanationSpec] field of the + // [Endpoint.deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models] + // object, points to the schema file that describes the features and their + // attribution values (if it is populated). + google.protobuf.Value feature_attributions = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The index that locates the explained prediction output. // @@ -135,8 +159,9 @@ message Attribution { // of the output vector. Indices start from 0. repeated int32 output_index = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. The display name of the output identified by [output_index][google.cloud.aiplatform.v1.Attribution.output_index]. For example, - // the predicted class name by a multi-classification Model. + // Output only. The display name of the output identified by + // [output_index][google.cloud.aiplatform.v1.Attribution.output_index]. For + // example, the predicted class name by a multi-classification Model. // // This field is only populated iff the Model predicts display names as a // separate field along with the explained output. The predicted display name @@ -144,20 +169,26 @@ message Attribution { // output_index. string output_display_name = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. Error of [feature_attributions][google.cloud.aiplatform.v1.Attribution.feature_attributions] caused by approximation used in the - // explanation method. Lower value means more precise attributions. + // Output only. Error of + // [feature_attributions][google.cloud.aiplatform.v1.Attribution.feature_attributions] + // caused by approximation used in the explanation method. Lower value means + // more precise attributions. // // * For Sampled Shapley // [attribution][google.cloud.aiplatform.v1.ExplanationParameters.sampled_shapley_attribution], - // increasing [path_count][google.cloud.aiplatform.v1.SampledShapleyAttribution.path_count] might reduce - // the error. + // increasing + // [path_count][google.cloud.aiplatform.v1.SampledShapleyAttribution.path_count] + // might reduce the error. // * For Integrated Gradients // [attribution][google.cloud.aiplatform.v1.ExplanationParameters.integrated_gradients_attribution], - // increasing [step_count][google.cloud.aiplatform.v1.IntegratedGradientsAttribution.step_count] might - // reduce the error. - // * For [XRAI attribution][google.cloud.aiplatform.v1.ExplanationParameters.xrai_attribution], // increasing - // [step_count][google.cloud.aiplatform.v1.XraiAttribution.step_count] might reduce the error. + // [step_count][google.cloud.aiplatform.v1.IntegratedGradientsAttribution.step_count] + // might reduce the error. + // * For [XRAI + // attribution][google.cloud.aiplatform.v1.ExplanationParameters.xrai_attribution], + // increasing + // [step_count][google.cloud.aiplatform.v1.XraiAttribution.step_count] might + // reduce the error. // // See [this introduction](/vertex-ai/docs/explainable-ai/overview) // for more information. @@ -219,13 +250,14 @@ message ExplanationParameters { int32 top_k = 4; // If populated, only returns attributions that have - // [output_index][google.cloud.aiplatform.v1.Attribution.output_index] contained in output_indices. It - // must be an ndarray of integers, with the same shape of the output it's - // explaining. + // [output_index][google.cloud.aiplatform.v1.Attribution.output_index] + // contained in output_indices. It must be an ndarray of integers, with the + // same shape of the output it's explaining. // - // If not populated, returns attributions for [top_k][google.cloud.aiplatform.v1.ExplanationParameters.top_k] indices of outputs. - // If neither top_k nor output_indices is populated, returns the argmax - // index of the outputs. + // If not populated, returns attributions for + // [top_k][google.cloud.aiplatform.v1.ExplanationParameters.top_k] indices of + // outputs. If neither top_k nor output_indices is populated, returns the + // argmax index of the outputs. // // Only applicable to Models that predict multiple outputs (e,g, multi-class // Models that predict multiple classes). @@ -236,8 +268,8 @@ message ExplanationParameters { // contribute to the label being predicted. A sampling strategy is used to // approximate the value rather than considering all subsets of features. message SampledShapleyAttribution { - // Required. The number of feature permutations to consider when approximating the - // Shapley values. + // Required. The number of feature permutations to consider when approximating + // the Shapley values. // // Valid range of its value is [1, 50], inclusively. int32 path_count = 1 [(google.api.field_behavior) = REQUIRED]; @@ -324,16 +356,18 @@ message SmoothGradConfig { // paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to 0.1. // // If the distribution is different per feature, set - // [feature_noise_sigma][google.cloud.aiplatform.v1.SmoothGradConfig.feature_noise_sigma] instead - // for each feature. + // [feature_noise_sigma][google.cloud.aiplatform.v1.SmoothGradConfig.feature_noise_sigma] + // instead for each feature. float noise_sigma = 1; - // This is similar to [noise_sigma][google.cloud.aiplatform.v1.SmoothGradConfig.noise_sigma], but - // provides additional flexibility. A separate noise sigma can be provided - // for each feature, which is useful if their distributions are different. - // No noise is added to features that are not set. If this field is unset, - // [noise_sigma][google.cloud.aiplatform.v1.SmoothGradConfig.noise_sigma] will be used for all - // features. + // This is similar to + // [noise_sigma][google.cloud.aiplatform.v1.SmoothGradConfig.noise_sigma], + // but provides additional flexibility. A separate noise sigma can be + // provided for each feature, which is useful if their distributions are + // different. No noise is added to features that are not set. If this field + // is unset, + // [noise_sigma][google.cloud.aiplatform.v1.SmoothGradConfig.noise_sigma] + // will be used for all features. FeatureNoiseSigma feature_noise_sigma = 2; } @@ -352,13 +386,14 @@ message FeatureNoiseSigma { message NoiseSigmaForFeature { // The name of the input feature for which noise sigma is provided. The // features are defined in - // [explanation metadata inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs]. + // [explanation metadata + // inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs]. string name = 1; // This represents the standard deviation of the Gaussian kernel that will // be used to add noise to the feature prior to computing gradients. Similar - // to [noise_sigma][google.cloud.aiplatform.v1.SmoothGradConfig.noise_sigma] but represents the - // noise added to the current feature. Defaults to 0.1. + // to [noise_sigma][google.cloud.aiplatform.v1.SmoothGradConfig.noise_sigma] + // but represents the noise added to the current feature. Defaults to 0.1. float sigma = 2; } @@ -380,12 +415,13 @@ message BlurBaselineConfig { float max_blur_sigma = 1; } -// The [ExplanationSpec][google.cloud.aiplatform.v1.ExplanationSpec] entries that can be overridden at -// [online explanation][google.cloud.aiplatform.v1.PredictionService.Explain] time. +// The [ExplanationSpec][google.cloud.aiplatform.v1.ExplanationSpec] entries +// that can be overridden at [online +// explanation][google.cloud.aiplatform.v1.PredictionService.Explain] time. message ExplanationSpecOverride { // The parameters to be overridden. Note that the - // [method][google.cloud.aiplatform.v1.ExplanationParameters.method] cannot be changed. If not specified, - // no parameter is overridden. + // [method][google.cloud.aiplatform.v1.ExplanationParameters.method] cannot be + // changed. If not specified, no parameter is overridden. ExplanationParameters parameters = 1; // The metadata to be overridden. If not specified, no metadata is overridden. @@ -395,11 +431,13 @@ message ExplanationSpecOverride { ExamplesOverride examples_override = 3; } -// The [ExplanationMetadata][google.cloud.aiplatform.v1.ExplanationMetadata] entries that can be overridden at -// [online explanation][google.cloud.aiplatform.v1.PredictionService.Explain] time. +// The [ExplanationMetadata][google.cloud.aiplatform.v1.ExplanationMetadata] +// entries that can be overridden at [online +// explanation][google.cloud.aiplatform.v1.PredictionService.Explain] time. message ExplanationMetadataOverride { - // The [input metadata][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata] entries to be - // overridden. + // The [input + // metadata][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata] + // entries to be overridden. message InputMetadataOverride { // Baseline inputs for this feature. // @@ -410,12 +448,14 @@ message ExplanationMetadataOverride { repeated google.protobuf.Value input_baselines = 1; } - // Required. Overrides the [input metadata][google.cloud.aiplatform.v1.ExplanationMetadata.inputs] of the features. - // The key is the name of the feature to be overridden. The keys specified - // here must exist in the input metadata to be overridden. If a feature is - // not specified here, the corresponding feature's input metadata is not - // overridden. - map inputs = 1 [(google.api.field_behavior) = REQUIRED]; + // Required. Overrides the [input + // metadata][google.cloud.aiplatform.v1.ExplanationMetadata.inputs] of the + // features. The key is the name of the feature to be overridden. The keys + // specified here must exist in the input metadata to be overridden. If a + // feature is not specified here, the corresponding feature's input metadata + // is not overridden. + map inputs = 1 + [(google.api.field_behavior) = REQUIRED]; } // Overrides for example-based explanations. diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/explanation_metadata.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/explanation_metadata.proto index 5ee0c1ce33e..aac28243085 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/explanation_metadata.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/explanation_metadata.proto @@ -31,8 +31,10 @@ option ruby_package = "Google::Cloud::AIPlatform::V1"; message ExplanationMetadata { // Metadata of the input of a feature. // - // Fields other than [InputMetadata.input_baselines][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.input_baselines] are applicable only - // for Models that are using Vertex AI-provided images for Tensorflow. + // Fields other than + // [InputMetadata.input_baselines][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.input_baselines] + // are applicable only for Models that are using Vertex AI-provided images for + // Tensorflow. message InputMetadata { // Domain details of the input feature value. Provides numeric information // about the feature, such as its range (min, max). If the feature has been @@ -63,7 +65,8 @@ message ExplanationMetadata { // Visualization configurations for image explanation. message Visualization { // Type of the image visualization. Only applicable to - // [Integrated Gradients attribution][google.cloud.aiplatform.v1.ExplanationParameters.integrated_gradients_attribution]. + // [Integrated Gradients + // attribution][google.cloud.aiplatform.v1.ExplanationParameters.integrated_gradients_attribution]. enum Type { // Should not be used. TYPE_UNSPECIFIED = 0; @@ -141,7 +144,8 @@ message ExplanationMetadata { } // Type of the image visualization. Only applicable to - // [Integrated Gradients attribution][google.cloud.aiplatform.v1.ExplanationParameters.integrated_gradients_attribution]. + // [Integrated Gradients + // attribution][google.cloud.aiplatform.v1.ExplanationParameters.integrated_gradients_attribution]. // OUTLINES shows regions of attribution, while PIXELS shows per-pixel // attribution. Defaults to OUTLINES. Type type = 1; @@ -153,12 +157,14 @@ message ExplanationMetadata { // The color scheme used for the highlighted areas. // // Defaults to PINK_GREEN for - // [Integrated Gradients attribution][google.cloud.aiplatform.v1.ExplanationParameters.integrated_gradients_attribution], + // [Integrated Gradients + // attribution][google.cloud.aiplatform.v1.ExplanationParameters.integrated_gradients_attribution], // which shows positive attributions in green and negative in pink. // // Defaults to VIRIDIS for - // [XRAI attribution][google.cloud.aiplatform.v1.ExplanationParameters.xrai_attribution], which - // highlights the most influential regions in yellow and the least + // [XRAI + // attribution][google.cloud.aiplatform.v1.ExplanationParameters.xrai_attribution], + // which highlights the most influential regions in yellow and the least // influential in blue. ColorMap color_map = 3; @@ -188,8 +194,9 @@ message ExplanationMetadata { IDENTITY = 1; // The tensor represents a bag of features where each index maps to - // a feature. [InputMetadata.index_feature_mapping][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.index_feature_mapping] must be provided for - // this encoding. For example: + // a feature. + // [InputMetadata.index_feature_mapping][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.index_feature_mapping] + // must be provided for this encoding. For example: // ``` // input = [27, 6.0, 150] // index_feature_mapping = ["age", "height", "weight"] @@ -198,8 +205,9 @@ message ExplanationMetadata { // The tensor represents a bag of features where each index maps to a // feature. Zero values in the tensor indicates feature being - // non-existent. [InputMetadata.index_feature_mapping][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.index_feature_mapping] must be provided - // for this encoding. For example: + // non-existent. + // [InputMetadata.index_feature_mapping][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.index_feature_mapping] + // must be provided for this encoding. For example: // ``` // input = [2, 0, 5, 0, 1] // index_feature_mapping = ["a", "b", "c", "d", "e"] @@ -207,7 +215,8 @@ message ExplanationMetadata { BAG_OF_FEATURES_SPARSE = 3; // The tensor is a list of binaries representing whether a feature exists - // or not (1 indicates existence). [InputMetadata.index_feature_mapping][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.index_feature_mapping] + // or not (1 indicates existence). + // [InputMetadata.index_feature_mapping][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.index_feature_mapping] // must be provided for this encoding. For example: // ``` // input = [1, 0, 1, 0, 1] @@ -216,8 +225,9 @@ message ExplanationMetadata { INDICATOR = 4; // The tensor is encoded into a 1-dimensional array represented by an - // encoded tensor. [InputMetadata.encoded_tensor_name][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.encoded_tensor_name] must be provided - // for this encoding. For example: + // encoded tensor. + // [InputMetadata.encoded_tensor_name][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.encoded_tensor_name] + // must be provided for this encoding. For example: // ``` // input = ["This", "is", "a", "test", "."] // encoded = [0.1, 0.2, 0.3, 0.4, 0.5] @@ -226,9 +236,9 @@ message ExplanationMetadata { // Select this encoding when the input tensor is encoded into a // 2-dimensional array represented by an encoded tensor. - // [InputMetadata.encoded_tensor_name][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.encoded_tensor_name] must be provided for this - // encoding. The first dimension of the encoded tensor's shape is the same - // as the input tensor's shape. For example: + // [InputMetadata.encoded_tensor_name][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.encoded_tensor_name] + // must be provided for this encoding. The first dimension of the encoded + // tensor's shape is the same as the input tensor's shape. For example: // ``` // input = ["This", "is", "a", "test", "."] // encoded = [[0.1, 0.2, 0.3, 0.4, 0.5], @@ -244,7 +254,8 @@ message ExplanationMetadata { // // If no baseline is specified, Vertex AI chooses the baseline for this // feature. If multiple baselines are specified, Vertex AI returns the - // average attributions across them in [Attribution.feature_attributions][google.cloud.aiplatform.v1.Attribution.feature_attributions]. + // average attributions across them in + // [Attribution.feature_attributions][google.cloud.aiplatform.v1.Attribution.feature_attributions]. // // For Vertex AI-provided Tensorflow images (both 1.x and 2.x), the shape // of each baseline must match the shape of the input tensor. If a scalar is @@ -252,9 +263,9 @@ message ExplanationMetadata { // // For custom images, the element of the baselines must be in the same // format as the feature's input in the - // [instance][google.cloud.aiplatform.v1.ExplainRequest.instances][]. The schema of any single instance - // may be specified via Endpoint's DeployedModels' - // [Model's][google.cloud.aiplatform.v1.DeployedModel.model] + // [instance][google.cloud.aiplatform.v1.ExplainRequest.instances][]. The + // schema of any single instance may be specified via Endpoint's + // DeployedModels' [Model's][google.cloud.aiplatform.v1.DeployedModel.model] // [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata] // [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri]. repeated google.protobuf.Value input_baselines = 1; @@ -287,15 +298,18 @@ message ExplanationMetadata { string dense_shape_tensor_name = 7; // A list of feature names for each index in the input tensor. - // Required when the input [InputMetadata.encoding][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.encoding] is BAG_OF_FEATURES, - // BAG_OF_FEATURES_SPARSE, INDICATOR. + // Required when the input + // [InputMetadata.encoding][google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.encoding] + // is BAG_OF_FEATURES, BAG_OF_FEATURES_SPARSE, INDICATOR. repeated string index_feature_mapping = 8; // Encoded tensor is a transformation of the input tensor. Must be provided // if choosing - // [Integrated Gradients attribution][google.cloud.aiplatform.v1.ExplanationParameters.integrated_gradients_attribution] - // or [XRAI attribution][google.cloud.aiplatform.v1.ExplanationParameters.xrai_attribution] and the - // input tensor is not differentiable. + // [Integrated Gradients + // attribution][google.cloud.aiplatform.v1.ExplanationParameters.integrated_gradients_attribution] + // or [XRAI + // attribution][google.cloud.aiplatform.v1.ExplanationParameters.xrai_attribution] + // and the input tensor is not differentiable. // // An encoded tensor is generated if the input tensor is encoded by a lookup // table. @@ -315,17 +329,21 @@ message ExplanationMetadata { // name will be treated as one feature when computing attributions. Features // grouped together can have different shapes in value. If provided, there // will be one single attribution generated in - // [Attribution.feature_attributions][google.cloud.aiplatform.v1.Attribution.feature_attributions], keyed by the group name. + // [Attribution.feature_attributions][google.cloud.aiplatform.v1.Attribution.feature_attributions], + // keyed by the group name. string group_name = 12; } // Metadata of the prediction output to be explained. message OutputMetadata { - // Defines how to map [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index] to + // Defines how to map + // [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index] + // to // [Attribution.output_display_name][google.cloud.aiplatform.v1.Attribution.output_display_name]. // // If neither of the fields are specified, - // [Attribution.output_display_name][google.cloud.aiplatform.v1.Attribution.output_display_name] will not be populated. + // [Attribution.output_display_name][google.cloud.aiplatform.v1.Attribution.output_display_name] + // will not be populated. oneof display_name_mapping { // Static mapping between the index and display name. // @@ -337,8 +355,10 @@ message ExplanationMetadata { // // The shape of the value must be an n-dimensional array of strings. The // number of dimensions must match that of the outputs to be explained. - // The [Attribution.output_display_name][google.cloud.aiplatform.v1.Attribution.output_display_name] is populated by locating in the - // mapping with [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index]. + // The + // [Attribution.output_display_name][google.cloud.aiplatform.v1.Attribution.output_display_name] + // is populated by locating in the mapping with + // [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index]. google.protobuf.Value index_display_name_mapping = 1; // Specify a field name in the prediction to look for the display name. @@ -346,8 +366,9 @@ message ExplanationMetadata { // Use this if the prediction contains the display names for the outputs. // // The display names in the prediction must have the same shape of the - // outputs, so that it can be located by [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index] for - // a specific output. + // outputs, so that it can be located by + // [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index] + // for a specific output. string display_name_mapping_key = 2; } @@ -356,21 +377,23 @@ message ExplanationMetadata { string output_tensor_name = 3; } - // Required. Map from feature names to feature input metadata. Keys are the name of the - // features. Values are the specification of the feature. + // Required. Map from feature names to feature input metadata. Keys are the + // name of the features. Values are the specification of the feature. // // An empty InputMetadata is valid. It describes a text feature which has the - // name specified as the key in [ExplanationMetadata.inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs]. The baseline - // of the empty feature is chosen by Vertex AI. + // name specified as the key in + // [ExplanationMetadata.inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs]. + // The baseline of the empty feature is chosen by Vertex AI. // // For Vertex AI-provided Tensorflow images, the key can be any friendly // name of the feature. Once specified, - // [featureAttributions][google.cloud.aiplatform.v1.Attribution.feature_attributions] are keyed by - // this key (if not grouped with another feature). + // [featureAttributions][google.cloud.aiplatform.v1.Attribution.feature_attributions] + // are keyed by this key (if not grouped with another feature). // // For custom images, the key must match with the key in // [instance][google.cloud.aiplatform.v1.ExplainRequest.instances]. - map inputs = 1 [(google.api.field_behavior) = REQUIRED]; + map inputs = 1 + [(google.api.field_behavior) = REQUIRED]; // Required. Map from output names to output metadata. // @@ -381,10 +404,12 @@ message ExplanationMetadata { // to be explained. // // Currently only one key is allowed. - map outputs = 2 [(google.api.field_behavior) = REQUIRED]; + map outputs = 2 + [(google.api.field_behavior) = REQUIRED]; // Points to a YAML file stored on Google Cloud Storage describing the format - // of the [feature attributions][google.cloud.aiplatform.v1.Attribution.feature_attributions]. + // of the [feature + // attributions][google.cloud.aiplatform.v1.Attribution.feature_attributions]. // The schema is defined as an OpenAPI 3.0.2 [Schema // Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). // AutoML tabular Models always have this field populated by Vertex AI. diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/feature.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/feature.proto index 690bb364110..ea62bd1b7b1 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/feature.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/feature.proto @@ -41,7 +41,9 @@ message Feature { // A list of historical [Snapshot // Analysis][FeaturestoreMonitoringConfig.SnapshotAnalysis] or [Import Feature // Analysis] [FeaturestoreMonitoringConfig.ImportFeatureAnalysis] stats - // requested by user, sorted by [FeatureStatsAnomaly.start_time][google.cloud.aiplatform.v1.FeatureStatsAnomaly.start_time] descending. + // requested by user, sorted by + // [FeatureStatsAnomaly.start_time][google.cloud.aiplatform.v1.FeatureStatsAnomaly.start_time] + // descending. message MonitoringStatsAnomaly { // If the objective in the request is both // Import Feature Analysis and Snapshot Analysis, this objective could be @@ -62,7 +64,8 @@ message Feature { Objective objective = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The stats and anomalies generated at specific timestamp. - FeatureStatsAnomaly feature_stats_anomaly = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + FeatureStatsAnomaly feature_stats_anomaly = 2 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // An enum representing the value type of a feature. @@ -118,10 +121,12 @@ message Feature { ]; // Output only. Timestamp when this EntityType was created. - google.protobuf.Timestamp create_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this EntityType was most recently updated. - google.protobuf.Timestamp update_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Optional. The labels with user-defined metadata to organize your Features. // @@ -140,15 +145,17 @@ message Feature { // "overwrite" update happens. string etag = 7; - // Optional. If not set, use the monitoring_config defined for the EntityType this - // Feature belongs to. - // Only Features with type ([Feature.ValueType][google.cloud.aiplatform.v1.Feature.ValueType]) BOOL, STRING, DOUBLE or - // INT64 can enable monitoring. + // Optional. If not set, use the monitoring_config defined for the EntityType + // this Feature belongs to. Only Features with type + // ([Feature.ValueType][google.cloud.aiplatform.v1.Feature.ValueType]) BOOL, + // STRING, DOUBLE or INT64 can enable monitoring. // // If set to true, all types of data monitoring are disabled despite the // config on EntityType. bool disable_monitoring = 12 [(google.api.field_behavior) = OPTIONAL]; - // Output only. The list of historical stats and anomalies with specified objectives. - repeated MonitoringStatsAnomaly monitoring_stats_anomalies = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. The list of historical stats and anomalies with specified + // objectives. + repeated MonitoringStatsAnomaly monitoring_stats_anomalies = 11 + [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/feature_monitoring_stats.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/feature_monitoring_stats.proto index 1138ec8c340..95cad9fc475 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/feature_monitoring_stats.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/feature_monitoring_stats.proto @@ -39,7 +39,8 @@ message FeatureStatsAnomaly { // Feature importance score, only populated when cross-feature monitoring is // enabled. For now only used to represent feature attribution score within // range [0, 1] for - // [ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_SKEW][google.cloud.aiplatform.v1.ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_SKEW] and + // [ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_SKEW][google.cloud.aiplatform.v1.ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_SKEW] + // and // [ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_DRIFT][google.cloud.aiplatform.v1.ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_DRIFT]. double score = 1; diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/featurestore.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/featurestore.proto index 4c8a72f59f8..facac33d0ef 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/featurestore.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/featurestore.proto @@ -45,8 +45,8 @@ message Featurestore { // max_node_count are set to the same value, the cluster will be configured // with the fixed number of node (no auto-scaling). message Scaling { - // Required. The minimum number of nodes to scale down to. Must be greater than or - // equal to 1. + // Required. The minimum number of nodes to scale down to. Must be greater + // than or equal to 1. int32 min_node_count = 1 [(google.api.field_behavior) = REQUIRED]; // The maximum number of nodes to scale up to. Must be greater than @@ -94,16 +94,19 @@ message Featurestore { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this Featurestore was created. - google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this Featurestore was last updated. - google.protobuf.Timestamp update_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Optional. Used to perform consistent read-modify-write updates. If not set, a blind - // "overwrite" update happens. + // Optional. Used to perform consistent read-modify-write updates. If not set, + // a blind "overwrite" update happens. string etag = 5 [(google.api.field_behavior) = OPTIONAL]; - // Optional. The labels with user-defined metadata to organize your Featurestore. + // Optional. The labels with user-defined metadata to organize your + // Featurestore. // // Label keys and values can be no longer than 64 characters // (Unicode codepoints), can only contain lowercase letters, numeric @@ -116,14 +119,17 @@ message Featurestore { // and are immutable. map labels = 6 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Config for online storage resources. If unset, the featurestore will - // not have an online store and cannot be used for online serving. - OnlineServingConfig online_serving_config = 7 [(google.api.field_behavior) = OPTIONAL]; + // Optional. Config for online storage resources. The field should not + // co-exist with the field of `OnlineStoreReplicationConfig`. If both of it + // and OnlineStoreReplicationConfig are unset, the feature store will not have + // an online store and cannot be used for online serving. + OnlineServingConfig online_serving_config = 7 + [(google.api.field_behavior) = OPTIONAL]; // Output only. State of the featurestore. State state = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Optional. Customer-managed encryption key spec for data storage. If set, both of the - // online and offline data storage will be secured by this key. + // Optional. Customer-managed encryption key spec for data storage. If set, + // both of the online and offline data storage will be secured by this key. EncryptionSpec encryption_spec = 10 [(google.api.field_behavior) = OPTIONAL]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/featurestore_monitoring.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/featurestore_monitoring.proto index 7233658b077..071f6a24656 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/featurestore_monitoring.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/featurestore_monitoring.proto @@ -139,11 +139,15 @@ message FeaturestoreMonitoringConfig { // Threshold for numerical features of anomaly detection. // This is shared by all objectives of Featurestore Monitoring for numerical - // features (i.e. Features with type ([Feature.ValueType][google.cloud.aiplatform.v1.Feature.ValueType]) DOUBLE or INT64). + // features (i.e. Features with type + // ([Feature.ValueType][google.cloud.aiplatform.v1.Feature.ValueType]) DOUBLE + // or INT64). ThresholdConfig numerical_threshold_config = 3; // Threshold for categorical features of anomaly detection. // This is shared by all types of Featurestore Monitoring for categorical - // features (i.e. Features with type ([Feature.ValueType][google.cloud.aiplatform.v1.Feature.ValueType]) BOOL or STRING). + // features (i.e. Features with type + // ([Feature.ValueType][google.cloud.aiplatform.v1.Feature.ValueType]) BOOL or + // STRING). ThresholdConfig categorical_threshold_config = 4; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/featurestore_online_service.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/featurestore_online_service.proto index 915c4c3fb97..b9c4f3dbf4d 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/featurestore_online_service.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/featurestore_online_service.proto @@ -35,12 +35,14 @@ option ruby_package = "Google::Cloud::AIPlatform::V1"; // A service for serving online feature values. service FeaturestoreOnlineServingService { option (google.api.default_host) = "aiplatform.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/cloud-platform"; // Reads Feature values of a specific entity of an EntityType. For reading // feature values of multiple entities of an EntityType, please use // StreamingReadFeatureValues. - rpc ReadFeatureValues(ReadFeatureValuesRequest) returns (ReadFeatureValuesResponse) { + rpc ReadFeatureValues(ReadFeatureValuesRequest) + returns (ReadFeatureValuesResponse) { option (google.api.http) = { post: "/v1/{entity_type=projects/*/locations/*/featurestores/*/entityTypes/*}:readFeatureValues" body: "*" @@ -51,16 +53,71 @@ service FeaturestoreOnlineServingService { // Reads Feature values for multiple entities. Depending on their size, data // for different entities may be broken // up across multiple responses. - rpc StreamingReadFeatureValues(StreamingReadFeatureValuesRequest) returns (stream ReadFeatureValuesResponse) { + rpc StreamingReadFeatureValues(StreamingReadFeatureValuesRequest) + returns (stream ReadFeatureValuesResponse) { option (google.api.http) = { post: "/v1/{entity_type=projects/*/locations/*/featurestores/*/entityTypes/*}:streamingReadFeatureValues" body: "*" }; option (google.api.method_signature) = "entity_type"; } + + // Writes Feature values of one or more entities of an EntityType. + // + // The Feature values are merged into existing entities if any. The Feature + // values to be written must have timestamp within the online storage + // retention. + rpc WriteFeatureValues(WriteFeatureValuesRequest) + returns (WriteFeatureValuesResponse) { + option (google.api.http) = { + post: "/v1/{entity_type=projects/*/locations/*/featurestores/*/entityTypes/*}:writeFeatureValues" + body: "*" + }; + option (google.api.method_signature) = "entity_type,payloads"; + } +} + +// Request message for +// [FeaturestoreOnlineServingService.WriteFeatureValues][google.cloud.aiplatform.v1.FeaturestoreOnlineServingService.WriteFeatureValues]. +message WriteFeatureValuesRequest { + // Required. The resource name of the EntityType for the entities being + // written. Value format: + // `projects/{project}/locations/{location}/featurestores/ + // {featurestore}/entityTypes/{entityType}`. For example, + // for a machine learning model predicting user clicks on a website, an + // EntityType ID could be `user`. + string entity_type = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "aiplatform.googleapis.com/EntityType" + } + ]; + + // Required. The entities to be written. Up to 100,000 feature values can be + // written across all `payloads`. + repeated WriteFeatureValuesPayload payloads = 2 + [(google.api.field_behavior) = REQUIRED]; } -// Request message for [FeaturestoreOnlineServingService.ReadFeatureValues][google.cloud.aiplatform.v1.FeaturestoreOnlineServingService.ReadFeatureValues]. +// Contains Feature values to be written for a specific entity. +message WriteFeatureValuesPayload { + // Required. The ID of the entity. + string entity_id = 1 [(google.api.field_behavior) = REQUIRED]; + + // Required. Feature values to be written, mapping from Feature ID to value. + // Up to 100,000 `feature_values` entries may be written across all payloads. + // The feature generation time, aligned by days, must be no older than five + // years (1825 days) and no later than one year (366 days) in the future. + map feature_values = 2 + [(google.api.field_behavior) = REQUIRED]; +} + +// Response message for +// [FeaturestoreOnlineServingService.WriteFeatureValues][google.cloud.aiplatform.v1.FeaturestoreOnlineServingService.WriteFeatureValues]. +message WriteFeatureValuesResponse {} + +// Request message for +// [FeaturestoreOnlineServingService.ReadFeatureValues][google.cloud.aiplatform.v1.FeaturestoreOnlineServingService.ReadFeatureValues]. message ReadFeatureValuesRequest { // Required. The resource name of the EntityType for the entity being read. // Value format: @@ -83,7 +140,8 @@ message ReadFeatureValuesRequest { FeatureSelector feature_selector = 3 [(google.api.field_behavior) = REQUIRED]; } -// Response message for [FeaturestoreOnlineServingService.ReadFeatureValues][google.cloud.aiplatform.v1.FeaturestoreOnlineServingService.ReadFeatureValues]. +// Response message for +// [FeaturestoreOnlineServingService.ReadFeatureValues][google.cloud.aiplatform.v1.FeaturestoreOnlineServingService.ReadFeatureValues]. message ReadFeatureValuesResponse { // Metadata for requested Features. message FeatureDescriptor { @@ -92,14 +150,16 @@ message ReadFeatureValuesResponse { } // Response header with metadata for the requested - // [ReadFeatureValuesRequest.entity_type][google.cloud.aiplatform.v1.ReadFeatureValuesRequest.entity_type] and Features. + // [ReadFeatureValuesRequest.entity_type][google.cloud.aiplatform.v1.ReadFeatureValuesRequest.entity_type] + // and Features. message Header { // The resource name of the EntityType from the - // [ReadFeatureValuesRequest][google.cloud.aiplatform.v1.ReadFeatureValuesRequest]. Value format: + // [ReadFeatureValuesRequest][google.cloud.aiplatform.v1.ReadFeatureValuesRequest]. + // Value format: // `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`. string entity_type = 1 [(google.api.resource_reference) = { - type: "aiplatform.googleapis.com/EntityType" - }]; + type: "aiplatform.googleapis.com/EntityType" + }]; // List of Feature metadata corresponding to each piece of // [ReadFeatureValuesResponse.data][]. @@ -130,7 +190,8 @@ message ReadFeatureValuesResponse { // requested values for one requested Feature. If no values // for the requested Feature exist, the corresponding cell will be empty. // This has the same size and is in the same order as the features from the - // header [ReadFeatureValuesResponse.header][google.cloud.aiplatform.v1.ReadFeatureValuesResponse.header]. + // header + // [ReadFeatureValuesResponse.header][google.cloud.aiplatform.v1.ReadFeatureValuesResponse.header]. repeated Data data = 2; } @@ -160,13 +221,13 @@ message StreamingReadFeatureValuesRequest { } ]; - // Required. IDs of entities to read Feature values of. The maximum number of IDs is - // 100. For example, for a machine learning model predicting user clicks on a - // website, an entity ID could be `user_123`. + // Required. IDs of entities to read Feature values of. The maximum number of + // IDs is 100. For example, for a machine learning model predicting user + // clicks on a website, an entity ID could be `user_123`. repeated string entity_ids = 2 [(google.api.field_behavior) = REQUIRED]; - // Required. Selector choosing Features of the target EntityType. Feature IDs will be - // deduplicated. + // Required. Selector choosing Features of the target EntityType. Feature IDs + // will be deduplicated. FeatureSelector feature_selector = 3 [(google.api.field_behavior) = REQUIRED]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/featurestore_service.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/featurestore_service.proto index 516092ee159..b500a4aa2b8 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/featurestore_service.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/featurestore_service.proto @@ -41,16 +41,19 @@ option ruby_package = "Google::Cloud::AIPlatform::V1"; // The service that handles CRUD and List for resources for Featurestore. service FeaturestoreService { option (google.api.default_host) = "aiplatform.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/cloud-platform"; // Creates a new Featurestore in a given project and location. - rpc CreateFeaturestore(CreateFeaturestoreRequest) returns (google.longrunning.Operation) { + rpc CreateFeaturestore(CreateFeaturestoreRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{parent=projects/*/locations/*}/featurestores" body: "featurestore" }; option (google.api.method_signature) = "parent,featurestore"; - option (google.api.method_signature) = "parent,featurestore,featurestore_id"; + option (google.api.method_signature) = + "parent,featurestore,featurestore_id"; option (google.longrunning.operation_info) = { response_type: "Featurestore" metadata_type: "CreateFeaturestoreOperationMetadata" @@ -66,7 +69,8 @@ service FeaturestoreService { } // Lists Featurestores in a given project and location. - rpc ListFeaturestores(ListFeaturestoresRequest) returns (ListFeaturestoresResponse) { + rpc ListFeaturestores(ListFeaturestoresRequest) + returns (ListFeaturestoresResponse) { option (google.api.http) = { get: "/v1/{parent=projects/*/locations/*}/featurestores" }; @@ -74,7 +78,8 @@ service FeaturestoreService { } // Updates the parameters of a single Featurestore. - rpc UpdateFeaturestore(UpdateFeaturestoreRequest) returns (google.longrunning.Operation) { + rpc UpdateFeaturestore(UpdateFeaturestoreRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { patch: "/v1/{featurestore.name=projects/*/locations/*/featurestores/*}" body: "featurestore" @@ -88,7 +93,8 @@ service FeaturestoreService { // Deletes a single Featurestore. The Featurestore must not contain any // EntityTypes or `force` must be set to true for the request to succeed. - rpc DeleteFeaturestore(DeleteFeaturestoreRequest) returns (google.longrunning.Operation) { + rpc DeleteFeaturestore(DeleteFeaturestoreRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1/{name=projects/*/locations/*/featurestores/*}" }; @@ -101,7 +107,8 @@ service FeaturestoreService { } // Creates a new EntityType in a given Featurestore. - rpc CreateEntityType(CreateEntityTypeRequest) returns (google.longrunning.Operation) { + rpc CreateEntityType(CreateEntityTypeRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{parent=projects/*/locations/*/featurestores/*}/entityTypes" body: "entity_type" @@ -123,7 +130,8 @@ service FeaturestoreService { } // Lists EntityTypes in a given Featurestore. - rpc ListEntityTypes(ListEntityTypesRequest) returns (ListEntityTypesResponse) { + rpc ListEntityTypes(ListEntityTypesRequest) + returns (ListEntityTypesResponse) { option (google.api.http) = { get: "/v1/{parent=projects/*/locations/*/featurestores/*}/entityTypes" }; @@ -141,7 +149,8 @@ service FeaturestoreService { // Deletes a single EntityType. The EntityType must not have any Features // or `force` must be set to true for the request to succeed. - rpc DeleteEntityType(DeleteEntityTypeRequest) returns (google.longrunning.Operation) { + rpc DeleteEntityType(DeleteEntityTypeRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1/{name=projects/*/locations/*/featurestores/*/entityTypes/*}" }; @@ -154,7 +163,8 @@ service FeaturestoreService { } // Creates a new Feature in a given EntityType. - rpc CreateFeature(CreateFeatureRequest) returns (google.longrunning.Operation) { + rpc CreateFeature(CreateFeatureRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{parent=projects/*/locations/*/featurestores/*/entityTypes/*}/features" body: "feature" @@ -168,7 +178,8 @@ service FeaturestoreService { } // Creates a batch of Features in a given EntityType. - rpc BatchCreateFeatures(BatchCreateFeaturesRequest) returns (google.longrunning.Operation) { + rpc BatchCreateFeatures(BatchCreateFeaturesRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{parent=projects/*/locations/*/featurestores/*/entityTypes/*}/features:batchCreate" body: "*" @@ -206,7 +217,8 @@ service FeaturestoreService { } // Deletes a single Feature. - rpc DeleteFeature(DeleteFeatureRequest) returns (google.longrunning.Operation) { + rpc DeleteFeature(DeleteFeatureRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1/{name=projects/*/locations/*/featurestores/*/entityTypes/*/features/*}" }; @@ -237,7 +249,8 @@ service FeaturestoreService { // include but are not limited to changing storage location, storage class, // or retention policy. // - Online serving cluster is under-provisioned. - rpc ImportFeatureValues(ImportFeatureValuesRequest) returns (google.longrunning.Operation) { + rpc ImportFeatureValues(ImportFeatureValuesRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{entity_type=projects/*/locations/*/featurestores/*/entityTypes/*}:importFeatureValues" body: "*" @@ -255,7 +268,8 @@ service FeaturestoreService { // 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. - rpc BatchReadFeatureValues(BatchReadFeatureValuesRequest) returns (google.longrunning.Operation) { + rpc BatchReadFeatureValues(BatchReadFeatureValuesRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{featurestore=projects/*/locations/*/featurestores/*}:batchReadFeatureValues" body: "*" @@ -268,7 +282,8 @@ service FeaturestoreService { } // Exports Feature values from all the entities of a target EntityType. - rpc ExportFeatureValues(ExportFeatureValuesRequest) returns (google.longrunning.Operation) { + rpc ExportFeatureValues(ExportFeatureValuesRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{entity_type=projects/*/locations/*/featurestores/*/entityTypes/*}:exportFeatureValues" body: "*" @@ -290,7 +305,8 @@ service FeaturestoreService { } } -// Request message for [FeaturestoreService.CreateFeaturestore][google.cloud.aiplatform.v1.FeaturestoreService.CreateFeaturestore]. +// Request message for +// [FeaturestoreService.CreateFeaturestore][google.cloud.aiplatform.v1.FeaturestoreService.CreateFeaturestore]. message CreateFeaturestoreRequest { // Required. The resource name of the Location to create Featurestores. // Format: @@ -305,8 +321,8 @@ message CreateFeaturestoreRequest { // Required. The Featurestore to create. Featurestore featurestore = 2 [(google.api.field_behavior) = REQUIRED]; - // Required. The ID to use for this Featurestore, which will become the final component - // of the Featurestore's resource name. + // Required. The ID to use for this Featurestore, which will become the final + // component of the Featurestore's resource name. // // This value may be up to 60 characters, and valid characters are // `[a-z0-9_]`. The first character cannot be a number. @@ -315,7 +331,8 @@ message CreateFeaturestoreRequest { string featurestore_id = 3 [(google.api.field_behavior) = REQUIRED]; } -// Request message for [FeaturestoreService.GetFeaturestore][google.cloud.aiplatform.v1.FeaturestoreService.GetFeaturestore]. +// Request message for +// [FeaturestoreService.GetFeaturestore][google.cloud.aiplatform.v1.FeaturestoreService.GetFeaturestore]. message GetFeaturestoreRequest { // Required. The name of the Featurestore resource. string name = 1 [ @@ -326,7 +343,8 @@ message GetFeaturestoreRequest { ]; } -// Request message for [FeaturestoreService.ListFeaturestores][google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores]. +// Request message for +// [FeaturestoreService.ListFeaturestores][google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores]. message ListFeaturestoresRequest { // Required. The resource name of the Location to list Featurestores. // Format: @@ -366,12 +384,12 @@ message ListFeaturestoresRequest { int32 page_size = 3; // A page token, received from a previous - // [FeaturestoreService.ListFeaturestores][google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores] call. - // Provide this to retrieve the subsequent page. + // [FeaturestoreService.ListFeaturestores][google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores] + // call. Provide this to retrieve the subsequent page. // // When paginating, all other parameters provided to - // [FeaturestoreService.ListFeaturestores][google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores] must - // match the call that provided the page token. + // [FeaturestoreService.ListFeaturestores][google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores] + // must match the call that provided the page token. string page_token = 4; // A comma-separated list of fields to order by, sorted in ascending order. @@ -387,22 +405,24 @@ message ListFeaturestoresRequest { google.protobuf.FieldMask read_mask = 6; } -// Response message for [FeaturestoreService.ListFeaturestores][google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores]. +// Response message for +// [FeaturestoreService.ListFeaturestores][google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores]. message ListFeaturestoresResponse { // The Featurestores matching the request. repeated Featurestore featurestores = 1; - // A token, which can be sent as [ListFeaturestoresRequest.page_token][google.cloud.aiplatform.v1.ListFeaturestoresRequest.page_token] to - // retrieve the next page. - // If this field is omitted, there are no subsequent pages. + // A token, which can be sent as + // [ListFeaturestoresRequest.page_token][google.cloud.aiplatform.v1.ListFeaturestoresRequest.page_token] + // to retrieve the next page. If this field is omitted, there are no + // subsequent pages. string next_page_token = 2; } -// Request message for [FeaturestoreService.UpdateFeaturestore][google.cloud.aiplatform.v1.FeaturestoreService.UpdateFeaturestore]. +// Request message for +// [FeaturestoreService.UpdateFeaturestore][google.cloud.aiplatform.v1.FeaturestoreService.UpdateFeaturestore]. message UpdateFeaturestoreRequest { - // Required. The Featurestore's `name` field is used to identify the Featurestore to be - // updated. - // Format: + // Required. The Featurestore's `name` field is used to identify the + // Featurestore to be updated. Format: // `projects/{project}/locations/{location}/featurestores/{featurestore}` Featurestore featurestore = 1 [(google.api.field_behavior) = REQUIRED]; @@ -419,10 +439,12 @@ message UpdateFeaturestoreRequest { // * `labels` // * `online_serving_config.fixed_node_count` // * `online_serving_config.scaling` + // * `online_storage_ttl_days` (available in Preview) google.protobuf.FieldMask update_mask = 2; } -// Request message for [FeaturestoreService.DeleteFeaturestore][google.cloud.aiplatform.v1.FeaturestoreService.DeleteFeaturestore]. +// Request message for +// [FeaturestoreService.DeleteFeaturestore][google.cloud.aiplatform.v1.FeaturestoreService.DeleteFeaturestore]. message DeleteFeaturestoreRequest { // Required. The name of the Featurestore to be deleted. // Format: @@ -440,12 +462,13 @@ message DeleteFeaturestoreRequest { bool force = 2; } -// Request message for [FeaturestoreService.ImportFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.ImportFeatureValues]. +// Request message for +// [FeaturestoreService.ImportFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.ImportFeatureValues]. message ImportFeatureValuesRequest { // Defines the Feature value(s) to import. message FeatureSpec { - // Required. ID of the Feature to import values of. This Feature must exist in the - // target EntityType, or the request will fail. + // Required. ID of the Feature to import values of. This Feature must exist + // in the target EntityType, or the request will fail. string id = 1 [(google.api.field_behavior) = REQUIRED]; // Source column to get the Feature values from. If not set, uses the column @@ -475,8 +498,8 @@ message ImportFeatureValuesRequest { google.protobuf.Timestamp feature_time = 7; } - // Required. The resource name of the EntityType grouping the Features for which values - // are being imported. Format: + // Required. The resource name of the EntityType grouping the Features for + // which values are being imported. Format: // `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}` string entity_type = 1 [ (google.api.field_behavior) = REQUIRED, @@ -489,10 +512,11 @@ message ImportFeatureValuesRequest { // extracted from the column named `entity_id`. string entity_id_field = 5; - // Required. Specifications defining which Feature values to import from the entity. The - // request fails if no feature_specs are provided, and having multiple - // feature_specs for one Feature is not allowed. - repeated FeatureSpec feature_specs = 8 [(google.api.field_behavior) = REQUIRED]; + // Required. Specifications defining which Feature values to import from the + // entity. The request fails if no feature_specs are provided, and having + // multiple feature_specs for one Feature is not allowed. + repeated FeatureSpec feature_specs = 8 + [(google.api.field_behavior) = REQUIRED]; // If set, data will not be imported for online serving. This // is typically used for backfilling, where Feature generation timestamps are @@ -511,7 +535,8 @@ message ImportFeatureValuesRequest { bool disable_ingestion_analysis = 12; } -// Response message for [FeaturestoreService.ImportFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.ImportFeatureValues]. +// Response message for +// [FeaturestoreService.ImportFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.ImportFeatureValues]. message ImportFeatureValuesResponse { // Number of entities that have been imported by the operation. int64 imported_entity_count = 1; @@ -531,25 +556,30 @@ message ImportFeatureValuesResponse { int64 timestamp_outside_retention_rows_count = 4; } -// Request message for [FeaturestoreService.BatchReadFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.BatchReadFeatureValues]. +// Request message for +// [FeaturestoreService.BatchReadFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.BatchReadFeatureValues]. message BatchReadFeatureValuesRequest { // Describe pass-through fields in read_instance source. message PassThroughField { - // Required. The name of the field in the CSV header or the name of the column in - // BigQuery table. The naming restriction is the same as [Feature.name][google.cloud.aiplatform.v1.Feature.name]. + // Required. The name of the field in the CSV header or the name of the + // column in BigQuery table. The naming restriction is the same as + // [Feature.name][google.cloud.aiplatform.v1.Feature.name]. string field_name = 1 [(google.api.field_behavior) = REQUIRED]; } // Selects Features of an EntityType to read values of and specifies read // settings. message EntityTypeSpec { - // Required. ID of the EntityType to select Features. The EntityType id is the - // [entity_type_id][google.cloud.aiplatform.v1.CreateEntityTypeRequest.entity_type_id] specified - // during EntityType creation. + // Required. ID of the EntityType to select Features. The EntityType id is + // the + // [entity_type_id][google.cloud.aiplatform.v1.CreateEntityTypeRequest.entity_type_id] + // specified during EntityType creation. string entity_type_id = 1 [(google.api.field_behavior) = REQUIRED]; - // Required. Selectors choosing which Feature values to read from the EntityType. - FeatureSelector feature_selector = 2 [(google.api.field_behavior) = REQUIRED]; + // Required. Selectors choosing which Feature values to read from the + // EntityType. + FeatureSelector feature_selector = 2 + [(google.api.field_behavior) = REQUIRED]; // Per-Feature settings for the batch read. repeated DestinationFeatureSetting settings = 3; @@ -586,8 +616,8 @@ message BatchReadFeatureValuesRequest { BigQuerySource bigquery_read_instances = 5; } - // Required. The resource name of the Featurestore from which to query Feature values. - // Format: + // Required. The resource name of the Featurestore from which to query Feature + // values. Format: // `projects/{project}/locations/{location}/featurestores/{featurestore}` string featurestore = 1 [ (google.api.field_behavior) = REQUIRED, @@ -597,7 +627,8 @@ message BatchReadFeatureValuesRequest { ]; // Required. Specifies output location and format. - FeatureValueDestination destination = 4 [(google.api.field_behavior) = REQUIRED]; + FeatureValueDestination destination = 4 + [(google.api.field_behavior) = REQUIRED]; // When not empty, the specified fields in the *_read_instances source will be // joined as-is in the output, in addition to those fields from the @@ -608,15 +639,23 @@ message BatchReadFeatureValuesRequest { // passed as opaque bytes. repeated PassThroughField pass_through_fields = 8; - // Required. Specifies EntityType grouping Features to read values of and settings. - // Each EntityType referenced in + // Required. Specifies EntityType grouping Features to read values of and + // settings. Each EntityType referenced in // [BatchReadFeatureValuesRequest.entity_type_specs] must have a column // specifying entity IDs in the EntityType in // [BatchReadFeatureValuesRequest.request][] . - repeated EntityTypeSpec entity_type_specs = 7 [(google.api.field_behavior) = REQUIRED]; + repeated EntityTypeSpec entity_type_specs = 7 + [(google.api.field_behavior) = REQUIRED]; + + // Optional. Excludes Feature values with feature generation timestamp before + // this timestamp. If not set, retrieve oldest values kept in Feature Store. + // Timestamp, if present, must not have higher than millisecond precision. + google.protobuf.Timestamp start_time = 11 + [(google.api.field_behavior) = OPTIONAL]; } -// Request message for [FeaturestoreService.ExportFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.ExportFeatureValues]. +// Request message for +// [FeaturestoreService.ExportFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.ExportFeatureValues]. message ExportFeatureValuesRequest { // Describes exporting the latest Feature values of all entities of the // EntityType between [start_time, snapshot_time]. @@ -657,8 +696,8 @@ message ExportFeatureValuesRequest { FullExport full_export = 7; } - // Required. The resource name of the EntityType from which to export Feature values. - // Format: + // Required. The resource name of the EntityType from which to export Feature + // values. Format: // `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` string entity_type = 1 [ (google.api.field_behavior) = REQUIRED, @@ -668,7 +707,8 @@ message ExportFeatureValuesRequest { ]; // Required. Specifies destination location and format. - FeatureValueDestination destination = 4 [(google.api.field_behavior) = REQUIRED]; + FeatureValueDestination destination = 4 + [(google.api.field_behavior) = REQUIRED]; // Required. Selects Features to export values of. FeatureSelector feature_selector = 5 [(google.api.field_behavior) = REQUIRED]; @@ -690,8 +730,10 @@ message DestinationFeatureSetting { message FeatureValueDestination { oneof destination { // Output in BigQuery format. - // [BigQueryDestination.output_uri][google.cloud.aiplatform.v1.BigQueryDestination.output_uri] in - // [FeatureValueDestination.bigquery_destination][google.cloud.aiplatform.v1.FeatureValueDestination.bigquery_destination] must refer to a table. + // [BigQueryDestination.output_uri][google.cloud.aiplatform.v1.BigQueryDestination.output_uri] + // in + // [FeatureValueDestination.bigquery_destination][google.cloud.aiplatform.v1.FeatureValueDestination.bigquery_destination] + // must refer to a table. BigQueryDestination bigquery_destination = 1; // Output in TFRecord format. @@ -713,17 +755,16 @@ message FeatureValueDestination { } } -// Response message for [FeaturestoreService.ExportFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.ExportFeatureValues]. -message ExportFeatureValuesResponse { +// Response message for +// [FeaturestoreService.ExportFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.ExportFeatureValues]. +message ExportFeatureValuesResponse {} -} - -// Response message for [FeaturestoreService.BatchReadFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.BatchReadFeatureValues]. -message BatchReadFeatureValuesResponse { +// Response message for +// [FeaturestoreService.BatchReadFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.BatchReadFeatureValues]. +message BatchReadFeatureValuesResponse {} -} - -// Request message for [FeaturestoreService.CreateEntityType][google.cloud.aiplatform.v1.FeaturestoreService.CreateEntityType]. +// Request message for +// [FeaturestoreService.CreateEntityType][google.cloud.aiplatform.v1.FeaturestoreService.CreateEntityType]. message CreateEntityTypeRequest { // Required. The resource name of the Featurestore to create EntityTypes. // Format: @@ -738,8 +779,8 @@ message CreateEntityTypeRequest { // The EntityType to create. EntityType entity_type = 2; - // Required. The ID to use for the EntityType, which will become the final component of - // the EntityType's resource name. + // Required. The ID to use for the EntityType, which will become the final + // component of the EntityType's resource name. // // This value may be up to 60 characters, and valid characters are // `[a-z0-9_]`. The first character cannot be a number. @@ -748,7 +789,8 @@ message CreateEntityTypeRequest { string entity_type_id = 3 [(google.api.field_behavior) = REQUIRED]; } -// Request message for [FeaturestoreService.GetEntityType][google.cloud.aiplatform.v1.FeaturestoreService.GetEntityType]. +// Request message for +// [FeaturestoreService.GetEntityType][google.cloud.aiplatform.v1.FeaturestoreService.GetEntityType]. message GetEntityTypeRequest { // Required. The name of the EntityType resource. // Format: @@ -761,7 +803,8 @@ message GetEntityTypeRequest { ]; } -// Request message for [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes]. +// Request message for +// [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes]. message ListEntityTypesRequest { // Required. The resource name of the Featurestore to list EntityTypes. // Format: @@ -800,12 +843,12 @@ message ListEntityTypesRequest { int32 page_size = 3; // A page token, received from a previous - // [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes] call. - // Provide this to retrieve the subsequent page. + // [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes] + // call. Provide this to retrieve the subsequent page. // // When paginating, all other parameters provided to - // [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes] must - // match the call that provided the page token. + // [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes] + // must match the call that provided the page token. string page_token = 4; // A comma-separated list of fields to order by, sorted in ascending order. @@ -822,22 +865,24 @@ message ListEntityTypesRequest { google.protobuf.FieldMask read_mask = 6; } -// Response message for [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes]. +// Response message for +// [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes]. message ListEntityTypesResponse { // The EntityTypes matching the request. repeated EntityType entity_types = 1; - // A token, which can be sent as [ListEntityTypesRequest.page_token][google.cloud.aiplatform.v1.ListEntityTypesRequest.page_token] to - // retrieve the next page. - // If this field is omitted, there are no subsequent pages. + // A token, which can be sent as + // [ListEntityTypesRequest.page_token][google.cloud.aiplatform.v1.ListEntityTypesRequest.page_token] + // to retrieve the next page. If this field is omitted, there are no + // subsequent pages. string next_page_token = 2; } -// Request message for [FeaturestoreService.UpdateEntityType][google.cloud.aiplatform.v1.FeaturestoreService.UpdateEntityType]. +// Request message for +// [FeaturestoreService.UpdateEntityType][google.cloud.aiplatform.v1.FeaturestoreService.UpdateEntityType]. message UpdateEntityTypeRequest { - // Required. The EntityType's `name` field is used to identify the EntityType to be - // updated. - // Format: + // Required. The EntityType's `name` field is used to identify the EntityType + // to be updated. Format: // `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` EntityType entity_type = 1 [(google.api.field_behavior) = REQUIRED]; @@ -860,6 +905,7 @@ message UpdateEntityTypeRequest { // * `monitoring_config.import_features_analysis.anomaly_detection_baseline` // * `monitoring_config.numerical_threshold_config.value` // * `monitoring_config.categorical_threshold_config.value` + // * `offline_storage_ttl_days` (available in Preview) google.protobuf.FieldMask update_mask = 2; } @@ -880,7 +926,8 @@ message DeleteEntityTypeRequest { bool force = 2; } -// Request message for [FeaturestoreService.CreateFeature][google.cloud.aiplatform.v1.FeaturestoreService.CreateFeature]. +// Request message for +// [FeaturestoreService.CreateFeature][google.cloud.aiplatform.v1.FeaturestoreService.CreateFeature]. message CreateFeatureRequest { // Required. The resource name of the EntityType to create a Feature. // Format: @@ -895,20 +942,21 @@ message CreateFeatureRequest { // Required. The Feature to create. Feature feature = 2 [(google.api.field_behavior) = REQUIRED]; - // Required. The ID to use for the Feature, which will become the final component of - // the Feature's resource name. + // Required. The ID to use for the Feature, which will become the final + // component of the Feature's resource name. // - // This value may be up to 60 characters, and valid characters are + // This value may be up to 128 characters, and valid characters are // `[a-z0-9_]`. The first character cannot be a number. // // The value must be unique within an EntityType. string feature_id = 3 [(google.api.field_behavior) = REQUIRED]; } -// Request message for [FeaturestoreService.BatchCreateFeatures][google.cloud.aiplatform.v1.FeaturestoreService.BatchCreateFeatures]. +// Request message for +// [FeaturestoreService.BatchCreateFeatures][google.cloud.aiplatform.v1.FeaturestoreService.BatchCreateFeatures]. message BatchCreateFeaturesRequest { - // Required. The resource name of the EntityType to create the batch of Features under. - // Format: + // Required. The resource name of the EntityType to create the batch of + // Features under. Format: // `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, @@ -917,20 +965,24 @@ message BatchCreateFeaturesRequest { } ]; - // Required. The request message specifying the Features to create. All Features must be - // created under the same parent EntityType. The `parent` field in each child - // request message can be omitted. If `parent` is set in a child request, then - // the value must match the `parent` value in this request message. - repeated CreateFeatureRequest requests = 2 [(google.api.field_behavior) = REQUIRED]; + // Required. The request message specifying the Features to create. All + // Features must be created under the same parent EntityType. The `parent` + // field in each child request message can be omitted. If `parent` is set in a + // child request, then the value must match the `parent` value in this request + // message. + repeated CreateFeatureRequest requests = 2 + [(google.api.field_behavior) = REQUIRED]; } -// Response message for [FeaturestoreService.BatchCreateFeatures][google.cloud.aiplatform.v1.FeaturestoreService.BatchCreateFeatures]. +// Response message for +// [FeaturestoreService.BatchCreateFeatures][google.cloud.aiplatform.v1.FeaturestoreService.BatchCreateFeatures]. message BatchCreateFeaturesResponse { // The Features created. repeated Feature features = 1; } -// Request message for [FeaturestoreService.GetFeature][google.cloud.aiplatform.v1.FeaturestoreService.GetFeature]. +// Request message for +// [FeaturestoreService.GetFeature][google.cloud.aiplatform.v1.FeaturestoreService.GetFeature]. message GetFeatureRequest { // Required. The name of the Feature resource. // Format: @@ -943,7 +995,8 @@ message GetFeatureRequest { ]; } -// Request message for [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures]. +// Request message for +// [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures]. message ListFeaturesRequest { // Required. The resource name of the Location to list Features. // Format: @@ -984,12 +1037,12 @@ message ListFeaturesRequest { int32 page_size = 3; // A page token, received from a previous - // [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures] call. - // Provide this to retrieve the subsequent page. + // [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures] + // call. Provide this to retrieve the subsequent page. // // When paginating, all other parameters provided to - // [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures] must - // match the call that provided the page token. + // [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures] + // must match the call that provided the page token. string page_token = 4; // A comma-separated list of fields to order by, sorted in ascending order. @@ -1005,25 +1058,30 @@ message ListFeaturesRequest { // Mask specifying which fields to read. google.protobuf.FieldMask read_mask = 6; - // If set, return the most recent [ListFeaturesRequest.latest_stats_count][google.cloud.aiplatform.v1.ListFeaturesRequest.latest_stats_count] + // If set, return the most recent + // [ListFeaturesRequest.latest_stats_count][google.cloud.aiplatform.v1.ListFeaturesRequest.latest_stats_count] // of stats for each Feature in response. Valid value is [0, 10]. If number of - // stats exists < [ListFeaturesRequest.latest_stats_count][google.cloud.aiplatform.v1.ListFeaturesRequest.latest_stats_count], return all - // existing stats. + // stats exists < + // [ListFeaturesRequest.latest_stats_count][google.cloud.aiplatform.v1.ListFeaturesRequest.latest_stats_count], + // return all existing stats. int32 latest_stats_count = 7; } -// Response message for [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures]. +// Response message for +// [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures]. message ListFeaturesResponse { // The Features matching the request. repeated Feature features = 1; - // A token, which can be sent as [ListFeaturesRequest.page_token][google.cloud.aiplatform.v1.ListFeaturesRequest.page_token] to - // retrieve the next page. - // If this field is omitted, there are no subsequent pages. + // A token, which can be sent as + // [ListFeaturesRequest.page_token][google.cloud.aiplatform.v1.ListFeaturesRequest.page_token] + // to retrieve the next page. If this field is omitted, there are no + // subsequent pages. string next_page_token = 2; } -// Request message for [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures]. +// Request message for +// [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures]. message SearchFeaturesRequest { // Required. The resource name of the Location to search Features. // Format: @@ -1103,16 +1161,17 @@ message SearchFeaturesRequest { int32 page_size = 4; // A page token, received from a previous - // [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures] call. - // Provide this to retrieve the subsequent page. + // [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures] + // call. Provide this to retrieve the subsequent page. // // When paginating, all other parameters provided to - // [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures], except `page_size`, must - // match the call that provided the page token. + // [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures], + // except `page_size`, must match the call that provided the page token. string page_token = 5; } -// Response message for [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures]. +// Response message for +// [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures]. message SearchFeaturesResponse { // The Features matching the request. // @@ -1125,13 +1184,15 @@ message SearchFeaturesResponse { // * `update_time` repeated Feature features = 1; - // A token, which can be sent as [SearchFeaturesRequest.page_token][google.cloud.aiplatform.v1.SearchFeaturesRequest.page_token] to - // retrieve the next page. - // If this field is omitted, there are no subsequent pages. + // A token, which can be sent as + // [SearchFeaturesRequest.page_token][google.cloud.aiplatform.v1.SearchFeaturesRequest.page_token] + // to retrieve the next page. If this field is omitted, there are no + // subsequent pages. string next_page_token = 2; } -// Request message for [FeaturestoreService.UpdateFeature][google.cloud.aiplatform.v1.FeaturestoreService.UpdateFeature]. +// Request message for +// [FeaturestoreService.UpdateFeature][google.cloud.aiplatform.v1.FeaturestoreService.UpdateFeature]. message UpdateFeatureRequest { // Required. The Feature's `name` field is used to identify the Feature to be // updated. @@ -1155,7 +1216,8 @@ message UpdateFeatureRequest { google.protobuf.FieldMask update_mask = 2; } -// Request message for [FeaturestoreService.DeleteFeature][google.cloud.aiplatform.v1.FeaturestoreService.DeleteFeature]. +// Request message for +// [FeaturestoreService.DeleteFeature][google.cloud.aiplatform.v1.FeaturestoreService.DeleteFeature]. message DeleteFeatureRequest { // Required. The name of the Features to be deleted. // Format: @@ -1191,6 +1253,9 @@ message ImportFeatureValuesOperationMetadata { // Number of Feature values that have been imported by the operation. int64 imported_feature_value_count = 3; + // The source URI from where Feature values are imported. + repeated string source_uris = 4; + // The number of rows in input source that weren't imported due to either // * Not having any featureValues. // * Having a null entityId. diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/hyperparameter_tuning_job.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/hyperparameter_tuning_job.proto index dfe173dcc7a..0178d6d53f6 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/hyperparameter_tuning_job.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/hyperparameter_tuning_job.proto @@ -46,7 +46,7 @@ message HyperparameterTuningJob { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. The display name of the HyperparameterTuningJob. - // The name can be up to 128 characters long and can be consist of any UTF-8 + // The name can be up to 128 characters long and can consist of any UTF-8 // characters. string display_name = 2 [(google.api.field_behavior) = REQUIRED]; @@ -66,8 +66,8 @@ message HyperparameterTuningJob { // before the whole job fails. int32 max_failed_trial_count = 7; - // Required. The spec of a trial job. The same spec applies to the CustomJobs created - // in all the trials. + // Required. The spec of a trial job. The same spec applies to the CustomJobs + // created in all the trials. CustomJobSpec trial_job_spec = 8 [(google.api.field_behavior) = REQUIRED]; // Output only. Trials of the HyperparameterTuningJob. @@ -77,18 +77,24 @@ message HyperparameterTuningJob { JobState state = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Time when the HyperparameterTuningJob was created. - google.protobuf.Timestamp create_time = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. Time when the HyperparameterTuningJob for the first time entered the - // `JOB_STATE_RUNNING` state. - google.protobuf.Timestamp start_time = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. Time when the HyperparameterTuningJob entered any of the following states: - // `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`. - google.protobuf.Timestamp end_time = 13 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. Time when the HyperparameterTuningJob was most recently updated. - google.protobuf.Timestamp update_time = 14 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 11 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Time when the HyperparameterTuningJob for the first time + // entered the `JOB_STATE_RUNNING` state. + google.protobuf.Timestamp start_time = 12 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Time when the HyperparameterTuningJob entered any of the + // following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, + // `JOB_STATE_CANCELLED`. + google.protobuf.Timestamp end_time = 13 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Time when the HyperparameterTuningJob was most recently + // updated. + google.protobuf.Timestamp update_time = 14 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Only populated when job's state is JOB_STATE_FAILED or // JOB_STATE_CANCELLED. diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/index.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/index.proto index 69fde66a709..c50e5d48f8c 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/index.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/index.proto @@ -57,17 +57,17 @@ message Index { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. The display name of the Index. - // The name can be up to 128 characters long and can be consist of any UTF-8 + // The name can be up to 128 characters long and can consist of any UTF-8 // characters. string display_name = 2 [(google.api.field_behavior) = REQUIRED]; // The description of the Index. string description = 3; - // Immutable. Points to a YAML file stored on Google Cloud Storage describing additional - // information about the Index, that is specific to it. Unset if the Index - // does not have any additional information. - // The schema is defined as an OpenAPI 3.0.2 [Schema + // Immutable. Points to a YAML file stored on Google Cloud Storage describing + // additional information about the Index, that is specific to it. Unset if + // the Index does not have any additional information. The schema is defined + // as an OpenAPI 3.0.2 [Schema // Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). // Note: The URI given on output will be immutable and probably different, // including the URI scheme, than the one given on input. The output URI will @@ -75,13 +75,15 @@ message Index { string metadata_schema_uri = 4 [(google.api.field_behavior) = IMMUTABLE]; // An additional information about the Index; the schema of the metadata can - // be found in [metadata_schema][google.cloud.aiplatform.v1.Index.metadata_schema_uri]. + // be found in + // [metadata_schema][google.cloud.aiplatform.v1.Index.metadata_schema_uri]. google.protobuf.Value metadata = 6; // Output only. The pointers to DeployedIndexes created from this Index. // An Index can be only deleted if all its DeployedIndexes had been undeployed // first. - repeated DeployedIndexRef deployed_indexes = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + repeated DeployedIndexRef deployed_indexes = 7 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Used to perform consistent read-modify-write updates. If not set, a blind // "overwrite" update happens. @@ -97,24 +99,27 @@ message Index { map labels = 9; // Output only. Timestamp when this Index was created. - google.protobuf.Timestamp create_time = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 10 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this Index was most recently updated. // This also includes any update to the contents of the Index. // Note that Operations working on this Index may have their // [Operations.metadata.generic_metadata.update_time] - // [google.cloud.aiplatform.v1.GenericOperationMetadata.update_time] a little after the value of this - // timestamp, yet that does not mean their results are not already reflected - // in the Index. Result of any successfully completed Operation on the Index - // is reflected in it. - google.protobuf.Timestamp update_time = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; + // [google.cloud.aiplatform.v1.GenericOperationMetadata.update_time] a little + // after the value of this timestamp, yet that does not mean their results are + // not already reflected in the Index. Result of any successfully completed + // Operation on the Index is reflected in it. + google.protobuf.Timestamp update_time = 11 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Stats of the index resource. IndexStats index_stats = 14 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be - // used by default. - IndexUpdateMethod index_update_method = 16 [(google.api.field_behavior) = IMMUTABLE]; + // Immutable. The update method to use with this Index. If not set, + // BATCH_UPDATE will be used by default. + IndexUpdateMethod index_update_method = 16 + [(google.api.field_behavior) = IMMUTABLE]; } // A datapoint of Index. @@ -151,14 +156,14 @@ message IndexDatapoint { // [NearestNeighborSearchConfig.dimensions]. repeated float feature_vector = 2 [(google.api.field_behavior) = REQUIRED]; - // Optional. List of Restrict of the datapoint, used to perform "restricted searches" - // where boolean rule are used to filter the subset of the database eligible - // for matching. - // See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering + // Optional. List of Restrict of the datapoint, used to perform "restricted + // searches" where boolean rule are used to filter the subset of the database + // eligible for matching. See: + // https://cloud.google.com/vertex-ai/docs/matching-engine/filtering repeated Restriction restricts = 4 [(google.api.field_behavior) = OPTIONAL]; - // Optional. CrowdingTag of the datapoint, the number of neighbors to return in each - // crowding can be configured during query. + // Optional. CrowdingTag of the datapoint, the number of neighbors to return + // in each crowding can be configured during query. CrowdingTag crowding_tag = 5 [(google.api.field_behavior) = OPTIONAL]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/index_endpoint.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/index_endpoint.proto index 9f1e9941bde..8aed1b0f557 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/index_endpoint.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/index_endpoint.proto @@ -49,7 +49,8 @@ message IndexEndpoint { string description = 3; // Output only. The indexes deployed in this endpoint. - repeated DeployedIndex deployed_indexes = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + repeated DeployedIndex deployed_indexes = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Used to perform consistent read-modify-write updates. If not set, a blind // "overwrite" update happens. @@ -65,13 +66,15 @@ message IndexEndpoint { map labels = 6; // Output only. Timestamp when this IndexEndpoint was created. - google.protobuf.Timestamp create_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 7 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this IndexEndpoint was last updated. // This timestamp is not updated when the endpoint's DeployedIndexes are // updated, e.g. due to updates of the original Indexes they are the // deployments of. - google.protobuf.Timestamp update_time = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 8 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Optional. The full name of the Google Compute Engine // [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) @@ -85,20 +88,20 @@ message IndexEndpoint { // are mutually exclusive. // // [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): - // projects/{project}/global/networks/{network}. + // `projects/{project}/global/networks/{network}`. // Where {project} is a project number, as in '12345', and {network} is // network name. string network = 9 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Deprecated: If true, expose the IndexEndpoint via private service connect. + // Optional. Deprecated: If true, expose the IndexEndpoint via private service + // connect. // - // Only one of the fields, [network][google.cloud.aiplatform.v1.IndexEndpoint.network] or + // Only one of the fields, + // [network][google.cloud.aiplatform.v1.IndexEndpoint.network] or // [enable_private_service_connect][google.cloud.aiplatform.v1.IndexEndpoint.enable_private_service_connect], // can be set. - bool enable_private_service_connect = 10 [ - deprecated = true, - (google.api.field_behavior) = OPTIONAL - ]; + bool enable_private_service_connect = 10 + [deprecated = true, (google.api.field_behavior) = OPTIONAL]; } // A deployment of an Index. IndexEndpoints contain one or more DeployedIndexes. @@ -123,18 +126,22 @@ message DeployedIndex { string display_name = 3; // Output only. Timestamp when the DeployedIndex was created. - google.protobuf.Timestamp create_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. Provides paths for users to send requests directly to the deployed index - // services running on Cloud via private services access. This field is - // populated if [network][google.cloud.aiplatform.v1.IndexEndpoint.network] is configured. - IndexPrivateEndpoints private_endpoints = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. The DeployedIndex may depend on various data on its original Index. - // Additionally when certain changes to the original Index are being done - // (e.g. when what the Index contains is being changed) the DeployedIndex may - // be asynchronously updated in the background to reflect this changes. - // If this timestamp's value is at least the [Index.update_time][google.cloud.aiplatform.v1.Index.update_time] of the + google.protobuf.Timestamp create_time = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Provides paths for users to send requests directly to the + // deployed index services running on Cloud via private services access. This + // field is populated if + // [network][google.cloud.aiplatform.v1.IndexEndpoint.network] is configured. + IndexPrivateEndpoints private_endpoints = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The DeployedIndex may depend on various data on its original + // Index. Additionally when certain changes to the original Index are being + // done (e.g. when what the Index contains is being changed) the DeployedIndex + // may be asynchronously updated in the background to reflect this changes. If + // this timestamp's value is at least the + // [Index.update_time][google.cloud.aiplatform.v1.Index.update_time] of the // original Index, it means that this DeployedIndex and the original Index are // in sync. If this timestamp is older, then to see which updates this // DeployedIndex already contains (and which not), one must @@ -144,30 +151,41 @@ message DeployedIndex { // [Operations.metadata.generic_metadata.update_time] // [google.cloud.aiplatform.v1.GenericOperationMetadata.update_time] // equal or before this sync time are contained in this DeployedIndex. - google.protobuf.Timestamp index_sync_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp index_sync_time = 6 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Optional. A description of resources that the DeployedIndex uses, which to large - // degree are decided by Vertex AI, and optionally allows only a modest + // Optional. A description of resources that the DeployedIndex uses, which to + // large degree are decided by Vertex AI, and optionally allows only a modest // additional configuration. // If min_replica_count is not set, the default value is 2 (we don't provide // SLA when min_replica_count=1). If max_replica_count is not set, the // default value is min_replica_count. The max allowed replica count is // 1000. - AutomaticResources automatic_resources = 7 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. A description of resources that are dedicated to the DeployedIndex, and - // that need a higher degree of manual configuration. - // If min_replica_count is not set, the default value is 2 (we don't provide - // SLA when min_replica_count=1). If max_replica_count is not set, the - // default value is min_replica_count. The max allowed replica count is - // 1000. + AutomaticResources automatic_resources = 7 + [(google.api.field_behavior) = OPTIONAL]; + + // Optional. A description of resources that are dedicated to the + // DeployedIndex, and that need a higher degree of manual configuration. If + // min_replica_count is not set, the default value is 2 (we don't provide SLA + // when min_replica_count=1). If max_replica_count is not set, the default + // value is min_replica_count. The max allowed replica count is 1000. + // + // Available machine types for SMALL shard: + // e2-standard-2 and all machine types available for MEDIUM and LARGE shard. + // + // Available machine types for MEDIUM shard: + // e2-standard-16 and all machine types available for LARGE shard. + // + // Available machine types for LARGE shard: + // e2-standard-32, e2-highmem-16, n2d-standard-32. // - // Available machine types: - // n1-standard-16 - // n1-standard-32 - DedicatedResources dedicated_resources = 16 [(google.api.field_behavior) = OPTIONAL]; + // n1-standard-16 and n1-standard-32 are still available, but we recommend + // e2-standard-16 and e2-standard-32 for cost efficiency. + DedicatedResources dedicated_resources = 16 + [(google.api.field_behavior) = OPTIONAL]; - // Optional. If true, private endpoint's access logs are sent to StackDriver Logging. + // Optional. If true, private endpoint's access logs are sent to StackDriver + // Logging. // // These logs are like standard server access logs, containing // information like timestamp and latency for each MatchRequest. @@ -178,7 +196,8 @@ message DeployedIndex { bool enable_access_logging = 8 [(google.api.field_behavior) = OPTIONAL]; // Optional. If set, the authentication is enabled for the private endpoint. - DeployedIndexAuthConfig deployed_index_auth_config = 9 [(google.api.field_behavior) = OPTIONAL]; + DeployedIndexAuthConfig deployed_index_auth_config = 9 + [(google.api.field_behavior) = OPTIONAL]; // Optional. A list of reserved ip ranges under the VPC network that can be // used for this DeployedIndex. @@ -190,7 +209,8 @@ message DeployedIndex { // The value sohuld be the name of the address // (https://cloud.google.com/compute/docs/reference/rest/v1/addresses) // Example: 'vertex-ai-ip-range'. - repeated string reserved_ip_ranges = 10 [(google.api.field_behavior) = OPTIONAL]; + repeated string reserved_ip_ranges = 10 + [(google.api.field_behavior) = OPTIONAL]; // Optional. The deployment group can be no longer than 64 characters (eg: // 'test', 'prod'). If not set, we will use the 'default' deployment group. @@ -239,7 +259,7 @@ message IndexPrivateEndpoints { // Output only. The ip address used to send match gRPC requests. string match_grpc_address = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. The name of the service attachment resource. Populated if private service - // connect is enabled. + // Output only. The name of the service attachment resource. Populated if + // private service connect is enabled. string service_attachment = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/index_endpoint_service.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/index_endpoint_service.proto index 8acdb5bc631..72dcb7566ca 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/index_endpoint_service.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/index_endpoint_service.proto @@ -36,10 +36,12 @@ option ruby_package = "Google::Cloud::AIPlatform::V1"; // A service for managing Vertex AI's IndexEndpoints. service IndexEndpointService { option (google.api.default_host) = "aiplatform.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/cloud-platform"; // Creates an IndexEndpoint. - rpc CreateIndexEndpoint(CreateIndexEndpointRequest) returns (google.longrunning.Operation) { + rpc CreateIndexEndpoint(CreateIndexEndpointRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{parent=projects/*/locations/*}/indexEndpoints" body: "index_endpoint" @@ -60,7 +62,8 @@ service IndexEndpointService { } // Lists IndexEndpoints in a Location. - rpc ListIndexEndpoints(ListIndexEndpointsRequest) returns (ListIndexEndpointsResponse) { + rpc ListIndexEndpoints(ListIndexEndpointsRequest) + returns (ListIndexEndpointsResponse) { option (google.api.http) = { get: "/v1/{parent=projects/*/locations/*}/indexEndpoints" }; @@ -77,7 +80,8 @@ service IndexEndpointService { } // Deletes an IndexEndpoint. - rpc DeleteIndexEndpoint(DeleteIndexEndpointRequest) returns (google.longrunning.Operation) { + rpc DeleteIndexEndpoint(DeleteIndexEndpointRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1/{name=projects/*/locations/*/indexEndpoints/*}" }; @@ -105,7 +109,8 @@ service IndexEndpointService { // Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, // and freeing all resources it's using. - rpc UndeployIndex(UndeployIndexRequest) returns (google.longrunning.Operation) { + rpc UndeployIndex(UndeployIndexRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{index_endpoint=projects/*/locations/*/indexEndpoints/*}:undeployIndex" body: "*" @@ -118,7 +123,8 @@ service IndexEndpointService { } // Update an existing DeployedIndex under an IndexEndpoint. - rpc MutateDeployedIndex(MutateDeployedIndexRequest) returns (google.longrunning.Operation) { + rpc MutateDeployedIndex(MutateDeployedIndexRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{index_endpoint=projects/*/locations/*/indexEndpoints/*}:mutateDeployedIndex" body: "deployed_index" @@ -131,7 +137,8 @@ service IndexEndpointService { } } -// Request message for [IndexEndpointService.CreateIndexEndpoint][google.cloud.aiplatform.v1.IndexEndpointService.CreateIndexEndpoint]. +// Request message for +// [IndexEndpointService.CreateIndexEndpoint][google.cloud.aiplatform.v1.IndexEndpointService.CreateIndexEndpoint]. message CreateIndexEndpointRequest { // Required. The resource name of the Location to create the IndexEndpoint in. // Format: `projects/{project}/locations/{location}` @@ -153,7 +160,8 @@ message CreateIndexEndpointOperationMetadata { GenericOperationMetadata generic_metadata = 1; } -// Request message for [IndexEndpointService.GetIndexEndpoint][google.cloud.aiplatform.v1.IndexEndpointService.GetIndexEndpoint] +// Request message for +// [IndexEndpointService.GetIndexEndpoint][google.cloud.aiplatform.v1.IndexEndpointService.GetIndexEndpoint] message GetIndexEndpointRequest { // Required. The name of the IndexEndpoint resource. // Format: @@ -166,10 +174,11 @@ message GetIndexEndpointRequest { ]; } -// Request message for [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints]. +// Request message for +// [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints]. message ListIndexEndpointsRequest { - // Required. The resource name of the Location from which to list the IndexEndpoints. - // Format: `projects/{project}/locations/{location}` + // Required. The resource name of the Location from which to list the + // IndexEndpoints. Format: `projects/{project}/locations/{location}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -177,8 +186,8 @@ message ListIndexEndpointsRequest { } ]; - // Optional. An expression for filtering the results of the request. For field names - // both snake_case and camelCase are supported. + // Optional. An expression for filtering the results of the request. For field + // names both snake_case and camelCase are supported. // // * `index_endpoint` supports = and !=. `index_endpoint` represents the // IndexEndpoint ID, ie. the last segment of the IndexEndpoint's @@ -202,34 +211,44 @@ message ListIndexEndpointsRequest { // Optional. The standard list page token. // Typically obtained via - // [ListIndexEndpointsResponse.next_page_token][google.cloud.aiplatform.v1.ListIndexEndpointsResponse.next_page_token] of the previous - // [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints] call. + // [ListIndexEndpointsResponse.next_page_token][google.cloud.aiplatform.v1.ListIndexEndpointsResponse.next_page_token] + // of the previous + // [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints] + // call. string page_token = 4 [(google.api.field_behavior) = OPTIONAL]; // Optional. Mask specifying which fields to read. - google.protobuf.FieldMask read_mask = 5 [(google.api.field_behavior) = OPTIONAL]; + google.protobuf.FieldMask read_mask = 5 + [(google.api.field_behavior) = OPTIONAL]; } -// Response message for [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints]. +// Response message for +// [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints]. message ListIndexEndpointsResponse { // List of IndexEndpoints in the requested page. repeated IndexEndpoint index_endpoints = 1; // A token to retrieve next page of results. - // Pass to [ListIndexEndpointsRequest.page_token][google.cloud.aiplatform.v1.ListIndexEndpointsRequest.page_token] to obtain that page. + // Pass to + // [ListIndexEndpointsRequest.page_token][google.cloud.aiplatform.v1.ListIndexEndpointsRequest.page_token] + // to obtain that page. string next_page_token = 2; } -// Request message for [IndexEndpointService.UpdateIndexEndpoint][google.cloud.aiplatform.v1.IndexEndpointService.UpdateIndexEndpoint]. +// Request message for +// [IndexEndpointService.UpdateIndexEndpoint][google.cloud.aiplatform.v1.IndexEndpointService.UpdateIndexEndpoint]. message UpdateIndexEndpointRequest { // Required. The IndexEndpoint which replaces the resource on the server. IndexEndpoint index_endpoint = 1 [(google.api.field_behavior) = REQUIRED]; - // Required. The update mask applies to the resource. See [google.protobuf.FieldMask][google.protobuf.FieldMask]. - google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED]; + // Required. The update mask applies to the resource. See + // [google.protobuf.FieldMask][google.protobuf.FieldMask]. + google.protobuf.FieldMask update_mask = 2 + [(google.api.field_behavior) = REQUIRED]; } -// Request message for [IndexEndpointService.DeleteIndexEndpoint][google.cloud.aiplatform.v1.IndexEndpointService.DeleteIndexEndpoint]. +// Request message for +// [IndexEndpointService.DeleteIndexEndpoint][google.cloud.aiplatform.v1.IndexEndpointService.DeleteIndexEndpoint]. message DeleteIndexEndpointRequest { // Required. The name of the IndexEndpoint resource to be deleted. // Format: @@ -242,10 +261,11 @@ message DeleteIndexEndpointRequest { ]; } -// Request message for [IndexEndpointService.DeployIndex][google.cloud.aiplatform.v1.IndexEndpointService.DeployIndex]. +// Request message for +// [IndexEndpointService.DeployIndex][google.cloud.aiplatform.v1.IndexEndpointService.DeployIndex]. message DeployIndexRequest { - // Required. The name of the IndexEndpoint resource into which to deploy an Index. - // Format: + // Required. The name of the IndexEndpoint resource into which to deploy an + // Index. Format: // `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}` string index_endpoint = 1 [ (google.api.field_behavior) = REQUIRED, @@ -258,13 +278,15 @@ message DeployIndexRequest { DeployedIndex deployed_index = 2 [(google.api.field_behavior) = REQUIRED]; } -// Response message for [IndexEndpointService.DeployIndex][google.cloud.aiplatform.v1.IndexEndpointService.DeployIndex]. +// Response message for +// [IndexEndpointService.DeployIndex][google.cloud.aiplatform.v1.IndexEndpointService.DeployIndex]. message DeployIndexResponse { // The DeployedIndex that had been deployed in the IndexEndpoint. DeployedIndex deployed_index = 1; } -// Runtime operation information for [IndexEndpointService.DeployIndex][google.cloud.aiplatform.v1.IndexEndpointService.DeployIndex]. +// Runtime operation information for +// [IndexEndpointService.DeployIndex][google.cloud.aiplatform.v1.IndexEndpointService.DeployIndex]. message DeployIndexOperationMetadata { // The operation generic information. GenericOperationMetadata generic_metadata = 1; @@ -273,10 +295,11 @@ message DeployIndexOperationMetadata { string deployed_index_id = 2; } -// Request message for [IndexEndpointService.UndeployIndex][google.cloud.aiplatform.v1.IndexEndpointService.UndeployIndex]. +// Request message for +// [IndexEndpointService.UndeployIndex][google.cloud.aiplatform.v1.IndexEndpointService.UndeployIndex]. message UndeployIndexRequest { - // Required. The name of the IndexEndpoint resource from which to undeploy an Index. - // Format: + // Required. The name of the IndexEndpoint resource from which to undeploy an + // Index. Format: // `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}` string index_endpoint = 1 [ (google.api.field_behavior) = REQUIRED, @@ -285,25 +308,27 @@ message UndeployIndexRequest { } ]; - // Required. The ID of the DeployedIndex to be undeployed from the IndexEndpoint. + // Required. The ID of the DeployedIndex to be undeployed from the + // IndexEndpoint. string deployed_index_id = 2 [(google.api.field_behavior) = REQUIRED]; } -// Response message for [IndexEndpointService.UndeployIndex][google.cloud.aiplatform.v1.IndexEndpointService.UndeployIndex]. -message UndeployIndexResponse { +// Response message for +// [IndexEndpointService.UndeployIndex][google.cloud.aiplatform.v1.IndexEndpointService.UndeployIndex]. +message UndeployIndexResponse {} -} - -// Runtime operation information for [IndexEndpointService.UndeployIndex][google.cloud.aiplatform.v1.IndexEndpointService.UndeployIndex]. +// Runtime operation information for +// [IndexEndpointService.UndeployIndex][google.cloud.aiplatform.v1.IndexEndpointService.UndeployIndex]. message UndeployIndexOperationMetadata { // The operation generic information. GenericOperationMetadata generic_metadata = 1; } -// Request message for [IndexEndpointService.MutateDeployedIndex][google.cloud.aiplatform.v1.IndexEndpointService.MutateDeployedIndex]. +// Request message for +// [IndexEndpointService.MutateDeployedIndex][google.cloud.aiplatform.v1.IndexEndpointService.MutateDeployedIndex]. message MutateDeployedIndexRequest { - // Required. The name of the IndexEndpoint resource into which to deploy an Index. - // Format: + // Required. The name of the IndexEndpoint resource into which to deploy an + // Index. Format: // `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}` string index_endpoint = 1 [ (google.api.field_behavior) = REQUIRED, @@ -318,7 +343,8 @@ message MutateDeployedIndexRequest { DeployedIndex deployed_index = 2 [(google.api.field_behavior) = REQUIRED]; } -// Response message for [IndexEndpointService.MutateDeployedIndex][google.cloud.aiplatform.v1.IndexEndpointService.MutateDeployedIndex]. +// Response message for +// [IndexEndpointService.MutateDeployedIndex][google.cloud.aiplatform.v1.IndexEndpointService.MutateDeployedIndex]. message MutateDeployedIndexResponse { // The DeployedIndex that had been updated in the IndexEndpoint. DeployedIndex deployed_index = 1; diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/index_service.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/index_service.proto index 0f6c632567b..bf323fa2b86 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/index_service.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/index_service.proto @@ -36,7 +36,8 @@ option ruby_package = "Google::Cloud::AIPlatform::V1"; // A service for creating and managing Vertex AI's Index resources. service IndexService { option (google.api.default_host) = "aiplatform.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/cloud-platform"; // Creates an Index. rpc CreateIndex(CreateIndexRequest) returns (google.longrunning.Operation) { @@ -82,7 +83,8 @@ service IndexService { // Deletes an Index. // An Index can only be deleted when all its - // [DeployedIndexes][google.cloud.aiplatform.v1.Index.deployed_indexes] had been undeployed. + // [DeployedIndexes][google.cloud.aiplatform.v1.Index.deployed_indexes] had + // been undeployed. rpc DeleteIndex(DeleteIndexRequest) returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1/{name=projects/*/locations/*/indexes/*}" @@ -95,7 +97,8 @@ service IndexService { } // Add/update Datapoints into an Index. - rpc UpsertDatapoints(UpsertDatapointsRequest) returns (UpsertDatapointsResponse) { + rpc UpsertDatapoints(UpsertDatapointsRequest) + returns (UpsertDatapointsResponse) { option (google.api.http) = { post: "/v1/{index=projects/*/locations/*/indexes/*}:upsertDatapoints" body: "*" @@ -103,7 +106,8 @@ service IndexService { } // Remove Datapoints from an Index. - rpc RemoveDatapoints(RemoveDatapointsRequest) returns (RemoveDatapointsResponse) { + rpc RemoveDatapoints(RemoveDatapointsRequest) + returns (RemoveDatapointsResponse) { option (google.api.http) = { post: "/v1/{index=projects/*/locations/*/indexes/*}:removeDatapoints" body: "*" @@ -111,7 +115,8 @@ service IndexService { } } -// Request message for [IndexService.CreateIndex][google.cloud.aiplatform.v1.IndexService.CreateIndex]. +// Request message for +// [IndexService.CreateIndex][google.cloud.aiplatform.v1.IndexService.CreateIndex]. message CreateIndexRequest { // Required. The resource name of the Location to create the Index in. // Format: `projects/{project}/locations/{location}` @@ -126,16 +131,19 @@ message CreateIndexRequest { Index index = 2 [(google.api.field_behavior) = REQUIRED]; } -// Runtime operation information for [IndexService.CreateIndex][google.cloud.aiplatform.v1.IndexService.CreateIndex]. +// Runtime operation information for +// [IndexService.CreateIndex][google.cloud.aiplatform.v1.IndexService.CreateIndex]. message CreateIndexOperationMetadata { // The operation generic information. GenericOperationMetadata generic_metadata = 1; // The operation metadata with regard to Matching Engine Index operation. - NearestNeighborSearchOperationMetadata nearest_neighbor_search_operation_metadata = 2; + NearestNeighborSearchOperationMetadata + nearest_neighbor_search_operation_metadata = 2; } -// Request message for [IndexService.GetIndex][google.cloud.aiplatform.v1.IndexService.GetIndex] +// Request message for +// [IndexService.GetIndex][google.cloud.aiplatform.v1.IndexService.GetIndex] message GetIndexRequest { // Required. The name of the Index resource. // Format: @@ -148,7 +156,8 @@ message GetIndexRequest { ]; } -// Request message for [IndexService.ListIndexes][google.cloud.aiplatform.v1.IndexService.ListIndexes]. +// Request message for +// [IndexService.ListIndexes][google.cloud.aiplatform.v1.IndexService.ListIndexes]. message ListIndexesRequest { // Required. The resource name of the Location from which to list the Indexes. // Format: `projects/{project}/locations/{location}` @@ -167,44 +176,54 @@ message ListIndexesRequest { // The standard list page token. // Typically obtained via - // [ListIndexesResponse.next_page_token][google.cloud.aiplatform.v1.ListIndexesResponse.next_page_token] of the previous - // [IndexService.ListIndexes][google.cloud.aiplatform.v1.IndexService.ListIndexes] call. + // [ListIndexesResponse.next_page_token][google.cloud.aiplatform.v1.ListIndexesResponse.next_page_token] + // of the previous + // [IndexService.ListIndexes][google.cloud.aiplatform.v1.IndexService.ListIndexes] + // call. string page_token = 4; // Mask specifying which fields to read. google.protobuf.FieldMask read_mask = 5; } -// Response message for [IndexService.ListIndexes][google.cloud.aiplatform.v1.IndexService.ListIndexes]. +// Response message for +// [IndexService.ListIndexes][google.cloud.aiplatform.v1.IndexService.ListIndexes]. message ListIndexesResponse { // List of indexes in the requested page. repeated Index indexes = 1; // A token to retrieve next page of results. - // Pass to [ListIndexesRequest.page_token][google.cloud.aiplatform.v1.ListIndexesRequest.page_token] to obtain that page. + // Pass to + // [ListIndexesRequest.page_token][google.cloud.aiplatform.v1.ListIndexesRequest.page_token] + // to obtain that page. string next_page_token = 2; } -// Request message for [IndexService.UpdateIndex][google.cloud.aiplatform.v1.IndexService.UpdateIndex]. +// Request message for +// [IndexService.UpdateIndex][google.cloud.aiplatform.v1.IndexService.UpdateIndex]. message UpdateIndexRequest { // Required. The Index which updates the resource on the server. Index index = 1 [(google.api.field_behavior) = REQUIRED]; // The update mask applies to the resource. - // For the `FieldMask` definition, see [google.protobuf.FieldMask][google.protobuf.FieldMask]. + // For the `FieldMask` definition, see + // [google.protobuf.FieldMask][google.protobuf.FieldMask]. google.protobuf.FieldMask update_mask = 2; } -// Runtime operation information for [IndexService.UpdateIndex][google.cloud.aiplatform.v1.IndexService.UpdateIndex]. +// Runtime operation information for +// [IndexService.UpdateIndex][google.cloud.aiplatform.v1.IndexService.UpdateIndex]. message UpdateIndexOperationMetadata { // The operation generic information. GenericOperationMetadata generic_metadata = 1; // The operation metadata with regard to Matching Engine Index operation. - NearestNeighborSearchOperationMetadata nearest_neighbor_search_operation_metadata = 2; + NearestNeighborSearchOperationMetadata + nearest_neighbor_search_operation_metadata = 2; } -// Request message for [IndexService.DeleteIndex][google.cloud.aiplatform.v1.IndexService.DeleteIndex]. +// Request message for +// [IndexService.DeleteIndex][google.cloud.aiplatform.v1.IndexService.DeleteIndex]. message DeleteIndexRequest { // Required. The name of the Index resource to be deleted. // Format: @@ -217,7 +236,8 @@ message DeleteIndexRequest { ]; } -// Request message for [IndexService.UpsertDatapoints][google.cloud.aiplatform.v1.IndexService.UpsertDatapoints] +// Request message for +// [IndexService.UpsertDatapoints][google.cloud.aiplatform.v1.IndexService.UpsertDatapoints] message UpsertDatapointsRequest { // Required. The name of the Index resource to be updated. // Format: @@ -233,12 +253,12 @@ message UpsertDatapointsRequest { repeated IndexDatapoint datapoints = 2; } -// Response message for [IndexService.UpsertDatapoints][google.cloud.aiplatform.v1.IndexService.UpsertDatapoints] -message UpsertDatapointsResponse { +// Response message for +// [IndexService.UpsertDatapoints][google.cloud.aiplatform.v1.IndexService.UpsertDatapoints] +message UpsertDatapointsResponse {} -} - -// Request message for [IndexService.RemoveDatapoints][google.cloud.aiplatform.v1.IndexService.RemoveDatapoints] +// Request message for +// [IndexService.RemoveDatapoints][google.cloud.aiplatform.v1.IndexService.RemoveDatapoints] message RemoveDatapointsRequest { // Required. The name of the Index resource to be updated. // Format: @@ -254,10 +274,9 @@ message RemoveDatapointsRequest { repeated string datapoint_ids = 2; } -// Response message for [IndexService.RemoveDatapoints][google.cloud.aiplatform.v1.IndexService.RemoveDatapoints] -message RemoveDatapointsResponse { - -} +// Response message for +// [IndexService.RemoveDatapoints][google.cloud.aiplatform.v1.IndexService.RemoveDatapoints] +message RemoveDatapointsResponse {} // Runtime operation metadata with regard to Matching Engine Index. message NearestNeighborSearchOperationMetadata { @@ -325,7 +344,8 @@ message NearestNeighborSearchOperationMetadata { // The validation stats of the content (per file) to be inserted or // updated on the Matching Engine Index resource. Populated if - // contentsDeltaUri is provided as part of [Index.metadata][google.cloud.aiplatform.v1.Index.metadata]. Please note + // contentsDeltaUri is provided as part of + // [Index.metadata][google.cloud.aiplatform.v1.Index.metadata]. Please note // that, currently for those files that are broken or has unsupported file // format, we will not have the stats for those files. repeated ContentValidationStats content_validation_stats = 1; diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/io.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/io.proto index 43d5fdc6305..676c3a891fd 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/io.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/io.proto @@ -48,7 +48,8 @@ message GcsSource { // The Google Cloud Storage location where the output is to be written to. message GcsDestination { - // Required. Google Cloud Storage URI to output directory. If the uri doesn't end with + // Required. Google Cloud Storage URI to output directory. If the uri doesn't + // end with // '/', a '/' will be automatically appended. The directory is created if it // doesn't exist. string output_uri_prefix = 1 [(google.api.field_behavior) = REQUIRED]; diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/job_service.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/job_service.proto index 7e987dfde5b..cf4abe14947 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/job_service.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/job_service.proto @@ -42,7 +42,8 @@ option ruby_package = "Google::Cloud::AIPlatform::V1"; // A service for creating and managing Vertex AI's jobs. service JobService { option (google.api.default_host) = "aiplatform.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/cloud-platform"; // Creates a CustomJob. A created CustomJob right away // will be attempted to be run. @@ -71,7 +72,8 @@ service JobService { } // Deletes a CustomJob. - rpc DeleteCustomJob(DeleteCustomJobRequest) returns (google.longrunning.Operation) { + rpc DeleteCustomJob(DeleteCustomJobRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1/{name=projects/*/locations/*/customJobs/*}" }; @@ -85,12 +87,15 @@ service JobService { // 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 + // 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 + // 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`. rpc CancelCustomJob(CancelCustomJobRequest) returns (google.protobuf.Empty) { option (google.api.http) = { @@ -101,7 +106,8 @@ service JobService { } // Creates a DataLabelingJob. - rpc CreateDataLabelingJob(CreateDataLabelingJobRequest) returns (DataLabelingJob) { + rpc CreateDataLabelingJob(CreateDataLabelingJobRequest) + returns (DataLabelingJob) { option (google.api.http) = { post: "/v1/{parent=projects/*/locations/*}/dataLabelingJobs" body: "data_labeling_job" @@ -118,7 +124,8 @@ service JobService { } // Lists DataLabelingJobs in a Location. - rpc ListDataLabelingJobs(ListDataLabelingJobsRequest) returns (ListDataLabelingJobsResponse) { + rpc ListDataLabelingJobs(ListDataLabelingJobsRequest) + returns (ListDataLabelingJobsResponse) { option (google.api.http) = { get: "/v1/{parent=projects/*/locations/*}/dataLabelingJobs" }; @@ -126,7 +133,8 @@ service JobService { } // Deletes a DataLabelingJob. - rpc DeleteDataLabelingJob(DeleteDataLabelingJobRequest) returns (google.longrunning.Operation) { + rpc DeleteDataLabelingJob(DeleteDataLabelingJobRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1/{name=projects/*/locations/*/dataLabelingJobs/*}" }; @@ -138,7 +146,8 @@ service JobService { } // Cancels a DataLabelingJob. Success of cancellation is not guaranteed. - rpc CancelDataLabelingJob(CancelDataLabelingJobRequest) returns (google.protobuf.Empty) { + rpc CancelDataLabelingJob(CancelDataLabelingJobRequest) + returns (google.protobuf.Empty) { option (google.api.http) = { post: "/v1/{name=projects/*/locations/*/dataLabelingJobs/*}:cancel" body: "*" @@ -147,7 +156,8 @@ service JobService { } // Creates a HyperparameterTuningJob - rpc CreateHyperparameterTuningJob(CreateHyperparameterTuningJobRequest) returns (HyperparameterTuningJob) { + rpc CreateHyperparameterTuningJob(CreateHyperparameterTuningJobRequest) + returns (HyperparameterTuningJob) { option (google.api.http) = { post: "/v1/{parent=projects/*/locations/*}/hyperparameterTuningJobs" body: "hyperparameter_tuning_job" @@ -156,7 +166,8 @@ service JobService { } // Gets a HyperparameterTuningJob - rpc GetHyperparameterTuningJob(GetHyperparameterTuningJobRequest) returns (HyperparameterTuningJob) { + rpc GetHyperparameterTuningJob(GetHyperparameterTuningJobRequest) + returns (HyperparameterTuningJob) { option (google.api.http) = { get: "/v1/{name=projects/*/locations/*/hyperparameterTuningJobs/*}" }; @@ -164,7 +175,8 @@ service JobService { } // Lists HyperparameterTuningJobs in a Location. - rpc ListHyperparameterTuningJobs(ListHyperparameterTuningJobsRequest) returns (ListHyperparameterTuningJobsResponse) { + rpc ListHyperparameterTuningJobs(ListHyperparameterTuningJobsRequest) + returns (ListHyperparameterTuningJobsResponse) { option (google.api.http) = { get: "/v1/{parent=projects/*/locations/*}/hyperparameterTuningJobs" }; @@ -172,7 +184,8 @@ service JobService { } // Deletes a HyperparameterTuningJob. - rpc DeleteHyperparameterTuningJob(DeleteHyperparameterTuningJobRequest) returns (google.longrunning.Operation) { + rpc DeleteHyperparameterTuningJob(DeleteHyperparameterTuningJobRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1/{name=projects/*/locations/*/hyperparameterTuningJobs/*}" }; @@ -186,14 +199,19 @@ service JobService { // 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 + // 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`. - rpc CancelHyperparameterTuningJob(CancelHyperparameterTuningJobRequest) returns (google.protobuf.Empty) { + // 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`. + rpc CancelHyperparameterTuningJob(CancelHyperparameterTuningJobRequest) + returns (google.protobuf.Empty) { option (google.api.http) = { post: "/v1/{name=projects/*/locations/*/hyperparameterTuningJobs/*}:cancel" body: "*" @@ -203,7 +221,8 @@ service JobService { // Creates a BatchPredictionJob. A BatchPredictionJob once created will // right away be attempted to start. - rpc CreateBatchPredictionJob(CreateBatchPredictionJobRequest) returns (BatchPredictionJob) { + rpc CreateBatchPredictionJob(CreateBatchPredictionJobRequest) + returns (BatchPredictionJob) { option (google.api.http) = { post: "/v1/{parent=projects/*/locations/*}/batchPredictionJobs" body: "batch_prediction_job" @@ -212,7 +231,8 @@ service JobService { } // Gets a BatchPredictionJob - rpc GetBatchPredictionJob(GetBatchPredictionJobRequest) returns (BatchPredictionJob) { + rpc GetBatchPredictionJob(GetBatchPredictionJobRequest) + returns (BatchPredictionJob) { option (google.api.http) = { get: "/v1/{name=projects/*/locations/*/batchPredictionJobs/*}" }; @@ -220,7 +240,8 @@ service JobService { } // Lists BatchPredictionJobs in a Location. - rpc ListBatchPredictionJobs(ListBatchPredictionJobsRequest) returns (ListBatchPredictionJobsResponse) { + rpc ListBatchPredictionJobs(ListBatchPredictionJobsRequest) + returns (ListBatchPredictionJobsResponse) { option (google.api.http) = { get: "/v1/{parent=projects/*/locations/*}/batchPredictionJobs" }; @@ -229,7 +250,8 @@ service JobService { // Deletes a BatchPredictionJob. Can only be called on jobs that already // finished. - rpc DeleteBatchPredictionJob(DeleteBatchPredictionJobRequest) returns (google.longrunning.Operation) { + rpc DeleteBatchPredictionJob(DeleteBatchPredictionJobRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1/{name=projects/*/locations/*/batchPredictionJobs/*}" }; @@ -244,13 +266,16 @@ service JobService { // // 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 + // 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. - rpc CancelBatchPredictionJob(CancelBatchPredictionJobRequest) returns (google.protobuf.Empty) { + // [BatchPredictionJob.state][google.cloud.aiplatform.v1.BatchPredictionJob.state] + // is set to `CANCELLED`. Any files already outputted by the job are not + // deleted. + rpc CancelBatchPredictionJob(CancelBatchPredictionJobRequest) + returns (google.protobuf.Empty) { option (google.api.http) = { post: "/v1/{name=projects/*/locations/*/batchPredictionJobs/*}:cancel" body: "*" @@ -260,25 +285,32 @@ service JobService { // Creates a ModelDeploymentMonitoringJob. It will run periodically on a // configured interval. - rpc CreateModelDeploymentMonitoringJob(CreateModelDeploymentMonitoringJobRequest) returns (ModelDeploymentMonitoringJob) { + rpc CreateModelDeploymentMonitoringJob( + CreateModelDeploymentMonitoringJobRequest) + returns (ModelDeploymentMonitoringJob) { option (google.api.http) = { post: "/v1/{parent=projects/*/locations/*}/modelDeploymentMonitoringJobs" body: "model_deployment_monitoring_job" }; - option (google.api.method_signature) = "parent,model_deployment_monitoring_job"; + option (google.api.method_signature) = + "parent,model_deployment_monitoring_job"; } // Searches Model Monitoring Statistics generated within a given time window. - rpc SearchModelDeploymentMonitoringStatsAnomalies(SearchModelDeploymentMonitoringStatsAnomaliesRequest) returns (SearchModelDeploymentMonitoringStatsAnomaliesResponse) { + rpc SearchModelDeploymentMonitoringStatsAnomalies( + SearchModelDeploymentMonitoringStatsAnomaliesRequest) + returns (SearchModelDeploymentMonitoringStatsAnomaliesResponse) { option (google.api.http) = { post: "/v1/{model_deployment_monitoring_job=projects/*/locations/*/modelDeploymentMonitoringJobs/*}:searchModelDeploymentMonitoringStatsAnomalies" body: "*" }; - option (google.api.method_signature) = "model_deployment_monitoring_job,deployed_model_id"; + option (google.api.method_signature) = + "model_deployment_monitoring_job,deployed_model_id"; } // Gets a ModelDeploymentMonitoringJob. - rpc GetModelDeploymentMonitoringJob(GetModelDeploymentMonitoringJobRequest) returns (ModelDeploymentMonitoringJob) { + rpc GetModelDeploymentMonitoringJob(GetModelDeploymentMonitoringJobRequest) + returns (ModelDeploymentMonitoringJob) { option (google.api.http) = { get: "/v1/{name=projects/*/locations/*/modelDeploymentMonitoringJobs/*}" }; @@ -286,7 +318,9 @@ service JobService { } // Lists ModelDeploymentMonitoringJobs in a Location. - rpc ListModelDeploymentMonitoringJobs(ListModelDeploymentMonitoringJobsRequest) returns (ListModelDeploymentMonitoringJobsResponse) { + rpc ListModelDeploymentMonitoringJobs( + ListModelDeploymentMonitoringJobsRequest) + returns (ListModelDeploymentMonitoringJobsResponse) { option (google.api.http) = { get: "/v1/{parent=projects/*/locations/*}/modelDeploymentMonitoringJobs" }; @@ -294,12 +328,15 @@ service JobService { } // Updates a ModelDeploymentMonitoringJob. - rpc UpdateModelDeploymentMonitoringJob(UpdateModelDeploymentMonitoringJobRequest) returns (google.longrunning.Operation) { + rpc UpdateModelDeploymentMonitoringJob( + UpdateModelDeploymentMonitoringJobRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { patch: "/v1/{model_deployment_monitoring_job.name=projects/*/locations/*/modelDeploymentMonitoringJobs/*}" body: "model_deployment_monitoring_job" }; - option (google.api.method_signature) = "model_deployment_monitoring_job,update_mask"; + option (google.api.method_signature) = + "model_deployment_monitoring_job,update_mask"; option (google.longrunning.operation_info) = { response_type: "ModelDeploymentMonitoringJob" metadata_type: "UpdateModelDeploymentMonitoringJobOperationMetadata" @@ -307,7 +344,9 @@ service JobService { } // Deletes a ModelDeploymentMonitoringJob. - rpc DeleteModelDeploymentMonitoringJob(DeleteModelDeploymentMonitoringJobRequest) returns (google.longrunning.Operation) { + rpc DeleteModelDeploymentMonitoringJob( + DeleteModelDeploymentMonitoringJobRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1/{name=projects/*/locations/*/modelDeploymentMonitoringJobs/*}" }; @@ -320,8 +359,11 @@ service JobService { // 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'. - rpc PauseModelDeploymentMonitoringJob(PauseModelDeploymentMonitoringJobRequest) returns (google.protobuf.Empty) { + // [ModelDeploymentMonitoringJob.state][google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob.state] + // to 'PAUSED'. + rpc PauseModelDeploymentMonitoringJob( + PauseModelDeploymentMonitoringJobRequest) + returns (google.protobuf.Empty) { option (google.api.http) = { post: "/v1/{name=projects/*/locations/*/modelDeploymentMonitoringJobs/*}:pause" body: "*" @@ -332,7 +374,9 @@ service JobService { // Resumes a paused ModelDeploymentMonitoringJob. It will start to run from // next scheduled time. A deleted ModelDeploymentMonitoringJob can't be // resumed. - rpc ResumeModelDeploymentMonitoringJob(ResumeModelDeploymentMonitoringJobRequest) returns (google.protobuf.Empty) { + rpc ResumeModelDeploymentMonitoringJob( + ResumeModelDeploymentMonitoringJobRequest) + returns (google.protobuf.Empty) { option (google.api.http) = { post: "/v1/{name=projects/*/locations/*/modelDeploymentMonitoringJobs/*}:resume" body: "*" @@ -341,7 +385,8 @@ service JobService { } } -// Request message for [JobService.CreateCustomJob][google.cloud.aiplatform.v1.JobService.CreateCustomJob]. +// Request message for +// [JobService.CreateCustomJob][google.cloud.aiplatform.v1.JobService.CreateCustomJob]. message CreateCustomJobRequest { // Required. The resource name of the Location to create the CustomJob in. // Format: `projects/{project}/locations/{location}` @@ -356,7 +401,8 @@ message CreateCustomJobRequest { CustomJob custom_job = 2 [(google.api.field_behavior) = REQUIRED]; } -// Request message for [JobService.GetCustomJob][google.cloud.aiplatform.v1.JobService.GetCustomJob]. +// Request message for +// [JobService.GetCustomJob][google.cloud.aiplatform.v1.JobService.GetCustomJob]. message GetCustomJobRequest { // Required. The name of the CustomJob resource. // Format: @@ -369,7 +415,8 @@ message GetCustomJobRequest { ]; } -// Request message for [JobService.ListCustomJobs][google.cloud.aiplatform.v1.JobService.ListCustomJobs]. +// Request message for +// [JobService.ListCustomJobs][google.cloud.aiplatform.v1.JobService.ListCustomJobs]. message ListCustomJobsRequest { // Required. The resource name of the Location to list the CustomJobs from. // Format: `projects/{project}/locations/{location}` @@ -407,25 +454,31 @@ message ListCustomJobsRequest { // The standard list page token. // Typically obtained via - // [ListCustomJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListCustomJobsResponse.next_page_token] of the previous - // [JobService.ListCustomJobs][google.cloud.aiplatform.v1.JobService.ListCustomJobs] call. + // [ListCustomJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListCustomJobsResponse.next_page_token] + // of the previous + // [JobService.ListCustomJobs][google.cloud.aiplatform.v1.JobService.ListCustomJobs] + // call. string page_token = 4; // Mask specifying which fields to read. google.protobuf.FieldMask read_mask = 5; } -// Response message for [JobService.ListCustomJobs][google.cloud.aiplatform.v1.JobService.ListCustomJobs] +// Response message for +// [JobService.ListCustomJobs][google.cloud.aiplatform.v1.JobService.ListCustomJobs] message ListCustomJobsResponse { // List of CustomJobs in the requested page. repeated CustomJob custom_jobs = 1; // A token to retrieve the next page of results. - // Pass to [ListCustomJobsRequest.page_token][google.cloud.aiplatform.v1.ListCustomJobsRequest.page_token] to obtain that page. + // Pass to + // [ListCustomJobsRequest.page_token][google.cloud.aiplatform.v1.ListCustomJobsRequest.page_token] + // to obtain that page. string next_page_token = 2; } -// Request message for [JobService.DeleteCustomJob][google.cloud.aiplatform.v1.JobService.DeleteCustomJob]. +// Request message for +// [JobService.DeleteCustomJob][google.cloud.aiplatform.v1.JobService.DeleteCustomJob]. message DeleteCustomJobRequest { // Required. The name of the CustomJob resource to be deleted. // Format: @@ -438,7 +491,8 @@ message DeleteCustomJobRequest { ]; } -// Request message for [JobService.CancelCustomJob][google.cloud.aiplatform.v1.JobService.CancelCustomJob]. +// Request message for +// [JobService.CancelCustomJob][google.cloud.aiplatform.v1.JobService.CancelCustomJob]. message CancelCustomJobRequest { // Required. The name of the CustomJob to cancel. // Format: @@ -451,7 +505,8 @@ message CancelCustomJobRequest { ]; } -// Request message for [JobService.CreateDataLabelingJob][google.cloud.aiplatform.v1.JobService.CreateDataLabelingJob]. +// Request message for +// [JobService.CreateDataLabelingJob][google.cloud.aiplatform.v1.JobService.CreateDataLabelingJob]. message CreateDataLabelingJobRequest { // Required. The parent of the DataLabelingJob. // Format: `projects/{project}/locations/{location}` @@ -463,10 +518,12 @@ message CreateDataLabelingJobRequest { ]; // Required. The DataLabelingJob to create. - DataLabelingJob data_labeling_job = 2 [(google.api.field_behavior) = REQUIRED]; + DataLabelingJob data_labeling_job = 2 + [(google.api.field_behavior) = REQUIRED]; } -// Request message for [JobService.GetDataLabelingJob][google.cloud.aiplatform.v1.JobService.GetDataLabelingJob]. +// Request message for +// [JobService.GetDataLabelingJob][google.cloud.aiplatform.v1.JobService.GetDataLabelingJob]. message GetDataLabelingJobRequest { // Required. The name of the DataLabelingJob. // Format: @@ -479,7 +536,8 @@ message GetDataLabelingJobRequest { ]; } -// Request message for [JobService.ListDataLabelingJobs][google.cloud.aiplatform.v1.JobService.ListDataLabelingJobs]. +// Request message for +// [JobService.ListDataLabelingJobs][google.cloud.aiplatform.v1.JobService.ListDataLabelingJobs]. message ListDataLabelingJobsRequest { // Required. The parent of the DataLabelingJob. // Format: `projects/{project}/locations/{location}` @@ -530,7 +588,8 @@ message ListDataLabelingJobsRequest { string order_by = 6; } -// Response message for [JobService.ListDataLabelingJobs][google.cloud.aiplatform.v1.JobService.ListDataLabelingJobs]. +// Response message for +// [JobService.ListDataLabelingJobs][google.cloud.aiplatform.v1.JobService.ListDataLabelingJobs]. message ListDataLabelingJobsResponse { // A list of DataLabelingJobs that matches the specified filter in the // request. @@ -540,7 +599,8 @@ message ListDataLabelingJobsResponse { string next_page_token = 2; } -// Request message for [JobService.DeleteDataLabelingJob][google.cloud.aiplatform.v1.JobService.DeleteDataLabelingJob]. +// Request message for +// [JobService.DeleteDataLabelingJob][google.cloud.aiplatform.v1.JobService.DeleteDataLabelingJob]. message DeleteDataLabelingJobRequest { // Required. The name of the DataLabelingJob to be deleted. // Format: @@ -553,7 +613,8 @@ message DeleteDataLabelingJobRequest { ]; } -// Request message for [JobService.CancelDataLabelingJob][google.cloud.aiplatform.v1.JobService.CancelDataLabelingJob]. +// Request message for +// [JobService.CancelDataLabelingJob][google.cloud.aiplatform.v1.JobService.CancelDataLabelingJob]. message CancelDataLabelingJobRequest { // Required. The name of the DataLabelingJob. // Format: @@ -566,10 +627,12 @@ message CancelDataLabelingJobRequest { ]; } -// Request message for [JobService.CreateHyperparameterTuningJob][google.cloud.aiplatform.v1.JobService.CreateHyperparameterTuningJob]. +// Request message for +// [JobService.CreateHyperparameterTuningJob][google.cloud.aiplatform.v1.JobService.CreateHyperparameterTuningJob]. message CreateHyperparameterTuningJobRequest { - // Required. The resource name of the Location to create the HyperparameterTuningJob in. - // Format: `projects/{project}/locations/{location}` + // Required. The resource name of the Location to create the + // HyperparameterTuningJob in. Format: + // `projects/{project}/locations/{location}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -578,10 +641,12 @@ message CreateHyperparameterTuningJobRequest { ]; // Required. The HyperparameterTuningJob to create. - HyperparameterTuningJob hyperparameter_tuning_job = 2 [(google.api.field_behavior) = REQUIRED]; + HyperparameterTuningJob hyperparameter_tuning_job = 2 + [(google.api.field_behavior) = REQUIRED]; } -// Request message for [JobService.GetHyperparameterTuningJob][google.cloud.aiplatform.v1.JobService.GetHyperparameterTuningJob]. +// Request message for +// [JobService.GetHyperparameterTuningJob][google.cloud.aiplatform.v1.JobService.GetHyperparameterTuningJob]. message GetHyperparameterTuningJobRequest { // Required. The name of the HyperparameterTuningJob resource. // Format: @@ -594,10 +659,12 @@ message GetHyperparameterTuningJobRequest { ]; } -// Request message for [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs]. +// Request message for +// [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs]. message ListHyperparameterTuningJobsRequest { - // Required. The resource name of the Location to list the HyperparameterTuningJobs - // from. Format: `projects/{project}/locations/{location}` + // Required. The resource name of the Location to list the + // HyperparameterTuningJobs from. Format: + // `projects/{project}/locations/{location}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -632,27 +699,33 @@ message ListHyperparameterTuningJobsRequest { // The standard list page token. // Typically obtained via - // [ListHyperparameterTuningJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListHyperparameterTuningJobsResponse.next_page_token] of the previous - // [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs] call. + // [ListHyperparameterTuningJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListHyperparameterTuningJobsResponse.next_page_token] + // of the previous + // [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs] + // call. string page_token = 4; // Mask specifying which fields to read. google.protobuf.FieldMask read_mask = 5; } -// Response message for [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs] +// Response message for +// [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs] message ListHyperparameterTuningJobsResponse { // List of HyperparameterTuningJobs in the requested page. - // [HyperparameterTuningJob.trials][google.cloud.aiplatform.v1.HyperparameterTuningJob.trials] of the jobs will be not be returned. + // [HyperparameterTuningJob.trials][google.cloud.aiplatform.v1.HyperparameterTuningJob.trials] + // of the jobs will be not be returned. repeated HyperparameterTuningJob hyperparameter_tuning_jobs = 1; // A token to retrieve the next page of results. - // Pass to [ListHyperparameterTuningJobsRequest.page_token][google.cloud.aiplatform.v1.ListHyperparameterTuningJobsRequest.page_token] to obtain that - // page. + // Pass to + // [ListHyperparameterTuningJobsRequest.page_token][google.cloud.aiplatform.v1.ListHyperparameterTuningJobsRequest.page_token] + // to obtain that page. string next_page_token = 2; } -// Request message for [JobService.DeleteHyperparameterTuningJob][google.cloud.aiplatform.v1.JobService.DeleteHyperparameterTuningJob]. +// Request message for +// [JobService.DeleteHyperparameterTuningJob][google.cloud.aiplatform.v1.JobService.DeleteHyperparameterTuningJob]. message DeleteHyperparameterTuningJobRequest { // Required. The name of the HyperparameterTuningJob resource to be deleted. // Format: @@ -665,7 +738,8 @@ message DeleteHyperparameterTuningJobRequest { ]; } -// Request message for [JobService.CancelHyperparameterTuningJob][google.cloud.aiplatform.v1.JobService.CancelHyperparameterTuningJob]. +// Request message for +// [JobService.CancelHyperparameterTuningJob][google.cloud.aiplatform.v1.JobService.CancelHyperparameterTuningJob]. message CancelHyperparameterTuningJobRequest { // Required. The name of the HyperparameterTuningJob to cancel. // Format: @@ -678,10 +752,11 @@ message CancelHyperparameterTuningJobRequest { ]; } -// Request message for [JobService.CreateBatchPredictionJob][google.cloud.aiplatform.v1.JobService.CreateBatchPredictionJob]. +// Request message for +// [JobService.CreateBatchPredictionJob][google.cloud.aiplatform.v1.JobService.CreateBatchPredictionJob]. message CreateBatchPredictionJobRequest { - // Required. The resource name of the Location to create the BatchPredictionJob in. - // Format: `projects/{project}/locations/{location}` + // Required. The resource name of the Location to create the + // BatchPredictionJob in. Format: `projects/{project}/locations/{location}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -690,10 +765,12 @@ message CreateBatchPredictionJobRequest { ]; // Required. The BatchPredictionJob to create. - BatchPredictionJob batch_prediction_job = 2 [(google.api.field_behavior) = REQUIRED]; + BatchPredictionJob batch_prediction_job = 2 + [(google.api.field_behavior) = REQUIRED]; } -// Request message for [JobService.GetBatchPredictionJob][google.cloud.aiplatform.v1.JobService.GetBatchPredictionJob]. +// Request message for +// [JobService.GetBatchPredictionJob][google.cloud.aiplatform.v1.JobService.GetBatchPredictionJob]. message GetBatchPredictionJobRequest { // Required. The name of the BatchPredictionJob resource. // Format: @@ -706,7 +783,8 @@ message GetBatchPredictionJobRequest { ]; } -// Request message for [JobService.ListBatchPredictionJobs][google.cloud.aiplatform.v1.JobService.ListBatchPredictionJobs]. +// Request message for +// [JobService.ListBatchPredictionJobs][google.cloud.aiplatform.v1.JobService.ListBatchPredictionJobs]. message ListBatchPredictionJobsRequest { // Required. The resource name of the Location to list the BatchPredictionJobs // from. Format: `projects/{project}/locations/{location}` @@ -745,26 +823,31 @@ message ListBatchPredictionJobsRequest { // The standard list page token. // Typically obtained via - // [ListBatchPredictionJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListBatchPredictionJobsResponse.next_page_token] of the previous - // [JobService.ListBatchPredictionJobs][google.cloud.aiplatform.v1.JobService.ListBatchPredictionJobs] call. + // [ListBatchPredictionJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListBatchPredictionJobsResponse.next_page_token] + // of the previous + // [JobService.ListBatchPredictionJobs][google.cloud.aiplatform.v1.JobService.ListBatchPredictionJobs] + // call. string page_token = 4; // Mask specifying which fields to read. google.protobuf.FieldMask read_mask = 5; } -// Response message for [JobService.ListBatchPredictionJobs][google.cloud.aiplatform.v1.JobService.ListBatchPredictionJobs] +// Response message for +// [JobService.ListBatchPredictionJobs][google.cloud.aiplatform.v1.JobService.ListBatchPredictionJobs] message ListBatchPredictionJobsResponse { // List of BatchPredictionJobs in the requested page. repeated BatchPredictionJob batch_prediction_jobs = 1; // A token to retrieve the next page of results. - // Pass to [ListBatchPredictionJobsRequest.page_token][google.cloud.aiplatform.v1.ListBatchPredictionJobsRequest.page_token] to obtain that - // page. + // Pass to + // [ListBatchPredictionJobsRequest.page_token][google.cloud.aiplatform.v1.ListBatchPredictionJobsRequest.page_token] + // to obtain that page. string next_page_token = 2; } -// Request message for [JobService.DeleteBatchPredictionJob][google.cloud.aiplatform.v1.JobService.DeleteBatchPredictionJob]. +// Request message for +// [JobService.DeleteBatchPredictionJob][google.cloud.aiplatform.v1.JobService.DeleteBatchPredictionJob]. message DeleteBatchPredictionJobRequest { // Required. The name of the BatchPredictionJob resource to be deleted. // Format: @@ -777,7 +860,8 @@ message DeleteBatchPredictionJobRequest { ]; } -// Request message for [JobService.CancelBatchPredictionJob][google.cloud.aiplatform.v1.JobService.CancelBatchPredictionJob]. +// Request message for +// [JobService.CancelBatchPredictionJob][google.cloud.aiplatform.v1.JobService.CancelBatchPredictionJob]. message CancelBatchPredictionJobRequest { // Required. The name of the BatchPredictionJob to cancel. // Format: @@ -803,7 +887,8 @@ message CreateModelDeploymentMonitoringJobRequest { ]; // Required. The ModelDeploymentMonitoringJob to create - ModelDeploymentMonitoringJob model_deployment_monitoring_job = 2 [(google.api.field_behavior) = REQUIRED]; + ModelDeploymentMonitoringJob model_deployment_monitoring_job = 2 + [(google.api.field_behavior) = REQUIRED]; } // Request message for @@ -814,11 +899,12 @@ message SearchModelDeploymentMonitoringStatsAnomaliesRequest { ModelDeploymentMonitoringObjectiveType type = 1; // If set, all attribution scores between - // [SearchModelDeploymentMonitoringStatsAnomaliesRequest.start_time][google.cloud.aiplatform.v1.SearchModelDeploymentMonitoringStatsAnomaliesRequest.start_time] and - // [SearchModelDeploymentMonitoringStatsAnomaliesRequest.end_time][google.cloud.aiplatform.v1.SearchModelDeploymentMonitoringStatsAnomaliesRequest.end_time] are - // fetched, and page token doesn't take affect in this case. - // Only used to retrieve attribution score for the top Features which has - // the highest attribution score in the latest monitoring run. + // [SearchModelDeploymentMonitoringStatsAnomaliesRequest.start_time][google.cloud.aiplatform.v1.SearchModelDeploymentMonitoringStatsAnomaliesRequest.start_time] + // and + // [SearchModelDeploymentMonitoringStatsAnomaliesRequest.end_time][google.cloud.aiplatform.v1.SearchModelDeploymentMonitoringStatsAnomaliesRequest.end_time] + // are fetched, and page token doesn't take effect in this case. Only used + // to retrieve attribution score for the top Features which has the highest + // attribution score in the latest monitoring run. int32 top_feature_count = 4; } @@ -843,7 +929,8 @@ message SearchModelDeploymentMonitoringStatsAnomaliesRequest { string feature_display_name = 3; // Required. Objectives of the stats to retrieve. - repeated StatsAnomaliesObjective objectives = 4 [(google.api.field_behavior) = REQUIRED]; + repeated StatsAnomaliesObjective objectives = 4 + [(google.api.field_behavior) = REQUIRED]; // The standard list page size. int32 page_size = 5; @@ -949,18 +1036,18 @@ message ListModelDeploymentMonitoringJobsResponse { // Request message for // [JobService.UpdateModelDeploymentMonitoringJob][google.cloud.aiplatform.v1.JobService.UpdateModelDeploymentMonitoringJob]. message UpdateModelDeploymentMonitoringJobRequest { - // Required. The model monitoring configuration which replaces the resource on the - // server. - ModelDeploymentMonitoringJob model_deployment_monitoring_job = 1 [(google.api.field_behavior) = REQUIRED]; - - // Required. The update mask is used to specify the fields to be overwritten in the - // ModelDeploymentMonitoringJob resource by the update. - // The fields specified in the update_mask are relative to the resource, not - // the full request. A field will be overwritten if it is in the mask. If the - // user does not provide a mask then only the non-empty fields present in the - // request will be overwritten. Set the update_mask to `*` to override all - // fields. - // For the objective config, the user can either provide the update mask for + // Required. The model monitoring configuration which replaces the resource on + // the server. + ModelDeploymentMonitoringJob model_deployment_monitoring_job = 1 + [(google.api.field_behavior) = REQUIRED]; + + // Required. The update mask is used to specify the fields to be overwritten + // in the ModelDeploymentMonitoringJob resource by the update. The fields + // specified in the update_mask are relative to the resource, not the full + // request. A field will be overwritten if it is in the mask. If the user does + // not provide a mask then only the non-empty fields present in the request + // will be overwritten. Set the update_mask to `*` to override all fields. For + // the objective config, the user can either provide the update mask for // model_deployment_monitoring_objective_configs or any combination of its // nested fields, such as: // model_deployment_monitoring_objective_configs.objective_config.training_dataset. @@ -980,7 +1067,8 @@ message UpdateModelDeploymentMonitoringJobRequest { // * `model_deployment_monitoring_objective_configs.objective_config.training_dataset` // * `model_deployment_monitoring_objective_configs.objective_config.training_prediction_skew_detection_config` // * `model_deployment_monitoring_objective_configs.objective_config.prediction_drift_detection_config` - google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.FieldMask update_mask = 2 + [(google.api.field_behavior) = REQUIRED]; } // Request message for diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/machine_resources.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/machine_resources.proto index 9bcf37c1613..23b93f8e464 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/machine_resources.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/machine_resources.proto @@ -37,14 +37,18 @@ message MachineSpec { // See the [list of machine types supported for custom // training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). // - // For [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] this field is optional, and the default - // value is `n1-standard-2`. For [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob] or as part of - // [WorkerPoolSpec][google.cloud.aiplatform.v1.WorkerPoolSpec] this field is required. + // For [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] this field is + // optional, and the default value is `n1-standard-2`. For + // [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob] or as + // part of [WorkerPoolSpec][google.cloud.aiplatform.v1.WorkerPoolSpec] this + // field is required. string machine_type = 1 [(google.api.field_behavior) = IMMUTABLE]; - // Immutable. The type of accelerator(s) that may be attached to the machine as per + // Immutable. The type of accelerator(s) that may be attached to the machine + // as per // [accelerator_count][google.cloud.aiplatform.v1.MachineSpec.accelerator_count]. - AcceleratorType accelerator_type = 2 [(google.api.field_behavior) = IMMUTABLE]; + AcceleratorType accelerator_type = 2 + [(google.api.field_behavior) = IMMUTABLE]; // The number of accelerators to attach to the machine. int32 accelerator_count = 3; @@ -53,14 +57,16 @@ message MachineSpec { // A description of resources that are dedicated to a DeployedModel, and // that need a higher degree of manual configuration. message DedicatedResources { - // Required. Immutable. The specification of a single machine used by the prediction. + // Required. Immutable. The specification of a single machine used by the + // prediction. MachineSpec machine_spec = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.field_behavior) = IMMUTABLE ]; - // Required. Immutable. The minimum number of machine replicas this DeployedModel will be always - // deployed on. This value must be greater than or equal to 1. + // Required. Immutable. The minimum number of machine replicas this + // DeployedModel will be always deployed on. This value must be greater than + // or equal to 1. // // If traffic against the DeployedModel increases, it may dynamically be // deployed onto more replicas, and as traffic decreases, some of these extra @@ -70,14 +76,15 @@ message DedicatedResources { (google.api.field_behavior) = IMMUTABLE ]; - // Immutable. The maximum number of replicas this DeployedModel may be deployed on when - // the traffic against it increases. If the requested value is too large, - // the deployment will error, but if deployment succeeds then the ability - // to scale the model to that many replicas is guaranteed (barring service - // outages). If traffic against the DeployedModel increases beyond what its - // replicas at maximum may handle, a portion of the traffic will be dropped. - // If this value is not provided, will use [min_replica_count][google.cloud.aiplatform.v1.DedicatedResources.min_replica_count] as the - // default value. + // Immutable. The maximum number of replicas this DeployedModel may be + // deployed on when the traffic against it increases. If the requested value + // is too large, the deployment will error, but if deployment succeeds then + // the ability to scale the model to that many replicas is guaranteed (barring + // service outages). If traffic against the DeployedModel increases beyond + // what its replicas at maximum may handle, a portion of the traffic will be + // dropped. If this value is not provided, will use + // [min_replica_count][google.cloud.aiplatform.v1.DedicatedResources.min_replica_count] + // as the default value. // // The value of this field impacts the charge against Vertex CPU and GPU // quotas. Specifically, you will be charged for (max_replica_count * @@ -90,44 +97,49 @@ message DedicatedResources { // target value (default to 60 if not set). At most one entry is allowed per // metric. // - // If [machine_spec.accelerator_count][google.cloud.aiplatform.v1.MachineSpec.accelerator_count] is - // above 0, the autoscaling will be based on both CPU utilization and + // If + // [machine_spec.accelerator_count][google.cloud.aiplatform.v1.MachineSpec.accelerator_count] + // is above 0, the autoscaling will be based on both CPU utilization and // accelerator's duty cycle metrics and scale up when either metrics exceeds // its target value while scale down if both metrics are under their target // value. The default target value is 60 for both metrics. // - // If [machine_spec.accelerator_count][google.cloud.aiplatform.v1.MachineSpec.accelerator_count] is - // 0, the autoscaling will be based on CPU utilization metric only with + // If + // [machine_spec.accelerator_count][google.cloud.aiplatform.v1.MachineSpec.accelerator_count] + // is 0, the autoscaling will be based on CPU utilization metric only with // default target value 60 if not explicitly set. // // For example, in the case of Online Prediction, if you want to override // target CPU utilization to 80, you should set // [autoscaling_metric_specs.metric_name][google.cloud.aiplatform.v1.AutoscalingMetricSpec.metric_name] // to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and - // [autoscaling_metric_specs.target][google.cloud.aiplatform.v1.AutoscalingMetricSpec.target] to `80`. - repeated AutoscalingMetricSpec autoscaling_metric_specs = 4 [(google.api.field_behavior) = IMMUTABLE]; + // [autoscaling_metric_specs.target][google.cloud.aiplatform.v1.AutoscalingMetricSpec.target] + // to `80`. + repeated AutoscalingMetricSpec autoscaling_metric_specs = 4 + [(google.api.field_behavior) = IMMUTABLE]; } // A description of resources that to large degree are decided by Vertex AI, // and require only a modest additional configuration. // Each Model supporting these resources documents its specific guidelines. message AutomaticResources { - // Immutable. The minimum number of replicas this DeployedModel will be always deployed - // on. If traffic against it increases, it may dynamically be deployed onto - // more replicas up to [max_replica_count][google.cloud.aiplatform.v1.AutomaticResources.max_replica_count], and as traffic decreases, some - // of these extra replicas may be freed. - // If the requested value is too large, the deployment will error. + // Immutable. The minimum number of replicas this DeployedModel will be always + // deployed on. If traffic against it increases, it may dynamically be + // deployed onto more replicas up to + // [max_replica_count][google.cloud.aiplatform.v1.AutomaticResources.max_replica_count], + // and as traffic decreases, some of these extra replicas may be freed. If the + // requested value is too large, the deployment will error. int32 min_replica_count = 1 [(google.api.field_behavior) = IMMUTABLE]; - // Immutable. The maximum number of replicas this DeployedModel may be deployed on when - // the traffic against it increases. If the requested value is too large, - // the deployment will error, but if deployment succeeds then the ability - // to scale the model to that many replicas is guaranteed (barring service - // outages). If traffic against the DeployedModel increases beyond what its - // replicas at maximum may handle, a portion of the traffic will be dropped. - // If this value is not provided, a no upper bound for scaling under heavy - // traffic will be assume, though Vertex AI may be unable to scale beyond - // certain replica number. + // Immutable. The maximum number of replicas this DeployedModel may be + // deployed on when the traffic against it increases. If the requested value + // is too large, the deployment will error, but if deployment succeeds then + // the ability to scale the model to that many replicas is guaranteed (barring + // service outages). If traffic against the DeployedModel increases beyond + // what its replicas at maximum may handle, a portion of the traffic will be + // dropped. If this value is not provided, a no upper bound for scaling under + // heavy traffic will be assume, though Vertex AI may be unable to scale + // beyond certain replica number. int32 max_replica_count = 2 [(google.api.field_behavior) = IMMUTABLE]; } @@ -140,21 +152,21 @@ message BatchDedicatedResources { (google.api.field_behavior) = IMMUTABLE ]; - // Immutable. The number of machine replicas used at the start of the batch operation. - // If not set, Vertex AI decides starting number, not greater than + // Immutable. The number of machine replicas used at the start of the batch + // operation. If not set, Vertex AI decides starting number, not greater than // [max_replica_count][google.cloud.aiplatform.v1.BatchDedicatedResources.max_replica_count] int32 starting_replica_count = 2 [(google.api.field_behavior) = IMMUTABLE]; - // Immutable. The maximum number of machine replicas the batch operation may be scaled - // to. The default value is 10. + // Immutable. The maximum number of machine replicas the batch operation may + // be scaled to. The default value is 10. int32 max_replica_count = 3 [(google.api.field_behavior) = IMMUTABLE]; } // Statistics information about resource consumption. message ResourcesConsumed { - // Output only. The number of replica hours used. Note that many replicas may run in - // parallel, and additionally any given work may be queued for some time. - // Therefore this value is not strictly related to wall time. + // Output only. The number of replica hours used. Note that many replicas may + // run in parallel, and additionally any given work may be queued for some + // time. Therefore this value is not strictly related to wall time. double replica_hours = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; } @@ -179,8 +191,8 @@ message NfsMount { // the source mount path in the form of `server:path` string path = 2 [(google.api.field_behavior) = REQUIRED]; - // Required. Destination mount path. The NFS will be mounted for the user under - // /mnt/nfs/ + // Required. Destination mount path. The NFS will be mounted for the user + // under /mnt/nfs/ string mount_point = 3 [(google.api.field_behavior) = REQUIRED]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/manual_batch_tuning_parameters.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/manual_batch_tuning_parameters.proto index e469d45eb10..a32ccfac66a 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/manual_batch_tuning_parameters.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/manual_batch_tuning_parameters.proto @@ -28,11 +28,11 @@ option ruby_package = "Google::Cloud::AIPlatform::V1"; // Manual batch tuning parameters. message ManualBatchTuningParameters { - // Immutable. The number of the records (e.g. instances) of the operation given in - // each batch to a machine replica. Machine type, and size of a single - // record should be considered when setting this parameter, higher value - // speeds up the batch operation's execution, but too high value will result - // in a whole batch not fitting in a machine's memory, and the whole + // Immutable. The number of the records (e.g. instances) of the operation + // given in each batch to a machine replica. Machine type, and size of a + // single record should be considered when setting this parameter, higher + // value speeds up the batch operation's execution, but too high value will + // result in a whole batch not fitting in a machine's memory, and the whole // operation will fail. // The default value is 64. int32 batch_size = 1 [(google.api.field_behavior) = IMMUTABLE]; diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/metadata_schema.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/metadata_schema.proto index b00a1552979..c82e6e1fb23 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/metadata_schema.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/metadata_schema.proto @@ -58,9 +58,9 @@ message MetadataSchema { // allow to order/compare different versions. Example: 1.0.0, 1.0.1, etc. string schema_version = 2; - // Required. The raw YAML string representation of the MetadataSchema. The combination - // of [MetadataSchema.version] and the schema name given by `title` in - // [MetadataSchema.schema] must be unique within a MetadataStore. + // Required. The raw YAML string representation of the MetadataSchema. The + // combination of [MetadataSchema.version] and the schema name given by + // `title` in [MetadataSchema.schema] must be unique within a MetadataStore. // // The schema is defined as an OpenAPI 3.0.2 // [MetadataSchema @@ -72,7 +72,8 @@ message MetadataSchema { MetadataSchemaType schema_type = 4; // Output only. Timestamp when this MetadataSchema was created. - google.protobuf.Timestamp create_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Description of the Metadata Schema string description = 6; diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/metadata_service.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/metadata_service.proto index e1dd4fcc077..ae10562c152 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/metadata_service.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/metadata_service.proto @@ -42,15 +42,18 @@ option ruby_package = "Google::Cloud::AIPlatform::V1"; // Service for reading and writing metadata entries. service MetadataService { option (google.api.default_host) = "aiplatform.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/cloud-platform"; // Initializes a MetadataStore, including allocation of resources. - rpc CreateMetadataStore(CreateMetadataStoreRequest) returns (google.longrunning.Operation) { + rpc CreateMetadataStore(CreateMetadataStoreRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{parent=projects/*/locations/*}/metadataStores" body: "metadata_store" }; - option (google.api.method_signature) = "parent,metadata_store,metadata_store_id"; + option (google.api.method_signature) = + "parent,metadata_store,metadata_store_id"; option (google.longrunning.operation_info) = { response_type: "MetadataStore" metadata_type: "CreateMetadataStoreOperationMetadata" @@ -66,7 +69,8 @@ service MetadataService { } // Lists MetadataStores for a Location. - rpc ListMetadataStores(ListMetadataStoresRequest) returns (ListMetadataStoresResponse) { + rpc ListMetadataStores(ListMetadataStoresRequest) + returns (ListMetadataStoresResponse) { option (google.api.http) = { get: "/v1/{parent=projects/*/locations/*}/metadataStores" }; @@ -75,7 +79,8 @@ service MetadataService { // Deletes a single MetadataStore and all its child resources (Artifacts, // Executions, and Contexts). - rpc DeleteMetadataStore(DeleteMetadataStoreRequest) returns (google.longrunning.Operation) { + rpc DeleteMetadataStore(DeleteMetadataStoreRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1/{name=projects/*/locations/*/metadataStores/*}" }; @@ -121,7 +126,8 @@ service MetadataService { } // Deletes an Artifact. - rpc DeleteArtifact(DeleteArtifactRequest) returns (google.longrunning.Operation) { + rpc DeleteArtifact(DeleteArtifactRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1/{name=projects/*/locations/*/metadataStores/*/artifacts/*}" }; @@ -133,7 +139,8 @@ service MetadataService { } // Purges Artifacts. - rpc PurgeArtifacts(PurgeArtifactsRequest) returns (google.longrunning.Operation) { + rpc PurgeArtifacts(PurgeArtifactsRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{parent=projects/*/locations/*/metadataStores/*}/artifacts:purge" body: "*" @@ -180,7 +187,8 @@ service MetadataService { } // Deletes a stored Context. - rpc DeleteContext(DeleteContextRequest) returns (google.longrunning.Operation) { + rpc DeleteContext(DeleteContextRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1/{name=projects/*/locations/*/metadataStores/*/contexts/*}" }; @@ -192,7 +200,8 @@ service MetadataService { } // Purges Contexts. - rpc PurgeContexts(PurgeContextsRequest) returns (google.longrunning.Operation) { + rpc PurgeContexts(PurgeContextsRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{parent=projects/*/locations/*/metadataStores/*}/contexts:purge" body: "*" @@ -207,7 +216,8 @@ service MetadataService { // 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. - rpc AddContextArtifactsAndExecutions(AddContextArtifactsAndExecutionsRequest) returns (AddContextArtifactsAndExecutionsResponse) { + rpc AddContextArtifactsAndExecutions(AddContextArtifactsAndExecutionsRequest) + returns (AddContextArtifactsAndExecutionsResponse) { option (google.api.http) = { post: "/v1/{context=projects/*/locations/*/metadataStores/*/contexts/*}:addContextArtifactsAndExecutions" body: "*" @@ -220,7 +230,8 @@ service MetadataService { // 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. - rpc AddContextChildren(AddContextChildrenRequest) returns (AddContextChildrenResponse) { + rpc AddContextChildren(AddContextChildrenRequest) + returns (AddContextChildrenResponse) { option (google.api.http) = { post: "/v1/{context=projects/*/locations/*/metadataStores/*/contexts/*}:addContextChildren" body: "*" @@ -231,7 +242,8 @@ service MetadataService { // Remove a set of children contexts from a parent Context. If any of the // child Contexts were NOT added to the parent Context, they are // simply skipped. - rpc RemoveContextChildren(RemoveContextChildrenRequest) returns (RemoveContextChildrenResponse) { + rpc RemoveContextChildren(RemoveContextChildrenRequest) + returns (RemoveContextChildrenResponse) { option (google.api.http) = { post: "/v1/{context=projects/*/locations/*/metadataStores/*/contexts/*}:removeContextChildren" body: "*" @@ -241,7 +253,8 @@ service MetadataService { // Retrieves Artifacts and Executions within the specified Context, connected // by Event edges and returned as a LineageSubgraph. - rpc QueryContextLineageSubgraph(QueryContextLineageSubgraphRequest) returns (LineageSubgraph) { + rpc QueryContextLineageSubgraph(QueryContextLineageSubgraphRequest) + returns (LineageSubgraph) { option (google.api.http) = { get: "/v1/{context=projects/*/locations/*/metadataStores/*/contexts/*}:queryContextLineageSubgraph" }; @@ -283,7 +296,8 @@ service MetadataService { } // Deletes an Execution. - rpc DeleteExecution(DeleteExecutionRequest) returns (google.longrunning.Operation) { + rpc DeleteExecution(DeleteExecutionRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1/{name=projects/*/locations/*/metadataStores/*/executions/*}" }; @@ -295,7 +309,8 @@ service MetadataService { } // Purges Executions. - rpc PurgeExecutions(PurgeExecutionsRequest) returns (google.longrunning.Operation) { + rpc PurgeExecutions(PurgeExecutionsRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{parent=projects/*/locations/*/metadataStores/*}/executions:purge" body: "*" @@ -311,7 +326,8 @@ service MetadataService { // 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. - rpc AddExecutionEvents(AddExecutionEventsRequest) returns (AddExecutionEventsResponse) { + rpc AddExecutionEvents(AddExecutionEventsRequest) + returns (AddExecutionEventsResponse) { option (google.api.http) = { post: "/v1/{execution=projects/*/locations/*/metadataStores/*/executions/*}:addExecutionEvents" body: "*" @@ -322,7 +338,8 @@ service MetadataService { // Obtains the set of input and output Artifacts for this Execution, in the // form of LineageSubgraph that also contains the Execution and connecting // Events. - rpc QueryExecutionInputsAndOutputs(QueryExecutionInputsAndOutputsRequest) returns (LineageSubgraph) { + rpc QueryExecutionInputsAndOutputs(QueryExecutionInputsAndOutputsRequest) + returns (LineageSubgraph) { option (google.api.http) = { get: "/v1/{execution=projects/*/locations/*/metadataStores/*/executions/*}:queryExecutionInputsAndOutputs" }; @@ -330,12 +347,14 @@ service MetadataService { } // Creates a MetadataSchema. - rpc CreateMetadataSchema(CreateMetadataSchemaRequest) returns (MetadataSchema) { + rpc CreateMetadataSchema(CreateMetadataSchemaRequest) + returns (MetadataSchema) { option (google.api.http) = { post: "/v1/{parent=projects/*/locations/*/metadataStores/*}/metadataSchemas" body: "metadata_schema" }; - option (google.api.method_signature) = "parent,metadata_schema,metadata_schema_id"; + option (google.api.method_signature) = + "parent,metadata_schema,metadata_schema_id"; } // Retrieves a specific MetadataSchema. @@ -347,7 +366,8 @@ service MetadataService { } // Lists MetadataSchemas. - rpc ListMetadataSchemas(ListMetadataSchemasRequest) returns (ListMetadataSchemasResponse) { + rpc ListMetadataSchemas(ListMetadataSchemasRequest) + returns (ListMetadataSchemasResponse) { option (google.api.http) = { get: "/v1/{parent=projects/*/locations/*/metadataStores/*}/metadataSchemas" }; @@ -356,7 +376,8 @@ service MetadataService { // Retrieves lineage of an Artifact represented through Artifacts and // Executions connected by Event edges and returned as a LineageSubgraph. - rpc QueryArtifactLineageSubgraph(QueryArtifactLineageSubgraphRequest) returns (LineageSubgraph) { + rpc QueryArtifactLineageSubgraph(QueryArtifactLineageSubgraphRequest) + returns (LineageSubgraph) { option (google.api.http) = { get: "/v1/{artifact=projects/*/locations/*/metadataStores/*/artifacts/*}:queryArtifactLineageSubgraph" }; @@ -364,7 +385,8 @@ service MetadataService { } } -// Request message for [MetadataService.CreateMetadataStore][google.cloud.aiplatform.v1.MetadataService.CreateMetadataStore]. +// Request message for +// [MetadataService.CreateMetadataStore][google.cloud.aiplatform.v1.MetadataService.CreateMetadataStore]. message CreateMetadataStoreRequest { // Required. The resource name of the Location where the MetadataStore should // be created. @@ -390,13 +412,15 @@ message CreateMetadataStoreRequest { string metadata_store_id = 3; } -// Details of operations that perform [MetadataService.CreateMetadataStore][google.cloud.aiplatform.v1.MetadataService.CreateMetadataStore]. +// Details of operations that perform +// [MetadataService.CreateMetadataStore][google.cloud.aiplatform.v1.MetadataService.CreateMetadataStore]. message CreateMetadataStoreOperationMetadata { // Operation metadata for creating a MetadataStore. GenericOperationMetadata generic_metadata = 1; } -// Request message for [MetadataService.GetMetadataStore][google.cloud.aiplatform.v1.MetadataService.GetMetadataStore]. +// Request message for +// [MetadataService.GetMetadataStore][google.cloud.aiplatform.v1.MetadataService.GetMetadataStore]. message GetMetadataStoreRequest { // Required. The resource name of the MetadataStore to retrieve. // Format: @@ -409,7 +433,8 @@ message GetMetadataStoreRequest { ]; } -// Request message for [MetadataService.ListMetadataStores][google.cloud.aiplatform.v1.MetadataService.ListMetadataStores]. +// Request message for +// [MetadataService.ListMetadataStores][google.cloud.aiplatform.v1.MetadataService.ListMetadataStores]. message ListMetadataStoresRequest { // Required. The Location whose MetadataStores should be listed. // Format: @@ -427,8 +452,8 @@ message ListMetadataStoresRequest { int32 page_size = 2; // A page token, received from a previous - // [MetadataService.ListMetadataStores][google.cloud.aiplatform.v1.MetadataService.ListMetadataStores] call. Provide this to retrieve the - // subsequent page. + // [MetadataService.ListMetadataStores][google.cloud.aiplatform.v1.MetadataService.ListMetadataStores] + // call. Provide this to retrieve the subsequent page. // // When paginating, all other provided parameters must match the call that // provided the page token. (Otherwise the request will fail with @@ -436,18 +461,21 @@ message ListMetadataStoresRequest { string page_token = 3; } -// Response message for [MetadataService.ListMetadataStores][google.cloud.aiplatform.v1.MetadataService.ListMetadataStores]. +// Response message for +// [MetadataService.ListMetadataStores][google.cloud.aiplatform.v1.MetadataService.ListMetadataStores]. message ListMetadataStoresResponse { // The MetadataStores found for the Location. repeated MetadataStore metadata_stores = 1; // A token, which can be sent as - // [ListMetadataStoresRequest.page_token][google.cloud.aiplatform.v1.ListMetadataStoresRequest.page_token] to retrieve the next - // page. If this field is not populated, there are no subsequent pages. + // [ListMetadataStoresRequest.page_token][google.cloud.aiplatform.v1.ListMetadataStoresRequest.page_token] + // to retrieve the next page. If this field is not populated, there are no + // subsequent pages. string next_page_token = 2; } -// Request message for [MetadataService.DeleteMetadataStore][google.cloud.aiplatform.v1.MetadataService.DeleteMetadataStore]. +// Request message for +// [MetadataService.DeleteMetadataStore][google.cloud.aiplatform.v1.MetadataService.DeleteMetadataStore]. message DeleteMetadataStoreRequest { // Required. The resource name of the MetadataStore to delete. // Format: @@ -463,13 +491,15 @@ message DeleteMetadataStoreRequest { bool force = 2 [deprecated = true]; } -// Details of operations that perform [MetadataService.DeleteMetadataStore][google.cloud.aiplatform.v1.MetadataService.DeleteMetadataStore]. +// Details of operations that perform +// [MetadataService.DeleteMetadataStore][google.cloud.aiplatform.v1.MetadataService.DeleteMetadataStore]. message DeleteMetadataStoreOperationMetadata { // Operation metadata for deleting a MetadataStore. GenericOperationMetadata generic_metadata = 1; } -// Request message for [MetadataService.CreateArtifact][google.cloud.aiplatform.v1.MetadataService.CreateArtifact]. +// Request message for +// [MetadataService.CreateArtifact][google.cloud.aiplatform.v1.MetadataService.CreateArtifact]. message CreateArtifactRequest { // Required. The resource name of the MetadataStore where the Artifact should // be created. @@ -495,7 +525,8 @@ message CreateArtifactRequest { string artifact_id = 3; } -// Request message for [MetadataService.GetArtifact][google.cloud.aiplatform.v1.MetadataService.GetArtifact]. +// Request message for +// [MetadataService.GetArtifact][google.cloud.aiplatform.v1.MetadataService.GetArtifact]. message GetArtifactRequest { // Required. The resource name of the Artifact to retrieve. // Format: @@ -508,7 +539,8 @@ message GetArtifactRequest { ]; } -// Request message for [MetadataService.ListArtifacts][google.cloud.aiplatform.v1.MetadataService.ListArtifacts]. +// Request message for +// [MetadataService.ListArtifacts][google.cloud.aiplatform.v1.MetadataService.ListArtifacts]. message ListArtifactsRequest { // Required. The MetadataStore whose Artifacts should be listed. // Format: @@ -524,7 +556,8 @@ message ListArtifactsRequest { // Must be in range 1-1000, inclusive. Defaults to 100. int32 page_size = 2; - // A page token, received from a previous [MetadataService.ListArtifacts][google.cloud.aiplatform.v1.MetadataService.ListArtifacts] + // A page token, received from a previous + // [MetadataService.ListArtifacts][google.cloud.aiplatform.v1.MetadataService.ListArtifacts] // call. Provide this to retrieve the subsequent page. // // When paginating, all other provided parameters must match the call that @@ -556,7 +589,8 @@ message ListArtifactsRequest { // `in_context("projects//locations//metadataStores//contexts/")` // // Each of the above supported filter types can be combined together using - // logical operators (`AND` & `OR`). + // logical operators (`AND` & `OR`). Maximum nested expression depth allowed + // is 5. // // For example: `display_name = "test" AND metadata.field1.bool_value = true`. string filter = 4; @@ -570,36 +604,41 @@ message ListArtifactsRequest { string order_by = 5; } -// Response message for [MetadataService.ListArtifacts][google.cloud.aiplatform.v1.MetadataService.ListArtifacts]. +// Response message for +// [MetadataService.ListArtifacts][google.cloud.aiplatform.v1.MetadataService.ListArtifacts]. message ListArtifactsResponse { // The Artifacts retrieved from the MetadataStore. repeated Artifact artifacts = 1; - // A token, which can be sent as [ListArtifactsRequest.page_token][google.cloud.aiplatform.v1.ListArtifactsRequest.page_token] + // A token, which can be sent as + // [ListArtifactsRequest.page_token][google.cloud.aiplatform.v1.ListArtifactsRequest.page_token] // to retrieve the next page. // If this field is not populated, there are no subsequent pages. string next_page_token = 2; } -// Request message for [MetadataService.UpdateArtifact][google.cloud.aiplatform.v1.MetadataService.UpdateArtifact]. +// Request message for +// [MetadataService.UpdateArtifact][google.cloud.aiplatform.v1.MetadataService.UpdateArtifact]. message UpdateArtifactRequest { // Required. The Artifact containing updates. - // The Artifact's [Artifact.name][google.cloud.aiplatform.v1.Artifact.name] field is used to identify the Artifact to - // be updated. - // Format: + // The Artifact's [Artifact.name][google.cloud.aiplatform.v1.Artifact.name] + // field is used to identify the Artifact to be updated. Format: // `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` Artifact artifact = 1 [(google.api.field_behavior) = REQUIRED]; // Optional. A FieldMask indicating which fields should be updated. // Functionality of this field is not yet supported. - google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = OPTIONAL]; + google.protobuf.FieldMask update_mask = 2 + [(google.api.field_behavior) = OPTIONAL]; - // If set to true, and the [Artifact][google.cloud.aiplatform.v1.Artifact] is not found, a new [Artifact][google.cloud.aiplatform.v1.Artifact] is + // If set to true, and the [Artifact][google.cloud.aiplatform.v1.Artifact] is + // not found, a new [Artifact][google.cloud.aiplatform.v1.Artifact] is // created. bool allow_missing = 3; } -// Request message for [MetadataService.DeleteArtifact][google.cloud.aiplatform.v1.MetadataService.DeleteArtifact]. +// Request message for +// [MetadataService.DeleteArtifact][google.cloud.aiplatform.v1.MetadataService.DeleteArtifact]. message DeleteArtifactRequest { // Required. The resource name of the Artifact to delete. // Format: @@ -617,7 +656,8 @@ message DeleteArtifactRequest { string etag = 2 [(google.api.field_behavior) = OPTIONAL]; } -// Request message for [MetadataService.PurgeArtifacts][google.cloud.aiplatform.v1.MetadataService.PurgeArtifacts]. +// Request message for +// [MetadataService.PurgeArtifacts][google.cloud.aiplatform.v1.MetadataService.PurgeArtifacts]. message PurgeArtifactsRequest { // Required. The metadata store to purge Artifacts from. // Format: @@ -639,7 +679,8 @@ message PurgeArtifactsRequest { bool force = 3 [(google.api.field_behavior) = OPTIONAL]; } -// Response message for [MetadataService.PurgeArtifacts][google.cloud.aiplatform.v1.MetadataService.PurgeArtifacts]. +// Response message for +// [MetadataService.PurgeArtifacts][google.cloud.aiplatform.v1.MetadataService.PurgeArtifacts]. message PurgeArtifactsResponse { // The number of Artifacts that this request deleted (or, if `force` is false, // the number of Artifacts that will be deleted). This can be an estimate. @@ -649,21 +690,22 @@ message PurgeArtifactsResponse { // Only populated if `force` is set to false. The maximum number of samples is // 100 (it is possible to return fewer). repeated string purge_sample = 2 [(google.api.resource_reference) = { - type: "aiplatform.googleapis.com/Artifact" - }]; + type: "aiplatform.googleapis.com/Artifact" + }]; } -// Details of operations that perform [MetadataService.PurgeArtifacts][google.cloud.aiplatform.v1.MetadataService.PurgeArtifacts]. +// Details of operations that perform +// [MetadataService.PurgeArtifacts][google.cloud.aiplatform.v1.MetadataService.PurgeArtifacts]. message PurgeArtifactsMetadata { // Operation metadata for purging Artifacts. GenericOperationMetadata generic_metadata = 1; } -// Request message for [MetadataService.CreateContext][google.cloud.aiplatform.v1.MetadataService.CreateContext]. +// Request message for +// [MetadataService.CreateContext][google.cloud.aiplatform.v1.MetadataService.CreateContext]. message CreateContextRequest { - // Required. The resource name of the MetadataStore where the Context should be - // created. - // Format: + // Required. The resource name of the MetadataStore where the Context should + // be created. Format: // `projects/{project}/locations/{location}/metadataStores/{metadatastore}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, @@ -685,7 +727,8 @@ message CreateContextRequest { string context_id = 3; } -// Request message for [MetadataService.GetContext][google.cloud.aiplatform.v1.MetadataService.GetContext]. +// Request message for +// [MetadataService.GetContext][google.cloud.aiplatform.v1.MetadataService.GetContext]. message GetContextRequest { // Required. The resource name of the Context to retrieve. // Format: @@ -698,7 +741,8 @@ message GetContextRequest { ]; } -// Request message for [MetadataService.ListContexts][google.cloud.aiplatform.v1.MetadataService.ListContexts] +// Request message for +// [MetadataService.ListContexts][google.cloud.aiplatform.v1.MetadataService.ListContexts] message ListContextsRequest { // Required. The MetadataStore whose Contexts should be listed. // Format: @@ -714,7 +758,8 @@ message ListContextsRequest { // Must be in range 1-1000, inclusive. Defaults to 100. int32 page_size = 2; - // A page token, received from a previous [MetadataService.ListContexts][google.cloud.aiplatform.v1.MetadataService.ListContexts] + // A page token, received from a previous + // [MetadataService.ListContexts][google.cloud.aiplatform.v1.MetadataService.ListContexts] // call. Provide this to retrieve the subsequent page. // // When paginating, all other provided parameters must match the call that @@ -750,7 +795,8 @@ message ListContextsRequest { // ``` // // Each of the above supported filters can be combined together using - // logical operators (`AND` & `OR`). + // logical operators (`AND` & `OR`). Maximum nested expression depth allowed + // is 5. // // For example: `display_name = "test" AND metadata.field1.bool_value = true`. string filter = 4; @@ -764,36 +810,40 @@ message ListContextsRequest { string order_by = 5; } -// Response message for [MetadataService.ListContexts][google.cloud.aiplatform.v1.MetadataService.ListContexts]. +// Response message for +// [MetadataService.ListContexts][google.cloud.aiplatform.v1.MetadataService.ListContexts]. message ListContextsResponse { // The Contexts retrieved from the MetadataStore. repeated Context contexts = 1; - // A token, which can be sent as [ListContextsRequest.page_token][google.cloud.aiplatform.v1.ListContextsRequest.page_token] + // A token, which can be sent as + // [ListContextsRequest.page_token][google.cloud.aiplatform.v1.ListContextsRequest.page_token] // to retrieve the next page. // If this field is not populated, there are no subsequent pages. string next_page_token = 2; } -// Request message for [MetadataService.UpdateContext][google.cloud.aiplatform.v1.MetadataService.UpdateContext]. +// Request message for +// [MetadataService.UpdateContext][google.cloud.aiplatform.v1.MetadataService.UpdateContext]. message UpdateContextRequest { // Required. The Context containing updates. - // The Context's [Context.name][google.cloud.aiplatform.v1.Context.name] field is used to identify the Context to be - // updated. - // Format: + // The Context's [Context.name][google.cloud.aiplatform.v1.Context.name] field + // is used to identify the Context to be updated. Format: // `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}` Context context = 1 [(google.api.field_behavior) = REQUIRED]; // Optional. A FieldMask indicating which fields should be updated. // Functionality of this field is not yet supported. - google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = OPTIONAL]; + google.protobuf.FieldMask update_mask = 2 + [(google.api.field_behavior) = OPTIONAL]; - // If set to true, and the [Context][google.cloud.aiplatform.v1.Context] is not found, a new [Context][google.cloud.aiplatform.v1.Context] is - // created. + // If set to true, and the [Context][google.cloud.aiplatform.v1.Context] is + // not found, a new [Context][google.cloud.aiplatform.v1.Context] is created. bool allow_missing = 3; } -// Request message for [MetadataService.DeleteContext][google.cloud.aiplatform.v1.MetadataService.DeleteContext]. +// Request message for +// [MetadataService.DeleteContext][google.cloud.aiplatform.v1.MetadataService.DeleteContext]. message DeleteContextRequest { // Required. The resource name of the Context to delete. // Format: @@ -815,7 +865,8 @@ message DeleteContextRequest { string etag = 3 [(google.api.field_behavior) = OPTIONAL]; } -// Request message for [MetadataService.PurgeContexts][google.cloud.aiplatform.v1.MetadataService.PurgeContexts]. +// Request message for +// [MetadataService.PurgeContexts][google.cloud.aiplatform.v1.MetadataService.PurgeContexts]. message PurgeContextsRequest { // Required. The metadata store to purge Contexts from. // Format: @@ -837,7 +888,8 @@ message PurgeContextsRequest { bool force = 3 [(google.api.field_behavior) = OPTIONAL]; } -// Response message for [MetadataService.PurgeContexts][google.cloud.aiplatform.v1.MetadataService.PurgeContexts]. +// Response message for +// [MetadataService.PurgeContexts][google.cloud.aiplatform.v1.MetadataService.PurgeContexts]. message PurgeContextsResponse { // The number of Contexts that this request deleted (or, if `force` is false, // the number of Contexts that will be deleted). This can be an estimate. @@ -847,21 +899,22 @@ message PurgeContextsResponse { // Only populated if `force` is set to false. The maximum number of samples is // 100 (it is possible to return fewer). repeated string purge_sample = 2 [(google.api.resource_reference) = { - type: "aiplatform.googleapis.com/Context" - }]; + type: "aiplatform.googleapis.com/Context" + }]; } -// Details of operations that perform [MetadataService.PurgeContexts][google.cloud.aiplatform.v1.MetadataService.PurgeContexts]. +// Details of operations that perform +// [MetadataService.PurgeContexts][google.cloud.aiplatform.v1.MetadataService.PurgeContexts]. message PurgeContextsMetadata { // Operation metadata for purging Contexts. GenericOperationMetadata generic_metadata = 1; } -// Request message for [MetadataService.AddContextArtifactsAndExecutions][google.cloud.aiplatform.v1.MetadataService.AddContextArtifactsAndExecutions]. +// Request message for +// [MetadataService.AddContextArtifactsAndExecutions][google.cloud.aiplatform.v1.MetadataService.AddContextArtifactsAndExecutions]. message AddContextArtifactsAndExecutionsRequest { - // Required. The resource name of the Context that the Artifacts and Executions - // belong to. - // Format: + // Required. The resource name of the Context that the Artifacts and + // Executions belong to. Format: // `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}` string context = 1 [ (google.api.field_behavior) = REQUIRED, @@ -875,8 +928,8 @@ message AddContextArtifactsAndExecutionsRequest { // Format: // `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` repeated string artifacts = 2 [(google.api.resource_reference) = { - type: "aiplatform.googleapis.com/Artifact" - }]; + type: "aiplatform.googleapis.com/Artifact" + }]; // The resource names of the Executions to associate with the // Context. @@ -884,16 +937,16 @@ message AddContextArtifactsAndExecutionsRequest { // Format: // `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` repeated string executions = 3 [(google.api.resource_reference) = { - type: "aiplatform.googleapis.com/Execution" - }]; + type: "aiplatform.googleapis.com/Execution" + }]; } -// Response message for [MetadataService.AddContextArtifactsAndExecutions][google.cloud.aiplatform.v1.MetadataService.AddContextArtifactsAndExecutions]. -message AddContextArtifactsAndExecutionsResponse { - -} +// Response message for +// [MetadataService.AddContextArtifactsAndExecutions][google.cloud.aiplatform.v1.MetadataService.AddContextArtifactsAndExecutions]. +message AddContextArtifactsAndExecutionsResponse {} -// Request message for [MetadataService.AddContextChildren][google.cloud.aiplatform.v1.MetadataService.AddContextChildren]. +// Request message for +// [MetadataService.AddContextChildren][google.cloud.aiplatform.v1.MetadataService.AddContextChildren]. message AddContextChildrenRequest { // Required. The resource name of the parent Context. // @@ -908,14 +961,13 @@ message AddContextChildrenRequest { // The resource names of the child Contexts. repeated string child_contexts = 2 [(google.api.resource_reference) = { - type: "aiplatform.googleapis.com/Context" - }]; + type: "aiplatform.googleapis.com/Context" + }]; } -// Response message for [MetadataService.AddContextChildren][google.cloud.aiplatform.v1.MetadataService.AddContextChildren]. -message AddContextChildrenResponse { - -} +// Response message for +// [MetadataService.AddContextChildren][google.cloud.aiplatform.v1.MetadataService.AddContextChildren]. +message AddContextChildrenResponse {} // Request message for // [MetadataService.DeleteContextChildrenRequest][]. @@ -933,16 +985,16 @@ message RemoveContextChildrenRequest { // The resource names of the child Contexts. repeated string child_contexts = 2 [(google.api.resource_reference) = { - type: "aiplatform.googleapis.com/Context" - }]; + type: "aiplatform.googleapis.com/Context" + }]; } -// Response message for [MetadataService.RemoveContextChildren][google.cloud.aiplatform.v1.MetadataService.RemoveContextChildren]. -message RemoveContextChildrenResponse { - -} +// Response message for +// [MetadataService.RemoveContextChildren][google.cloud.aiplatform.v1.MetadataService.RemoveContextChildren]. +message RemoveContextChildrenResponse {} -// Request message for [MetadataService.QueryContextLineageSubgraph][google.cloud.aiplatform.v1.MetadataService.QueryContextLineageSubgraph]. +// Request message for +// [MetadataService.QueryContextLineageSubgraph][google.cloud.aiplatform.v1.MetadataService.QueryContextLineageSubgraph]. message QueryContextLineageSubgraphRequest { // Required. The resource name of the Context whose Artifacts and Executions // should be retrieved as a LineageSubgraph. @@ -960,7 +1012,8 @@ message QueryContextLineageSubgraphRequest { ]; } -// Request message for [MetadataService.CreateExecution][google.cloud.aiplatform.v1.MetadataService.CreateExecution]. +// Request message for +// [MetadataService.CreateExecution][google.cloud.aiplatform.v1.MetadataService.CreateExecution]. message CreateExecutionRequest { // Required. The resource name of the MetadataStore where the Execution should // be created. @@ -987,7 +1040,8 @@ message CreateExecutionRequest { string execution_id = 3; } -// Request message for [MetadataService.GetExecution][google.cloud.aiplatform.v1.MetadataService.GetExecution]. +// Request message for +// [MetadataService.GetExecution][google.cloud.aiplatform.v1.MetadataService.GetExecution]. message GetExecutionRequest { // Required. The resource name of the Execution to retrieve. // Format: @@ -1000,7 +1054,8 @@ message GetExecutionRequest { ]; } -// Request message for [MetadataService.ListExecutions][google.cloud.aiplatform.v1.MetadataService.ListExecutions]. +// Request message for +// [MetadataService.ListExecutions][google.cloud.aiplatform.v1.MetadataService.ListExecutions]. message ListExecutionsRequest { // Required. The MetadataStore whose Executions should be listed. // Format: @@ -1016,7 +1071,8 @@ message ListExecutionsRequest { // Must be in range 1-1000, inclusive. Defaults to 100. int32 page_size = 2; - // A page token, received from a previous [MetadataService.ListExecutions][google.cloud.aiplatform.v1.MetadataService.ListExecutions] + // A page token, received from a previous + // [MetadataService.ListExecutions][google.cloud.aiplatform.v1.MetadataService.ListExecutions] // call. Provide this to retrieve the subsequent page. // // When paginating, all other provided parameters must match the call that @@ -1048,7 +1104,9 @@ message ListExecutionsRequest { // `in_context("projects//locations//metadataStores//contexts/")` // // Each of the above supported filters can be combined together using - // logical operators (`AND` & `OR`). + // logical operators (`AND` & `OR`). Maximum nested expression depth allowed + // is 5. + // // For example: `display_name = "test" AND metadata.field1.bool_value = true`. string filter = 4; @@ -1061,36 +1119,41 @@ message ListExecutionsRequest { string order_by = 5; } -// Response message for [MetadataService.ListExecutions][google.cloud.aiplatform.v1.MetadataService.ListExecutions]. +// Response message for +// [MetadataService.ListExecutions][google.cloud.aiplatform.v1.MetadataService.ListExecutions]. message ListExecutionsResponse { // The Executions retrieved from the MetadataStore. repeated Execution executions = 1; - // A token, which can be sent as [ListExecutionsRequest.page_token][google.cloud.aiplatform.v1.ListExecutionsRequest.page_token] + // A token, which can be sent as + // [ListExecutionsRequest.page_token][google.cloud.aiplatform.v1.ListExecutionsRequest.page_token] // to retrieve the next page. // If this field is not populated, there are no subsequent pages. string next_page_token = 2; } -// Request message for [MetadataService.UpdateExecution][google.cloud.aiplatform.v1.MetadataService.UpdateExecution]. +// Request message for +// [MetadataService.UpdateExecution][google.cloud.aiplatform.v1.MetadataService.UpdateExecution]. message UpdateExecutionRequest { // Required. The Execution containing updates. - // The Execution's [Execution.name][google.cloud.aiplatform.v1.Execution.name] field is used to identify the Execution - // to be updated. - // Format: + // The Execution's [Execution.name][google.cloud.aiplatform.v1.Execution.name] + // field is used to identify the Execution to be updated. Format: // `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` Execution execution = 1 [(google.api.field_behavior) = REQUIRED]; // Optional. A FieldMask indicating which fields should be updated. // Functionality of this field is not yet supported. - google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = OPTIONAL]; + google.protobuf.FieldMask update_mask = 2 + [(google.api.field_behavior) = OPTIONAL]; - // If set to true, and the [Execution][google.cloud.aiplatform.v1.Execution] is not found, a new [Execution][google.cloud.aiplatform.v1.Execution] - // is created. + // If set to true, and the [Execution][google.cloud.aiplatform.v1.Execution] + // is not found, a new [Execution][google.cloud.aiplatform.v1.Execution] is + // created. bool allow_missing = 3; } -// Request message for [MetadataService.DeleteExecution][google.cloud.aiplatform.v1.MetadataService.DeleteExecution]. +// Request message for +// [MetadataService.DeleteExecution][google.cloud.aiplatform.v1.MetadataService.DeleteExecution]. message DeleteExecutionRequest { // Required. The resource name of the Execution to delete. // Format: @@ -1108,7 +1171,8 @@ message DeleteExecutionRequest { string etag = 2 [(google.api.field_behavior) = OPTIONAL]; } -// Request message for [MetadataService.PurgeExecutions][google.cloud.aiplatform.v1.MetadataService.PurgeExecutions]. +// Request message for +// [MetadataService.PurgeExecutions][google.cloud.aiplatform.v1.MetadataService.PurgeExecutions]. message PurgeExecutionsRequest { // Required. The metadata store to purge Executions from. // Format: @@ -1130,7 +1194,8 @@ message PurgeExecutionsRequest { bool force = 3 [(google.api.field_behavior) = OPTIONAL]; } -// Response message for [MetadataService.PurgeExecutions][google.cloud.aiplatform.v1.MetadataService.PurgeExecutions]. +// Response message for +// [MetadataService.PurgeExecutions][google.cloud.aiplatform.v1.MetadataService.PurgeExecutions]. message PurgeExecutionsResponse { // The number of Executions that this request deleted (or, if `force` is // false, the number of Executions that will be deleted). This can be an @@ -1141,17 +1206,19 @@ message PurgeExecutionsResponse { // Only populated if `force` is set to false. The maximum number of samples is // 100 (it is possible to return fewer). repeated string purge_sample = 2 [(google.api.resource_reference) = { - type: "aiplatform.googleapis.com/Execution" - }]; + type: "aiplatform.googleapis.com/Execution" + }]; } -// Details of operations that perform [MetadataService.PurgeExecutions][google.cloud.aiplatform.v1.MetadataService.PurgeExecutions]. +// Details of operations that perform +// [MetadataService.PurgeExecutions][google.cloud.aiplatform.v1.MetadataService.PurgeExecutions]. message PurgeExecutionsMetadata { // Operation metadata for purging Executions. GenericOperationMetadata generic_metadata = 1; } -// Request message for [MetadataService.AddExecutionEvents][google.cloud.aiplatform.v1.MetadataService.AddExecutionEvents]. +// Request message for +// [MetadataService.AddExecutionEvents][google.cloud.aiplatform.v1.MetadataService.AddExecutionEvents]. message AddExecutionEventsRequest { // Required. The resource name of the Execution that the Events connect // Artifacts with. @@ -1168,16 +1235,15 @@ message AddExecutionEventsRequest { repeated Event events = 2; } -// Response message for [MetadataService.AddExecutionEvents][google.cloud.aiplatform.v1.MetadataService.AddExecutionEvents]. -message AddExecutionEventsResponse { +// Response message for +// [MetadataService.AddExecutionEvents][google.cloud.aiplatform.v1.MetadataService.AddExecutionEvents]. +message AddExecutionEventsResponse {} -} - -// Request message for [MetadataService.QueryExecutionInputsAndOutputs][google.cloud.aiplatform.v1.MetadataService.QueryExecutionInputsAndOutputs]. +// Request message for +// [MetadataService.QueryExecutionInputsAndOutputs][google.cloud.aiplatform.v1.MetadataService.QueryExecutionInputsAndOutputs]. message QueryExecutionInputsAndOutputsRequest { - // Required. The resource name of the Execution whose input and output Artifacts should - // be retrieved as a LineageSubgraph. - // Format: + // Required. The resource name of the Execution whose input and output + // Artifacts should be retrieved as a LineageSubgraph. Format: // `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` string execution = 1 [ (google.api.field_behavior) = REQUIRED, @@ -1187,11 +1253,11 @@ message QueryExecutionInputsAndOutputsRequest { ]; } -// Request message for [MetadataService.CreateMetadataSchema][google.cloud.aiplatform.v1.MetadataService.CreateMetadataSchema]. +// Request message for +// [MetadataService.CreateMetadataSchema][google.cloud.aiplatform.v1.MetadataService.CreateMetadataSchema]. message CreateMetadataSchemaRequest { - // Required. The resource name of the MetadataStore where the MetadataSchema should - // be created. - // Format: + // Required. The resource name of the MetadataStore where the MetadataSchema + // should be created. Format: // `projects/{project}/locations/{location}/metadataStores/{metadatastore}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, @@ -1214,7 +1280,8 @@ message CreateMetadataSchemaRequest { string metadata_schema_id = 3; } -// Request message for [MetadataService.GetMetadataSchema][google.cloud.aiplatform.v1.MetadataService.GetMetadataSchema]. +// Request message for +// [MetadataService.GetMetadataSchema][google.cloud.aiplatform.v1.MetadataService.GetMetadataSchema]. message GetMetadataSchemaRequest { // Required. The resource name of the MetadataSchema to retrieve. // Format: @@ -1227,7 +1294,8 @@ message GetMetadataSchemaRequest { ]; } -// Request message for [MetadataService.ListMetadataSchemas][google.cloud.aiplatform.v1.MetadataService.ListMetadataSchemas]. +// Request message for +// [MetadataService.ListMetadataSchemas][google.cloud.aiplatform.v1.MetadataService.ListMetadataSchemas]. message ListMetadataSchemasRequest { // Required. The MetadataStore whose MetadataSchemas should be listed. // Format: @@ -1245,8 +1313,8 @@ message ListMetadataSchemasRequest { int32 page_size = 2; // A page token, received from a previous - // [MetadataService.ListMetadataSchemas][google.cloud.aiplatform.v1.MetadataService.ListMetadataSchemas] call. Provide this to retrieve the - // next page. + // [MetadataService.ListMetadataSchemas][google.cloud.aiplatform.v1.MetadataService.ListMetadataSchemas] + // call. Provide this to retrieve the next page. // // When paginating, all other provided parameters must match the call that // provided the page token. (Otherwise the request will fail with @@ -1257,22 +1325,24 @@ message ListMetadataSchemasRequest { string filter = 4; } -// Response message for [MetadataService.ListMetadataSchemas][google.cloud.aiplatform.v1.MetadataService.ListMetadataSchemas]. +// Response message for +// [MetadataService.ListMetadataSchemas][google.cloud.aiplatform.v1.MetadataService.ListMetadataSchemas]. message ListMetadataSchemasResponse { // The MetadataSchemas found for the MetadataStore. repeated MetadataSchema metadata_schemas = 1; // A token, which can be sent as - // [ListMetadataSchemasRequest.page_token][google.cloud.aiplatform.v1.ListMetadataSchemasRequest.page_token] to retrieve the next - // page. If this field is not populated, there are no subsequent pages. + // [ListMetadataSchemasRequest.page_token][google.cloud.aiplatform.v1.ListMetadataSchemasRequest.page_token] + // to retrieve the next page. If this field is not populated, there are no + // subsequent pages. string next_page_token = 2; } -// Request message for [MetadataService.QueryArtifactLineageSubgraph][google.cloud.aiplatform.v1.MetadataService.QueryArtifactLineageSubgraph]. +// Request message for +// [MetadataService.QueryArtifactLineageSubgraph][google.cloud.aiplatform.v1.MetadataService.QueryArtifactLineageSubgraph]. message QueryArtifactLineageSubgraphRequest { - // Required. The resource name of the Artifact whose Lineage needs to be retrieved as a - // LineageSubgraph. - // Format: + // Required. The resource name of the Artifact whose Lineage needs to be + // retrieved as a LineageSubgraph. Format: // `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` // // The request may error with FAILED_PRECONDITION if the number of Artifacts, @@ -1310,7 +1380,8 @@ message QueryArtifactLineageSubgraphRequest { // For example: `metadata.field_1.number_value = 10.0` // // Each of the above supported filter types can be combined together using - // logical operators (`AND` & `OR`). + // logical operators (`AND` & `OR`). Maximum nested expression depth allowed + // is 5. // // For example: `display_name = "test" AND metadata.field1.bool_value = true`. string filter = 3; diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/metadata_store.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/metadata_store.proto index 31e7fd2c94a..a151ddce9b2 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/metadata_store.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/metadata_store.proto @@ -47,10 +47,12 @@ message MetadataStore { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this MetadataStore was created. - google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this MetadataStore was last updated. - google.protobuf.Timestamp update_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Customer-managed encryption key spec for a Metadata Store. If set, this // Metadata Store and all sub-resources of this Metadata Store are secured diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/migratable_resource.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/migratable_resource.proto index 3306029af40..04dff9c8566 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/migratable_resource.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/migratable_resource.proto @@ -65,9 +65,9 @@ message MigratableResource { // Full resource name of ml engine model Version. // Format: `projects/{project}/models/{model}/versions/{version}`. - string version = 2 [(google.api.resource_reference) = { - type: "ml.googleapis.com/Version" - }]; + string version = 2 [ + (google.api.resource_reference) = { type: "ml.googleapis.com/Version" } + ]; } // Represents one Model in automl.googleapis.com. @@ -75,9 +75,9 @@ message MigratableResource { // Full resource name of automl Model. // Format: // `projects/{project}/locations/{location}/models/{model}`. - string model = 1 [(google.api.resource_reference) = { - type: "automl.googleapis.com/Model" - }]; + string model = 1 [ + (google.api.resource_reference) = { type: "automl.googleapis.com/Model" } + ]; // The Model's display name in automl.googleapis.com. string model_display_name = 3; @@ -89,8 +89,8 @@ message MigratableResource { // Format: // `projects/{project}/locations/{location}/datasets/{dataset}`. string dataset = 1 [(google.api.resource_reference) = { - type: "automl.googleapis.com/Dataset" - }]; + type: "automl.googleapis.com/Dataset" + }]; // The Dataset's display name in automl.googleapis.com. string dataset_display_name = 4; @@ -104,8 +104,8 @@ message MigratableResource { // Format: // `projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}`. string annotated_dataset = 1 [(google.api.resource_reference) = { - type: "datalabeling.googleapis.com/AnnotatedDataset" - }]; + type: "datalabeling.googleapis.com/AnnotatedDataset" + }]; // The AnnotatedDataset's display name in datalabeling.googleapis.com. string annotated_dataset_display_name = 3; @@ -115,8 +115,8 @@ message MigratableResource { // Format: // `projects/{project}/datasets/{dataset}`. string dataset = 1 [(google.api.resource_reference) = { - type: "datalabeling.googleapis.com/Dataset" - }]; + type: "datalabeling.googleapis.com/Dataset" + }]; // The Dataset's display name in datalabeling.googleapis.com. string dataset_display_name = 4; @@ -128,23 +128,28 @@ message MigratableResource { oneof resource { // Output only. Represents one Version in ml.googleapis.com. - MlEngineModelVersion ml_engine_model_version = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + MlEngineModelVersion ml_engine_model_version = 1 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Represents one Model in automl.googleapis.com. AutomlModel automl_model = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Represents one Dataset in automl.googleapis.com. - AutomlDataset automl_dataset = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + AutomlDataset automl_dataset = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Represents one Dataset in datalabeling.googleapis.com. - DataLabelingDataset data_labeling_dataset = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + DataLabelingDataset data_labeling_dataset = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; } - // Output only. Timestamp when the last migration attempt on this MigratableResource - // started. Will not be set if there's no migration attempt on this - // MigratableResource. - google.protobuf.Timestamp last_migrate_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. Timestamp when the last migration attempt on this + // MigratableResource started. Will not be set if there's no migration attempt + // on this MigratableResource. + google.protobuf.Timestamp last_migrate_time = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this MigratableResource was last updated. - google.protobuf.Timestamp last_update_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp last_update_time = 6 + [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/migration_service.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/migration_service.proto index bcacf30a4fa..7acbdb11e3d 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/migration_service.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/migration_service.proto @@ -37,12 +37,14 @@ option ruby_package = "Google::Cloud::AIPlatform::V1"; // datalabeling.googleapis.com and ml.googleapis.com to Vertex AI. service MigrationService { option (google.api.default_host) = "aiplatform.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/cloud-platform"; // 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. - rpc SearchMigratableResources(SearchMigratableResourcesRequest) returns (SearchMigratableResourcesResponse) { + rpc SearchMigratableResources(SearchMigratableResourcesRequest) + returns (SearchMigratableResourcesResponse) { option (google.api.http) = { post: "/v1/{parent=projects/*/locations/*}/migratableResources:search" body: "*" @@ -52,7 +54,8 @@ service MigrationService { // Batch migrates resources from ml.googleapis.com, automl.googleapis.com, // and datalabeling.googleapis.com to Vertex AI. - rpc BatchMigrateResources(BatchMigrateResourcesRequest) returns (google.longrunning.Operation) { + rpc BatchMigrateResources(BatchMigrateResourcesRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{parent=projects/*/locations/*}/migratableResources:batchMigrate" body: "*" @@ -65,12 +68,12 @@ service MigrationService { } } -// Request message for [MigrationService.SearchMigratableResources][google.cloud.aiplatform.v1.MigrationService.SearchMigratableResources]. +// Request message for +// [MigrationService.SearchMigratableResources][google.cloud.aiplatform.v1.MigrationService.SearchMigratableResources]. message SearchMigratableResourcesRequest { - // Required. The location that the migratable resources should be searched from. - // It's the Vertex AI location that the resources can be migrated to, not - // the resources' original location. - // Format: + // Required. The location that the migratable resources should be searched + // from. It's the Vertex AI location that the resources can be migrated to, + // not the resources' original location. Format: // `projects/{project}/locations/{location}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, @@ -101,7 +104,8 @@ message SearchMigratableResourcesRequest { string filter = 4; } -// Response message for [MigrationService.SearchMigratableResources][google.cloud.aiplatform.v1.MigrationService.SearchMigratableResources]. +// Response message for +// [MigrationService.SearchMigratableResources][google.cloud.aiplatform.v1.MigrationService.SearchMigratableResources]. message SearchMigratableResourcesResponse { // All migratable resources that can be migrated to the // location specified in the request. @@ -113,7 +117,8 @@ message SearchMigratableResourcesResponse { string next_page_token = 2; } -// Request message for [MigrationService.BatchMigrateResources][google.cloud.aiplatform.v1.MigrationService.BatchMigrateResources]. +// Request message for +// [MigrationService.BatchMigrateResources][google.cloud.aiplatform.v1.MigrationService.BatchMigrateResources]. message BatchMigrateResourcesRequest { // Required. The location of the migrated resource will live in. // Format: `projects/{project}/locations/{location}` @@ -127,7 +132,8 @@ message BatchMigrateResourcesRequest { // Required. The request messages specifying the resources to migrate. // They must be in the same location as the destination. // Up to 50 resources can be migrated in one batch. - repeated MigrateResourceRequest migrate_resource_requests = 2 [(google.api.field_behavior) = REQUIRED]; + repeated MigrateResourceRequest migrate_resource_requests = 2 + [(google.api.field_behavior) = REQUIRED]; } // Config of migrating one resource from automl.googleapis.com, @@ -135,9 +141,8 @@ message BatchMigrateResourcesRequest { message MigrateResourceRequest { // Config for migrating version in ml.googleapis.com to Vertex AI's Model. message MigrateMlEngineModelVersionConfig { - // Required. The ml.googleapis.com endpoint that this model version should be migrated - // from. - // Example values: + // Required. The ml.googleapis.com endpoint that this model version should + // be migrated from. Example values: // // * ml.googleapis.com // @@ -152,9 +157,7 @@ message MigrateResourceRequest { // Format: `projects/{project}/models/{model}/versions/{version}`. string model_version = 2 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "ml.googleapis.com/Version" - } + (google.api.resource_reference) = { type: "ml.googleapis.com/Version" } ]; // Required. Display name of the model in Vertex AI. @@ -169,9 +172,7 @@ message MigrateResourceRequest { // `projects/{project}/locations/{location}/models/{model}`. string model = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "automl.googleapis.com/Model" - } + (google.api.resource_reference) = { type: "automl.googleapis.com/Model" } ]; // Optional. Display name of the model in Vertex AI. @@ -228,15 +229,18 @@ message MigrateResourceRequest { // System will pick a display name if unspecified. string dataset_display_name = 2 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Configs for migrating AnnotatedDataset in datalabeling.googleapis.com to - // Vertex AI's SavedQuery. The specified AnnotatedDatasets have to belong - // to the datalabeling Dataset. - repeated MigrateDataLabelingAnnotatedDatasetConfig migrate_data_labeling_annotated_dataset_configs = 3 [(google.api.field_behavior) = OPTIONAL]; + // Optional. Configs for migrating AnnotatedDataset in + // datalabeling.googleapis.com to Vertex AI's SavedQuery. The specified + // AnnotatedDatasets have to belong to the datalabeling Dataset. + repeated MigrateDataLabelingAnnotatedDatasetConfig + migrate_data_labeling_annotated_dataset_configs = 3 + [(google.api.field_behavior) = OPTIONAL]; } oneof request { // Config for migrating Version in ml.googleapis.com to Vertex AI's Model. - MigrateMlEngineModelVersionConfig migrate_ml_engine_model_version_config = 1; + MigrateMlEngineModelVersionConfig migrate_ml_engine_model_version_config = + 1; // Config for migrating Model in automl.googleapis.com to Vertex AI's // Model. @@ -252,7 +256,8 @@ message MigrateResourceRequest { } } -// Response message for [MigrationService.BatchMigrateResources][google.cloud.aiplatform.v1.MigrationService.BatchMigrateResources]. +// Response message for +// [MigrationService.BatchMigrateResources][google.cloud.aiplatform.v1.MigrationService.BatchMigrateResources]. message BatchMigrateResourcesResponse { // Successfully migrated resources. repeated MigrateResourceResponse migrate_resource_responses = 1; @@ -264,13 +269,13 @@ message MigrateResourceResponse { oneof migrated_resource { // Migrated Dataset's resource name. string dataset = 1 [(google.api.resource_reference) = { - type: "aiplatform.googleapis.com/Dataset" - }]; + type: "aiplatform.googleapis.com/Dataset" + }]; // Migrated Model's resource name. string model = 2 [(google.api.resource_reference) = { - type: "aiplatform.googleapis.com/Model" - }]; + type: "aiplatform.googleapis.com/Model" + }]; } // Before migration, the identifier in ml.googleapis.com, @@ -278,7 +283,8 @@ message MigrateResourceResponse { MigratableResource migratable_resource = 3; } -// Runtime operation information for [MigrationService.BatchMigrateResources][google.cloud.aiplatform.v1.MigrationService.BatchMigrateResources]. +// Runtime operation information for +// [MigrationService.BatchMigrateResources][google.cloud.aiplatform.v1.MigrationService.BatchMigrateResources]. message BatchMigrateResourcesOperationMetadata { // Represents a partial result in batch migration operation for one // [MigrateResourceRequest][google.cloud.aiplatform.v1.MigrateResourceRequest]. @@ -292,13 +298,13 @@ message BatchMigrateResourcesOperationMetadata { // Migrated model resource name. string model = 3 [(google.api.resource_reference) = { - type: "aiplatform.googleapis.com/Model" - }]; + type: "aiplatform.googleapis.com/Model" + }]; // Migrated dataset resource name. string dataset = 4 [(google.api.resource_reference) = { - type: "aiplatform.googleapis.com/Dataset" - }]; + type: "aiplatform.googleapis.com/Dataset" + }]; } // It's the same as the value in diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/model.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/model.proto index f34fad6ed28..3c6d66b8ac1 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/model.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/model.proto @@ -50,12 +50,15 @@ message Model { // Model artifact and any of its supported files. Will be exported to the // location specified by the `artifactDestination` field of the - // [ExportModelRequest.output_config][google.cloud.aiplatform.v1.ExportModelRequest.output_config] object. + // [ExportModelRequest.output_config][google.cloud.aiplatform.v1.ExportModelRequest.output_config] + // object. ARTIFACT = 1; // The container image that is to be used when deploying this Model. Will // be exported to the location specified by the `imageDestination` field - // of the [ExportModelRequest.output_config][google.cloud.aiplatform.v1.ExportModelRequest.output_config] object. + // of the + // [ExportModelRequest.output_config][google.cloud.aiplatform.v1.ExportModelRequest.output_config] + // object. IMAGE = 2; } @@ -83,7 +86,8 @@ message Model { string id = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The content of this Model that may be exported. - repeated ExportableContent exportable_contents = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + repeated ExportableContent exportable_contents = 2 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // Identifies a type of Model's prediction resources. @@ -91,16 +95,18 @@ message Model { // Should not be used. DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED = 0; - // Resources that are dedicated to the [DeployedModel][google.cloud.aiplatform.v1.DeployedModel], and that need a - // higher degree of manual configuration. + // Resources that are dedicated to the + // [DeployedModel][google.cloud.aiplatform.v1.DeployedModel], and that need + // a higher degree of manual configuration. DEDICATED_RESOURCES = 1; // Resources that to large degree are decided by Vertex AI, and require // only a modest additional configuration. AUTOMATIC_RESOURCES = 2; - // Resources that can be shared by multiple [DeployedModels][google.cloud.aiplatform.v1.DeployedModel]. - // A pre-configured [DeploymentResourcePool][] is required. + // Resources that can be shared by multiple + // [DeployedModels][google.cloud.aiplatform.v1.DeployedModel]. A + // pre-configured [DeploymentResourcePool][] is required. SHARED_RESOURCES = 3; } @@ -118,9 +124,9 @@ message Model { // User provided version aliases so that a model version can be referenced via // alias (i.e. - // projects/{project}/locations/{location}/models/{model_id}@{version_alias} + // `projects/{project}/locations/{location}/models/{model_id}@{version_alias}` // instead of auto-generated version id (i.e. - // projects/{project}/locations/{location}/models/{model_id}@{version_id}). + // `projects/{project}/locations/{location}/models/{model_id}@{version_id})`. // The format is [a-z][a-zA-Z0-9-]{0,126}[a-z0-9] to distinguish from // version_id. A default version alias will be created for the first version // of the model, and there must be exactly one default version alias for a @@ -128,13 +134,15 @@ message Model { repeated string version_aliases = 29; // Output only. Timestamp when this version was created. - google.protobuf.Timestamp version_create_time = 31 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp version_create_time = 31 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this version was most recently updated. - google.protobuf.Timestamp version_update_time = 32 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp version_update_time = 32 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. The display name of the Model. - // The name can be up to 128 characters long and can be consist of any UTF-8 + // The name can be up to 128 characters long and can consist of any UTF-8 // characters. string display_name = 2 [(google.api.field_behavior) = REQUIRED]; @@ -146,13 +154,15 @@ message Model { // The schemata that describe formats of the Model's predictions and // explanations as given and returned via - // [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] and [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain]. + // [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] + // and + // [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain]. PredictSchemata predict_schemata = 4; - // Immutable. Points to a YAML file stored on Google Cloud Storage describing additional - // information about the Model, that is specific to it. Unset if the Model - // does not have any additional information. - // The schema is defined as an OpenAPI 3.0.2 [Schema + // Immutable. Points to a YAML file stored on Google Cloud Storage describing + // additional information about the Model, that is specific to it. Unset if + // the Model does not have any additional information. The schema is defined + // as an OpenAPI 3.0.2 [Schema // Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). // AutoML Models always have this field populated by Vertex AI, if no // additional metadata is needed, this field is set to an empty string. @@ -161,17 +171,19 @@ message Model { // point to a location where the user only has a read access. string metadata_schema_uri = 5 [(google.api.field_behavior) = IMMUTABLE]; - // Immutable. An additional information about the Model; the schema of the metadata can - // be found in [metadata_schema][google.cloud.aiplatform.v1.Model.metadata_schema_uri]. + // Immutable. An additional information about the Model; the schema of the + // metadata can be found in + // [metadata_schema][google.cloud.aiplatform.v1.Model.metadata_schema_uri]. // Unset if the Model does not have any additional information. google.protobuf.Value metadata = 6 [(google.api.field_behavior) = IMMUTABLE]; - // Output only. The formats in which this Model may be exported. If empty, this Model is - // not available for export. - repeated ExportFormat supported_export_formats = 20 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. The formats in which this Model may be exported. If empty, + // this Model is not available for export. + repeated ExportFormat supported_export_formats = 20 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. The resource name of the TrainingPipeline that uploaded this Model, if - // any. + // Output only. The resource name of the TrainingPipeline that uploaded this + // Model, if any. string training_pipeline = 7 [ (google.api.field_behavior) = OUTPUT_ONLY, (google.api.resource_reference) = { @@ -179,35 +191,43 @@ message Model { } ]; - // Input only. The specification of the container that is to be used when deploying - // this Model. The specification is ingested upon - // [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel], and all binaries it contains are copied - // and stored internally by Vertex AI. + // Input only. The specification of the container that is to be used when + // deploying this Model. The specification is ingested upon + // [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel], + // and all binaries it contains are copied and stored internally by Vertex AI. // Not present for AutoML Models. - ModelContainerSpec container_spec = 9 [(google.api.field_behavior) = INPUT_ONLY]; + ModelContainerSpec container_spec = 9 + [(google.api.field_behavior) = INPUT_ONLY]; - // Immutable. The path to the directory containing the Model artifact and any of its - // supporting files. - // Not present for AutoML Models. + // Immutable. The path to the directory containing the Model artifact and any + // of its supporting files. Not present for AutoML Models. string artifact_uri = 26 [(google.api.field_behavior) = IMMUTABLE]; - // Output only. When this Model is deployed, its prediction resources are described by the - // `prediction_resources` field of the [Endpoint.deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models] object. - // Because not all Models support all resource configuration types, the - // configuration types this Model supports are listed here. If no + // Output only. When this Model is deployed, its prediction resources are + // described by the `prediction_resources` field of the + // [Endpoint.deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models] + // object. Because not all Models support all resource configuration types, + // the configuration types this Model supports are listed here. If no // configuration types are listed, the Model cannot be deployed to an // [Endpoint][google.cloud.aiplatform.v1.Endpoint] and does not support - // online predictions ([PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] or - // [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain]). Such a Model can serve predictions by - // using a [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob], if it has at least one entry each in - // [supported_input_storage_formats][google.cloud.aiplatform.v1.Model.supported_input_storage_formats] and + // online predictions + // ([PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] + // or + // [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain]). + // Such a Model can serve predictions by using a + // [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob], if it + // has at least one entry each in + // [supported_input_storage_formats][google.cloud.aiplatform.v1.Model.supported_input_storage_formats] + // and // [supported_output_storage_formats][google.cloud.aiplatform.v1.Model.supported_output_storage_formats]. - repeated DeploymentResourcesType supported_deployment_resources_types = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; + repeated DeploymentResourcesType supported_deployment_resources_types = 10 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The formats this Model supports in - // [BatchPredictionJob.input_config][google.cloud.aiplatform.v1.BatchPredictionJob.input_config]. If - // [PredictSchemata.instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri] exists, the instances - // should be given as per that schema. + // [BatchPredictionJob.input_config][google.cloud.aiplatform.v1.BatchPredictionJob.input_config]. + // If + // [PredictSchemata.instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri] + // exists, the instances should be given as per that schema. // // The possible formats are: // @@ -218,11 +238,13 @@ message Model { // * `csv` // The CSV format, where each instance is a single comma-separated line. // The first line in the file is the header, containing comma-separated field - // names. Uses [GcsSource][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.gcs_source]. + // names. Uses + // [GcsSource][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.gcs_source]. // // * `tf-record` // The TFRecord format, where each instance is a single record in tfrecord - // syntax. Uses [GcsSource][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.gcs_source]. + // syntax. Uses + // [GcsSource][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.gcs_source]. // // * `tf-record-gzip` // Similar to `tf-record`, but the file is gzipped. Uses @@ -235,23 +257,31 @@ message Model { // * `file-list` // Each line of the file is the location of an instance to process, uses // `gcs_source` field of the - // [InputConfig][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig] object. + // [InputConfig][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig] + // object. // // // If this Model doesn't support any of these formats it means it cannot be - // used with a [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob]. However, if it has - // [supported_deployment_resources_types][google.cloud.aiplatform.v1.Model.supported_deployment_resources_types], it could serve online - // predictions by using [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] or + // used with a + // [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob]. + // However, if it has + // [supported_deployment_resources_types][google.cloud.aiplatform.v1.Model.supported_deployment_resources_types], + // it could serve online predictions by using + // [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] + // or // [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain]. - repeated string supported_input_storage_formats = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; + repeated string supported_input_storage_formats = 11 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The formats this Model supports in - // [BatchPredictionJob.output_config][google.cloud.aiplatform.v1.BatchPredictionJob.output_config]. If both - // [PredictSchemata.instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri] and - // [PredictSchemata.prediction_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.prediction_schema_uri] exist, the predictions - // are returned together with their instances. In other words, the - // prediction has the original instance data first, followed - // by the actual prediction content (as per the schema). + // [BatchPredictionJob.output_config][google.cloud.aiplatform.v1.BatchPredictionJob.output_config]. + // If both + // [PredictSchemata.instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri] + // and + // [PredictSchemata.prediction_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.prediction_schema_uri] + // exist, the predictions are returned together with their instances. In other + // words, the prediction has the original instance data first, followed by the + // actual prediction content (as per the schema). // // The possible formats are: // @@ -272,44 +302,56 @@ message Model { // // // If this Model doesn't support any of these formats it means it cannot be - // used with a [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob]. However, if it has - // [supported_deployment_resources_types][google.cloud.aiplatform.v1.Model.supported_deployment_resources_types], it could serve online - // predictions by using [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] or + // used with a + // [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob]. + // However, if it has + // [supported_deployment_resources_types][google.cloud.aiplatform.v1.Model.supported_deployment_resources_types], + // it could serve online predictions by using + // [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] + // or // [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain]. - repeated string supported_output_storage_formats = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; + repeated string supported_output_storage_formats = 12 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this Model was uploaded into Vertex AI. - google.protobuf.Timestamp create_time = 13 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 13 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this Model was most recently updated. - google.protobuf.Timestamp update_time = 14 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 14 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. The pointers to DeployedModels created from this Model. Note that - // Model could have been deployed to Endpoints in different Locations. - repeated DeployedModelRef deployed_models = 15 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. The pointers to DeployedModels created from this Model. Note + // that Model could have been deployed to Endpoints in different Locations. + repeated DeployedModelRef deployed_models = 15 + [(google.api.field_behavior) = OUTPUT_ONLY]; // The default explanation specification for this Model. // // The Model can be used for [requesting // explanation][PredictionService.Explain] after being - // [deployed][google.cloud.aiplatform.v1.EndpointService.DeployModel] if it is populated. - // The Model can be used for [batch + // [deployed][google.cloud.aiplatform.v1.EndpointService.DeployModel] if it is + // populated. The Model can be used for [batch // explanation][BatchPredictionJob.generate_explanation] if it is populated. // // All fields of the explanation_spec can be overridden by - // [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] of - // [DeployModelRequest.deployed_model][google.cloud.aiplatform.v1.DeployModelRequest.deployed_model], or - // [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec] of - // [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob]. + // [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] + // of + // [DeployModelRequest.deployed_model][google.cloud.aiplatform.v1.DeployModelRequest.deployed_model], + // or + // [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec] + // of [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob]. // // If the default explanation specification is not set for this Model, this // Model can still be used for [requesting // explanation][PredictionService.Explain] by setting - // [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] of - // [DeployModelRequest.deployed_model][google.cloud.aiplatform.v1.DeployModelRequest.deployed_model] and for [batch - // explanation][BatchPredictionJob.generate_explanation] by setting - // [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec] of - // [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob]. + // [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] + // of + // [DeployModelRequest.deployed_model][google.cloud.aiplatform.v1.DeployModelRequest.deployed_model] + // and for [batch explanation][BatchPredictionJob.generate_explanation] by + // setting + // [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec] + // of [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob]. ExplanationSpec explanation_spec = 23; // Used to perform consistent read-modify-write updates. If not set, a blind @@ -329,18 +371,28 @@ message Model { // Model and all sub-resources of this Model will be secured by this key. EncryptionSpec encryption_spec = 24; - // Output only. Source of a model. It can either be automl training pipeline, custom - // training pipeline, BigQuery ML, or existing Vertex AI Model. - ModelSourceInfo model_source_info = 38 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. Source of a model. It can either be automl training pipeline, + // custom training pipeline, BigQuery ML, or existing Vertex AI Model. + ModelSourceInfo model_source_info = 38 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The resource name of the Artifact that was created in + // MetadataStore when creating the Model. The Artifact resource name pattern + // is + // `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. + string metadata_artifact = 44 [(google.api.field_behavior) = OUTPUT_ONLY]; } // Contains the schemata used in Model's predictions and explanations via -// [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict], [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain] and -// [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob]. +// [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict], +// [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain] +// and [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob]. message PredictSchemata { - // Immutable. Points to a YAML file stored on Google Cloud Storage describing the format - // of a single instance, which are used in [PredictRequest.instances][google.cloud.aiplatform.v1.PredictRequest.instances], - // [ExplainRequest.instances][google.cloud.aiplatform.v1.ExplainRequest.instances] and + // Immutable. Points to a YAML file stored on Google Cloud Storage describing + // the format of a single instance, which are used in + // [PredictRequest.instances][google.cloud.aiplatform.v1.PredictRequest.instances], + // [ExplainRequest.instances][google.cloud.aiplatform.v1.ExplainRequest.instances] + // and // [BatchPredictionJob.input_config][google.cloud.aiplatform.v1.BatchPredictionJob.input_config]. // The schema is defined as an OpenAPI 3.0.2 [Schema // Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). @@ -350,9 +402,11 @@ message PredictSchemata { // point to a location where the user only has a read access. string instance_schema_uri = 1 [(google.api.field_behavior) = IMMUTABLE]; - // Immutable. Points to a YAML file stored on Google Cloud Storage describing the - // parameters of prediction and explanation via - // [PredictRequest.parameters][google.cloud.aiplatform.v1.PredictRequest.parameters], [ExplainRequest.parameters][google.cloud.aiplatform.v1.ExplainRequest.parameters] and + // Immutable. Points to a YAML file stored on Google Cloud Storage describing + // the parameters of prediction and explanation via + // [PredictRequest.parameters][google.cloud.aiplatform.v1.PredictRequest.parameters], + // [ExplainRequest.parameters][google.cloud.aiplatform.v1.ExplainRequest.parameters] + // and // [BatchPredictionJob.model_parameters][google.cloud.aiplatform.v1.BatchPredictionJob.model_parameters]. // The schema is defined as an OpenAPI 3.0.2 [Schema // Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). @@ -363,9 +417,12 @@ message PredictSchemata { // point to a location where the user only has a read access. string parameters_schema_uri = 2 [(google.api.field_behavior) = IMMUTABLE]; - // Immutable. Points to a YAML file stored on Google Cloud Storage describing the format - // of a single prediction produced by this Model, which are returned via - // [PredictResponse.predictions][google.cloud.aiplatform.v1.PredictResponse.predictions], [ExplainResponse.explanations][google.cloud.aiplatform.v1.ExplainResponse.explanations], and + // Immutable. Points to a YAML file stored on Google Cloud Storage describing + // the format of a single prediction produced by this Model, which are + // returned via + // [PredictResponse.predictions][google.cloud.aiplatform.v1.PredictResponse.predictions], + // [ExplainResponse.explanations][google.cloud.aiplatform.v1.ExplainResponse.explanations], + // and // [BatchPredictionJob.output_config][google.cloud.aiplatform.v1.BatchPredictionJob.output_config]. // The schema is defined as an OpenAPI 3.0.2 [Schema // Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). @@ -380,14 +437,16 @@ message PredictSchemata { // message correspond to fields in the [Kubernetes Container v1 core // specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). message ModelContainerSpec { - // Required. Immutable. URI of the Docker image to be used as the custom container for serving - // predictions. This URI must identify an image in Artifact Registry or - // Container Registry. Learn more about the [container publishing + // Required. Immutable. URI of the Docker image to be used as the custom + // container for serving predictions. This URI must identify an image in + // Artifact Registry or Container Registry. Learn more about the [container + // publishing // requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#publishing), // including permissions requirements for the Vertex AI Service Agent. // - // The container image is ingested upon [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel], stored - // internally, and this original path is afterwards not used. + // The container image is ingested upon + // [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel], + // stored internally, and this original path is afterwards not used. // // To learn about the requirements for the Docker image itself, see // [Custom container @@ -401,14 +460,15 @@ message ModelContainerSpec { (google.api.field_behavior) = IMMUTABLE ]; - // Immutable. Specifies the command that runs when the container starts. This overrides - // the container's + // Immutable. Specifies the command that runs when the container starts. This + // overrides the container's // [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint). // Specify this field as an array of executable and arguments, similar to a // Docker `ENTRYPOINT`'s "exec" form, not its "shell" form. // // If you do not specify this field, then the container's `ENTRYPOINT` runs, - // in conjunction with the [args][google.cloud.aiplatform.v1.ModelContainerSpec.args] field or the + // in conjunction with the + // [args][google.cloud.aiplatform.v1.ModelContainerSpec.args] field or the // container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd), // if either exists. If this field is not specified and the container does not // have an `ENTRYPOINT`, then refer to the Docker documentation about [how @@ -424,32 +484,30 @@ message ModelContainerSpec { // // In this field, you can reference [environment variables set by Vertex // AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) - // and environment variables set in the [env][google.cloud.aiplatform.v1.ModelContainerSpec.env] field. - // You cannot reference environment variables set in the Docker image. In - // order for environment variables to be expanded, reference them by using the - // following syntax: - // $(VARIABLE_NAME) - // Note that this differs from Bash variable expansion, which does not use - // parentheses. If a variable cannot be resolved, the reference in the input - // string is used unchanged. To avoid variable expansion, you can escape this - // syntax with `$$`; for example: - // $$(VARIABLE_NAME) - // This field corresponds to the `command` field of the Kubernetes Containers - // [v1 core + // and environment variables set in the + // [env][google.cloud.aiplatform.v1.ModelContainerSpec.env] field. You cannot + // reference environment variables set in the Docker image. In order for + // environment variables to be expanded, reference them by using the following + // syntax: $(VARIABLE_NAME) Note that this differs + // from Bash variable expansion, which does not use parentheses. If a variable + // cannot be resolved, the reference in the input string is used unchanged. To + // avoid variable expansion, you can escape this syntax with `$$`; for + // example: $$(VARIABLE_NAME) This field corresponds + // to the `command` field of the Kubernetes Containers [v1 core // API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). repeated string command = 2 [(google.api.field_behavior) = IMMUTABLE]; - // Immutable. Specifies arguments for the command that runs when the container starts. - // This overrides the container's + // Immutable. Specifies arguments for the command that runs when the container + // starts. This overrides the container's // [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify // this field as an array of executable and arguments, similar to a Docker // `CMD`'s "default parameters" form. // // If you don't specify this field but do specify the - // [command][google.cloud.aiplatform.v1.ModelContainerSpec.command] field, then the command from the - // `command` field runs without any additional arguments. See the - // [Kubernetes documentation about how the - // `command` and `args` fields interact with a container's `ENTRYPOINT` and + // [command][google.cloud.aiplatform.v1.ModelContainerSpec.command] field, + // then the command from the `command` field runs without any additional + // arguments. See the [Kubernetes documentation about how the `command` and + // `args` fields interact with a container's `ENTRYPOINT` and // `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). // // If you don't specify this field and don't specify the `command` field, @@ -462,29 +520,29 @@ message ModelContainerSpec { // In this field, you can reference [environment variables // set by Vertex // AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) - // and environment variables set in the [env][google.cloud.aiplatform.v1.ModelContainerSpec.env] field. - // You cannot reference environment variables set in the Docker image. In - // order for environment variables to be expanded, reference them by using the - // following syntax: - // $(VARIABLE_NAME) - // Note that this differs from Bash variable expansion, which does not use - // parentheses. If a variable cannot be resolved, the reference in the input - // string is used unchanged. To avoid variable expansion, you can escape this - // syntax with `$$`; for example: - // $$(VARIABLE_NAME) - // This field corresponds to the `args` field of the Kubernetes Containers - // [v1 core + // and environment variables set in the + // [env][google.cloud.aiplatform.v1.ModelContainerSpec.env] field. You cannot + // reference environment variables set in the Docker image. In order for + // environment variables to be expanded, reference them by using the following + // syntax: $(VARIABLE_NAME) Note that this differs + // from Bash variable expansion, which does not use parentheses. If a variable + // cannot be resolved, the reference in the input string is used unchanged. To + // avoid variable expansion, you can escape this syntax with `$$`; for + // example: $$(VARIABLE_NAME) This field corresponds + // to the `args` field of the Kubernetes Containers [v1 core // API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). repeated string args = 3 [(google.api.field_behavior) = IMMUTABLE]; - // Immutable. List of environment variables to set in the container. After the container - // starts running, code running in the container can read these environment - // variables. + // Immutable. List of environment variables to set in the container. After the + // container starts running, code running in the container can read these + // environment variables. // - // Additionally, the [command][google.cloud.aiplatform.v1.ModelContainerSpec.command] and - // [args][google.cloud.aiplatform.v1.ModelContainerSpec.args] fields can reference these variables. Later - // entries in this list can also reference earlier entries. For example, the - // following example sets the variable `VAR_2` to have the value `foo bar`: + // Additionally, the + // [command][google.cloud.aiplatform.v1.ModelContainerSpec.command] and + // [args][google.cloud.aiplatform.v1.ModelContainerSpec.args] fields can + // reference these variables. Later entries in this list can also reference + // earlier entries. For example, the following example sets the variable + // `VAR_2` to have the value `foo bar`: // // ```json // [ @@ -530,11 +588,11 @@ message ModelContainerSpec { // API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). repeated Port ports = 5 [(google.api.field_behavior) = IMMUTABLE]; - // Immutable. HTTP path on the container to send prediction requests to. Vertex AI - // forwards requests sent using - // [projects.locations.endpoints.predict][google.cloud.aiplatform.v1.PredictionService.Predict] to this - // path on the container's IP address and port. Vertex AI then returns the - // container's response in the API response. + // Immutable. HTTP path on the container to send prediction requests to. + // Vertex AI forwards requests sent using + // [projects.locations.endpoints.predict][google.cloud.aiplatform.v1.PredictionService.Predict] + // to this path on the container's IP address and port. Vertex AI then returns + // the container's response in the API response. // // For example, if you set this field to `/foo`, then when Vertex AI // receives a prediction request, it forwards the request body in a POST @@ -543,7 +601,8 @@ message ModelContainerSpec { // [ports][google.cloud.aiplatform.v1.ModelContainerSpec.ports] field. // // If you don't specify this field, it defaults to the following value when - // you [deploy this Model to an Endpoint][google.cloud.aiplatform.v1.EndpointService.DeployModel]: + // you [deploy this Model to an + // Endpoint][google.cloud.aiplatform.v1.EndpointService.DeployModel]: // /v1/endpoints/ENDPOINT/deployedModels/DEPLOYED_MODEL:predict // The placeholders in this value are replaced as follows: // @@ -553,7 +612,9 @@ message ModelContainerSpec { // as the [`AIP_ENDPOINT_ID` environment // variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) // - // * DEPLOYED_MODEL: [DeployedModel.id][google.cloud.aiplatform.v1.DeployedModel.id] of the `DeployedModel`. + // * DEPLOYED_MODEL: + // [DeployedModel.id][google.cloud.aiplatform.v1.DeployedModel.id] of the + // `DeployedModel`. // (Vertex AI makes this value available to your container code // as the [`AIP_DEPLOYED_MODEL_ID` environment // variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) @@ -571,7 +632,8 @@ message ModelContainerSpec { // [ports][google.cloud.aiplatform.v1.ModelContainerSpec.ports] field. // // If you don't specify this field, it defaults to the following value when - // you [deploy this Model to an Endpoint][google.cloud.aiplatform.v1.EndpointService.DeployModel]: + // you [deploy this Model to an + // Endpoint][google.cloud.aiplatform.v1.EndpointService.DeployModel]: // /v1/endpoints/ENDPOINT/deployedModels/DEPLOYED_MODEL:predict // The placeholders in this value are replaced as follows: // @@ -581,7 +643,9 @@ message ModelContainerSpec { // as the [`AIP_ENDPOINT_ID` environment // variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) // - // * DEPLOYED_MODEL: [DeployedModel.id][google.cloud.aiplatform.v1.DeployedModel.id] of the `DeployedModel`. + // * DEPLOYED_MODEL: + // [DeployedModel.id][google.cloud.aiplatform.v1.DeployedModel.id] of the + // `DeployedModel`. // (Vertex AI makes this value available to your container code as the // [`AIP_DEPLOYED_MODEL_ID` environment // variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/model_deployment_monitoring_job.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/model_deployment_monitoring_job.proto index 87252239df4..ecbda9d8487 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/model_deployment_monitoring_job.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/model_deployment_monitoring_job.proto @@ -96,7 +96,7 @@ message ModelDeploymentMonitoringJob { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. The user-defined name of the ModelDeploymentMonitoringJob. - // The name can be up to 128 characters long and can be consist of any UTF-8 + // The name can be up to 128 characters long and can consist of any UTF-8 // characters. // Display name of a ModelDeploymentMonitoringJob. string display_name = 2 [(google.api.field_behavior) = REQUIRED]; @@ -118,20 +118,27 @@ message ModelDeploymentMonitoringJob { JobState state = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Schedule state when the monitoring job is in Running state. - MonitoringScheduleState schedule_state = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + MonitoringScheduleState schedule_state = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Latest triggered monitoring pipeline metadata. - LatestMonitoringPipelineMetadata latest_monitoring_pipeline_metadata = 25 [(google.api.field_behavior) = OUTPUT_ONLY]; + LatestMonitoringPipelineMetadata latest_monitoring_pipeline_metadata = 25 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Required. The config for monitoring objectives. This is a per DeployedModel config. - // Each DeployedModel needs to be configured separately. - repeated ModelDeploymentMonitoringObjectiveConfig model_deployment_monitoring_objective_configs = 6 [(google.api.field_behavior) = REQUIRED]; + // Required. The config for monitoring objectives. This is a per DeployedModel + // config. Each DeployedModel needs to be configured separately. + repeated ModelDeploymentMonitoringObjectiveConfig + model_deployment_monitoring_objective_configs = 6 + [(google.api.field_behavior) = REQUIRED]; // Required. Schedule config for running the monitoring job. - ModelDeploymentMonitoringScheduleConfig model_deployment_monitoring_schedule_config = 7 [(google.api.field_behavior) = REQUIRED]; + ModelDeploymentMonitoringScheduleConfig + model_deployment_monitoring_schedule_config = 7 + [(google.api.field_behavior) = REQUIRED]; // Required. Sample Strategy for logging. - SamplingStrategy logging_sampling_strategy = 8 [(google.api.field_behavior) = REQUIRED]; + SamplingStrategy logging_sampling_strategy = 8 + [(google.api.field_behavior) = REQUIRED]; // Alert config for model monitoring. ModelMonitoringAlertConfig model_monitoring_alert_config = 15; @@ -142,10 +149,12 @@ message ModelDeploymentMonitoringJob { // requests. string predict_instance_schema_uri = 9; - // Sample Predict instance, same format as [PredictRequest.instances][google.cloud.aiplatform.v1.PredictRequest.instances], + // Sample Predict instance, same format as + // [PredictRequest.instances][google.cloud.aiplatform.v1.PredictRequest.instances], // this can be set as a replacement of - // [ModelDeploymentMonitoringJob.predict_instance_schema_uri][google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob.predict_instance_schema_uri]. If not set, - // we will generate predict schema from collected predict requests. + // [ModelDeploymentMonitoringJob.predict_instance_schema_uri][google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob.predict_instance_schema_uri]. + // If not set, we will generate predict schema from collected predict + // requests. google.protobuf.Value sample_predict_instance = 19; // YAML schema file uri describing the format of a single instance that you @@ -161,12 +170,13 @@ message ModelDeploymentMonitoringJob { // fields in predict instance formatted as string. string analysis_instance_schema_uri = 16; - // Output only. The created bigquery tables for the job under customer project. Customer - // could do their own query & analysis. There could be 4 log tables in - // maximum: + // Output only. The created bigquery tables for the job under customer + // project. Customer could do their own query & analysis. There could be 4 log + // tables in maximum: // 1. Training data logging predict request/response // 2. Serving data logging predict request/response - repeated ModelDeploymentMonitoringBigQueryTable bigquery_tables = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; + repeated ModelDeploymentMonitoringBigQueryTable bigquery_tables = 10 + [(google.api.field_behavior) = OUTPUT_ONLY]; // The TTL of BigQuery tables in user projects which stores logs. // A day is the basic unit of the TTL and we take the ceil of TTL/86400(a @@ -184,14 +194,18 @@ message ModelDeploymentMonitoringJob { map labels = 11; // Output only. Timestamp when this ModelDeploymentMonitoringJob was created. - google.protobuf.Timestamp create_time = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 12 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. Timestamp when this ModelDeploymentMonitoringJob was updated most recently. - google.protobuf.Timestamp update_time = 13 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. Timestamp when this ModelDeploymentMonitoringJob was updated + // most recently. + google.protobuf.Timestamp update_time = 13 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. Timestamp when this monitoring pipeline will be scheduled to run for the - // next round. - google.protobuf.Timestamp next_schedule_time = 14 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. Timestamp when this monitoring pipeline will be scheduled to + // run for the next round. + google.protobuf.Timestamp next_schedule_time = 14 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Stats anomalies base folder path. GcsDestination stats_anomalies_base_directory = 20; @@ -263,17 +277,19 @@ message ModelDeploymentMonitoringObjectiveConfig { // The config for scheduling monitoring job. message ModelDeploymentMonitoringScheduleConfig { - // Required. The model monitoring job scheduling interval. It will be rounded up to next - // full hour. This defines how often the monitoring jobs are triggered. - google.protobuf.Duration monitor_interval = 1 [(google.api.field_behavior) = REQUIRED]; + // Required. The model monitoring job scheduling interval. It will be rounded + // up to next full hour. This defines how often the monitoring jobs are + // triggered. + google.protobuf.Duration monitor_interval = 1 + [(google.api.field_behavior) = REQUIRED]; // The time window of the prediction data being included in each prediction // dataset. This window specifies how long the data should be collected from // historical model results for each run. If not set, - // [ModelDeploymentMonitoringScheduleConfig.monitor_interval][google.cloud.aiplatform.v1.ModelDeploymentMonitoringScheduleConfig.monitor_interval] will be used. - // e.g. If currently the cutoff time is 2022-01-08 14:30:00 and the - // monitor_window is set to be 3600, then data from 2022-01-08 13:30:00 - // to 2022-01-08 14:30:00 will be retrieved and aggregated to calculate the + // [ModelDeploymentMonitoringScheduleConfig.monitor_interval][google.cloud.aiplatform.v1.ModelDeploymentMonitoringScheduleConfig.monitor_interval] + // will be used. e.g. If currently the cutoff time is 2022-01-08 14:30:00 and + // the monitor_window is set to be 3600, then data from 2022-01-08 13:30:00 to + // 2022-01-08 14:30:00 will be retrieved and aggregated to calculate the // monitoring statistics. google.protobuf.Duration monitor_window = 2; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/model_evaluation.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/model_evaluation.proto index 5fc333e6693..a8f12525bf3 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/model_evaluation.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/model_evaluation.proto @@ -58,8 +58,8 @@ message ModelEvaluation { string display_name = 10; // Points to a YAML file stored on Google Cloud Storage describing the - // [metrics][google.cloud.aiplatform.v1.ModelEvaluation.metrics] of this ModelEvaluation. The schema is - // defined as an OpenAPI 3.0.2 [Schema + // [metrics][google.cloud.aiplatform.v1.ModelEvaluation.metrics] of this + // ModelEvaluation. The schema is defined as an OpenAPI 3.0.2 [Schema // Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). string metrics_schema_uri = 2; @@ -68,12 +68,13 @@ message ModelEvaluation { google.protobuf.Value metrics = 3; // Output only. Timestamp when this ModelEvaluation was created. - google.protobuf.Timestamp create_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; // All possible [dimensions][ModelEvaluationSlice.slice.dimension] of // ModelEvaluationSlices. The dimensions can be used as the filter of the - // [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices] request, in the form of - // `slice.dimension = `. + // [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices] + // request, in the form of `slice.dimension = `. repeated string slice_dimensions = 5; // Points to a YAML file stored on Google Cloud Storage describing @@ -104,8 +105,9 @@ message ModelEvaluation { // ModelExplanation model_explanation = 8; - // Describes the values of [ExplanationSpec][google.cloud.aiplatform.v1.ExplanationSpec] that are used for explaining - // the predicted values on the evaluated data. + // Describes the values of + // [ExplanationSpec][google.cloud.aiplatform.v1.ExplanationSpec] that are used + // for explaining the predicted values on the evaluated data. repeated ModelEvaluationExplanationSpec explanation_specs = 9; // The metadata of the ModelEvaluation. diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/model_evaluation_slice.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/model_evaluation_slice.proto index f28b013546d..085132e38d8 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/model_evaluation_slice.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/model_evaluation_slice.proto @@ -42,8 +42,10 @@ message ModelEvaluationSlice { // Output only. The dimension of the slice. // Well-known dimensions are: // * `annotationSpec`: This slice is on the test data that has either - // ground truth or prediction with [AnnotationSpec.display_name][google.cloud.aiplatform.v1.AnnotationSpec.display_name] - // equals to [value][google.cloud.aiplatform.v1.ModelEvaluationSlice.Slice.value]. + // ground truth or prediction with + // [AnnotationSpec.display_name][google.cloud.aiplatform.v1.AnnotationSpec.display_name] + // equals to + // [value][google.cloud.aiplatform.v1.ModelEvaluationSlice.Slice.value]. string dimension = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The value of the dimension in this slice. @@ -56,16 +58,19 @@ message ModelEvaluationSlice { // Output only. The slice of the test data that is used to evaluate the Model. Slice slice = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. Points to a YAML file stored on Google Cloud Storage describing the - // [metrics][google.cloud.aiplatform.v1.ModelEvaluationSlice.metrics] of this ModelEvaluationSlice. The - // schema is defined as an OpenAPI 3.0.2 [Schema + // Output only. Points to a YAML file stored on Google Cloud Storage + // describing the + // [metrics][google.cloud.aiplatform.v1.ModelEvaluationSlice.metrics] of this + // ModelEvaluationSlice. The schema is defined as an OpenAPI 3.0.2 [Schema // Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). string metrics_schema_uri = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. Sliced evaluation metrics of the Model. The schema of the metrics is stored - // in [metrics_schema_uri][google.cloud.aiplatform.v1.ModelEvaluationSlice.metrics_schema_uri] + // Output only. Sliced evaluation metrics of the Model. The schema of the + // metrics is stored in + // [metrics_schema_uri][google.cloud.aiplatform.v1.ModelEvaluationSlice.metrics_schema_uri] google.protobuf.Value metrics = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this ModelEvaluationSlice was created. - google.protobuf.Timestamp create_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/model_monitoring.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/model_monitoring.proto index 039161dde60..1b44c09230a 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/model_monitoring.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/model_monitoring.proto @@ -35,8 +35,8 @@ message ModelMonitoringObjectiveConfig { oneof data_source { // The resource name of the Dataset used to train this Model. string dataset = 3 [(google.api.resource_reference) = { - type: "aiplatform.googleapis.com/Dataset" - }]; + type: "aiplatform.googleapis.com/Dataset" + }]; // The Google Cloud Storage uri of the unmanaged Dataset used to train // this Model. @@ -111,8 +111,10 @@ message ModelMonitoringObjectiveConfig { // The config for integrating with Vertex Explainable AI. Only applicable if // the Model has explanation_spec populated. message ExplanationConfig { - // Output from [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob] for Model Monitoring baseline dataset, - // which can be used to generate baseline attribution scores. + // Output from + // [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob] for + // Model Monitoring baseline dataset, which can be used to generate baseline + // attribution scores. message ExplanationBaseline { // The storage format of the predictions generated BatchPrediction job. enum PredictionFormat { @@ -154,7 +156,8 @@ message ModelMonitoringObjectiveConfig { TrainingDataset training_dataset = 1; // The config for skew between training data and prediction data. - TrainingPredictionSkewDetectionConfig training_prediction_skew_detection_config = 2; + TrainingPredictionSkewDetectionConfig + training_prediction_skew_detection_config = 2; // The config for drift of prediction data. PredictionDriftDetectionConfig prediction_drift_detection_config = 3; diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/model_service.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/model_service.proto index 9ea6c56c4a8..cac89f57a70 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/model_service.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/model_service.proto @@ -39,7 +39,8 @@ option ruby_package = "Google::Cloud::AIPlatform::V1"; // A service for managing Vertex AI's machine learning Models. service ModelService { option (google.api.default_host) = "aiplatform.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/cloud-platform"; // Uploads a Model artifact into Vertex AI. rpc UploadModel(UploadModelRequest) returns (google.longrunning.Operation) { @@ -71,7 +72,8 @@ service ModelService { } // Lists versions of the specified model. - rpc ListModelVersions(ListModelVersionsRequest) returns (ListModelVersionsResponse) { + rpc ListModelVersions(ListModelVersionsRequest) + returns (ListModelVersionsResponse) { option (google.api.http) = { get: "/v1/{name=projects/*/locations/*/models/*}:listVersions" }; @@ -89,9 +91,12 @@ service ModelService { // 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. + // 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. rpc DeleteModel(DeleteModelRequest) returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1/{name=projects/*/locations/*/models/*}" @@ -107,8 +112,10 @@ service ModelService { // // 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.v1.ModelService.DeleteModel] for deleting the Model instead. - rpc DeleteModelVersion(DeleteModelVersionRequest) returns (google.longrunning.Operation) { + // [DeleteModel][google.cloud.aiplatform.v1.ModelService.DeleteModel] for + // deleting the Model instead. + rpc DeleteModelVersion(DeleteModelVersionRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1/{name=projects/*/locations/*/models/*}:deleteVersion" }; @@ -130,7 +137,8 @@ service ModelService { // 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]. + // [supported export + // format][google.cloud.aiplatform.v1.Model.supported_export_formats]. rpc ExportModel(ExportModelRequest) returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{name=projects/*/locations/*/models/*}:export" @@ -144,7 +152,8 @@ service ModelService { } // Imports an externally generated ModelEvaluation. - rpc ImportModelEvaluation(ImportModelEvaluationRequest) returns (ModelEvaluation) { + rpc ImportModelEvaluation(ImportModelEvaluationRequest) + returns (ModelEvaluation) { option (google.api.http) = { post: "/v1/{parent=projects/*/locations/*/models/*}/evaluations:import" body: "*" @@ -153,7 +162,8 @@ service ModelService { } // Imports a list of externally generated ModelEvaluationSlice. - rpc BatchImportModelEvaluationSlices(BatchImportModelEvaluationSlicesRequest) returns (BatchImportModelEvaluationSlicesResponse) { + rpc BatchImportModelEvaluationSlices(BatchImportModelEvaluationSlicesRequest) + returns (BatchImportModelEvaluationSlicesResponse) { option (google.api.http) = { post: "/v1/{parent=projects/*/locations/*/models/*/evaluations/*}/slices:batchImport" body: "*" @@ -170,7 +180,8 @@ service ModelService { } // Lists ModelEvaluations in a Model. - rpc ListModelEvaluations(ListModelEvaluationsRequest) returns (ListModelEvaluationsResponse) { + rpc ListModelEvaluations(ListModelEvaluationsRequest) + returns (ListModelEvaluationsResponse) { option (google.api.http) = { get: "/v1/{parent=projects/*/locations/*/models/*}/evaluations" }; @@ -178,7 +189,8 @@ service ModelService { } // Gets a ModelEvaluationSlice. - rpc GetModelEvaluationSlice(GetModelEvaluationSliceRequest) returns (ModelEvaluationSlice) { + rpc GetModelEvaluationSlice(GetModelEvaluationSliceRequest) + returns (ModelEvaluationSlice) { option (google.api.http) = { get: "/v1/{name=projects/*/locations/*/models/*/evaluations/*/slices/*}" }; @@ -186,7 +198,8 @@ service ModelService { } // Lists ModelEvaluationSlices in a ModelEvaluation. - rpc ListModelEvaluationSlices(ListModelEvaluationSlicesRequest) returns (ListModelEvaluationSlicesResponse) { + rpc ListModelEvaluationSlices(ListModelEvaluationSlicesRequest) + returns (ListModelEvaluationSlicesResponse) { option (google.api.http) = { get: "/v1/{parent=projects/*/locations/*/models/*/evaluations/*}/slices" }; @@ -194,7 +207,8 @@ service ModelService { } } -// Request message for [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel]. +// Request message for +// [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel]. message UploadModelRequest { // Required. The resource name of the Location into which to upload the Model. // Format: `projects/{project}/locations/{location}` @@ -205,8 +219,8 @@ message UploadModelRequest { } ]; - // Optional. The resource name of the model into which to upload the version. Only - // specify this field when uploading a new version. + // Optional. The resource name of the model into which to upload the version. + // Only specify this field when uploading a new version. string parent_model = 4 [(google.api.field_behavior) = OPTIONAL]; // Optional. The ID to use for the uploaded Model, which will become the final @@ -218,27 +232,41 @@ message UploadModelRequest { // Required. The Model to create. Model model = 2 [(google.api.field_behavior) = REQUIRED]; + + // Optional. The user-provided custom service account to use to do the model + // upload. If empty, [Vertex AI Service + // Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) + // will be used. Users uploading the Model must have the + // `iam.serviceAccounts.actAs` permission on this service account. Also, this + // account must belong to the project specified in the `parent` field and have + // all necessary read permissions. + string service_account = 6 [(google.api.field_behavior) = OPTIONAL]; } -// Details of [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel] operation. +// Details of +// [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel] +// operation. message UploadModelOperationMetadata { // The common part of the operation metadata. GenericOperationMetadata generic_metadata = 1; } -// Response message of [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel] operation. +// Response message of +// [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel] +// operation. message UploadModelResponse { // The name of the uploaded Model resource. // Format: `projects/{project}/locations/{location}/models/{model}` string model = 1 [(google.api.resource_reference) = { - type: "aiplatform.googleapis.com/Model" - }]; + type: "aiplatform.googleapis.com/Model" + }]; // Output only. The version ID of the model that is uploaded. string model_version_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; } -// Request message for [ModelService.GetModel][google.cloud.aiplatform.v1.ModelService.GetModel]. +// Request message for +// [ModelService.GetModel][google.cloud.aiplatform.v1.ModelService.GetModel]. message GetModelRequest { // Required. The name of the Model resource. // Format: `projects/{project}/locations/{location}/models/{model}` @@ -260,7 +288,8 @@ message GetModelRequest { ]; } -// Request message for [ModelService.ListModels][google.cloud.aiplatform.v1.ModelService.ListModels]. +// Request message for +// [ModelService.ListModels][google.cloud.aiplatform.v1.ModelService.ListModels]. message ListModelsRequest { // Required. The resource name of the Location to list the Models from. // Format: `projects/{project}/locations/{location}` @@ -275,7 +304,8 @@ message ListModelsRequest { // both snake_case and camelCase are supported. // // * `model` supports = and !=. `model` represents the Model ID, - // i.e. the last segment of the Model's [resource name][google.cloud.aiplatform.v1.Model.name]. + // i.e. the last segment of the Model's [resource + // name][google.cloud.aiplatform.v1.Model.name]. // * `display_name` supports = and != // * `labels` supports general map functions that is: // * `labels.key=value` - key:value equality @@ -294,8 +324,10 @@ message ListModelsRequest { // The standard list page token. // Typically obtained via - // [ListModelsResponse.next_page_token][google.cloud.aiplatform.v1.ListModelsResponse.next_page_token] of the previous - // [ModelService.ListModels][google.cloud.aiplatform.v1.ModelService.ListModels] call. + // [ListModelsResponse.next_page_token][google.cloud.aiplatform.v1.ListModelsResponse.next_page_token] + // of the previous + // [ModelService.ListModels][google.cloud.aiplatform.v1.ModelService.ListModels] + // call. string page_token = 4; // Mask specifying which fields to read. @@ -313,17 +345,21 @@ message ListModelsRequest { string order_by = 6; } -// Response message for [ModelService.ListModels][google.cloud.aiplatform.v1.ModelService.ListModels] +// Response message for +// [ModelService.ListModels][google.cloud.aiplatform.v1.ModelService.ListModels] message ListModelsResponse { // List of Models in the requested page. repeated Model models = 1; // A token to retrieve next page of results. - // Pass to [ListModelsRequest.page_token][google.cloud.aiplatform.v1.ListModelsRequest.page_token] to obtain that page. + // Pass to + // [ListModelsRequest.page_token][google.cloud.aiplatform.v1.ListModelsRequest.page_token] + // to obtain that page. string next_page_token = 2; } -// Request message for [ModelService.ListModelVersions][google.cloud.aiplatform.v1.ModelService.ListModelVersions]. +// Request message for +// [ModelService.ListModelVersions][google.cloud.aiplatform.v1.ModelService.ListModelVersions]. message ListModelVersionsRequest { // Required. The name of the model to list versions for. string name = 1 [ @@ -338,8 +374,8 @@ message ListModelVersionsRequest { // The standard list page token. // Typically obtained via - // [ListModelVersionsResponse.next_page_token][google.cloud.aiplatform.v1.ListModelVersionsResponse.next_page_token] of the previous - // [ModelService.ListModelversions][] call. + // [ListModelVersionsResponse.next_page_token][google.cloud.aiplatform.v1.ListModelVersionsResponse.next_page_token] + // of the previous [ModelService.ListModelversions][] call. string page_token = 3; // An expression for filtering the results of the request. For field names @@ -357,9 +393,20 @@ message ListModelVersionsRequest { // Mask specifying which fields to read. google.protobuf.FieldMask read_mask = 5; + + // A comma-separated list of fields to order by, sorted in ascending order. + // Use "desc" after a field name for descending. + // Supported fields: + // + // * `create_time` + // * `update_time` + // + // Example: `update_time asc, create_time desc`. + string order_by = 6; } -// Response message for [ModelService.ListModelVersions][google.cloud.aiplatform.v1.ModelService.ListModelVersions] +// Response message for +// [ModelService.ListModelVersions][google.cloud.aiplatform.v1.ModelService.ListModelVersions] message ListModelVersionsResponse { // List of Model versions in the requested page. // In the returned Model name field, version ID instead of regvision tag will @@ -367,11 +414,14 @@ message ListModelVersionsResponse { repeated Model models = 1; // A token to retrieve the next page of results. - // Pass to [ListModelVersionsRequest.page_token][google.cloud.aiplatform.v1.ListModelVersionsRequest.page_token] to obtain that page. + // Pass to + // [ListModelVersionsRequest.page_token][google.cloud.aiplatform.v1.ListModelVersionsRequest.page_token] + // to obtain that page. string next_page_token = 2; } -// Request message for [ModelService.UpdateModel][google.cloud.aiplatform.v1.ModelService.UpdateModel]. +// Request message for +// [ModelService.UpdateModel][google.cloud.aiplatform.v1.ModelService.UpdateModel]. message UpdateModelRequest { // Required. The Model which replaces the resource on the server. // When Model Versioning is enabled, the model.name will be used to determine @@ -394,11 +444,14 @@ message UpdateModelRequest { Model model = 1 [(google.api.field_behavior) = REQUIRED]; // Required. The update mask applies to the resource. - // For the `FieldMask` definition, see [google.protobuf.FieldMask][google.protobuf.FieldMask]. - google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED]; + // For the `FieldMask` definition, see + // [google.protobuf.FieldMask][google.protobuf.FieldMask]. + google.protobuf.FieldMask update_mask = 2 + [(google.api.field_behavior) = REQUIRED]; } -// Request message for [ModelService.DeleteModel][google.cloud.aiplatform.v1.ModelService.DeleteModel]. +// Request message for +// [ModelService.DeleteModel][google.cloud.aiplatform.v1.ModelService.DeleteModel]. message DeleteModelRequest { // Required. The name of the Model resource to be deleted. // Format: `projects/{project}/locations/{location}/models/{model}` @@ -410,10 +463,11 @@ message DeleteModelRequest { ]; } -// Request message for [ModelService.DeleteModelVersion][google.cloud.aiplatform.v1.ModelService.DeleteModelVersion]. +// Request message for +// [ModelService.DeleteModelVersion][google.cloud.aiplatform.v1.ModelService.DeleteModelVersion]. message DeleteModelVersionRequest { - // Required. The name of the model version to be deleted, with a version ID explicitly - // included. + // Required. The name of the model version to be deleted, with a version ID + // explicitly included. // // Example: `projects/{project}/locations/{location}/models/{model}@1234` string name = 1 [ @@ -424,7 +478,8 @@ message DeleteModelVersionRequest { ]; } -// Request message for [ModelService.MergeVersionAliases][google.cloud.aiplatform.v1.ModelService.MergeVersionAliases]. +// Request message for +// [ModelService.MergeVersionAliases][google.cloud.aiplatform.v1.ModelService.MergeVersionAliases]. message MergeVersionAliasesRequest { // Required. The name of the model version to merge aliases, with a version ID // explicitly included. @@ -452,13 +507,15 @@ message MergeVersionAliasesRequest { repeated string version_aliases = 2 [(google.api.field_behavior) = REQUIRED]; } -// Request message for [ModelService.ExportModel][google.cloud.aiplatform.v1.ModelService.ExportModel]. +// Request message for +// [ModelService.ExportModel][google.cloud.aiplatform.v1.ModelService.ExportModel]. message ExportModelRequest { // Output configuration for the Model export. message OutputConfig { // The ID of the format in which the Model must be exported. Each Model - // lists the [export formats it supports][google.cloud.aiplatform.v1.Model.supported_export_formats]. - // If no value is provided here, then the first from the list of the Model's + // lists the [export formats it + // supports][google.cloud.aiplatform.v1.Model.supported_export_formats]. If + // no value is provided here, then the first from the list of the Model's // supported formats is used by default. string export_format_id = 1; @@ -493,34 +550,38 @@ message ExportModelRequest { OutputConfig output_config = 2 [(google.api.field_behavior) = REQUIRED]; } -// Details of [ModelService.ExportModel][google.cloud.aiplatform.v1.ModelService.ExportModel] operation. +// Details of +// [ModelService.ExportModel][google.cloud.aiplatform.v1.ModelService.ExportModel] +// operation. message ExportModelOperationMetadata { // Further describes the output of the ExportModel. Supplements // [ExportModelRequest.OutputConfig][google.cloud.aiplatform.v1.ExportModelRequest.OutputConfig]. message OutputInfo { - // Output only. If the Model artifact is being exported to Google Cloud Storage this is - // the full path of the directory created, into which the Model files are - // being written to. + // Output only. If the Model artifact is being exported to Google Cloud + // Storage this is the full path of the directory created, into which the + // Model files are being written to. string artifact_output_uri = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. If the Model image is being exported to Google Container Registry or - // Artifact Registry this is the full path of the image created. + // Output only. If the Model image is being exported to Google Container + // Registry or Artifact Registry this is the full path of the image created. string image_output_uri = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; } // The common part of the operation metadata. GenericOperationMetadata generic_metadata = 1; - // Output only. Information further describing the output of this Model export. + // Output only. Information further describing the output of this Model + // export. OutputInfo output_info = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; } -// Response message of [ModelService.ExportModel][google.cloud.aiplatform.v1.ModelService.ExportModel] operation. -message ExportModelResponse { - -} +// Response message of +// [ModelService.ExportModel][google.cloud.aiplatform.v1.ModelService.ExportModel] +// operation. +message ExportModelResponse {} -// Request message for [ModelService.ImportModelEvaluation][google.cloud.aiplatform.v1.ModelService.ImportModelEvaluation] +// Request message for +// [ModelService.ImportModelEvaluation][google.cloud.aiplatform.v1.ModelService.ImportModelEvaluation] message ImportModelEvaluationRequest { // Required. The name of the parent model resource. // Format: `projects/{project}/locations/{location}/models/{model}` @@ -535,7 +596,8 @@ message ImportModelEvaluationRequest { ModelEvaluation model_evaluation = 2 [(google.api.field_behavior) = REQUIRED]; } -// Request message for [ModelService.BatchImportModelEvaluationSlices][google.cloud.aiplatform.v1.ModelService.BatchImportModelEvaluationSlices] +// Request message for +// [ModelService.BatchImportModelEvaluationSlices][google.cloud.aiplatform.v1.ModelService.BatchImportModelEvaluationSlices] message BatchImportModelEvaluationSlicesRequest { // Required. The name of the parent ModelEvaluation resource. // Format: @@ -548,16 +610,21 @@ message BatchImportModelEvaluationSlicesRequest { ]; // Required. Model evaluation slice resource to be imported. - repeated ModelEvaluationSlice model_evaluation_slices = 2 [(google.api.field_behavior) = REQUIRED]; + repeated ModelEvaluationSlice model_evaluation_slices = 2 + [(google.api.field_behavior) = REQUIRED]; } -// Response message for [ModelService.BatchImportModelEvaluationSlices][google.cloud.aiplatform.v1.ModelService.BatchImportModelEvaluationSlices] +// Response message for +// [ModelService.BatchImportModelEvaluationSlices][google.cloud.aiplatform.v1.ModelService.BatchImportModelEvaluationSlices] message BatchImportModelEvaluationSlicesResponse { - // Output only. List of imported [ModelEvaluationSlice.name][google.cloud.aiplatform.v1.ModelEvaluationSlice.name]. - repeated string imported_model_evaluation_slices = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. List of imported + // [ModelEvaluationSlice.name][google.cloud.aiplatform.v1.ModelEvaluationSlice.name]. + repeated string imported_model_evaluation_slices = 1 + [(google.api.field_behavior) = OUTPUT_ONLY]; } -// Request message for [ModelService.GetModelEvaluation][google.cloud.aiplatform.v1.ModelService.GetModelEvaluation]. +// Request message for +// [ModelService.GetModelEvaluation][google.cloud.aiplatform.v1.ModelService.GetModelEvaluation]. message GetModelEvaluationRequest { // Required. The name of the ModelEvaluation resource. // Format: @@ -570,7 +637,8 @@ message GetModelEvaluationRequest { ]; } -// Request message for [ModelService.ListModelEvaluations][google.cloud.aiplatform.v1.ModelService.ListModelEvaluations]. +// Request message for +// [ModelService.ListModelEvaluations][google.cloud.aiplatform.v1.ModelService.ListModelEvaluations]. message ListModelEvaluationsRequest { // Required. The resource name of the Model to list the ModelEvaluations from. // Format: `projects/{project}/locations/{location}/models/{model}` @@ -589,25 +657,31 @@ message ListModelEvaluationsRequest { // The standard list page token. // Typically obtained via - // [ListModelEvaluationsResponse.next_page_token][google.cloud.aiplatform.v1.ListModelEvaluationsResponse.next_page_token] of the previous - // [ModelService.ListModelEvaluations][google.cloud.aiplatform.v1.ModelService.ListModelEvaluations] call. + // [ListModelEvaluationsResponse.next_page_token][google.cloud.aiplatform.v1.ListModelEvaluationsResponse.next_page_token] + // of the previous + // [ModelService.ListModelEvaluations][google.cloud.aiplatform.v1.ModelService.ListModelEvaluations] + // call. string page_token = 4; // Mask specifying which fields to read. google.protobuf.FieldMask read_mask = 5; } -// Response message for [ModelService.ListModelEvaluations][google.cloud.aiplatform.v1.ModelService.ListModelEvaluations]. +// Response message for +// [ModelService.ListModelEvaluations][google.cloud.aiplatform.v1.ModelService.ListModelEvaluations]. message ListModelEvaluationsResponse { // List of ModelEvaluations in the requested page. repeated ModelEvaluation model_evaluations = 1; // A token to retrieve next page of results. - // Pass to [ListModelEvaluationsRequest.page_token][google.cloud.aiplatform.v1.ListModelEvaluationsRequest.page_token] to obtain that page. + // Pass to + // [ListModelEvaluationsRequest.page_token][google.cloud.aiplatform.v1.ListModelEvaluationsRequest.page_token] + // to obtain that page. string next_page_token = 2; } -// Request message for [ModelService.GetModelEvaluationSlice][google.cloud.aiplatform.v1.ModelService.GetModelEvaluationSlice]. +// Request message for +// [ModelService.GetModelEvaluationSlice][google.cloud.aiplatform.v1.ModelService.GetModelEvaluationSlice]. message GetModelEvaluationSliceRequest { // Required. The name of the ModelEvaluationSlice resource. // Format: @@ -620,10 +694,11 @@ message GetModelEvaluationSliceRequest { ]; } -// Request message for [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices]. +// Request message for +// [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices]. message ListModelEvaluationSlicesRequest { - // Required. The resource name of the ModelEvaluation to list the ModelEvaluationSlices - // from. Format: + // Required. The resource name of the ModelEvaluation to list the + // ModelEvaluationSlices from. Format: // `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, @@ -642,21 +717,25 @@ message ListModelEvaluationSlicesRequest { // The standard list page token. // Typically obtained via - // [ListModelEvaluationSlicesResponse.next_page_token][google.cloud.aiplatform.v1.ListModelEvaluationSlicesResponse.next_page_token] of the previous - // [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices] call. + // [ListModelEvaluationSlicesResponse.next_page_token][google.cloud.aiplatform.v1.ListModelEvaluationSlicesResponse.next_page_token] + // of the previous + // [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices] + // call. string page_token = 4; // Mask specifying which fields to read. google.protobuf.FieldMask read_mask = 5; } -// Response message for [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices]. +// Response message for +// [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices]. message ListModelEvaluationSlicesResponse { // List of ModelEvaluations in the requested page. repeated ModelEvaluationSlice model_evaluation_slices = 1; // A token to retrieve next page of results. - // Pass to [ListModelEvaluationSlicesRequest.page_token][google.cloud.aiplatform.v1.ListModelEvaluationSlicesRequest.page_token] to obtain that - // page. + // Pass to + // [ListModelEvaluationSlicesRequest.page_token][google.cloud.aiplatform.v1.ListModelEvaluationSlicesRequest.page_token] + // to obtain that page. string next_page_token = 2; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/operation.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/operation.proto index da7c5dcc23e..e1d4a90079f 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/operation.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/operation.proto @@ -33,16 +33,19 @@ message GenericOperationMetadata { // Output only. Partial failures encountered. // E.g. single files that couldn't be read. // This field should never exceed 20 entries. - // Status details field will contain standard GCP error details. - repeated google.rpc.Status partial_failures = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Status details field will contain standard Google Cloud error details. + repeated google.rpc.Status partial_failures = 1 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Time when the operation was created. - google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 2 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Time when the operation was updated for the last time. // If the operation has finished (successfully or not), this is the finish // time. - google.protobuf.Timestamp update_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // Details of operations that perform deletes of any entities. diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/pipeline_job.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/pipeline_job.proto index 656a385b9aa..66f862a4f7b 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/pipeline_job.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/pipeline_job.proto @@ -54,24 +54,26 @@ message PipelineJob { message InputArtifact { oneof kind { // Artifact resource id from MLMD. Which is the last portion of an - // artifact resource - // name(projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}). + // artifact resource name: + // `projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}`. // The artifact must stay within the same project, location and default // metadatastore as the pipeline. string artifact_id = 1; } } - // Deprecated. Use [RuntimeConfig.parameter_values][google.cloud.aiplatform.v1.PipelineJob.RuntimeConfig.parameter_values] instead. The runtime - // parameters of the PipelineJob. The parameters will be passed into - // [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec] to replace the placeholders at runtime. - // This field is used by pipelines built using - // `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower, such as - // pipelines built using Kubeflow Pipelines SDK 1.8 or lower. + // Deprecated. Use + // [RuntimeConfig.parameter_values][google.cloud.aiplatform.v1.PipelineJob.RuntimeConfig.parameter_values] + // instead. The runtime parameters of the PipelineJob. The parameters will + // be passed into + // [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec] + // to replace the placeholders at runtime. This field is used by pipelines + // built using `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower, + // such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower. map parameters = 1 [deprecated = true]; - // Required. A path in a Cloud Storage bucket, which will be treated as the root - // output directory of the pipeline. It is used by the system to + // Required. A path in a Cloud Storage bucket, which will be treated as the + // root output directory of the pipeline. It is used by the system to // generate the paths of output artifacts. The artifact paths are generated // with a sub-path pattern `{job_id}/{task_id}/{output_key}` under the // specified output directory. The service account specified in this @@ -80,10 +82,12 @@ message PipelineJob { string gcs_output_directory = 2 [(google.api.field_behavior) = REQUIRED]; // The runtime parameters of the PipelineJob. The parameters will be - // passed into [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec] to replace the placeholders - // at runtime. This field is used by pipelines built using - // `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as pipelines built - // using Kubeflow Pipelines SDK 1.9 or higher and the v2 DSL. + // passed into + // [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec] + // to replace the placeholders at runtime. This field is used by pipelines + // built using `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as + // pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2 + // DSL. map parameter_values = 3; // Represents the failure policy of a pipeline. Currently, the default of a @@ -103,21 +107,25 @@ message PipelineJob { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // The display name of the Pipeline. - // The name can be up to 128 characters long and can be consist of any UTF-8 + // The name can be up to 128 characters long and can consist of any UTF-8 // characters. string display_name = 2; // Output only. Pipeline creation time. - google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Pipeline start time. - google.protobuf.Timestamp start_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp start_time = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Pipeline end time. - google.protobuf.Timestamp end_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp end_time = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this PipelineJob was most recently updated. - google.protobuf.Timestamp update_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 6 + [(google.api.field_behavior) = OUTPUT_ONLY]; // The spec of the pipeline. google.protobuf.Struct pipeline_spec = 7; @@ -168,31 +176,36 @@ message PipelineJob { // network name. // // Private services access must already be configured for the network. - // Pipeline job will apply the network configuration to the GCP resources - // being launched, if applied, such as Vertex AI + // Pipeline job will apply the network configuration to the Google Cloud + // resources being launched, if applied, such as Vertex AI // Training or Dataflow job. If left unspecified, the workload is not peered // with any network. - string network = 18 [(google.api.resource_reference) = { - type: "compute.googleapis.com/Network" - }]; + string network = 18 [ + (google.api.resource_reference) = { type: "compute.googleapis.com/Network" } + ]; - // A template uri from where the [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec], if empty, will - // be downloaded. + // A template uri from where the + // [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec], + // if empty, will be downloaded. string template_uri = 19; // Output only. Pipeline template metadata. Will fill up fields if - // [PipelineJob.template_uri][google.cloud.aiplatform.v1.PipelineJob.template_uri] is from supported template registry. - PipelineTemplateMetadata template_metadata = 20 [(google.api.field_behavior) = OUTPUT_ONLY]; + // [PipelineJob.template_uri][google.cloud.aiplatform.v1.PipelineJob.template_uri] + // is from supported template registry. + PipelineTemplateMetadata template_metadata = 20 + [(google.api.field_behavior) = OUTPUT_ONLY]; } -// Pipeline template metadata if [PipelineJob.template_uri][google.cloud.aiplatform.v1.PipelineJob.template_uri] is from supported -// template registry. Currently, the only supported registry is Artifact -// Registry. +// Pipeline template metadata if +// [PipelineJob.template_uri][google.cloud.aiplatform.v1.PipelineJob.template_uri] +// is from supported template registry. Currently, the only supported registry +// is Artifact Registry. message PipelineTemplateMetadata { // The version_name in artifact registry. // - // Will always be presented in output if the [PipelineJob.template_uri][google.cloud.aiplatform.v1.PipelineJob.template_uri] is - // from supported template registry. + // Will always be presented in output if the + // [PipelineJob.template_uri][google.cloud.aiplatform.v1.PipelineJob.template_uri] + // is from supported template registry. // // Format is "sha256:abcdef123456...". string version = 3; @@ -207,7 +220,8 @@ message PipelineJobDetail { Context pipeline_run_context = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The runtime details of the tasks under the pipeline. - repeated PipelineTaskDetail task_details = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + repeated PipelineTaskDetail task_details = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // The runtime detail of a task execution. @@ -215,17 +229,17 @@ message PipelineTaskDetail { // A single record of the task status. message PipelineTaskStatus { // Output only. Update time of this status. - google.protobuf.Timestamp update_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 1 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The state of the task. State state = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. The error that occurred during the state. May be set when the state is - // any of the non-final state (PENDING/RUNNING/CANCELLING) or FAILED state. - // If the state is FAILED, the error here is final and not going to be - // retried. - // If the state is a non-final state, the error indicates a system-error - // being retried. + // Output only. The error that occurred during the state. May be set when + // the state is any of the non-final state (PENDING/RUNNING/CANCELLING) or + // FAILED state. If the state is FAILED, the error here is final and not + // going to be retried. If the state is a non-final state, the error + // indicates a system-error being retried. google.rpc.Status error = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; } @@ -266,15 +280,16 @@ message PipelineTaskDetail { // Specifies that the task was not triggered because the task's trigger // policy is not satisfied. The trigger policy is specified in the - // `condition` field of [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec]. + // `condition` field of + // [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec]. NOT_TRIGGERED = 9; } // Output only. The system generated ID of the task. int64 task_id = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. The id of the parent task if the task is within a component scope. - // Empty if the task is at the root level. + // Output only. The id of the parent task if the task is within a component + // scope. Empty if the task is at the root level. int64 parent_task_id = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The user specified name of the task that is defined in @@ -282,16 +297,20 @@ message PipelineTaskDetail { string task_name = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Task create time. - google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Task start time. - google.protobuf.Timestamp start_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp start_time = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Task end time. - google.protobuf.Timestamp end_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp end_time = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The detailed execution info. - PipelineTaskExecutorDetail executor_detail = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + PipelineTaskExecutorDetail executor_detail = 6 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. State of the task. State state = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; @@ -303,15 +322,18 @@ message PipelineTaskDetail { // Only populated when the task's state is FAILED or CANCELLED. google.rpc.Status error = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. A list of task status. This field keeps a record of task status evolving - // over time. - repeated PipelineTaskStatus pipeline_task_status = 13 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. A list of task status. This field keeps a record of task + // status evolving over time. + repeated PipelineTaskStatus pipeline_task_status = 13 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The runtime input artifacts of the task. - map inputs = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; + map inputs = 10 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The runtime output artifacts of the task. - map outputs = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; + map outputs = 11 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // The runtime detail of a pipeline executor. @@ -319,7 +341,9 @@ message PipelineTaskExecutorDetail { // The detail of a container execution. It contains the job names of the // lifecycle of a container execution. message ContainerDetail { - // Output only. The name of the [CustomJob][google.cloud.aiplatform.v1.CustomJob] for the main container execution. + // Output only. The name of the + // [CustomJob][google.cloud.aiplatform.v1.CustomJob] for the main container + // execution. string main_job = 1 [ (google.api.field_behavior) = OUTPUT_ONLY, (google.api.resource_reference) = { @@ -327,23 +351,40 @@ message PipelineTaskExecutorDetail { } ]; - // Output only. The name of the [CustomJob][google.cloud.aiplatform.v1.CustomJob] for the pre-caching-check container - // execution. This job will be available if the - // [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec] specifies the `pre_caching_check` hook in - // the lifecycle events. + // Output only. The name of the + // [CustomJob][google.cloud.aiplatform.v1.CustomJob] for the + // pre-caching-check container execution. This job will be available if the + // [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec] + // specifies the `pre_caching_check` hook in the lifecycle events. string pre_caching_check_job = 2 [ (google.api.field_behavior) = OUTPUT_ONLY, (google.api.resource_reference) = { type: "aiplatform.googleapis.com/CustomJob" } ]; + + // Output only. The names of the previously failed + // [CustomJob][google.cloud.aiplatform.v1.CustomJob] for the main container + // executions. The list includes the all attempts in chronological order. + repeated string failed_main_jobs = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The names of the previously failed + // [CustomJob][google.cloud.aiplatform.v1.CustomJob] for the + // pre-caching-check container executions. This job will be available if the + // [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec] + // specifies the `pre_caching_check` hook in the lifecycle events. The list + // includes the all attempts in chronological order. + repeated string failed_pre_caching_check_jobs = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // The detailed info for a custom job executor. message CustomJobDetail { option deprecated = true; - // Output only. The name of the [CustomJob][google.cloud.aiplatform.v1.CustomJob]. + // Output only. The name of the + // [CustomJob][google.cloud.aiplatform.v1.CustomJob]. string job = 1 [ (google.api.field_behavior) = OUTPUT_ONLY, (google.api.resource_reference) = { @@ -354,12 +395,11 @@ message PipelineTaskExecutorDetail { oneof details { // Output only. The detailed info for a container executor. - ContainerDetail container_detail = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + ContainerDetail container_detail = 1 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The detailed info for a custom job executor. - CustomJobDetail custom_job_detail = 2 [ - deprecated = true, - (google.api.field_behavior) = OUTPUT_ONLY - ]; + CustomJobDetail custom_job_detail = 2 + [deprecated = true, (google.api.field_behavior) = OUTPUT_ONLY]; } } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/pipeline_service.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/pipeline_service.proto index 0cd46b32902..ada10871dc7 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/pipeline_service.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/pipeline_service.proto @@ -39,11 +39,13 @@ option ruby_package = "Google::Cloud::AIPlatform::V1"; // `PipelineJob` resources (used for Vertex AI Pipelines). service PipelineService { option (google.api.default_host) = "aiplatform.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/cloud-platform"; // Creates a TrainingPipeline. A created TrainingPipeline right away will be // attempted to be run. - rpc CreateTrainingPipeline(CreateTrainingPipelineRequest) returns (TrainingPipeline) { + rpc CreateTrainingPipeline(CreateTrainingPipelineRequest) + returns (TrainingPipeline) { option (google.api.http) = { post: "/v1/{parent=projects/*/locations/*}/trainingPipelines" body: "training_pipeline" @@ -52,7 +54,8 @@ service PipelineService { } // Gets a TrainingPipeline. - rpc GetTrainingPipeline(GetTrainingPipelineRequest) returns (TrainingPipeline) { + rpc GetTrainingPipeline(GetTrainingPipelineRequest) + returns (TrainingPipeline) { option (google.api.http) = { get: "/v1/{name=projects/*/locations/*/trainingPipelines/*}" }; @@ -60,7 +63,8 @@ service PipelineService { } // Lists TrainingPipelines in a Location. - rpc ListTrainingPipelines(ListTrainingPipelinesRequest) returns (ListTrainingPipelinesResponse) { + rpc ListTrainingPipelines(ListTrainingPipelinesRequest) + returns (ListTrainingPipelinesResponse) { option (google.api.http) = { get: "/v1/{parent=projects/*/locations/*}/trainingPipelines" }; @@ -68,7 +72,8 @@ service PipelineService { } // Deletes a TrainingPipeline. - rpc DeleteTrainingPipeline(DeleteTrainingPipelineRequest) returns (google.longrunning.Operation) { + rpc DeleteTrainingPipeline(DeleteTrainingPipelineRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1/{name=projects/*/locations/*/trainingPipelines/*}" }; @@ -82,14 +87,19 @@ service PipelineService { // 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 + // 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`. - rpc CancelTrainingPipeline(CancelTrainingPipelineRequest) returns (google.protobuf.Empty) { + // 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`. + rpc CancelTrainingPipeline(CancelTrainingPipelineRequest) + returns (google.protobuf.Empty) { option (google.api.http) = { post: "/v1/{name=projects/*/locations/*/trainingPipelines/*}:cancel" body: "*" @@ -103,7 +113,8 @@ service PipelineService { post: "/v1/{parent=projects/*/locations/*}/pipelineJobs" body: "pipeline_job" }; - option (google.api.method_signature) = "parent,pipeline_job,pipeline_job_id"; + option (google.api.method_signature) = + "parent,pipeline_job,pipeline_job_id"; } // Gets a PipelineJob. @@ -115,7 +126,8 @@ service PipelineService { } // Lists PipelineJobs in a Location. - rpc ListPipelineJobs(ListPipelineJobsRequest) returns (ListPipelineJobsResponse) { + rpc ListPipelineJobs(ListPipelineJobsRequest) + returns (ListPipelineJobsResponse) { option (google.api.http) = { get: "/v1/{parent=projects/*/locations/*}/pipelineJobs" }; @@ -123,7 +135,8 @@ service PipelineService { } // Deletes a PipelineJob. - rpc DeletePipelineJob(DeletePipelineJobRequest) returns (google.longrunning.Operation) { + rpc DeletePipelineJob(DeletePipelineJobRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1/{name=projects/*/locations/*/pipelineJobs/*}" }; @@ -137,14 +150,18 @@ service PipelineService { // 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 + // 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 + // 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`. - rpc CancelPipelineJob(CancelPipelineJobRequest) returns (google.protobuf.Empty) { + rpc CancelPipelineJob(CancelPipelineJobRequest) + returns (google.protobuf.Empty) { option (google.api.http) = { post: "/v1/{name=projects/*/locations/*/pipelineJobs/*}:cancel" body: "*" @@ -153,10 +170,11 @@ service PipelineService { } } -// Request message for [PipelineService.CreateTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.CreateTrainingPipeline]. +// Request message for +// [PipelineService.CreateTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.CreateTrainingPipeline]. message CreateTrainingPipelineRequest { - // Required. The resource name of the Location to create the TrainingPipeline in. - // Format: `projects/{project}/locations/{location}` + // Required. The resource name of the Location to create the TrainingPipeline + // in. Format: `projects/{project}/locations/{location}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -165,10 +183,12 @@ message CreateTrainingPipelineRequest { ]; // Required. The TrainingPipeline to create. - TrainingPipeline training_pipeline = 2 [(google.api.field_behavior) = REQUIRED]; + TrainingPipeline training_pipeline = 2 + [(google.api.field_behavior) = REQUIRED]; } -// Request message for [PipelineService.GetTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.GetTrainingPipeline]. +// Request message for +// [PipelineService.GetTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.GetTrainingPipeline]. message GetTrainingPipelineRequest { // Required. The name of the TrainingPipeline resource. // Format: @@ -181,10 +201,11 @@ message GetTrainingPipelineRequest { ]; } -// Request message for [PipelineService.ListTrainingPipelines][google.cloud.aiplatform.v1.PipelineService.ListTrainingPipelines]. +// Request message for +// [PipelineService.ListTrainingPipelines][google.cloud.aiplatform.v1.PipelineService.ListTrainingPipelines]. message ListTrainingPipelinesRequest { - // Required. The resource name of the Location to list the TrainingPipelines from. - // Format: `projects/{project}/locations/{location}` + // Required. The resource name of the Location to list the TrainingPipelines + // from. Format: `projects/{project}/locations/{location}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -219,25 +240,31 @@ message ListTrainingPipelinesRequest { // The standard list page token. // Typically obtained via - // [ListTrainingPipelinesResponse.next_page_token][google.cloud.aiplatform.v1.ListTrainingPipelinesResponse.next_page_token] of the previous - // [PipelineService.ListTrainingPipelines][google.cloud.aiplatform.v1.PipelineService.ListTrainingPipelines] call. + // [ListTrainingPipelinesResponse.next_page_token][google.cloud.aiplatform.v1.ListTrainingPipelinesResponse.next_page_token] + // of the previous + // [PipelineService.ListTrainingPipelines][google.cloud.aiplatform.v1.PipelineService.ListTrainingPipelines] + // call. string page_token = 4; // Mask specifying which fields to read. google.protobuf.FieldMask read_mask = 5; } -// Response message for [PipelineService.ListTrainingPipelines][google.cloud.aiplatform.v1.PipelineService.ListTrainingPipelines] +// Response message for +// [PipelineService.ListTrainingPipelines][google.cloud.aiplatform.v1.PipelineService.ListTrainingPipelines] message ListTrainingPipelinesResponse { // List of TrainingPipelines in the requested page. repeated TrainingPipeline training_pipelines = 1; // A token to retrieve the next page of results. - // Pass to [ListTrainingPipelinesRequest.page_token][google.cloud.aiplatform.v1.ListTrainingPipelinesRequest.page_token] to obtain that page. + // Pass to + // [ListTrainingPipelinesRequest.page_token][google.cloud.aiplatform.v1.ListTrainingPipelinesRequest.page_token] + // to obtain that page. string next_page_token = 2; } -// Request message for [PipelineService.DeleteTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.DeleteTrainingPipeline]. +// Request message for +// [PipelineService.DeleteTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.DeleteTrainingPipeline]. message DeleteTrainingPipelineRequest { // Required. The name of the TrainingPipeline resource to be deleted. // Format: @@ -250,7 +277,8 @@ message DeleteTrainingPipelineRequest { ]; } -// Request message for [PipelineService.CancelTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.CancelTrainingPipeline]. +// Request message for +// [PipelineService.CancelTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.CancelTrainingPipeline]. message CancelTrainingPipelineRequest { // Required. The name of the TrainingPipeline to cancel. // Format: @@ -263,7 +291,8 @@ message CancelTrainingPipelineRequest { ]; } -// Request message for [PipelineService.CreatePipelineJob][google.cloud.aiplatform.v1.PipelineService.CreatePipelineJob]. +// Request message for +// [PipelineService.CreatePipelineJob][google.cloud.aiplatform.v1.PipelineService.CreatePipelineJob]. message CreatePipelineJobRequest { // Required. The resource name of the Location to create the PipelineJob in. // Format: `projects/{project}/locations/{location}` @@ -286,7 +315,8 @@ message CreatePipelineJobRequest { string pipeline_job_id = 3; } -// Request message for [PipelineService.GetPipelineJob][google.cloud.aiplatform.v1.PipelineService.GetPipelineJob]. +// Request message for +// [PipelineService.GetPipelineJob][google.cloud.aiplatform.v1.PipelineService.GetPipelineJob]. message GetPipelineJobRequest { // Required. The name of the PipelineJob resource. // Format: @@ -299,7 +329,8 @@ message GetPipelineJobRequest { ]; } -// Request message for [PipelineService.ListPipelineJobs][google.cloud.aiplatform.v1.PipelineService.ListPipelineJobs]. +// Request message for +// [PipelineService.ListPipelineJobs][google.cloud.aiplatform.v1.PipelineService.ListPipelineJobs]. message ListPipelineJobsRequest { // Required. The resource name of the Location to list the PipelineJobs from. // Format: `projects/{project}/locations/{location}` @@ -351,8 +382,10 @@ message ListPipelineJobsRequest { // The standard list page token. // Typically obtained via - // [ListPipelineJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListPipelineJobsResponse.next_page_token] of the previous - // [PipelineService.ListPipelineJobs][google.cloud.aiplatform.v1.PipelineService.ListPipelineJobs] call. + // [ListPipelineJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListPipelineJobsResponse.next_page_token] + // of the previous + // [PipelineService.ListPipelineJobs][google.cloud.aiplatform.v1.PipelineService.ListPipelineJobs] + // call. string page_token = 4; // A comma-separated list of fields to order by. The default sort order is in @@ -374,17 +407,21 @@ message ListPipelineJobsRequest { google.protobuf.FieldMask read_mask = 7; } -// Response message for [PipelineService.ListPipelineJobs][google.cloud.aiplatform.v1.PipelineService.ListPipelineJobs] +// Response message for +// [PipelineService.ListPipelineJobs][google.cloud.aiplatform.v1.PipelineService.ListPipelineJobs] message ListPipelineJobsResponse { // List of PipelineJobs in the requested page. repeated PipelineJob pipeline_jobs = 1; // A token to retrieve the next page of results. - // Pass to [ListPipelineJobsRequest.page_token][google.cloud.aiplatform.v1.ListPipelineJobsRequest.page_token] to obtain that page. + // Pass to + // [ListPipelineJobsRequest.page_token][google.cloud.aiplatform.v1.ListPipelineJobsRequest.page_token] + // to obtain that page. string next_page_token = 2; } -// Request message for [PipelineService.DeletePipelineJob][google.cloud.aiplatform.v1.PipelineService.DeletePipelineJob]. +// Request message for +// [PipelineService.DeletePipelineJob][google.cloud.aiplatform.v1.PipelineService.DeletePipelineJob]. message DeletePipelineJobRequest { // Required. The name of the PipelineJob resource to be deleted. // Format: @@ -397,7 +434,8 @@ message DeletePipelineJobRequest { ]; } -// Request message for [PipelineService.CancelPipelineJob][google.cloud.aiplatform.v1.PipelineService.CancelPipelineJob]. +// Request message for +// [PipelineService.CancelPipelineJob][google.cloud.aiplatform.v1.PipelineService.CancelPipelineJob]. message CancelPipelineJobRequest { // Required. The name of the PipelineJob to cancel. // Format: diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/prediction_service.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/prediction_service.proto index 36096fd9ef2..e2f5e420293 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/prediction_service.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/prediction_service.proto @@ -35,7 +35,8 @@ option ruby_package = "Google::Cloud::AIPlatform::V1"; // A service for online predictions and explanations. service PredictionService { option (google.api.default_host) = "aiplatform.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/cloud-platform"; // Perform an online prediction. rpc Predict(PredictRequest) returns (PredictResponse) { @@ -50,11 +51,13 @@ service PredictionService { // // The response includes the following HTTP headers: // - // * `X-Vertex-AI-Endpoint-Id`: ID of the [Endpoint][google.cloud.aiplatform.v1.Endpoint] that served this + // * `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. + // * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's + // [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] that served this + // prediction. rpc RawPredict(RawPredictRequest) returns (google.api.HttpBody) { option (google.api.http) = { post: "/v1/{endpoint=projects/*/locations/*/endpoints/*}:rawPredict" @@ -65,10 +68,12 @@ service PredictionService { // Perform an online explanation. // - // If [deployed_model_id][google.cloud.aiplatform.v1.ExplainRequest.deployed_model_id] is specified, - // the corresponding DeployModel must have + // 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] + // 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 @@ -78,11 +83,13 @@ service PredictionService { post: "/v1/{endpoint=projects/*/locations/*/endpoints/*}:explain" body: "*" }; - option (google.api.method_signature) = "endpoint,instances,parameters,deployed_model_id"; + option (google.api.method_signature) = + "endpoint,instances,parameters,deployed_model_id"; } } -// Request message for [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict]. +// Request message for +// [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict]. message PredictRequest { // Required. The name of the Endpoint requested to serve the prediction. // Format: @@ -103,16 +110,19 @@ message PredictRequest { // DeployedModels' [Model's][google.cloud.aiplatform.v1.DeployedModel.model] // [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata] // [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri]. - repeated google.protobuf.Value instances = 2 [(google.api.field_behavior) = REQUIRED]; + repeated google.protobuf.Value instances = 2 + [(google.api.field_behavior) = REQUIRED]; // The parameters that govern the prediction. The schema of the parameters may - // be specified via Endpoint's DeployedModels' [Model's ][google.cloud.aiplatform.v1.DeployedModel.model] + // be specified via Endpoint's DeployedModels' [Model's + // ][google.cloud.aiplatform.v1.DeployedModel.model] // [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata] // [parameters_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri]. google.protobuf.Value parameters = 3; } -// Response message for [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict]. +// Response message for +// [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict]. message PredictResponse { // The predictions that are the output of the predictions call. // The schema of any single prediction may be specified via Endpoint's @@ -124,8 +134,8 @@ message PredictResponse { // ID of the Endpoint's DeployedModel that served this prediction. string deployed_model_id = 2; - // Output only. The resource name of the Model which is deployed as the DeployedModel that - // this prediction hits. + // Output only. The resource name of the Model which is deployed as the + // DeployedModel that this prediction hits. string model = 3 [ (google.api.field_behavior) = OUTPUT_ONLY, (google.api.resource_reference) = { @@ -133,16 +143,18 @@ message PredictResponse { } ]; - // Output only. The version ID of the Model which is deployed as the DeployedModel that - // this prediction hits. + // Output only. The version ID of the Model which is deployed as the + // DeployedModel that this prediction hits. string model_version_id = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. The [display name][google.cloud.aiplatform.v1.Model.display_name] of the Model which is deployed as - // the DeployedModel that this prediction hits. + // Output only. The [display + // name][google.cloud.aiplatform.v1.Model.display_name] of the Model which is + // deployed as the DeployedModel that this prediction hits. string model_display_name = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; } -// Request message for [PredictionService.RawPredict][google.cloud.aiplatform.v1.PredictionService.RawPredict]. +// Request message for +// [PredictionService.RawPredict][google.cloud.aiplatform.v1.PredictionService.RawPredict]. message RawPredictRequest { // Required. The name of the Endpoint requested to serve the prediction. // Format: @@ -156,21 +168,24 @@ message RawPredictRequest { // The prediction input. Supports HTTP headers and arbitrary data payload. // - // A [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] may have an upper limit on the number of instances it - // supports per request. When this limit it is exceeded for an AutoML model, - // the [RawPredict][google.cloud.aiplatform.v1.PredictionService.RawPredict] method returns an error. - // When this limit is exceeded for a custom-trained model, the behavior varies - // depending on the model. + // A [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] may have an + // upper limit on the number of instances it supports per request. When this + // limit it is exceeded for an AutoML model, the + // [RawPredict][google.cloud.aiplatform.v1.PredictionService.RawPredict] + // method returns an error. When this limit is exceeded for a custom-trained + // model, the behavior varies depending on the model. // // You can specify the schema for each instance in the // [predict_schemata.instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri] - // field when you create a [Model][google.cloud.aiplatform.v1.Model]. This schema applies when you deploy the - // `Model` as a `DeployedModel` to an [Endpoint][google.cloud.aiplatform.v1.Endpoint] and use the `RawPredict` + // field when you create a [Model][google.cloud.aiplatform.v1.Model]. This + // schema applies when you deploy the `Model` as a `DeployedModel` to an + // [Endpoint][google.cloud.aiplatform.v1.Endpoint] and use the `RawPredict` // method. google.api.HttpBody http_body = 2; } -// Request message for [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain]. +// Request message for +// [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain]. message ExplainRequest { // Required. The name of the Endpoint requested to serve the explanation. // Format: @@ -191,18 +206,20 @@ message ExplainRequest { // DeployedModels' [Model's][google.cloud.aiplatform.v1.DeployedModel.model] // [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata] // [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri]. - repeated google.protobuf.Value instances = 2 [(google.api.field_behavior) = REQUIRED]; + repeated google.protobuf.Value instances = 2 + [(google.api.field_behavior) = REQUIRED]; // The parameters that govern the prediction. The schema of the parameters may - // be specified via Endpoint's DeployedModels' [Model's ][google.cloud.aiplatform.v1.DeployedModel.model] + // be specified via Endpoint's DeployedModels' [Model's + // ][google.cloud.aiplatform.v1.DeployedModel.model] // [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata] // [parameters_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri]. google.protobuf.Value parameters = 4; // If specified, overrides the - // [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] of the DeployedModel. - // Can be used for explaining prediction results with different - // configurations, such as: + // [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] + // of the DeployedModel. Can be used for explaining prediction results with + // different configurations, such as: // - Explaining top-5 predictions results as opposed to top-1; // - Increasing path count or step count of the attribution methods to reduce // approximate errors; @@ -210,22 +227,27 @@ message ExplainRequest { ExplanationSpecOverride explanation_spec_override = 5; // If specified, this ExplainRequest will be served by the chosen - // DeployedModel, overriding [Endpoint.traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split]. + // DeployedModel, overriding + // [Endpoint.traffic_split][google.cloud.aiplatform.v1.Endpoint.traffic_split]. string deployed_model_id = 3; } -// Response message for [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain]. +// Response message for +// [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain]. message ExplainResponse { - // The explanations of the Model's [PredictResponse.predictions][google.cloud.aiplatform.v1.PredictResponse.predictions]. + // The explanations of the Model's + // [PredictResponse.predictions][google.cloud.aiplatform.v1.PredictResponse.predictions]. // - // It has the same number of elements as [instances][google.cloud.aiplatform.v1.ExplainRequest.instances] - // to be explained. + // It has the same number of elements as + // [instances][google.cloud.aiplatform.v1.ExplainRequest.instances] to be + // explained. repeated Explanation explanations = 1; // ID of the Endpoint's DeployedModel that served this explanation. string deployed_model_id = 2; // The predictions that are the output of the predictions call. - // Same as [PredictResponse.predictions][google.cloud.aiplatform.v1.PredictResponse.predictions]. + // Same as + // [PredictResponse.predictions][google.cloud.aiplatform.v1.PredictResponse.predictions]. repeated google.protobuf.Value predictions = 3; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/saved_query.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/saved_query.proto index 5332222d262..ec9ec0c9f3b 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/saved_query.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/saved_query.proto @@ -49,10 +49,12 @@ message SavedQuery { google.protobuf.Value metadata = 12; // Output only. Timestamp when this SavedQuery was created. - google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when SavedQuery was last updated. - google.protobuf.Timestamp update_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Filters on the Annotations in the dataset. string annotation_filter = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; @@ -79,7 +81,7 @@ message SavedQuery { // "overwrite" update happens. string etag = 8; - // Output only. If the Annotations belonging to the SavedQuery can be used for AutoML - // training. + // Output only. If the Annotations belonging to the SavedQuery can be used for + // AutoML training. bool support_automl_training = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/specialist_pool.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/specialist_pool.proto index 0e620e6a1db..d186592a578 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/specialist_pool.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/specialist_pool.proto @@ -43,19 +43,21 @@ message SpecialistPool { string name = 1 [(google.api.field_behavior) = REQUIRED]; // Required. The user-defined name of the SpecialistPool. - // The name can be up to 128 characters long and can be consist of any UTF-8 + // The name can be up to 128 characters long and can consist of any UTF-8 // characters. // This field should be unique on project-level. string display_name = 2 [(google.api.field_behavior) = REQUIRED]; // Output only. The number of managers in this SpecialistPool. - int32 specialist_managers_count = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + int32 specialist_managers_count = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; // The email addresses of the managers in the SpecialistPool. repeated string specialist_manager_emails = 4; // Output only. The resource name of the pending data labeling jobs. - repeated string pending_data_labeling_jobs = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + repeated string pending_data_labeling_jobs = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; // The email addresses of workers in the SpecialistPool. repeated string specialist_worker_emails = 7; diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/specialist_pool_service.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/specialist_pool_service.proto index c45cc767b42..982b1395a5e 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/specialist_pool_service.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/specialist_pool_service.proto @@ -41,10 +41,12 @@ option ruby_package = "Google::Cloud::AIPlatform::V1"; // CrowdCompute console. service SpecialistPoolService { option (google.api.default_host) = "aiplatform.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/cloud-platform"; // Creates a SpecialistPool. - rpc CreateSpecialistPool(CreateSpecialistPoolRequest) returns (google.longrunning.Operation) { + rpc CreateSpecialistPool(CreateSpecialistPoolRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{parent=projects/*/locations/*}/specialistPools" body: "specialist_pool" @@ -65,7 +67,8 @@ service SpecialistPoolService { } // Lists SpecialistPools in a Location. - rpc ListSpecialistPools(ListSpecialistPoolsRequest) returns (ListSpecialistPoolsResponse) { + rpc ListSpecialistPools(ListSpecialistPoolsRequest) + returns (ListSpecialistPoolsResponse) { option (google.api.http) = { get: "/v1/{parent=projects/*/locations/*}/specialistPools" }; @@ -73,7 +76,8 @@ service SpecialistPoolService { } // Deletes a SpecialistPool as well as all Specialists in the pool. - rpc DeleteSpecialistPool(DeleteSpecialistPoolRequest) returns (google.longrunning.Operation) { + rpc DeleteSpecialistPool(DeleteSpecialistPoolRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1/{name=projects/*/locations/*/specialistPools/*}" }; @@ -85,7 +89,8 @@ service SpecialistPoolService { } // Updates a SpecialistPool. - rpc UpdateSpecialistPool(UpdateSpecialistPoolRequest) returns (google.longrunning.Operation) { + rpc UpdateSpecialistPool(UpdateSpecialistPoolRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { patch: "/v1/{specialist_pool.name=projects/*/locations/*/specialistPools/*}" body: "specialist_pool" @@ -98,7 +103,8 @@ service SpecialistPoolService { } } -// Request message for [SpecialistPoolService.CreateSpecialistPool][google.cloud.aiplatform.v1.SpecialistPoolService.CreateSpecialistPool]. +// Request message for +// [SpecialistPoolService.CreateSpecialistPool][google.cloud.aiplatform.v1.SpecialistPoolService.CreateSpecialistPool]. message CreateSpecialistPoolRequest { // Required. The parent Project name for the new SpecialistPool. // The form is `projects/{project}/locations/{location}`. @@ -120,7 +126,8 @@ message CreateSpecialistPoolOperationMetadata { GenericOperationMetadata generic_metadata = 1; } -// Request message for [SpecialistPoolService.GetSpecialistPool][google.cloud.aiplatform.v1.SpecialistPoolService.GetSpecialistPool]. +// Request message for +// [SpecialistPoolService.GetSpecialistPool][google.cloud.aiplatform.v1.SpecialistPoolService.GetSpecialistPool]. message GetSpecialistPoolRequest { // Required. The name of the SpecialistPool resource. // The form is @@ -133,7 +140,8 @@ message GetSpecialistPoolRequest { ]; } -// Request message for [SpecialistPoolService.ListSpecialistPools][google.cloud.aiplatform.v1.SpecialistPoolService.ListSpecialistPools]. +// Request message for +// [SpecialistPoolService.ListSpecialistPools][google.cloud.aiplatform.v1.SpecialistPoolService.ListSpecialistPools]. message ListSpecialistPoolsRequest { // Required. The name of the SpecialistPool's parent resource. // Format: `projects/{project}/locations/{location}` @@ -148,16 +156,19 @@ message ListSpecialistPoolsRequest { int32 page_size = 2; // The standard list page token. - // Typically obtained by [ListSpecialistPoolsResponse.next_page_token][google.cloud.aiplatform.v1.ListSpecialistPoolsResponse.next_page_token] of - // the previous [SpecialistPoolService.ListSpecialistPools][google.cloud.aiplatform.v1.SpecialistPoolService.ListSpecialistPools] call. Return - // first page if empty. + // Typically obtained by + // [ListSpecialistPoolsResponse.next_page_token][google.cloud.aiplatform.v1.ListSpecialistPoolsResponse.next_page_token] + // of the previous + // [SpecialistPoolService.ListSpecialistPools][google.cloud.aiplatform.v1.SpecialistPoolService.ListSpecialistPools] + // call. Return first page if empty. string page_token = 3; // Mask specifying which fields to read. FieldMask represents a set of google.protobuf.FieldMask read_mask = 4; } -// Response message for [SpecialistPoolService.ListSpecialistPools][google.cloud.aiplatform.v1.SpecialistPoolService.ListSpecialistPools]. +// Response message for +// [SpecialistPoolService.ListSpecialistPools][google.cloud.aiplatform.v1.SpecialistPoolService.ListSpecialistPools]. message ListSpecialistPoolsResponse { // A list of SpecialistPools that matches the specified filter in the request. repeated SpecialistPool specialist_pools = 1; @@ -166,7 +177,8 @@ message ListSpecialistPoolsResponse { string next_page_token = 2; } -// Request message for [SpecialistPoolService.DeleteSpecialistPool][google.cloud.aiplatform.v1.SpecialistPoolService.DeleteSpecialistPool]. +// Request message for +// [SpecialistPoolService.DeleteSpecialistPool][google.cloud.aiplatform.v1.SpecialistPoolService.DeleteSpecialistPool]. message DeleteSpecialistPoolRequest { // Required. The resource name of the SpecialistPool to delete. Format: // `projects/{project}/locations/{location}/specialistPools/{specialist_pool}` @@ -183,20 +195,22 @@ message DeleteSpecialistPoolRequest { bool force = 2; } -// Request message for [SpecialistPoolService.UpdateSpecialistPool][google.cloud.aiplatform.v1.SpecialistPoolService.UpdateSpecialistPool]. +// Request message for +// [SpecialistPoolService.UpdateSpecialistPool][google.cloud.aiplatform.v1.SpecialistPoolService.UpdateSpecialistPool]. message UpdateSpecialistPoolRequest { // Required. The SpecialistPool which replaces the resource on the server. SpecialistPool specialist_pool = 1 [(google.api.field_behavior) = REQUIRED]; // Required. The update mask applies to the resource. - google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.FieldMask update_mask = 2 + [(google.api.field_behavior) = REQUIRED]; } // Runtime operation metadata for // [SpecialistPoolService.UpdateSpecialistPool][google.cloud.aiplatform.v1.SpecialistPoolService.UpdateSpecialistPool]. message UpdateSpecialistPoolOperationMetadata { - // Output only. The name of the SpecialistPool to which the specialists are being added. - // Format: + // Output only. The name of the SpecialistPool to which the specialists are + // being added. Format: // `projects/{project_id}/locations/{location_id}/specialistPools/{specialist_pool}` string specialist_pool = 1 [ (google.api.field_behavior) = OUTPUT_ONLY, diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/study.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/study.proto index c61a4a3feb1..7a949bc8f31 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/study.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/study.proto @@ -67,7 +67,8 @@ message Study { State state = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Time at which the study was created. - google.protobuf.Timestamp create_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. A human readable reason why the Study is inactive. // This should be empty if a study is ACTIVE or COMPLETED. @@ -86,7 +87,8 @@ message Trial { // A message representing a parameter to be tuned. message Parameter { // Output only. The ID of the parameter. The parameter should be defined in - // [StudySpec's Parameters][google.cloud.aiplatform.v1.StudySpec.parameters]. + // [StudySpec's + // Parameters][google.cloud.aiplatform.v1.StudySpec.parameters]. string parameter_id = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The value of the parameter. @@ -139,17 +141,21 @@ message Trial { // Output only. A list of measurements that are strictly lexicographically // ordered by their induced tuples (steps, elapsed_duration). // These are used for early stopping computations. - repeated Measurement measurements = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + repeated Measurement measurements = 6 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Time when the Trial was started. - google.protobuf.Timestamp start_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp start_time = 7 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. Time when the Trial's status changed to `SUCCEEDED` or `INFEASIBLE`. - google.protobuf.Timestamp end_time = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. Time when the Trial's status changed to `SUCCEEDED` or + // `INFEASIBLE`. + google.protobuf.Timestamp end_time = 8 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. The identifier of the client that originally requested this Trial. - // Each client is identified by a unique client_id. When a client - // asks for a suggestion, Vertex AI Vizier will assign it a Trial. The client + // Output only. The identifier of the client that originally requested this + // Trial. Each client is identified by a unique client_id. When a client asks + // for a suggestion, Vertex AI Vizier will assign it a Trial. The client // should evaluate the Trial, complete it, and report back to Vertex AI // Vizier. If suggestion is asked again by same client_id before the Trial is // completed, the same Trial will be returned. Multiple clients with @@ -173,9 +179,11 @@ message Trial { // Output only. URIs for accessing [interactive // shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) // (one URI for each training node). Only available if this trial is part of - // a [HyperparameterTuningJob][google.cloud.aiplatform.v1.HyperparameterTuningJob] and the job's - // [trial_job_spec.enable_web_access][google.cloud.aiplatform.v1.CustomJobSpec.enable_web_access] field - // is `true`. + // a + // [HyperparameterTuningJob][google.cloud.aiplatform.v1.HyperparameterTuningJob] + // and the job's + // [trial_job_spec.enable_web_access][google.cloud.aiplatform.v1.CustomJobSpec.enable_web_access] + // field is `true`. // // The keys are names of each node used for the trial; for example, // `workerpool0-0` for the primary node, `workerpool1-0` for the first node in @@ -183,7 +191,8 @@ message Trial { // second worker pool. // // The values are the URIs for each node's interactive shell. - map web_access_uris = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; + map web_access_uris = 12 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // Represents specification of a Study. @@ -202,8 +211,8 @@ message StudySpec { MINIMIZE = 2; } - // Required. The ID of the metric. Must not contain whitespaces and must be unique - // amongst all MetricSpecs. + // Required. The ID of the metric. Must not contain whitespaces and must be + // unique amongst all MetricSpecs. string metric_id = 1 [(google.api.field_behavior) = REQUIRED]; // Required. The optimization goal of the metric. @@ -298,8 +307,8 @@ message StudySpec { // Represents the spec to match categorical values from parent parameter. message CategoricalValueCondition { - // Required. Matches values of the parent parameter of 'CATEGORICAL' type. - // All values must exist in `categorical_value_spec` of parent + // Required. Matches values of the parent parameter of 'CATEGORICAL' + // type. All values must exist in `categorical_value_spec` of parent // parameter. repeated string values = 1 [(google.api.field_behavior) = REQUIRED]; } @@ -357,8 +366,8 @@ message StudySpec { DiscreteValueSpec discrete_value_spec = 5; } - // Required. The ID of the parameter. Must not contain whitespaces and must be unique - // amongst all ParameterSpecs. + // Required. The ID of the parameter. Must not contain whitespaces and must + // be unique amongst all ParameterSpecs. string parameter_id = 1 [(google.api.field_behavior) = REQUIRED]; // How the parameter should be scaled. @@ -379,9 +388,11 @@ message StudySpec { // Trial. Early stopping is requested for the current Trial if there is very // low probability to exceed the optimal value found so far. message DecayCurveAutomatedStoppingSpec { - // True if [Measurement.elapsed_duration][google.cloud.aiplatform.v1.Measurement.elapsed_duration] is used as the x-axis of each - // Trials Decay Curve. Otherwise, [Measurement.step_count][google.cloud.aiplatform.v1.Measurement.step_count] will be used - // as the x-axis. + // True if + // [Measurement.elapsed_duration][google.cloud.aiplatform.v1.Measurement.elapsed_duration] + // is used as the x-axis of each Trials Decay Curve. Otherwise, + // [Measurement.step_count][google.cloud.aiplatform.v1.Measurement.step_count] + // will be used as the x-axis. bool use_elapsed_duration = 1; } @@ -392,9 +403,10 @@ message StudySpec { // values reported by the Trial in each measurement. message MedianAutomatedStoppingSpec { // True if median automated stopping rule applies on - // [Measurement.elapsed_duration][google.cloud.aiplatform.v1.Measurement.elapsed_duration]. It means that elapsed_duration - // field of latest measurement of current Trial is used to compute median - // objective value for each completed Trials. + // [Measurement.elapsed_duration][google.cloud.aiplatform.v1.Measurement.elapsed_duration]. + // It means that elapsed_duration field of latest measurement of current + // Trial is used to compute median objective value for each completed + // Trials. bool use_elapsed_duration = 1; } @@ -444,6 +456,15 @@ message StudySpec { // min_num_steps are overloaded to contain max_elapsed_seconds and // min_elapsed_seconds. bool use_elapsed_duration = 5; + + // ConvexAutomatedStoppingSpec by default only updates the trials that needs + // to be early stopped using a newly trained auto-regressive model. When + // this flag is set to True, all stopped trials from the beginning are + // potentially updated in terms of their `final_measurement`. Also, note + // that the training logic of autoregressive models is different in this + // case. Enabling this option has shown better results and this may be the + // default option in the future. + optional bool update_all_stopped_trials = 6; } // The available search algorithms for the Study. @@ -518,7 +539,8 @@ message StudySpec { repeated MetricSpec metrics = 1 [(google.api.field_behavior) = REQUIRED]; // Required. The set of parameters to tune. - repeated ParameterSpec parameters = 2 [(google.api.field_behavior) = REQUIRED]; + repeated ParameterSpec parameters = 2 + [(google.api.field_behavior) = REQUIRED]; // The search algorithm specified for the Study. Algorithm algorithm = 3; @@ -546,14 +568,16 @@ message Measurement { double value = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; } - // Output only. Time that the Trial has been running at the point of this Measurement. - google.protobuf.Duration elapsed_duration = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. Time that the Trial has been running at the point of this + // Measurement. + google.protobuf.Duration elapsed_duration = 1 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. The number of steps the machine learning model has been trained for. - // Must be non-negative. + // Output only. The number of steps the machine learning model has been + // trained for. Must be non-negative. int64 step_count = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. A list of metrics got by evaluating the objective functions using suggested - // Parameter values. + // Output only. A list of metrics got by evaluating the objective functions + // using suggested Parameter values. repeated Metric metrics = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/tensorboard.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/tensorboard.proto index 84a245d9028..a0c6aad5576 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/tensorboard.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/tensorboard.proto @@ -30,7 +30,7 @@ option php_namespace = "Google\\Cloud\\AIPlatform\\V1"; option ruby_package = "Google::Cloud::AIPlatform::V1"; // Tensorboard is a physical database that stores users' training metrics. -// A default Tensorboard is provided in each region of a GCP project. +// A default Tensorboard is provided in each region of a Google Cloud project. // If needed users can also create extra Tensorboards in their projects. message Tensorboard { option (google.api.resource) = { @@ -54,18 +54,21 @@ message Tensorboard { // this key. EncryptionSpec encryption_spec = 11; - // Output only. Consumer project Cloud Storage path prefix used to store blob data, which - // can either be a bucket or directory. Does not end with a '/'. - string blob_storage_path_prefix = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. Consumer project Cloud Storage path prefix used to store blob + // data, which can either be a bucket or directory. Does not end with a '/'. + string blob_storage_path_prefix = 10 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The number of Runs stored in this Tensorboard. int32 run_count = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this Tensorboard was created. - google.protobuf.Timestamp create_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 6 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this Tensorboard was last updated. - google.protobuf.Timestamp update_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 7 + [(google.api.field_behavior) = OUTPUT_ONLY]; // The labels with user-defined metadata to organize your Tensorboards. // diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/tensorboard_data.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/tensorboard_data.proto index c65db694555..6cc0f24d7ba 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/tensorboard_data.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/tensorboard_data.proto @@ -30,19 +30,21 @@ option ruby_package = "Google::Cloud::AIPlatform::V1"; // All the data stored in a TensorboardTimeSeries. message TimeSeriesData { - // Required. The ID of the TensorboardTimeSeries, which will become the final component - // of the TensorboardTimeSeries' resource name - string tensorboard_time_series_id = 1 [(google.api.field_behavior) = REQUIRED]; + // Required. The ID of the TensorboardTimeSeries, which will become the final + // component of the TensorboardTimeSeries' resource name + string tensorboard_time_series_id = 1 + [(google.api.field_behavior) = REQUIRED]; - // Required. Immutable. The value type of this time series. All the values in this time series data - // must match this value type. + // Required. Immutable. The value type of this time series. All the values in + // this time series data must match this value type. TensorboardTimeSeries.ValueType value_type = 2 [ (google.api.field_behavior) = REQUIRED, (google.api.field_behavior) = IMMUTABLE ]; // Required. Data points in this time series. - repeated TimeSeriesDataPoint values = 3 [(google.api.field_behavior) = REQUIRED]; + repeated TimeSeriesDataPoint values = 3 + [(google.api.field_behavior) = REQUIRED]; } // A TensorboardTimeSeries data point. @@ -78,7 +80,8 @@ message TensorboardTensor { // https://github.com/tensorflow/tensorflow/blob/master/tensorflow/core/framework/tensor.proto bytes value = 1 [(google.api.field_behavior) = REQUIRED]; - // Optional. Version number of TensorProto used to serialize [value][google.cloud.aiplatform.v1.TensorboardTensor.value]. + // Optional. Version number of TensorProto used to serialize + // [value][google.cloud.aiplatform.v1.TensorboardTensor.value]. int32 version_number = 2 [(google.api.field_behavior) = OPTIONAL]; } @@ -91,8 +94,8 @@ message TensorboardBlobSequence { // One blob (e.g, image, graph) viewable on a blob metric plot. message TensorboardBlob { - // Output only. A URI safe key uniquely identifying a blob. Can be used to locate the blob - // stored in the Cloud Storage bucket of the consumer project. + // Output only. A URI safe key uniquely identifying a blob. Can be used to + // locate the blob stored in the Cloud Storage bucket of the consumer project. string id = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Optional. The bytes of the blob is not present unless it's returned by the diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/tensorboard_experiment.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/tensorboard_experiment.proto index 9d7fe1204cf..30a334f2c90 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/tensorboard_experiment.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/tensorboard_experiment.proto @@ -48,10 +48,12 @@ message TensorboardExperiment { string description = 3; // Output only. Timestamp when this TensorboardExperiment was created. - google.protobuf.Timestamp create_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this TensorboardExperiment was last updated. - google.protobuf.Timestamp update_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; // The labels with user-defined metadata to organize your Datasets. // @@ -73,6 +75,7 @@ message TensorboardExperiment { // "overwrite" update happens. string etag = 7; - // Immutable. Source of the TensorboardExperiment. Example: a custom training job. + // Immutable. Source of the TensorboardExperiment. Example: a custom training + // job. string source = 8 [(google.api.field_behavior) = IMMUTABLE]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/tensorboard_run.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/tensorboard_run.proto index 0f7b5eff6a4..25c373f605d 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/tensorboard_run.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/tensorboard_run.proto @@ -50,10 +50,12 @@ message TensorboardRun { string description = 3; // Output only. Timestamp when this TensorboardRun was created. - google.protobuf.Timestamp create_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 6 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this TensorboardRun was last updated. - google.protobuf.Timestamp update_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 7 + [(google.api.field_behavior) = OUTPUT_ONLY]; // The labels with user-defined metadata to organize your TensorboardRuns. // diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/tensorboard_service.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/tensorboard_service.proto index ed81dd1f287..07ea601deda 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/tensorboard_service.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/tensorboard_service.proto @@ -45,7 +45,8 @@ service TensorboardService { "https://www.googleapis.com/auth/cloud-platform.read-only"; // Creates a Tensorboard. - rpc CreateTensorboard(CreateTensorboardRequest) returns (google.longrunning.Operation) { + rpc CreateTensorboard(CreateTensorboardRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{parent=projects/*/locations/*}/tensorboards" body: "tensorboard" @@ -65,8 +66,18 @@ service TensorboardService { option (google.api.method_signature) = "name"; } + // Returns a list of monthly active users for a given TensorBoard instance. + rpc ReadTensorboardUsage(ReadTensorboardUsageRequest) + returns (ReadTensorboardUsageResponse) { + option (google.api.http) = { + get: "/v1/{tensorboard=projects/*/locations/*/tensorboards/*}:readUsage" + }; + option (google.api.method_signature) = "tensorboard"; + } + // Updates a Tensorboard. - rpc UpdateTensorboard(UpdateTensorboardRequest) returns (google.longrunning.Operation) { + rpc UpdateTensorboard(UpdateTensorboardRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { patch: "/v1/{tensorboard.name=projects/*/locations/*/tensorboards/*}" body: "tensorboard" @@ -79,7 +90,8 @@ service TensorboardService { } // Lists Tensorboards in a Location. - rpc ListTensorboards(ListTensorboardsRequest) returns (ListTensorboardsResponse) { + rpc ListTensorboards(ListTensorboardsRequest) + returns (ListTensorboardsResponse) { option (google.api.http) = { get: "/v1/{parent=projects/*/locations/*}/tensorboards" }; @@ -87,7 +99,8 @@ service TensorboardService { } // Deletes a Tensorboard. - rpc DeleteTensorboard(DeleteTensorboardRequest) returns (google.longrunning.Operation) { + rpc DeleteTensorboard(DeleteTensorboardRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1/{name=projects/*/locations/*/tensorboards/*}" }; @@ -99,16 +112,19 @@ service TensorboardService { } // Creates a TensorboardExperiment. - rpc CreateTensorboardExperiment(CreateTensorboardExperimentRequest) returns (TensorboardExperiment) { + rpc CreateTensorboardExperiment(CreateTensorboardExperimentRequest) + returns (TensorboardExperiment) { option (google.api.http) = { post: "/v1/{parent=projects/*/locations/*/tensorboards/*}/experiments" body: "tensorboard_experiment" }; - option (google.api.method_signature) = "parent,tensorboard_experiment,tensorboard_experiment_id"; + option (google.api.method_signature) = + "parent,tensorboard_experiment,tensorboard_experiment_id"; } // Gets a TensorboardExperiment. - rpc GetTensorboardExperiment(GetTensorboardExperimentRequest) returns (TensorboardExperiment) { + rpc GetTensorboardExperiment(GetTensorboardExperimentRequest) + returns (TensorboardExperiment) { option (google.api.http) = { get: "/v1/{name=projects/*/locations/*/tensorboards/*/experiments/*}" }; @@ -116,7 +132,8 @@ service TensorboardService { } // Updates a TensorboardExperiment. - rpc UpdateTensorboardExperiment(UpdateTensorboardExperimentRequest) returns (TensorboardExperiment) { + rpc UpdateTensorboardExperiment(UpdateTensorboardExperimentRequest) + returns (TensorboardExperiment) { option (google.api.http) = { patch: "/v1/{tensorboard_experiment.name=projects/*/locations/*/tensorboards/*/experiments/*}" body: "tensorboard_experiment" @@ -125,7 +142,8 @@ service TensorboardService { } // Lists TensorboardExperiments in a Location. - rpc ListTensorboardExperiments(ListTensorboardExperimentsRequest) returns (ListTensorboardExperimentsResponse) { + rpc ListTensorboardExperiments(ListTensorboardExperimentsRequest) + returns (ListTensorboardExperimentsResponse) { option (google.api.http) = { get: "/v1/{parent=projects/*/locations/*/tensorboards/*}/experiments" }; @@ -133,7 +151,8 @@ service TensorboardService { } // Deletes a TensorboardExperiment. - rpc DeleteTensorboardExperiment(DeleteTensorboardExperimentRequest) returns (google.longrunning.Operation) { + rpc DeleteTensorboardExperiment(DeleteTensorboardExperimentRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1/{name=projects/*/locations/*/tensorboards/*/experiments/*}" }; @@ -145,16 +164,19 @@ service TensorboardService { } // Creates a TensorboardRun. - rpc CreateTensorboardRun(CreateTensorboardRunRequest) returns (TensorboardRun) { + rpc CreateTensorboardRun(CreateTensorboardRunRequest) + returns (TensorboardRun) { option (google.api.http) = { post: "/v1/{parent=projects/*/locations/*/tensorboards/*/experiments/*}/runs" body: "tensorboard_run" }; - option (google.api.method_signature) = "parent,tensorboard_run,tensorboard_run_id"; + option (google.api.method_signature) = + "parent,tensorboard_run,tensorboard_run_id"; } // Batch create TensorboardRuns. - rpc BatchCreateTensorboardRuns(BatchCreateTensorboardRunsRequest) returns (BatchCreateTensorboardRunsResponse) { + rpc BatchCreateTensorboardRuns(BatchCreateTensorboardRunsRequest) + returns (BatchCreateTensorboardRunsResponse) { option (google.api.http) = { post: "/v1/{parent=projects/*/locations/*/tensorboards/*/experiments/*}/runs:batchCreate" body: "*" @@ -171,7 +193,8 @@ service TensorboardService { } // Updates a TensorboardRun. - rpc UpdateTensorboardRun(UpdateTensorboardRunRequest) returns (TensorboardRun) { + rpc UpdateTensorboardRun(UpdateTensorboardRunRequest) + returns (TensorboardRun) { option (google.api.http) = { patch: "/v1/{tensorboard_run.name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*}" body: "tensorboard_run" @@ -180,7 +203,8 @@ service TensorboardService { } // Lists TensorboardRuns in a Location. - rpc ListTensorboardRuns(ListTensorboardRunsRequest) returns (ListTensorboardRunsResponse) { + rpc ListTensorboardRuns(ListTensorboardRunsRequest) + returns (ListTensorboardRunsResponse) { option (google.api.http) = { get: "/v1/{parent=projects/*/locations/*/tensorboards/*/experiments/*}/runs" }; @@ -188,7 +212,8 @@ service TensorboardService { } // Deletes a TensorboardRun. - rpc DeleteTensorboardRun(DeleteTensorboardRunRequest) returns (google.longrunning.Operation) { + rpc DeleteTensorboardRun(DeleteTensorboardRunRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1/{name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*}" }; @@ -200,7 +225,8 @@ service TensorboardService { } // Batch create TensorboardTimeSeries that belong to a TensorboardExperiment. - rpc BatchCreateTensorboardTimeSeries(BatchCreateTensorboardTimeSeriesRequest) returns (BatchCreateTensorboardTimeSeriesResponse) { + rpc BatchCreateTensorboardTimeSeries(BatchCreateTensorboardTimeSeriesRequest) + returns (BatchCreateTensorboardTimeSeriesResponse) { option (google.api.http) = { post: "/v1/{parent=projects/*/locations/*/tensorboards/*/experiments/*}/runs/*/timeSeries:batchCreate" body: "*" @@ -209,7 +235,8 @@ service TensorboardService { } // Creates a TensorboardTimeSeries. - rpc CreateTensorboardTimeSeries(CreateTensorboardTimeSeriesRequest) returns (TensorboardTimeSeries) { + rpc CreateTensorboardTimeSeries(CreateTensorboardTimeSeriesRequest) + returns (TensorboardTimeSeries) { option (google.api.http) = { post: "/v1/{parent=projects/*/locations/*/tensorboards/*/experiments/*/runs/*}/timeSeries" body: "tensorboard_time_series" @@ -218,7 +245,8 @@ service TensorboardService { } // Gets a TensorboardTimeSeries. - rpc GetTensorboardTimeSeries(GetTensorboardTimeSeriesRequest) returns (TensorboardTimeSeries) { + rpc GetTensorboardTimeSeries(GetTensorboardTimeSeriesRequest) + returns (TensorboardTimeSeries) { option (google.api.http) = { get: "/v1/{name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*}" }; @@ -226,16 +254,19 @@ service TensorboardService { } // Updates a TensorboardTimeSeries. - rpc UpdateTensorboardTimeSeries(UpdateTensorboardTimeSeriesRequest) returns (TensorboardTimeSeries) { + rpc UpdateTensorboardTimeSeries(UpdateTensorboardTimeSeriesRequest) + returns (TensorboardTimeSeries) { option (google.api.http) = { patch: "/v1/{tensorboard_time_series.name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*}" body: "tensorboard_time_series" }; - option (google.api.method_signature) = "tensorboard_time_series,update_mask"; + option (google.api.method_signature) = + "tensorboard_time_series,update_mask"; } // Lists TensorboardTimeSeries in a Location. - rpc ListTensorboardTimeSeries(ListTensorboardTimeSeriesRequest) returns (ListTensorboardTimeSeriesResponse) { + rpc ListTensorboardTimeSeries(ListTensorboardTimeSeriesRequest) + returns (ListTensorboardTimeSeriesResponse) { option (google.api.http) = { get: "/v1/{parent=projects/*/locations/*/tensorboards/*/experiments/*/runs/*}/timeSeries" }; @@ -243,7 +274,8 @@ service TensorboardService { } // Deletes a TensorboardTimeSeries. - rpc DeleteTensorboardTimeSeries(DeleteTensorboardTimeSeriesRequest) returns (google.longrunning.Operation) { + rpc DeleteTensorboardTimeSeries(DeleteTensorboardTimeSeriesRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1/{name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*}" }; @@ -256,10 +288,12 @@ service TensorboardService { // 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 + // data points stored is less than the limit, all data is returned. + // Otherwise, the number limit of data points is randomly selected from // this time series and returned. - rpc BatchReadTensorboardTimeSeriesData(BatchReadTensorboardTimeSeriesDataRequest) returns (BatchReadTensorboardTimeSeriesDataResponse) { + rpc BatchReadTensorboardTimeSeriesData( + BatchReadTensorboardTimeSeriesDataRequest) + returns (BatchReadTensorboardTimeSeriesDataResponse) { option (google.api.http) = { get: "/v1/{tensorboard=projects/*/locations/*/tensorboards/*}/experiments/*/runs/*/timeSeries:batchRead" }; @@ -267,11 +301,12 @@ service TensorboardService { } // 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. + // points stored is less than 1000, all data is returned. Otherwise, 1000 + // data points is randomly selected from this time series and returned. // This value can be changed by changing max_data_points, which can't be // greater than 10k. - rpc ReadTensorboardTimeSeriesData(ReadTensorboardTimeSeriesDataRequest) returns (ReadTensorboardTimeSeriesDataResponse) { + rpc ReadTensorboardTimeSeriesData(ReadTensorboardTimeSeriesDataRequest) + returns (ReadTensorboardTimeSeriesDataResponse) { option (google.api.http) = { get: "/v1/{tensorboard_time_series=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*}:read" }; @@ -282,7 +317,8 @@ service TensorboardService { // This is to allow reading blob data stored in consumer project's Cloud // Storage bucket without users having to obtain Cloud Storage access // permission. - rpc ReadTensorboardBlobData(ReadTensorboardBlobDataRequest) returns (stream ReadTensorboardBlobDataResponse) { + rpc ReadTensorboardBlobData(ReadTensorboardBlobDataRequest) + returns (stream ReadTensorboardBlobDataResponse) { option (google.api.http) = { get: "/v1/{time_series=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*}:readBlobData" }; @@ -290,20 +326,21 @@ service TensorboardService { } // Write time series data points of multiple TensorboardTimeSeries in multiple - // TensorboardRun's. If any data fail to be ingested, an error will be - // returned. - rpc WriteTensorboardExperimentData(WriteTensorboardExperimentDataRequest) returns (WriteTensorboardExperimentDataResponse) { + // TensorboardRun's. If any data fail to be ingested, an error is returned. + rpc WriteTensorboardExperimentData(WriteTensorboardExperimentDataRequest) + returns (WriteTensorboardExperimentDataResponse) { option (google.api.http) = { post: "/v1/{tensorboard_experiment=projects/*/locations/*/tensorboards/*/experiments/*}:write" body: "*" }; - option (google.api.method_signature) = "tensorboard_experiment,write_run_data_requests"; + option (google.api.method_signature) = + "tensorboard_experiment,write_run_data_requests"; } // Write time series data points into multiple TensorboardTimeSeries under - // a TensorboardRun. If any data fail to be ingested, an error will be - // returned. - rpc WriteTensorboardRunData(WriteTensorboardRunDataRequest) returns (WriteTensorboardRunDataResponse) { + // a TensorboardRun. If any data fail to be ingested, an error is returned. + rpc WriteTensorboardRunData(WriteTensorboardRunDataRequest) + returns (WriteTensorboardRunDataResponse) { option (google.api.http) = { post: "/v1/{tensorboard_run=projects/*/locations/*/tensorboards/*/experiments/*/runs/*}:write" body: "*" @@ -313,7 +350,8 @@ service TensorboardService { // Exports a TensorboardTimeSeries' data. Data is returned in paginated // responses. - rpc ExportTensorboardTimeSeriesData(ExportTensorboardTimeSeriesDataRequest) returns (ExportTensorboardTimeSeriesDataResponse) { + rpc ExportTensorboardTimeSeriesData(ExportTensorboardTimeSeriesDataRequest) + returns (ExportTensorboardTimeSeriesDataResponse) { option (google.api.http) = { post: "/v1/{tensorboard_time_series=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*}:exportTensorboardTimeSeries" body: "*" @@ -322,7 +360,8 @@ service TensorboardService { } } -// Request message for [TensorboardService.CreateTensorboard][google.cloud.aiplatform.v1.TensorboardService.CreateTensorboard]. +// Request message for +// [TensorboardService.CreateTensorboard][google.cloud.aiplatform.v1.TensorboardService.CreateTensorboard]. message CreateTensorboardRequest { // Required. The resource name of the Location to create the Tensorboard in. // Format: `projects/{project}/locations/{location}` @@ -337,7 +376,8 @@ message CreateTensorboardRequest { Tensorboard tensorboard = 2 [(google.api.field_behavior) = REQUIRED]; } -// Request message for [TensorboardService.GetTensorboard][google.cloud.aiplatform.v1.TensorboardService.GetTensorboard]. +// Request message for +// [TensorboardService.GetTensorboard][google.cloud.aiplatform.v1.TensorboardService.GetTensorboard]. message GetTensorboardRequest { // Required. The name of the Tensorboard resource. // Format: @@ -350,7 +390,42 @@ message GetTensorboardRequest { ]; } -// Request message for [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1.TensorboardService.ListTensorboards]. +// Request message for [TensorboardService.GetTensorboardUsage][]. +message ReadTensorboardUsageRequest { + // Required. The name of the Tensorboard resource. + // Format: + // `projects/{project}/locations/{location}/tensorboards/{tensorboard}` + string tensorboard = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "aiplatform.googleapis.com/Tensorboard" + } + ]; +} + +// Response message for [TensorboardService.GetTensorboardUsage][]. +message ReadTensorboardUsageResponse { + // Per user usage data. + message PerUserUsageData { + // User's username + string username = 1; + + // Number of times the user has read data within the Tensorboard. + int64 view_count = 2; + } + + // Per month usage data + message PerMonthUsageData { + // Usage data for each user in the given month. + repeated PerUserUsageData user_usage_data = 1; + } + + // Maps year-month (YYYYMM) string to per month usage data. + map monthly_usage_data = 1; +} + +// Request message for +// [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1.TensorboardService.ListTensorboards]. message ListTensorboardsRequest { // Required. The resource name of the Location to list Tensorboards. // Format: @@ -366,18 +441,18 @@ message ListTensorboardsRequest { string filter = 2; // The maximum number of Tensorboards to return. The service may return - // fewer than this value. If unspecified, at most 100 Tensorboards will be - // returned. The maximum value is 100; values above 100 will be coerced to + // fewer than this value. If unspecified, at most 100 Tensorboards are + // returned. The maximum value is 100; values above 100 are coerced to // 100. int32 page_size = 3; // A page token, received from a previous - // [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1.TensorboardService.ListTensorboards] call. - // Provide this to retrieve the subsequent page. + // [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1.TensorboardService.ListTensorboards] + // call. Provide this to retrieve the subsequent page. // // When paginating, all other parameters provided to - // [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1.TensorboardService.ListTensorboards] must - // match the call that provided the page token. + // [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1.TensorboardService.ListTensorboards] + // must match the call that provided the page token. string page_token = 4; // Field to use to sort the list. @@ -387,26 +462,30 @@ message ListTensorboardsRequest { google.protobuf.FieldMask read_mask = 6; } -// Response message for [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1.TensorboardService.ListTensorboards]. +// Response message for +// [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1.TensorboardService.ListTensorboards]. message ListTensorboardsResponse { // The Tensorboards mathching the request. repeated Tensorboard tensorboards = 1; - // A token, which can be sent as [ListTensorboardsRequest.page_token][google.cloud.aiplatform.v1.ListTensorboardsRequest.page_token] + // A token, which can be sent as + // [ListTensorboardsRequest.page_token][google.cloud.aiplatform.v1.ListTensorboardsRequest.page_token] // to retrieve the next page. If this field is omitted, there are no // subsequent pages. string next_page_token = 2; } -// Request message for [TensorboardService.UpdateTensorboard][google.cloud.aiplatform.v1.TensorboardService.UpdateTensorboard]. +// Request message for +// [TensorboardService.UpdateTensorboard][google.cloud.aiplatform.v1.TensorboardService.UpdateTensorboard]. message UpdateTensorboardRequest { // Required. Field mask is used to specify the fields to be overwritten in the // Tensorboard resource by the update. // The fields specified in the update_mask are relative to the resource, not - // the full request. A field will be overwritten if it is in the mask. If the - // user does not provide a mask then all fields will be overwritten if new + // the full request. A field is overwritten if it's in the mask. If the + // user does not provide a mask then all fields are overwritten if new // values are specified. - google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.FieldMask update_mask = 1 + [(google.api.field_behavior) = REQUIRED]; // Required. The Tensorboard's `name` field is used to identify the // Tensorboard to be updated. Format: @@ -414,7 +493,8 @@ message UpdateTensorboardRequest { Tensorboard tensorboard = 2 [(google.api.field_behavior) = REQUIRED]; } -// Request message for [TensorboardService.DeleteTensorboard][google.cloud.aiplatform.v1.TensorboardService.DeleteTensorboard]. +// Request message for +// [TensorboardService.DeleteTensorboard][google.cloud.aiplatform.v1.TensorboardService.DeleteTensorboard]. message DeleteTensorboardRequest { // Required. The name of the Tensorboard to be deleted. // Format: @@ -427,10 +507,11 @@ message DeleteTensorboardRequest { ]; } -// Request message for [TensorboardService.CreateTensorboardExperiment][google.cloud.aiplatform.v1.TensorboardService.CreateTensorboardExperiment]. +// Request message for +// [TensorboardService.CreateTensorboardExperiment][google.cloud.aiplatform.v1.TensorboardService.CreateTensorboardExperiment]. message CreateTensorboardExperimentRequest { - // Required. The resource name of the Tensorboard to create the TensorboardExperiment - // in. Format: + // Required. The resource name of the Tensorboard to create the + // TensorboardExperiment in. Format: // `projects/{project}/locations/{location}/tensorboards/{tensorboard}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, @@ -442,15 +523,16 @@ message CreateTensorboardExperimentRequest { // The TensorboardExperiment to create. TensorboardExperiment tensorboard_experiment = 2; - // Required. The ID to use for the Tensorboard experiment, which will become the final - // component of the Tensorboard experiment's resource name. + // Required. The ID to use for the Tensorboard experiment, which becomes the + // final component of the Tensorboard experiment's resource name. // // This value should be 1-128 characters, and valid characters // are /[a-z][0-9]-/. string tensorboard_experiment_id = 3 [(google.api.field_behavior) = REQUIRED]; } -// Request message for [TensorboardService.GetTensorboardExperiment][google.cloud.aiplatform.v1.TensorboardService.GetTensorboardExperiment]. +// Request message for +// [TensorboardService.GetTensorboardExperiment][google.cloud.aiplatform.v1.TensorboardService.GetTensorboardExperiment]. message GetTensorboardExperimentRequest { // Required. The name of the TensorboardExperiment resource. // Format: @@ -463,11 +545,12 @@ message GetTensorboardExperimentRequest { ]; } -// Request message for [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments]. +// Request message for +// [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments]. message ListTensorboardExperimentsRequest { - // Required. The resource name of the Tensorboard to list TensorboardExperiments. - // Format: - // 'projects/{project}/locations/{location}/tensorboards/{tensorboard}' + // Required. The resource name of the Tensorboard to list + // TensorboardExperiments. Format: + // `projects/{project}/locations/{location}/tensorboards/{tensorboard}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -480,17 +563,17 @@ message ListTensorboardExperimentsRequest { // The maximum number of TensorboardExperiments to return. The service may // return fewer than this value. If unspecified, at most 50 - // TensorboardExperiments will be returned. The maximum value is 1000; values - // above 1000 will be coerced to 1000. + // TensorboardExperiments are returned. The maximum value is 1000; values + // above 1000 are coerced to 1000. int32 page_size = 3; // A page token, received from a previous - // [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments] call. - // Provide this to retrieve the subsequent page. + // [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments] + // call. Provide this to retrieve the subsequent page. // // When paginating, all other parameters provided to - // [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments] must - // match the call that provided the page token. + // [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments] + // must match the call that provided the page token. string page_token = 4; // Field to use to sort the list. @@ -500,34 +583,40 @@ message ListTensorboardExperimentsRequest { google.protobuf.FieldMask read_mask = 6; } -// Response message for [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments]. +// Response message for +// [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments]. message ListTensorboardExperimentsResponse { // The TensorboardExperiments mathching the request. repeated TensorboardExperiment tensorboard_experiments = 1; // A token, which can be sent as - // [ListTensorboardExperimentsRequest.page_token][google.cloud.aiplatform.v1.ListTensorboardExperimentsRequest.page_token] to retrieve the next page. - // If this field is omitted, there are no subsequent pages. + // [ListTensorboardExperimentsRequest.page_token][google.cloud.aiplatform.v1.ListTensorboardExperimentsRequest.page_token] + // to retrieve the next page. If this field is omitted, there are no + // subsequent pages. string next_page_token = 2; } -// Request message for [TensorboardService.UpdateTensorboardExperiment][google.cloud.aiplatform.v1.TensorboardService.UpdateTensorboardExperiment]. +// Request message for +// [TensorboardService.UpdateTensorboardExperiment][google.cloud.aiplatform.v1.TensorboardService.UpdateTensorboardExperiment]. message UpdateTensorboardExperimentRequest { // Required. Field mask is used to specify the fields to be overwritten in the // TensorboardExperiment resource by the update. // The fields specified in the update_mask are relative to the resource, not - // the full request. A field will be overwritten if it is in the mask. If the - // user does not provide a mask then all fields will be overwritten if new + // the full request. A field is overwritten if it's in the mask. If the + // user does not provide a mask then all fields are overwritten if new // values are specified. - google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.FieldMask update_mask = 1 + [(google.api.field_behavior) = REQUIRED]; // Required. The TensorboardExperiment's `name` field is used to identify the // TensorboardExperiment to be updated. Format: // `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` - TensorboardExperiment tensorboard_experiment = 2 [(google.api.field_behavior) = REQUIRED]; + TensorboardExperiment tensorboard_experiment = 2 + [(google.api.field_behavior) = REQUIRED]; } -// Request message for [TensorboardService.DeleteTensorboardExperiment][google.cloud.aiplatform.v1.TensorboardService.DeleteTensorboardExperiment]. +// Request message for +// [TensorboardService.DeleteTensorboardExperiment][google.cloud.aiplatform.v1.TensorboardService.DeleteTensorboardExperiment]. message DeleteTensorboardExperimentRequest { // Required. The name of the TensorboardExperiment to be deleted. // Format: @@ -540,7 +629,8 @@ message DeleteTensorboardExperimentRequest { ]; } -// Request message for [TensorboardService.BatchCreateTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.BatchCreateTensorboardRuns]. +// Request message for +// [TensorboardService.BatchCreateTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.BatchCreateTensorboardRuns]. message BatchCreateTensorboardRunsRequest { // Required. The resource name of the TensorboardExperiment to create the // TensorboardRuns in. Format: @@ -556,19 +646,22 @@ message BatchCreateTensorboardRunsRequest { // Required. The request message specifying the TensorboardRuns to create. // A maximum of 1000 TensorboardRuns can be created in a batch. - repeated CreateTensorboardRunRequest requests = 2 [(google.api.field_behavior) = REQUIRED]; + repeated CreateTensorboardRunRequest requests = 2 + [(google.api.field_behavior) = REQUIRED]; } -// Response message for [TensorboardService.BatchCreateTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.BatchCreateTensorboardRuns]. +// Response message for +// [TensorboardService.BatchCreateTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.BatchCreateTensorboardRuns]. message BatchCreateTensorboardRunsResponse { // The created TensorboardRuns. repeated TensorboardRun tensorboard_runs = 1; } -// Request message for [TensorboardService.CreateTensorboardRun][google.cloud.aiplatform.v1.TensorboardService.CreateTensorboardRun]. +// Request message for +// [TensorboardService.CreateTensorboardRun][google.cloud.aiplatform.v1.TensorboardService.CreateTensorboardRun]. message CreateTensorboardRunRequest { - // Required. The resource name of the TensorboardExperiment to create the TensorboardRun - // in. Format: + // Required. The resource name of the TensorboardExperiment to create the + // TensorboardRun in. Format: // `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, @@ -580,7 +673,7 @@ message CreateTensorboardRunRequest { // Required. The TensorboardRun to create. TensorboardRun tensorboard_run = 2 [(google.api.field_behavior) = REQUIRED]; - // Required. The ID to use for the Tensorboard run, which will become the final + // Required. The ID to use for the Tensorboard run, which becomes the final // component of the Tensorboard run's resource name. // // This value should be 1-128 characters, and valid characters @@ -588,7 +681,8 @@ message CreateTensorboardRunRequest { string tensorboard_run_id = 3 [(google.api.field_behavior) = REQUIRED]; } -// Request message for [TensorboardService.GetTensorboardRun][google.cloud.aiplatform.v1.TensorboardService.GetTensorboardRun]. +// Request message for +// [TensorboardService.GetTensorboardRun][google.cloud.aiplatform.v1.TensorboardService.GetTensorboardRun]. message GetTensorboardRunRequest { // Required. The name of the TensorboardRun resource. // Format: @@ -601,11 +695,12 @@ message GetTensorboardRunRequest { ]; } -// Request message for [TensorboardService.ReadTensorboardBlobData][google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardBlobData]. +// Request message for +// [TensorboardService.ReadTensorboardBlobData][google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardBlobData]. message ReadTensorboardBlobDataRequest { // Required. The resource name of the TensorboardTimeSeries to list Blobs. // Format: - // 'projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}' + // `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}` string time_series = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -617,17 +712,19 @@ message ReadTensorboardBlobDataRequest { repeated string blob_ids = 2; } -// Response message for [TensorboardService.ReadTensorboardBlobData][google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardBlobData]. +// Response message for +// [TensorboardService.ReadTensorboardBlobData][google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardBlobData]. message ReadTensorboardBlobDataResponse { // Blob messages containing blob bytes. repeated TensorboardBlob blobs = 1; } -// Request message for [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns]. +// Request message for +// [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns]. message ListTensorboardRunsRequest { - // Required. The resource name of the TensorboardExperiment to list TensorboardRuns. - // Format: - // 'projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}' + // Required. The resource name of the TensorboardExperiment to list + // TensorboardRuns. Format: + // `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -639,18 +736,18 @@ message ListTensorboardRunsRequest { string filter = 2; // The maximum number of TensorboardRuns to return. The service may return - // fewer than this value. If unspecified, at most 50 TensorboardRuns will be - // returned. The maximum value is 1000; values above 1000 will be coerced to + // fewer than this value. If unspecified, at most 50 TensorboardRuns are + // returned. The maximum value is 1000; values above 1000 are coerced to // 1000. int32 page_size = 3; // A page token, received from a previous - // [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns] call. - // Provide this to retrieve the subsequent page. + // [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns] + // call. Provide this to retrieve the subsequent page. // // When paginating, all other parameters provided to - // [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns] must - // match the call that provided the page token. + // [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns] + // must match the call that provided the page token. string page_token = 4; // Field to use to sort the list. @@ -660,34 +757,39 @@ message ListTensorboardRunsRequest { google.protobuf.FieldMask read_mask = 6; } -// Response message for [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns]. +// Response message for +// [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns]. message ListTensorboardRunsResponse { // The TensorboardRuns mathching the request. repeated TensorboardRun tensorboard_runs = 1; - // A token, which can be sent as [ListTensorboardRunsRequest.page_token][google.cloud.aiplatform.v1.ListTensorboardRunsRequest.page_token] to - // retrieve the next page. - // If this field is omitted, there are no subsequent pages. + // A token, which can be sent as + // [ListTensorboardRunsRequest.page_token][google.cloud.aiplatform.v1.ListTensorboardRunsRequest.page_token] + // to retrieve the next page. If this field is omitted, there are no + // subsequent pages. string next_page_token = 2; } -// Request message for [TensorboardService.UpdateTensorboardRun][google.cloud.aiplatform.v1.TensorboardService.UpdateTensorboardRun]. +// Request message for +// [TensorboardService.UpdateTensorboardRun][google.cloud.aiplatform.v1.TensorboardService.UpdateTensorboardRun]. message UpdateTensorboardRunRequest { // Required. Field mask is used to specify the fields to be overwritten in the // TensorboardRun resource by the update. // The fields specified in the update_mask are relative to the resource, not - // the full request. A field will be overwritten if it is in the mask. If the - // user does not provide a mask then all fields will be overwritten if new + // the full request. A field is overwritten if it's in the mask. If the + // user does not provide a mask then all fields are overwritten if new // values are specified. - google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.FieldMask update_mask = 1 + [(google.api.field_behavior) = REQUIRED]; - // Required. The TensorboardRun's `name` field is used to identify the TensorboardRun to - // be updated. Format: + // Required. The TensorboardRun's `name` field is used to identify the + // TensorboardRun to be updated. Format: // `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` TensorboardRun tensorboard_run = 2 [(google.api.field_behavior) = REQUIRED]; } -// Request message for [TensorboardService.DeleteTensorboardRun][google.cloud.aiplatform.v1.TensorboardService.DeleteTensorboardRun]. +// Request message for +// [TensorboardService.DeleteTensorboardRun][google.cloud.aiplatform.v1.TensorboardService.DeleteTensorboardRun]. message DeleteTensorboardRunRequest { // Required. The name of the TensorboardRun to be deleted. // Format: @@ -700,7 +802,8 @@ message DeleteTensorboardRunRequest { ]; } -// Request message for [TensorboardService.BatchCreateTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.BatchCreateTensorboardTimeSeries]. +// Request message for +// [TensorboardService.BatchCreateTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.BatchCreateTensorboardTimeSeries]. message BatchCreateTensorboardTimeSeriesRequest { // Required. The resource name of the TensorboardExperiment to create the // TensorboardTimeSeries in. @@ -716,18 +819,21 @@ message BatchCreateTensorboardTimeSeriesRequest { } ]; - // Required. The request message specifying the TensorboardTimeSeries to create. - // A maximum of 1000 TensorboardTimeSeries can be created in a batch. - repeated CreateTensorboardTimeSeriesRequest requests = 2 [(google.api.field_behavior) = REQUIRED]; + // Required. The request message specifying the TensorboardTimeSeries to + // create. A maximum of 1000 TensorboardTimeSeries can be created in a batch. + repeated CreateTensorboardTimeSeriesRequest requests = 2 + [(google.api.field_behavior) = REQUIRED]; } -// Response message for [TensorboardService.BatchCreateTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.BatchCreateTensorboardTimeSeries]. +// Response message for +// [TensorboardService.BatchCreateTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.BatchCreateTensorboardTimeSeries]. message BatchCreateTensorboardTimeSeriesResponse { // The created TensorboardTimeSeries. repeated TensorboardTimeSeries tensorboard_time_series = 1; } -// Request message for [TensorboardService.CreateTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.CreateTensorboardTimeSeries]. +// Request message for +// [TensorboardService.CreateTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.CreateTensorboardTimeSeries]. message CreateTensorboardTimeSeriesRequest { // Required. The resource name of the TensorboardRun to create the // TensorboardTimeSeries in. @@ -740,17 +846,20 @@ message CreateTensorboardTimeSeriesRequest { } ]; - // Optional. The user specified unique ID to use for the TensorboardTimeSeries, which - // will become the final component of the TensorboardTimeSeries's resource - // name. - // This value should match "[a-z0-9][a-z0-9-]{0, 127}" - string tensorboard_time_series_id = 3 [(google.api.field_behavior) = OPTIONAL]; + // Optional. The user specified unique ID to use for the + // TensorboardTimeSeries, which becomes the final component of the + // TensorboardTimeSeries's resource name. This value should match + // "[a-z0-9][a-z0-9-]{0, 127}" + string tensorboard_time_series_id = 3 + [(google.api.field_behavior) = OPTIONAL]; // Required. The TensorboardTimeSeries to create. - TensorboardTimeSeries tensorboard_time_series = 2 [(google.api.field_behavior) = REQUIRED]; + TensorboardTimeSeries tensorboard_time_series = 2 + [(google.api.field_behavior) = REQUIRED]; } -// Request message for [TensorboardService.GetTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.GetTensorboardTimeSeries]. +// Request message for +// [TensorboardService.GetTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.GetTensorboardTimeSeries]. message GetTensorboardTimeSeriesRequest { // Required. The name of the TensorboardTimeSeries resource. // Format: @@ -763,11 +872,12 @@ message GetTensorboardTimeSeriesRequest { ]; } -// Request message for [TensorboardService.ListTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries]. +// Request message for +// [TensorboardService.ListTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries]. message ListTensorboardTimeSeriesRequest { - // Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. - // Format: - // 'projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}' + // Required. The resource name of the TensorboardRun to list + // TensorboardTimeSeries. Format: + // `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -780,17 +890,17 @@ message ListTensorboardTimeSeriesRequest { // The maximum number of TensorboardTimeSeries to return. The service may // return fewer than this value. If unspecified, at most 50 - // TensorboardTimeSeries will be returned. The maximum value is 1000; values - // above 1000 will be coerced to 1000. + // TensorboardTimeSeries are returned. The maximum value is 1000; values + // above 1000 are coerced to 1000. int32 page_size = 3; // A page token, received from a previous - // [TensorboardService.ListTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries] call. - // Provide this to retrieve the subsequent page. + // [TensorboardService.ListTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries] + // call. Provide this to retrieve the subsequent page. // // When paginating, all other parameters provided to - // [TensorboardService.ListTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries] must - // match the call that provided the page token. + // [TensorboardService.ListTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries] + // must match the call that provided the page token. string page_token = 4; // Field to use to sort the list. @@ -800,35 +910,41 @@ message ListTensorboardTimeSeriesRequest { google.protobuf.FieldMask read_mask = 6; } -// Response message for [TensorboardService.ListTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries]. +// Response message for +// [TensorboardService.ListTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries]. message ListTensorboardTimeSeriesResponse { // The TensorboardTimeSeries mathching the request. repeated TensorboardTimeSeries tensorboard_time_series = 1; // A token, which can be sent as - // [ListTensorboardTimeSeriesRequest.page_token][google.cloud.aiplatform.v1.ListTensorboardTimeSeriesRequest.page_token] to retrieve the next page. - // If this field is omitted, there are no subsequent pages. + // [ListTensorboardTimeSeriesRequest.page_token][google.cloud.aiplatform.v1.ListTensorboardTimeSeriesRequest.page_token] + // to retrieve the next page. If this field is omitted, there are no + // subsequent pages. string next_page_token = 2; } -// Request message for [TensorboardService.UpdateTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.UpdateTensorboardTimeSeries]. +// Request message for +// [TensorboardService.UpdateTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.UpdateTensorboardTimeSeries]. message UpdateTensorboardTimeSeriesRequest { // Required. Field mask is used to specify the fields to be overwritten in the // TensorboardTimeSeries resource by the update. // The fields specified in the update_mask are relative to the resource, not - // the full request. A field will be overwritten if it is in the mask. If the - // user does not provide a mask then all fields will be overwritten if new + // the full request. A field is overwritten if it's in the mask. If the + // user does not provide a mask then all fields are overwritten if new // values are specified. - google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.FieldMask update_mask = 1 + [(google.api.field_behavior) = REQUIRED]; // Required. The TensorboardTimeSeries' `name` field is used to identify the // TensorboardTimeSeries to be updated. // Format: // `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}` - TensorboardTimeSeries tensorboard_time_series = 2 [(google.api.field_behavior) = REQUIRED]; + TensorboardTimeSeries tensorboard_time_series = 2 + [(google.api.field_behavior) = REQUIRED]; } -// Request message for [TensorboardService.DeleteTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.DeleteTensorboardTimeSeries]. +// Request message for +// [TensorboardService.DeleteTensorboardTimeSeries][google.cloud.aiplatform.v1.TensorboardService.DeleteTensorboardTimeSeries]. message DeleteTensorboardTimeSeriesRequest { // Required. The name of the TensorboardTimeSeries to be deleted. // Format: @@ -844,11 +960,12 @@ message DeleteTensorboardTimeSeriesRequest { // Request message for // [TensorboardService.BatchReadTensorboardTimeSeriesData][google.cloud.aiplatform.v1.TensorboardService.BatchReadTensorboardTimeSeriesData]. message BatchReadTensorboardTimeSeriesDataRequest { - // Required. The resource name of the Tensorboard containing TensorboardTimeSeries to - // read data from. Format: + // Required. The resource name of the Tensorboard containing + // TensorboardTimeSeries to read data from. Format: // `projects/{project}/locations/{location}/tensorboards/{tensorboard}`. - // The TensorboardTimeSeries referenced by [time_series][google.cloud.aiplatform.v1.BatchReadTensorboardTimeSeriesDataRequest.time_series] must be sub - // resources of this Tensorboard. + // The TensorboardTimeSeries referenced by + // [time_series][google.cloud.aiplatform.v1.BatchReadTensorboardTimeSeriesDataRequest.time_series] + // must be sub resources of this Tensorboard. string tensorboard = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -856,7 +973,8 @@ message BatchReadTensorboardTimeSeriesDataRequest { } ]; - // Required. The resource names of the TensorboardTimeSeries to read data from. Format: + // Required. The resource names of the TensorboardTimeSeries to read data + // from. Format: // `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}` repeated string time_series = 2 [ (google.api.field_behavior) = REQUIRED, @@ -873,7 +991,8 @@ message BatchReadTensorboardTimeSeriesDataResponse { repeated TimeSeriesData time_series_data = 1; } -// Request message for [TensorboardService.ReadTensorboardTimeSeriesData][google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardTimeSeriesData]. +// Request message for +// [TensorboardService.ReadTensorboardTimeSeriesData][google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardTimeSeriesData]. message ReadTensorboardTimeSeriesDataRequest { // Required. The resource name of the TensorboardTimeSeries to read data from. // Format: @@ -895,13 +1014,15 @@ message ReadTensorboardTimeSeriesDataRequest { string filter = 3; } -// Response message for [TensorboardService.ReadTensorboardTimeSeriesData][google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardTimeSeriesData]. +// Response message for +// [TensorboardService.ReadTensorboardTimeSeriesData][google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardTimeSeriesData]. message ReadTensorboardTimeSeriesDataResponse { // The returned time series data. TimeSeriesData time_series_data = 1; } -// Request message for [TensorboardService.WriteTensorboardExperimentData][google.cloud.aiplatform.v1.TensorboardService.WriteTensorboardExperimentData]. +// Request message for +// [TensorboardService.WriteTensorboardExperimentData][google.cloud.aiplatform.v1.TensorboardService.WriteTensorboardExperimentData]. message WriteTensorboardExperimentDataRequest { // Required. The resource name of the TensorboardExperiment to write data to. // Format: @@ -914,15 +1035,16 @@ message WriteTensorboardExperimentDataRequest { ]; // Required. Requests containing per-run TensorboardTimeSeries data to write. - repeated WriteTensorboardRunDataRequest write_run_data_requests = 2 [(google.api.field_behavior) = REQUIRED]; + repeated WriteTensorboardRunDataRequest write_run_data_requests = 2 + [(google.api.field_behavior) = REQUIRED]; } -// Response message for [TensorboardService.WriteTensorboardExperimentData][google.cloud.aiplatform.v1.TensorboardService.WriteTensorboardExperimentData]. -message WriteTensorboardExperimentDataResponse { - -} +// Response message for +// [TensorboardService.WriteTensorboardExperimentData][google.cloud.aiplatform.v1.TensorboardService.WriteTensorboardExperimentData]. +message WriteTensorboardExperimentDataResponse {} -// Request message for [TensorboardService.WriteTensorboardRunData][google.cloud.aiplatform.v1.TensorboardService.WriteTensorboardRunData]. +// Request message for +// [TensorboardService.WriteTensorboardRunData][google.cloud.aiplatform.v1.TensorboardService.WriteTensorboardRunData]. message WriteTensorboardRunDataRequest { // Required. The resource name of the TensorboardRun to write data to. // Format: @@ -939,18 +1061,19 @@ message WriteTensorboardRunDataRequest { // Repeated writes to the same step will overwrite the existing value for that // step. // The upper limit of data points per write request is 5000. - repeated TimeSeriesData time_series_data = 2 [(google.api.field_behavior) = REQUIRED]; + repeated TimeSeriesData time_series_data = 2 + [(google.api.field_behavior) = REQUIRED]; } -// Response message for [TensorboardService.WriteTensorboardRunData][google.cloud.aiplatform.v1.TensorboardService.WriteTensorboardRunData]. -message WriteTensorboardRunDataResponse { - -} +// Response message for +// [TensorboardService.WriteTensorboardRunData][google.cloud.aiplatform.v1.TensorboardService.WriteTensorboardRunData]. +message WriteTensorboardRunDataResponse {} -// Request message for [TensorboardService.ExportTensorboardTimeSeriesData][google.cloud.aiplatform.v1.TensorboardService.ExportTensorboardTimeSeriesData]. +// Request message for +// [TensorboardService.ExportTensorboardTimeSeriesData][google.cloud.aiplatform.v1.TensorboardService.ExportTensorboardTimeSeriesData]. message ExportTensorboardTimeSeriesDataRequest { - // Required. The resource name of the TensorboardTimeSeries to export data from. - // Format: + // Required. The resource name of the TensorboardTimeSeries to export data + // from. Format: // `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}` string tensorboard_time_series = 1 [ (google.api.field_behavior) = REQUIRED, @@ -963,8 +1086,8 @@ message ExportTensorboardTimeSeriesDataRequest { string filter = 2; // The maximum number of data points to return per page. - // The default page_size will be 1000. Values must be between 1 and 10000. - // Values above 10000 will be coerced to 10000. + // The default page_size is 1000. Values must be between 1 and 10000. + // Values above 10000 are coerced to 10000. int32 page_size = 3; // A page token, received from a previous @@ -977,12 +1100,13 @@ message ExportTensorboardTimeSeriesDataRequest { string page_token = 4; // Field to use to sort the TensorboardTimeSeries' data. - // By default, TensorboardTimeSeries' data will be returned in a pseudo random + // By default, TensorboardTimeSeries' data is returned in a pseudo random // order. string order_by = 5; } -// Response message for [TensorboardService.ExportTensorboardTimeSeriesData][google.cloud.aiplatform.v1.TensorboardService.ExportTensorboardTimeSeriesData]. +// Response message for +// [TensorboardService.ExportTensorboardTimeSeriesData][google.cloud.aiplatform.v1.TensorboardService.ExportTensorboardTimeSeriesData]. message ExportTensorboardTimeSeriesDataResponse { // The returned time series data points. repeated TimeSeriesDataPoint time_series_data_points = 1; diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/tensorboard_time_series.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/tensorboard_time_series.proto index eff288e5d12..09af560fb8d 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/tensorboard_time_series.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/tensorboard_time_series.proto @@ -37,16 +37,19 @@ message TensorboardTimeSeries { // Describes metadata for a TensorboardTimeSeries. message Metadata { - // Output only. Max step index of all data points within a TensorboardTimeSeries. + // Output only. Max step index of all data points within a + // TensorboardTimeSeries. int64 max_step = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Max wall clock timestamp of all data points within a // TensorboardTimeSeries. - google.protobuf.Timestamp max_wall_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp max_wall_time = 2 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. The largest blob sequence length (number of blobs) of all data points in - // this time series, if its ValueType is BLOB_SEQUENCE. - int64 max_blob_sequence_length = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. The largest blob sequence length (number of blobs) of all + // data points in this time series, if its ValueType is BLOB_SEQUENCE. + int64 max_blob_sequence_length = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // An enum representing the value type of a TensorboardTimeSeries. @@ -85,22 +88,25 @@ message TensorboardTimeSeries { ]; // Output only. Timestamp when this TensorboardTimeSeries was created. - google.protobuf.Timestamp create_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this TensorboardTimeSeries was last updated. - google.protobuf.Timestamp update_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 6 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Used to perform a consistent read-modify-write updates. If not set, a blind // "overwrite" update happens. string etag = 7; - // Immutable. Name of the plugin this time series pertain to. Such as Scalar, Tensor, - // Blob + // Immutable. Name of the plugin this time series pertain to. Such as Scalar, + // Tensor, Blob string plugin_name = 8 [(google.api.field_behavior) = IMMUTABLE]; // Data of the current plugin, with the size limited to 65KB. bytes plugin_data = 9; - // Output only. Scalar, Tensor, or Blob metadata for this TensorboardTimeSeries. + // Output only. Scalar, Tensor, or Blob metadata for this + // TensorboardTimeSeries. Metadata metadata = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/training_pipeline.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/training_pipeline.proto index a0de8cf400f..298cc49a1d6 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/training_pipeline.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/training_pipeline.proto @@ -37,8 +37,8 @@ option ruby_package = "Google::Cloud::AIPlatform::V1"; // The TrainingPipeline orchestrates tasks associated with training a Model. It // always executes the training task, and optionally may also // export data from Vertex AI's Dataset which becomes the training input, -// [upload][google.cloud.aiplatform.v1.ModelService.UploadModel] the Model to Vertex AI, and evaluate the -// Model. +// [upload][google.cloud.aiplatform.v1.ModelService.UploadModel] the Model to +// Vertex AI, and evaluate the Model. message TrainingPipeline { option (google.api.resource) = { type: "aiplatform.googleapis.com/TrainingPipeline" @@ -52,17 +52,20 @@ message TrainingPipeline { string display_name = 2 [(google.api.field_behavior) = REQUIRED]; // Specifies Vertex AI owned input data that may be used for training the - // Model. The TrainingPipeline's [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition] should make - // clear whether this config is used and if there are any special requirements - // on how it should be filled. If nothing about this config is mentioned in - // the [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition], then it should be assumed that the - // TrainingPipeline does not depend on this configuration. + // Model. The TrainingPipeline's + // [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition] + // should make clear whether this config is used and if there are any special + // requirements on how it should be filled. If nothing about this config is + // mentioned in the + // [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition], + // then it should be assumed that the TrainingPipeline does not depend on this + // configuration. InputDataConfig input_data_config = 3; - // Required. A Google Cloud Storage path to the YAML file that defines the training task - // which is responsible for producing the model artifact, and may also include - // additional auxiliary work. - // The definition files that can be used here are found in + // Required. A Google Cloud Storage path to the YAML file that defines the + // training task which is responsible for producing the model artifact, and + // may also include additional auxiliary work. The definition files that can + // be used here are found in // gs://google-cloud-aiplatform/schema/trainingjob/definition/. // Note: The URI given on output will be immutable and probably different, // including the URI scheme, than the one given on input. The output URI will @@ -70,30 +73,38 @@ message TrainingPipeline { string training_task_definition = 4 [(google.api.field_behavior) = REQUIRED]; // Required. The training task's parameter(s), as specified in the - // [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition]'s `inputs`. - google.protobuf.Value training_task_inputs = 5 [(google.api.field_behavior) = REQUIRED]; + // [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition]'s + // `inputs`. + google.protobuf.Value training_task_inputs = 5 + [(google.api.field_behavior) = REQUIRED]; - // Output only. The metadata information as specified in the [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition]'s + // Output only. The metadata information as specified in the + // [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition]'s // `metadata`. This metadata is an auxiliary runtime and final information // about the training task. While the pipeline is running this information is // populated only at a best effort basis. Only present if the - // pipeline's [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition] contains `metadata` object. - google.protobuf.Value training_task_metadata = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Describes the Model that may be uploaded (via [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel]) + // pipeline's + // [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition] + // contains `metadata` object. + google.protobuf.Value training_task_metadata = 6 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Describes the Model that may be uploaded (via + // [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel]) // by this TrainingPipeline. The TrainingPipeline's - // [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition] should make clear whether this Model - // description should be populated, and if there are any special requirements - // regarding how it should be filled. If nothing is mentioned in the - // [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition], then it should be assumed that this field - // should not be filled and the training task either uploads the Model without - // a need of this information, or that training task does not support - // uploading a Model as part of the pipeline. - // When the Pipeline's state becomes `PIPELINE_STATE_SUCCEEDED` and + // [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition] + // should make clear whether this Model description should be populated, and + // if there are any special requirements regarding how it should be filled. If + // nothing is mentioned in the + // [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition], + // then it should be assumed that this field should not be filled and the + // training task either uploads the Model without a need of this information, + // or that training task does not support uploading a Model as part of the + // pipeline. When the Pipeline's state becomes `PIPELINE_STATE_SUCCEEDED` and // the trained Model had been uploaded into Vertex AI, then the - // model_to_upload's resource [name][google.cloud.aiplatform.v1.Model.name] is populated. The Model - // is always uploaded into the Project and Location in which this pipeline - // is. + // model_to_upload's resource [name][google.cloud.aiplatform.v1.Model.name] is + // populated. The Model is always uploaded into the Project and Location in + // which this pipeline is. Model model_to_upload = 7; // Optional. The ID to use for the uploaded Model, which will become the final @@ -103,31 +114,36 @@ message TrainingPipeline { // `[a-z0-9_-]`. The first character cannot be a number or hyphen. string model_id = 22 [(google.api.field_behavior) = OPTIONAL]; - // Optional. When specify this field, the `model_to_upload` will not be uploaded as a - // new model, instead, it will become a new version of this `parent_model`. + // Optional. When specify this field, the `model_to_upload` will not be + // uploaded as a new model, instead, it will become a new version of this + // `parent_model`. string parent_model = 21 [(google.api.field_behavior) = OPTIONAL]; // Output only. The detailed state of the pipeline. PipelineState state = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. Only populated when the pipeline's state is `PIPELINE_STATE_FAILED` or - // `PIPELINE_STATE_CANCELLED`. + // Output only. Only populated when the pipeline's state is + // `PIPELINE_STATE_FAILED` or `PIPELINE_STATE_CANCELLED`. google.rpc.Status error = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Time when the TrainingPipeline was created. - google.protobuf.Timestamp create_time = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 11 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Time when the TrainingPipeline for the first time entered the // `PIPELINE_STATE_RUNNING` state. - google.protobuf.Timestamp start_time = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp start_time = 12 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. Time when the TrainingPipeline entered any of the following states: - // `PIPELINE_STATE_SUCCEEDED`, `PIPELINE_STATE_FAILED`, + // Output only. Time when the TrainingPipeline entered any of the following + // states: `PIPELINE_STATE_SUCCEEDED`, `PIPELINE_STATE_FAILED`, // `PIPELINE_STATE_CANCELLED`. - google.protobuf.Timestamp end_time = 13 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp end_time = 13 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Time when the TrainingPipeline was most recently updated. - google.protobuf.Timestamp update_time = 14 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 14 + [(google.api.field_behavior) = OUTPUT_ONLY]; // The labels with user-defined metadata to organize TrainingPipelines. // @@ -142,7 +158,8 @@ message TrainingPipeline { // TrainingPipeline will be secured by this key. // // Note: Model trained by this TrainingPipeline is also secured by this key if - // [model_to_upload][google.cloud.aiplatform.v1.TrainingPipeline.encryption_spec] is not set separately. + // [model_to_upload][google.cloud.aiplatform.v1.TrainingPipeline.encryption_spec] + // is not set separately. EncryptionSpec encryption_spec = 18; } @@ -151,7 +168,9 @@ message TrainingPipeline { message InputDataConfig { // The instructions how the input data should be split between the // training, validation and test sets. - // If no split type is provided, the [fraction_split][google.cloud.aiplatform.v1.InputDataConfig.fraction_split] is used by default. + // If no split type is provided, the + // [fraction_split][google.cloud.aiplatform.v1.InputDataConfig.fraction_split] + // is used by default. oneof split { // Split based on fractions defining the size of each set. FractionSplit fraction_split = 2; @@ -235,9 +254,9 @@ message InputDataConfig { BigQueryDestination bigquery_destination = 10; } - // Required. The ID of the Dataset in the same Project and Location which data will be - // used to train the Model. The Dataset must use schema compatible with - // Model being trained, and what is compatible should be described in the + // Required. The ID of the Dataset in the same Project and Location which data + // will be used to train the Model. The Dataset must use schema compatible + // with Model being trained, and what is compatible should be described in the // used TrainingPipeline's [training_task_definition] // [google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition]. // For tabular Datasets, all their data is exported to training, to pick @@ -251,9 +270,9 @@ message InputDataConfig { // are used in respectively training, validation or test role, depending on // the role of the DataItem they are on (for the auto-assigned that role is // decided by Vertex AI). A filter with same syntax as the one used in - // [ListAnnotations][google.cloud.aiplatform.v1.DatasetService.ListAnnotations] may be used, but note - // here it filters across all Annotations of the Dataset, and not just within - // a single DataItem. + // [ListAnnotations][google.cloud.aiplatform.v1.DatasetService.ListAnnotations] + // may be used, but note here it filters across all Annotations of the + // Dataset, and not just within a single DataItem. string annotations_filter = 6; // Applicable only to custom training with Datasets that have DataItems and @@ -265,31 +284,45 @@ message InputDataConfig { // The schema files that can be used here are found in // gs://google-cloud-aiplatform/schema/dataset/annotation/ , note that the // chosen schema must be consistent with - // [metadata][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri] of the Dataset specified by + // [metadata][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri] of the + // Dataset specified by // [dataset_id][google.cloud.aiplatform.v1.InputDataConfig.dataset_id]. // // Only Annotations that both match this schema and belong to DataItems not // ignored by the split method are used in respectively training, validation // or test role, depending on the role of the DataItem they are on. // - // When used in conjunction with [annotations_filter][google.cloud.aiplatform.v1.InputDataConfig.annotations_filter], the Annotations used - // for training are filtered by both [annotations_filter][google.cloud.aiplatform.v1.InputDataConfig.annotations_filter] and + // When used in conjunction with + // [annotations_filter][google.cloud.aiplatform.v1.InputDataConfig.annotations_filter], + // the Annotations used for training are filtered by both + // [annotations_filter][google.cloud.aiplatform.v1.InputDataConfig.annotations_filter] + // and // [annotation_schema_uri][google.cloud.aiplatform.v1.InputDataConfig.annotation_schema_uri]. string annotation_schema_uri = 9; // Only applicable to Datasets that have SavedQueries. // // The ID of a SavedQuery (annotation set) under the Dataset specified by - // [dataset_id][google.cloud.aiplatform.v1.InputDataConfig.dataset_id] used for filtering Annotations for training. + // [dataset_id][google.cloud.aiplatform.v1.InputDataConfig.dataset_id] used + // for filtering Annotations for training. // // Only Annotations that are associated with this SavedQuery are used in // respectively training. When used in conjunction with - // [annotations_filter][google.cloud.aiplatform.v1.InputDataConfig.annotations_filter], the Annotations used for training are filtered by - // both [saved_query_id][google.cloud.aiplatform.v1.InputDataConfig.saved_query_id] and [annotations_filter][google.cloud.aiplatform.v1.InputDataConfig.annotations_filter]. + // [annotations_filter][google.cloud.aiplatform.v1.InputDataConfig.annotations_filter], + // the Annotations used for training are filtered by both + // [saved_query_id][google.cloud.aiplatform.v1.InputDataConfig.saved_query_id] + // and + // [annotations_filter][google.cloud.aiplatform.v1.InputDataConfig.annotations_filter]. // - // Only one of [saved_query_id][google.cloud.aiplatform.v1.InputDataConfig.saved_query_id] and [annotation_schema_uri][google.cloud.aiplatform.v1.InputDataConfig.annotation_schema_uri] should be - // specified as both of them represent the same thing: problem type. + // Only one of + // [saved_query_id][google.cloud.aiplatform.v1.InputDataConfig.saved_query_id] + // and + // [annotation_schema_uri][google.cloud.aiplatform.v1.InputDataConfig.annotation_schema_uri] + // should be specified as both of them represent the same thing: problem type. string saved_query_id = 7; + + // Whether to persist the ML use assignment to data item system labels. + bool persist_ml_use_assignment = 11; } // Assigns the input data to training, validation, and test sets as per the @@ -320,26 +353,29 @@ message FractionSplit { message FilterSplit { // Required. A filter on DataItems of the Dataset. DataItems that match // this filter are used to train the Model. A filter with same syntax - // as the one used in [DatasetService.ListDataItems][google.cloud.aiplatform.v1.DatasetService.ListDataItems] may be used. If a - // single DataItem is matched by more than one of the FilterSplit filters, - // then it is assigned to the first set that applies to it in the - // training, validation, test order. + // as the one used in + // [DatasetService.ListDataItems][google.cloud.aiplatform.v1.DatasetService.ListDataItems] + // may be used. If a single DataItem is matched by more than one of the + // FilterSplit filters, then it is assigned to the first set that applies to + // it in the training, validation, test order. string training_filter = 1 [(google.api.field_behavior) = REQUIRED]; // Required. A filter on DataItems of the Dataset. DataItems that match // this filter are used to validate the Model. A filter with same syntax - // as the one used in [DatasetService.ListDataItems][google.cloud.aiplatform.v1.DatasetService.ListDataItems] may be used. If a - // single DataItem is matched by more than one of the FilterSplit filters, - // then it is assigned to the first set that applies to it in the - // training, validation, test order. + // as the one used in + // [DatasetService.ListDataItems][google.cloud.aiplatform.v1.DatasetService.ListDataItems] + // may be used. If a single DataItem is matched by more than one of the + // FilterSplit filters, then it is assigned to the first set that applies to + // it in the training, validation, test order. string validation_filter = 2 [(google.api.field_behavior) = REQUIRED]; // Required. A filter on DataItems of the Dataset. DataItems that match // this filter are used to test the Model. A filter with same syntax - // as the one used in [DatasetService.ListDataItems][google.cloud.aiplatform.v1.DatasetService.ListDataItems] may be used. If a - // single DataItem is matched by more than one of the FilterSplit filters, - // then it is assigned to the first set that applies to it in the - // training, validation, test order. + // as the one used in + // [DatasetService.ListDataItems][google.cloud.aiplatform.v1.DatasetService.ListDataItems] + // may be used. If a single DataItem is matched by more than one of the + // FilterSplit filters, then it is assigned to the first set that applies to + // it in the training, validation, test order. string test_filter = 3 [(google.api.field_behavior) = REQUIRED]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/unmanaged_container_model.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/unmanaged_container_model.proto index 62e3e459c8a..c3d167d817a 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/unmanaged_container_model.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/unmanaged_container_model.proto @@ -37,7 +37,8 @@ message UnmanagedContainerModel { // Contains the schemata used in Model's predictions and explanations PredictSchemata predict_schemata = 2; - // Input only. The specification of the container that is to be used when deploying - // this Model. - ModelContainerSpec container_spec = 3 [(google.api.field_behavior) = INPUT_ONLY]; + // Input only. The specification of the container that is to be used when + // deploying this Model. + ModelContainerSpec container_spec = 3 + [(google.api.field_behavior) = INPUT_ONLY]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/user_action_reference.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/user_action_reference.proto index bf4c9f933fc..102dac6d47f 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/user_action_reference.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/user_action_reference.proto @@ -31,13 +31,13 @@ message UserActionReference { // For API calls that return a long running operation. // Resource name of the long running operation. // Format: - // 'projects/{project}/locations/{location}/operations/{operation}' + // `projects/{project}/locations/{location}/operations/{operation}` string operation = 1; // For API calls that start a LabelingJob. // Resource name of the LabelingJob. // Format: - // 'projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}' + // `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` string data_labeling_job = 2; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/vizier_service.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/vizier_service.proto index 70cc7a7a269..da56853fa6e 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/vizier_service.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1/vizier_service.proto @@ -41,7 +41,8 @@ option ruby_package = "Google::Cloud::AIPlatform::V1"; // learning architectures. service VizierService { option (google.api.default_host) = "aiplatform.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/cloud-platform"; // Creates a Study. A resource name will be generated after creation of the // Study. @@ -92,7 +93,8 @@ service VizierService { // operation associated with the generation of Trial suggestions. // When this long-running operation succeeds, it will contain // a [SuggestTrialsResponse][google.cloud.ml.v1.SuggestTrialsResponse]. - rpc SuggestTrials(SuggestTrialsRequest) returns (google.longrunning.Operation) { + rpc SuggestTrials(SuggestTrialsRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{parent=projects/*/locations/*/studies/*}/trials:suggest" body: "*" @@ -157,7 +159,8 @@ service VizierService { // long-running operation. When the operation is successful, // it will contain a // [CheckTrialEarlyStoppingStateResponse][google.cloud.ml.v1.CheckTrialEarlyStoppingStateResponse]. - rpc CheckTrialEarlyStoppingState(CheckTrialEarlyStoppingStateRequest) returns (google.longrunning.Operation) { + rpc CheckTrialEarlyStoppingState(CheckTrialEarlyStoppingStateRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{trial_name=projects/*/locations/*/studies/*/trials/*}:checkTrialEarlyStoppingState" body: "*" @@ -180,7 +183,8 @@ service VizierService { // optimal Trials for single-objective Study. The definition of // pareto-optimal can be checked in wiki page. // https://en.wikipedia.org/wiki/Pareto_efficiency - rpc ListOptimalTrials(ListOptimalTrialsRequest) returns (ListOptimalTrialsResponse) { + rpc ListOptimalTrials(ListOptimalTrialsRequest) + returns (ListOptimalTrialsResponse) { option (google.api.http) = { post: "/v1/{parent=projects/*/locations/*/studies/*}/trials:listOptimalTrials" body: "*" @@ -189,7 +193,8 @@ service VizierService { } } -// Request message for [VizierService.GetStudy][google.cloud.aiplatform.v1.VizierService.GetStudy]. +// Request message for +// [VizierService.GetStudy][google.cloud.aiplatform.v1.VizierService.GetStudy]. message GetStudyRequest { // Required. The name of the Study resource. // Format: `projects/{project}/locations/{location}/studies/{study}` @@ -201,7 +206,8 @@ message GetStudyRequest { ]; } -// Request message for [VizierService.CreateStudy][google.cloud.aiplatform.v1.VizierService.CreateStudy]. +// Request message for +// [VizierService.CreateStudy][google.cloud.aiplatform.v1.VizierService.CreateStudy]. message CreateStudyRequest { // Required. The resource name of the Location to create the CustomJob in. // Format: `projects/{project}/locations/{location}` @@ -216,7 +222,8 @@ message CreateStudyRequest { Study study = 2 [(google.api.field_behavior) = REQUIRED]; } -// Request message for [VizierService.ListStudies][google.cloud.aiplatform.v1.VizierService.ListStudies]. +// Request message for +// [VizierService.ListStudies][google.cloud.aiplatform.v1.VizierService.ListStudies]. message ListStudiesRequest { // Required. The resource name of the Location to list the Study from. // Format: `projects/{project}/locations/{location}` @@ -236,7 +243,8 @@ message ListStudiesRequest { int32 page_size = 3 [(google.api.field_behavior) = OPTIONAL]; } -// Response message for [VizierService.ListStudies][google.cloud.aiplatform.v1.VizierService.ListStudies]. +// Response message for +// [VizierService.ListStudies][google.cloud.aiplatform.v1.VizierService.ListStudies]. message ListStudiesResponse { // The studies associated with the project. repeated Study studies = 1; @@ -247,7 +255,8 @@ message ListStudiesResponse { string next_page_token = 2; } -// Request message for [VizierService.DeleteStudy][google.cloud.aiplatform.v1.VizierService.DeleteStudy]. +// Request message for +// [VizierService.DeleteStudy][google.cloud.aiplatform.v1.VizierService.DeleteStudy]. message DeleteStudyRequest { // Required. The name of the Study resource to be deleted. // Format: `projects/{project}/locations/{location}/studies/{study}` @@ -259,7 +268,8 @@ message DeleteStudyRequest { ]; } -// Request message for [VizierService.LookupStudy][google.cloud.aiplatform.v1.VizierService.LookupStudy]. +// Request message for +// [VizierService.LookupStudy][google.cloud.aiplatform.v1.VizierService.LookupStudy]. message LookupStudyRequest { // Required. The resource name of the Location to get the Study from. // Format: `projects/{project}/locations/{location}` @@ -274,7 +284,8 @@ message LookupStudyRequest { string display_name = 2 [(google.api.field_behavior) = REQUIRED]; } -// Request message for [VizierService.SuggestTrials][google.cloud.aiplatform.v1.VizierService.SuggestTrials]. +// Request message for +// [VizierService.SuggestTrials][google.cloud.aiplatform.v1.VizierService.SuggestTrials]. message SuggestTrialsRequest { // Required. The project and location that the Study belongs to. // Format: `projects/{project}/locations/{location}/studies/{study}` @@ -296,7 +307,8 @@ message SuggestTrialsRequest { string client_id = 3 [(google.api.field_behavior) = REQUIRED]; } -// Response message for [VizierService.SuggestTrials][google.cloud.aiplatform.v1.VizierService.SuggestTrials]. +// Response message for +// [VizierService.SuggestTrials][google.cloud.aiplatform.v1.VizierService.SuggestTrials]. message SuggestTrialsResponse { // A list of Trials. repeated Trial trials = 1; @@ -324,7 +336,8 @@ message SuggestTrialsMetadata { string client_id = 2; } -// Request message for [VizierService.CreateTrial][google.cloud.aiplatform.v1.VizierService.CreateTrial]. +// Request message for +// [VizierService.CreateTrial][google.cloud.aiplatform.v1.VizierService.CreateTrial]. message CreateTrialRequest { // Required. The resource name of the Study to create the Trial in. // Format: `projects/{project}/locations/{location}/studies/{study}` @@ -339,7 +352,8 @@ message CreateTrialRequest { Trial trial = 2 [(google.api.field_behavior) = REQUIRED]; } -// Request message for [VizierService.GetTrial][google.cloud.aiplatform.v1.VizierService.GetTrial]. +// Request message for +// [VizierService.GetTrial][google.cloud.aiplatform.v1.VizierService.GetTrial]. message GetTrialRequest { // Required. The name of the Trial resource. // Format: @@ -352,7 +366,8 @@ message GetTrialRequest { ]; } -// Request message for [VizierService.ListTrials][google.cloud.aiplatform.v1.VizierService.ListTrials]. +// Request message for +// [VizierService.ListTrials][google.cloud.aiplatform.v1.VizierService.ListTrials]. message ListTrialsRequest { // Required. The resource name of the Study to list the Trial from. // Format: `projects/{project}/locations/{location}/studies/{study}` @@ -372,7 +387,8 @@ message ListTrialsRequest { int32 page_size = 3 [(google.api.field_behavior) = OPTIONAL]; } -// Response message for [VizierService.ListTrials][google.cloud.aiplatform.v1.VizierService.ListTrials]. +// Response message for +// [VizierService.ListTrials][google.cloud.aiplatform.v1.VizierService.ListTrials]. message ListTrialsResponse { // The Trials associated with the Study. repeated Trial trials = 1; @@ -383,7 +399,8 @@ message ListTrialsResponse { string next_page_token = 2; } -// Request message for [VizierService.AddTrialMeasurement][google.cloud.aiplatform.v1.VizierService.AddTrialMeasurement]. +// Request message for +// [VizierService.AddTrialMeasurement][google.cloud.aiplatform.v1.VizierService.AddTrialMeasurement]. message AddTrialMeasurementRequest { // Required. The name of the trial to add measurement. // Format: @@ -399,7 +416,8 @@ message AddTrialMeasurementRequest { Measurement measurement = 3 [(google.api.field_behavior) = REQUIRED]; } -// Request message for [VizierService.CompleteTrial][google.cloud.aiplatform.v1.VizierService.CompleteTrial]. +// Request message for +// [VizierService.CompleteTrial][google.cloud.aiplatform.v1.VizierService.CompleteTrial]. message CompleteTrialRequest { // Required. The Trial's name. // Format: @@ -425,7 +443,8 @@ message CompleteTrialRequest { string infeasible_reason = 4 [(google.api.field_behavior) = OPTIONAL]; } -// Request message for [VizierService.DeleteTrial][google.cloud.aiplatform.v1.VizierService.DeleteTrial]. +// Request message for +// [VizierService.DeleteTrial][google.cloud.aiplatform.v1.VizierService.DeleteTrial]. message DeleteTrialRequest { // Required. The Trial's name. // Format: @@ -438,7 +457,8 @@ message DeleteTrialRequest { ]; } -// Request message for [VizierService.CheckTrialEarlyStoppingState][google.cloud.aiplatform.v1.VizierService.CheckTrialEarlyStoppingState]. +// Request message for +// [VizierService.CheckTrialEarlyStoppingState][google.cloud.aiplatform.v1.VizierService.CheckTrialEarlyStoppingState]. message CheckTrialEarlyStoppingStateRequest { // Required. The Trial's name. // Format: @@ -451,7 +471,8 @@ message CheckTrialEarlyStoppingStateRequest { ]; } -// Response message for [VizierService.CheckTrialEarlyStoppingState][google.cloud.aiplatform.v1.VizierService.CheckTrialEarlyStoppingState]. +// Response message for +// [VizierService.CheckTrialEarlyStoppingState][google.cloud.aiplatform.v1.VizierService.CheckTrialEarlyStoppingState]. message CheckTrialEarlyStoppingStateResponse { // True if the Trial should stop. bool should_stop = 1; @@ -471,7 +492,8 @@ message CheckTrialEarlyStoppingStateMetatdata { string trial = 3; } -// Request message for [VizierService.StopTrial][google.cloud.aiplatform.v1.VizierService.StopTrial]. +// Request message for +// [VizierService.StopTrial][google.cloud.aiplatform.v1.VizierService.StopTrial]. message StopTrialRequest { // Required. The Trial's name. // Format: @@ -484,7 +506,8 @@ message StopTrialRequest { ]; } -// Request message for [VizierService.ListOptimalTrials][google.cloud.aiplatform.v1.VizierService.ListOptimalTrials]. +// Request message for +// [VizierService.ListOptimalTrials][google.cloud.aiplatform.v1.VizierService.ListOptimalTrials]. message ListOptimalTrialsRequest { // Required. The name of the Study that the optimal Trial belongs to. string parent = 1 [ @@ -495,7 +518,8 @@ message ListOptimalTrialsRequest { ]; } -// Response message for [VizierService.ListOptimalTrials][google.cloud.aiplatform.v1.VizierService.ListOptimalTrials]. +// Response message for +// [VizierService.ListOptimalTrials][google.cloud.aiplatform.v1.VizierService.ListOptimalTrials]. message ListOptimalTrialsResponse { // The pareto-optimal Trials for multiple objective Study or the // optimal trial for single objective Study. The definition of diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/accelerator_type.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/accelerator_type.proto index af624cb732b..4d4c3b8f01c 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/accelerator_type.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/accelerator_type.proto @@ -47,6 +47,9 @@ enum AcceleratorType { // Nvidia Tesla A100 GPU. NVIDIA_TESLA_A100 = 8; + // Nvidia A2 Ultra GPU. + NVIDIA_A100_80GB = 9; + // TPU v2. TPU_V2 = 6; diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/annotation.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/annotation.proto index e57ab445a7d..44858aa0ebd 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/annotation.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/annotation.proto @@ -41,8 +41,9 @@ message Annotation { // Output only. Resource name of the Annotation. string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Required. Google Cloud Storage URI points to a YAML file describing [payload][google.cloud.aiplatform.v1beta1.Annotation.payload]. The - // schema is defined as an [OpenAPI 3.0.2 Schema + // Required. Google Cloud Storage URI points to a YAML file describing + // [payload][google.cloud.aiplatform.v1beta1.Annotation.payload]. The schema + // is defined as an [OpenAPI 3.0.2 Schema // Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). // The schema files that can be used here are found in // gs://google-cloud-aiplatform/schema/dataset/annotation/, note that the @@ -55,19 +56,23 @@ message Annotation { google.protobuf.Value payload = 3 [(google.api.field_behavior) = REQUIRED]; // Output only. Timestamp when this Annotation was created. - google.protobuf.Timestamp create_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this Annotation was last updated. - google.protobuf.Timestamp update_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 7 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Optional. Used to perform consistent read-modify-write updates. If not set, a blind - // "overwrite" update happens. + // Optional. Used to perform consistent read-modify-write updates. If not set, + // a blind "overwrite" update happens. string etag = 8 [(google.api.field_behavior) = OPTIONAL]; // Output only. The source of the Annotation. - UserActionReference annotation_source = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + UserActionReference annotation_source = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Optional. The labels with user-defined metadata to organize your Annotations. + // Optional. The labels with user-defined metadata to organize your + // Annotations. // // Label keys and values can be no longer than 64 characters // (Unicode codepoints), can only contain lowercase letters, numeric @@ -84,7 +89,8 @@ message Annotation { // If not set, the Annotation is not visible in the UI. // // * "aiplatform.googleapis.com/payload_schema": - // output only, its value is the [payload_schema's][google.cloud.aiplatform.v1beta1.Annotation.payload_schema_uri] + // output only, its value is the + // [payload_schema's][google.cloud.aiplatform.v1beta1.Annotation.payload_schema_uri] // title. map labels = 6 [(google.api.field_behavior) = OPTIONAL]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/annotation_spec.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/annotation_spec.proto index 5d4c5664ec7..a2c18690bc1 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/annotation_spec.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/annotation_spec.proto @@ -39,17 +39,19 @@ message AnnotationSpec { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. The user-defined name of the AnnotationSpec. - // The name can be up to 128 characters long and can be consist of any UTF-8 + // The name can be up to 128 characters long and can consist of any UTF-8 // characters. string display_name = 2 [(google.api.field_behavior) = REQUIRED]; // Output only. Timestamp when this AnnotationSpec was created. - google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when AnnotationSpec was last updated. - google.protobuf.Timestamp update_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Optional. Used to perform consistent read-modify-write updates. If not set, a blind - // "overwrite" update happens. + // Optional. Used to perform consistent read-modify-write updates. If not set, + // a blind "overwrite" update happens. string etag = 5 [(google.api.field_behavior) = OPTIONAL]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/artifact.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/artifact.proto index 378afb3f79b..b0df629bcba 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/artifact.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/artifact.proto @@ -75,10 +75,12 @@ message Artifact { map labels = 10; // Output only. Timestamp when this Artifact was created. - google.protobuf.Timestamp create_time = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 11 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this Artifact was last updated. - google.protobuf.Timestamp update_time = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 12 + [(google.api.field_behavior) = OUTPUT_ONLY]; // The state of this Artifact. This is a property of the Artifact, and does // not imply or capture any ongoing process. This property is managed by @@ -101,6 +103,7 @@ message Artifact { string schema_version = 15; // Properties of the Artifact. + // Top level metadata keys' heading and trailing spaces will be trimmed. // The size of this field should not exceed 200KB. google.protobuf.Struct metadata = 16; diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/batch_prediction_job.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/batch_prediction_job.proto index 63fb0d9d0c4..bf4f40b8f6d 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/batch_prediction_job.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/batch_prediction_job.proto @@ -40,19 +40,24 @@ option java_package = "com.google.cloud.aiplatform.v1beta1"; option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1"; option ruby_package = "Google::Cloud::AIPlatform::V1beta1"; -// A job that uses a [Model][google.cloud.aiplatform.v1beta1.BatchPredictionJob.model] to produce predictions -// on multiple [input instances][google.cloud.aiplatform.v1beta1.BatchPredictionJob.input_config]. If -// predictions for significant portion of the instances fail, the job may finish -// without attempting predictions for all remaining instances. +// A job that uses a +// [Model][google.cloud.aiplatform.v1beta1.BatchPredictionJob.model] to produce +// predictions on multiple [input +// instances][google.cloud.aiplatform.v1beta1.BatchPredictionJob.input_config]. +// If predictions for significant portion of the instances fail, the job may +// finish without attempting predictions for all remaining instances. message BatchPredictionJob { option (google.api.resource) = { type: "aiplatform.googleapis.com/BatchPredictionJob" pattern: "projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}" }; - // Configures the input to [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob]. - // See [Model.supported_input_storage_formats][google.cloud.aiplatform.v1beta1.Model.supported_input_storage_formats] for Model's supported input - // formats, and how instances should be expressed via any of them. + // Configures the input to + // [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob]. + // See + // [Model.supported_input_storage_formats][google.cloud.aiplatform.v1beta1.Model.supported_input_storage_formats] + // for Model's supported input formats, and how instances should be expressed + // via any of them. message InputConfig { // Required. The source of the input. oneof source { @@ -73,9 +78,110 @@ message BatchPredictionJob { string instances_format = 1 [(google.api.field_behavior) = REQUIRED]; } - // Configures the output of [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob]. - // See [Model.supported_output_storage_formats][google.cloud.aiplatform.v1beta1.Model.supported_output_storage_formats] for supported output - // formats, and how predictions are expressed via any of them. + // Configuration defining how to transform batch prediction input instances to + // the instances that the Model accepts. + message InstanceConfig { + // The format of the instance that the Model accepts. Vertex AI will + // convert compatible + // [batch prediction input instance + // formats][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig.instances_format] + // to the specified format. + // + // Supported values are: + // + // * `object`: Each input is converted to JSON object format. + // * For `bigquery`, each row is converted to an object. + // * For `jsonl`, each line of the JSONL input must be an object. + // * Does not apply to `csv`, `file-list`, `tf-record`, or + // `tf-record-gzip`. + // + // * `array`: Each input is converted to JSON array format. + // * For `bigquery`, each row is converted to an array. The order + // of columns is determined by the BigQuery column order, unless + // [included_fields][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig.included_fields] + // is populated. + // [included_fields][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig.included_fields] + // must be populated for specifying field orders. + // * For `jsonl`, if each line of the JSONL input is an object, + // [included_fields][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig.included_fields] + // must be populated for specifying field orders. + // * Does not apply to `csv`, `file-list`, `tf-record`, or + // `tf-record-gzip`. + // + // If not specified, Vertex AI converts the batch prediction input as + // follows: + // + // * For `bigquery` and `csv`, the behavior is the same as `array`. The + // order of columns is the same as defined in the file or table, unless + // [included_fields][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig.included_fields] + // is populated. + // * For `jsonl`, the prediction instance format is determined by + // each line of the input. + // * For `tf-record`/`tf-record-gzip`, each record will be converted to + // an object in the format of `{"b64": }`, where `` is + // the Base64-encoded string of the content of the record. + // * For `file-list`, each file in the list will be converted to an + // object in the format of `{"b64": }`, where `` is + // the Base64-encoded string of the content of the file. + string instance_type = 1; + + // The name of the field that is considered as a key. + // + // The values identified by the key field is not included in the transformed + // instances that is sent to the Model. This is similar to + // specifying this name of the field in + // [excluded_fields][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig.excluded_fields]. + // In addition, the batch prediction output will not include the instances. + // Instead the output will only include the value of the key field, in a + // field named `key` in the output: + // + // * For `jsonl` output format, the output will have a `key` field + // instead of the `instance` field. + // * For `csv`/`bigquery` output format, the output will have have a `key` + // column instead of the instance feature columns. + // + // The input must be JSONL with objects at each line, CSV, BigQuery + // or TfRecord. + string key_field = 2; + + // Fields that will be included in the prediction instance that is + // sent to the Model. + // + // If + // [instance_type][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig.instance_type] + // is `array`, the order of field names in included_fields also determines + // the order of the values in the array. + // + // When included_fields is populated, + // [excluded_fields][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig.excluded_fields] + // must be empty. + // + // The input must be JSONL with objects at each line, CSV, BigQuery + // or TfRecord. + repeated string included_fields = 3; + + // Fields that will be excluded in the prediction instance that is + // sent to the Model. + // + // Excluded will be attached to the batch prediction output if + // [key_field][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig.key_field] + // is not specified. + // + // When excluded_fields is populated, + // [included_fields][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig.included_fields] + // must be empty. + // + // The input must be JSONL with objects at each line, CSV, BigQuery + // or TfRecord. + repeated string excluded_fields = 4; + } + + // Configures the output of + // [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob]. + // See + // [Model.supported_output_storage_formats][google.cloud.aiplatform.v1beta1.Model.supported_output_storage_formats] + // for supported output formats, and how predictions are expressed via any of + // them. message OutputConfig { // Required. The destination of the output. oneof destination { @@ -86,11 +192,13 @@ message BatchPredictionJob { // Inside of it files `predictions_0001.`, // `predictions_0002.`, ..., `predictions_N.` // are created where `` depends on chosen - // [predictions_format][google.cloud.aiplatform.v1beta1.BatchPredictionJob.OutputConfig.predictions_format], and N may equal 0001 and depends on the total - // number of successfully predicted instances. - // If the Model has both [instance][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri] - // and [prediction][google.cloud.aiplatform.v1beta1.PredictSchemata.parameters_schema_uri] schemata - // defined then each such file contains predictions as per the + // [predictions_format][google.cloud.aiplatform.v1beta1.BatchPredictionJob.OutputConfig.predictions_format], + // and N may equal 0001 and depends on the total number of successfully + // predicted instances. If the Model has both + // [instance][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri] + // and + // [prediction][google.cloud.aiplatform.v1beta1.PredictSchemata.parameters_schema_uri] + // schemata defined then each such file contains predictions as per the // [predictions_format][google.cloud.aiplatform.v1beta1.BatchPredictionJob.OutputConfig.predictions_format]. // If prediction for any instance failed (partially or completely), then // an additional `errors_0001.`, `errors_0002.`,..., @@ -109,45 +217,52 @@ message BatchPredictionJob { // become underscores), and timestamp is in // YYYY_MM_DDThh_mm_ss_sssZ "based on ISO-8601" format. In the dataset // two tables will be created, `predictions`, and `errors`. - // If the Model has both [instance][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri] - // and [prediction][google.cloud.aiplatform.v1beta1.PredictSchemata.parameters_schema_uri] schemata - // defined then the tables have columns as follows: The `predictions` - // table contains instances for which the prediction succeeded, it - // has columns as per a concatenation of the Model's instance and - // prediction schemata. The `errors` table contains rows for which the - // prediction has failed, it has instance columns, as per the + // If the Model has both + // [instance][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri] + // and + // [prediction][google.cloud.aiplatform.v1beta1.PredictSchemata.parameters_schema_uri] + // schemata defined then the tables have columns as follows: The + // `predictions` table contains instances for which the prediction + // succeeded, it has columns as per a concatenation of the Model's + // instance and prediction schemata. The `errors` table contains rows for + // which the prediction has failed, it has instance columns, as per the // instance schema, followed by a single "errors" column, which as values // has [google.rpc.Status][google.rpc.Status] // represented as a STRUCT, and containing only `code` and `message`. BigQueryDestination bigquery_destination = 3; } - // Required. The format in which Vertex AI gives the predictions, must be one of the + // Required. The format in which Vertex AI gives the predictions, must be + // one of the // [Model's][google.cloud.aiplatform.v1beta1.BatchPredictionJob.model] // [supported_output_storage_formats][google.cloud.aiplatform.v1beta1.Model.supported_output_storage_formats]. string predictions_format = 1 [(google.api.field_behavior) = REQUIRED]; } // Further describes this job's output. - // Supplements [output_config][google.cloud.aiplatform.v1beta1.BatchPredictionJob.output_config]. + // Supplements + // [output_config][google.cloud.aiplatform.v1beta1.BatchPredictionJob.output_config]. message OutputInfo { // The output location into which prediction output is written. oneof output_location { - // Output only. The full path of the Cloud Storage directory created, into which - // the prediction output is written. - string gcs_output_directory = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. The full path of the Cloud Storage directory created, into + // which the prediction output is written. + string gcs_output_directory = 1 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The path of the BigQuery dataset created, in // `bq://projectId.bqDatasetId` // format, into which the prediction output is written. - string bigquery_output_dataset = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + string bigquery_output_dataset = 2 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // Output only. The name of the BigQuery table created, in // `predictions_` // format, into which the prediction output is written. // Can be used by UI to generate the BigQuery output path, for example. - string bigquery_output_table = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + string bigquery_output_table = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // Output only. Resource name of the BatchPredictionJob. @@ -165,10 +280,11 @@ message BatchPredictionJob { // The model resource name may contain version id or version alias to specify // the version, if no version is specified, the default version will be used. string model = 3 [(google.api.resource_reference) = { - type: "aiplatform.googleapis.com/Model" - }]; + type: "aiplatform.googleapis.com/Model" + }]; - // Output only. The version ID of the Model that produces the predictions via this job. + // Output only. The version ID of the Model that produces the predictions via + // this job. string model_version_id = 30 [(google.api.field_behavior) = OUTPUT_ONLY]; // Contains model information necessary to perform batch prediction without @@ -176,15 +292,20 @@ message BatchPredictionJob { // Exactly one of model and unmanaged_container_model must be set. UnmanagedContainerModel unmanaged_container_model = 28; - // Required. Input configuration of the instances on which predictions are performed. - // The schema of any single instance may be specified via - // the [Model's][google.cloud.aiplatform.v1beta1.BatchPredictionJob.model] + // Required. Input configuration of the instances on which predictions are + // performed. The schema of any single instance may be specified via the + // [Model's][google.cloud.aiplatform.v1beta1.BatchPredictionJob.model] // [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata] // [instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri]. InputConfig input_config = 4 [(google.api.field_behavior) = REQUIRED]; + // Configuration for how to convert batch prediction input instances to the + // prediction instances that are sent to the Model. + InstanceConfig instance_config = 27; + // The parameters that govern the predictions. The schema of the parameters - // may be specified via the [Model's][google.cloud.aiplatform.v1beta1.BatchPredictionJob.model] + // may be specified via the + // [Model's][google.cloud.aiplatform.v1beta1.BatchPredictionJob.model] // [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata] // [parameters_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.parameters_schema_uri]. google.protobuf.Value model_parameters = 5; @@ -200,7 +321,8 @@ message BatchPredictionJob { OutputConfig output_config = 6 [(google.api.field_behavior) = REQUIRED]; // The config of resources used by the Model during the batch prediction. If - // the Model [supports][google.cloud.aiplatform.v1beta1.Model.supported_deployment_resources_types] + // the Model + // [supports][google.cloud.aiplatform.v1beta1.Model.supported_deployment_resources_types] // DEDICATED_RESOURCES this config may be provided (and the job will use these // resources), if the Model doesn't support AUTOMATIC_RESOURCES, this config // must be provided. @@ -209,41 +331,56 @@ message BatchPredictionJob { // The service account that the DeployedModel's container runs as. If not // specified, a system generated one will be used, which // has minimal permissions and the custom container, if used, may not have - // enough permission to access other GCP resources. + // enough permission to access other Google Cloud resources. // // Users deploying the Model must have the `iam.serviceAccounts.actAs` // permission on this service account. string service_account = 29; - // Immutable. Parameters configuring the batch behavior. Currently only applicable when - // [dedicated_resources][google.cloud.aiplatform.v1beta1.BatchPredictionJob.dedicated_resources] are used (in other cases Vertex AI does - // the tuning itself). - ManualBatchTuningParameters manual_batch_tuning_parameters = 8 [(google.api.field_behavior) = IMMUTABLE]; + // Immutable. Parameters configuring the batch behavior. Currently only + // applicable when + // [dedicated_resources][google.cloud.aiplatform.v1beta1.BatchPredictionJob.dedicated_resources] + // are used (in other cases Vertex AI does the tuning itself). + ManualBatchTuningParameters manual_batch_tuning_parameters = 8 + [(google.api.field_behavior) = IMMUTABLE]; // Generate explanation with the batch prediction results. // // When set to `true`, the batch prediction output changes based on the // `predictions_format` field of the - // [BatchPredictionJob.output_config][google.cloud.aiplatform.v1beta1.BatchPredictionJob.output_config] object: + // [BatchPredictionJob.output_config][google.cloud.aiplatform.v1beta1.BatchPredictionJob.output_config] + // object: // // * `bigquery`: output includes a column named `explanation`. The value - // is a struct that conforms to the [Explanation][google.cloud.aiplatform.v1beta1.Explanation] object. + // is a struct that conforms to the + // [Explanation][google.cloud.aiplatform.v1beta1.Explanation] object. // * `jsonl`: The JSON objects on each line include an additional entry // keyed `explanation`. The value of the entry is a JSON object that - // conforms to the [Explanation][google.cloud.aiplatform.v1beta1.Explanation] object. + // conforms to the + // [Explanation][google.cloud.aiplatform.v1beta1.Explanation] object. // * `csv`: Generating explanations for CSV format is not supported. // - // If this field is set to true, either the [Model.explanation_spec][google.cloud.aiplatform.v1beta1.Model.explanation_spec] or - // [explanation_spec][google.cloud.aiplatform.v1beta1.BatchPredictionJob.explanation_spec] must be populated. + // If this field is set to true, either the + // [Model.explanation_spec][google.cloud.aiplatform.v1beta1.Model.explanation_spec] + // or + // [explanation_spec][google.cloud.aiplatform.v1beta1.BatchPredictionJob.explanation_spec] + // must be populated. bool generate_explanation = 23; // Explanation configuration for this BatchPredictionJob. Can be - // specified only if [generate_explanation][google.cloud.aiplatform.v1beta1.BatchPredictionJob.generate_explanation] is set to `true`. + // specified only if + // [generate_explanation][google.cloud.aiplatform.v1beta1.BatchPredictionJob.generate_explanation] + // is set to `true`. // - // This value overrides the value of [Model.explanation_spec][google.cloud.aiplatform.v1beta1.Model.explanation_spec]. All fields of - // [explanation_spec][google.cloud.aiplatform.v1beta1.BatchPredictionJob.explanation_spec] are optional in the request. If a field of the - // [explanation_spec][google.cloud.aiplatform.v1beta1.BatchPredictionJob.explanation_spec] object is not populated, the corresponding field of - // the [Model.explanation_spec][google.cloud.aiplatform.v1beta1.Model.explanation_spec] object is inherited. + // This value overrides the value of + // [Model.explanation_spec][google.cloud.aiplatform.v1beta1.Model.explanation_spec]. + // All fields of + // [explanation_spec][google.cloud.aiplatform.v1beta1.BatchPredictionJob.explanation_spec] + // are optional in the request. If a field of the + // [explanation_spec][google.cloud.aiplatform.v1beta1.BatchPredictionJob.explanation_spec] + // object is not populated, the corresponding field of the + // [Model.explanation_spec][google.cloud.aiplatform.v1beta1.Model.explanation_spec] + // object is inherited. ExplanationSpec explanation_spec = 25; // Output only. Information further describing the output of this job. @@ -259,33 +396,40 @@ message BatchPredictionJob { // Output only. Partial failures encountered. // For example, single files that can't be read. // This field never exceeds 20 entries. - // Status details fields contain standard GCP error details. - repeated google.rpc.Status partial_failures = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Status details fields contain standard Google Cloud error details. + repeated google.rpc.Status partial_failures = 12 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. Information about resources that had been consumed by this job. - // Provided in real time at best effort basis, as well as a final value + // Output only. Information about resources that had been consumed by this + // job. Provided in real time at best effort basis, as well as a final value // once the job completes. // // Note: This field currently may be not populated for batch predictions that // use AutoML Models. - ResourcesConsumed resources_consumed = 13 [(google.api.field_behavior) = OUTPUT_ONLY]; + ResourcesConsumed resources_consumed = 13 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Statistics on completed and failed prediction instances. - CompletionStats completion_stats = 14 [(google.api.field_behavior) = OUTPUT_ONLY]; + CompletionStats completion_stats = 14 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Time when the BatchPredictionJob was created. - google.protobuf.Timestamp create_time = 15 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 15 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. Time when the BatchPredictionJob for the first time entered the - // `JOB_STATE_RUNNING` state. - google.protobuf.Timestamp start_time = 16 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. Time when the BatchPredictionJob for the first time entered + // the `JOB_STATE_RUNNING` state. + google.protobuf.Timestamp start_time = 16 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. Time when the BatchPredictionJob entered any of the following states: - // `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`. - google.protobuf.Timestamp end_time = 17 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. Time when the BatchPredictionJob entered any of the following + // states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`. + google.protobuf.Timestamp end_time = 17 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Time when the BatchPredictionJob was most recently updated. - google.protobuf.Timestamp update_time = 18 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 18 + [(google.api.field_behavior) = OUTPUT_ONLY]; // The labels with user-defined metadata to organize BatchPredictionJobs. // @@ -310,5 +454,6 @@ message BatchPredictionJob { repeated ModelMonitoringStatsAnomalies model_monitoring_stats_anomalies = 31; // Output only. The running status of the model monitoring pipeline. - google.rpc.Status model_monitoring_status = 32 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.rpc.Status model_monitoring_status = 32 + [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/completion_stats.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/completion_stats.proto index f784eda4eb2..ee99522663f 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/completion_stats.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/completion_stats.proto @@ -35,14 +35,16 @@ message CompletionStats { // Output only. The number of entities for which any error was encountered. int64 failed_count = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. In cases when enough errors are encountered a job, pipeline, or operation - // may be failed as a whole. Below is the number of entities for which the - // processing had not been finished (either in successful or failed state). - // Set to -1 if the number is unknown (for example, the operation failed - // before the total entity number could be collected). + // Output only. In cases when enough errors are encountered a job, pipeline, + // or operation may be failed as a whole. Below is the number of entities for + // which the processing had not been finished (either in successful or failed + // state). Set to -1 if the number is unknown (for example, the operation + // failed before the total entity number could be collected). int64 incomplete_count = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. The number of the successful forecast points that are generated by the - // forecasting model. This is ONLY used by the forecasting batch prediction. - int64 successful_forecast_point_count = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. The number of the successful forecast points that are + // generated by the forecasting model. This is ONLY used by the forecasting + // batch prediction. + int64 successful_forecast_point_count = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/context.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/context.proto index 7f81ce4c0e8..3c6ae7750b6 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/context.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/context.proto @@ -57,13 +57,15 @@ message Context { map labels = 9; // Output only. Timestamp when this Context was created. - google.protobuf.Timestamp create_time = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 10 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this Context was last updated. - google.protobuf.Timestamp update_time = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 11 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. A list of resource names of Contexts that are parents of this Context. - // A Context may have at most 10 parent_contexts. + // Output only. A list of resource names of Contexts that are parents of this + // Context. A Context may have at most 10 parent_contexts. repeated string parent_contexts = 12 [ (google.api.field_behavior) = OUTPUT_ONLY, (google.api.resource_reference) = { @@ -86,6 +88,7 @@ message Context { string schema_version = 14; // Properties of the Context. + // Top level metadata keys' heading and trailing spaces will be trimmed. // The size of this field should not exceed 200KB. google.protobuf.Struct metadata = 15; diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/custom_job.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/custom_job.proto index 24d384ff603..917616422ad 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/custom_job.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/custom_job.proto @@ -49,7 +49,7 @@ message CustomJob { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. The display name of the CustomJob. - // The name can be up to 128 characters long and can be consist of any UTF-8 + // The name can be up to 128 characters long and can consist of any UTF-8 // characters. string display_name = 2 [(google.api.field_behavior) = REQUIRED]; @@ -60,18 +60,22 @@ message CustomJob { JobState state = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Time when the CustomJob was created. - google.protobuf.Timestamp create_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 6 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Time when the CustomJob for the first time entered the // `JOB_STATE_RUNNING` state. - google.protobuf.Timestamp start_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp start_time = 7 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Time when the CustomJob entered any of the following states: // `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`. - google.protobuf.Timestamp end_time = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp end_time = 8 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Time when the CustomJob was most recently updated. - google.protobuf.Timestamp update_time = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 9 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Only populated when job's state is `JOB_STATE_FAILED` or // `JOB_STATE_CANCELLED`. @@ -94,7 +98,8 @@ message CustomJob { // Output only. URIs for accessing [interactive // shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) // (one URI for each training node). Only available if - // [job_spec.enable_web_access][google.cloud.aiplatform.v1beta1.CustomJobSpec.enable_web_access] is `true`. + // [job_spec.enable_web_access][google.cloud.aiplatform.v1beta1.CustomJobSpec.enable_web_access] + // is `true`. // // The keys are names of each node in the training job; for example, // `workerpool0-0` for the primary node, `workerpool1-0` for the first node in @@ -102,15 +107,17 @@ message CustomJob { // second worker pool. // // The values are the URIs for each node's interactive shell. - map web_access_uris = 16 [(google.api.field_behavior) = OUTPUT_ONLY]; + map web_access_uris = 16 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // Represents the spec of a CustomJob. message CustomJobSpec { - // Required. The spec of the worker pools including machine type and Docker image. - // All worker pools except the first one are optional and can be skipped by - // providing an empty value. - repeated WorkerPoolSpec worker_pool_specs = 1 [(google.api.field_behavior) = REQUIRED]; + // Required. The spec of the worker pools including machine type and Docker + // image. All worker pools except the first one are optional and can be + // skipped by providing an empty value. + repeated WorkerPoolSpec worker_pool_specs = 1 + [(google.api.field_behavior) = REQUIRED]; // Scheduling options for a CustomJob. Scheduling scheduling = 3; @@ -137,9 +144,7 @@ message CustomJobSpec { // If this field is left unspecified, the job is not peered with any network. string network = 5 [ (google.api.field_behavior) = OPTIONAL, - (google.api.resource_reference) = { - type: "compute.googleapis.com/Network" - } + (google.api.resource_reference) = { type: "compute.googleapis.com/Network" } ]; // Optional. A list of names for the reserved ip ranges under the VPC network @@ -150,14 +155,15 @@ message CustomJobSpec { // network. // // Example: ['vertex-ai-ip-range']. - repeated string reserved_ip_ranges = 13 [(google.api.field_behavior) = OPTIONAL]; + repeated string reserved_ip_ranges = 13 + [(google.api.field_behavior) = OPTIONAL]; // The Cloud Storage location to store the output of this CustomJob or // HyperparameterTuningJob. For HyperparameterTuningJob, // the baseOutputDirectory of // each child CustomJob backing a Trial is set to a subdirectory of name - // [id][google.cloud.aiplatform.v1beta1.Trial.id] under its parent HyperparameterTuningJob's - // baseOutputDirectory. + // [id][google.cloud.aiplatform.v1beta1.Trial.id] under its parent + // HyperparameterTuningJob's baseOutputDirectory. // // The following Vertex AI environment variables will be passed to // containers or python modules when this field is set: @@ -175,9 +181,9 @@ message CustomJobSpec { // * AIP_TENSORBOARD_LOG_DIR = `//logs/` GcsDestination base_output_directory = 6; - // Optional. The name of a Vertex AI [Tensorboard][google.cloud.aiplatform.v1beta1.Tensorboard] resource to which this CustomJob - // will upload Tensorboard logs. - // Format: + // Optional. The name of a Vertex AI + // [Tensorboard][google.cloud.aiplatform.v1beta1.Tensorboard] resource to + // which this CustomJob will upload Tensorboard logs. Format: // `projects/{project}/locations/{location}/tensorboards/{tensorboard}` string tensorboard = 7 [ (google.api.field_behavior) = OPTIONAL, @@ -191,9 +197,25 @@ message CustomJobSpec { // to training containers. // // If set to `true`, you can access interactive shells at the URIs given - // by [CustomJob.web_access_uris][google.cloud.aiplatform.v1beta1.CustomJob.web_access_uris] or [Trial.web_access_uris][google.cloud.aiplatform.v1beta1.Trial.web_access_uris] (within + // by + // [CustomJob.web_access_uris][google.cloud.aiplatform.v1beta1.CustomJob.web_access_uris] + // or + // [Trial.web_access_uris][google.cloud.aiplatform.v1beta1.Trial.web_access_uris] + // (within // [HyperparameterTuningJob.trials][google.cloud.aiplatform.v1beta1.HyperparameterTuningJob.trials]). bool enable_web_access = 10 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Whether you want Vertex AI to enable access to the customized + // dashboard in training chief container. + // + // If set to `true`, you can access the dashboard at the URIs given + // by + // [CustomJob.web_access_uris][google.cloud.aiplatform.v1beta1.CustomJob.web_access_uris] + // or + // [Trial.web_access_uris][google.cloud.aiplatform.v1beta1.Trial.web_access_uris] + // (within + // [HyperparameterTuningJob.trials][google.cloud.aiplatform.v1beta1.HyperparameterTuningJob.trials]). + bool enable_dashboard_access = 16 [(google.api.field_behavior) = OPTIONAL]; } // Represents the spec of a worker pool in a job. @@ -225,8 +247,8 @@ message WorkerPoolSpec { // The spec of a Container. message ContainerSpec { - // Required. The URI of a container image in the Container Registry that is to be run on - // each worker replica. + // Required. The URI of a container image in the Container Registry that is to + // be run on each worker replica. string image_uri = 1 [(google.api.field_behavior) = REQUIRED]; // The command to be invoked when the container is started. @@ -243,17 +265,17 @@ message ContainerSpec { // The spec of a Python packaged code. message PythonPackageSpec { - // Required. The URI of a container image in Artifact Registry that will run the - // provided Python package. Vertex AI provides a wide range of executor + // Required. The URI of a container image in Artifact Registry that will run + // the provided Python package. Vertex AI provides a wide range of executor // images with pre-installed packages to meet users' various use cases. See // the list of [pre-built containers for // training](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). // You must use an image from this list. string executor_image_uri = 1 [(google.api.field_behavior) = REQUIRED]; - // Required. The Google Cloud Storage location of the Python package files which are - // the training program and its dependent packages. - // The maximum number of package URIs is 100. + // Required. The Google Cloud Storage location of the Python package files + // which are the training program and its dependent packages. The maximum + // number of package URIs is 100. repeated string package_uris = 2 [(google.api.field_behavior) = REQUIRED]; // Required. The Python module name to run after installing the packages. diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/data_item.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/data_item.proto index 5c3e443bfdb..b65ebdaf5c7 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/data_item.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/data_item.proto @@ -41,10 +41,12 @@ message DataItem { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this DataItem was created. - google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 2 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this DataItem was last updated. - google.protobuf.Timestamp update_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 6 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Optional. The labels with user-defined metadata to organize your DataItems. // @@ -59,12 +61,14 @@ message DataItem { // and are immutable. map labels = 3 [(google.api.field_behavior) = OPTIONAL]; - // Required. The data that the DataItem represents (for example, an image or a text - // snippet). The schema of the payload is stored in the parent Dataset's - // [metadata schema's][google.cloud.aiplatform.v1beta1.Dataset.metadata_schema_uri] dataItemSchemaUri field. + // Required. The data that the DataItem represents (for example, an image or a + // text snippet). The schema of the payload is stored in the parent Dataset's + // [metadata + // schema's][google.cloud.aiplatform.v1beta1.Dataset.metadata_schema_uri] + // dataItemSchemaUri field. google.protobuf.Value payload = 4 [(google.api.field_behavior) = REQUIRED]; - // Optional. Used to perform consistent read-modify-write updates. If not set, a blind - // "overwrite" update happens. + // Optional. Used to perform consistent read-modify-write updates. If not set, + // a blind "overwrite" update happens. string etag = 7 [(google.api.field_behavior) = OPTIONAL]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/data_labeling_job.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/data_labeling_job.proto index 3a7160a5644..38cf99ffee1 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/data_labeling_job.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/data_labeling_job.proto @@ -45,14 +45,13 @@ message DataLabelingJob { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. The user-defined name of the DataLabelingJob. - // The name can be up to 128 characters long and can be consist of any UTF-8 + // The name can be up to 128 characters long and can consist of any UTF-8 // characters. // Display name of a DataLabelingJob. string display_name = 2 [(google.api.field_behavior) = REQUIRED]; - // Required. Dataset resource names. Right now we only support labeling from a single - // Dataset. - // Format: + // Required. Dataset resource names. Right now we only support labeling from a + // single Dataset. Format: // `projects/{project}/locations/{location}/datasets/{dataset}` repeated string datasets = 3 [ (google.api.field_behavior) = REQUIRED, @@ -74,14 +73,14 @@ message DataLabelingJob { // Required. Number of labelers to work on each DataItem. int32 labeler_count = 4 [(google.api.field_behavior) = REQUIRED]; - // Required. The Google Cloud Storage location of the instruction pdf. This pdf is - // shared with labelers, and provides detailed description on how to label - // DataItems in Datasets. + // Required. The Google Cloud Storage location of the instruction pdf. This + // pdf is shared with labelers, and provides detailed description on how to + // label DataItems in Datasets. string instruction_uri = 5 [(google.api.field_behavior) = REQUIRED]; - // Required. Points to a YAML file stored on Google Cloud Storage describing the - // config for a specific type of DataLabelingJob. - // The schema files that can be used here are found in the + // Required. Points to a YAML file stored on Google Cloud Storage describing + // the config for a specific type of DataLabelingJob. The schema files that + // can be used here are found in the // https://storage.googleapis.com/google-cloud-aiplatform bucket in the // /schema/datalabelingjob/inputs/ folder. string inputs_schema_uri = 6 [(google.api.field_behavior) = REQUIRED]; @@ -92,22 +91,25 @@ message DataLabelingJob { // Output only. The detailed state of the job. JobState state = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. Current labeling job progress percentage scaled in interval [0, 100], - // indicating the percentage of DataItems that has been finished. + // Output only. Current labeling job progress percentage scaled in interval + // [0, 100], indicating the percentage of DataItems that has been finished. int32 labeling_progress = 13 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. Estimated cost(in US dollars) that the DataLabelingJob has incurred to - // date. - google.type.Money current_spend = 14 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. Estimated cost(in US dollars) that the DataLabelingJob has + // incurred to date. + google.type.Money current_spend = 14 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this DataLabelingJob was created. - google.protobuf.Timestamp create_time = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 9 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this DataLabelingJob was updated most recently. - google.protobuf.Timestamp update_time = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 10 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. DataLabelingJob errors. It is only populated when job's state is - // `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`. + // Output only. DataLabelingJob errors. It is only populated when job's state + // is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`. google.rpc.Status error = 22 [(google.api.field_behavior) = OUTPUT_ONLY]; // The labels with user-defined metadata to organize your DataLabelingJobs. @@ -121,7 +123,8 @@ message DataLabelingJob { // and are immutable. Following system labels exist for each DataLabelingJob: // // * "aiplatform.googleapis.com/schema": output only, its value is the - // [inputs_schema][google.cloud.aiplatform.v1beta1.DataLabelingJob.inputs_schema_uri]'s title. + // [inputs_schema][google.cloud.aiplatform.v1beta1.DataLabelingJob.inputs_schema_uri]'s + // title. map labels = 11; // The SpecialistPools' resource names associated with this job. diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/dataset.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/dataset.proto index 5d1f197f451..51ef2928a1b 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/dataset.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/dataset.proto @@ -20,6 +20,7 @@ import "google/api/field_behavior.proto"; import "google/api/resource.proto"; import "google/cloud/aiplatform/v1beta1/encryption_spec.proto"; import "google/cloud/aiplatform/v1beta1/io.proto"; +import "google/cloud/aiplatform/v1beta1/saved_query.proto"; import "google/protobuf/struct.proto"; import "google/protobuf/timestamp.proto"; @@ -42,28 +43,29 @@ message Dataset { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. The user-defined name of the Dataset. - // The name can be up to 128 characters long and can be consist of any UTF-8 + // The name can be up to 128 characters long and can consist of any UTF-8 // characters. string display_name = 2 [(google.api.field_behavior) = REQUIRED]; - // Optional. The description of the Dataset. - string description = 16 [(google.api.field_behavior) = OPTIONAL]; + // The description of the Dataset. + string description = 16; - // Required. Points to a YAML file stored on Google Cloud Storage describing additional - // information about the Dataset. - // The schema is defined as an OpenAPI 3.0.2 Schema Object. - // The schema files that can be used here are found in - // gs://google-cloud-aiplatform/schema/dataset/metadata/. + // Required. Points to a YAML file stored on Google Cloud Storage describing + // additional information about the Dataset. The schema is defined as an + // OpenAPI 3.0.2 Schema Object. The schema files that can be used here are + // found in gs://google-cloud-aiplatform/schema/dataset/metadata/. string metadata_schema_uri = 3 [(google.api.field_behavior) = REQUIRED]; // Required. Additional information about the Dataset. google.protobuf.Value metadata = 8 [(google.api.field_behavior) = REQUIRED]; // Output only. Timestamp when this Dataset was created. - google.protobuf.Timestamp create_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this Dataset was last updated. - google.protobuf.Timestamp update_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Used to perform consistent read-modify-write updates. If not set, a blind // "overwrite" update happens. @@ -82,12 +84,29 @@ message Dataset { // and are immutable. Following system labels exist for each Dataset: // // * "aiplatform.googleapis.com/dataset_metadata_schema": output only, its - // value is the [metadata_schema's][google.cloud.aiplatform.v1beta1.Dataset.metadata_schema_uri] title. + // value is the + // [metadata_schema's][google.cloud.aiplatform.v1beta1.Dataset.metadata_schema_uri] + // title. map labels = 7; + // All SavedQueries belong to the Dataset will be returned in List/Get + // Dataset response. The [annotation_specs][SavedQuery.annotation_specs] field + // will not be populated except for UI cases which will only use + // [annotation_spec_count][google.cloud.aiplatform.v1beta1.SavedQuery.annotation_spec_count]. + // In CreateDataset request, a SavedQuery is created together if + // this field is set, up to one SavedQuery can be set in CreateDatasetRequest. + // The SavedQuery should not contain any AnnotationSpec. + repeated SavedQuery saved_queries = 9; + // Customer-managed encryption key spec for a Dataset. If set, this Dataset // and all sub-resources of this Dataset will be secured by this key. EncryptionSpec encryption_spec = 11; + + // Output only. The resource name of the Artifact that was created in + // MetadataStore when creating the Dataset. The Artifact resource name pattern + // is + // `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. + string metadata_artifact = 17 [(google.api.field_behavior) = OUTPUT_ONLY]; } // Describes the location from where we import data into a Dataset, together @@ -109,12 +128,27 @@ message ImportDataConfig { // considered identical if their content bytes are identical (e.g. image bytes // or pdf bytes). // These labels will be overridden by Annotation labels specified inside index - // file referenced by [import_schema_uri][google.cloud.aiplatform.v1beta1.ImportDataConfig.import_schema_uri], e.g. jsonl file. + // file referenced by + // [import_schema_uri][google.cloud.aiplatform.v1beta1.ImportDataConfig.import_schema_uri], + // e.g. jsonl file. map data_item_labels = 2; - // Required. Points to a YAML file stored on Google Cloud Storage describing the import - // format. Validation will be done against the schema. The schema is defined - // as an [OpenAPI 3.0.2 Schema + // Labels that will be applied to newly imported Annotations. If two + // Annotations are identical, one of them will be deduped. Two Annotations are + // considered identical if their + // [payload][google.cloud.aiplatform.v1beta1.Annotation.payload], + // [payload_schema_uri][google.cloud.aiplatform.v1beta1.Annotation.payload_schema_uri] + // and all of their + // [labels][google.cloud.aiplatform.v1beta1.Annotation.labels] are the same. + // These labels will be overridden by Annotation labels specified inside index + // file referenced by + // [import_schema_uri][google.cloud.aiplatform.v1beta1.ImportDataConfig.import_schema_uri], + // e.g. jsonl file. + map annotation_labels = 3; + + // Required. Points to a YAML file stored on Google Cloud Storage describing + // the import format. Validation will be done against the schema. The schema + // is defined as an [OpenAPI 3.0.2 Schema // Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). string import_schema_uri = 4 [(google.api.field_behavior) = REQUIRED]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/dataset_service.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/dataset_service.proto index 3be59c059d8..30097e817d9 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/dataset_service.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/dataset_service.proto @@ -41,10 +41,12 @@ option ruby_package = "Google::Cloud::AIPlatform::V1beta1"; // resources. service DatasetService { option (google.api.default_host) = "aiplatform.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/cloud-platform"; // Creates a Dataset. - rpc CreateDataset(CreateDatasetRequest) returns (google.longrunning.Operation) { + rpc CreateDataset(CreateDatasetRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta1/{parent=projects/*/locations/*}/datasets" body: "dataset" @@ -82,7 +84,8 @@ service DatasetService { } // Deletes a Dataset. - rpc DeleteDataset(DeleteDatasetRequest) returns (google.longrunning.Operation) { + rpc DeleteDataset(DeleteDatasetRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1beta1/{name=projects/*/locations/*/datasets/*}" }; @@ -127,8 +130,17 @@ service DatasetService { option (google.api.method_signature) = "parent"; } + // Searches DataItems in a Dataset. + rpc SearchDataItems(SearchDataItemsRequest) + returns (SearchDataItemsResponse) { + option (google.api.http) = { + get: "/v1beta1/{dataset=projects/*/locations/*/datasets/*}:searchDataItems" + }; + } + // Lists SavedQueries in a Dataset. - rpc ListSavedQueries(ListSavedQueriesRequest) returns (ListSavedQueriesResponse) { + rpc ListSavedQueries(ListSavedQueriesRequest) + returns (ListSavedQueriesResponse) { option (google.api.http) = { get: "/v1beta1/{parent=projects/*/locations/*/datasets/*}/savedQueries" }; @@ -144,7 +156,8 @@ service DatasetService { } // Lists Annotations belongs to a dataitem - rpc ListAnnotations(ListAnnotationsRequest) returns (ListAnnotationsResponse) { + rpc ListAnnotations(ListAnnotationsRequest) + returns (ListAnnotationsResponse) { option (google.api.http) = { get: "/v1beta1/{parent=projects/*/locations/*/datasets/*/dataItems/*}/annotations" }; @@ -152,7 +165,8 @@ service DatasetService { } } -// Request message for [DatasetService.CreateDataset][google.cloud.aiplatform.v1beta1.DatasetService.CreateDataset]. +// Request message for +// [DatasetService.CreateDataset][google.cloud.aiplatform.v1beta1.DatasetService.CreateDataset]. message CreateDatasetRequest { // Required. The resource name of the Location to create the Dataset in. // Format: `projects/{project}/locations/{location}` @@ -167,13 +181,15 @@ message CreateDatasetRequest { Dataset dataset = 2 [(google.api.field_behavior) = REQUIRED]; } -// Runtime operation information for [DatasetService.CreateDataset][google.cloud.aiplatform.v1beta1.DatasetService.CreateDataset]. +// Runtime operation information for +// [DatasetService.CreateDataset][google.cloud.aiplatform.v1beta1.DatasetService.CreateDataset]. message CreateDatasetOperationMetadata { // The operation generic information. GenericOperationMetadata generic_metadata = 1; } -// Request message for [DatasetService.GetDataset][google.cloud.aiplatform.v1beta1.DatasetService.GetDataset]. +// Request message for +// [DatasetService.GetDataset][google.cloud.aiplatform.v1beta1.DatasetService.GetDataset]. message GetDatasetRequest { // Required. The name of the Dataset resource. string name = 1 [ @@ -187,22 +203,25 @@ message GetDatasetRequest { google.protobuf.FieldMask read_mask = 2; } -// Request message for [DatasetService.UpdateDataset][google.cloud.aiplatform.v1beta1.DatasetService.UpdateDataset]. +// Request message for +// [DatasetService.UpdateDataset][google.cloud.aiplatform.v1beta1.DatasetService.UpdateDataset]. message UpdateDatasetRequest { // Required. The Dataset which replaces the resource on the server. Dataset dataset = 1 [(google.api.field_behavior) = REQUIRED]; // Required. The update mask applies to the resource. - // For the `FieldMask` definition, see [google.protobuf.FieldMask][google.protobuf.FieldMask]. - // Updatable fields: + // For the `FieldMask` definition, see + // [google.protobuf.FieldMask][google.protobuf.FieldMask]. Updatable fields: // // * `display_name` // * `description` // * `labels` - google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.FieldMask update_mask = 2 + [(google.api.field_behavior) = REQUIRED]; } -// Request message for [DatasetService.ListDatasets][google.cloud.aiplatform.v1beta1.DatasetService.ListDatasets]. +// Request message for +// [DatasetService.ListDatasets][google.cloud.aiplatform.v1beta1.DatasetService.ListDatasets]. message ListDatasetsRequest { // Required. The name of the Dataset's parent resource. // Format: `projects/{project}/locations/{location}` @@ -248,7 +267,8 @@ message ListDatasetsRequest { string order_by = 6; } -// Response message for [DatasetService.ListDatasets][google.cloud.aiplatform.v1beta1.DatasetService.ListDatasets]. +// Response message for +// [DatasetService.ListDatasets][google.cloud.aiplatform.v1beta1.DatasetService.ListDatasets]. message ListDatasetsResponse { // A list of Datasets that matches the specified filter in the request. repeated Dataset datasets = 1; @@ -257,7 +277,8 @@ message ListDatasetsResponse { string next_page_token = 2; } -// Request message for [DatasetService.DeleteDataset][google.cloud.aiplatform.v1beta1.DatasetService.DeleteDataset]. +// Request message for +// [DatasetService.DeleteDataset][google.cloud.aiplatform.v1beta1.DatasetService.DeleteDataset]. message DeleteDatasetRequest { // Required. The resource name of the Dataset to delete. // Format: @@ -270,7 +291,8 @@ message DeleteDatasetRequest { ]; } -// Request message for [DatasetService.ImportData][google.cloud.aiplatform.v1beta1.DatasetService.ImportData]. +// Request message for +// [DatasetService.ImportData][google.cloud.aiplatform.v1beta1.DatasetService.ImportData]. message ImportDataRequest { // Required. The name of the Dataset resource. // Format: @@ -282,23 +304,25 @@ message ImportDataRequest { } ]; - // Required. The desired input locations. The contents of all input locations will be - // imported in one batch. - repeated ImportDataConfig import_configs = 2 [(google.api.field_behavior) = REQUIRED]; + // Required. The desired input locations. The contents of all input locations + // will be imported in one batch. + repeated ImportDataConfig import_configs = 2 + [(google.api.field_behavior) = REQUIRED]; } -// Response message for [DatasetService.ImportData][google.cloud.aiplatform.v1beta1.DatasetService.ImportData]. -message ImportDataResponse { - -} +// Response message for +// [DatasetService.ImportData][google.cloud.aiplatform.v1beta1.DatasetService.ImportData]. +message ImportDataResponse {} -// Runtime operation information for [DatasetService.ImportData][google.cloud.aiplatform.v1beta1.DatasetService.ImportData]. +// Runtime operation information for +// [DatasetService.ImportData][google.cloud.aiplatform.v1beta1.DatasetService.ImportData]. message ImportDataOperationMetadata { // The common part of the operation metadata. GenericOperationMetadata generic_metadata = 1; } -// Request message for [DatasetService.ExportData][google.cloud.aiplatform.v1beta1.DatasetService.ExportData]. +// Request message for +// [DatasetService.ExportData][google.cloud.aiplatform.v1beta1.DatasetService.ExportData]. message ExportDataRequest { // Required. The name of the Dataset resource. // Format: @@ -314,13 +338,15 @@ message ExportDataRequest { ExportDataConfig export_config = 2 [(google.api.field_behavior) = REQUIRED]; } -// Response message for [DatasetService.ExportData][google.cloud.aiplatform.v1beta1.DatasetService.ExportData]. +// Response message for +// [DatasetService.ExportData][google.cloud.aiplatform.v1beta1.DatasetService.ExportData]. message ExportDataResponse { // All of the files that are exported in this export operation. repeated string exported_files = 1; } -// Runtime operation information for [DatasetService.ExportData][google.cloud.aiplatform.v1beta1.DatasetService.ExportData]. +// Runtime operation information for +// [DatasetService.ExportData][google.cloud.aiplatform.v1beta1.DatasetService.ExportData]. message ExportDataOperationMetadata { // The common part of the operation metadata. GenericOperationMetadata generic_metadata = 1; @@ -330,7 +356,8 @@ message ExportDataOperationMetadata { string gcs_output_directory = 2; } -// Request message for [DatasetService.ListDataItems][google.cloud.aiplatform.v1beta1.DatasetService.ListDataItems]. +// Request message for +// [DatasetService.ListDataItems][google.cloud.aiplatform.v1beta1.DatasetService.ListDataItems]. message ListDataItemsRequest { // Required. The resource name of the Dataset to list DataItems from. // Format: @@ -359,7 +386,8 @@ message ListDataItemsRequest { string order_by = 6; } -// Response message for [DatasetService.ListDataItems][google.cloud.aiplatform.v1beta1.DatasetService.ListDataItems]. +// Response message for +// [DatasetService.ListDataItems][google.cloud.aiplatform.v1beta1.DatasetService.ListDataItems]. message ListDataItemsResponse { // A list of DataItems that matches the specified filter in the request. repeated DataItem data_items = 1; @@ -368,7 +396,144 @@ message ListDataItemsResponse { string next_page_token = 2; } -// Request message for [DatasetService.ListSavedQueries][google.cloud.aiplatform.v1beta1.DatasetService.ListSavedQueries]. +// Request message for +// [DatasetService.SearchDataItems][google.cloud.aiplatform.v1beta1.DatasetService.SearchDataItems]. +message SearchDataItemsRequest { + // Expression that allows ranking results based on annotation's property. + message OrderByAnnotation { + // Required. Saved query of the Annotation. Only Annotations belong to this + // saved query will be considered for ordering. + string saved_query = 1 [(google.api.field_behavior) = REQUIRED]; + + // A comma-separated list of annotation fields to order by, sorted in + // ascending order. Use "desc" after a field name for descending. Must also + // specify saved_query. + string order_by = 2; + } + + oneof order { + // A comma-separated list of data item fields to order by, sorted in + // ascending order. Use "desc" after a field name for descending. + string order_by_data_item = 12; + + // Expression that allows ranking results based on annotation's property. + OrderByAnnotation order_by_annotation = 13; + } + + // Required. The resource name of the Dataset from which to search DataItems. + // Format: + // `projects/{project}/locations/{location}/datasets/{dataset}` + string dataset = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "aiplatform.googleapis.com/Dataset" + } + ]; + + // The resource name of a SavedQuery(annotation set in UI). + // Format: + // `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}` + // All of the search will be done in the context of this SavedQuery. + string saved_query = 2 [ + deprecated = true, + (google.api.resource_reference) = { + type: "aiplatform.googleapis.com/SavedQuery" + } + ]; + + // The resource name of a DataLabelingJob. + // Format: + // `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` + // If this field is set, all of the search will be done in the context of + // this DataLabelingJob. + string data_labeling_job = 3; + + // An expression for filtering the DataItem that will be returned. + // + // * `data_item_id` - for = or !=. + // * `labeled` - for = or !=. + // * `has_annotation(ANNOTATION_SPEC_ID)` - true only for DataItem that + // have at least one annotation with annotation_spec_id = + // `ANNOTATION_SPEC_ID` in the context of SavedQuery or DataLabelingJob. + // + // For example: + // + // * `data_item=1` + // * `has_annotation(5)` + string data_item_filter = 4; + + // An expression for filtering the Annotations that will be returned per + // DataItem. + // * `annotation_spec_id` - for = or !=. + string annotations_filter = 5 [deprecated = true]; + + // An expression that specifies what Annotations will be returned per + // DataItem. Annotations satisfied either of the conditions will be returned. + // * `annotation_spec_id` - for = or !=. + // Must specify `saved_query_id=` - saved query id that annotations should + // belong to. + repeated string annotation_filters = 11; + + // Mask specifying which fields of + // [DataItemView][google.cloud.aiplatform.v1beta1.DataItemView] to read. + google.protobuf.FieldMask field_mask = 6; + + // If set, only up to this many of Annotations will be returned per + // DataItemView. The maximum value is 1000. If not set, the maximum value will + // be used. + int32 annotations_limit = 7; + + // Requested page size. Server may return fewer results than requested. + // Default and maximum page size is 100. + int32 page_size = 8; + + // A comma-separated list of fields to order by, sorted in ascending order. + // Use "desc" after a field name for descending. + string order_by = 9 [deprecated = true]; + + // A token identifying a page of results for the server to return + // Typically obtained via + // [SearchDataItemsResponse.next_page_token][google.cloud.aiplatform.v1beta1.SearchDataItemsResponse.next_page_token] + // of the previous + // [DatasetService.SearchDataItems][google.cloud.aiplatform.v1beta1.DatasetService.SearchDataItems] + // call. + string page_token = 10; +} + +// Response message for +// [DatasetService.SearchDataItems][google.cloud.aiplatform.v1beta1.DatasetService.SearchDataItems]. +message SearchDataItemsResponse { + // The DataItemViews read. + repeated DataItemView data_item_views = 1; + + // A token to retrieve next page of results. + // Pass to + // [SearchDataItemsRequest.page_token][google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.page_token] + // to obtain that page. + string next_page_token = 2; +} + +// A container for a single DataItem and Annotations on it. +message DataItemView { + // The DataItem. + DataItem data_item = 1; + + // The Annotations on the DataItem. If too many Annotations should be returned + // for the DataItem, this field will be truncated per annotations_limit in + // request. If it was, then the has_truncated_annotations will be set to true. + repeated Annotation annotations = 2; + + // True if and only if the Annotations field has been truncated. It happens if + // more Annotations for this DataItem met the request's annotation_filter than + // are allowed to be returned by annotations_limit. + // Note that if Annotations field is not being returned due to field mask, + // then this field will not be set to true no matter how many Annotations are + // there. + bool has_truncated_annotations = 3; +} + +// Request message for +// [DatasetService.ListSavedQueries][google.cloud.aiplatform.v1beta1.DatasetService.ListSavedQueries]. message ListSavedQueriesRequest { // Required. The resource name of the Dataset to list SavedQueries from. // Format: @@ -397,7 +562,8 @@ message ListSavedQueriesRequest { string order_by = 6; } -// Response message for [DatasetService.ListSavedQueries][google.cloud.aiplatform.v1beta1.DatasetService.ListSavedQueries]. +// Response message for +// [DatasetService.ListSavedQueries][google.cloud.aiplatform.v1beta1.DatasetService.ListSavedQueries]. message ListSavedQueriesResponse { // A list of SavedQueries that match the specified filter in the request. repeated SavedQuery saved_queries = 1; @@ -406,7 +572,8 @@ message ListSavedQueriesResponse { string next_page_token = 2; } -// Request message for [DatasetService.GetAnnotationSpec][google.cloud.aiplatform.v1beta1.DatasetService.GetAnnotationSpec]. +// Request message for +// [DatasetService.GetAnnotationSpec][google.cloud.aiplatform.v1beta1.DatasetService.GetAnnotationSpec]. message GetAnnotationSpecRequest { // Required. The name of the AnnotationSpec resource. // Format: @@ -422,7 +589,8 @@ message GetAnnotationSpecRequest { google.protobuf.FieldMask read_mask = 2; } -// Request message for [DatasetService.ListAnnotations][google.cloud.aiplatform.v1beta1.DatasetService.ListAnnotations]. +// Request message for +// [DatasetService.ListAnnotations][google.cloud.aiplatform.v1beta1.DatasetService.ListAnnotations]. message ListAnnotationsRequest { // Required. The resource name of the DataItem to list Annotations from. // Format: @@ -451,7 +619,8 @@ message ListAnnotationsRequest { string order_by = 6; } -// Response message for [DatasetService.ListAnnotations][google.cloud.aiplatform.v1beta1.DatasetService.ListAnnotations]. +// Response message for +// [DatasetService.ListAnnotations][google.cloud.aiplatform.v1beta1.DatasetService.ListAnnotations]. message ListAnnotationsResponse { // A list of Annotations that matches the specified filter in the request. repeated Annotation annotations = 1; diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/deployment_resource_pool.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/deployment_resource_pool.proto index 2249e655c3b..8f794120f86 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/deployment_resource_pool.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/deployment_resource_pool.proto @@ -39,12 +39,15 @@ message DeploymentResourcePool { // Output only. The resource name of the DeploymentResourcePool. // Format: - // projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool} + // `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Required. The underlying DedicatedResources that the DeploymentResourcePool uses. - DedicatedResources dedicated_resources = 2 [(google.api.field_behavior) = REQUIRED]; + // Required. The underlying DedicatedResources that the DeploymentResourcePool + // uses. + DedicatedResources dedicated_resources = 2 + [(google.api.field_behavior) = REQUIRED]; // Output only. Timestamp when this DeploymentResourcePool was created. - google.protobuf.Timestamp create_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/deployment_resource_pool_service.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/deployment_resource_pool_service.proto index 11eddf67cf9..752d8407aae 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/deployment_resource_pool_service.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/deployment_resource_pool_service.proto @@ -37,15 +37,18 @@ option ruby_package = "Google::Cloud::AIPlatform::V1beta1"; // A service that manages the DeploymentResourcePool resource. service DeploymentResourcePoolService { option (google.api.default_host) = "aiplatform.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/cloud-platform"; // Create a DeploymentResourcePool. - rpc CreateDeploymentResourcePool(CreateDeploymentResourcePoolRequest) returns (google.longrunning.Operation) { + rpc CreateDeploymentResourcePool(CreateDeploymentResourcePoolRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta1/{parent=projects/*/locations/*}/deploymentResourcePools" body: "*" }; - option (google.api.method_signature) = "parent,deployment_resource_pool,deployment_resource_pool_id"; + option (google.api.method_signature) = + "parent,deployment_resource_pool,deployment_resource_pool_id"; option (google.longrunning.operation_info) = { response_type: "DeploymentResourcePool" metadata_type: "CreateDeploymentResourcePoolOperationMetadata" @@ -53,7 +56,8 @@ service DeploymentResourcePoolService { } // Get a DeploymentResourcePool. - rpc GetDeploymentResourcePool(GetDeploymentResourcePoolRequest) returns (DeploymentResourcePool) { + rpc GetDeploymentResourcePool(GetDeploymentResourcePoolRequest) + returns (DeploymentResourcePool) { option (google.api.http) = { get: "/v1beta1/{name=projects/*/locations/*/deploymentResourcePools/*}" }; @@ -61,7 +65,8 @@ service DeploymentResourcePoolService { } // List DeploymentResourcePools in a location. - rpc ListDeploymentResourcePools(ListDeploymentResourcePoolsRequest) returns (ListDeploymentResourcePoolsResponse) { + rpc ListDeploymentResourcePools(ListDeploymentResourcePoolsRequest) + returns (ListDeploymentResourcePoolsResponse) { option (google.api.http) = { get: "/v1beta1/{parent=projects/*/locations/*}/deploymentResourcePools" }; @@ -69,7 +74,8 @@ service DeploymentResourcePoolService { } // Delete a DeploymentResourcePool. - rpc DeleteDeploymentResourcePool(DeleteDeploymentResourcePoolRequest) returns (google.longrunning.Operation) { + rpc DeleteDeploymentResourcePool(DeleteDeploymentResourcePoolRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1beta1/{name=projects/*/locations/*/deploymentResourcePools/*}" }; @@ -81,7 +87,8 @@ service DeploymentResourcePoolService { } // List DeployedModels that have been deployed on this DeploymentResourcePool. - rpc QueryDeployedModels(QueryDeployedModelsRequest) returns (QueryDeployedModelsResponse) { + rpc QueryDeployedModels(QueryDeployedModelsRequest) + returns (QueryDeployedModelsResponse) { option (google.api.http) = { get: "/v1beta1/{deployment_resource_pool=projects/*/locations/*/deploymentResourcePools/*}:queryDeployedModels" }; @@ -91,8 +98,8 @@ service DeploymentResourcePoolService { // Request message for CreateDeploymentResourcePool method. message CreateDeploymentResourcePoolRequest { - // Required. The parent location resource where this DeploymentResourcePool will be - // created. Format: projects/{project}/locations/{location} + // Required. The parent location resource where this DeploymentResourcePool + // will be created. Format: `projects/{project}/locations/{location}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -101,7 +108,8 @@ message CreateDeploymentResourcePoolRequest { ]; // Required. The DeploymentResourcePool to create. - DeploymentResourcePool deployment_resource_pool = 2 [(google.api.field_behavior) = REQUIRED]; + DeploymentResourcePool deployment_resource_pool = 2 + [(google.api.field_behavior) = REQUIRED]; // Required. The ID to use for the DeploymentResourcePool, which // will become the final component of the DeploymentResourcePool's resource @@ -109,7 +117,8 @@ message CreateDeploymentResourcePoolRequest { // // The maximum length is 63 characters, and valid characters // are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`. - string deployment_resource_pool_id = 3 [(google.api.field_behavior) = REQUIRED]; + string deployment_resource_pool_id = 3 + [(google.api.field_behavior) = REQUIRED]; } // Runtime operation information for CreateDeploymentResourcePool method. @@ -122,7 +131,7 @@ message CreateDeploymentResourcePoolOperationMetadata { message GetDeploymentResourcePoolRequest { // Required. The name of the DeploymentResourcePool to retrieve. // Format: - // projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool} + // `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` string name = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -133,8 +142,8 @@ message GetDeploymentResourcePoolRequest { // Request message for ListDeploymentResourcePools method. message ListDeploymentResourcePoolsRequest { - // Required. The parent Location which owns this collection of DeploymentResourcePools. - // Format: projects/{project}/locations/{location} + // Required. The parent Location which owns this collection of + // DeploymentResourcePools. Format: `projects/{project}/locations/{location}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -175,7 +184,7 @@ message UpdateDeploymentResourcePoolOperationMetadata { message DeleteDeploymentResourcePoolRequest { // Required. The name of the DeploymentResourcePool to delete. // Format: - // projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool} + // `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` string name = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -188,7 +197,7 @@ message DeleteDeploymentResourcePoolRequest { message QueryDeployedModelsRequest { // Required. The name of the target DeploymentResourcePool to query. // Format: - // projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool} + // `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` string deployment_resource_pool = 1 [(google.api.field_behavior) = REQUIRED]; // The maximum number of DeployedModels to return. The service may return @@ -216,4 +225,11 @@ message QueryDeployedModelsResponse { // References to the DeployedModels that share the specified // deploymentResourcePool. repeated DeployedModelRef deployed_model_refs = 3; + + // The total number of DeployedModels on this DeploymentResourcePool. + int32 total_deployed_model_count = 4; + + // The total number of Endpoints that have DeployedModels on this + // DeploymentResourcePool. + int32 total_endpoint_count = 5; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/encryption_spec.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/encryption_spec.proto index 27e2bade03b..738f8876b8d 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/encryption_spec.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/encryption_spec.proto @@ -29,8 +29,8 @@ option ruby_package = "Google::Cloud::AIPlatform::V1beta1"; // Represents a customer-managed encryption key spec that can be applied to // a top-level resource. message EncryptionSpec { - // Required. The Cloud KMS resource identifier of the customer managed encryption key - // used to protect a resource. Has the form: + // Required. The Cloud KMS resource identifier of the customer managed + // encryption key used to protect a resource. Has the form: // `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. // The key needs to be in the same region as where the compute resource is // created. diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/endpoint.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/endpoint.proto index 0236e532f7c..c8055754466 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/endpoint.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/endpoint.proto @@ -44,7 +44,7 @@ message Endpoint { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. The display name of the Endpoint. - // The name can be up to 128 characters long and can be consist of any UTF-8 + // The name can be up to 128 characters long and can consist of any UTF-8 // characters. string display_name = 2 [(google.api.field_behavior) = REQUIRED]; @@ -52,9 +52,13 @@ message Endpoint { string description = 3; // Output only. The models deployed in this Endpoint. - // To add or remove DeployedModels use [EndpointService.DeployModel][google.cloud.aiplatform.v1beta1.EndpointService.DeployModel] and - // [EndpointService.UndeployModel][google.cloud.aiplatform.v1beta1.EndpointService.UndeployModel] respectively. - repeated DeployedModel deployed_models = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + // To add or remove DeployedModels use + // [EndpointService.DeployModel][google.cloud.aiplatform.v1beta1.EndpointService.DeployModel] + // and + // [EndpointService.UndeployModel][google.cloud.aiplatform.v1beta1.EndpointService.UndeployModel] + // respectively. + repeated DeployedModel deployed_models = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; // A map from a DeployedModel's ID to the percentage of this Endpoint's // traffic that should be forwarded to that DeployedModel. @@ -80,10 +84,12 @@ message Endpoint { map labels = 7; // Output only. Timestamp when this Endpoint was created. - google.protobuf.Timestamp create_time = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 8 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this Endpoint was last updated. - google.protobuf.Timestamp update_time = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 9 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Customer-managed encryption key spec for an Endpoint. If set, this // Endpoint and all sub-resources of this Endpoint will be secured by @@ -97,7 +103,8 @@ message Endpoint { // Private services access must already be configured for the network. If left // unspecified, the Endpoint is not peered with any network. // - // Only one of the fields, [network][google.cloud.aiplatform.v1beta1.Endpoint.network] or + // Only one of the fields, + // [network][google.cloud.aiplatform.v1beta1.Endpoint.network] or // [enable_private_service_connect][google.cloud.aiplatform.v1beta1.Endpoint.enable_private_service_connect], // can be set. // @@ -105,20 +112,21 @@ message Endpoint { // `projects/{project}/global/networks/{network}`. // Where `{project}` is a project number, as in `12345`, and `{network}` is // network name. - string network = 13 [(google.api.resource_reference) = { - type: "compute.googleapis.com/Network" - }]; + string network = 13 [ + (google.api.resource_reference) = { type: "compute.googleapis.com/Network" } + ]; // Deprecated: If true, expose the Endpoint via private service connect. // - // Only one of the fields, [network][google.cloud.aiplatform.v1beta1.Endpoint.network] or + // Only one of the fields, + // [network][google.cloud.aiplatform.v1beta1.Endpoint.network] or // [enable_private_service_connect][google.cloud.aiplatform.v1beta1.Endpoint.enable_private_service_connect], // can be set. bool enable_private_service_connect = 17 [deprecated = true]; - // Output only. Resource name of the Model Monitoring job associated with this Endpoint - // if monitoring is enabled by [CreateModelDeploymentMonitoringJob][]. - // Format: + // Output only. Resource name of the Model Monitoring job associated with this + // Endpoint if monitoring is enabled by + // [CreateModelDeploymentMonitoringJob][]. Format: // `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}` string model_deployment_monitoring_job = 14 [ (google.api.field_behavior) = OUTPUT_ONLY, @@ -128,7 +136,8 @@ message Endpoint { ]; // Configures the request-response logging for online prediction. - PredictRequestResponseLoggingConfig predict_request_response_logging_config = 18; + PredictRequestResponseLoggingConfig predict_request_response_logging_config = + 18; } // A deployment of a Model. Endpoints contain one or more DeployedModels. @@ -149,20 +158,21 @@ message DeployedModel { // The resource name of the shared DeploymentResourcePool to deploy on. // Format: - // projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool} + // `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` string shared_resources = 17 [(google.api.resource_reference) = { - type: "aiplatform.googleapis.com/DeploymentResourcePool" - }]; + type: "aiplatform.googleapis.com/DeploymentResourcePool" + }]; } - // Immutable. The ID of the DeployedModel. If not provided upon deployment, Vertex AI - // will generate a value for this ID. + // Immutable. The ID of the DeployedModel. If not provided upon deployment, + // Vertex AI will generate a value for this ID. // // This value should be 1-10 characters, and valid characters are /[0-9]/. string id = 1 [(google.api.field_behavior) = IMMUTABLE]; - // Required. The resource name of the Model that this is the deployment of. Note that - // the Model may be in a different location than the DeployedModel's Endpoint. + // Required. The resource name of the Model that this is the deployment of. + // Note that the Model may be in a different location than the DeployedModel's + // Endpoint. // // The resource name may contain version id or version alias to specify the // version, if no version is specified, the default version will be deployed. @@ -181,17 +191,26 @@ message DeployedModel { string display_name = 3; // Output only. Timestamp when the DeployedModel was created. - google.protobuf.Timestamp create_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 6 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Explanation configuration for this DeployedModel. // - // When deploying a Model using [EndpointService.DeployModel][google.cloud.aiplatform.v1beta1.EndpointService.DeployModel], this value - // overrides the value of [Model.explanation_spec][google.cloud.aiplatform.v1beta1.Model.explanation_spec]. All fields of - // [explanation_spec][google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec] are optional in the request. If a field of - // [explanation_spec][google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec] is not populated, the value of the same field of - // [Model.explanation_spec][google.cloud.aiplatform.v1beta1.Model.explanation_spec] is inherited. If the corresponding - // [Model.explanation_spec][google.cloud.aiplatform.v1beta1.Model.explanation_spec] is not populated, all fields of the - // [explanation_spec][google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec] will be used for the explanation configuration. + // When deploying a Model using + // [EndpointService.DeployModel][google.cloud.aiplatform.v1beta1.EndpointService.DeployModel], + // this value overrides the value of + // [Model.explanation_spec][google.cloud.aiplatform.v1beta1.Model.explanation_spec]. + // All fields of + // [explanation_spec][google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec] + // are optional in the request. If a field of + // [explanation_spec][google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec] + // is not populated, the value of the same field of + // [Model.explanation_spec][google.cloud.aiplatform.v1beta1.Model.explanation_spec] + // is inherited. If the corresponding + // [Model.explanation_spec][google.cloud.aiplatform.v1beta1.Model.explanation_spec] + // is not populated, all fields of the + // [explanation_spec][google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec] + // will be used for the explanation configuration. ExplanationSpec explanation_spec = 9; // The service account that the DeployedModel's container runs as. Specify the @@ -217,10 +236,12 @@ message DeployedModel { // Estimate your costs before enabling this option. bool enable_access_logging = 13; - // Output only. Provide paths for users to send predict/explain/health requests directly to - // the deployed model services running on Cloud via private services access. - // This field is populated if [network][google.cloud.aiplatform.v1beta1.Endpoint.network] is configured. - PrivateEndpoints private_endpoints = 14 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. Provide paths for users to send predict/explain/health + // requests directly to the deployed model services running on Cloud via + // private services access. This field is populated if + // [network][google.cloud.aiplatform.v1beta1.Endpoint.network] is configured. + PrivateEndpoints private_endpoints = 14 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // PrivateEndpoints proto is used to provide paths for users to send @@ -238,8 +259,8 @@ message PrivateEndpoints { // Output only. Http(s) path to send health check requests. string health_http_uri = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. The name of the service attachment resource. Populated if private service - // connect is enabled. + // Output only. The name of the service attachment resource. Populated if + // private service connect is enabled. string service_attachment = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/endpoint_service.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/endpoint_service.proto index e30077dcdae..8496b62ff59 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/endpoint_service.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/endpoint_service.proto @@ -36,10 +36,12 @@ option ruby_package = "Google::Cloud::AIPlatform::V1beta1"; // A service for managing Vertex AI's Endpoints. service EndpointService { option (google.api.default_host) = "aiplatform.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/cloud-platform"; // Creates an Endpoint. - rpc CreateEndpoint(CreateEndpointRequest) returns (google.longrunning.Operation) { + rpc CreateEndpoint(CreateEndpointRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta1/{parent=projects/*/locations/*}/endpoints" body: "endpoint" @@ -78,7 +80,8 @@ service EndpointService { } // Deletes an Endpoint. - rpc DeleteEndpoint(DeleteEndpointRequest) returns (google.longrunning.Operation) { + rpc DeleteEndpoint(DeleteEndpointRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1beta1/{name=projects/*/locations/*/endpoints/*}" }; @@ -95,7 +98,8 @@ service EndpointService { post: "/v1beta1/{endpoint=projects/*/locations/*/endpoints/*}:deployModel" body: "*" }; - option (google.api.method_signature) = "endpoint,deployed_model,traffic_split"; + option (google.api.method_signature) = + "endpoint,deployed_model,traffic_split"; option (google.longrunning.operation_info) = { response_type: "DeployModelResponse" metadata_type: "DeployModelOperationMetadata" @@ -104,12 +108,14 @@ service EndpointService { // Undeploys a Model from an Endpoint, removing a DeployedModel from it, and // freeing all resources it's using. - rpc UndeployModel(UndeployModelRequest) returns (google.longrunning.Operation) { + rpc UndeployModel(UndeployModelRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta1/{endpoint=projects/*/locations/*/endpoints/*}:undeployModel" body: "*" }; - option (google.api.method_signature) = "endpoint,deployed_model_id,traffic_split"; + option (google.api.method_signature) = + "endpoint,deployed_model_id,traffic_split"; option (google.longrunning.operation_info) = { response_type: "UndeployModelResponse" metadata_type: "UndeployModelOperationMetadata" @@ -117,7 +123,8 @@ service EndpointService { } } -// Request message for [EndpointService.CreateEndpoint][google.cloud.aiplatform.v1beta1.EndpointService.CreateEndpoint]. +// Request message for +// [EndpointService.CreateEndpoint][google.cloud.aiplatform.v1beta1.EndpointService.CreateEndpoint]. message CreateEndpointRequest { // Required. The resource name of the Location to create the Endpoint in. // Format: `projects/{project}/locations/{location}` @@ -142,13 +149,15 @@ message CreateEndpointRequest { string endpoint_id = 4 [(google.api.field_behavior) = IMMUTABLE]; } -// Runtime operation information for [EndpointService.CreateEndpoint][google.cloud.aiplatform.v1beta1.EndpointService.CreateEndpoint]. +// Runtime operation information for +// [EndpointService.CreateEndpoint][google.cloud.aiplatform.v1beta1.EndpointService.CreateEndpoint]. message CreateEndpointOperationMetadata { // The operation generic information. GenericOperationMetadata generic_metadata = 1; } -// Request message for [EndpointService.GetEndpoint][google.cloud.aiplatform.v1beta1.EndpointService.GetEndpoint] +// Request message for +// [EndpointService.GetEndpoint][google.cloud.aiplatform.v1beta1.EndpointService.GetEndpoint] message GetEndpointRequest { // Required. The name of the Endpoint resource. // Format: @@ -161,10 +170,11 @@ message GetEndpointRequest { ]; } -// Request message for [EndpointService.ListEndpoints][google.cloud.aiplatform.v1beta1.EndpointService.ListEndpoints]. +// Request message for +// [EndpointService.ListEndpoints][google.cloud.aiplatform.v1beta1.EndpointService.ListEndpoints]. message ListEndpointsRequest { - // Required. The resource name of the Location from which to list the Endpoints. - // Format: `projects/{project}/locations/{location}` + // Required. The resource name of the Location from which to list the + // Endpoints. Format: `projects/{project}/locations/{location}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -172,11 +182,12 @@ message ListEndpointsRequest { } ]; - // Optional. An expression for filtering the results of the request. For field names - // both snake_case and camelCase are supported. + // Optional. An expression for filtering the results of the request. For field + // names both snake_case and camelCase are supported. // // * `endpoint` supports = and !=. `endpoint` represents the Endpoint ID, - // i.e. the last segment of the Endpoint's [resource name][google.cloud.aiplatform.v1beta1.Endpoint.name]. + // i.e. the last segment of the Endpoint's [resource + // name][google.cloud.aiplatform.v1beta1.Endpoint.name]. // * `display_name` supports = and, != // * `labels` supports general map functions that is: // * `labels.key=value` - key:value equality @@ -194,34 +205,44 @@ message ListEndpointsRequest { // Optional. The standard list page token. // Typically obtained via - // [ListEndpointsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListEndpointsResponse.next_page_token] of the previous - // [EndpointService.ListEndpoints][google.cloud.aiplatform.v1beta1.EndpointService.ListEndpoints] call. + // [ListEndpointsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListEndpointsResponse.next_page_token] + // of the previous + // [EndpointService.ListEndpoints][google.cloud.aiplatform.v1beta1.EndpointService.ListEndpoints] + // call. string page_token = 4 [(google.api.field_behavior) = OPTIONAL]; // Optional. Mask specifying which fields to read. - google.protobuf.FieldMask read_mask = 5 [(google.api.field_behavior) = OPTIONAL]; + google.protobuf.FieldMask read_mask = 5 + [(google.api.field_behavior) = OPTIONAL]; } -// Response message for [EndpointService.ListEndpoints][google.cloud.aiplatform.v1beta1.EndpointService.ListEndpoints]. +// Response message for +// [EndpointService.ListEndpoints][google.cloud.aiplatform.v1beta1.EndpointService.ListEndpoints]. message ListEndpointsResponse { // List of Endpoints in the requested page. repeated Endpoint endpoints = 1; // A token to retrieve the next page of results. - // Pass to [ListEndpointsRequest.page_token][google.cloud.aiplatform.v1beta1.ListEndpointsRequest.page_token] to obtain that page. + // Pass to + // [ListEndpointsRequest.page_token][google.cloud.aiplatform.v1beta1.ListEndpointsRequest.page_token] + // to obtain that page. string next_page_token = 2; } -// Request message for [EndpointService.UpdateEndpoint][google.cloud.aiplatform.v1beta1.EndpointService.UpdateEndpoint]. +// Request message for +// [EndpointService.UpdateEndpoint][google.cloud.aiplatform.v1beta1.EndpointService.UpdateEndpoint]. message UpdateEndpointRequest { // Required. The Endpoint which replaces the resource on the server. Endpoint endpoint = 1 [(google.api.field_behavior) = REQUIRED]; - // Required. The update mask applies to the resource. See [google.protobuf.FieldMask][google.protobuf.FieldMask]. - google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED]; + // Required. The update mask applies to the resource. See + // [google.protobuf.FieldMask][google.protobuf.FieldMask]. + google.protobuf.FieldMask update_mask = 2 + [(google.api.field_behavior) = REQUIRED]; } -// Request message for [EndpointService.DeleteEndpoint][google.cloud.aiplatform.v1beta1.EndpointService.DeleteEndpoint]. +// Request message for +// [EndpointService.DeleteEndpoint][google.cloud.aiplatform.v1beta1.EndpointService.DeleteEndpoint]. message DeleteEndpointRequest { // Required. The name of the Endpoint resource to be deleted. // Format: @@ -234,7 +255,8 @@ message DeleteEndpointRequest { ]; } -// Request message for [EndpointService.DeployModel][google.cloud.aiplatform.v1beta1.EndpointService.DeployModel]. +// Request message for +// [EndpointService.DeployModel][google.cloud.aiplatform.v1beta1.EndpointService.DeployModel]. message DeployModelRequest { // Required. The name of the Endpoint resource into which to deploy a Model. // Format: @@ -247,8 +269,9 @@ message DeployModelRequest { ]; // Required. The DeployedModel to be created within the Endpoint. Note that - // [Endpoint.traffic_split][google.cloud.aiplatform.v1beta1.Endpoint.traffic_split] must be updated for the DeployedModel to start - // receiving traffic, either as part of this call, or via + // [Endpoint.traffic_split][google.cloud.aiplatform.v1beta1.Endpoint.traffic_split] + // must be updated for the DeployedModel to start receiving traffic, either as + // part of this call, or via // [EndpointService.UpdateEndpoint][google.cloud.aiplatform.v1beta1.EndpointService.UpdateEndpoint]. DeployedModel deployed_model = 2 [(google.api.field_behavior) = REQUIRED]; @@ -256,29 +279,34 @@ message DeployModelRequest { // traffic that should be forwarded to that DeployedModel. // // If this field is non-empty, then the Endpoint's - // [traffic_split][google.cloud.aiplatform.v1beta1.Endpoint.traffic_split] will be overwritten with it. - // To refer to the ID of the just being deployed Model, a "0" should be used, - // and the actual ID of the new DeployedModel will be filled in its place by - // this method. The traffic percentage values must add up to 100. + // [traffic_split][google.cloud.aiplatform.v1beta1.Endpoint.traffic_split] + // will be overwritten with it. To refer to the ID of the just being deployed + // Model, a "0" should be used, and the actual ID of the new DeployedModel + // will be filled in its place by this method. The traffic percentage values + // must add up to 100. // // If this field is empty, then the Endpoint's - // [traffic_split][google.cloud.aiplatform.v1beta1.Endpoint.traffic_split] is not updated. + // [traffic_split][google.cloud.aiplatform.v1beta1.Endpoint.traffic_split] is + // not updated. map traffic_split = 3; } -// Response message for [EndpointService.DeployModel][google.cloud.aiplatform.v1beta1.EndpointService.DeployModel]. +// Response message for +// [EndpointService.DeployModel][google.cloud.aiplatform.v1beta1.EndpointService.DeployModel]. message DeployModelResponse { // The DeployedModel that had been deployed in the Endpoint. DeployedModel deployed_model = 1; } -// Runtime operation information for [EndpointService.DeployModel][google.cloud.aiplatform.v1beta1.EndpointService.DeployModel]. +// Runtime operation information for +// [EndpointService.DeployModel][google.cloud.aiplatform.v1beta1.EndpointService.DeployModel]. message DeployModelOperationMetadata { // The operation generic information. GenericOperationMetadata generic_metadata = 1; } -// Request message for [EndpointService.UndeployModel][google.cloud.aiplatform.v1beta1.EndpointService.UndeployModel]. +// Request message for +// [EndpointService.UndeployModel][google.cloud.aiplatform.v1beta1.EndpointService.UndeployModel]. message UndeployModelRequest { // Required. The name of the Endpoint resource from which to undeploy a Model. // Format: @@ -294,21 +322,21 @@ message UndeployModelRequest { string deployed_model_id = 2 [(google.api.field_behavior) = REQUIRED]; // If this field is provided, then the Endpoint's - // [traffic_split][google.cloud.aiplatform.v1beta1.Endpoint.traffic_split] will be overwritten with it. If - // last DeployedModel is being undeployed from the Endpoint, the - // [Endpoint.traffic_split] will always end up empty when this call returns. - // A DeployedModel will be successfully undeployed only if it doesn't have - // any traffic assigned to it when this method executes, or if this field - // unassigns any traffic to it. + // [traffic_split][google.cloud.aiplatform.v1beta1.Endpoint.traffic_split] + // will be overwritten with it. If last DeployedModel is being undeployed from + // the Endpoint, the [Endpoint.traffic_split] will always end up empty when + // this call returns. A DeployedModel will be successfully undeployed only if + // it doesn't have any traffic assigned to it when this method executes, or if + // this field unassigns any traffic to it. map traffic_split = 3; } -// Response message for [EndpointService.UndeployModel][google.cloud.aiplatform.v1beta1.EndpointService.UndeployModel]. -message UndeployModelResponse { - -} +// Response message for +// [EndpointService.UndeployModel][google.cloud.aiplatform.v1beta1.EndpointService.UndeployModel]. +message UndeployModelResponse {} -// Runtime operation information for [EndpointService.UndeployModel][google.cloud.aiplatform.v1beta1.EndpointService.UndeployModel]. +// Runtime operation information for +// [EndpointService.UndeployModel][google.cloud.aiplatform.v1beta1.EndpointService.UndeployModel]. message UndeployModelOperationMetadata { // The operation generic information. GenericOperationMetadata generic_metadata = 1; diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/entity_type.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/entity_type.proto index 14f762bacd0..e69d56a0980 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/entity_type.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/entity_type.proto @@ -52,12 +52,15 @@ message EntityType { string description = 2 [(google.api.field_behavior) = OPTIONAL]; // Output only. Timestamp when this EntityType was created. - google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this EntityType was most recently updated. - google.protobuf.Timestamp update_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Optional. The labels with user-defined metadata to organize your EntityTypes. + // Optional. The labels with user-defined metadata to organize your + // EntityTypes. // // Label keys and values can be no longer than 64 characters // (Unicode codepoints), can only contain lowercase letters, numeric @@ -70,17 +73,26 @@ message EntityType { // and are immutable. map labels = 6 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Used to perform a consistent read-modify-write updates. If not set, a blind - // "overwrite" update happens. + // Optional. Used to perform a consistent read-modify-write updates. If not + // set, a blind "overwrite" update happens. string etag = 7 [(google.api.field_behavior) = OPTIONAL]; - // Optional. The default monitoring configuration for all Features with value type - // ([Feature.ValueType][google.cloud.aiplatform.v1beta1.Feature.ValueType]) BOOL, STRING, DOUBLE or INT64 under this - // EntityType. + // Optional. The default monitoring configuration for all Features with value + // type + // ([Feature.ValueType][google.cloud.aiplatform.v1beta1.Feature.ValueType]) + // BOOL, STRING, DOUBLE or INT64 under this EntityType. // // If this is populated with // [FeaturestoreMonitoringConfig.monitoring_interval] specified, snapshot // analysis monitoring is enabled. Otherwise, snapshot analysis monitoring is // disabled. - FeaturestoreMonitoringConfig monitoring_config = 8 [(google.api.field_behavior) = OPTIONAL]; + FeaturestoreMonitoringConfig monitoring_config = 8 + [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Config for data retention policy in offline storage. + // TTL in days for feature values that will be stored in offline storage. + // The Feature Store offline storage periodically removes obsolete feature + // values older than `offline_storage_ttl_days` since the feature generation + // time. If unset (or explicitly set to 0), default to 4000 days TTL. + int32 offline_storage_ttl_days = 10 [(google.api.field_behavior) = OPTIONAL]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/event.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/event.proto index 5cbb25c8cfe..628aba7b6bd 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/event.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/event.proto @@ -60,7 +60,8 @@ message Event { ]; // Output only. Time the Event occurred. - google.protobuf.Timestamp event_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp event_time = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. The type of the Event. Type type = 4 [(google.api.field_behavior) = REQUIRED]; diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/execution.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/execution.proto index 74395db99d0..7c477048abf 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/execution.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/execution.proto @@ -87,10 +87,12 @@ message Execution { map labels = 10; // Output only. Timestamp when this Execution was created. - google.protobuf.Timestamp create_time = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 11 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this Execution was last updated. - google.protobuf.Timestamp update_time = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 12 + [(google.api.field_behavior) = OUTPUT_ONLY]; // The title of the schema describing the metadata. // @@ -107,6 +109,7 @@ message Execution { string schema_version = 14; // Properties of the Execution. + // Top level metadata keys' heading and trailing spaces will be trimmed. // The size of this field should not exceed 200KB. google.protobuf.Struct metadata = 15; diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/explanation.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/explanation.proto index 6dccd06e4e9..222e75daa22 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/explanation.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/explanation.proto @@ -29,8 +29,10 @@ option java_package = "com.google.cloud.aiplatform.v1beta1"; option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1"; option ruby_package = "Google::Cloud::AIPlatform::V1beta1"; -// Explanation of a prediction (provided in [PredictResponse.predictions][google.cloud.aiplatform.v1beta1.PredictResponse.predictions]) -// produced by the Model on a given [instance][google.cloud.aiplatform.v1beta1.ExplainRequest.instances]. +// Explanation of a prediction (provided in +// [PredictResponse.predictions][google.cloud.aiplatform.v1beta1.PredictResponse.predictions]) +// produced by the Model on a given +// [instance][google.cloud.aiplatform.v1beta1.ExplainRequest.instances]. message Explanation { // Output only. Feature attributions grouped by predicted outputs. // @@ -38,15 +40,21 @@ message Explanation { // predict only one score, there is only one attibution that explains the // predicted output. For Models that predict multiple outputs, such as // multiclass Models that predict multiple classes, each element explains one - // specific item. [Attribution.output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index] can be used to identify which - // output this attribution is explaining. + // specific item. + // [Attribution.output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index] + // can be used to identify which output this attribution is explaining. // - // If users set [ExplanationParameters.top_k][google.cloud.aiplatform.v1beta1.ExplanationParameters.top_k], the attributions are sorted - // by [instance_output_value][Attributions.instance_output_value] in - // descending order. If [ExplanationParameters.output_indices][google.cloud.aiplatform.v1beta1.ExplanationParameters.output_indices] is specified, - // the attributions are stored by [Attribution.output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index] in the same - // order as they appear in the output_indices. - repeated Attribution attributions = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + // If users set + // [ExplanationParameters.top_k][google.cloud.aiplatform.v1beta1.ExplanationParameters.top_k], + // the attributions are sorted by + // [instance_output_value][Attributions.instance_output_value] in descending + // order. If + // [ExplanationParameters.output_indices][google.cloud.aiplatform.v1beta1.ExplanationParameters.output_indices] + // is specified, the attributions are stored by + // [Attribution.output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index] + // in the same order as they appear in the output_indices. + repeated Attribution attributions = 1 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. List of the nearest neighbors for example-based explanations. // @@ -57,54 +65,66 @@ message Explanation { // Aggregated explanation metrics for a Model over a set of instances. message ModelExplanation { - // Output only. Aggregated attributions explaining the Model's prediction outputs over the - // set of instances. The attributions are grouped by outputs. + // Output only. Aggregated attributions explaining the Model's prediction + // outputs over the set of instances. The attributions are grouped by outputs. // // For Models that predict only one output, such as regression Models that // predict only one score, there is only one attibution that explains the // predicted output. For Models that predict multiple outputs, such as // multiclass Models that predict multiple classes, each element explains one - // specific item. [Attribution.output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index] can be used to identify which - // output this attribution is explaining. + // specific item. + // [Attribution.output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index] + // can be used to identify which output this attribution is explaining. // - // The [baselineOutputValue][google.cloud.aiplatform.v1beta1.Attribution.baseline_output_value], - // [instanceOutputValue][google.cloud.aiplatform.v1beta1.Attribution.instance_output_value] and - // [featureAttributions][google.cloud.aiplatform.v1beta1.Attribution.feature_attributions] fields are - // averaged over the test data. + // The + // [baselineOutputValue][google.cloud.aiplatform.v1beta1.Attribution.baseline_output_value], + // [instanceOutputValue][google.cloud.aiplatform.v1beta1.Attribution.instance_output_value] + // and + // [featureAttributions][google.cloud.aiplatform.v1beta1.Attribution.feature_attributions] + // fields are averaged over the test data. // // NOTE: Currently AutoML tabular classification Models produce only one // attribution, which averages attributions over all the classes it predicts. - // [Attribution.approximation_error][google.cloud.aiplatform.v1beta1.Attribution.approximation_error] is not populated. - repeated Attribution mean_attributions = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + // [Attribution.approximation_error][google.cloud.aiplatform.v1beta1.Attribution.approximation_error] + // is not populated. + repeated Attribution mean_attributions = 1 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // Attribution that explains a particular prediction output. message Attribution { - // Output only. Model predicted output if the input instance is constructed from the - // baselines of all the features defined in [ExplanationMetadata.inputs][google.cloud.aiplatform.v1beta1.ExplanationMetadata.inputs]. + // Output only. Model predicted output if the input instance is constructed + // from the baselines of all the features defined in + // [ExplanationMetadata.inputs][google.cloud.aiplatform.v1beta1.ExplanationMetadata.inputs]. // The field name of the output is determined by the key in // [ExplanationMetadata.outputs][google.cloud.aiplatform.v1beta1.ExplanationMetadata.outputs]. // // If the Model's predicted output has multiple dimensions (rank > 1), this is - // the value in the output located by [output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index]. + // the value in the output located by + // [output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index]. // // If there are multiple baselines, their output values are averaged. double baseline_output_value = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Model predicted output on the corresponding [explanation // instance][ExplainRequest.instances]. The field name of the output is - // determined by the key in [ExplanationMetadata.outputs][google.cloud.aiplatform.v1beta1.ExplanationMetadata.outputs]. + // determined by the key in + // [ExplanationMetadata.outputs][google.cloud.aiplatform.v1beta1.ExplanationMetadata.outputs]. // // If the Model predicted output has multiple dimensions, this is the value in - // the output located by [output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index]. + // the output located by + // [output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index]. double instance_output_value = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. Attributions of each explained feature. Features are extracted from - // the [prediction instances][google.cloud.aiplatform.v1beta1.ExplainRequest.instances] according to - // [explanation metadata for inputs][google.cloud.aiplatform.v1beta1.ExplanationMetadata.inputs]. + // Output only. Attributions of each explained feature. Features are extracted + // from the [prediction + // instances][google.cloud.aiplatform.v1beta1.ExplainRequest.instances] + // according to [explanation metadata for + // inputs][google.cloud.aiplatform.v1beta1.ExplanationMetadata.inputs]. // // The value is a struct, whose keys are the name of the feature. The values - // are how much the feature in the [instance][google.cloud.aiplatform.v1beta1.ExplainRequest.instances] + // are how much the feature in the + // [instance][google.cloud.aiplatform.v1beta1.ExplainRequest.instances] // contributed to the predicted result. // // The format of the value is determined by the feature's input format: @@ -121,11 +141,16 @@ message Attribution { // struct. The formats of the values in the attribution struct are // determined by the formats of the values in the feature struct. // - // The [ExplanationMetadata.feature_attributions_schema_uri][google.cloud.aiplatform.v1beta1.ExplanationMetadata.feature_attributions_schema_uri] field, - // pointed to by the [ExplanationSpec][google.cloud.aiplatform.v1beta1.ExplanationSpec] field of the - // [Endpoint.deployed_models][google.cloud.aiplatform.v1beta1.Endpoint.deployed_models] object, points to the schema file that - // describes the features and their attribution values (if it is populated). - google.protobuf.Value feature_attributions = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + // The + // [ExplanationMetadata.feature_attributions_schema_uri][google.cloud.aiplatform.v1beta1.ExplanationMetadata.feature_attributions_schema_uri] + // field, pointed to by the + // [ExplanationSpec][google.cloud.aiplatform.v1beta1.ExplanationSpec] field of + // the + // [Endpoint.deployed_models][google.cloud.aiplatform.v1beta1.Endpoint.deployed_models] + // object, points to the schema file that describes the features and their + // attribution values (if it is populated). + google.protobuf.Value feature_attributions = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The index that locates the explained prediction output. // @@ -136,8 +161,9 @@ message Attribution { // of the output vector. Indices start from 0. repeated int32 output_index = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. The display name of the output identified by [output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index]. For example, - // the predicted class name by a multi-classification Model. + // Output only. The display name of the output identified by + // [output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index]. + // For example, the predicted class name by a multi-classification Model. // // This field is only populated iff the Model predicts display names as a // separate field along with the explained output. The predicted display name @@ -145,20 +171,26 @@ message Attribution { // output_index. string output_display_name = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. Error of [feature_attributions][google.cloud.aiplatform.v1beta1.Attribution.feature_attributions] caused by approximation used in the - // explanation method. Lower value means more precise attributions. + // Output only. Error of + // [feature_attributions][google.cloud.aiplatform.v1beta1.Attribution.feature_attributions] + // caused by approximation used in the explanation method. Lower value means + // more precise attributions. // // * For Sampled Shapley // [attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.sampled_shapley_attribution], - // increasing [path_count][google.cloud.aiplatform.v1beta1.SampledShapleyAttribution.path_count] might reduce - // the error. + // increasing + // [path_count][google.cloud.aiplatform.v1beta1.SampledShapleyAttribution.path_count] + // might reduce the error. // * For Integrated Gradients // [attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.integrated_gradients_attribution], - // increasing [step_count][google.cloud.aiplatform.v1beta1.IntegratedGradientsAttribution.step_count] might - // reduce the error. - // * For [XRAI attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.xrai_attribution], // increasing - // [step_count][google.cloud.aiplatform.v1beta1.XraiAttribution.step_count] might reduce the error. + // [step_count][google.cloud.aiplatform.v1beta1.IntegratedGradientsAttribution.step_count] + // might reduce the error. + // * For [XRAI + // attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.xrai_attribution], + // increasing + // [step_count][google.cloud.aiplatform.v1beta1.XraiAttribution.step_count] + // might reduce the error. // // See [this introduction](/vertex-ai/docs/explainable-ai/overview) // for more information. @@ -224,13 +256,14 @@ message ExplanationParameters { int32 top_k = 4; // If populated, only returns attributions that have - // [output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index] contained in output_indices. It - // must be an ndarray of integers, with the same shape of the output it's - // explaining. + // [output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index] + // contained in output_indices. It must be an ndarray of integers, with the + // same shape of the output it's explaining. // - // If not populated, returns attributions for [top_k][google.cloud.aiplatform.v1beta1.ExplanationParameters.top_k] indices of outputs. - // If neither top_k nor output_indices is populated, returns the argmax - // index of the outputs. + // If not populated, returns attributions for + // [top_k][google.cloud.aiplatform.v1beta1.ExplanationParameters.top_k] + // indices of outputs. If neither top_k nor output_indices is populated, + // returns the argmax index of the outputs. // // Only applicable to Models that predict multiple outputs (e,g, multi-class // Models that predict multiple classes). @@ -241,8 +274,8 @@ message ExplanationParameters { // contribute to the label being predicted. A sampling strategy is used to // approximate the value rather than considering all subsets of features. message SampledShapleyAttribution { - // Required. The number of feature permutations to consider when approximating the - // Shapley values. + // Required. The number of feature permutations to consider when approximating + // the Shapley values. // // Valid range of its value is [1, 50], inclusively. int32 path_count = 1 [(google.api.field_behavior) = REQUIRED]; @@ -329,16 +362,18 @@ message SmoothGradConfig { // paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to 0.1. // // If the distribution is different per feature, set - // [feature_noise_sigma][google.cloud.aiplatform.v1beta1.SmoothGradConfig.feature_noise_sigma] instead - // for each feature. + // [feature_noise_sigma][google.cloud.aiplatform.v1beta1.SmoothGradConfig.feature_noise_sigma] + // instead for each feature. float noise_sigma = 1; - // This is similar to [noise_sigma][google.cloud.aiplatform.v1beta1.SmoothGradConfig.noise_sigma], but - // provides additional flexibility. A separate noise sigma can be provided - // for each feature, which is useful if their distributions are different. - // No noise is added to features that are not set. If this field is unset, - // [noise_sigma][google.cloud.aiplatform.v1beta1.SmoothGradConfig.noise_sigma] will be used for all - // features. + // This is similar to + // [noise_sigma][google.cloud.aiplatform.v1beta1.SmoothGradConfig.noise_sigma], + // but provides additional flexibility. A separate noise sigma can be + // provided for each feature, which is useful if their distributions are + // different. No noise is added to features that are not set. If this field + // is unset, + // [noise_sigma][google.cloud.aiplatform.v1beta1.SmoothGradConfig.noise_sigma] + // will be used for all features. FeatureNoiseSigma feature_noise_sigma = 2; } @@ -357,13 +392,15 @@ message FeatureNoiseSigma { message NoiseSigmaForFeature { // The name of the input feature for which noise sigma is provided. The // features are defined in - // [explanation metadata inputs][google.cloud.aiplatform.v1beta1.ExplanationMetadata.inputs]. + // [explanation metadata + // inputs][google.cloud.aiplatform.v1beta1.ExplanationMetadata.inputs]. string name = 1; // This represents the standard deviation of the Gaussian kernel that will // be used to add noise to the feature prior to computing gradients. Similar - // to [noise_sigma][google.cloud.aiplatform.v1beta1.SmoothGradConfig.noise_sigma] but represents the - // noise added to the current feature. Defaults to 0.1. + // to + // [noise_sigma][google.cloud.aiplatform.v1beta1.SmoothGradConfig.noise_sigma] + // but represents the noise added to the current feature. Defaults to 0.1. float sigma = 2; } @@ -390,7 +427,8 @@ message BlurBaselineConfig { message Examples { oneof config { // The configuration for the generated index, the semantics are the same as - // [metadata][google.cloud.aiplatform.v1beta1.Index.metadata] and should match NearestNeighborSearchConfig. + // [metadata][google.cloud.aiplatform.v1beta1.Index.metadata] and should + // match NearestNeighborSearchConfig. google.protobuf.Value nearest_neighbor_search_config = 2; // Preset config based on the desired query speed-precision trade-off @@ -439,12 +477,13 @@ message Presets { Modality modality = 2; } -// The [ExplanationSpec][google.cloud.aiplatform.v1beta1.ExplanationSpec] entries that can be overridden at -// [online explanation][google.cloud.aiplatform.v1beta1.PredictionService.Explain] time. +// The [ExplanationSpec][google.cloud.aiplatform.v1beta1.ExplanationSpec] +// entries that can be overridden at [online +// explanation][google.cloud.aiplatform.v1beta1.PredictionService.Explain] time. message ExplanationSpecOverride { // The parameters to be overridden. Note that the - // [method][google.cloud.aiplatform.v1beta1.ExplanationParameters.method] cannot be changed. If not specified, - // no parameter is overridden. + // [method][google.cloud.aiplatform.v1beta1.ExplanationParameters.method] + // cannot be changed. If not specified, no parameter is overridden. ExplanationParameters parameters = 1; // The metadata to be overridden. If not specified, no metadata is overridden. @@ -454,11 +493,14 @@ message ExplanationSpecOverride { ExamplesOverride examples_override = 3; } -// The [ExplanationMetadata][google.cloud.aiplatform.v1beta1.ExplanationMetadata] entries that can be overridden at -// [online explanation][google.cloud.aiplatform.v1beta1.PredictionService.Explain] time. +// The +// [ExplanationMetadata][google.cloud.aiplatform.v1beta1.ExplanationMetadata] +// entries that can be overridden at [online +// explanation][google.cloud.aiplatform.v1beta1.PredictionService.Explain] time. message ExplanationMetadataOverride { - // The [input metadata][google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata] entries to be - // overridden. + // The [input + // metadata][google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata] + // entries to be overridden. message InputMetadataOverride { // Baseline inputs for this feature. // @@ -469,12 +511,14 @@ message ExplanationMetadataOverride { repeated google.protobuf.Value input_baselines = 1; } - // Required. Overrides the [input metadata][google.cloud.aiplatform.v1beta1.ExplanationMetadata.inputs] of the features. - // The key is the name of the feature to be overridden. The keys specified - // here must exist in the input metadata to be overridden. If a feature is - // not specified here, the corresponding feature's input metadata is not - // overridden. - map inputs = 1 [(google.api.field_behavior) = REQUIRED]; + // Required. Overrides the [input + // metadata][google.cloud.aiplatform.v1beta1.ExplanationMetadata.inputs] of + // the features. The key is the name of the feature to be overridden. The keys + // specified here must exist in the input metadata to be overridden. If a + // feature is not specified here, the corresponding feature's input metadata + // is not overridden. + map inputs = 1 + [(google.api.field_behavior) = REQUIRED]; } // Overrides for example-based explanations. diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/explanation_metadata.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/explanation_metadata.proto index ef962a51933..7089c4e01d1 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/explanation_metadata.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/explanation_metadata.proto @@ -31,8 +31,10 @@ option ruby_package = "Google::Cloud::AIPlatform::V1beta1"; message ExplanationMetadata { // Metadata of the input of a feature. // - // Fields other than [InputMetadata.input_baselines][google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.input_baselines] are applicable only - // for Models that are using Vertex AI-provided images for Tensorflow. + // Fields other than + // [InputMetadata.input_baselines][google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.input_baselines] + // are applicable only for Models that are using Vertex AI-provided images for + // Tensorflow. message InputMetadata { // Domain details of the input feature value. Provides numeric information // about the feature, such as its range (min, max). If the feature has been @@ -63,7 +65,8 @@ message ExplanationMetadata { // Visualization configurations for image explanation. message Visualization { // Type of the image visualization. Only applicable to - // [Integrated Gradients attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.integrated_gradients_attribution]. + // [Integrated Gradients + // attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.integrated_gradients_attribution]. enum Type { // Should not be used. TYPE_UNSPECIFIED = 0; @@ -141,7 +144,8 @@ message ExplanationMetadata { } // Type of the image visualization. Only applicable to - // [Integrated Gradients attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.integrated_gradients_attribution]. + // [Integrated Gradients + // attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.integrated_gradients_attribution]. // OUTLINES shows regions of attribution, while PIXELS shows per-pixel // attribution. Defaults to OUTLINES. Type type = 1; @@ -153,12 +157,14 @@ message ExplanationMetadata { // The color scheme used for the highlighted areas. // // Defaults to PINK_GREEN for - // [Integrated Gradients attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.integrated_gradients_attribution], + // [Integrated Gradients + // attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.integrated_gradients_attribution], // which shows positive attributions in green and negative in pink. // // Defaults to VIRIDIS for - // [XRAI attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.xrai_attribution], which - // highlights the most influential regions in yellow and the least + // [XRAI + // attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.xrai_attribution], + // which highlights the most influential regions in yellow and the least // influential in blue. ColorMap color_map = 3; @@ -188,8 +194,9 @@ message ExplanationMetadata { IDENTITY = 1; // The tensor represents a bag of features where each index maps to - // a feature. [InputMetadata.index_feature_mapping][google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.index_feature_mapping] must be provided for - // this encoding. For example: + // a feature. + // [InputMetadata.index_feature_mapping][google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.index_feature_mapping] + // must be provided for this encoding. For example: // ``` // input = [27, 6.0, 150] // index_feature_mapping = ["age", "height", "weight"] @@ -198,8 +205,9 @@ message ExplanationMetadata { // The tensor represents a bag of features where each index maps to a // feature. Zero values in the tensor indicates feature being - // non-existent. [InputMetadata.index_feature_mapping][google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.index_feature_mapping] must be provided - // for this encoding. For example: + // non-existent. + // [InputMetadata.index_feature_mapping][google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.index_feature_mapping] + // must be provided for this encoding. For example: // ``` // input = [2, 0, 5, 0, 1] // index_feature_mapping = ["a", "b", "c", "d", "e"] @@ -207,7 +215,8 @@ message ExplanationMetadata { BAG_OF_FEATURES_SPARSE = 3; // The tensor is a list of binaries representing whether a feature exists - // or not (1 indicates existence). [InputMetadata.index_feature_mapping][google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.index_feature_mapping] + // or not (1 indicates existence). + // [InputMetadata.index_feature_mapping][google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.index_feature_mapping] // must be provided for this encoding. For example: // ``` // input = [1, 0, 1, 0, 1] @@ -216,8 +225,9 @@ message ExplanationMetadata { INDICATOR = 4; // The tensor is encoded into a 1-dimensional array represented by an - // encoded tensor. [InputMetadata.encoded_tensor_name][google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.encoded_tensor_name] must be provided - // for this encoding. For example: + // encoded tensor. + // [InputMetadata.encoded_tensor_name][google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.encoded_tensor_name] + // must be provided for this encoding. For example: // ``` // input = ["This", "is", "a", "test", "."] // encoded = [0.1, 0.2, 0.3, 0.4, 0.5] @@ -226,9 +236,9 @@ message ExplanationMetadata { // Select this encoding when the input tensor is encoded into a // 2-dimensional array represented by an encoded tensor. - // [InputMetadata.encoded_tensor_name][google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.encoded_tensor_name] must be provided for this - // encoding. The first dimension of the encoded tensor's shape is the same - // as the input tensor's shape. For example: + // [InputMetadata.encoded_tensor_name][google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.encoded_tensor_name] + // must be provided for this encoding. The first dimension of the encoded + // tensor's shape is the same as the input tensor's shape. For example: // ``` // input = ["This", "is", "a", "test", "."] // encoded = [[0.1, 0.2, 0.3, 0.4, 0.5], @@ -244,7 +254,8 @@ message ExplanationMetadata { // // If no baseline is specified, Vertex AI chooses the baseline for this // feature. If multiple baselines are specified, Vertex AI returns the - // average attributions across them in [Attribution.feature_attributions][google.cloud.aiplatform.v1beta1.Attribution.feature_attributions]. + // average attributions across them in + // [Attribution.feature_attributions][google.cloud.aiplatform.v1beta1.Attribution.feature_attributions]. // // For Vertex AI-provided Tensorflow images (both 1.x and 2.x), the shape // of each baseline must match the shape of the input tensor. If a scalar is @@ -252,8 +263,9 @@ message ExplanationMetadata { // // For custom images, the element of the baselines must be in the same // format as the feature's input in the - // [instance][google.cloud.aiplatform.v1beta1.ExplainRequest.instances][]. The schema of any single instance - // may be specified via Endpoint's DeployedModels' + // [instance][google.cloud.aiplatform.v1beta1.ExplainRequest.instances][]. + // The schema of any single instance may be specified via Endpoint's + // DeployedModels' // [Model's][google.cloud.aiplatform.v1beta1.DeployedModel.model] // [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata] // [instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri]. @@ -287,15 +299,18 @@ message ExplanationMetadata { string dense_shape_tensor_name = 7; // A list of feature names for each index in the input tensor. - // Required when the input [InputMetadata.encoding][google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.encoding] is BAG_OF_FEATURES, - // BAG_OF_FEATURES_SPARSE, INDICATOR. + // Required when the input + // [InputMetadata.encoding][google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.encoding] + // is BAG_OF_FEATURES, BAG_OF_FEATURES_SPARSE, INDICATOR. repeated string index_feature_mapping = 8; // Encoded tensor is a transformation of the input tensor. Must be provided // if choosing - // [Integrated Gradients attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.integrated_gradients_attribution] - // or [XRAI attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.xrai_attribution] and the - // input tensor is not differentiable. + // [Integrated Gradients + // attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.integrated_gradients_attribution] + // or [XRAI + // attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.xrai_attribution] + // and the input tensor is not differentiable. // // An encoded tensor is generated if the input tensor is encoded by a lookup // table. @@ -315,17 +330,21 @@ message ExplanationMetadata { // name will be treated as one feature when computing attributions. Features // grouped together can have different shapes in value. If provided, there // will be one single attribution generated in - // [Attribution.feature_attributions][google.cloud.aiplatform.v1beta1.Attribution.feature_attributions], keyed by the group name. + // [Attribution.feature_attributions][google.cloud.aiplatform.v1beta1.Attribution.feature_attributions], + // keyed by the group name. string group_name = 12; } // Metadata of the prediction output to be explained. message OutputMetadata { - // Defines how to map [Attribution.output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index] to + // Defines how to map + // [Attribution.output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index] + // to // [Attribution.output_display_name][google.cloud.aiplatform.v1beta1.Attribution.output_display_name]. // // If neither of the fields are specified, - // [Attribution.output_display_name][google.cloud.aiplatform.v1beta1.Attribution.output_display_name] will not be populated. + // [Attribution.output_display_name][google.cloud.aiplatform.v1beta1.Attribution.output_display_name] + // will not be populated. oneof display_name_mapping { // Static mapping between the index and display name. // @@ -337,8 +356,10 @@ message ExplanationMetadata { // // The shape of the value must be an n-dimensional array of strings. The // number of dimensions must match that of the outputs to be explained. - // The [Attribution.output_display_name][google.cloud.aiplatform.v1beta1.Attribution.output_display_name] is populated by locating in the - // mapping with [Attribution.output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index]. + // The + // [Attribution.output_display_name][google.cloud.aiplatform.v1beta1.Attribution.output_display_name] + // is populated by locating in the mapping with + // [Attribution.output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index]. google.protobuf.Value index_display_name_mapping = 1; // Specify a field name in the prediction to look for the display name. @@ -346,8 +367,9 @@ message ExplanationMetadata { // Use this if the prediction contains the display names for the outputs. // // The display names in the prediction must have the same shape of the - // outputs, so that it can be located by [Attribution.output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index] for - // a specific output. + // outputs, so that it can be located by + // [Attribution.output_index][google.cloud.aiplatform.v1beta1.Attribution.output_index] + // for a specific output. string display_name_mapping_key = 2; } @@ -356,21 +378,23 @@ message ExplanationMetadata { string output_tensor_name = 3; } - // Required. Map from feature names to feature input metadata. Keys are the name of the - // features. Values are the specification of the feature. + // Required. Map from feature names to feature input metadata. Keys are the + // name of the features. Values are the specification of the feature. // // An empty InputMetadata is valid. It describes a text feature which has the - // name specified as the key in [ExplanationMetadata.inputs][google.cloud.aiplatform.v1beta1.ExplanationMetadata.inputs]. The baseline - // of the empty feature is chosen by Vertex AI. + // name specified as the key in + // [ExplanationMetadata.inputs][google.cloud.aiplatform.v1beta1.ExplanationMetadata.inputs]. + // The baseline of the empty feature is chosen by Vertex AI. // // For Vertex AI-provided Tensorflow images, the key can be any friendly // name of the feature. Once specified, - // [featureAttributions][google.cloud.aiplatform.v1beta1.Attribution.feature_attributions] are keyed by - // this key (if not grouped with another feature). + // [featureAttributions][google.cloud.aiplatform.v1beta1.Attribution.feature_attributions] + // are keyed by this key (if not grouped with another feature). // // For custom images, the key must match with the key in // [instance][google.cloud.aiplatform.v1beta1.ExplainRequest.instances]. - map inputs = 1 [(google.api.field_behavior) = REQUIRED]; + map inputs = 1 + [(google.api.field_behavior) = REQUIRED]; // Required. Map from output names to output metadata. // @@ -381,10 +405,12 @@ message ExplanationMetadata { // to be explained. // // Currently only one key is allowed. - map outputs = 2 [(google.api.field_behavior) = REQUIRED]; + map outputs = 2 + [(google.api.field_behavior) = REQUIRED]; // Points to a YAML file stored on Google Cloud Storage describing the format - // of the [feature attributions][google.cloud.aiplatform.v1beta1.Attribution.feature_attributions]. + // of the [feature + // attributions][google.cloud.aiplatform.v1beta1.Attribution.feature_attributions]. // The schema is defined as an OpenAPI 3.0.2 [Schema // Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). // AutoML tabular Models always have this field populated by Vertex AI. diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/feature.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/feature.proto index cf67cf3e9fd..2d9b8883d7c 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/feature.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/feature.proto @@ -42,7 +42,9 @@ message Feature { // A list of historical [Snapshot // Analysis][FeaturestoreMonitoringConfig.SnapshotAnalysis] or [Import Feature // Analysis] [FeaturestoreMonitoringConfig.ImportFeatureAnalysis] stats - // requested by user, sorted by [FeatureStatsAnomaly.start_time][google.cloud.aiplatform.v1beta1.FeatureStatsAnomaly.start_time] descending. + // requested by user, sorted by + // [FeatureStatsAnomaly.start_time][google.cloud.aiplatform.v1beta1.FeatureStatsAnomaly.start_time] + // descending. message MonitoringStatsAnomaly { // If the objective in the request is both // Import Feature Analysis and Snapshot Analysis, this objective could be @@ -63,7 +65,8 @@ message Feature { Objective objective = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The stats and anomalies generated at specific timestamp. - FeatureStatsAnomaly feature_stats_anomaly = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + FeatureStatsAnomaly feature_stats_anomaly = 2 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // An enum representing the value type of a feature. @@ -119,10 +122,12 @@ message Feature { ]; // Output only. Timestamp when this EntityType was created. - google.protobuf.Timestamp create_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this EntityType was most recently updated. - google.protobuf.Timestamp update_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Optional. The labels with user-defined metadata to organize your Features. // @@ -141,11 +146,11 @@ message Feature { // "overwrite" update happens. string etag = 7; - // Optional. Deprecated: The custom monitoring configuration for this Feature, if not - // set, use the monitoring_config defined for the EntityType this Feature - // belongs to. - // Only Features with type ([Feature.ValueType][google.cloud.aiplatform.v1beta1.Feature.ValueType]) BOOL, STRING, DOUBLE or - // INT64 can enable monitoring. + // Optional. Deprecated: The custom monitoring configuration for this Feature, + // if not set, use the monitoring_config defined for the EntityType this + // Feature belongs to. Only Features with type + // ([Feature.ValueType][google.cloud.aiplatform.v1beta1.Feature.ValueType]) + // BOOL, STRING, DOUBLE or INT64 can enable monitoring. // // If this is populated with // [FeaturestoreMonitoringConfig.disabled][] = true, snapshot analysis @@ -153,15 +158,13 @@ message Feature { // [FeaturestoreMonitoringConfig.monitoring_interval][] specified, snapshot // analysis monitoring is enabled. Otherwise, snapshot analysis monitoring // config is same as the EntityType's this Feature belongs to. - FeaturestoreMonitoringConfig monitoring_config = 9 [ - deprecated = true, - (google.api.field_behavior) = OPTIONAL - ]; + FeaturestoreMonitoringConfig monitoring_config = 9 + [deprecated = true, (google.api.field_behavior) = OPTIONAL]; - // Optional. If not set, use the monitoring_config defined for the EntityType this - // Feature belongs to. - // Only Features with type ([Feature.ValueType][google.cloud.aiplatform.v1beta1.Feature.ValueType]) BOOL, STRING, DOUBLE or - // INT64 can enable monitoring. + // Optional. If not set, use the monitoring_config defined for the EntityType + // this Feature belongs to. Only Features with type + // ([Feature.ValueType][google.cloud.aiplatform.v1beta1.Feature.ValueType]) + // BOOL, STRING, DOUBLE or INT64 can enable monitoring. // // If set to true, all types of data monitoring are disabled despite the // config on EntityType. @@ -169,10 +172,14 @@ message Feature { // Output only. A list of historical [Snapshot // Analysis][FeaturestoreMonitoringConfig.SnapshotAnalysis] - // stats requested by user, sorted by [FeatureStatsAnomaly.start_time][google.cloud.aiplatform.v1beta1.FeatureStatsAnomaly.start_time] + // stats requested by user, sorted by + // [FeatureStatsAnomaly.start_time][google.cloud.aiplatform.v1beta1.FeatureStatsAnomaly.start_time] // descending. - repeated FeatureStatsAnomaly monitoring_stats = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; + repeated FeatureStatsAnomaly monitoring_stats = 10 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. The list of historical stats and anomalies with specified objectives. - repeated MonitoringStatsAnomaly monitoring_stats_anomalies = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. The list of historical stats and anomalies with specified + // objectives. + repeated MonitoringStatsAnomaly monitoring_stats_anomalies = 11 + [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/feature_monitoring_stats.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/feature_monitoring_stats.proto index 30ffbd951a1..749632305de 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/feature_monitoring_stats.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/feature_monitoring_stats.proto @@ -39,7 +39,8 @@ message FeatureStatsAnomaly { // Feature importance score, only populated when cross-feature monitoring is // enabled. For now only used to represent feature attribution score within // range [0, 1] for - // [ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_SKEW][google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_SKEW] and + // [ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_SKEW][google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_SKEW] + // and // [ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_DRIFT][google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_DRIFT]. double score = 1; diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/featurestore.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/featurestore.proto index f5ece8f20f6..3530ca6fbec 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/featurestore.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/featurestore.proto @@ -45,8 +45,8 @@ message Featurestore { // max_node_count are set to the same value, the cluster will be configured // with the fixed number of node (no auto-scaling). message Scaling { - // Required. The minimum number of nodes to scale down to. Must be greater than or - // equal to 1. + // Required. The minimum number of nodes to scale down to. Must be greater + // than or equal to 1. int32 min_node_count = 1 [(google.api.field_behavior) = REQUIRED]; // The maximum number of nodes to scale up to. Must be greater than @@ -94,16 +94,19 @@ message Featurestore { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this Featurestore was created. - google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this Featurestore was last updated. - google.protobuf.Timestamp update_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Optional. Used to perform consistent read-modify-write updates. If not set, a blind - // "overwrite" update happens. + // Optional. Used to perform consistent read-modify-write updates. If not set, + // a blind "overwrite" update happens. string etag = 5 [(google.api.field_behavior) = OPTIONAL]; - // Optional. The labels with user-defined metadata to organize your Featurestore. + // Optional. The labels with user-defined metadata to organize your + // Featurestore. // // Label keys and values can be no longer than 64 characters // (Unicode codepoints), can only contain lowercase letters, numeric @@ -116,14 +119,25 @@ message Featurestore { // and are immutable. map labels = 6 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Config for online storage resources. If unset, the featurestore will - // not have an online store and cannot be used for online serving. - OnlineServingConfig online_serving_config = 7 [(google.api.field_behavior) = OPTIONAL]; + // Optional. Config for online storage resources. The field should not + // co-exist with the field of `OnlineStoreReplicationConfig`. If both of it + // and OnlineStoreReplicationConfig are unset, the feature store will not have + // an online store and cannot be used for online serving. + OnlineServingConfig online_serving_config = 7 + [(google.api.field_behavior) = OPTIONAL]; // Output only. State of the featurestore. State state = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Optional. Customer-managed encryption key spec for data storage. If set, both of the - // online and offline data storage will be secured by this key. + // Optional. TTL in days for feature values that will be stored in online + // serving storage. The Feature Store online storage periodically removes + // obsolete feature values older than `online_storage_ttl_days` since the + // feature generation time. Note that `online_storage_ttl_days` should be less + // than or equal to `offline_storage_ttl_days` for each EntityType under a + // featurestore. If not set, default to 4000 days + int32 online_storage_ttl_days = 13 [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Customer-managed encryption key spec for data storage. If set, + // both of the online and offline data storage will be secured by this key. EncryptionSpec encryption_spec = 10 [(google.api.field_behavior) = OPTIONAL]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/featurestore_monitoring.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/featurestore_monitoring.proto index fefe9e7729c..307a3cd88ed 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/featurestore_monitoring.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/featurestore_monitoring.proto @@ -54,7 +54,8 @@ message FeaturestoreMonitoringConfig { // running interval. The value indicates number of days. // If both // [FeaturestoreMonitoringConfig.SnapshotAnalysis.monitoring_interval_days][google.cloud.aiplatform.v1beta1.FeaturestoreMonitoringConfig.SnapshotAnalysis.monitoring_interval_days] - // and [FeaturestoreMonitoringConfig.SnapshotAnalysis.monitoring_interval][google.cloud.aiplatform.v1beta1.FeaturestoreMonitoringConfig.SnapshotAnalysis.monitoring_interval] + // and + // [FeaturestoreMonitoringConfig.SnapshotAnalysis.monitoring_interval][google.cloud.aiplatform.v1beta1.FeaturestoreMonitoringConfig.SnapshotAnalysis.monitoring_interval] // are set when creating/updating EntityTypes/Features, // [FeaturestoreMonitoringConfig.SnapshotAnalysis.monitoring_interval_days][google.cloud.aiplatform.v1beta1.FeaturestoreMonitoringConfig.SnapshotAnalysis.monitoring_interval_days] // will be used. @@ -145,11 +146,15 @@ message FeaturestoreMonitoringConfig { // Threshold for numerical features of anomaly detection. // This is shared by all objectives of Featurestore Monitoring for numerical - // features (i.e. Features with type ([Feature.ValueType][google.cloud.aiplatform.v1beta1.Feature.ValueType]) DOUBLE or INT64). + // features (i.e. Features with type + // ([Feature.ValueType][google.cloud.aiplatform.v1beta1.Feature.ValueType]) + // DOUBLE or INT64). ThresholdConfig numerical_threshold_config = 3; // Threshold for categorical features of anomaly detection. // This is shared by all types of Featurestore Monitoring for categorical - // features (i.e. Features with type ([Feature.ValueType][google.cloud.aiplatform.v1beta1.Feature.ValueType]) BOOL or STRING). + // features (i.e. Features with type + // ([Feature.ValueType][google.cloud.aiplatform.v1beta1.Feature.ValueType]) + // BOOL or STRING). ThresholdConfig categorical_threshold_config = 4; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/featurestore_online_service.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/featurestore_online_service.proto index 5f7cbd1449a..8ee05dffa2c 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/featurestore_online_service.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/featurestore_online_service.proto @@ -35,12 +35,14 @@ option ruby_package = "Google::Cloud::AIPlatform::V1beta1"; // A service for serving online feature values. service FeaturestoreOnlineServingService { option (google.api.default_host) = "aiplatform.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/cloud-platform"; // Reads Feature values of a specific entity of an EntityType. For reading // feature values of multiple entities of an EntityType, please use // StreamingReadFeatureValues. - rpc ReadFeatureValues(ReadFeatureValuesRequest) returns (ReadFeatureValuesResponse) { + rpc ReadFeatureValues(ReadFeatureValuesRequest) + returns (ReadFeatureValuesResponse) { option (google.api.http) = { post: "/v1beta1/{entity_type=projects/*/locations/*/featurestores/*/entityTypes/*}:readFeatureValues" body: "*" @@ -51,7 +53,8 @@ service FeaturestoreOnlineServingService { // Reads Feature values for multiple entities. Depending on their size, data // for different entities may be broken // up across multiple responses. - rpc StreamingReadFeatureValues(StreamingReadFeatureValuesRequest) returns (stream ReadFeatureValuesResponse) { + rpc StreamingReadFeatureValues(StreamingReadFeatureValuesRequest) + returns (stream ReadFeatureValuesResponse) { option (google.api.http) = { post: "/v1beta1/{entity_type=projects/*/locations/*/featurestores/*/entityTypes/*}:streamingReadFeatureValues" body: "*" @@ -64,7 +67,8 @@ service FeaturestoreOnlineServingService { // The Feature values are merged into existing entities if any. The Feature // values to be written must have timestamp within the online storage // retention. - rpc WriteFeatureValues(WriteFeatureValuesRequest) returns (WriteFeatureValuesResponse) { + rpc WriteFeatureValues(WriteFeatureValuesRequest) + returns (WriteFeatureValuesResponse) { option (google.api.http) = { post: "/v1beta1/{entity_type=projects/*/locations/*/featurestores/*/entityTypes/*}:writeFeatureValues" body: "*" @@ -73,10 +77,12 @@ service FeaturestoreOnlineServingService { } } -// Request message for [FeaturestoreOnlineServingService.WriteFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreOnlineServingService.WriteFeatureValues]. +// Request message for +// [FeaturestoreOnlineServingService.WriteFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreOnlineServingService.WriteFeatureValues]. message WriteFeatureValuesRequest { - // Required. The resource name of the EntityType for the entities being written. - // Value format: `projects/{project}/locations/{location}/featurestores/ + // Required. The resource name of the EntityType for the entities being + // written. Value format: + // `projects/{project}/locations/{location}/featurestores/ // {featurestore}/entityTypes/{entityType}`. For example, // for a machine learning model predicting user clicks on a website, an // EntityType ID could be `user`. @@ -87,9 +93,10 @@ message WriteFeatureValuesRequest { } ]; - // Required. The entities to be written. Up to 100,000 feature values can be written - // across all `payloads`. - repeated WriteFeatureValuesPayload payloads = 2 [(google.api.field_behavior) = REQUIRED]; + // Required. The entities to be written. Up to 100,000 feature values can be + // written across all `payloads`. + repeated WriteFeatureValuesPayload payloads = 2 + [(google.api.field_behavior) = REQUIRED]; } // Contains Feature values to be written for a specific entity. @@ -97,19 +104,20 @@ message WriteFeatureValuesPayload { // Required. The ID of the entity. string entity_id = 1 [(google.api.field_behavior) = REQUIRED]; - // Required. Feature values to be written, mapping from Feature ID to value. Up to - // 100,000 `feature_values` entries may be written across all payloads. The - // feature generation time, aligned by days, must be no older than five + // Required. Feature values to be written, mapping from Feature ID to value. + // Up to 100,000 `feature_values` entries may be written across all payloads. + // The feature generation time, aligned by days, must be no older than five // years (1825 days) and no later than one year (366 days) in the future. - map feature_values = 2 [(google.api.field_behavior) = REQUIRED]; + map feature_values = 2 + [(google.api.field_behavior) = REQUIRED]; } -// Response message for [FeaturestoreOnlineServingService.WriteFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreOnlineServingService.WriteFeatureValues]. -message WriteFeatureValuesResponse { - -} +// Response message for +// [FeaturestoreOnlineServingService.WriteFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreOnlineServingService.WriteFeatureValues]. +message WriteFeatureValuesResponse {} -// Request message for [FeaturestoreOnlineServingService.ReadFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreOnlineServingService.ReadFeatureValues]. +// Request message for +// [FeaturestoreOnlineServingService.ReadFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreOnlineServingService.ReadFeatureValues]. message ReadFeatureValuesRequest { // Required. The resource name of the EntityType for the entity being read. // Value format: @@ -132,7 +140,8 @@ message ReadFeatureValuesRequest { FeatureSelector feature_selector = 3 [(google.api.field_behavior) = REQUIRED]; } -// Response message for [FeaturestoreOnlineServingService.ReadFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreOnlineServingService.ReadFeatureValues]. +// Response message for +// [FeaturestoreOnlineServingService.ReadFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreOnlineServingService.ReadFeatureValues]. message ReadFeatureValuesResponse { // Metadata for requested Features. message FeatureDescriptor { @@ -141,14 +150,16 @@ message ReadFeatureValuesResponse { } // Response header with metadata for the requested - // [ReadFeatureValuesRequest.entity_type][google.cloud.aiplatform.v1beta1.ReadFeatureValuesRequest.entity_type] and Features. + // [ReadFeatureValuesRequest.entity_type][google.cloud.aiplatform.v1beta1.ReadFeatureValuesRequest.entity_type] + // and Features. message Header { // The resource name of the EntityType from the - // [ReadFeatureValuesRequest][google.cloud.aiplatform.v1beta1.ReadFeatureValuesRequest]. Value format: + // [ReadFeatureValuesRequest][google.cloud.aiplatform.v1beta1.ReadFeatureValuesRequest]. + // Value format: // `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`. string entity_type = 1 [(google.api.resource_reference) = { - type: "aiplatform.googleapis.com/EntityType" - }]; + type: "aiplatform.googleapis.com/EntityType" + }]; // List of Feature metadata corresponding to each piece of // [ReadFeatureValuesResponse.data][]. @@ -179,7 +190,8 @@ message ReadFeatureValuesResponse { // requested values for one requested Feature. If no values // for the requested Feature exist, the corresponding cell will be empty. // This has the same size and is in the same order as the features from the - // header [ReadFeatureValuesResponse.header][google.cloud.aiplatform.v1beta1.ReadFeatureValuesResponse.header]. + // header + // [ReadFeatureValuesResponse.header][google.cloud.aiplatform.v1beta1.ReadFeatureValuesResponse.header]. repeated Data data = 2; } @@ -209,13 +221,13 @@ message StreamingReadFeatureValuesRequest { } ]; - // Required. IDs of entities to read Feature values of. The maximum number of IDs is - // 100. For example, for a machine learning model predicting user clicks on a - // website, an entity ID could be `user_123`. + // Required. IDs of entities to read Feature values of. The maximum number of + // IDs is 100. For example, for a machine learning model predicting user + // clicks on a website, an entity ID could be `user_123`. repeated string entity_ids = 2 [(google.api.field_behavior) = REQUIRED]; - // Required. Selector choosing Features of the target EntityType. Feature IDs will be - // deduplicated. + // Required. Selector choosing Features of the target EntityType. Feature IDs + // will be deduplicated. FeatureSelector feature_selector = 3 [(google.api.field_behavior) = REQUIRED]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/featurestore_service.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/featurestore_service.proto index 56df4670f7f..31aed3da96c 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/featurestore_service.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/featurestore_service.proto @@ -42,16 +42,19 @@ option ruby_package = "Google::Cloud::AIPlatform::V1beta1"; // The service that handles CRUD and List for resources for Featurestore. service FeaturestoreService { option (google.api.default_host) = "aiplatform.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/cloud-platform"; // Creates a new Featurestore in a given project and location. - rpc CreateFeaturestore(CreateFeaturestoreRequest) returns (google.longrunning.Operation) { + rpc CreateFeaturestore(CreateFeaturestoreRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta1/{parent=projects/*/locations/*}/featurestores" body: "featurestore" }; option (google.api.method_signature) = "parent,featurestore"; - option (google.api.method_signature) = "parent,featurestore,featurestore_id"; + option (google.api.method_signature) = + "parent,featurestore,featurestore_id"; option (google.longrunning.operation_info) = { response_type: "Featurestore" metadata_type: "CreateFeaturestoreOperationMetadata" @@ -67,7 +70,8 @@ service FeaturestoreService { } // Lists Featurestores in a given project and location. - rpc ListFeaturestores(ListFeaturestoresRequest) returns (ListFeaturestoresResponse) { + rpc ListFeaturestores(ListFeaturestoresRequest) + returns (ListFeaturestoresResponse) { option (google.api.http) = { get: "/v1beta1/{parent=projects/*/locations/*}/featurestores" }; @@ -75,7 +79,8 @@ service FeaturestoreService { } // Updates the parameters of a single Featurestore. - rpc UpdateFeaturestore(UpdateFeaturestoreRequest) returns (google.longrunning.Operation) { + rpc UpdateFeaturestore(UpdateFeaturestoreRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { patch: "/v1beta1/{featurestore.name=projects/*/locations/*/featurestores/*}" body: "featurestore" @@ -89,7 +94,8 @@ service FeaturestoreService { // Deletes a single Featurestore. The Featurestore must not contain any // EntityTypes or `force` must be set to true for the request to succeed. - rpc DeleteFeaturestore(DeleteFeaturestoreRequest) returns (google.longrunning.Operation) { + rpc DeleteFeaturestore(DeleteFeaturestoreRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1beta1/{name=projects/*/locations/*/featurestores/*}" }; @@ -102,7 +108,8 @@ service FeaturestoreService { } // Creates a new EntityType in a given Featurestore. - rpc CreateEntityType(CreateEntityTypeRequest) returns (google.longrunning.Operation) { + rpc CreateEntityType(CreateEntityTypeRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta1/{parent=projects/*/locations/*/featurestores/*}/entityTypes" body: "entity_type" @@ -124,7 +131,8 @@ service FeaturestoreService { } // Lists EntityTypes in a given Featurestore. - rpc ListEntityTypes(ListEntityTypesRequest) returns (ListEntityTypesResponse) { + rpc ListEntityTypes(ListEntityTypesRequest) + returns (ListEntityTypesResponse) { option (google.api.http) = { get: "/v1beta1/{parent=projects/*/locations/*/featurestores/*}/entityTypes" }; @@ -142,7 +150,8 @@ service FeaturestoreService { // Deletes a single EntityType. The EntityType must not have any Features // or `force` must be set to true for the request to succeed. - rpc DeleteEntityType(DeleteEntityTypeRequest) returns (google.longrunning.Operation) { + rpc DeleteEntityType(DeleteEntityTypeRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1beta1/{name=projects/*/locations/*/featurestores/*/entityTypes/*}" }; @@ -155,7 +164,8 @@ service FeaturestoreService { } // Creates a new Feature in a given EntityType. - rpc CreateFeature(CreateFeatureRequest) returns (google.longrunning.Operation) { + rpc CreateFeature(CreateFeatureRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta1/{parent=projects/*/locations/*/featurestores/*/entityTypes/*}/features" body: "feature" @@ -169,7 +179,8 @@ service FeaturestoreService { } // Creates a batch of Features in a given EntityType. - rpc BatchCreateFeatures(BatchCreateFeaturesRequest) returns (google.longrunning.Operation) { + rpc BatchCreateFeatures(BatchCreateFeaturesRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta1/{parent=projects/*/locations/*/featurestores/*/entityTypes/*}/features:batchCreate" body: "*" @@ -207,7 +218,8 @@ service FeaturestoreService { } // Deletes a single Feature. - rpc DeleteFeature(DeleteFeatureRequest) returns (google.longrunning.Operation) { + rpc DeleteFeature(DeleteFeatureRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1beta1/{name=projects/*/locations/*/featurestores/*/entityTypes/*/features/*}" }; @@ -238,7 +250,8 @@ service FeaturestoreService { // include but are not limited to changing storage location, storage class, // or retention policy. // - Online serving cluster is under-provisioned. - rpc ImportFeatureValues(ImportFeatureValuesRequest) returns (google.longrunning.Operation) { + rpc ImportFeatureValues(ImportFeatureValuesRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta1/{entity_type=projects/*/locations/*/featurestores/*/entityTypes/*}:importFeatureValues" body: "*" @@ -256,7 +269,8 @@ service FeaturestoreService { // 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. - rpc BatchReadFeatureValues(BatchReadFeatureValuesRequest) returns (google.longrunning.Operation) { + rpc BatchReadFeatureValues(BatchReadFeatureValuesRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta1/{featurestore=projects/*/locations/*/featurestores/*}:batchReadFeatureValues" body: "*" @@ -269,7 +283,8 @@ service FeaturestoreService { } // Exports Feature values from all the entities of a target EntityType. - rpc ExportFeatureValues(ExportFeatureValuesRequest) returns (google.longrunning.Operation) { + rpc ExportFeatureValues(ExportFeatureValuesRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta1/{entity_type=projects/*/locations/*/featurestores/*/entityTypes/*}:exportFeatureValues" body: "*" @@ -291,7 +306,8 @@ service FeaturestoreService { // returned from reads and exports may be inconsistent. If consistency is // required, the caller must retry the same delete request again and wait till // the new operation returned is marked as successfully done. - rpc DeleteFeatureValues(DeleteFeatureValuesRequest) returns (google.longrunning.Operation) { + rpc DeleteFeatureValues(DeleteFeatureValuesRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta1/{entity_type=projects/*/locations/*/featurestores/*/entityTypes/*}:deleteFeatureValues" body: "*" @@ -313,7 +329,8 @@ service FeaturestoreService { } } -// Request message for [FeaturestoreService.CreateFeaturestore][google.cloud.aiplatform.v1beta1.FeaturestoreService.CreateFeaturestore]. +// Request message for +// [FeaturestoreService.CreateFeaturestore][google.cloud.aiplatform.v1beta1.FeaturestoreService.CreateFeaturestore]. message CreateFeaturestoreRequest { // Required. The resource name of the Location to create Featurestores. // Format: @@ -328,8 +345,8 @@ message CreateFeaturestoreRequest { // Required. The Featurestore to create. Featurestore featurestore = 2 [(google.api.field_behavior) = REQUIRED]; - // Required. The ID to use for this Featurestore, which will become the final component - // of the Featurestore's resource name. + // Required. The ID to use for this Featurestore, which will become the final + // component of the Featurestore's resource name. // // This value may be up to 60 characters, and valid characters are // `[a-z0-9_]`. The first character cannot be a number. @@ -338,7 +355,8 @@ message CreateFeaturestoreRequest { string featurestore_id = 3 [(google.api.field_behavior) = REQUIRED]; } -// Request message for [FeaturestoreService.GetFeaturestore][google.cloud.aiplatform.v1beta1.FeaturestoreService.GetFeaturestore]. +// Request message for +// [FeaturestoreService.GetFeaturestore][google.cloud.aiplatform.v1beta1.FeaturestoreService.GetFeaturestore]. message GetFeaturestoreRequest { // Required. The name of the Featurestore resource. string name = 1 [ @@ -349,7 +367,8 @@ message GetFeaturestoreRequest { ]; } -// Request message for [FeaturestoreService.ListFeaturestores][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeaturestores]. +// Request message for +// [FeaturestoreService.ListFeaturestores][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeaturestores]. message ListFeaturestoresRequest { // Required. The resource name of the Location to list Featurestores. // Format: @@ -389,12 +408,12 @@ message ListFeaturestoresRequest { int32 page_size = 3; // A page token, received from a previous - // [FeaturestoreService.ListFeaturestores][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeaturestores] call. - // Provide this to retrieve the subsequent page. + // [FeaturestoreService.ListFeaturestores][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeaturestores] + // call. Provide this to retrieve the subsequent page. // // When paginating, all other parameters provided to - // [FeaturestoreService.ListFeaturestores][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeaturestores] must - // match the call that provided the page token. + // [FeaturestoreService.ListFeaturestores][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeaturestores] + // must match the call that provided the page token. string page_token = 4; // A comma-separated list of fields to order by, sorted in ascending order. @@ -410,22 +429,24 @@ message ListFeaturestoresRequest { google.protobuf.FieldMask read_mask = 6; } -// Response message for [FeaturestoreService.ListFeaturestores][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeaturestores]. +// Response message for +// [FeaturestoreService.ListFeaturestores][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeaturestores]. message ListFeaturestoresResponse { // The Featurestores matching the request. repeated Featurestore featurestores = 1; - // A token, which can be sent as [ListFeaturestoresRequest.page_token][google.cloud.aiplatform.v1beta1.ListFeaturestoresRequest.page_token] to - // retrieve the next page. - // If this field is omitted, there are no subsequent pages. + // A token, which can be sent as + // [ListFeaturestoresRequest.page_token][google.cloud.aiplatform.v1beta1.ListFeaturestoresRequest.page_token] + // to retrieve the next page. If this field is omitted, there are no + // subsequent pages. string next_page_token = 2; } -// Request message for [FeaturestoreService.UpdateFeaturestore][google.cloud.aiplatform.v1beta1.FeaturestoreService.UpdateFeaturestore]. +// Request message for +// [FeaturestoreService.UpdateFeaturestore][google.cloud.aiplatform.v1beta1.FeaturestoreService.UpdateFeaturestore]. message UpdateFeaturestoreRequest { - // Required. The Featurestore's `name` field is used to identify the Featurestore to be - // updated. - // Format: + // Required. The Featurestore's `name` field is used to identify the + // Featurestore to be updated. Format: // `projects/{project}/locations/{location}/featurestores/{featurestore}` Featurestore featurestore = 1 [(google.api.field_behavior) = REQUIRED]; @@ -442,10 +463,12 @@ message UpdateFeaturestoreRequest { // * `labels` // * `online_serving_config.fixed_node_count` // * `online_serving_config.scaling` + // * `online_storage_ttl_days` (available in Preview) google.protobuf.FieldMask update_mask = 2; } -// Request message for [FeaturestoreService.DeleteFeaturestore][google.cloud.aiplatform.v1beta1.FeaturestoreService.DeleteFeaturestore]. +// Request message for +// [FeaturestoreService.DeleteFeaturestore][google.cloud.aiplatform.v1beta1.FeaturestoreService.DeleteFeaturestore]. message DeleteFeaturestoreRequest { // Required. The name of the Featurestore to be deleted. // Format: @@ -463,12 +486,13 @@ message DeleteFeaturestoreRequest { bool force = 2; } -// Request message for [FeaturestoreService.ImportFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreService.ImportFeatureValues]. +// Request message for +// [FeaturestoreService.ImportFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreService.ImportFeatureValues]. message ImportFeatureValuesRequest { // Defines the Feature value(s) to import. message FeatureSpec { - // Required. ID of the Feature to import values of. This Feature must exist in the - // target EntityType, or the request will fail. + // Required. ID of the Feature to import values of. This Feature must exist + // in the target EntityType, or the request will fail. string id = 1 [(google.api.field_behavior) = REQUIRED]; // Source column to get the Feature values from. If not set, uses the column @@ -498,8 +522,8 @@ message ImportFeatureValuesRequest { google.protobuf.Timestamp feature_time = 7; } - // Required. The resource name of the EntityType grouping the Features for which values - // are being imported. Format: + // Required. The resource name of the EntityType grouping the Features for + // which values are being imported. Format: // `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}` string entity_type = 1 [ (google.api.field_behavior) = REQUIRED, @@ -512,10 +536,11 @@ message ImportFeatureValuesRequest { // extracted from the column named `entity_id`. string entity_id_field = 5; - // Required. Specifications defining which Feature values to import from the entity. The - // request fails if no feature_specs are provided, and having multiple - // feature_specs for one Feature is not allowed. - repeated FeatureSpec feature_specs = 8 [(google.api.field_behavior) = REQUIRED]; + // Required. Specifications defining which Feature values to import from the + // entity. The request fails if no feature_specs are provided, and having + // multiple feature_specs for one Feature is not allowed. + repeated FeatureSpec feature_specs = 8 + [(google.api.field_behavior) = REQUIRED]; // If set, data will not be imported for online serving. This // is typically used for backfilling, where Feature generation timestamps are @@ -534,7 +559,8 @@ message ImportFeatureValuesRequest { bool disable_ingestion_analysis = 12; } -// Response message for [FeaturestoreService.ImportFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreService.ImportFeatureValues]. +// Response message for +// [FeaturestoreService.ImportFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreService.ImportFeatureValues]. message ImportFeatureValuesResponse { // Number of entities that have been imported by the operation. int64 imported_entity_count = 1; @@ -554,25 +580,30 @@ message ImportFeatureValuesResponse { int64 timestamp_outside_retention_rows_count = 4; } -// Request message for [FeaturestoreService.BatchReadFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreService.BatchReadFeatureValues]. +// Request message for +// [FeaturestoreService.BatchReadFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreService.BatchReadFeatureValues]. message BatchReadFeatureValuesRequest { // Describe pass-through fields in read_instance source. message PassThroughField { - // Required. The name of the field in the CSV header or the name of the column in - // BigQuery table. The naming restriction is the same as [Feature.name][google.cloud.aiplatform.v1beta1.Feature.name]. + // Required. The name of the field in the CSV header or the name of the + // column in BigQuery table. The naming restriction is the same as + // [Feature.name][google.cloud.aiplatform.v1beta1.Feature.name]. string field_name = 1 [(google.api.field_behavior) = REQUIRED]; } // Selects Features of an EntityType to read values of and specifies read // settings. message EntityTypeSpec { - // Required. ID of the EntityType to select Features. The EntityType id is the - // [entity_type_id][google.cloud.aiplatform.v1beta1.CreateEntityTypeRequest.entity_type_id] specified - // during EntityType creation. + // Required. ID of the EntityType to select Features. The EntityType id is + // the + // [entity_type_id][google.cloud.aiplatform.v1beta1.CreateEntityTypeRequest.entity_type_id] + // specified during EntityType creation. string entity_type_id = 1 [(google.api.field_behavior) = REQUIRED]; - // Required. Selectors choosing which Feature values to read from the EntityType. - FeatureSelector feature_selector = 2 [(google.api.field_behavior) = REQUIRED]; + // Required. Selectors choosing which Feature values to read from the + // EntityType. + FeatureSelector feature_selector = 2 + [(google.api.field_behavior) = REQUIRED]; // Per-Feature settings for the batch read. repeated DestinationFeatureSetting settings = 3; @@ -609,8 +640,8 @@ message BatchReadFeatureValuesRequest { BigQuerySource bigquery_read_instances = 5; } - // Required. The resource name of the Featurestore from which to query Feature values. - // Format: + // Required. The resource name of the Featurestore from which to query Feature + // values. Format: // `projects/{project}/locations/{location}/featurestores/{featurestore}` string featurestore = 1 [ (google.api.field_behavior) = REQUIRED, @@ -620,7 +651,8 @@ message BatchReadFeatureValuesRequest { ]; // Required. Specifies output location and format. - FeatureValueDestination destination = 4 [(google.api.field_behavior) = REQUIRED]; + FeatureValueDestination destination = 4 + [(google.api.field_behavior) = REQUIRED]; // When not empty, the specified fields in the *_read_instances source will be // joined as-is in the output, in addition to those fields from the @@ -631,15 +663,23 @@ message BatchReadFeatureValuesRequest { // passed as opaque bytes. repeated PassThroughField pass_through_fields = 8; - // Required. Specifies EntityType grouping Features to read values of and settings. - // Each EntityType referenced in + // Required. Specifies EntityType grouping Features to read values of and + // settings. Each EntityType referenced in // [BatchReadFeatureValuesRequest.entity_type_specs] must have a column // specifying entity IDs in the EntityType in // [BatchReadFeatureValuesRequest.request][] . - repeated EntityTypeSpec entity_type_specs = 7 [(google.api.field_behavior) = REQUIRED]; + repeated EntityTypeSpec entity_type_specs = 7 + [(google.api.field_behavior) = REQUIRED]; + + // Optional. Excludes Feature values with feature generation timestamp before + // this timestamp. If not set, retrieve oldest values kept in Feature Store. + // Timestamp, if present, must not have higher than millisecond precision. + google.protobuf.Timestamp start_time = 11 + [(google.api.field_behavior) = OPTIONAL]; } -// Request message for [FeaturestoreService.ExportFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreService.ExportFeatureValues]. +// Request message for +// [FeaturestoreService.ExportFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreService.ExportFeatureValues]. message ExportFeatureValuesRequest { // Describes exporting the latest Feature values of all entities of the // EntityType between [start_time, snapshot_time]. @@ -680,8 +720,8 @@ message ExportFeatureValuesRequest { FullExport full_export = 7; } - // Required. The resource name of the EntityType from which to export Feature values. - // Format: + // Required. The resource name of the EntityType from which to export Feature + // values. Format: // `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` string entity_type = 1 [ (google.api.field_behavior) = REQUIRED, @@ -691,7 +731,8 @@ message ExportFeatureValuesRequest { ]; // Required. Specifies destination location and format. - FeatureValueDestination destination = 4 [(google.api.field_behavior) = REQUIRED]; + FeatureValueDestination destination = 4 + [(google.api.field_behavior) = REQUIRED]; // Required. Selects Features to export values of. FeatureSelector feature_selector = 5 [(google.api.field_behavior) = REQUIRED]; @@ -713,8 +754,10 @@ message DestinationFeatureSetting { message FeatureValueDestination { oneof destination { // Output in BigQuery format. - // [BigQueryDestination.output_uri][google.cloud.aiplatform.v1beta1.BigQueryDestination.output_uri] in - // [FeatureValueDestination.bigquery_destination][google.cloud.aiplatform.v1beta1.FeatureValueDestination.bigquery_destination] must refer to a table. + // [BigQueryDestination.output_uri][google.cloud.aiplatform.v1beta1.BigQueryDestination.output_uri] + // in + // [FeatureValueDestination.bigquery_destination][google.cloud.aiplatform.v1beta1.FeatureValueDestination.bigquery_destination] + // must refer to a table. BigQueryDestination bigquery_destination = 1; // Output in TFRecord format. @@ -736,17 +779,16 @@ message FeatureValueDestination { } } -// Response message for [FeaturestoreService.ExportFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreService.ExportFeatureValues]. -message ExportFeatureValuesResponse { - -} - -// Response message for [FeaturestoreService.BatchReadFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreService.BatchReadFeatureValues]. -message BatchReadFeatureValuesResponse { +// Response message for +// [FeaturestoreService.ExportFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreService.ExportFeatureValues]. +message ExportFeatureValuesResponse {} -} +// Response message for +// [FeaturestoreService.BatchReadFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreService.BatchReadFeatureValues]. +message BatchReadFeatureValuesResponse {} -// Request message for [FeaturestoreService.CreateEntityType][google.cloud.aiplatform.v1beta1.FeaturestoreService.CreateEntityType]. +// Request message for +// [FeaturestoreService.CreateEntityType][google.cloud.aiplatform.v1beta1.FeaturestoreService.CreateEntityType]. message CreateEntityTypeRequest { // Required. The resource name of the Featurestore to create EntityTypes. // Format: @@ -761,8 +803,8 @@ message CreateEntityTypeRequest { // The EntityType to create. EntityType entity_type = 2; - // Required. The ID to use for the EntityType, which will become the final component of - // the EntityType's resource name. + // Required. The ID to use for the EntityType, which will become the final + // component of the EntityType's resource name. // // This value may be up to 60 characters, and valid characters are // `[a-z0-9_]`. The first character cannot be a number. @@ -771,7 +813,8 @@ message CreateEntityTypeRequest { string entity_type_id = 3 [(google.api.field_behavior) = REQUIRED]; } -// Request message for [FeaturestoreService.GetEntityType][google.cloud.aiplatform.v1beta1.FeaturestoreService.GetEntityType]. +// Request message for +// [FeaturestoreService.GetEntityType][google.cloud.aiplatform.v1beta1.FeaturestoreService.GetEntityType]. message GetEntityTypeRequest { // Required. The name of the EntityType resource. // Format: @@ -784,7 +827,8 @@ message GetEntityTypeRequest { ]; } -// Request message for [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes]. +// Request message for +// [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes]. message ListEntityTypesRequest { // Required. The resource name of the Featurestore to list EntityTypes. // Format: @@ -823,12 +867,12 @@ message ListEntityTypesRequest { int32 page_size = 3; // A page token, received from a previous - // [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes] call. - // Provide this to retrieve the subsequent page. + // [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes] + // call. Provide this to retrieve the subsequent page. // // When paginating, all other parameters provided to - // [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes] must - // match the call that provided the page token. + // [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes] + // must match the call that provided the page token. string page_token = 4; // A comma-separated list of fields to order by, sorted in ascending order. @@ -845,22 +889,24 @@ message ListEntityTypesRequest { google.protobuf.FieldMask read_mask = 6; } -// Response message for [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes]. +// Response message for +// [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes]. message ListEntityTypesResponse { // The EntityTypes matching the request. repeated EntityType entity_types = 1; - // A token, which can be sent as [ListEntityTypesRequest.page_token][google.cloud.aiplatform.v1beta1.ListEntityTypesRequest.page_token] to - // retrieve the next page. - // If this field is omitted, there are no subsequent pages. + // A token, which can be sent as + // [ListEntityTypesRequest.page_token][google.cloud.aiplatform.v1beta1.ListEntityTypesRequest.page_token] + // to retrieve the next page. If this field is omitted, there are no + // subsequent pages. string next_page_token = 2; } -// Request message for [FeaturestoreService.UpdateEntityType][google.cloud.aiplatform.v1beta1.FeaturestoreService.UpdateEntityType]. +// Request message for +// [FeaturestoreService.UpdateEntityType][google.cloud.aiplatform.v1beta1.FeaturestoreService.UpdateEntityType]. message UpdateEntityTypeRequest { - // Required. The EntityType's `name` field is used to identify the EntityType to be - // updated. - // Format: + // Required. The EntityType's `name` field is used to identify the EntityType + // to be updated. Format: // `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` EntityType entity_type = 1 [(google.api.field_behavior) = REQUIRED]; @@ -883,6 +929,7 @@ message UpdateEntityTypeRequest { // * `monitoring_config.import_features_analysis.anomaly_detection_baseline` // * `monitoring_config.numerical_threshold_config.value` // * `monitoring_config.categorical_threshold_config.value` + // * `offline_storage_ttl_days` (available in Preview) google.protobuf.FieldMask update_mask = 2; } @@ -903,7 +950,8 @@ message DeleteEntityTypeRequest { bool force = 2; } -// Request message for [FeaturestoreService.CreateFeature][google.cloud.aiplatform.v1beta1.FeaturestoreService.CreateFeature]. +// Request message for +// [FeaturestoreService.CreateFeature][google.cloud.aiplatform.v1beta1.FeaturestoreService.CreateFeature]. message CreateFeatureRequest { // Required. The resource name of the EntityType to create a Feature. // Format: @@ -918,20 +966,21 @@ message CreateFeatureRequest { // Required. The Feature to create. Feature feature = 2 [(google.api.field_behavior) = REQUIRED]; - // Required. The ID to use for the Feature, which will become the final component of - // the Feature's resource name. + // Required. The ID to use for the Feature, which will become the final + // component of the Feature's resource name. // - // This value may be up to 60 characters, and valid characters are + // This value may be up to 128 characters, and valid characters are // `[a-z0-9_]`. The first character cannot be a number. // // The value must be unique within an EntityType. string feature_id = 3 [(google.api.field_behavior) = REQUIRED]; } -// Request message for [FeaturestoreService.BatchCreateFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.BatchCreateFeatures]. +// Request message for +// [FeaturestoreService.BatchCreateFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.BatchCreateFeatures]. message BatchCreateFeaturesRequest { - // Required. The resource name of the EntityType to create the batch of Features under. - // Format: + // Required. The resource name of the EntityType to create the batch of + // Features under. Format: // `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, @@ -940,20 +989,24 @@ message BatchCreateFeaturesRequest { } ]; - // Required. The request message specifying the Features to create. All Features must be - // created under the same parent EntityType. The `parent` field in each child - // request message can be omitted. If `parent` is set in a child request, then - // the value must match the `parent` value in this request message. - repeated CreateFeatureRequest requests = 2 [(google.api.field_behavior) = REQUIRED]; + // Required. The request message specifying the Features to create. All + // Features must be created under the same parent EntityType. The `parent` + // field in each child request message can be omitted. If `parent` is set in a + // child request, then the value must match the `parent` value in this request + // message. + repeated CreateFeatureRequest requests = 2 + [(google.api.field_behavior) = REQUIRED]; } -// Response message for [FeaturestoreService.BatchCreateFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.BatchCreateFeatures]. +// Response message for +// [FeaturestoreService.BatchCreateFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.BatchCreateFeatures]. message BatchCreateFeaturesResponse { // The Features created. repeated Feature features = 1; } -// Request message for [FeaturestoreService.GetFeature][google.cloud.aiplatform.v1beta1.FeaturestoreService.GetFeature]. +// Request message for +// [FeaturestoreService.GetFeature][google.cloud.aiplatform.v1beta1.FeaturestoreService.GetFeature]. message GetFeatureRequest { // Required. The name of the Feature resource. // Format: @@ -966,7 +1019,8 @@ message GetFeatureRequest { ]; } -// Request message for [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures]. +// Request message for +// [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures]. message ListFeaturesRequest { // Required. The resource name of the Location to list Features. // Format: @@ -1007,12 +1061,12 @@ message ListFeaturesRequest { int32 page_size = 3; // A page token, received from a previous - // [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures] call. - // Provide this to retrieve the subsequent page. + // [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures] + // call. Provide this to retrieve the subsequent page. // // When paginating, all other parameters provided to - // [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures] must - // match the call that provided the page token. + // [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures] + // must match the call that provided the page token. string page_token = 4; // A comma-separated list of fields to order by, sorted in ascending order. @@ -1028,25 +1082,30 @@ message ListFeaturesRequest { // Mask specifying which fields to read. google.protobuf.FieldMask read_mask = 6; - // If set, return the most recent [ListFeaturesRequest.latest_stats_count][google.cloud.aiplatform.v1beta1.ListFeaturesRequest.latest_stats_count] + // If set, return the most recent + // [ListFeaturesRequest.latest_stats_count][google.cloud.aiplatform.v1beta1.ListFeaturesRequest.latest_stats_count] // of stats for each Feature in response. Valid value is [0, 10]. If number of - // stats exists < [ListFeaturesRequest.latest_stats_count][google.cloud.aiplatform.v1beta1.ListFeaturesRequest.latest_stats_count], return all - // existing stats. + // stats exists < + // [ListFeaturesRequest.latest_stats_count][google.cloud.aiplatform.v1beta1.ListFeaturesRequest.latest_stats_count], + // return all existing stats. int32 latest_stats_count = 7; } -// Response message for [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures]. +// Response message for +// [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures]. message ListFeaturesResponse { // The Features matching the request. repeated Feature features = 1; - // A token, which can be sent as [ListFeaturesRequest.page_token][google.cloud.aiplatform.v1beta1.ListFeaturesRequest.page_token] to - // retrieve the next page. - // If this field is omitted, there are no subsequent pages. + // A token, which can be sent as + // [ListFeaturesRequest.page_token][google.cloud.aiplatform.v1beta1.ListFeaturesRequest.page_token] + // to retrieve the next page. If this field is omitted, there are no + // subsequent pages. string next_page_token = 2; } -// Request message for [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures]. +// Request message for +// [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures]. message SearchFeaturesRequest { // Required. The resource name of the Location to search Features. // Format: @@ -1126,16 +1185,17 @@ message SearchFeaturesRequest { int32 page_size = 4; // A page token, received from a previous - // [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures] call. - // Provide this to retrieve the subsequent page. + // [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures] + // call. Provide this to retrieve the subsequent page. // // When paginating, all other parameters provided to - // [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures], except `page_size`, must - // match the call that provided the page token. + // [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures], + // except `page_size`, must match the call that provided the page token. string page_token = 5; } -// Response message for [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures]. +// Response message for +// [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures]. message SearchFeaturesResponse { // The Features matching the request. // @@ -1148,13 +1208,15 @@ message SearchFeaturesResponse { // * `update_time` repeated Feature features = 1; - // A token, which can be sent as [SearchFeaturesRequest.page_token][google.cloud.aiplatform.v1beta1.SearchFeaturesRequest.page_token] to - // retrieve the next page. - // If this field is omitted, there are no subsequent pages. + // A token, which can be sent as + // [SearchFeaturesRequest.page_token][google.cloud.aiplatform.v1beta1.SearchFeaturesRequest.page_token] + // to retrieve the next page. If this field is omitted, there are no + // subsequent pages. string next_page_token = 2; } -// Request message for [FeaturestoreService.UpdateFeature][google.cloud.aiplatform.v1beta1.FeaturestoreService.UpdateFeature]. +// Request message for +// [FeaturestoreService.UpdateFeature][google.cloud.aiplatform.v1beta1.FeaturestoreService.UpdateFeature]. message UpdateFeatureRequest { // Required. The Feature's `name` field is used to identify the Feature to be // updated. @@ -1178,7 +1240,8 @@ message UpdateFeatureRequest { google.protobuf.FieldMask update_mask = 2; } -// Request message for [FeaturestoreService.DeleteFeature][google.cloud.aiplatform.v1beta1.FeaturestoreService.DeleteFeature]. +// Request message for +// [FeaturestoreService.DeleteFeature][google.cloud.aiplatform.v1beta1.FeaturestoreService.DeleteFeature]. message DeleteFeatureRequest { // Required. The name of the Features to be deleted. // Format: @@ -1214,6 +1277,9 @@ message ImportFeatureValuesOperationMetadata { // Number of Feature values that have been imported by the operation. int64 imported_feature_value_count = 3; + // The source URI from where Feature values are imported. + repeated string source_uris = 4; + // The number of rows in input source that weren't imported due to either // * Not having any featureValues. // * Having a null entityId. @@ -1262,28 +1328,35 @@ message BatchCreateFeaturesOperationMetadata { GenericOperationMetadata generic_metadata = 1; } -// Request message for [FeaturestoreService.DeleteFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreService.DeleteFeatureValues]. +// Request message for +// [FeaturestoreService.DeleteFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreService.DeleteFeatureValues]. message DeleteFeatureValuesRequest { // Message to select entity. // If an entity id is selected, all the feature values corresponding to the // entity id will be deleted, including the entityId. message SelectEntity { - // Required. Selectors choosing feature values of which entity id to be deleted from - // the EntityType. - EntityIdSelector entity_id_selector = 1 [(google.api.field_behavior) = REQUIRED]; + // Required. Selectors choosing feature values of which entity id to be + // deleted from the EntityType. + EntityIdSelector entity_id_selector = 1 + [(google.api.field_behavior) = REQUIRED]; } // Message to select time range and feature. // Values of the selected feature generated within an inclusive time range - // will be deleted. + // will be deleted. Using this option permanently deletes the feature values + // from the specified feature IDs within the specified time range. + // This might include data from the online storage. If you want to retain + // any deleted historical data in the online storage, you must re-ingest it. message SelectTimeRangeAndFeature { // Required. Select feature generated within a half-inclusive time range. // The time range is lower inclusive and upper exclusive. - google.type.Interval time_range = 1 [(google.api.field_behavior) = REQUIRED]; + google.type.Interval time_range = 1 + [(google.api.field_behavior) = REQUIRED]; // Required. Selectors choosing which feature values to be deleted from the // EntityType. - FeatureSelector feature_selector = 2 [(google.api.field_behavior) = REQUIRED]; + FeatureSelector feature_selector = 2 + [(google.api.field_behavior) = REQUIRED]; // If set, data will not be deleted from online storage. // When time range is older than the data in online storage, setting this to @@ -1301,8 +1374,8 @@ message DeleteFeatureValuesRequest { SelectTimeRangeAndFeature select_time_range_and_feature = 3; } - // Required. The resource name of the EntityType grouping the Features for which values - // are being deleted from. Format: + // Required. The resource name of the EntityType grouping the Features for + // which values are being deleted from. Format: // `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}` string entity_type = 1 [ (google.api.field_behavior) = REQUIRED, @@ -1312,10 +1385,9 @@ message DeleteFeatureValuesRequest { ]; } -// Response message for [FeaturestoreService.DeleteFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreService.DeleteFeatureValues]. -message DeleteFeatureValuesResponse { - -} +// Response message for +// [FeaturestoreService.DeleteFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreService.DeleteFeatureValues]. +message DeleteFeatureValuesResponse {} // Selector for entityId. Getting ids from the given source. message EntityIdSelector { diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/hyperparameter_tuning_job.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/hyperparameter_tuning_job.proto index 4e994e1e726..ac5d551570e 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/hyperparameter_tuning_job.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/hyperparameter_tuning_job.proto @@ -46,7 +46,7 @@ message HyperparameterTuningJob { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. The display name of the HyperparameterTuningJob. - // The name can be up to 128 characters long and can be consist of any UTF-8 + // The name can be up to 128 characters long and can consist of any UTF-8 // characters. string display_name = 2 [(google.api.field_behavior) = REQUIRED]; @@ -66,8 +66,8 @@ message HyperparameterTuningJob { // before the whole job fails. int32 max_failed_trial_count = 7; - // Required. The spec of a trial job. The same spec applies to the CustomJobs created - // in all the trials. + // Required. The spec of a trial job. The same spec applies to the CustomJobs + // created in all the trials. CustomJobSpec trial_job_spec = 8 [(google.api.field_behavior) = REQUIRED]; // Output only. Trials of the HyperparameterTuningJob. @@ -77,18 +77,24 @@ message HyperparameterTuningJob { JobState state = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Time when the HyperparameterTuningJob was created. - google.protobuf.Timestamp create_time = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. Time when the HyperparameterTuningJob for the first time entered the - // `JOB_STATE_RUNNING` state. - google.protobuf.Timestamp start_time = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. Time when the HyperparameterTuningJob entered any of the following states: - // `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`. - google.protobuf.Timestamp end_time = 13 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. Time when the HyperparameterTuningJob was most recently updated. - google.protobuf.Timestamp update_time = 14 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 11 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Time when the HyperparameterTuningJob for the first time + // entered the `JOB_STATE_RUNNING` state. + google.protobuf.Timestamp start_time = 12 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Time when the HyperparameterTuningJob entered any of the + // following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, + // `JOB_STATE_CANCELLED`. + google.protobuf.Timestamp end_time = 13 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Time when the HyperparameterTuningJob was most recently + // updated. + google.protobuf.Timestamp update_time = 14 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Only populated when job's state is JOB_STATE_FAILED or // JOB_STATE_CANCELLED. diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/index.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/index.proto index f0e3c67a05f..279c421d883 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/index.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/index.proto @@ -57,17 +57,17 @@ message Index { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. The display name of the Index. - // The name can be up to 128 characters long and can be consist of any UTF-8 + // The name can be up to 128 characters long and can consist of any UTF-8 // characters. string display_name = 2 [(google.api.field_behavior) = REQUIRED]; // The description of the Index. string description = 3; - // Immutable. Points to a YAML file stored on Google Cloud Storage describing additional - // information about the Index, that is specific to it. Unset if the Index - // does not have any additional information. - // The schema is defined as an OpenAPI 3.0.2 [Schema + // Immutable. Points to a YAML file stored on Google Cloud Storage describing + // additional information about the Index, that is specific to it. Unset if + // the Index does not have any additional information. The schema is defined + // as an OpenAPI 3.0.2 [Schema // Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). // Note: The URI given on output will be immutable and probably different, // including the URI scheme, than the one given on input. The output URI will @@ -75,13 +75,15 @@ message Index { string metadata_schema_uri = 4 [(google.api.field_behavior) = IMMUTABLE]; // An additional information about the Index; the schema of the metadata can - // be found in [metadata_schema][google.cloud.aiplatform.v1beta1.Index.metadata_schema_uri]. + // be found in + // [metadata_schema][google.cloud.aiplatform.v1beta1.Index.metadata_schema_uri]. google.protobuf.Value metadata = 6; // Output only. The pointers to DeployedIndexes created from this Index. // An Index can be only deleted if all its DeployedIndexes had been undeployed // first. - repeated DeployedIndexRef deployed_indexes = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + repeated DeployedIndexRef deployed_indexes = 7 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Used to perform consistent read-modify-write updates. If not set, a blind // "overwrite" update happens. @@ -97,24 +99,27 @@ message Index { map labels = 9; // Output only. Timestamp when this Index was created. - google.protobuf.Timestamp create_time = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 10 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this Index was most recently updated. // This also includes any update to the contents of the Index. // Note that Operations working on this Index may have their // [Operations.metadata.generic_metadata.update_time] - // [google.cloud.aiplatform.v1beta1.GenericOperationMetadata.update_time] a little after the value of this - // timestamp, yet that does not mean their results are not already reflected - // in the Index. Result of any successfully completed Operation on the Index - // is reflected in it. - google.protobuf.Timestamp update_time = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; + // [google.cloud.aiplatform.v1beta1.GenericOperationMetadata.update_time] a + // little after the value of this timestamp, yet that does not mean their + // results are not already reflected in the Index. Result of any successfully + // completed Operation on the Index is reflected in it. + google.protobuf.Timestamp update_time = 11 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Stats of the index resource. IndexStats index_stats = 14 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be - // used by default. - IndexUpdateMethod index_update_method = 16 [(google.api.field_behavior) = IMMUTABLE]; + // Immutable. The update method to use with this Index. If not set, + // BATCH_UPDATE will be used by default. + IndexUpdateMethod index_update_method = 16 + [(google.api.field_behavior) = IMMUTABLE]; } // A datapoint of Index. @@ -151,14 +156,14 @@ message IndexDatapoint { // [NearestNeighborSearchConfig.dimensions]. repeated float feature_vector = 2 [(google.api.field_behavior) = REQUIRED]; - // Optional. List of Restrict of the datapoint, used to perform "restricted searches" - // where boolean rule are used to filter the subset of the database eligible - // for matching. - // See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering + // Optional. List of Restrict of the datapoint, used to perform "restricted + // searches" where boolean rule are used to filter the subset of the database + // eligible for matching. See: + // https://cloud.google.com/vertex-ai/docs/matching-engine/filtering repeated Restriction restricts = 4 [(google.api.field_behavior) = OPTIONAL]; - // Optional. CrowdingTag of the datapoint, the number of neighbors to return in each - // crowding can be configured during query. + // Optional. CrowdingTag of the datapoint, the number of neighbors to return + // in each crowding can be configured during query. CrowdingTag crowding_tag = 5 [(google.api.field_behavior) = OPTIONAL]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/index_endpoint.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/index_endpoint.proto index 3f8fa62b2d3..2230eae354a 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/index_endpoint.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/index_endpoint.proto @@ -49,7 +49,8 @@ message IndexEndpoint { string description = 3; // Output only. The indexes deployed in this endpoint. - repeated DeployedIndex deployed_indexes = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + repeated DeployedIndex deployed_indexes = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Used to perform consistent read-modify-write updates. If not set, a blind // "overwrite" update happens. @@ -65,13 +66,15 @@ message IndexEndpoint { map labels = 6; // Output only. Timestamp when this IndexEndpoint was created. - google.protobuf.Timestamp create_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 7 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this IndexEndpoint was last updated. // This timestamp is not updated when the endpoint's DeployedIndexes are // updated, e.g. due to updates of the original Indexes they are the // deployments of. - google.protobuf.Timestamp update_time = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 8 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Optional. The full name of the Google Compute Engine // [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) @@ -85,20 +88,20 @@ message IndexEndpoint { // are mutually exclusive. // // [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): - // projects/{project}/global/networks/{network}. + // `projects/{project}/global/networks/{network}`. // Where {project} is a project number, as in '12345', and {network} is // network name. string network = 9 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Deprecated: If true, expose the IndexEndpoint via private service connect. + // Optional. Deprecated: If true, expose the IndexEndpoint via private service + // connect. // - // Only one of the fields, [network][google.cloud.aiplatform.v1beta1.IndexEndpoint.network] or + // Only one of the fields, + // [network][google.cloud.aiplatform.v1beta1.IndexEndpoint.network] or // [enable_private_service_connect][google.cloud.aiplatform.v1beta1.IndexEndpoint.enable_private_service_connect], // can be set. - bool enable_private_service_connect = 10 [ - deprecated = true, - (google.api.field_behavior) = OPTIONAL - ]; + bool enable_private_service_connect = 10 + [deprecated = true, (google.api.field_behavior) = OPTIONAL]; } // A deployment of an Index. IndexEndpoints contain one or more DeployedIndexes. @@ -123,20 +126,25 @@ message DeployedIndex { string display_name = 3; // Output only. Timestamp when the DeployedIndex was created. - google.protobuf.Timestamp create_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. Provides paths for users to send requests directly to the deployed index - // services running on Cloud via private services access. This field is - // populated if [network][google.cloud.aiplatform.v1beta1.IndexEndpoint.network] is configured. - IndexPrivateEndpoints private_endpoints = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. The DeployedIndex may depend on various data on its original Index. - // Additionally when certain changes to the original Index are being done - // (e.g. when what the Index contains is being changed) the DeployedIndex may - // be asynchronously updated in the background to reflect this changes. - // If this timestamp's value is at least the [Index.update_time][google.cloud.aiplatform.v1beta1.Index.update_time] of the - // original Index, it means that this DeployedIndex and the original Index are - // in sync. If this timestamp is older, then to see which updates this + google.protobuf.Timestamp create_time = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. Provides paths for users to send requests directly to the + // deployed index services running on Cloud via private services access. This + // field is populated if + // [network][google.cloud.aiplatform.v1beta1.IndexEndpoint.network] is + // configured. + IndexPrivateEndpoints private_endpoints = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The DeployedIndex may depend on various data on its original + // Index. Additionally when certain changes to the original Index are being + // done (e.g. when what the Index contains is being changed) the DeployedIndex + // may be asynchronously updated in the background to reflect this changes. If + // this timestamp's value is at least the + // [Index.update_time][google.cloud.aiplatform.v1beta1.Index.update_time] of + // the original Index, it means that this DeployedIndex and the original Index + // are in sync. If this timestamp is older, then to see which updates this // DeployedIndex already contains (and which not), one must // [list][Operations.ListOperations] [Operations][Operation] // [working][Operation.name] on the original Index. Only @@ -144,30 +152,41 @@ message DeployedIndex { // [Operations.metadata.generic_metadata.update_time] // [google.cloud.aiplatform.v1beta1.GenericOperationMetadata.update_time] // equal or before this sync time are contained in this DeployedIndex. - google.protobuf.Timestamp index_sync_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp index_sync_time = 6 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Optional. A description of resources that the DeployedIndex uses, which to large - // degree are decided by Vertex AI, and optionally allows only a modest + // Optional. A description of resources that the DeployedIndex uses, which to + // large degree are decided by Vertex AI, and optionally allows only a modest // additional configuration. // If min_replica_count is not set, the default value is 2 (we don't provide // SLA when min_replica_count=1). If max_replica_count is not set, the // default value is min_replica_count. The max allowed replica count is // 1000. - AutomaticResources automatic_resources = 7 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. A description of resources that are dedicated to the DeployedIndex, and - // that need a higher degree of manual configuration. - // If min_replica_count is not set, the default value is 2 (we don't provide - // SLA when min_replica_count=1). If max_replica_count is not set, the - // default value is min_replica_count. The max allowed replica count is - // 1000. + AutomaticResources automatic_resources = 7 + [(google.api.field_behavior) = OPTIONAL]; + + // Optional. A description of resources that are dedicated to the + // DeployedIndex, and that need a higher degree of manual configuration. If + // min_replica_count is not set, the default value is 2 (we don't provide SLA + // when min_replica_count=1). If max_replica_count is not set, the default + // value is min_replica_count. The max allowed replica count is 1000. + // + // Available machine types for SMALL shard: + // e2-standard-2 and all machine types available for MEDIUM and LARGE shard. + // + // Available machine types for MEDIUM shard: + // e2-standard-16 and all machine types available for LARGE shard. + // + // Available machine types for LARGE shard: + // e2-standard-32, e2-highmem-16, n2d-standard-32. // - // Available machine types: - // n1-standard-16 - // n1-standard-32 - DedicatedResources dedicated_resources = 16 [(google.api.field_behavior) = OPTIONAL]; + // n1-standard-16 and n1-standard-32 are still available, but we recommend + // e2-standard-16 and e2-standard-32 for cost efficiency. + DedicatedResources dedicated_resources = 16 + [(google.api.field_behavior) = OPTIONAL]; - // Optional. If true, private endpoint's access logs are sent to StackDriver Logging. + // Optional. If true, private endpoint's access logs are sent to StackDriver + // Logging. // // These logs are like standard server access logs, containing // information like timestamp and latency for each MatchRequest. @@ -178,7 +197,8 @@ message DeployedIndex { bool enable_access_logging = 8 [(google.api.field_behavior) = OPTIONAL]; // Optional. If set, the authentication is enabled for the private endpoint. - DeployedIndexAuthConfig deployed_index_auth_config = 9 [(google.api.field_behavior) = OPTIONAL]; + DeployedIndexAuthConfig deployed_index_auth_config = 9 + [(google.api.field_behavior) = OPTIONAL]; // Optional. A list of reserved ip ranges under the VPC network that can be // used for this DeployedIndex. @@ -190,7 +210,8 @@ message DeployedIndex { // The value sohuld be the name of the address // (https://cloud.google.com/compute/docs/reference/rest/v1/addresses) // Example: 'vertex-ai-ip-range'. - repeated string reserved_ip_ranges = 10 [(google.api.field_behavior) = OPTIONAL]; + repeated string reserved_ip_ranges = 10 + [(google.api.field_behavior) = OPTIONAL]; // Optional. The deployment group can be no longer than 64 characters (eg: // 'test', 'prod'). If not set, we will use the 'default' deployment group. @@ -239,7 +260,7 @@ message IndexPrivateEndpoints { // Output only. The ip address used to send match gRPC requests. string match_grpc_address = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. The name of the service attachment resource. Populated if private service - // connect is enabled. + // Output only. The name of the service attachment resource. Populated if + // private service connect is enabled. string service_attachment = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/index_endpoint_service.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/index_endpoint_service.proto index c688741fa2d..27e5e374d7a 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/index_endpoint_service.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/index_endpoint_service.proto @@ -36,10 +36,12 @@ option ruby_package = "Google::Cloud::AIPlatform::V1beta1"; // A service for managing Vertex AI's IndexEndpoints. service IndexEndpointService { option (google.api.default_host) = "aiplatform.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/cloud-platform"; // Creates an IndexEndpoint. - rpc CreateIndexEndpoint(CreateIndexEndpointRequest) returns (google.longrunning.Operation) { + rpc CreateIndexEndpoint(CreateIndexEndpointRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta1/{parent=projects/*/locations/*}/indexEndpoints" body: "index_endpoint" @@ -60,7 +62,8 @@ service IndexEndpointService { } // Lists IndexEndpoints in a Location. - rpc ListIndexEndpoints(ListIndexEndpointsRequest) returns (ListIndexEndpointsResponse) { + rpc ListIndexEndpoints(ListIndexEndpointsRequest) + returns (ListIndexEndpointsResponse) { option (google.api.http) = { get: "/v1beta1/{parent=projects/*/locations/*}/indexEndpoints" }; @@ -77,7 +80,8 @@ service IndexEndpointService { } // Deletes an IndexEndpoint. - rpc DeleteIndexEndpoint(DeleteIndexEndpointRequest) returns (google.longrunning.Operation) { + rpc DeleteIndexEndpoint(DeleteIndexEndpointRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1beta1/{name=projects/*/locations/*/indexEndpoints/*}" }; @@ -105,7 +109,8 @@ service IndexEndpointService { // Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, // and freeing all resources it's using. - rpc UndeployIndex(UndeployIndexRequest) returns (google.longrunning.Operation) { + rpc UndeployIndex(UndeployIndexRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta1/{index_endpoint=projects/*/locations/*/indexEndpoints/*}:undeployIndex" body: "*" @@ -118,7 +123,8 @@ service IndexEndpointService { } // Update an existing DeployedIndex under an IndexEndpoint. - rpc MutateDeployedIndex(MutateDeployedIndexRequest) returns (google.longrunning.Operation) { + rpc MutateDeployedIndex(MutateDeployedIndexRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta1/{index_endpoint=projects/*/locations/*/indexEndpoints/*}:mutateDeployedIndex" body: "deployed_index" @@ -131,7 +137,8 @@ service IndexEndpointService { } } -// Request message for [IndexEndpointService.CreateIndexEndpoint][google.cloud.aiplatform.v1beta1.IndexEndpointService.CreateIndexEndpoint]. +// Request message for +// [IndexEndpointService.CreateIndexEndpoint][google.cloud.aiplatform.v1beta1.IndexEndpointService.CreateIndexEndpoint]. message CreateIndexEndpointRequest { // Required. The resource name of the Location to create the IndexEndpoint in. // Format: `projects/{project}/locations/{location}` @@ -153,7 +160,8 @@ message CreateIndexEndpointOperationMetadata { GenericOperationMetadata generic_metadata = 1; } -// Request message for [IndexEndpointService.GetIndexEndpoint][google.cloud.aiplatform.v1beta1.IndexEndpointService.GetIndexEndpoint] +// Request message for +// [IndexEndpointService.GetIndexEndpoint][google.cloud.aiplatform.v1beta1.IndexEndpointService.GetIndexEndpoint] message GetIndexEndpointRequest { // Required. The name of the IndexEndpoint resource. // Format: @@ -166,10 +174,11 @@ message GetIndexEndpointRequest { ]; } -// Request message for [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1beta1.IndexEndpointService.ListIndexEndpoints]. +// Request message for +// [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1beta1.IndexEndpointService.ListIndexEndpoints]. message ListIndexEndpointsRequest { - // Required. The resource name of the Location from which to list the IndexEndpoints. - // Format: `projects/{project}/locations/{location}` + // Required. The resource name of the Location from which to list the + // IndexEndpoints. Format: `projects/{project}/locations/{location}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -177,8 +186,8 @@ message ListIndexEndpointsRequest { } ]; - // Optional. An expression for filtering the results of the request. For field names - // both snake_case and camelCase are supported. + // Optional. An expression for filtering the results of the request. For field + // names both snake_case and camelCase are supported. // // * `index_endpoint` supports = and !=. `index_endpoint` represents the // IndexEndpoint ID, ie. the last segment of the IndexEndpoint's @@ -202,34 +211,44 @@ message ListIndexEndpointsRequest { // Optional. The standard list page token. // Typically obtained via - // [ListIndexEndpointsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListIndexEndpointsResponse.next_page_token] of the previous - // [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1beta1.IndexEndpointService.ListIndexEndpoints] call. + // [ListIndexEndpointsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListIndexEndpointsResponse.next_page_token] + // of the previous + // [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1beta1.IndexEndpointService.ListIndexEndpoints] + // call. string page_token = 4 [(google.api.field_behavior) = OPTIONAL]; // Optional. Mask specifying which fields to read. - google.protobuf.FieldMask read_mask = 5 [(google.api.field_behavior) = OPTIONAL]; + google.protobuf.FieldMask read_mask = 5 + [(google.api.field_behavior) = OPTIONAL]; } -// Response message for [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1beta1.IndexEndpointService.ListIndexEndpoints]. +// Response message for +// [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1beta1.IndexEndpointService.ListIndexEndpoints]. message ListIndexEndpointsResponse { // List of IndexEndpoints in the requested page. repeated IndexEndpoint index_endpoints = 1; // A token to retrieve next page of results. - // Pass to [ListIndexEndpointsRequest.page_token][google.cloud.aiplatform.v1beta1.ListIndexEndpointsRequest.page_token] to obtain that page. + // Pass to + // [ListIndexEndpointsRequest.page_token][google.cloud.aiplatform.v1beta1.ListIndexEndpointsRequest.page_token] + // to obtain that page. string next_page_token = 2; } -// Request message for [IndexEndpointService.UpdateIndexEndpoint][google.cloud.aiplatform.v1beta1.IndexEndpointService.UpdateIndexEndpoint]. +// Request message for +// [IndexEndpointService.UpdateIndexEndpoint][google.cloud.aiplatform.v1beta1.IndexEndpointService.UpdateIndexEndpoint]. message UpdateIndexEndpointRequest { // Required. The IndexEndpoint which replaces the resource on the server. IndexEndpoint index_endpoint = 1 [(google.api.field_behavior) = REQUIRED]; - // Required. The update mask applies to the resource. See [google.protobuf.FieldMask][google.protobuf.FieldMask]. - google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED]; + // Required. The update mask applies to the resource. See + // [google.protobuf.FieldMask][google.protobuf.FieldMask]. + google.protobuf.FieldMask update_mask = 2 + [(google.api.field_behavior) = REQUIRED]; } -// Request message for [IndexEndpointService.DeleteIndexEndpoint][google.cloud.aiplatform.v1beta1.IndexEndpointService.DeleteIndexEndpoint]. +// Request message for +// [IndexEndpointService.DeleteIndexEndpoint][google.cloud.aiplatform.v1beta1.IndexEndpointService.DeleteIndexEndpoint]. message DeleteIndexEndpointRequest { // Required. The name of the IndexEndpoint resource to be deleted. // Format: @@ -242,10 +261,11 @@ message DeleteIndexEndpointRequest { ]; } -// Request message for [IndexEndpointService.DeployIndex][google.cloud.aiplatform.v1beta1.IndexEndpointService.DeployIndex]. +// Request message for +// [IndexEndpointService.DeployIndex][google.cloud.aiplatform.v1beta1.IndexEndpointService.DeployIndex]. message DeployIndexRequest { - // Required. The name of the IndexEndpoint resource into which to deploy an Index. - // Format: + // Required. The name of the IndexEndpoint resource into which to deploy an + // Index. Format: // `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}` string index_endpoint = 1 [ (google.api.field_behavior) = REQUIRED, @@ -258,13 +278,15 @@ message DeployIndexRequest { DeployedIndex deployed_index = 2 [(google.api.field_behavior) = REQUIRED]; } -// Response message for [IndexEndpointService.DeployIndex][google.cloud.aiplatform.v1beta1.IndexEndpointService.DeployIndex]. +// Response message for +// [IndexEndpointService.DeployIndex][google.cloud.aiplatform.v1beta1.IndexEndpointService.DeployIndex]. message DeployIndexResponse { // The DeployedIndex that had been deployed in the IndexEndpoint. DeployedIndex deployed_index = 1; } -// Runtime operation information for [IndexEndpointService.DeployIndex][google.cloud.aiplatform.v1beta1.IndexEndpointService.DeployIndex]. +// Runtime operation information for +// [IndexEndpointService.DeployIndex][google.cloud.aiplatform.v1beta1.IndexEndpointService.DeployIndex]. message DeployIndexOperationMetadata { // The operation generic information. GenericOperationMetadata generic_metadata = 1; @@ -273,10 +295,11 @@ message DeployIndexOperationMetadata { string deployed_index_id = 2; } -// Request message for [IndexEndpointService.UndeployIndex][google.cloud.aiplatform.v1beta1.IndexEndpointService.UndeployIndex]. +// Request message for +// [IndexEndpointService.UndeployIndex][google.cloud.aiplatform.v1beta1.IndexEndpointService.UndeployIndex]. message UndeployIndexRequest { - // Required. The name of the IndexEndpoint resource from which to undeploy an Index. - // Format: + // Required. The name of the IndexEndpoint resource from which to undeploy an + // Index. Format: // `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}` string index_endpoint = 1 [ (google.api.field_behavior) = REQUIRED, @@ -285,25 +308,27 @@ message UndeployIndexRequest { } ]; - // Required. The ID of the DeployedIndex to be undeployed from the IndexEndpoint. + // Required. The ID of the DeployedIndex to be undeployed from the + // IndexEndpoint. string deployed_index_id = 2 [(google.api.field_behavior) = REQUIRED]; } -// Response message for [IndexEndpointService.UndeployIndex][google.cloud.aiplatform.v1beta1.IndexEndpointService.UndeployIndex]. -message UndeployIndexResponse { +// Response message for +// [IndexEndpointService.UndeployIndex][google.cloud.aiplatform.v1beta1.IndexEndpointService.UndeployIndex]. +message UndeployIndexResponse {} -} - -// Runtime operation information for [IndexEndpointService.UndeployIndex][google.cloud.aiplatform.v1beta1.IndexEndpointService.UndeployIndex]. +// Runtime operation information for +// [IndexEndpointService.UndeployIndex][google.cloud.aiplatform.v1beta1.IndexEndpointService.UndeployIndex]. message UndeployIndexOperationMetadata { // The operation generic information. GenericOperationMetadata generic_metadata = 1; } -// Request message for [IndexEndpointService.MutateDeployedIndex][google.cloud.aiplatform.v1beta1.IndexEndpointService.MutateDeployedIndex]. +// Request message for +// [IndexEndpointService.MutateDeployedIndex][google.cloud.aiplatform.v1beta1.IndexEndpointService.MutateDeployedIndex]. message MutateDeployedIndexRequest { - // Required. The name of the IndexEndpoint resource into which to deploy an Index. - // Format: + // Required. The name of the IndexEndpoint resource into which to deploy an + // Index. Format: // `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}` string index_endpoint = 1 [ (google.api.field_behavior) = REQUIRED, @@ -318,7 +343,8 @@ message MutateDeployedIndexRequest { DeployedIndex deployed_index = 2 [(google.api.field_behavior) = REQUIRED]; } -// Response message for [IndexEndpointService.MutateDeployedIndex][google.cloud.aiplatform.v1beta1.IndexEndpointService.MutateDeployedIndex]. +// Response message for +// [IndexEndpointService.MutateDeployedIndex][google.cloud.aiplatform.v1beta1.IndexEndpointService.MutateDeployedIndex]. message MutateDeployedIndexResponse { // The DeployedIndex that had been updated in the IndexEndpoint. DeployedIndex deployed_index = 1; diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/index_service.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/index_service.proto index 813f648c93f..68bc4048885 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/index_service.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/index_service.proto @@ -36,7 +36,8 @@ option ruby_package = "Google::Cloud::AIPlatform::V1beta1"; // A service for creating and managing Vertex AI's Index resources. service IndexService { option (google.api.default_host) = "aiplatform.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/cloud-platform"; // Creates an Index. rpc CreateIndex(CreateIndexRequest) returns (google.longrunning.Operation) { @@ -82,7 +83,8 @@ service IndexService { // Deletes an Index. // An Index can only be deleted when all its - // [DeployedIndexes][google.cloud.aiplatform.v1beta1.Index.deployed_indexes] had been undeployed. + // [DeployedIndexes][google.cloud.aiplatform.v1beta1.Index.deployed_indexes] + // had been undeployed. rpc DeleteIndex(DeleteIndexRequest) returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1beta1/{name=projects/*/locations/*/indexes/*}" @@ -95,7 +97,8 @@ service IndexService { } // Add/update Datapoints into an Index. - rpc UpsertDatapoints(UpsertDatapointsRequest) returns (UpsertDatapointsResponse) { + rpc UpsertDatapoints(UpsertDatapointsRequest) + returns (UpsertDatapointsResponse) { option (google.api.http) = { post: "/v1beta1/{index=projects/*/locations/*/indexes/*}:upsertDatapoints" body: "*" @@ -103,7 +106,8 @@ service IndexService { } // Remove Datapoints from an Index. - rpc RemoveDatapoints(RemoveDatapointsRequest) returns (RemoveDatapointsResponse) { + rpc RemoveDatapoints(RemoveDatapointsRequest) + returns (RemoveDatapointsResponse) { option (google.api.http) = { post: "/v1beta1/{index=projects/*/locations/*/indexes/*}:removeDatapoints" body: "*" @@ -111,7 +115,8 @@ service IndexService { } } -// Request message for [IndexService.CreateIndex][google.cloud.aiplatform.v1beta1.IndexService.CreateIndex]. +// Request message for +// [IndexService.CreateIndex][google.cloud.aiplatform.v1beta1.IndexService.CreateIndex]. message CreateIndexRequest { // Required. The resource name of the Location to create the Index in. // Format: `projects/{project}/locations/{location}` @@ -126,16 +131,19 @@ message CreateIndexRequest { Index index = 2 [(google.api.field_behavior) = REQUIRED]; } -// Runtime operation information for [IndexService.CreateIndex][google.cloud.aiplatform.v1beta1.IndexService.CreateIndex]. +// Runtime operation information for +// [IndexService.CreateIndex][google.cloud.aiplatform.v1beta1.IndexService.CreateIndex]. message CreateIndexOperationMetadata { // The operation generic information. GenericOperationMetadata generic_metadata = 1; // The operation metadata with regard to Matching Engine Index operation. - NearestNeighborSearchOperationMetadata nearest_neighbor_search_operation_metadata = 2; + NearestNeighborSearchOperationMetadata + nearest_neighbor_search_operation_metadata = 2; } -// Request message for [IndexService.GetIndex][google.cloud.aiplatform.v1beta1.IndexService.GetIndex] +// Request message for +// [IndexService.GetIndex][google.cloud.aiplatform.v1beta1.IndexService.GetIndex] message GetIndexRequest { // Required. The name of the Index resource. // Format: @@ -148,7 +156,8 @@ message GetIndexRequest { ]; } -// Request message for [IndexService.ListIndexes][google.cloud.aiplatform.v1beta1.IndexService.ListIndexes]. +// Request message for +// [IndexService.ListIndexes][google.cloud.aiplatform.v1beta1.IndexService.ListIndexes]. message ListIndexesRequest { // Required. The resource name of the Location from which to list the Indexes. // Format: `projects/{project}/locations/{location}` @@ -167,44 +176,54 @@ message ListIndexesRequest { // The standard list page token. // Typically obtained via - // [ListIndexesResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListIndexesResponse.next_page_token] of the previous - // [IndexService.ListIndexes][google.cloud.aiplatform.v1beta1.IndexService.ListIndexes] call. + // [ListIndexesResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListIndexesResponse.next_page_token] + // of the previous + // [IndexService.ListIndexes][google.cloud.aiplatform.v1beta1.IndexService.ListIndexes] + // call. string page_token = 4; // Mask specifying which fields to read. google.protobuf.FieldMask read_mask = 5; } -// Response message for [IndexService.ListIndexes][google.cloud.aiplatform.v1beta1.IndexService.ListIndexes]. +// Response message for +// [IndexService.ListIndexes][google.cloud.aiplatform.v1beta1.IndexService.ListIndexes]. message ListIndexesResponse { // List of indexes in the requested page. repeated Index indexes = 1; // A token to retrieve next page of results. - // Pass to [ListIndexesRequest.page_token][google.cloud.aiplatform.v1beta1.ListIndexesRequest.page_token] to obtain that page. + // Pass to + // [ListIndexesRequest.page_token][google.cloud.aiplatform.v1beta1.ListIndexesRequest.page_token] + // to obtain that page. string next_page_token = 2; } -// Request message for [IndexService.UpdateIndex][google.cloud.aiplatform.v1beta1.IndexService.UpdateIndex]. +// Request message for +// [IndexService.UpdateIndex][google.cloud.aiplatform.v1beta1.IndexService.UpdateIndex]. message UpdateIndexRequest { // Required. The Index which updates the resource on the server. Index index = 1 [(google.api.field_behavior) = REQUIRED]; // The update mask applies to the resource. - // For the `FieldMask` definition, see [google.protobuf.FieldMask][google.protobuf.FieldMask]. + // For the `FieldMask` definition, see + // [google.protobuf.FieldMask][google.protobuf.FieldMask]. google.protobuf.FieldMask update_mask = 2; } -// Runtime operation information for [IndexService.UpdateIndex][google.cloud.aiplatform.v1beta1.IndexService.UpdateIndex]. +// Runtime operation information for +// [IndexService.UpdateIndex][google.cloud.aiplatform.v1beta1.IndexService.UpdateIndex]. message UpdateIndexOperationMetadata { // The operation generic information. GenericOperationMetadata generic_metadata = 1; // The operation metadata with regard to Matching Engine Index operation. - NearestNeighborSearchOperationMetadata nearest_neighbor_search_operation_metadata = 2; + NearestNeighborSearchOperationMetadata + nearest_neighbor_search_operation_metadata = 2; } -// Request message for [IndexService.DeleteIndex][google.cloud.aiplatform.v1beta1.IndexService.DeleteIndex]. +// Request message for +// [IndexService.DeleteIndex][google.cloud.aiplatform.v1beta1.IndexService.DeleteIndex]. message DeleteIndexRequest { // Required. The name of the Index resource to be deleted. // Format: @@ -217,7 +236,8 @@ message DeleteIndexRequest { ]; } -// Request message for [IndexService.UpsertDatapoints][google.cloud.aiplatform.v1beta1.IndexService.UpsertDatapoints] +// Request message for +// [IndexService.UpsertDatapoints][google.cloud.aiplatform.v1beta1.IndexService.UpsertDatapoints] message UpsertDatapointsRequest { // Required. The name of the Index resource to be updated. // Format: @@ -233,12 +253,12 @@ message UpsertDatapointsRequest { repeated IndexDatapoint datapoints = 2; } -// Response message for [IndexService.UpsertDatapoints][google.cloud.aiplatform.v1beta1.IndexService.UpsertDatapoints] -message UpsertDatapointsResponse { +// Response message for +// [IndexService.UpsertDatapoints][google.cloud.aiplatform.v1beta1.IndexService.UpsertDatapoints] +message UpsertDatapointsResponse {} -} - -// Request message for [IndexService.RemoveDatapoints][google.cloud.aiplatform.v1beta1.IndexService.RemoveDatapoints] +// Request message for +// [IndexService.RemoveDatapoints][google.cloud.aiplatform.v1beta1.IndexService.RemoveDatapoints] message RemoveDatapointsRequest { // Required. The name of the Index resource to be updated. // Format: @@ -254,10 +274,9 @@ message RemoveDatapointsRequest { repeated string datapoint_ids = 2; } -// Response message for [IndexService.RemoveDatapoints][google.cloud.aiplatform.v1beta1.IndexService.RemoveDatapoints] -message RemoveDatapointsResponse { - -} +// Response message for +// [IndexService.RemoveDatapoints][google.cloud.aiplatform.v1beta1.IndexService.RemoveDatapoints] +message RemoveDatapointsResponse {} // Runtime operation metadata with regard to Matching Engine Index. message NearestNeighborSearchOperationMetadata { @@ -325,9 +344,10 @@ message NearestNeighborSearchOperationMetadata { // The validation stats of the content (per file) to be inserted or // updated on the Matching Engine Index resource. Populated if - // contentsDeltaUri is provided as part of [Index.metadata][google.cloud.aiplatform.v1beta1.Index.metadata]. Please note - // that, currently for those files that are broken or has unsupported file - // format, we will not have the stats for those files. + // contentsDeltaUri is provided as part of + // [Index.metadata][google.cloud.aiplatform.v1beta1.Index.metadata]. Please + // note that, currently for those files that are broken or has unsupported + // file format, we will not have the stats for those files. repeated ContentValidationStats content_validation_stats = 1; // The ingested data size in bytes. diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/io.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/io.proto index f571bb62f74..2b52b83aeb5 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/io.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/io.proto @@ -48,7 +48,8 @@ message GcsSource { // The Google Cloud Storage location where the output is to be written to. message GcsDestination { - // Required. Google Cloud Storage URI to output directory. If the uri doesn't end with + // Required. Google Cloud Storage URI to output directory. If the uri doesn't + // end with // '/', a '/' will be automatically appended. The directory is created if it // doesn't exist. string output_uri_prefix = 1 [(google.api.field_behavior) = REQUIRED]; diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/job_service.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/job_service.proto index 68492a64c1d..ec07d5fd4aa 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/job_service.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/job_service.proto @@ -42,7 +42,8 @@ option ruby_package = "Google::Cloud::AIPlatform::V1beta1"; // A service for creating and managing Vertex AI's jobs. service JobService { option (google.api.default_host) = "aiplatform.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/cloud-platform"; // Creates a CustomJob. A created CustomJob right away // will be attempted to be run. @@ -71,7 +72,8 @@ service JobService { } // Deletes a CustomJob. - rpc DeleteCustomJob(DeleteCustomJobRequest) returns (google.longrunning.Operation) { + rpc DeleteCustomJob(DeleteCustomJobRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1beta1/{name=projects/*/locations/*/customJobs/*}" }; @@ -85,13 +87,16 @@ service JobService { // 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 + // 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`. + // 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`. rpc CancelCustomJob(CancelCustomJobRequest) returns (google.protobuf.Empty) { option (google.api.http) = { post: "/v1beta1/{name=projects/*/locations/*/customJobs/*}:cancel" @@ -101,7 +106,8 @@ service JobService { } // Creates a DataLabelingJob. - rpc CreateDataLabelingJob(CreateDataLabelingJobRequest) returns (DataLabelingJob) { + rpc CreateDataLabelingJob(CreateDataLabelingJobRequest) + returns (DataLabelingJob) { option (google.api.http) = { post: "/v1beta1/{parent=projects/*/locations/*}/dataLabelingJobs" body: "data_labeling_job" @@ -118,7 +124,8 @@ service JobService { } // Lists DataLabelingJobs in a Location. - rpc ListDataLabelingJobs(ListDataLabelingJobsRequest) returns (ListDataLabelingJobsResponse) { + rpc ListDataLabelingJobs(ListDataLabelingJobsRequest) + returns (ListDataLabelingJobsResponse) { option (google.api.http) = { get: "/v1beta1/{parent=projects/*/locations/*}/dataLabelingJobs" }; @@ -126,7 +133,8 @@ service JobService { } // Deletes a DataLabelingJob. - rpc DeleteDataLabelingJob(DeleteDataLabelingJobRequest) returns (google.longrunning.Operation) { + rpc DeleteDataLabelingJob(DeleteDataLabelingJobRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1beta1/{name=projects/*/locations/*/dataLabelingJobs/*}" }; @@ -138,7 +146,8 @@ service JobService { } // Cancels a DataLabelingJob. Success of cancellation is not guaranteed. - rpc CancelDataLabelingJob(CancelDataLabelingJobRequest) returns (google.protobuf.Empty) { + rpc CancelDataLabelingJob(CancelDataLabelingJobRequest) + returns (google.protobuf.Empty) { option (google.api.http) = { post: "/v1beta1/{name=projects/*/locations/*/dataLabelingJobs/*}:cancel" body: "*" @@ -147,7 +156,8 @@ service JobService { } // Creates a HyperparameterTuningJob - rpc CreateHyperparameterTuningJob(CreateHyperparameterTuningJobRequest) returns (HyperparameterTuningJob) { + rpc CreateHyperparameterTuningJob(CreateHyperparameterTuningJobRequest) + returns (HyperparameterTuningJob) { option (google.api.http) = { post: "/v1beta1/{parent=projects/*/locations/*}/hyperparameterTuningJobs" body: "hyperparameter_tuning_job" @@ -156,7 +166,8 @@ service JobService { } // Gets a HyperparameterTuningJob - rpc GetHyperparameterTuningJob(GetHyperparameterTuningJobRequest) returns (HyperparameterTuningJob) { + rpc GetHyperparameterTuningJob(GetHyperparameterTuningJobRequest) + returns (HyperparameterTuningJob) { option (google.api.http) = { get: "/v1beta1/{name=projects/*/locations/*/hyperparameterTuningJobs/*}" }; @@ -164,7 +175,8 @@ service JobService { } // Lists HyperparameterTuningJobs in a Location. - rpc ListHyperparameterTuningJobs(ListHyperparameterTuningJobsRequest) returns (ListHyperparameterTuningJobsResponse) { + rpc ListHyperparameterTuningJobs(ListHyperparameterTuningJobsRequest) + returns (ListHyperparameterTuningJobsResponse) { option (google.api.http) = { get: "/v1beta1/{parent=projects/*/locations/*}/hyperparameterTuningJobs" }; @@ -172,7 +184,8 @@ service JobService { } // Deletes a HyperparameterTuningJob. - rpc DeleteHyperparameterTuningJob(DeleteHyperparameterTuningJobRequest) returns (google.longrunning.Operation) { + rpc DeleteHyperparameterTuningJob(DeleteHyperparameterTuningJobRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1beta1/{name=projects/*/locations/*/hyperparameterTuningJobs/*}" }; @@ -186,14 +199,19 @@ service JobService { // 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 + // 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`. - rpc CancelHyperparameterTuningJob(CancelHyperparameterTuningJobRequest) returns (google.protobuf.Empty) { + // 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`. + rpc CancelHyperparameterTuningJob(CancelHyperparameterTuningJobRequest) + returns (google.protobuf.Empty) { option (google.api.http) = { post: "/v1beta1/{name=projects/*/locations/*/hyperparameterTuningJobs/*}:cancel" body: "*" @@ -203,7 +221,8 @@ service JobService { // Creates a BatchPredictionJob. A BatchPredictionJob once created will // right away be attempted to start. - rpc CreateBatchPredictionJob(CreateBatchPredictionJobRequest) returns (BatchPredictionJob) { + rpc CreateBatchPredictionJob(CreateBatchPredictionJobRequest) + returns (BatchPredictionJob) { option (google.api.http) = { post: "/v1beta1/{parent=projects/*/locations/*}/batchPredictionJobs" body: "batch_prediction_job" @@ -212,7 +231,8 @@ service JobService { } // Gets a BatchPredictionJob - rpc GetBatchPredictionJob(GetBatchPredictionJobRequest) returns (BatchPredictionJob) { + rpc GetBatchPredictionJob(GetBatchPredictionJobRequest) + returns (BatchPredictionJob) { option (google.api.http) = { get: "/v1beta1/{name=projects/*/locations/*/batchPredictionJobs/*}" }; @@ -220,7 +240,8 @@ service JobService { } // Lists BatchPredictionJobs in a Location. - rpc ListBatchPredictionJobs(ListBatchPredictionJobsRequest) returns (ListBatchPredictionJobsResponse) { + rpc ListBatchPredictionJobs(ListBatchPredictionJobsRequest) + returns (ListBatchPredictionJobsResponse) { option (google.api.http) = { get: "/v1beta1/{parent=projects/*/locations/*}/batchPredictionJobs" }; @@ -229,7 +250,8 @@ service JobService { // Deletes a BatchPredictionJob. Can only be called on jobs that already // finished. - rpc DeleteBatchPredictionJob(DeleteBatchPredictionJobRequest) returns (google.longrunning.Operation) { + rpc DeleteBatchPredictionJob(DeleteBatchPredictionJobRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1beta1/{name=projects/*/locations/*/batchPredictionJobs/*}" }; @@ -244,13 +266,16 @@ service JobService { // // 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 + // 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. - rpc CancelBatchPredictionJob(CancelBatchPredictionJobRequest) returns (google.protobuf.Empty) { + // [BatchPredictionJob.state][google.cloud.aiplatform.v1beta1.BatchPredictionJob.state] + // is set to `CANCELLED`. Any files already outputted by the job are not + // deleted. + rpc CancelBatchPredictionJob(CancelBatchPredictionJobRequest) + returns (google.protobuf.Empty) { option (google.api.http) = { post: "/v1beta1/{name=projects/*/locations/*/batchPredictionJobs/*}:cancel" body: "*" @@ -260,25 +285,32 @@ service JobService { // Creates a ModelDeploymentMonitoringJob. It will run periodically on a // configured interval. - rpc CreateModelDeploymentMonitoringJob(CreateModelDeploymentMonitoringJobRequest) returns (ModelDeploymentMonitoringJob) { + rpc CreateModelDeploymentMonitoringJob( + CreateModelDeploymentMonitoringJobRequest) + returns (ModelDeploymentMonitoringJob) { option (google.api.http) = { post: "/v1beta1/{parent=projects/*/locations/*}/modelDeploymentMonitoringJobs" body: "model_deployment_monitoring_job" }; - option (google.api.method_signature) = "parent,model_deployment_monitoring_job"; + option (google.api.method_signature) = + "parent,model_deployment_monitoring_job"; } // Searches Model Monitoring Statistics generated within a given time window. - rpc SearchModelDeploymentMonitoringStatsAnomalies(SearchModelDeploymentMonitoringStatsAnomaliesRequest) returns (SearchModelDeploymentMonitoringStatsAnomaliesResponse) { + rpc SearchModelDeploymentMonitoringStatsAnomalies( + SearchModelDeploymentMonitoringStatsAnomaliesRequest) + returns (SearchModelDeploymentMonitoringStatsAnomaliesResponse) { option (google.api.http) = { post: "/v1beta1/{model_deployment_monitoring_job=projects/*/locations/*/modelDeploymentMonitoringJobs/*}:searchModelDeploymentMonitoringStatsAnomalies" body: "*" }; - option (google.api.method_signature) = "model_deployment_monitoring_job,deployed_model_id"; + option (google.api.method_signature) = + "model_deployment_monitoring_job,deployed_model_id"; } // Gets a ModelDeploymentMonitoringJob. - rpc GetModelDeploymentMonitoringJob(GetModelDeploymentMonitoringJobRequest) returns (ModelDeploymentMonitoringJob) { + rpc GetModelDeploymentMonitoringJob(GetModelDeploymentMonitoringJobRequest) + returns (ModelDeploymentMonitoringJob) { option (google.api.http) = { get: "/v1beta1/{name=projects/*/locations/*/modelDeploymentMonitoringJobs/*}" }; @@ -286,7 +318,9 @@ service JobService { } // Lists ModelDeploymentMonitoringJobs in a Location. - rpc ListModelDeploymentMonitoringJobs(ListModelDeploymentMonitoringJobsRequest) returns (ListModelDeploymentMonitoringJobsResponse) { + rpc ListModelDeploymentMonitoringJobs( + ListModelDeploymentMonitoringJobsRequest) + returns (ListModelDeploymentMonitoringJobsResponse) { option (google.api.http) = { get: "/v1beta1/{parent=projects/*/locations/*}/modelDeploymentMonitoringJobs" }; @@ -294,12 +328,15 @@ service JobService { } // Updates a ModelDeploymentMonitoringJob. - rpc UpdateModelDeploymentMonitoringJob(UpdateModelDeploymentMonitoringJobRequest) returns (google.longrunning.Operation) { + rpc UpdateModelDeploymentMonitoringJob( + UpdateModelDeploymentMonitoringJobRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { patch: "/v1beta1/{model_deployment_monitoring_job.name=projects/*/locations/*/modelDeploymentMonitoringJobs/*}" body: "model_deployment_monitoring_job" }; - option (google.api.method_signature) = "model_deployment_monitoring_job,update_mask"; + option (google.api.method_signature) = + "model_deployment_monitoring_job,update_mask"; option (google.longrunning.operation_info) = { response_type: "ModelDeploymentMonitoringJob" metadata_type: "UpdateModelDeploymentMonitoringJobOperationMetadata" @@ -307,7 +344,9 @@ service JobService { } // Deletes a ModelDeploymentMonitoringJob. - rpc DeleteModelDeploymentMonitoringJob(DeleteModelDeploymentMonitoringJobRequest) returns (google.longrunning.Operation) { + rpc DeleteModelDeploymentMonitoringJob( + DeleteModelDeploymentMonitoringJobRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1beta1/{name=projects/*/locations/*/modelDeploymentMonitoringJobs/*}" }; @@ -320,8 +359,11 @@ service JobService { // 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'. - rpc PauseModelDeploymentMonitoringJob(PauseModelDeploymentMonitoringJobRequest) returns (google.protobuf.Empty) { + // [ModelDeploymentMonitoringJob.state][google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob.state] + // to 'PAUSED'. + rpc PauseModelDeploymentMonitoringJob( + PauseModelDeploymentMonitoringJobRequest) + returns (google.protobuf.Empty) { option (google.api.http) = { post: "/v1beta1/{name=projects/*/locations/*/modelDeploymentMonitoringJobs/*}:pause" body: "*" @@ -332,7 +374,9 @@ service JobService { // Resumes a paused ModelDeploymentMonitoringJob. It will start to run from // next scheduled time. A deleted ModelDeploymentMonitoringJob can't be // resumed. - rpc ResumeModelDeploymentMonitoringJob(ResumeModelDeploymentMonitoringJobRequest) returns (google.protobuf.Empty) { + rpc ResumeModelDeploymentMonitoringJob( + ResumeModelDeploymentMonitoringJobRequest) + returns (google.protobuf.Empty) { option (google.api.http) = { post: "/v1beta1/{name=projects/*/locations/*/modelDeploymentMonitoringJobs/*}:resume" body: "*" @@ -341,7 +385,8 @@ service JobService { } } -// Request message for [JobService.CreateCustomJob][google.cloud.aiplatform.v1beta1.JobService.CreateCustomJob]. +// Request message for +// [JobService.CreateCustomJob][google.cloud.aiplatform.v1beta1.JobService.CreateCustomJob]. message CreateCustomJobRequest { // Required. The resource name of the Location to create the CustomJob in. // Format: `projects/{project}/locations/{location}` @@ -356,7 +401,8 @@ message CreateCustomJobRequest { CustomJob custom_job = 2 [(google.api.field_behavior) = REQUIRED]; } -// Request message for [JobService.GetCustomJob][google.cloud.aiplatform.v1beta1.JobService.GetCustomJob]. +// Request message for +// [JobService.GetCustomJob][google.cloud.aiplatform.v1beta1.JobService.GetCustomJob]. message GetCustomJobRequest { // Required. The name of the CustomJob resource. // Format: @@ -369,7 +415,8 @@ message GetCustomJobRequest { ]; } -// Request message for [JobService.ListCustomJobs][google.cloud.aiplatform.v1beta1.JobService.ListCustomJobs]. +// Request message for +// [JobService.ListCustomJobs][google.cloud.aiplatform.v1beta1.JobService.ListCustomJobs]. message ListCustomJobsRequest { // Required. The resource name of the Location to list the CustomJobs from. // Format: `projects/{project}/locations/{location}` @@ -407,25 +454,31 @@ message ListCustomJobsRequest { // The standard list page token. // Typically obtained via - // [ListCustomJobsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListCustomJobsResponse.next_page_token] of the previous - // [JobService.ListCustomJobs][google.cloud.aiplatform.v1beta1.JobService.ListCustomJobs] call. + // [ListCustomJobsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListCustomJobsResponse.next_page_token] + // of the previous + // [JobService.ListCustomJobs][google.cloud.aiplatform.v1beta1.JobService.ListCustomJobs] + // call. string page_token = 4; // Mask specifying which fields to read. google.protobuf.FieldMask read_mask = 5; } -// Response message for [JobService.ListCustomJobs][google.cloud.aiplatform.v1beta1.JobService.ListCustomJobs] +// Response message for +// [JobService.ListCustomJobs][google.cloud.aiplatform.v1beta1.JobService.ListCustomJobs] message ListCustomJobsResponse { // List of CustomJobs in the requested page. repeated CustomJob custom_jobs = 1; // A token to retrieve the next page of results. - // Pass to [ListCustomJobsRequest.page_token][google.cloud.aiplatform.v1beta1.ListCustomJobsRequest.page_token] to obtain that page. + // Pass to + // [ListCustomJobsRequest.page_token][google.cloud.aiplatform.v1beta1.ListCustomJobsRequest.page_token] + // to obtain that page. string next_page_token = 2; } -// Request message for [JobService.DeleteCustomJob][google.cloud.aiplatform.v1beta1.JobService.DeleteCustomJob]. +// Request message for +// [JobService.DeleteCustomJob][google.cloud.aiplatform.v1beta1.JobService.DeleteCustomJob]. message DeleteCustomJobRequest { // Required. The name of the CustomJob resource to be deleted. // Format: @@ -438,7 +491,8 @@ message DeleteCustomJobRequest { ]; } -// Request message for [JobService.CancelCustomJob][google.cloud.aiplatform.v1beta1.JobService.CancelCustomJob]. +// Request message for +// [JobService.CancelCustomJob][google.cloud.aiplatform.v1beta1.JobService.CancelCustomJob]. message CancelCustomJobRequest { // Required. The name of the CustomJob to cancel. // Format: @@ -451,7 +505,8 @@ message CancelCustomJobRequest { ]; } -// Request message for [JobService.CreateDataLabelingJob][google.cloud.aiplatform.v1beta1.JobService.CreateDataLabelingJob]. +// Request message for +// [JobService.CreateDataLabelingJob][google.cloud.aiplatform.v1beta1.JobService.CreateDataLabelingJob]. message CreateDataLabelingJobRequest { // Required. The parent of the DataLabelingJob. // Format: `projects/{project}/locations/{location}` @@ -463,10 +518,12 @@ message CreateDataLabelingJobRequest { ]; // Required. The DataLabelingJob to create. - DataLabelingJob data_labeling_job = 2 [(google.api.field_behavior) = REQUIRED]; + DataLabelingJob data_labeling_job = 2 + [(google.api.field_behavior) = REQUIRED]; } -// Request message for [JobService.GetDataLabelingJob][google.cloud.aiplatform.v1beta1.JobService.GetDataLabelingJob]. +// Request message for +// [JobService.GetDataLabelingJob][google.cloud.aiplatform.v1beta1.JobService.GetDataLabelingJob]. message GetDataLabelingJobRequest { // Required. The name of the DataLabelingJob. // Format: @@ -479,7 +536,8 @@ message GetDataLabelingJobRequest { ]; } -// Request message for [JobService.ListDataLabelingJobs][google.cloud.aiplatform.v1beta1.JobService.ListDataLabelingJobs]. +// Request message for +// [JobService.ListDataLabelingJobs][google.cloud.aiplatform.v1beta1.JobService.ListDataLabelingJobs]. message ListDataLabelingJobsRequest { // Required. The parent of the DataLabelingJob. // Format: `projects/{project}/locations/{location}` @@ -530,7 +588,8 @@ message ListDataLabelingJobsRequest { string order_by = 6; } -// Response message for [JobService.ListDataLabelingJobs][google.cloud.aiplatform.v1beta1.JobService.ListDataLabelingJobs]. +// Response message for +// [JobService.ListDataLabelingJobs][google.cloud.aiplatform.v1beta1.JobService.ListDataLabelingJobs]. message ListDataLabelingJobsResponse { // A list of DataLabelingJobs that matches the specified filter in the // request. @@ -540,7 +599,8 @@ message ListDataLabelingJobsResponse { string next_page_token = 2; } -// Request message for [JobService.DeleteDataLabelingJob][google.cloud.aiplatform.v1beta1.JobService.DeleteDataLabelingJob]. +// Request message for +// [JobService.DeleteDataLabelingJob][google.cloud.aiplatform.v1beta1.JobService.DeleteDataLabelingJob]. message DeleteDataLabelingJobRequest { // Required. The name of the DataLabelingJob to be deleted. // Format: @@ -553,7 +613,8 @@ message DeleteDataLabelingJobRequest { ]; } -// Request message for [JobService.CancelDataLabelingJob][google.cloud.aiplatform.v1beta1.JobService.CancelDataLabelingJob]. +// Request message for +// [JobService.CancelDataLabelingJob][google.cloud.aiplatform.v1beta1.JobService.CancelDataLabelingJob]. message CancelDataLabelingJobRequest { // Required. The name of the DataLabelingJob. // Format: @@ -566,10 +627,12 @@ message CancelDataLabelingJobRequest { ]; } -// Request message for [JobService.CreateHyperparameterTuningJob][google.cloud.aiplatform.v1beta1.JobService.CreateHyperparameterTuningJob]. +// Request message for +// [JobService.CreateHyperparameterTuningJob][google.cloud.aiplatform.v1beta1.JobService.CreateHyperparameterTuningJob]. message CreateHyperparameterTuningJobRequest { - // Required. The resource name of the Location to create the HyperparameterTuningJob in. - // Format: `projects/{project}/locations/{location}` + // Required. The resource name of the Location to create the + // HyperparameterTuningJob in. Format: + // `projects/{project}/locations/{location}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -578,10 +641,12 @@ message CreateHyperparameterTuningJobRequest { ]; // Required. The HyperparameterTuningJob to create. - HyperparameterTuningJob hyperparameter_tuning_job = 2 [(google.api.field_behavior) = REQUIRED]; + HyperparameterTuningJob hyperparameter_tuning_job = 2 + [(google.api.field_behavior) = REQUIRED]; } -// Request message for [JobService.GetHyperparameterTuningJob][google.cloud.aiplatform.v1beta1.JobService.GetHyperparameterTuningJob]. +// Request message for +// [JobService.GetHyperparameterTuningJob][google.cloud.aiplatform.v1beta1.JobService.GetHyperparameterTuningJob]. message GetHyperparameterTuningJobRequest { // Required. The name of the HyperparameterTuningJob resource. // Format: @@ -594,10 +659,12 @@ message GetHyperparameterTuningJobRequest { ]; } -// Request message for [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1beta1.JobService.ListHyperparameterTuningJobs]. +// Request message for +// [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1beta1.JobService.ListHyperparameterTuningJobs]. message ListHyperparameterTuningJobsRequest { - // Required. The resource name of the Location to list the HyperparameterTuningJobs - // from. Format: `projects/{project}/locations/{location}` + // Required. The resource name of the Location to list the + // HyperparameterTuningJobs from. Format: + // `projects/{project}/locations/{location}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -632,27 +699,33 @@ message ListHyperparameterTuningJobsRequest { // The standard list page token. // Typically obtained via - // [ListHyperparameterTuningJobsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListHyperparameterTuningJobsResponse.next_page_token] of the previous - // [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1beta1.JobService.ListHyperparameterTuningJobs] call. + // [ListHyperparameterTuningJobsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListHyperparameterTuningJobsResponse.next_page_token] + // of the previous + // [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1beta1.JobService.ListHyperparameterTuningJobs] + // call. string page_token = 4; // Mask specifying which fields to read. google.protobuf.FieldMask read_mask = 5; } -// Response message for [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1beta1.JobService.ListHyperparameterTuningJobs] +// Response message for +// [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1beta1.JobService.ListHyperparameterTuningJobs] message ListHyperparameterTuningJobsResponse { // List of HyperparameterTuningJobs in the requested page. - // [HyperparameterTuningJob.trials][google.cloud.aiplatform.v1beta1.HyperparameterTuningJob.trials] of the jobs will be not be returned. + // [HyperparameterTuningJob.trials][google.cloud.aiplatform.v1beta1.HyperparameterTuningJob.trials] + // of the jobs will be not be returned. repeated HyperparameterTuningJob hyperparameter_tuning_jobs = 1; // A token to retrieve the next page of results. - // Pass to [ListHyperparameterTuningJobsRequest.page_token][google.cloud.aiplatform.v1beta1.ListHyperparameterTuningJobsRequest.page_token] to obtain that - // page. + // Pass to + // [ListHyperparameterTuningJobsRequest.page_token][google.cloud.aiplatform.v1beta1.ListHyperparameterTuningJobsRequest.page_token] + // to obtain that page. string next_page_token = 2; } -// Request message for [JobService.DeleteHyperparameterTuningJob][google.cloud.aiplatform.v1beta1.JobService.DeleteHyperparameterTuningJob]. +// Request message for +// [JobService.DeleteHyperparameterTuningJob][google.cloud.aiplatform.v1beta1.JobService.DeleteHyperparameterTuningJob]. message DeleteHyperparameterTuningJobRequest { // Required. The name of the HyperparameterTuningJob resource to be deleted. // Format: @@ -665,7 +738,8 @@ message DeleteHyperparameterTuningJobRequest { ]; } -// Request message for [JobService.CancelHyperparameterTuningJob][google.cloud.aiplatform.v1beta1.JobService.CancelHyperparameterTuningJob]. +// Request message for +// [JobService.CancelHyperparameterTuningJob][google.cloud.aiplatform.v1beta1.JobService.CancelHyperparameterTuningJob]. message CancelHyperparameterTuningJobRequest { // Required. The name of the HyperparameterTuningJob to cancel. // Format: @@ -678,10 +752,11 @@ message CancelHyperparameterTuningJobRequest { ]; } -// Request message for [JobService.CreateBatchPredictionJob][google.cloud.aiplatform.v1beta1.JobService.CreateBatchPredictionJob]. +// Request message for +// [JobService.CreateBatchPredictionJob][google.cloud.aiplatform.v1beta1.JobService.CreateBatchPredictionJob]. message CreateBatchPredictionJobRequest { - // Required. The resource name of the Location to create the BatchPredictionJob in. - // Format: `projects/{project}/locations/{location}` + // Required. The resource name of the Location to create the + // BatchPredictionJob in. Format: `projects/{project}/locations/{location}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -690,10 +765,12 @@ message CreateBatchPredictionJobRequest { ]; // Required. The BatchPredictionJob to create. - BatchPredictionJob batch_prediction_job = 2 [(google.api.field_behavior) = REQUIRED]; + BatchPredictionJob batch_prediction_job = 2 + [(google.api.field_behavior) = REQUIRED]; } -// Request message for [JobService.GetBatchPredictionJob][google.cloud.aiplatform.v1beta1.JobService.GetBatchPredictionJob]. +// Request message for +// [JobService.GetBatchPredictionJob][google.cloud.aiplatform.v1beta1.JobService.GetBatchPredictionJob]. message GetBatchPredictionJobRequest { // Required. The name of the BatchPredictionJob resource. // Format: @@ -706,7 +783,8 @@ message GetBatchPredictionJobRequest { ]; } -// Request message for [JobService.ListBatchPredictionJobs][google.cloud.aiplatform.v1beta1.JobService.ListBatchPredictionJobs]. +// Request message for +// [JobService.ListBatchPredictionJobs][google.cloud.aiplatform.v1beta1.JobService.ListBatchPredictionJobs]. message ListBatchPredictionJobsRequest { // Required. The resource name of the Location to list the BatchPredictionJobs // from. Format: `projects/{project}/locations/{location}` @@ -745,26 +823,31 @@ message ListBatchPredictionJobsRequest { // The standard list page token. // Typically obtained via - // [ListBatchPredictionJobsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListBatchPredictionJobsResponse.next_page_token] of the previous - // [JobService.ListBatchPredictionJobs][google.cloud.aiplatform.v1beta1.JobService.ListBatchPredictionJobs] call. + // [ListBatchPredictionJobsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListBatchPredictionJobsResponse.next_page_token] + // of the previous + // [JobService.ListBatchPredictionJobs][google.cloud.aiplatform.v1beta1.JobService.ListBatchPredictionJobs] + // call. string page_token = 4; // Mask specifying which fields to read. google.protobuf.FieldMask read_mask = 5; } -// Response message for [JobService.ListBatchPredictionJobs][google.cloud.aiplatform.v1beta1.JobService.ListBatchPredictionJobs] +// Response message for +// [JobService.ListBatchPredictionJobs][google.cloud.aiplatform.v1beta1.JobService.ListBatchPredictionJobs] message ListBatchPredictionJobsResponse { // List of BatchPredictionJobs in the requested page. repeated BatchPredictionJob batch_prediction_jobs = 1; // A token to retrieve the next page of results. - // Pass to [ListBatchPredictionJobsRequest.page_token][google.cloud.aiplatform.v1beta1.ListBatchPredictionJobsRequest.page_token] to obtain that - // page. + // Pass to + // [ListBatchPredictionJobsRequest.page_token][google.cloud.aiplatform.v1beta1.ListBatchPredictionJobsRequest.page_token] + // to obtain that page. string next_page_token = 2; } -// Request message for [JobService.DeleteBatchPredictionJob][google.cloud.aiplatform.v1beta1.JobService.DeleteBatchPredictionJob]. +// Request message for +// [JobService.DeleteBatchPredictionJob][google.cloud.aiplatform.v1beta1.JobService.DeleteBatchPredictionJob]. message DeleteBatchPredictionJobRequest { // Required. The name of the BatchPredictionJob resource to be deleted. // Format: @@ -777,7 +860,8 @@ message DeleteBatchPredictionJobRequest { ]; } -// Request message for [JobService.CancelBatchPredictionJob][google.cloud.aiplatform.v1beta1.JobService.CancelBatchPredictionJob]. +// Request message for +// [JobService.CancelBatchPredictionJob][google.cloud.aiplatform.v1beta1.JobService.CancelBatchPredictionJob]. message CancelBatchPredictionJobRequest { // Required. The name of the BatchPredictionJob to cancel. // Format: @@ -803,7 +887,8 @@ message CreateModelDeploymentMonitoringJobRequest { ]; // Required. The ModelDeploymentMonitoringJob to create - ModelDeploymentMonitoringJob model_deployment_monitoring_job = 2 [(google.api.field_behavior) = REQUIRED]; + ModelDeploymentMonitoringJob model_deployment_monitoring_job = 2 + [(google.api.field_behavior) = REQUIRED]; } // Request message for @@ -814,11 +899,12 @@ message SearchModelDeploymentMonitoringStatsAnomaliesRequest { ModelDeploymentMonitoringObjectiveType type = 1; // If set, all attribution scores between - // [SearchModelDeploymentMonitoringStatsAnomaliesRequest.start_time][google.cloud.aiplatform.v1beta1.SearchModelDeploymentMonitoringStatsAnomaliesRequest.start_time] and - // [SearchModelDeploymentMonitoringStatsAnomaliesRequest.end_time][google.cloud.aiplatform.v1beta1.SearchModelDeploymentMonitoringStatsAnomaliesRequest.end_time] are - // fetched, and page token doesn't take affect in this case. - // Only used to retrieve attribution score for the top Features which has - // the highest attribution score in the latest monitoring run. + // [SearchModelDeploymentMonitoringStatsAnomaliesRequest.start_time][google.cloud.aiplatform.v1beta1.SearchModelDeploymentMonitoringStatsAnomaliesRequest.start_time] + // and + // [SearchModelDeploymentMonitoringStatsAnomaliesRequest.end_time][google.cloud.aiplatform.v1beta1.SearchModelDeploymentMonitoringStatsAnomaliesRequest.end_time] + // are fetched, and page token doesn't take effect in this case. Only used + // to retrieve attribution score for the top Features which has the highest + // attribution score in the latest monitoring run. int32 top_feature_count = 4; } @@ -843,7 +929,8 @@ message SearchModelDeploymentMonitoringStatsAnomaliesRequest { string feature_display_name = 3; // Required. Objectives of the stats to retrieve. - repeated StatsAnomaliesObjective objectives = 4 [(google.api.field_behavior) = REQUIRED]; + repeated StatsAnomaliesObjective objectives = 4 + [(google.api.field_behavior) = REQUIRED]; // The standard list page size. int32 page_size = 5; @@ -949,18 +1036,18 @@ message ListModelDeploymentMonitoringJobsResponse { // Request message for // [JobService.UpdateModelDeploymentMonitoringJob][google.cloud.aiplatform.v1beta1.JobService.UpdateModelDeploymentMonitoringJob]. message UpdateModelDeploymentMonitoringJobRequest { - // Required. The model monitoring configuration which replaces the resource on the - // server. - ModelDeploymentMonitoringJob model_deployment_monitoring_job = 1 [(google.api.field_behavior) = REQUIRED]; - - // Required. The update mask is used to specify the fields to be overwritten in the - // ModelDeploymentMonitoringJob resource by the update. - // The fields specified in the update_mask are relative to the resource, not - // the full request. A field will be overwritten if it is in the mask. If the - // user does not provide a mask then only the non-empty fields present in the - // request will be overwritten. Set the update_mask to `*` to override all - // fields. - // For the objective config, the user can either provide the update mask for + // Required. The model monitoring configuration which replaces the resource on + // the server. + ModelDeploymentMonitoringJob model_deployment_monitoring_job = 1 + [(google.api.field_behavior) = REQUIRED]; + + // Required. The update mask is used to specify the fields to be overwritten + // in the ModelDeploymentMonitoringJob resource by the update. The fields + // specified in the update_mask are relative to the resource, not the full + // request. A field will be overwritten if it is in the mask. If the user does + // not provide a mask then only the non-empty fields present in the request + // will be overwritten. Set the update_mask to `*` to override all fields. For + // the objective config, the user can either provide the update mask for // model_deployment_monitoring_objective_configs or any combination of its // nested fields, such as: // model_deployment_monitoring_objective_configs.objective_config.training_dataset. @@ -980,7 +1067,8 @@ message UpdateModelDeploymentMonitoringJobRequest { // * `model_deployment_monitoring_objective_configs.objective_config.training_dataset` // * `model_deployment_monitoring_objective_configs.objective_config.training_prediction_skew_detection_config` // * `model_deployment_monitoring_objective_configs.objective_config.prediction_drift_detection_config` - google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.FieldMask update_mask = 2 + [(google.api.field_behavior) = REQUIRED]; } // Request message for diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/machine_resources.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/machine_resources.proto index fa1d1faaf53..fcf75e357f5 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/machine_resources.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/machine_resources.proto @@ -37,14 +37,18 @@ message MachineSpec { // See the [list of machine types supported for custom // training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). // - // For [DeployedModel][google.cloud.aiplatform.v1beta1.DeployedModel] this field is optional, and the default - // value is `n1-standard-2`. For [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob] or as part of - // [WorkerPoolSpec][google.cloud.aiplatform.v1beta1.WorkerPoolSpec] this field is required. + // For [DeployedModel][google.cloud.aiplatform.v1beta1.DeployedModel] this + // field is optional, and the default value is `n1-standard-2`. For + // [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob] or + // as part of [WorkerPoolSpec][google.cloud.aiplatform.v1beta1.WorkerPoolSpec] + // this field is required. string machine_type = 1 [(google.api.field_behavior) = IMMUTABLE]; - // Immutable. The type of accelerator(s) that may be attached to the machine as per + // Immutable. The type of accelerator(s) that may be attached to the machine + // as per // [accelerator_count][google.cloud.aiplatform.v1beta1.MachineSpec.accelerator_count]. - AcceleratorType accelerator_type = 2 [(google.api.field_behavior) = IMMUTABLE]; + AcceleratorType accelerator_type = 2 + [(google.api.field_behavior) = IMMUTABLE]; // The number of accelerators to attach to the machine. int32 accelerator_count = 3; @@ -53,14 +57,16 @@ message MachineSpec { // A description of resources that are dedicated to a DeployedModel, and // that need a higher degree of manual configuration. message DedicatedResources { - // Required. Immutable. The specification of a single machine used by the prediction. + // Required. Immutable. The specification of a single machine used by the + // prediction. MachineSpec machine_spec = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.field_behavior) = IMMUTABLE ]; - // Required. Immutable. The minimum number of machine replicas this DeployedModel will be always - // deployed on. This value must be greater than or equal to 1. + // Required. Immutable. The minimum number of machine replicas this + // DeployedModel will be always deployed on. This value must be greater than + // or equal to 1. // // If traffic against the DeployedModel increases, it may dynamically be // deployed onto more replicas, and as traffic decreases, some of these extra @@ -70,14 +76,15 @@ message DedicatedResources { (google.api.field_behavior) = IMMUTABLE ]; - // Immutable. The maximum number of replicas this DeployedModel may be deployed on when - // the traffic against it increases. If the requested value is too large, - // the deployment will error, but if deployment succeeds then the ability - // to scale the model to that many replicas is guaranteed (barring service - // outages). If traffic against the DeployedModel increases beyond what its - // replicas at maximum may handle, a portion of the traffic will be dropped. - // If this value is not provided, will use [min_replica_count][google.cloud.aiplatform.v1beta1.DedicatedResources.min_replica_count] as the - // default value. + // Immutable. The maximum number of replicas this DeployedModel may be + // deployed on when the traffic against it increases. If the requested value + // is too large, the deployment will error, but if deployment succeeds then + // the ability to scale the model to that many replicas is guaranteed (barring + // service outages). If traffic against the DeployedModel increases beyond + // what its replicas at maximum may handle, a portion of the traffic will be + // dropped. If this value is not provided, will use + // [min_replica_count][google.cloud.aiplatform.v1beta1.DedicatedResources.min_replica_count] + // as the default value. // // The value of this field impacts the charge against Vertex CPU and GPU // quotas. Specifically, you will be charged for (max_replica_count * @@ -90,44 +97,49 @@ message DedicatedResources { // target value (default to 60 if not set). At most one entry is allowed per // metric. // - // If [machine_spec.accelerator_count][google.cloud.aiplatform.v1beta1.MachineSpec.accelerator_count] is - // above 0, the autoscaling will be based on both CPU utilization and + // If + // [machine_spec.accelerator_count][google.cloud.aiplatform.v1beta1.MachineSpec.accelerator_count] + // is above 0, the autoscaling will be based on both CPU utilization and // accelerator's duty cycle metrics and scale up when either metrics exceeds // its target value while scale down if both metrics are under their target // value. The default target value is 60 for both metrics. // - // If [machine_spec.accelerator_count][google.cloud.aiplatform.v1beta1.MachineSpec.accelerator_count] is - // 0, the autoscaling will be based on CPU utilization metric only with + // If + // [machine_spec.accelerator_count][google.cloud.aiplatform.v1beta1.MachineSpec.accelerator_count] + // is 0, the autoscaling will be based on CPU utilization metric only with // default target value 60 if not explicitly set. // // For example, in the case of Online Prediction, if you want to override // target CPU utilization to 80, you should set // [autoscaling_metric_specs.metric_name][google.cloud.aiplatform.v1beta1.AutoscalingMetricSpec.metric_name] // to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and - // [autoscaling_metric_specs.target][google.cloud.aiplatform.v1beta1.AutoscalingMetricSpec.target] to `80`. - repeated AutoscalingMetricSpec autoscaling_metric_specs = 4 [(google.api.field_behavior) = IMMUTABLE]; + // [autoscaling_metric_specs.target][google.cloud.aiplatform.v1beta1.AutoscalingMetricSpec.target] + // to `80`. + repeated AutoscalingMetricSpec autoscaling_metric_specs = 4 + [(google.api.field_behavior) = IMMUTABLE]; } // A description of resources that to large degree are decided by Vertex AI, // and require only a modest additional configuration. // Each Model supporting these resources documents its specific guidelines. message AutomaticResources { - // Immutable. The minimum number of replicas this DeployedModel will be always deployed - // on. If traffic against it increases, it may dynamically be deployed onto - // more replicas up to [max_replica_count][google.cloud.aiplatform.v1beta1.AutomaticResources.max_replica_count], and as traffic decreases, some - // of these extra replicas may be freed. - // If the requested value is too large, the deployment will error. + // Immutable. The minimum number of replicas this DeployedModel will be always + // deployed on. If traffic against it increases, it may dynamically be + // deployed onto more replicas up to + // [max_replica_count][google.cloud.aiplatform.v1beta1.AutomaticResources.max_replica_count], + // and as traffic decreases, some of these extra replicas may be freed. If the + // requested value is too large, the deployment will error. int32 min_replica_count = 1 [(google.api.field_behavior) = IMMUTABLE]; - // Immutable. The maximum number of replicas this DeployedModel may be deployed on when - // the traffic against it increases. If the requested value is too large, - // the deployment will error, but if deployment succeeds then the ability - // to scale the model to that many replicas is guaranteed (barring service - // outages). If traffic against the DeployedModel increases beyond what its - // replicas at maximum may handle, a portion of the traffic will be dropped. - // If this value is not provided, a no upper bound for scaling under heavy - // traffic will be assume, though Vertex AI may be unable to scale beyond - // certain replica number. + // Immutable. The maximum number of replicas this DeployedModel may be + // deployed on when the traffic against it increases. If the requested value + // is too large, the deployment will error, but if deployment succeeds then + // the ability to scale the model to that many replicas is guaranteed (barring + // service outages). If traffic against the DeployedModel increases beyond + // what its replicas at maximum may handle, a portion of the traffic will be + // dropped. If this value is not provided, a no upper bound for scaling under + // heavy traffic will be assume, though Vertex AI may be unable to scale + // beyond certain replica number. int32 max_replica_count = 2 [(google.api.field_behavior) = IMMUTABLE]; } @@ -140,21 +152,21 @@ message BatchDedicatedResources { (google.api.field_behavior) = IMMUTABLE ]; - // Immutable. The number of machine replicas used at the start of the batch operation. - // If not set, Vertex AI decides starting number, not greater than + // Immutable. The number of machine replicas used at the start of the batch + // operation. If not set, Vertex AI decides starting number, not greater than // [max_replica_count][google.cloud.aiplatform.v1beta1.BatchDedicatedResources.max_replica_count] int32 starting_replica_count = 2 [(google.api.field_behavior) = IMMUTABLE]; - // Immutable. The maximum number of machine replicas the batch operation may be scaled - // to. The default value is 10. + // Immutable. The maximum number of machine replicas the batch operation may + // be scaled to. The default value is 10. int32 max_replica_count = 3 [(google.api.field_behavior) = IMMUTABLE]; } // Statistics information about resource consumption. message ResourcesConsumed { - // Output only. The number of replica hours used. Note that many replicas may run in - // parallel, and additionally any given work may be queued for some time. - // Therefore this value is not strictly related to wall time. + // Output only. The number of replica hours used. Note that many replicas may + // run in parallel, and additionally any given work may be queued for some + // time. Therefore this value is not strictly related to wall time. double replica_hours = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; } @@ -179,8 +191,8 @@ message NfsMount { // the source mount path in the form of `server:path` string path = 2 [(google.api.field_behavior) = REQUIRED]; - // Required. Destination mount path. The NFS will be mounted for the user under - // /mnt/nfs/ + // Required. Destination mount path. The NFS will be mounted for the user + // under /mnt/nfs/ string mount_point = 3 [(google.api.field_behavior) = REQUIRED]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/manual_batch_tuning_parameters.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/manual_batch_tuning_parameters.proto index 5498d89d4a3..189e88f21d6 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/manual_batch_tuning_parameters.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/manual_batch_tuning_parameters.proto @@ -28,11 +28,11 @@ option ruby_package = "Google::Cloud::AIPlatform::V1beta1"; // Manual batch tuning parameters. message ManualBatchTuningParameters { - // Immutable. The number of the records (e.g. instances) of the operation given in - // each batch to a machine replica. Machine type, and size of a single - // record should be considered when setting this parameter, higher value - // speeds up the batch operation's execution, but too high value will result - // in a whole batch not fitting in a machine's memory, and the whole + // Immutable. The number of the records (e.g. instances) of the operation + // given in each batch to a machine replica. Machine type, and size of a + // single record should be considered when setting this parameter, higher + // value speeds up the batch operation's execution, but too high value will + // result in a whole batch not fitting in a machine's memory, and the whole // operation will fail. // The default value is 64. int32 batch_size = 1 [(google.api.field_behavior) = IMMUTABLE]; diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/metadata_schema.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/metadata_schema.proto index 0623a3ee975..fbe45dff4e0 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/metadata_schema.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/metadata_schema.proto @@ -58,9 +58,9 @@ message MetadataSchema { // allow to order/compare different versions. Example: 1.0.0, 1.0.1, etc. string schema_version = 2; - // Required. The raw YAML string representation of the MetadataSchema. The combination - // of [MetadataSchema.version] and the schema name given by `title` in - // [MetadataSchema.schema] must be unique within a MetadataStore. + // Required. The raw YAML string representation of the MetadataSchema. The + // combination of [MetadataSchema.version] and the schema name given by + // `title` in [MetadataSchema.schema] must be unique within a MetadataStore. // // The schema is defined as an OpenAPI 3.0.2 // [MetadataSchema @@ -72,7 +72,8 @@ message MetadataSchema { MetadataSchemaType schema_type = 4; // Output only. Timestamp when this MetadataSchema was created. - google.protobuf.Timestamp create_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Description of the Metadata Schema string description = 6; diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/metadata_service.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/metadata_service.proto index abdcb600c23..215b853170e 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/metadata_service.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/metadata_service.proto @@ -42,15 +42,18 @@ option ruby_package = "Google::Cloud::AIPlatform::V1beta1"; // Service for reading and writing metadata entries. service MetadataService { option (google.api.default_host) = "aiplatform.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/cloud-platform"; // Initializes a MetadataStore, including allocation of resources. - rpc CreateMetadataStore(CreateMetadataStoreRequest) returns (google.longrunning.Operation) { + rpc CreateMetadataStore(CreateMetadataStoreRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta1/{parent=projects/*/locations/*}/metadataStores" body: "metadata_store" }; - option (google.api.method_signature) = "parent,metadata_store,metadata_store_id"; + option (google.api.method_signature) = + "parent,metadata_store,metadata_store_id"; option (google.longrunning.operation_info) = { response_type: "MetadataStore" metadata_type: "CreateMetadataStoreOperationMetadata" @@ -66,7 +69,8 @@ service MetadataService { } // Lists MetadataStores for a Location. - rpc ListMetadataStores(ListMetadataStoresRequest) returns (ListMetadataStoresResponse) { + rpc ListMetadataStores(ListMetadataStoresRequest) + returns (ListMetadataStoresResponse) { option (google.api.http) = { get: "/v1beta1/{parent=projects/*/locations/*}/metadataStores" }; @@ -75,7 +79,8 @@ service MetadataService { // Deletes a single MetadataStore and all its child resources (Artifacts, // Executions, and Contexts). - rpc DeleteMetadataStore(DeleteMetadataStoreRequest) returns (google.longrunning.Operation) { + rpc DeleteMetadataStore(DeleteMetadataStoreRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1beta1/{name=projects/*/locations/*/metadataStores/*}" }; @@ -121,7 +126,8 @@ service MetadataService { } // Deletes an Artifact. - rpc DeleteArtifact(DeleteArtifactRequest) returns (google.longrunning.Operation) { + rpc DeleteArtifact(DeleteArtifactRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1beta1/{name=projects/*/locations/*/metadataStores/*/artifacts/*}" }; @@ -133,7 +139,8 @@ service MetadataService { } // Purges Artifacts. - rpc PurgeArtifacts(PurgeArtifactsRequest) returns (google.longrunning.Operation) { + rpc PurgeArtifacts(PurgeArtifactsRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta1/{parent=projects/*/locations/*/metadataStores/*}/artifacts:purge" body: "*" @@ -180,7 +187,8 @@ service MetadataService { } // Deletes a stored Context. - rpc DeleteContext(DeleteContextRequest) returns (google.longrunning.Operation) { + rpc DeleteContext(DeleteContextRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1beta1/{name=projects/*/locations/*/metadataStores/*/contexts/*}" }; @@ -192,7 +200,8 @@ service MetadataService { } // Purges Contexts. - rpc PurgeContexts(PurgeContextsRequest) returns (google.longrunning.Operation) { + rpc PurgeContexts(PurgeContextsRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta1/{parent=projects/*/locations/*/metadataStores/*}/contexts:purge" body: "*" @@ -207,7 +216,8 @@ service MetadataService { // 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. - rpc AddContextArtifactsAndExecutions(AddContextArtifactsAndExecutionsRequest) returns (AddContextArtifactsAndExecutionsResponse) { + rpc AddContextArtifactsAndExecutions(AddContextArtifactsAndExecutionsRequest) + returns (AddContextArtifactsAndExecutionsResponse) { option (google.api.http) = { post: "/v1beta1/{context=projects/*/locations/*/metadataStores/*/contexts/*}:addContextArtifactsAndExecutions" body: "*" @@ -220,7 +230,8 @@ service MetadataService { // 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. - rpc AddContextChildren(AddContextChildrenRequest) returns (AddContextChildrenResponse) { + rpc AddContextChildren(AddContextChildrenRequest) + returns (AddContextChildrenResponse) { option (google.api.http) = { post: "/v1beta1/{context=projects/*/locations/*/metadataStores/*/contexts/*}:addContextChildren" body: "*" @@ -231,7 +242,8 @@ service MetadataService { // Remove a set of children contexts from a parent Context. If any of the // child Contexts were NOT added to the parent Context, they are // simply skipped. - rpc RemoveContextChildren(RemoveContextChildrenRequest) returns (RemoveContextChildrenResponse) { + rpc RemoveContextChildren(RemoveContextChildrenRequest) + returns (RemoveContextChildrenResponse) { option (google.api.http) = { post: "/v1beta1/{context=projects/*/locations/*/metadataStores/*/contexts/*}:removeContextChildren" body: "*" @@ -241,7 +253,8 @@ service MetadataService { // Retrieves Artifacts and Executions within the specified Context, connected // by Event edges and returned as a LineageSubgraph. - rpc QueryContextLineageSubgraph(QueryContextLineageSubgraphRequest) returns (LineageSubgraph) { + rpc QueryContextLineageSubgraph(QueryContextLineageSubgraphRequest) + returns (LineageSubgraph) { option (google.api.http) = { get: "/v1beta1/{context=projects/*/locations/*/metadataStores/*/contexts/*}:queryContextLineageSubgraph" }; @@ -283,7 +296,8 @@ service MetadataService { } // Deletes an Execution. - rpc DeleteExecution(DeleteExecutionRequest) returns (google.longrunning.Operation) { + rpc DeleteExecution(DeleteExecutionRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1beta1/{name=projects/*/locations/*/metadataStores/*/executions/*}" }; @@ -295,7 +309,8 @@ service MetadataService { } // Purges Executions. - rpc PurgeExecutions(PurgeExecutionsRequest) returns (google.longrunning.Operation) { + rpc PurgeExecutions(PurgeExecutionsRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta1/{parent=projects/*/locations/*/metadataStores/*}/executions:purge" body: "*" @@ -311,7 +326,8 @@ service MetadataService { // 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. - rpc AddExecutionEvents(AddExecutionEventsRequest) returns (AddExecutionEventsResponse) { + rpc AddExecutionEvents(AddExecutionEventsRequest) + returns (AddExecutionEventsResponse) { option (google.api.http) = { post: "/v1beta1/{execution=projects/*/locations/*/metadataStores/*/executions/*}:addExecutionEvents" body: "*" @@ -322,7 +338,8 @@ service MetadataService { // Obtains the set of input and output Artifacts for this Execution, in the // form of LineageSubgraph that also contains the Execution and connecting // Events. - rpc QueryExecutionInputsAndOutputs(QueryExecutionInputsAndOutputsRequest) returns (LineageSubgraph) { + rpc QueryExecutionInputsAndOutputs(QueryExecutionInputsAndOutputsRequest) + returns (LineageSubgraph) { option (google.api.http) = { get: "/v1beta1/{execution=projects/*/locations/*/metadataStores/*/executions/*}:queryExecutionInputsAndOutputs" }; @@ -330,12 +347,14 @@ service MetadataService { } // Creates a MetadataSchema. - rpc CreateMetadataSchema(CreateMetadataSchemaRequest) returns (MetadataSchema) { + rpc CreateMetadataSchema(CreateMetadataSchemaRequest) + returns (MetadataSchema) { option (google.api.http) = { post: "/v1beta1/{parent=projects/*/locations/*/metadataStores/*}/metadataSchemas" body: "metadata_schema" }; - option (google.api.method_signature) = "parent,metadata_schema,metadata_schema_id"; + option (google.api.method_signature) = + "parent,metadata_schema,metadata_schema_id"; } // Retrieves a specific MetadataSchema. @@ -347,7 +366,8 @@ service MetadataService { } // Lists MetadataSchemas. - rpc ListMetadataSchemas(ListMetadataSchemasRequest) returns (ListMetadataSchemasResponse) { + rpc ListMetadataSchemas(ListMetadataSchemasRequest) + returns (ListMetadataSchemasResponse) { option (google.api.http) = { get: "/v1beta1/{parent=projects/*/locations/*/metadataStores/*}/metadataSchemas" }; @@ -356,7 +376,8 @@ service MetadataService { // Retrieves lineage of an Artifact represented through Artifacts and // Executions connected by Event edges and returned as a LineageSubgraph. - rpc QueryArtifactLineageSubgraph(QueryArtifactLineageSubgraphRequest) returns (LineageSubgraph) { + rpc QueryArtifactLineageSubgraph(QueryArtifactLineageSubgraphRequest) + returns (LineageSubgraph) { option (google.api.http) = { get: "/v1beta1/{artifact=projects/*/locations/*/metadataStores/*/artifacts/*}:queryArtifactLineageSubgraph" }; @@ -364,7 +385,8 @@ service MetadataService { } } -// Request message for [MetadataService.CreateMetadataStore][google.cloud.aiplatform.v1beta1.MetadataService.CreateMetadataStore]. +// Request message for +// [MetadataService.CreateMetadataStore][google.cloud.aiplatform.v1beta1.MetadataService.CreateMetadataStore]. message CreateMetadataStoreRequest { // Required. The resource name of the Location where the MetadataStore should // be created. @@ -390,13 +412,15 @@ message CreateMetadataStoreRequest { string metadata_store_id = 3; } -// Details of operations that perform [MetadataService.CreateMetadataStore][google.cloud.aiplatform.v1beta1.MetadataService.CreateMetadataStore]. +// Details of operations that perform +// [MetadataService.CreateMetadataStore][google.cloud.aiplatform.v1beta1.MetadataService.CreateMetadataStore]. message CreateMetadataStoreOperationMetadata { // Operation metadata for creating a MetadataStore. GenericOperationMetadata generic_metadata = 1; } -// Request message for [MetadataService.GetMetadataStore][google.cloud.aiplatform.v1beta1.MetadataService.GetMetadataStore]. +// Request message for +// [MetadataService.GetMetadataStore][google.cloud.aiplatform.v1beta1.MetadataService.GetMetadataStore]. message GetMetadataStoreRequest { // Required. The resource name of the MetadataStore to retrieve. // Format: @@ -409,7 +433,8 @@ message GetMetadataStoreRequest { ]; } -// Request message for [MetadataService.ListMetadataStores][google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataStores]. +// Request message for +// [MetadataService.ListMetadataStores][google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataStores]. message ListMetadataStoresRequest { // Required. The Location whose MetadataStores should be listed. // Format: @@ -427,8 +452,8 @@ message ListMetadataStoresRequest { int32 page_size = 2; // A page token, received from a previous - // [MetadataService.ListMetadataStores][google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataStores] call. Provide this to retrieve the - // subsequent page. + // [MetadataService.ListMetadataStores][google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataStores] + // call. Provide this to retrieve the subsequent page. // // When paginating, all other provided parameters must match the call that // provided the page token. (Otherwise the request will fail with @@ -436,18 +461,21 @@ message ListMetadataStoresRequest { string page_token = 3; } -// Response message for [MetadataService.ListMetadataStores][google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataStores]. +// Response message for +// [MetadataService.ListMetadataStores][google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataStores]. message ListMetadataStoresResponse { // The MetadataStores found for the Location. repeated MetadataStore metadata_stores = 1; // A token, which can be sent as - // [ListMetadataStoresRequest.page_token][google.cloud.aiplatform.v1beta1.ListMetadataStoresRequest.page_token] to retrieve the next - // page. If this field is not populated, there are no subsequent pages. + // [ListMetadataStoresRequest.page_token][google.cloud.aiplatform.v1beta1.ListMetadataStoresRequest.page_token] + // to retrieve the next page. If this field is not populated, there are no + // subsequent pages. string next_page_token = 2; } -// Request message for [MetadataService.DeleteMetadataStore][google.cloud.aiplatform.v1beta1.MetadataService.DeleteMetadataStore]. +// Request message for +// [MetadataService.DeleteMetadataStore][google.cloud.aiplatform.v1beta1.MetadataService.DeleteMetadataStore]. message DeleteMetadataStoreRequest { // Required. The resource name of the MetadataStore to delete. // Format: @@ -463,13 +491,15 @@ message DeleteMetadataStoreRequest { bool force = 2 [deprecated = true]; } -// Details of operations that perform [MetadataService.DeleteMetadataStore][google.cloud.aiplatform.v1beta1.MetadataService.DeleteMetadataStore]. +// Details of operations that perform +// [MetadataService.DeleteMetadataStore][google.cloud.aiplatform.v1beta1.MetadataService.DeleteMetadataStore]. message DeleteMetadataStoreOperationMetadata { // Operation metadata for deleting a MetadataStore. GenericOperationMetadata generic_metadata = 1; } -// Request message for [MetadataService.CreateArtifact][google.cloud.aiplatform.v1beta1.MetadataService.CreateArtifact]. +// Request message for +// [MetadataService.CreateArtifact][google.cloud.aiplatform.v1beta1.MetadataService.CreateArtifact]. message CreateArtifactRequest { // Required. The resource name of the MetadataStore where the Artifact should // be created. @@ -495,7 +525,8 @@ message CreateArtifactRequest { string artifact_id = 3; } -// Request message for [MetadataService.GetArtifact][google.cloud.aiplatform.v1beta1.MetadataService.GetArtifact]. +// Request message for +// [MetadataService.GetArtifact][google.cloud.aiplatform.v1beta1.MetadataService.GetArtifact]. message GetArtifactRequest { // Required. The resource name of the Artifact to retrieve. // Format: @@ -508,7 +539,8 @@ message GetArtifactRequest { ]; } -// Request message for [MetadataService.ListArtifacts][google.cloud.aiplatform.v1beta1.MetadataService.ListArtifacts]. +// Request message for +// [MetadataService.ListArtifacts][google.cloud.aiplatform.v1beta1.MetadataService.ListArtifacts]. message ListArtifactsRequest { // Required. The MetadataStore whose Artifacts should be listed. // Format: @@ -524,7 +556,8 @@ message ListArtifactsRequest { // Must be in range 1-1000, inclusive. Defaults to 100. int32 page_size = 2; - // A page token, received from a previous [MetadataService.ListArtifacts][google.cloud.aiplatform.v1beta1.MetadataService.ListArtifacts] + // A page token, received from a previous + // [MetadataService.ListArtifacts][google.cloud.aiplatform.v1beta1.MetadataService.ListArtifacts] // call. Provide this to retrieve the subsequent page. // // When paginating, all other provided parameters must match the call that @@ -556,7 +589,8 @@ message ListArtifactsRequest { // `in_context("projects//locations//metadataStores//contexts/")` // // Each of the above supported filter types can be combined together using - // logical operators (`AND` & `OR`). + // logical operators (`AND` & `OR`). Maximum nested expression depth allowed + // is 5. // // For example: `display_name = "test" AND metadata.field1.bool_value = true`. string filter = 4; @@ -570,36 +604,42 @@ message ListArtifactsRequest { string order_by = 5; } -// Response message for [MetadataService.ListArtifacts][google.cloud.aiplatform.v1beta1.MetadataService.ListArtifacts]. +// Response message for +// [MetadataService.ListArtifacts][google.cloud.aiplatform.v1beta1.MetadataService.ListArtifacts]. message ListArtifactsResponse { // The Artifacts retrieved from the MetadataStore. repeated Artifact artifacts = 1; - // A token, which can be sent as [ListArtifactsRequest.page_token][google.cloud.aiplatform.v1beta1.ListArtifactsRequest.page_token] + // A token, which can be sent as + // [ListArtifactsRequest.page_token][google.cloud.aiplatform.v1beta1.ListArtifactsRequest.page_token] // to retrieve the next page. // If this field is not populated, there are no subsequent pages. string next_page_token = 2; } -// Request message for [MetadataService.UpdateArtifact][google.cloud.aiplatform.v1beta1.MetadataService.UpdateArtifact]. +// Request message for +// [MetadataService.UpdateArtifact][google.cloud.aiplatform.v1beta1.MetadataService.UpdateArtifact]. message UpdateArtifactRequest { // Required. The Artifact containing updates. - // The Artifact's [Artifact.name][google.cloud.aiplatform.v1beta1.Artifact.name] field is used to identify the Artifact to - // be updated. - // Format: + // The Artifact's + // [Artifact.name][google.cloud.aiplatform.v1beta1.Artifact.name] field is + // used to identify the Artifact to be updated. Format: // `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` Artifact artifact = 1 [(google.api.field_behavior) = REQUIRED]; // Optional. A FieldMask indicating which fields should be updated. // Functionality of this field is not yet supported. - google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = OPTIONAL]; + google.protobuf.FieldMask update_mask = 2 + [(google.api.field_behavior) = OPTIONAL]; - // If set to true, and the [Artifact][google.cloud.aiplatform.v1beta1.Artifact] is not found, a new [Artifact][google.cloud.aiplatform.v1beta1.Artifact] is - // created. + // If set to true, and the + // [Artifact][google.cloud.aiplatform.v1beta1.Artifact] is not found, a new + // [Artifact][google.cloud.aiplatform.v1beta1.Artifact] is created. bool allow_missing = 3; } -// Request message for [MetadataService.DeleteArtifact][google.cloud.aiplatform.v1beta1.MetadataService.DeleteArtifact]. +// Request message for +// [MetadataService.DeleteArtifact][google.cloud.aiplatform.v1beta1.MetadataService.DeleteArtifact]. message DeleteArtifactRequest { // Required. The resource name of the Artifact to delete. // Format: @@ -617,7 +657,8 @@ message DeleteArtifactRequest { string etag = 2 [(google.api.field_behavior) = OPTIONAL]; } -// Request message for [MetadataService.PurgeArtifacts][google.cloud.aiplatform.v1beta1.MetadataService.PurgeArtifacts]. +// Request message for +// [MetadataService.PurgeArtifacts][google.cloud.aiplatform.v1beta1.MetadataService.PurgeArtifacts]. message PurgeArtifactsRequest { // Required. The metadata store to purge Artifacts from. // Format: @@ -639,7 +680,8 @@ message PurgeArtifactsRequest { bool force = 3 [(google.api.field_behavior) = OPTIONAL]; } -// Response message for [MetadataService.PurgeArtifacts][google.cloud.aiplatform.v1beta1.MetadataService.PurgeArtifacts]. +// Response message for +// [MetadataService.PurgeArtifacts][google.cloud.aiplatform.v1beta1.MetadataService.PurgeArtifacts]. message PurgeArtifactsResponse { // The number of Artifacts that this request deleted (or, if `force` is false, // the number of Artifacts that will be deleted). This can be an estimate. @@ -649,21 +691,22 @@ message PurgeArtifactsResponse { // Only populated if `force` is set to false. The maximum number of samples is // 100 (it is possible to return fewer). repeated string purge_sample = 2 [(google.api.resource_reference) = { - type: "aiplatform.googleapis.com/Artifact" - }]; + type: "aiplatform.googleapis.com/Artifact" + }]; } -// Details of operations that perform [MetadataService.PurgeArtifacts][google.cloud.aiplatform.v1beta1.MetadataService.PurgeArtifacts]. +// Details of operations that perform +// [MetadataService.PurgeArtifacts][google.cloud.aiplatform.v1beta1.MetadataService.PurgeArtifacts]. message PurgeArtifactsMetadata { // Operation metadata for purging Artifacts. GenericOperationMetadata generic_metadata = 1; } -// Request message for [MetadataService.CreateContext][google.cloud.aiplatform.v1beta1.MetadataService.CreateContext]. +// Request message for +// [MetadataService.CreateContext][google.cloud.aiplatform.v1beta1.MetadataService.CreateContext]. message CreateContextRequest { - // Required. The resource name of the MetadataStore where the Context should be - // created. - // Format: + // Required. The resource name of the MetadataStore where the Context should + // be created. Format: // `projects/{project}/locations/{location}/metadataStores/{metadatastore}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, @@ -685,7 +728,8 @@ message CreateContextRequest { string context_id = 3; } -// Request message for [MetadataService.GetContext][google.cloud.aiplatform.v1beta1.MetadataService.GetContext]. +// Request message for +// [MetadataService.GetContext][google.cloud.aiplatform.v1beta1.MetadataService.GetContext]. message GetContextRequest { // Required. The resource name of the Context to retrieve. // Format: @@ -698,7 +742,8 @@ message GetContextRequest { ]; } -// Request message for [MetadataService.ListContexts][google.cloud.aiplatform.v1beta1.MetadataService.ListContexts] +// Request message for +// [MetadataService.ListContexts][google.cloud.aiplatform.v1beta1.MetadataService.ListContexts] message ListContextsRequest { // Required. The MetadataStore whose Contexts should be listed. // Format: @@ -714,7 +759,8 @@ message ListContextsRequest { // Must be in range 1-1000, inclusive. Defaults to 100. int32 page_size = 2; - // A page token, received from a previous [MetadataService.ListContexts][google.cloud.aiplatform.v1beta1.MetadataService.ListContexts] + // A page token, received from a previous + // [MetadataService.ListContexts][google.cloud.aiplatform.v1beta1.MetadataService.ListContexts] // call. Provide this to retrieve the subsequent page. // // When paginating, all other provided parameters must match the call that @@ -750,7 +796,8 @@ message ListContextsRequest { // ``` // // Each of the above supported filters can be combined together using - // logical operators (`AND` & `OR`). + // logical operators (`AND` & `OR`). Maximum nested expression depth allowed + // is 5. // // For example: `display_name = "test" AND metadata.field1.bool_value = true`. string filter = 4; @@ -764,36 +811,41 @@ message ListContextsRequest { string order_by = 5; } -// Response message for [MetadataService.ListContexts][google.cloud.aiplatform.v1beta1.MetadataService.ListContexts]. +// Response message for +// [MetadataService.ListContexts][google.cloud.aiplatform.v1beta1.MetadataService.ListContexts]. message ListContextsResponse { // The Contexts retrieved from the MetadataStore. repeated Context contexts = 1; - // A token, which can be sent as [ListContextsRequest.page_token][google.cloud.aiplatform.v1beta1.ListContextsRequest.page_token] + // A token, which can be sent as + // [ListContextsRequest.page_token][google.cloud.aiplatform.v1beta1.ListContextsRequest.page_token] // to retrieve the next page. // If this field is not populated, there are no subsequent pages. string next_page_token = 2; } -// Request message for [MetadataService.UpdateContext][google.cloud.aiplatform.v1beta1.MetadataService.UpdateContext]. +// Request message for +// [MetadataService.UpdateContext][google.cloud.aiplatform.v1beta1.MetadataService.UpdateContext]. message UpdateContextRequest { // Required. The Context containing updates. - // The Context's [Context.name][google.cloud.aiplatform.v1beta1.Context.name] field is used to identify the Context to be - // updated. - // Format: + // The Context's [Context.name][google.cloud.aiplatform.v1beta1.Context.name] + // field is used to identify the Context to be updated. Format: // `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}` Context context = 1 [(google.api.field_behavior) = REQUIRED]; // Optional. A FieldMask indicating which fields should be updated. // Functionality of this field is not yet supported. - google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = OPTIONAL]; + google.protobuf.FieldMask update_mask = 2 + [(google.api.field_behavior) = OPTIONAL]; - // If set to true, and the [Context][google.cloud.aiplatform.v1beta1.Context] is not found, a new [Context][google.cloud.aiplatform.v1beta1.Context] is + // If set to true, and the [Context][google.cloud.aiplatform.v1beta1.Context] + // is not found, a new [Context][google.cloud.aiplatform.v1beta1.Context] is // created. bool allow_missing = 3; } -// Request message for [MetadataService.DeleteContext][google.cloud.aiplatform.v1beta1.MetadataService.DeleteContext]. +// Request message for +// [MetadataService.DeleteContext][google.cloud.aiplatform.v1beta1.MetadataService.DeleteContext]. message DeleteContextRequest { // Required. The resource name of the Context to delete. // Format: @@ -815,7 +867,8 @@ message DeleteContextRequest { string etag = 3 [(google.api.field_behavior) = OPTIONAL]; } -// Request message for [MetadataService.PurgeContexts][google.cloud.aiplatform.v1beta1.MetadataService.PurgeContexts]. +// Request message for +// [MetadataService.PurgeContexts][google.cloud.aiplatform.v1beta1.MetadataService.PurgeContexts]. message PurgeContextsRequest { // Required. The metadata store to purge Contexts from. // Format: @@ -837,7 +890,8 @@ message PurgeContextsRequest { bool force = 3 [(google.api.field_behavior) = OPTIONAL]; } -// Response message for [MetadataService.PurgeContexts][google.cloud.aiplatform.v1beta1.MetadataService.PurgeContexts]. +// Response message for +// [MetadataService.PurgeContexts][google.cloud.aiplatform.v1beta1.MetadataService.PurgeContexts]. message PurgeContextsResponse { // The number of Contexts that this request deleted (or, if `force` is false, // the number of Contexts that will be deleted). This can be an estimate. @@ -847,21 +901,22 @@ message PurgeContextsResponse { // Only populated if `force` is set to false. The maximum number of samples is // 100 (it is possible to return fewer). repeated string purge_sample = 2 [(google.api.resource_reference) = { - type: "aiplatform.googleapis.com/Context" - }]; + type: "aiplatform.googleapis.com/Context" + }]; } -// Details of operations that perform [MetadataService.PurgeContexts][google.cloud.aiplatform.v1beta1.MetadataService.PurgeContexts]. +// Details of operations that perform +// [MetadataService.PurgeContexts][google.cloud.aiplatform.v1beta1.MetadataService.PurgeContexts]. message PurgeContextsMetadata { // Operation metadata for purging Contexts. GenericOperationMetadata generic_metadata = 1; } -// Request message for [MetadataService.AddContextArtifactsAndExecutions][google.cloud.aiplatform.v1beta1.MetadataService.AddContextArtifactsAndExecutions]. +// Request message for +// [MetadataService.AddContextArtifactsAndExecutions][google.cloud.aiplatform.v1beta1.MetadataService.AddContextArtifactsAndExecutions]. message AddContextArtifactsAndExecutionsRequest { - // Required. The resource name of the Context that the Artifacts and Executions - // belong to. - // Format: + // Required. The resource name of the Context that the Artifacts and + // Executions belong to. Format: // `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}` string context = 1 [ (google.api.field_behavior) = REQUIRED, @@ -875,8 +930,8 @@ message AddContextArtifactsAndExecutionsRequest { // Format: // `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` repeated string artifacts = 2 [(google.api.resource_reference) = { - type: "aiplatform.googleapis.com/Artifact" - }]; + type: "aiplatform.googleapis.com/Artifact" + }]; // The resource names of the Executions to associate with the // Context. @@ -884,16 +939,16 @@ message AddContextArtifactsAndExecutionsRequest { // Format: // `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` repeated string executions = 3 [(google.api.resource_reference) = { - type: "aiplatform.googleapis.com/Execution" - }]; + type: "aiplatform.googleapis.com/Execution" + }]; } -// Response message for [MetadataService.AddContextArtifactsAndExecutions][google.cloud.aiplatform.v1beta1.MetadataService.AddContextArtifactsAndExecutions]. -message AddContextArtifactsAndExecutionsResponse { - -} +// Response message for +// [MetadataService.AddContextArtifactsAndExecutions][google.cloud.aiplatform.v1beta1.MetadataService.AddContextArtifactsAndExecutions]. +message AddContextArtifactsAndExecutionsResponse {} -// Request message for [MetadataService.AddContextChildren][google.cloud.aiplatform.v1beta1.MetadataService.AddContextChildren]. +// Request message for +// [MetadataService.AddContextChildren][google.cloud.aiplatform.v1beta1.MetadataService.AddContextChildren]. message AddContextChildrenRequest { // Required. The resource name of the parent Context. // @@ -908,14 +963,13 @@ message AddContextChildrenRequest { // The resource names of the child Contexts. repeated string child_contexts = 2 [(google.api.resource_reference) = { - type: "aiplatform.googleapis.com/Context" - }]; + type: "aiplatform.googleapis.com/Context" + }]; } -// Response message for [MetadataService.AddContextChildren][google.cloud.aiplatform.v1beta1.MetadataService.AddContextChildren]. -message AddContextChildrenResponse { - -} +// Response message for +// [MetadataService.AddContextChildren][google.cloud.aiplatform.v1beta1.MetadataService.AddContextChildren]. +message AddContextChildrenResponse {} // Request message for // [MetadataService.DeleteContextChildrenRequest][]. @@ -933,16 +987,16 @@ message RemoveContextChildrenRequest { // The resource names of the child Contexts. repeated string child_contexts = 2 [(google.api.resource_reference) = { - type: "aiplatform.googleapis.com/Context" - }]; + type: "aiplatform.googleapis.com/Context" + }]; } -// Response message for [MetadataService.RemoveContextChildren][google.cloud.aiplatform.v1beta1.MetadataService.RemoveContextChildren]. -message RemoveContextChildrenResponse { +// Response message for +// [MetadataService.RemoveContextChildren][google.cloud.aiplatform.v1beta1.MetadataService.RemoveContextChildren]. +message RemoveContextChildrenResponse {} -} - -// Request message for [MetadataService.QueryContextLineageSubgraph][google.cloud.aiplatform.v1beta1.MetadataService.QueryContextLineageSubgraph]. +// Request message for +// [MetadataService.QueryContextLineageSubgraph][google.cloud.aiplatform.v1beta1.MetadataService.QueryContextLineageSubgraph]. message QueryContextLineageSubgraphRequest { // Required. The resource name of the Context whose Artifacts and Executions // should be retrieved as a LineageSubgraph. @@ -960,7 +1014,8 @@ message QueryContextLineageSubgraphRequest { ]; } -// Request message for [MetadataService.CreateExecution][google.cloud.aiplatform.v1beta1.MetadataService.CreateExecution]. +// Request message for +// [MetadataService.CreateExecution][google.cloud.aiplatform.v1beta1.MetadataService.CreateExecution]. message CreateExecutionRequest { // Required. The resource name of the MetadataStore where the Execution should // be created. @@ -987,7 +1042,8 @@ message CreateExecutionRequest { string execution_id = 3; } -// Request message for [MetadataService.GetExecution][google.cloud.aiplatform.v1beta1.MetadataService.GetExecution]. +// Request message for +// [MetadataService.GetExecution][google.cloud.aiplatform.v1beta1.MetadataService.GetExecution]. message GetExecutionRequest { // Required. The resource name of the Execution to retrieve. // Format: @@ -1000,7 +1056,8 @@ message GetExecutionRequest { ]; } -// Request message for [MetadataService.ListExecutions][google.cloud.aiplatform.v1beta1.MetadataService.ListExecutions]. +// Request message for +// [MetadataService.ListExecutions][google.cloud.aiplatform.v1beta1.MetadataService.ListExecutions]. message ListExecutionsRequest { // Required. The MetadataStore whose Executions should be listed. // Format: @@ -1016,7 +1073,8 @@ message ListExecutionsRequest { // Must be in range 1-1000, inclusive. Defaults to 100. int32 page_size = 2; - // A page token, received from a previous [MetadataService.ListExecutions][google.cloud.aiplatform.v1beta1.MetadataService.ListExecutions] + // A page token, received from a previous + // [MetadataService.ListExecutions][google.cloud.aiplatform.v1beta1.MetadataService.ListExecutions] // call. Provide this to retrieve the subsequent page. // // When paginating, all other provided parameters must match the call that @@ -1048,7 +1106,9 @@ message ListExecutionsRequest { // `in_context("projects//locations//metadataStores//contexts/")` // // Each of the above supported filters can be combined together using - // logical operators (`AND` & `OR`). + // logical operators (`AND` & `OR`). Maximum nested expression depth allowed + // is 5. + // // For example: `display_name = "test" AND metadata.field1.bool_value = true`. string filter = 4; @@ -1061,36 +1121,42 @@ message ListExecutionsRequest { string order_by = 5; } -// Response message for [MetadataService.ListExecutions][google.cloud.aiplatform.v1beta1.MetadataService.ListExecutions]. +// Response message for +// [MetadataService.ListExecutions][google.cloud.aiplatform.v1beta1.MetadataService.ListExecutions]. message ListExecutionsResponse { // The Executions retrieved from the MetadataStore. repeated Execution executions = 1; - // A token, which can be sent as [ListExecutionsRequest.page_token][google.cloud.aiplatform.v1beta1.ListExecutionsRequest.page_token] + // A token, which can be sent as + // [ListExecutionsRequest.page_token][google.cloud.aiplatform.v1beta1.ListExecutionsRequest.page_token] // to retrieve the next page. // If this field is not populated, there are no subsequent pages. string next_page_token = 2; } -// Request message for [MetadataService.UpdateExecution][google.cloud.aiplatform.v1beta1.MetadataService.UpdateExecution]. +// Request message for +// [MetadataService.UpdateExecution][google.cloud.aiplatform.v1beta1.MetadataService.UpdateExecution]. message UpdateExecutionRequest { // Required. The Execution containing updates. - // The Execution's [Execution.name][google.cloud.aiplatform.v1beta1.Execution.name] field is used to identify the Execution - // to be updated. - // Format: + // The Execution's + // [Execution.name][google.cloud.aiplatform.v1beta1.Execution.name] field is + // used to identify the Execution to be updated. Format: // `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` Execution execution = 1 [(google.api.field_behavior) = REQUIRED]; // Optional. A FieldMask indicating which fields should be updated. // Functionality of this field is not yet supported. - google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = OPTIONAL]; + google.protobuf.FieldMask update_mask = 2 + [(google.api.field_behavior) = OPTIONAL]; - // If set to true, and the [Execution][google.cloud.aiplatform.v1beta1.Execution] is not found, a new [Execution][google.cloud.aiplatform.v1beta1.Execution] - // is created. + // If set to true, and the + // [Execution][google.cloud.aiplatform.v1beta1.Execution] is not found, a new + // [Execution][google.cloud.aiplatform.v1beta1.Execution] is created. bool allow_missing = 3; } -// Request message for [MetadataService.DeleteExecution][google.cloud.aiplatform.v1beta1.MetadataService.DeleteExecution]. +// Request message for +// [MetadataService.DeleteExecution][google.cloud.aiplatform.v1beta1.MetadataService.DeleteExecution]. message DeleteExecutionRequest { // Required. The resource name of the Execution to delete. // Format: @@ -1108,7 +1174,8 @@ message DeleteExecutionRequest { string etag = 2 [(google.api.field_behavior) = OPTIONAL]; } -// Request message for [MetadataService.PurgeExecutions][google.cloud.aiplatform.v1beta1.MetadataService.PurgeExecutions]. +// Request message for +// [MetadataService.PurgeExecutions][google.cloud.aiplatform.v1beta1.MetadataService.PurgeExecutions]. message PurgeExecutionsRequest { // Required. The metadata store to purge Executions from. // Format: @@ -1130,7 +1197,8 @@ message PurgeExecutionsRequest { bool force = 3 [(google.api.field_behavior) = OPTIONAL]; } -// Response message for [MetadataService.PurgeExecutions][google.cloud.aiplatform.v1beta1.MetadataService.PurgeExecutions]. +// Response message for +// [MetadataService.PurgeExecutions][google.cloud.aiplatform.v1beta1.MetadataService.PurgeExecutions]. message PurgeExecutionsResponse { // The number of Executions that this request deleted (or, if `force` is // false, the number of Executions that will be deleted). This can be an @@ -1141,17 +1209,19 @@ message PurgeExecutionsResponse { // Only populated if `force` is set to false. The maximum number of samples is // 100 (it is possible to return fewer). repeated string purge_sample = 2 [(google.api.resource_reference) = { - type: "aiplatform.googleapis.com/Execution" - }]; + type: "aiplatform.googleapis.com/Execution" + }]; } -// Details of operations that perform [MetadataService.PurgeExecutions][google.cloud.aiplatform.v1beta1.MetadataService.PurgeExecutions]. +// Details of operations that perform +// [MetadataService.PurgeExecutions][google.cloud.aiplatform.v1beta1.MetadataService.PurgeExecutions]. message PurgeExecutionsMetadata { // Operation metadata for purging Executions. GenericOperationMetadata generic_metadata = 1; } -// Request message for [MetadataService.AddExecutionEvents][google.cloud.aiplatform.v1beta1.MetadataService.AddExecutionEvents]. +// Request message for +// [MetadataService.AddExecutionEvents][google.cloud.aiplatform.v1beta1.MetadataService.AddExecutionEvents]. message AddExecutionEventsRequest { // Required. The resource name of the Execution that the Events connect // Artifacts with. @@ -1168,16 +1238,15 @@ message AddExecutionEventsRequest { repeated Event events = 2; } -// Response message for [MetadataService.AddExecutionEvents][google.cloud.aiplatform.v1beta1.MetadataService.AddExecutionEvents]. -message AddExecutionEventsResponse { +// Response message for +// [MetadataService.AddExecutionEvents][google.cloud.aiplatform.v1beta1.MetadataService.AddExecutionEvents]. +message AddExecutionEventsResponse {} -} - -// Request message for [MetadataService.QueryExecutionInputsAndOutputs][google.cloud.aiplatform.v1beta1.MetadataService.QueryExecutionInputsAndOutputs]. +// Request message for +// [MetadataService.QueryExecutionInputsAndOutputs][google.cloud.aiplatform.v1beta1.MetadataService.QueryExecutionInputsAndOutputs]. message QueryExecutionInputsAndOutputsRequest { - // Required. The resource name of the Execution whose input and output Artifacts should - // be retrieved as a LineageSubgraph. - // Format: + // Required. The resource name of the Execution whose input and output + // Artifacts should be retrieved as a LineageSubgraph. Format: // `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` string execution = 1 [ (google.api.field_behavior) = REQUIRED, @@ -1187,11 +1256,11 @@ message QueryExecutionInputsAndOutputsRequest { ]; } -// Request message for [MetadataService.CreateMetadataSchema][google.cloud.aiplatform.v1beta1.MetadataService.CreateMetadataSchema]. +// Request message for +// [MetadataService.CreateMetadataSchema][google.cloud.aiplatform.v1beta1.MetadataService.CreateMetadataSchema]. message CreateMetadataSchemaRequest { - // Required. The resource name of the MetadataStore where the MetadataSchema should - // be created. - // Format: + // Required. The resource name of the MetadataStore where the MetadataSchema + // should be created. Format: // `projects/{project}/locations/{location}/metadataStores/{metadatastore}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, @@ -1214,7 +1283,8 @@ message CreateMetadataSchemaRequest { string metadata_schema_id = 3; } -// Request message for [MetadataService.GetMetadataSchema][google.cloud.aiplatform.v1beta1.MetadataService.GetMetadataSchema]. +// Request message for +// [MetadataService.GetMetadataSchema][google.cloud.aiplatform.v1beta1.MetadataService.GetMetadataSchema]. message GetMetadataSchemaRequest { // Required. The resource name of the MetadataSchema to retrieve. // Format: @@ -1227,7 +1297,8 @@ message GetMetadataSchemaRequest { ]; } -// Request message for [MetadataService.ListMetadataSchemas][google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataSchemas]. +// Request message for +// [MetadataService.ListMetadataSchemas][google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataSchemas]. message ListMetadataSchemasRequest { // Required. The MetadataStore whose MetadataSchemas should be listed. // Format: @@ -1245,8 +1316,8 @@ message ListMetadataSchemasRequest { int32 page_size = 2; // A page token, received from a previous - // [MetadataService.ListMetadataSchemas][google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataSchemas] call. Provide this to retrieve the - // next page. + // [MetadataService.ListMetadataSchemas][google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataSchemas] + // call. Provide this to retrieve the next page. // // When paginating, all other provided parameters must match the call that // provided the page token. (Otherwise the request will fail with @@ -1257,22 +1328,24 @@ message ListMetadataSchemasRequest { string filter = 4; } -// Response message for [MetadataService.ListMetadataSchemas][google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataSchemas]. +// Response message for +// [MetadataService.ListMetadataSchemas][google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataSchemas]. message ListMetadataSchemasResponse { // The MetadataSchemas found for the MetadataStore. repeated MetadataSchema metadata_schemas = 1; // A token, which can be sent as - // [ListMetadataSchemasRequest.page_token][google.cloud.aiplatform.v1beta1.ListMetadataSchemasRequest.page_token] to retrieve the next - // page. If this field is not populated, there are no subsequent pages. + // [ListMetadataSchemasRequest.page_token][google.cloud.aiplatform.v1beta1.ListMetadataSchemasRequest.page_token] + // to retrieve the next page. If this field is not populated, there are no + // subsequent pages. string next_page_token = 2; } -// Request message for [MetadataService.QueryArtifactLineageSubgraph][google.cloud.aiplatform.v1beta1.MetadataService.QueryArtifactLineageSubgraph]. +// Request message for +// [MetadataService.QueryArtifactLineageSubgraph][google.cloud.aiplatform.v1beta1.MetadataService.QueryArtifactLineageSubgraph]. message QueryArtifactLineageSubgraphRequest { - // Required. The resource name of the Artifact whose Lineage needs to be retrieved as a - // LineageSubgraph. - // Format: + // Required. The resource name of the Artifact whose Lineage needs to be + // retrieved as a LineageSubgraph. Format: // `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` // // The request may error with FAILED_PRECONDITION if the number of Artifacts, @@ -1310,7 +1383,8 @@ message QueryArtifactLineageSubgraphRequest { // For example: `metadata.field_1.number_value = 10.0` // // Each of the above supported filter types can be combined together using - // logical operators (`AND` & `OR`). + // logical operators (`AND` & `OR`). Maximum nested expression depth allowed + // is 5. // // For example: `display_name = "test" AND metadata.field1.bool_value = true`. string filter = 3; diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/metadata_store.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/metadata_store.proto index 2d8a19d3a1b..7e6bcbcb805 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/metadata_store.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/metadata_store.proto @@ -47,10 +47,12 @@ message MetadataStore { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this MetadataStore was created. - google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this MetadataStore was last updated. - google.protobuf.Timestamp update_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Customer-managed encryption key spec for a Metadata Store. If set, this // Metadata Store and all sub-resources of this Metadata Store are secured diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/migratable_resource.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/migratable_resource.proto index bd8aa73013a..e0995f3d37d 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/migratable_resource.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/migratable_resource.proto @@ -65,9 +65,9 @@ message MigratableResource { // Full resource name of ml engine model Version. // Format: `projects/{project}/models/{model}/versions/{version}`. - string version = 2 [(google.api.resource_reference) = { - type: "ml.googleapis.com/Version" - }]; + string version = 2 [ + (google.api.resource_reference) = { type: "ml.googleapis.com/Version" } + ]; } // Represents one Model in automl.googleapis.com. @@ -75,9 +75,9 @@ message MigratableResource { // Full resource name of automl Model. // Format: // `projects/{project}/locations/{location}/models/{model}`. - string model = 1 [(google.api.resource_reference) = { - type: "automl.googleapis.com/Model" - }]; + string model = 1 [ + (google.api.resource_reference) = { type: "automl.googleapis.com/Model" } + ]; // The Model's display name in automl.googleapis.com. string model_display_name = 3; @@ -89,8 +89,8 @@ message MigratableResource { // Format: // `projects/{project}/locations/{location}/datasets/{dataset}`. string dataset = 1 [(google.api.resource_reference) = { - type: "automl.googleapis.com/Dataset" - }]; + type: "automl.googleapis.com/Dataset" + }]; // The Dataset's display name in automl.googleapis.com. string dataset_display_name = 4; @@ -104,8 +104,8 @@ message MigratableResource { // Format: // `projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}`. string annotated_dataset = 1 [(google.api.resource_reference) = { - type: "datalabeling.googleapis.com/AnnotatedDataset" - }]; + type: "datalabeling.googleapis.com/AnnotatedDataset" + }]; // The AnnotatedDataset's display name in datalabeling.googleapis.com. string annotated_dataset_display_name = 3; @@ -115,8 +115,8 @@ message MigratableResource { // Format: // `projects/{project}/datasets/{dataset}`. string dataset = 1 [(google.api.resource_reference) = { - type: "datalabeling.googleapis.com/Dataset" - }]; + type: "datalabeling.googleapis.com/Dataset" + }]; // The Dataset's display name in datalabeling.googleapis.com. string dataset_display_name = 4; @@ -128,23 +128,28 @@ message MigratableResource { oneof resource { // Output only. Represents one Version in ml.googleapis.com. - MlEngineModelVersion ml_engine_model_version = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + MlEngineModelVersion ml_engine_model_version = 1 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Represents one Model in automl.googleapis.com. AutomlModel automl_model = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Represents one Dataset in automl.googleapis.com. - AutomlDataset automl_dataset = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + AutomlDataset automl_dataset = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Represents one Dataset in datalabeling.googleapis.com. - DataLabelingDataset data_labeling_dataset = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + DataLabelingDataset data_labeling_dataset = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; } - // Output only. Timestamp when the last migration attempt on this MigratableResource - // started. Will not be set if there's no migration attempt on this - // MigratableResource. - google.protobuf.Timestamp last_migrate_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. Timestamp when the last migration attempt on this + // MigratableResource started. Will not be set if there's no migration attempt + // on this MigratableResource. + google.protobuf.Timestamp last_migrate_time = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this MigratableResource was last updated. - google.protobuf.Timestamp last_update_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp last_update_time = 6 + [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/migration_service.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/migration_service.proto index f08ad889c6b..c3db729b533 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/migration_service.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/migration_service.proto @@ -37,12 +37,14 @@ option ruby_package = "Google::Cloud::AIPlatform::V1beta1"; // datalabeling.googleapis.com and ml.googleapis.com to Vertex AI. service MigrationService { option (google.api.default_host) = "aiplatform.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/cloud-platform"; // 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. - rpc SearchMigratableResources(SearchMigratableResourcesRequest) returns (SearchMigratableResourcesResponse) { + rpc SearchMigratableResources(SearchMigratableResourcesRequest) + returns (SearchMigratableResourcesResponse) { option (google.api.http) = { post: "/v1beta1/{parent=projects/*/locations/*}/migratableResources:search" body: "*" @@ -52,7 +54,8 @@ service MigrationService { // Batch migrates resources from ml.googleapis.com, automl.googleapis.com, // and datalabeling.googleapis.com to Vertex AI. - rpc BatchMigrateResources(BatchMigrateResourcesRequest) returns (google.longrunning.Operation) { + rpc BatchMigrateResources(BatchMigrateResourcesRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta1/{parent=projects/*/locations/*}/migratableResources:batchMigrate" body: "*" @@ -65,12 +68,12 @@ service MigrationService { } } -// Request message for [MigrationService.SearchMigratableResources][google.cloud.aiplatform.v1beta1.MigrationService.SearchMigratableResources]. +// Request message for +// [MigrationService.SearchMigratableResources][google.cloud.aiplatform.v1beta1.MigrationService.SearchMigratableResources]. message SearchMigratableResourcesRequest { - // Required. The location that the migratable resources should be searched from. - // It's the Vertex AI location that the resources can be migrated to, not - // the resources' original location. - // Format: + // Required. The location that the migratable resources should be searched + // from. It's the Vertex AI location that the resources can be migrated to, + // not the resources' original location. Format: // `projects/{project}/locations/{location}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, @@ -89,7 +92,8 @@ message SearchMigratableResourcesRequest { // A filter for your search. You can use the following types of filters: // // * Resource type filters. The following strings filter for a specific type - // of [MigratableResource][google.cloud.aiplatform.v1beta1.MigratableResource]: + // of + // [MigratableResource][google.cloud.aiplatform.v1beta1.MigratableResource]: // * `ml_engine_model_version:*` // * `automl_model:*` // * `automl_dataset:*` @@ -101,7 +105,8 @@ message SearchMigratableResourcesRequest { string filter = 4; } -// Response message for [MigrationService.SearchMigratableResources][google.cloud.aiplatform.v1beta1.MigrationService.SearchMigratableResources]. +// Response message for +// [MigrationService.SearchMigratableResources][google.cloud.aiplatform.v1beta1.MigrationService.SearchMigratableResources]. message SearchMigratableResourcesResponse { // All migratable resources that can be migrated to the // location specified in the request. @@ -113,7 +118,8 @@ message SearchMigratableResourcesResponse { string next_page_token = 2; } -// Request message for [MigrationService.BatchMigrateResources][google.cloud.aiplatform.v1beta1.MigrationService.BatchMigrateResources]. +// Request message for +// [MigrationService.BatchMigrateResources][google.cloud.aiplatform.v1beta1.MigrationService.BatchMigrateResources]. message BatchMigrateResourcesRequest { // Required. The location of the migrated resource will live in. // Format: `projects/{project}/locations/{location}` @@ -127,7 +133,8 @@ message BatchMigrateResourcesRequest { // Required. The request messages specifying the resources to migrate. // They must be in the same location as the destination. // Up to 50 resources can be migrated in one batch. - repeated MigrateResourceRequest migrate_resource_requests = 2 [(google.api.field_behavior) = REQUIRED]; + repeated MigrateResourceRequest migrate_resource_requests = 2 + [(google.api.field_behavior) = REQUIRED]; } // Config of migrating one resource from automl.googleapis.com, @@ -135,9 +142,8 @@ message BatchMigrateResourcesRequest { message MigrateResourceRequest { // Config for migrating version in ml.googleapis.com to Vertex AI's Model. message MigrateMlEngineModelVersionConfig { - // Required. The ml.googleapis.com endpoint that this model version should be migrated - // from. - // Example values: + // Required. The ml.googleapis.com endpoint that this model version should + // be migrated from. Example values: // // * ml.googleapis.com // @@ -152,9 +158,7 @@ message MigrateResourceRequest { // Format: `projects/{project}/models/{model}/versions/{version}`. string model_version = 2 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "ml.googleapis.com/Version" - } + (google.api.resource_reference) = { type: "ml.googleapis.com/Version" } ]; // Required. Display name of the model in Vertex AI. @@ -169,9 +173,7 @@ message MigrateResourceRequest { // `projects/{project}/locations/{location}/models/{model}`. string model = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "automl.googleapis.com/Model" - } + (google.api.resource_reference) = { type: "automl.googleapis.com/Model" } ]; // Optional. Display name of the model in Vertex AI. @@ -228,15 +230,18 @@ message MigrateResourceRequest { // System will pick a display name if unspecified. string dataset_display_name = 2 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Configs for migrating AnnotatedDataset in datalabeling.googleapis.com to - // Vertex AI's SavedQuery. The specified AnnotatedDatasets have to belong - // to the datalabeling Dataset. - repeated MigrateDataLabelingAnnotatedDatasetConfig migrate_data_labeling_annotated_dataset_configs = 3 [(google.api.field_behavior) = OPTIONAL]; + // Optional. Configs for migrating AnnotatedDataset in + // datalabeling.googleapis.com to Vertex AI's SavedQuery. The specified + // AnnotatedDatasets have to belong to the datalabeling Dataset. + repeated MigrateDataLabelingAnnotatedDatasetConfig + migrate_data_labeling_annotated_dataset_configs = 3 + [(google.api.field_behavior) = OPTIONAL]; } oneof request { // Config for migrating Version in ml.googleapis.com to Vertex AI's Model. - MigrateMlEngineModelVersionConfig migrate_ml_engine_model_version_config = 1; + MigrateMlEngineModelVersionConfig migrate_ml_engine_model_version_config = + 1; // Config for migrating Model in automl.googleapis.com to Vertex AI's // Model. @@ -252,7 +257,8 @@ message MigrateResourceRequest { } } -// Response message for [MigrationService.BatchMigrateResources][google.cloud.aiplatform.v1beta1.MigrationService.BatchMigrateResources]. +// Response message for +// [MigrationService.BatchMigrateResources][google.cloud.aiplatform.v1beta1.MigrationService.BatchMigrateResources]. message BatchMigrateResourcesResponse { // Successfully migrated resources. repeated MigrateResourceResponse migrate_resource_responses = 1; @@ -264,13 +270,13 @@ message MigrateResourceResponse { oneof migrated_resource { // Migrated Dataset's resource name. string dataset = 1 [(google.api.resource_reference) = { - type: "aiplatform.googleapis.com/Dataset" - }]; + type: "aiplatform.googleapis.com/Dataset" + }]; // Migrated Model's resource name. string model = 2 [(google.api.resource_reference) = { - type: "aiplatform.googleapis.com/Model" - }]; + type: "aiplatform.googleapis.com/Model" + }]; } // Before migration, the identifier in ml.googleapis.com, @@ -278,7 +284,8 @@ message MigrateResourceResponse { MigratableResource migratable_resource = 3; } -// Runtime operation information for [MigrationService.BatchMigrateResources][google.cloud.aiplatform.v1beta1.MigrationService.BatchMigrateResources]. +// Runtime operation information for +// [MigrationService.BatchMigrateResources][google.cloud.aiplatform.v1beta1.MigrationService.BatchMigrateResources]. message BatchMigrateResourcesOperationMetadata { // Represents a partial result in batch migration operation for one // [MigrateResourceRequest][google.cloud.aiplatform.v1beta1.MigrateResourceRequest]. @@ -292,13 +299,13 @@ message BatchMigrateResourcesOperationMetadata { // Migrated model resource name. string model = 3 [(google.api.resource_reference) = { - type: "aiplatform.googleapis.com/Model" - }]; + type: "aiplatform.googleapis.com/Model" + }]; // Migrated dataset resource name. string dataset = 4 [(google.api.resource_reference) = { - type: "aiplatform.googleapis.com/Dataset" - }]; + type: "aiplatform.googleapis.com/Dataset" + }]; } // It's the same as the value in diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/model.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/model.proto index 9e408aebda4..8c7b0fdc73f 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/model.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/model.proto @@ -50,12 +50,15 @@ message Model { // Model artifact and any of its supported files. Will be exported to the // location specified by the `artifactDestination` field of the - // [ExportModelRequest.output_config][google.cloud.aiplatform.v1beta1.ExportModelRequest.output_config] object. + // [ExportModelRequest.output_config][google.cloud.aiplatform.v1beta1.ExportModelRequest.output_config] + // object. ARTIFACT = 1; // The container image that is to be used when deploying this Model. Will // be exported to the location specified by the `imageDestination` field - // of the [ExportModelRequest.output_config][google.cloud.aiplatform.v1beta1.ExportModelRequest.output_config] object. + // of the + // [ExportModelRequest.output_config][google.cloud.aiplatform.v1beta1.ExportModelRequest.output_config] + // object. IMAGE = 2; } @@ -83,7 +86,8 @@ message Model { string id = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The content of this Model that may be exported. - repeated ExportableContent exportable_contents = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + repeated ExportableContent exportable_contents = 2 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // Identifies a type of Model's prediction resources. @@ -91,16 +95,20 @@ message Model { // Should not be used. DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED = 0; - // Resources that are dedicated to the [DeployedModel][google.cloud.aiplatform.v1beta1.DeployedModel], and that need a - // higher degree of manual configuration. + // Resources that are dedicated to the + // [DeployedModel][google.cloud.aiplatform.v1beta1.DeployedModel], and that + // need a higher degree of manual configuration. DEDICATED_RESOURCES = 1; // Resources that to large degree are decided by Vertex AI, and require // only a modest additional configuration. AUTOMATIC_RESOURCES = 2; - // Resources that can be shared by multiple [DeployedModels][google.cloud.aiplatform.v1beta1.DeployedModel]. - // A pre-configured [DeploymentResourcePool][google.cloud.aiplatform.v1beta1.DeploymentResourcePool] is required. + // Resources that can be shared by multiple + // [DeployedModels][google.cloud.aiplatform.v1beta1.DeployedModel]. A + // pre-configured + // [DeploymentResourcePool][google.cloud.aiplatform.v1beta1.DeploymentResourcePool] + // is required. SHARED_RESOURCES = 3; } @@ -118,9 +126,9 @@ message Model { // User provided version aliases so that a model version can be referenced via // alias (i.e. - // projects/{project}/locations/{location}/models/{model_id}@{version_alias} + // `projects/{project}/locations/{location}/models/{model_id}@{version_alias}` // instead of auto-generated version id (i.e. - // projects/{project}/locations/{location}/models/{model_id}@{version_id}). + // `projects/{project}/locations/{location}/models/{model_id}@{version_id})`. // The format is [a-z][a-zA-Z0-9-]{0,126}[a-z0-9] to distinguish from // version_id. A default version alias will be created for the first version // of the model, and there must be exactly one default version alias for a @@ -128,13 +136,15 @@ message Model { repeated string version_aliases = 29; // Output only. Timestamp when this version was created. - google.protobuf.Timestamp version_create_time = 31 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp version_create_time = 31 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this version was most recently updated. - google.protobuf.Timestamp version_update_time = 32 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp version_update_time = 32 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. The display name of the Model. - // The name can be up to 128 characters long and can be consist of any UTF-8 + // The name can be up to 128 characters long and can consist of any UTF-8 // characters. string display_name = 2 [(google.api.field_behavior) = REQUIRED]; @@ -146,13 +156,15 @@ message Model { // The schemata that describe formats of the Model's predictions and // explanations as given and returned via - // [PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict] and [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain]. + // [PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict] + // and + // [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain]. PredictSchemata predict_schemata = 4; - // Immutable. Points to a YAML file stored on Google Cloud Storage describing additional - // information about the Model, that is specific to it. Unset if the Model - // does not have any additional information. - // The schema is defined as an OpenAPI 3.0.2 [Schema + // Immutable. Points to a YAML file stored on Google Cloud Storage describing + // additional information about the Model, that is specific to it. Unset if + // the Model does not have any additional information. The schema is defined + // as an OpenAPI 3.0.2 [Schema // Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). // AutoML Models always have this field populated by Vertex AI, if no // additional metadata is needed, this field is set to an empty string. @@ -161,17 +173,19 @@ message Model { // point to a location where the user only has a read access. string metadata_schema_uri = 5 [(google.api.field_behavior) = IMMUTABLE]; - // Immutable. An additional information about the Model; the schema of the metadata can - // be found in [metadata_schema][google.cloud.aiplatform.v1beta1.Model.metadata_schema_uri]. + // Immutable. An additional information about the Model; the schema of the + // metadata can be found in + // [metadata_schema][google.cloud.aiplatform.v1beta1.Model.metadata_schema_uri]. // Unset if the Model does not have any additional information. google.protobuf.Value metadata = 6 [(google.api.field_behavior) = IMMUTABLE]; - // Output only. The formats in which this Model may be exported. If empty, this Model is - // not available for export. - repeated ExportFormat supported_export_formats = 20 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. The formats in which this Model may be exported. If empty, + // this Model is not available for export. + repeated ExportFormat supported_export_formats = 20 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. The resource name of the TrainingPipeline that uploaded this Model, if - // any. + // Output only. The resource name of the TrainingPipeline that uploaded this + // Model, if any. string training_pipeline = 7 [ (google.api.field_behavior) = OUTPUT_ONLY, (google.api.resource_reference) = { @@ -179,35 +193,43 @@ message Model { } ]; - // Input only. The specification of the container that is to be used when deploying - // this Model. The specification is ingested upon - // [ModelService.UploadModel][google.cloud.aiplatform.v1beta1.ModelService.UploadModel], and all binaries it contains are copied - // and stored internally by Vertex AI. + // Input only. The specification of the container that is to be used when + // deploying this Model. The specification is ingested upon + // [ModelService.UploadModel][google.cloud.aiplatform.v1beta1.ModelService.UploadModel], + // and all binaries it contains are copied and stored internally by Vertex AI. // Not present for AutoML Models. - ModelContainerSpec container_spec = 9 [(google.api.field_behavior) = INPUT_ONLY]; + ModelContainerSpec container_spec = 9 + [(google.api.field_behavior) = INPUT_ONLY]; - // Immutable. The path to the directory containing the Model artifact and any of its - // supporting files. - // Not present for AutoML Models. + // Immutable. The path to the directory containing the Model artifact and any + // of its supporting files. Not present for AutoML Models. string artifact_uri = 26 [(google.api.field_behavior) = IMMUTABLE]; - // Output only. When this Model is deployed, its prediction resources are described by the - // `prediction_resources` field of the [Endpoint.deployed_models][google.cloud.aiplatform.v1beta1.Endpoint.deployed_models] object. - // Because not all Models support all resource configuration types, the - // configuration types this Model supports are listed here. If no + // Output only. When this Model is deployed, its prediction resources are + // described by the `prediction_resources` field of the + // [Endpoint.deployed_models][google.cloud.aiplatform.v1beta1.Endpoint.deployed_models] + // object. Because not all Models support all resource configuration types, + // the configuration types this Model supports are listed here. If no // configuration types are listed, the Model cannot be deployed to an // [Endpoint][google.cloud.aiplatform.v1beta1.Endpoint] and does not support - // online predictions ([PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict] or - // [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain]). Such a Model can serve predictions by - // using a [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob], if it has at least one entry each in - // [supported_input_storage_formats][google.cloud.aiplatform.v1beta1.Model.supported_input_storage_formats] and + // online predictions + // ([PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict] + // or + // [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain]). + // Such a Model can serve predictions by using a + // [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob], + // if it has at least one entry each in + // [supported_input_storage_formats][google.cloud.aiplatform.v1beta1.Model.supported_input_storage_formats] + // and // [supported_output_storage_formats][google.cloud.aiplatform.v1beta1.Model.supported_output_storage_formats]. - repeated DeploymentResourcesType supported_deployment_resources_types = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; + repeated DeploymentResourcesType supported_deployment_resources_types = 10 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The formats this Model supports in - // [BatchPredictionJob.input_config][google.cloud.aiplatform.v1beta1.BatchPredictionJob.input_config]. If - // [PredictSchemata.instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri] exists, the instances - // should be given as per that schema. + // [BatchPredictionJob.input_config][google.cloud.aiplatform.v1beta1.BatchPredictionJob.input_config]. + // If + // [PredictSchemata.instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri] + // exists, the instances should be given as per that schema. // // The possible formats are: // @@ -218,11 +240,13 @@ message Model { // * `csv` // The CSV format, where each instance is a single comma-separated line. // The first line in the file is the header, containing comma-separated field - // names. Uses [GcsSource][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig.gcs_source]. + // names. Uses + // [GcsSource][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig.gcs_source]. // // * `tf-record` // The TFRecord format, where each instance is a single record in tfrecord - // syntax. Uses [GcsSource][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig.gcs_source]. + // syntax. Uses + // [GcsSource][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig.gcs_source]. // // * `tf-record-gzip` // Similar to `tf-record`, but the file is gzipped. Uses @@ -235,23 +259,31 @@ message Model { // * `file-list` // Each line of the file is the location of an instance to process, uses // `gcs_source` field of the - // [InputConfig][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig] object. + // [InputConfig][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig] + // object. // // // If this Model doesn't support any of these formats it means it cannot be - // used with a [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob]. However, if it has - // [supported_deployment_resources_types][google.cloud.aiplatform.v1beta1.Model.supported_deployment_resources_types], it could serve online - // predictions by using [PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict] or + // used with a + // [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob]. + // However, if it has + // [supported_deployment_resources_types][google.cloud.aiplatform.v1beta1.Model.supported_deployment_resources_types], + // it could serve online predictions by using + // [PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict] + // or // [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain]. - repeated string supported_input_storage_formats = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; + repeated string supported_input_storage_formats = 11 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The formats this Model supports in - // [BatchPredictionJob.output_config][google.cloud.aiplatform.v1beta1.BatchPredictionJob.output_config]. If both - // [PredictSchemata.instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri] and - // [PredictSchemata.prediction_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.prediction_schema_uri] exist, the predictions - // are returned together with their instances. In other words, the - // prediction has the original instance data first, followed - // by the actual prediction content (as per the schema). + // [BatchPredictionJob.output_config][google.cloud.aiplatform.v1beta1.BatchPredictionJob.output_config]. + // If both + // [PredictSchemata.instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri] + // and + // [PredictSchemata.prediction_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.prediction_schema_uri] + // exist, the predictions are returned together with their instances. In other + // words, the prediction has the original instance data first, followed by the + // actual prediction content (as per the schema). // // The possible formats are: // @@ -272,43 +304,57 @@ message Model { // // // If this Model doesn't support any of these formats it means it cannot be - // used with a [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob]. However, if it has - // [supported_deployment_resources_types][google.cloud.aiplatform.v1beta1.Model.supported_deployment_resources_types], it could serve online - // predictions by using [PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict] or + // used with a + // [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob]. + // However, if it has + // [supported_deployment_resources_types][google.cloud.aiplatform.v1beta1.Model.supported_deployment_resources_types], + // it could serve online predictions by using + // [PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict] + // or // [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain]. - repeated string supported_output_storage_formats = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; + repeated string supported_output_storage_formats = 12 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this Model was uploaded into Vertex AI. - google.protobuf.Timestamp create_time = 13 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 13 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this Model was most recently updated. - google.protobuf.Timestamp update_time = 14 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 14 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. The pointers to DeployedModels created from this Model. Note that - // Model could have been deployed to Endpoints in different Locations. - repeated DeployedModelRef deployed_models = 15 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. The pointers to DeployedModels created from this Model. Note + // that Model could have been deployed to Endpoints in different Locations. + repeated DeployedModelRef deployed_models = 15 + [(google.api.field_behavior) = OUTPUT_ONLY]; // The default explanation specification for this Model. // // The Model can be used for [requesting // explanation][PredictionService.Explain] after being - // [deployed][google.cloud.aiplatform.v1beta1.EndpointService.DeployModel] if it is populated. - // The Model can be used for [batch + // [deployed][google.cloud.aiplatform.v1beta1.EndpointService.DeployModel] if + // it is populated. The Model can be used for [batch // explanation][BatchPredictionJob.generate_explanation] if it is populated. // // All fields of the explanation_spec can be overridden by - // [explanation_spec][google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec] of - // [DeployModelRequest.deployed_model][google.cloud.aiplatform.v1beta1.DeployModelRequest.deployed_model], or - // [explanation_spec][google.cloud.aiplatform.v1beta1.BatchPredictionJob.explanation_spec] of + // [explanation_spec][google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec] + // of + // [DeployModelRequest.deployed_model][google.cloud.aiplatform.v1beta1.DeployModelRequest.deployed_model], + // or + // [explanation_spec][google.cloud.aiplatform.v1beta1.BatchPredictionJob.explanation_spec] + // of // [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob]. // // If the default explanation specification is not set for this Model, this // Model can still be used for [requesting // explanation][PredictionService.Explain] by setting - // [explanation_spec][google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec] of - // [DeployModelRequest.deployed_model][google.cloud.aiplatform.v1beta1.DeployModelRequest.deployed_model] and for [batch - // explanation][BatchPredictionJob.generate_explanation] by setting - // [explanation_spec][google.cloud.aiplatform.v1beta1.BatchPredictionJob.explanation_spec] of + // [explanation_spec][google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec] + // of + // [DeployModelRequest.deployed_model][google.cloud.aiplatform.v1beta1.DeployModelRequest.deployed_model] + // and for [batch explanation][BatchPredictionJob.generate_explanation] by + // setting + // [explanation_spec][google.cloud.aiplatform.v1beta1.BatchPredictionJob.explanation_spec] + // of // [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob]. ExplanationSpec explanation_spec = 23; @@ -329,18 +375,28 @@ message Model { // Model and all sub-resources of this Model will be secured by this key. EncryptionSpec encryption_spec = 24; - // Output only. Source of a model. It can either be automl training pipeline, custom - // training pipeline, BigQuery ML, or existing Vertex AI Model. - ModelSourceInfo model_source_info = 38 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. Source of a model. It can either be automl training pipeline, + // custom training pipeline, BigQuery ML, or existing Vertex AI Model. + ModelSourceInfo model_source_info = 38 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The resource name of the Artifact that was created in + // MetadataStore when creating the Model. The Artifact resource name pattern + // is + // `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. + string metadata_artifact = 44 [(google.api.field_behavior) = OUTPUT_ONLY]; } // Contains the schemata used in Model's predictions and explanations via -// [PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict], [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain] and -// [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob]. +// [PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict], +// [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain] +// and [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob]. message PredictSchemata { - // Immutable. Points to a YAML file stored on Google Cloud Storage describing the format - // of a single instance, which are used in [PredictRequest.instances][google.cloud.aiplatform.v1beta1.PredictRequest.instances], - // [ExplainRequest.instances][google.cloud.aiplatform.v1beta1.ExplainRequest.instances] and + // Immutable. Points to a YAML file stored on Google Cloud Storage describing + // the format of a single instance, which are used in + // [PredictRequest.instances][google.cloud.aiplatform.v1beta1.PredictRequest.instances], + // [ExplainRequest.instances][google.cloud.aiplatform.v1beta1.ExplainRequest.instances] + // and // [BatchPredictionJob.input_config][google.cloud.aiplatform.v1beta1.BatchPredictionJob.input_config]. // The schema is defined as an OpenAPI 3.0.2 [Schema // Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). @@ -350,9 +406,11 @@ message PredictSchemata { // point to a location where the user only has a read access. string instance_schema_uri = 1 [(google.api.field_behavior) = IMMUTABLE]; - // Immutable. Points to a YAML file stored on Google Cloud Storage describing the - // parameters of prediction and explanation via - // [PredictRequest.parameters][google.cloud.aiplatform.v1beta1.PredictRequest.parameters], [ExplainRequest.parameters][google.cloud.aiplatform.v1beta1.ExplainRequest.parameters] and + // Immutable. Points to a YAML file stored on Google Cloud Storage describing + // the parameters of prediction and explanation via + // [PredictRequest.parameters][google.cloud.aiplatform.v1beta1.PredictRequest.parameters], + // [ExplainRequest.parameters][google.cloud.aiplatform.v1beta1.ExplainRequest.parameters] + // and // [BatchPredictionJob.model_parameters][google.cloud.aiplatform.v1beta1.BatchPredictionJob.model_parameters]. // The schema is defined as an OpenAPI 3.0.2 [Schema // Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). @@ -363,9 +421,12 @@ message PredictSchemata { // point to a location where the user only has a read access. string parameters_schema_uri = 2 [(google.api.field_behavior) = IMMUTABLE]; - // Immutable. Points to a YAML file stored on Google Cloud Storage describing the format - // of a single prediction produced by this Model, which are returned via - // [PredictResponse.predictions][google.cloud.aiplatform.v1beta1.PredictResponse.predictions], [ExplainResponse.explanations][google.cloud.aiplatform.v1beta1.ExplainResponse.explanations], and + // Immutable. Points to a YAML file stored on Google Cloud Storage describing + // the format of a single prediction produced by this Model, which are + // returned via + // [PredictResponse.predictions][google.cloud.aiplatform.v1beta1.PredictResponse.predictions], + // [ExplainResponse.explanations][google.cloud.aiplatform.v1beta1.ExplainResponse.explanations], + // and // [BatchPredictionJob.output_config][google.cloud.aiplatform.v1beta1.BatchPredictionJob.output_config]. // The schema is defined as an OpenAPI 3.0.2 [Schema // Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). @@ -380,14 +441,16 @@ message PredictSchemata { // message correspond to fields in the [Kubernetes Container v1 core // specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). message ModelContainerSpec { - // Required. Immutable. URI of the Docker image to be used as the custom container for serving - // predictions. This URI must identify an image in Artifact Registry or - // Container Registry. Learn more about the [container publishing + // Required. Immutable. URI of the Docker image to be used as the custom + // container for serving predictions. This URI must identify an image in + // Artifact Registry or Container Registry. Learn more about the [container + // publishing // requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#publishing), // including permissions requirements for the Vertex AI Service Agent. // - // The container image is ingested upon [ModelService.UploadModel][google.cloud.aiplatform.v1beta1.ModelService.UploadModel], stored - // internally, and this original path is afterwards not used. + // The container image is ingested upon + // [ModelService.UploadModel][google.cloud.aiplatform.v1beta1.ModelService.UploadModel], + // stored internally, and this original path is afterwards not used. // // To learn about the requirements for the Docker image itself, see // [Custom container @@ -401,18 +464,20 @@ message ModelContainerSpec { (google.api.field_behavior) = IMMUTABLE ]; - // Immutable. Specifies the command that runs when the container starts. This overrides - // the container's + // Immutable. Specifies the command that runs when the container starts. This + // overrides the container's // [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint). // Specify this field as an array of executable and arguments, similar to a // Docker `ENTRYPOINT`'s "exec" form, not its "shell" form. // // If you do not specify this field, then the container's `ENTRYPOINT` runs, - // in conjunction with the [args][google.cloud.aiplatform.v1beta1.ModelContainerSpec.args] field or the - // container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd), - // if either exists. If this field is not specified and the container does not - // have an `ENTRYPOINT`, then refer to the Docker documentation about [how - // `CMD` and `ENTRYPOINT` + // in conjunction with the + // [args][google.cloud.aiplatform.v1beta1.ModelContainerSpec.args] field or + // the container's + // [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd), if either + // exists. If this field is not specified and the container does not have an + // `ENTRYPOINT`, then refer to the Docker documentation about [how `CMD` and + // `ENTRYPOINT` // interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). // // If you specify this field, then you can also specify the `args` field to @@ -424,9 +489,10 @@ message ModelContainerSpec { // // In this field, you can reference [environment variables set by Vertex // AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) - // and environment variables set in the [env][google.cloud.aiplatform.v1beta1.ModelContainerSpec.env] field. - // You cannot reference environment variables set in the Docker image. In - // order for environment variables to be expanded, reference them by using the + // and environment variables set in the + // [env][google.cloud.aiplatform.v1beta1.ModelContainerSpec.env] field. You + // cannot reference environment variables set in the Docker image. In order + // for environment variables to be expanded, reference them by using the // following syntax: // $(VARIABLE_NAME) // Note that this differs from Bash variable expansion, which does not use @@ -439,16 +505,16 @@ message ModelContainerSpec { // API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). repeated string command = 2 [(google.api.field_behavior) = IMMUTABLE]; - // Immutable. Specifies arguments for the command that runs when the container starts. - // This overrides the container's + // Immutable. Specifies arguments for the command that runs when the container + // starts. This overrides the container's // [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify // this field as an array of executable and arguments, similar to a Docker // `CMD`'s "default parameters" form. // // If you don't specify this field but do specify the - // [command][google.cloud.aiplatform.v1beta1.ModelContainerSpec.command] field, then the command from the - // `command` field runs without any additional arguments. See the - // [Kubernetes documentation about how the + // [command][google.cloud.aiplatform.v1beta1.ModelContainerSpec.command] + // field, then the command from the `command` field runs without any + // additional arguments. See the [Kubernetes documentation about how the // `command` and `args` fields interact with a container's `ENTRYPOINT` and // `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). // @@ -462,9 +528,10 @@ message ModelContainerSpec { // In this field, you can reference [environment variables // set by Vertex // AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) - // and environment variables set in the [env][google.cloud.aiplatform.v1beta1.ModelContainerSpec.env] field. - // You cannot reference environment variables set in the Docker image. In - // order for environment variables to be expanded, reference them by using the + // and environment variables set in the + // [env][google.cloud.aiplatform.v1beta1.ModelContainerSpec.env] field. You + // cannot reference environment variables set in the Docker image. In order + // for environment variables to be expanded, reference them by using the // following syntax: // $(VARIABLE_NAME) // Note that this differs from Bash variable expansion, which does not use @@ -477,14 +544,16 @@ message ModelContainerSpec { // API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). repeated string args = 3 [(google.api.field_behavior) = IMMUTABLE]; - // Immutable. List of environment variables to set in the container. After the container - // starts running, code running in the container can read these environment - // variables. + // Immutable. List of environment variables to set in the container. After the + // container starts running, code running in the container can read these + // environment variables. // - // Additionally, the [command][google.cloud.aiplatform.v1beta1.ModelContainerSpec.command] and - // [args][google.cloud.aiplatform.v1beta1.ModelContainerSpec.args] fields can reference these variables. Later - // entries in this list can also reference earlier entries. For example, the - // following example sets the variable `VAR_2` to have the value `foo bar`: + // Additionally, the + // [command][google.cloud.aiplatform.v1beta1.ModelContainerSpec.command] and + // [args][google.cloud.aiplatform.v1beta1.ModelContainerSpec.args] fields can + // reference these variables. Later entries in this list can also reference + // earlier entries. For example, the following example sets the variable + // `VAR_2` to have the value `foo bar`: // // ```json // [ @@ -530,11 +599,11 @@ message ModelContainerSpec { // API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). repeated Port ports = 5 [(google.api.field_behavior) = IMMUTABLE]; - // Immutable. HTTP path on the container to send prediction requests to. Vertex AI - // forwards requests sent using - // [projects.locations.endpoints.predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict] to this - // path on the container's IP address and port. Vertex AI then returns the - // container's response in the API response. + // Immutable. HTTP path on the container to send prediction requests to. + // Vertex AI forwards requests sent using + // [projects.locations.endpoints.predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict] + // to this path on the container's IP address and port. Vertex AI then returns + // the container's response in the API response. // // For example, if you set this field to `/foo`, then when Vertex AI // receives a prediction request, it forwards the request body in a POST @@ -543,7 +612,8 @@ message ModelContainerSpec { // [ports][google.cloud.aiplatform.v1beta1.ModelContainerSpec.ports] field. // // If you don't specify this field, it defaults to the following value when - // you [deploy this Model to an Endpoint][google.cloud.aiplatform.v1beta1.EndpointService.DeployModel]: + // you [deploy this Model to an + // Endpoint][google.cloud.aiplatform.v1beta1.EndpointService.DeployModel]: // /v1/endpoints/ENDPOINT/deployedModels/DEPLOYED_MODEL:predict // The placeholders in this value are replaced as follows: // @@ -553,7 +623,9 @@ message ModelContainerSpec { // as the [`AIP_ENDPOINT_ID` environment // variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) // - // * DEPLOYED_MODEL: [DeployedModel.id][google.cloud.aiplatform.v1beta1.DeployedModel.id] of the `DeployedModel`. + // * DEPLOYED_MODEL: + // [DeployedModel.id][google.cloud.aiplatform.v1beta1.DeployedModel.id] of the + // `DeployedModel`. // (Vertex AI makes this value available to your container code // as the [`AIP_DEPLOYED_MODEL_ID` environment // variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) @@ -571,7 +643,8 @@ message ModelContainerSpec { // [ports][google.cloud.aiplatform.v1beta1.ModelContainerSpec.ports] field. // // If you don't specify this field, it defaults to the following value when - // you [deploy this Model to an Endpoint][google.cloud.aiplatform.v1beta1.EndpointService.DeployModel]: + // you [deploy this Model to an + // Endpoint][google.cloud.aiplatform.v1beta1.EndpointService.DeployModel]: // /v1/endpoints/ENDPOINT/deployedModels/DEPLOYED_MODEL:predict // The placeholders in this value are replaced as follows: // @@ -581,7 +654,9 @@ message ModelContainerSpec { // as the [`AIP_ENDPOINT_ID` environment // variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) // - // * DEPLOYED_MODEL: [DeployedModel.id][google.cloud.aiplatform.v1beta1.DeployedModel.id] of the `DeployedModel`. + // * DEPLOYED_MODEL: + // [DeployedModel.id][google.cloud.aiplatform.v1beta1.DeployedModel.id] of the + // `DeployedModel`. // (Vertex AI makes this value available to your container code as the // [`AIP_DEPLOYED_MODEL_ID` environment // variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/model_deployment_monitoring_job.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/model_deployment_monitoring_job.proto index 0446c1cc2ae..153417ed0aa 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/model_deployment_monitoring_job.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/model_deployment_monitoring_job.proto @@ -96,7 +96,7 @@ message ModelDeploymentMonitoringJob { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. The user-defined name of the ModelDeploymentMonitoringJob. - // The name can be up to 128 characters long and can be consist of any UTF-8 + // The name can be up to 128 characters long and can consist of any UTF-8 // characters. // Display name of a ModelDeploymentMonitoringJob. string display_name = 2 [(google.api.field_behavior) = REQUIRED]; @@ -118,20 +118,27 @@ message ModelDeploymentMonitoringJob { JobState state = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Schedule state when the monitoring job is in Running state. - MonitoringScheduleState schedule_state = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + MonitoringScheduleState schedule_state = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Latest triggered monitoring pipeline metadata. - LatestMonitoringPipelineMetadata latest_monitoring_pipeline_metadata = 25 [(google.api.field_behavior) = OUTPUT_ONLY]; + LatestMonitoringPipelineMetadata latest_monitoring_pipeline_metadata = 25 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Required. The config for monitoring objectives. This is a per DeployedModel config. - // Each DeployedModel needs to be configured separately. - repeated ModelDeploymentMonitoringObjectiveConfig model_deployment_monitoring_objective_configs = 6 [(google.api.field_behavior) = REQUIRED]; + // Required. The config for monitoring objectives. This is a per DeployedModel + // config. Each DeployedModel needs to be configured separately. + repeated ModelDeploymentMonitoringObjectiveConfig + model_deployment_monitoring_objective_configs = 6 + [(google.api.field_behavior) = REQUIRED]; // Required. Schedule config for running the monitoring job. - ModelDeploymentMonitoringScheduleConfig model_deployment_monitoring_schedule_config = 7 [(google.api.field_behavior) = REQUIRED]; + ModelDeploymentMonitoringScheduleConfig + model_deployment_monitoring_schedule_config = 7 + [(google.api.field_behavior) = REQUIRED]; // Required. Sample Strategy for logging. - SamplingStrategy logging_sampling_strategy = 8 [(google.api.field_behavior) = REQUIRED]; + SamplingStrategy logging_sampling_strategy = 8 + [(google.api.field_behavior) = REQUIRED]; // Alert config for model monitoring. ModelMonitoringAlertConfig model_monitoring_alert_config = 15; @@ -142,10 +149,12 @@ message ModelDeploymentMonitoringJob { // requests. string predict_instance_schema_uri = 9; - // Sample Predict instance, same format as [PredictRequest.instances][google.cloud.aiplatform.v1beta1.PredictRequest.instances], + // Sample Predict instance, same format as + // [PredictRequest.instances][google.cloud.aiplatform.v1beta1.PredictRequest.instances], // this can be set as a replacement of - // [ModelDeploymentMonitoringJob.predict_instance_schema_uri][google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob.predict_instance_schema_uri]. If not set, - // we will generate predict schema from collected predict requests. + // [ModelDeploymentMonitoringJob.predict_instance_schema_uri][google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob.predict_instance_schema_uri]. + // If not set, we will generate predict schema from collected predict + // requests. google.protobuf.Value sample_predict_instance = 19; // YAML schema file uri describing the format of a single instance that you @@ -161,12 +170,13 @@ message ModelDeploymentMonitoringJob { // fields in predict instance formatted as string. string analysis_instance_schema_uri = 16; - // Output only. The created bigquery tables for the job under customer project. Customer - // could do their own query & analysis. There could be 4 log tables in - // maximum: + // Output only. The created bigquery tables for the job under customer + // project. Customer could do their own query & analysis. There could be 4 log + // tables in maximum: // 1. Training data logging predict request/response // 2. Serving data logging predict request/response - repeated ModelDeploymentMonitoringBigQueryTable bigquery_tables = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; + repeated ModelDeploymentMonitoringBigQueryTable bigquery_tables = 10 + [(google.api.field_behavior) = OUTPUT_ONLY]; // The TTL of BigQuery tables in user projects which stores logs. // A day is the basic unit of the TTL and we take the ceil of TTL/86400(a @@ -184,14 +194,18 @@ message ModelDeploymentMonitoringJob { map labels = 11; // Output only. Timestamp when this ModelDeploymentMonitoringJob was created. - google.protobuf.Timestamp create_time = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 12 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. Timestamp when this ModelDeploymentMonitoringJob was updated most recently. - google.protobuf.Timestamp update_time = 13 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. Timestamp when this ModelDeploymentMonitoringJob was updated + // most recently. + google.protobuf.Timestamp update_time = 13 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. Timestamp when this monitoring pipeline will be scheduled to run for the - // next round. - google.protobuf.Timestamp next_schedule_time = 14 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. Timestamp when this monitoring pipeline will be scheduled to + // run for the next round. + google.protobuf.Timestamp next_schedule_time = 14 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Stats anomalies base folder path. GcsDestination stats_anomalies_base_directory = 20; @@ -263,17 +277,19 @@ message ModelDeploymentMonitoringObjectiveConfig { // The config for scheduling monitoring job. message ModelDeploymentMonitoringScheduleConfig { - // Required. The model monitoring job scheduling interval. It will be rounded up to next - // full hour. This defines how often the monitoring jobs are triggered. - google.protobuf.Duration monitor_interval = 1 [(google.api.field_behavior) = REQUIRED]; + // Required. The model monitoring job scheduling interval. It will be rounded + // up to next full hour. This defines how often the monitoring jobs are + // triggered. + google.protobuf.Duration monitor_interval = 1 + [(google.api.field_behavior) = REQUIRED]; // The time window of the prediction data being included in each prediction // dataset. This window specifies how long the data should be collected from // historical model results for each run. If not set, - // [ModelDeploymentMonitoringScheduleConfig.monitor_interval][google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringScheduleConfig.monitor_interval] will be used. - // e.g. If currently the cutoff time is 2022-01-08 14:30:00 and the - // monitor_window is set to be 3600, then data from 2022-01-08 13:30:00 - // to 2022-01-08 14:30:00 will be retrieved and aggregated to calculate the + // [ModelDeploymentMonitoringScheduleConfig.monitor_interval][google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringScheduleConfig.monitor_interval] + // will be used. e.g. If currently the cutoff time is 2022-01-08 14:30:00 and + // the monitor_window is set to be 3600, then data from 2022-01-08 13:30:00 to + // 2022-01-08 14:30:00 will be retrieved and aggregated to calculate the // monitoring statistics. google.protobuf.Duration monitor_window = 2; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/model_evaluation.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/model_evaluation.proto index 4e2c903e1ff..e37ad53a1c6 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/model_evaluation.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/model_evaluation.proto @@ -58,8 +58,8 @@ message ModelEvaluation { string display_name = 10; // Points to a YAML file stored on Google Cloud Storage describing the - // [metrics][google.cloud.aiplatform.v1beta1.ModelEvaluation.metrics] of this ModelEvaluation. The schema is - // defined as an OpenAPI 3.0.2 [Schema + // [metrics][google.cloud.aiplatform.v1beta1.ModelEvaluation.metrics] of this + // ModelEvaluation. The schema is defined as an OpenAPI 3.0.2 [Schema // Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). string metrics_schema_uri = 2; @@ -68,12 +68,13 @@ message ModelEvaluation { google.protobuf.Value metrics = 3; // Output only. Timestamp when this ModelEvaluation was created. - google.protobuf.Timestamp create_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; // All possible [dimensions][ModelEvaluationSlice.slice.dimension] of // ModelEvaluationSlices. The dimensions can be used as the filter of the - // [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluationSlices] request, in the form of - // `slice.dimension = `. + // [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluationSlices] + // request, in the form of `slice.dimension = `. repeated string slice_dimensions = 5; // Aggregated explanation metrics for the Model's prediction output over the @@ -82,8 +83,9 @@ message ModelEvaluation { // ModelExplanation model_explanation = 8; - // Describes the values of [ExplanationSpec][google.cloud.aiplatform.v1beta1.ExplanationSpec] that are used for explaining - // the predicted values on the evaluated data. + // Describes the values of + // [ExplanationSpec][google.cloud.aiplatform.v1beta1.ExplanationSpec] that are + // used for explaining the predicted values on the evaluated data. repeated ModelEvaluationExplanationSpec explanation_specs = 9; // The metadata of the ModelEvaluation. diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/model_evaluation_slice.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/model_evaluation_slice.proto index aa39f11186c..d52c4766a88 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/model_evaluation_slice.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/model_evaluation_slice.proto @@ -42,8 +42,10 @@ message ModelEvaluationSlice { // Output only. The dimension of the slice. // Well-known dimensions are: // * `annotationSpec`: This slice is on the test data that has either - // ground truth or prediction with [AnnotationSpec.display_name][google.cloud.aiplatform.v1beta1.AnnotationSpec.display_name] - // equals to [value][google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.Slice.value]. + // ground truth or prediction with + // [AnnotationSpec.display_name][google.cloud.aiplatform.v1beta1.AnnotationSpec.display_name] + // equals to + // [value][google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.Slice.value]. string dimension = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The value of the dimension in this slice. @@ -56,16 +58,20 @@ message ModelEvaluationSlice { // Output only. The slice of the test data that is used to evaluate the Model. Slice slice = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. Points to a YAML file stored on Google Cloud Storage describing the - // [metrics][google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.metrics] of this ModelEvaluationSlice. The - // schema is defined as an OpenAPI 3.0.2 [Schema + // Output only. Points to a YAML file stored on Google Cloud Storage + // describing the + // [metrics][google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.metrics] of + // this ModelEvaluationSlice. The schema is defined as an OpenAPI 3.0.2 + // [Schema // Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). string metrics_schema_uri = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. Sliced evaluation metrics of the Model. The schema of the metrics is stored - // in [metrics_schema_uri][google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.metrics_schema_uri] + // Output only. Sliced evaluation metrics of the Model. The schema of the + // metrics is stored in + // [metrics_schema_uri][google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.metrics_schema_uri] google.protobuf.Value metrics = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this ModelEvaluationSlice was created. - google.protobuf.Timestamp create_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/model_monitoring.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/model_monitoring.proto index 955314ecd44..3dc687e5f10 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/model_monitoring.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/model_monitoring.proto @@ -59,8 +59,8 @@ message ModelMonitoringObjectiveConfig { oneof data_source { // The resource name of the Dataset used to train this Model. string dataset = 3 [(google.api.resource_reference) = { - type: "aiplatform.googleapis.com/Dataset" - }]; + type: "aiplatform.googleapis.com/Dataset" + }]; // The Google Cloud Storage uri of the unmanaged Dataset used to train // this Model. @@ -135,8 +135,10 @@ message ModelMonitoringObjectiveConfig { // The config for integrating with Vertex Explainable AI. Only applicable if // the Model has explanation_spec populated. message ExplanationConfig { - // Output from [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob] for Model Monitoring baseline dataset, - // which can be used to generate baseline attribution scores. + // Output from + // [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob] + // for Model Monitoring baseline dataset, which can be used to generate + // baseline attribution scores. message ExplanationBaseline { // The storage format of the predictions generated BatchPrediction job. enum PredictionFormat { @@ -178,7 +180,8 @@ message ModelMonitoringObjectiveConfig { TrainingDataset training_dataset = 1; // The config for skew between training data and prediction data. - TrainingPredictionSkewDetectionConfig training_prediction_skew_detection_config = 2; + TrainingPredictionSkewDetectionConfig + training_prediction_skew_detection_config = 2; // The config for drift of prediction data. PredictionDriftDetectionConfig prediction_drift_detection_config = 3; diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/model_service.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/model_service.proto index 1af9d4b48fe..80da8a99f8d 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/model_service.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/model_service.proto @@ -40,7 +40,8 @@ option ruby_package = "Google::Cloud::AIPlatform::V1beta1"; // A service for managing Vertex AI's machine learning Models. service ModelService { option (google.api.default_host) = "aiplatform.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/cloud-platform"; // Uploads a Model artifact into Vertex AI. rpc UploadModel(UploadModelRequest) returns (google.longrunning.Operation) { @@ -72,7 +73,8 @@ service ModelService { } // Lists versions of the specified model. - rpc ListModelVersions(ListModelVersionsRequest) returns (ListModelVersionsResponse) { + rpc ListModelVersions(ListModelVersionsRequest) + returns (ListModelVersionsResponse) { option (google.api.http) = { get: "/v1beta1/{name=projects/*/locations/*/models/*}:listVersions" }; @@ -89,7 +91,8 @@ service ModelService { } // Incrementally update the dataset used for an examples model. - rpc UpdateExplanationDataset(UpdateExplanationDatasetRequest) returns (google.longrunning.Operation) { + rpc UpdateExplanationDataset(UpdateExplanationDatasetRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta1/{model=projects/*/locations/*/models/*}:updateExplanationDataset" body: "*" @@ -103,9 +106,12 @@ service ModelService { // 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. + // 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. rpc DeleteModel(DeleteModelRequest) returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1beta1/{name=projects/*/locations/*/models/*}" @@ -121,8 +127,10 @@ service ModelService { // // 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. - rpc DeleteModelVersion(DeleteModelVersionRequest) returns (google.longrunning.Operation) { + // [DeleteModel][google.cloud.aiplatform.v1beta1.ModelService.DeleteModel] for + // deleting the Model instead. + rpc DeleteModelVersion(DeleteModelVersionRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1beta1/{name=projects/*/locations/*/models/*}:deleteVersion" }; @@ -144,7 +152,8 @@ service ModelService { // 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]. + // [supported export + // format][google.cloud.aiplatform.v1beta1.Model.supported_export_formats]. rpc ExportModel(ExportModelRequest) returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta1/{name=projects/*/locations/*/models/*}:export" @@ -158,7 +167,8 @@ service ModelService { } // Imports an externally generated ModelEvaluation. - rpc ImportModelEvaluation(ImportModelEvaluationRequest) returns (ModelEvaluation) { + rpc ImportModelEvaluation(ImportModelEvaluationRequest) + returns (ModelEvaluation) { option (google.api.http) = { post: "/v1beta1/{parent=projects/*/locations/*/models/*}/evaluations:import" body: "*" @@ -167,7 +177,8 @@ service ModelService { } // Imports a list of externally generated ModelEvaluationSlice. - rpc BatchImportModelEvaluationSlices(BatchImportModelEvaluationSlicesRequest) returns (BatchImportModelEvaluationSlicesResponse) { + rpc BatchImportModelEvaluationSlices(BatchImportModelEvaluationSlicesRequest) + returns (BatchImportModelEvaluationSlicesResponse) { option (google.api.http) = { post: "/v1beta1/{parent=projects/*/locations/*/models/*/evaluations/*}/slices:batchImport" body: "*" @@ -184,7 +195,8 @@ service ModelService { } // Lists ModelEvaluations in a Model. - rpc ListModelEvaluations(ListModelEvaluationsRequest) returns (ListModelEvaluationsResponse) { + rpc ListModelEvaluations(ListModelEvaluationsRequest) + returns (ListModelEvaluationsResponse) { option (google.api.http) = { get: "/v1beta1/{parent=projects/*/locations/*/models/*}/evaluations" }; @@ -192,7 +204,8 @@ service ModelService { } // Gets a ModelEvaluationSlice. - rpc GetModelEvaluationSlice(GetModelEvaluationSliceRequest) returns (ModelEvaluationSlice) { + rpc GetModelEvaluationSlice(GetModelEvaluationSliceRequest) + returns (ModelEvaluationSlice) { option (google.api.http) = { get: "/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/slices/*}" }; @@ -200,7 +213,8 @@ service ModelService { } // Lists ModelEvaluationSlices in a ModelEvaluation. - rpc ListModelEvaluationSlices(ListModelEvaluationSlicesRequest) returns (ListModelEvaluationSlicesResponse) { + rpc ListModelEvaluationSlices(ListModelEvaluationSlicesRequest) + returns (ListModelEvaluationSlicesResponse) { option (google.api.http) = { get: "/v1beta1/{parent=projects/*/locations/*/models/*/evaluations/*}/slices" }; @@ -208,7 +222,8 @@ service ModelService { } } -// Request message for [ModelService.UploadModel][google.cloud.aiplatform.v1beta1.ModelService.UploadModel]. +// Request message for +// [ModelService.UploadModel][google.cloud.aiplatform.v1beta1.ModelService.UploadModel]. message UploadModelRequest { // Required. The resource name of the Location into which to upload the Model. // Format: `projects/{project}/locations/{location}` @@ -219,8 +234,8 @@ message UploadModelRequest { } ]; - // Optional. The resource name of the model into which to upload the version. Only - // specify this field when uploading a new version. + // Optional. The resource name of the model into which to upload the version. + // Only specify this field when uploading a new version. string parent_model = 4 [(google.api.field_behavior) = OPTIONAL]; // Optional. The ID to use for the uploaded Model, which will become the final @@ -232,27 +247,41 @@ message UploadModelRequest { // Required. The Model to create. Model model = 2 [(google.api.field_behavior) = REQUIRED]; + + // Optional. The user-provided custom service account to use to do the model + // upload. If empty, [Vertex AI Service + // Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) + // will be used. Users uploading the Model must have the + // `iam.serviceAccounts.actAs` permission on this service account. Also, this + // account must belong to the project specified in the `parent` field and have + // all necessary read permissions. + string service_account = 6 [(google.api.field_behavior) = OPTIONAL]; } -// Details of [ModelService.UploadModel][google.cloud.aiplatform.v1beta1.ModelService.UploadModel] operation. +// Details of +// [ModelService.UploadModel][google.cloud.aiplatform.v1beta1.ModelService.UploadModel] +// operation. message UploadModelOperationMetadata { // The common part of the operation metadata. GenericOperationMetadata generic_metadata = 1; } -// Response message of [ModelService.UploadModel][google.cloud.aiplatform.v1beta1.ModelService.UploadModel] operation. +// Response message of +// [ModelService.UploadModel][google.cloud.aiplatform.v1beta1.ModelService.UploadModel] +// operation. message UploadModelResponse { // The name of the uploaded Model resource. // Format: `projects/{project}/locations/{location}/models/{model}` string model = 1 [(google.api.resource_reference) = { - type: "aiplatform.googleapis.com/Model" - }]; + type: "aiplatform.googleapis.com/Model" + }]; // Output only. The version ID of the model that is uploaded. string model_version_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; } -// Request message for [ModelService.GetModel][google.cloud.aiplatform.v1beta1.ModelService.GetModel]. +// Request message for +// [ModelService.GetModel][google.cloud.aiplatform.v1beta1.ModelService.GetModel]. message GetModelRequest { // Required. The name of the Model resource. // Format: `projects/{project}/locations/{location}/models/{model}` @@ -274,7 +303,8 @@ message GetModelRequest { ]; } -// Request message for [ModelService.ListModels][google.cloud.aiplatform.v1beta1.ModelService.ListModels]. +// Request message for +// [ModelService.ListModels][google.cloud.aiplatform.v1beta1.ModelService.ListModels]. message ListModelsRequest { // Required. The resource name of the Location to list the Models from. // Format: `projects/{project}/locations/{location}` @@ -289,7 +319,8 @@ message ListModelsRequest { // both snake_case and camelCase are supported. // // * `model` supports = and !=. `model` represents the Model ID, - // i.e. the last segment of the Model's [resource name][google.cloud.aiplatform.v1beta1.Model.name]. + // i.e. the last segment of the Model's [resource + // name][google.cloud.aiplatform.v1beta1.Model.name]. // * `display_name` supports = and != // * `labels` supports general map functions that is: // * `labels.key=value` - key:value equality @@ -308,25 +339,31 @@ message ListModelsRequest { // The standard list page token. // Typically obtained via - // [ListModelsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListModelsResponse.next_page_token] of the previous - // [ModelService.ListModels][google.cloud.aiplatform.v1beta1.ModelService.ListModels] call. + // [ListModelsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListModelsResponse.next_page_token] + // of the previous + // [ModelService.ListModels][google.cloud.aiplatform.v1beta1.ModelService.ListModels] + // call. string page_token = 4; // Mask specifying which fields to read. google.protobuf.FieldMask read_mask = 5; } -// Response message for [ModelService.ListModels][google.cloud.aiplatform.v1beta1.ModelService.ListModels] +// Response message for +// [ModelService.ListModels][google.cloud.aiplatform.v1beta1.ModelService.ListModels] message ListModelsResponse { // List of Models in the requested page. repeated Model models = 1; // A token to retrieve next page of results. - // Pass to [ListModelsRequest.page_token][google.cloud.aiplatform.v1beta1.ListModelsRequest.page_token] to obtain that page. + // Pass to + // [ListModelsRequest.page_token][google.cloud.aiplatform.v1beta1.ListModelsRequest.page_token] + // to obtain that page. string next_page_token = 2; } -// Request message for [ModelService.ListModelVersions][google.cloud.aiplatform.v1beta1.ModelService.ListModelVersions]. +// Request message for +// [ModelService.ListModelVersions][google.cloud.aiplatform.v1beta1.ModelService.ListModelVersions]. message ListModelVersionsRequest { // Required. The name of the model to list versions for. string name = 1 [ @@ -341,8 +378,8 @@ message ListModelVersionsRequest { // The standard list page token. // Typically obtained via - // [ListModelVersionsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListModelVersionsResponse.next_page_token] of the previous - // [ModelService.ListModelversions][] call. + // [ListModelVersionsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListModelVersionsResponse.next_page_token] + // of the previous [ModelService.ListModelversions][] call. string page_token = 3; // An expression for filtering the results of the request. For field names @@ -360,9 +397,20 @@ message ListModelVersionsRequest { // Mask specifying which fields to read. google.protobuf.FieldMask read_mask = 5; + + // A comma-separated list of fields to order by, sorted in ascending order. + // Use "desc" after a field name for descending. + // Supported fields: + // + // * `create_time` + // * `update_time` + // + // Example: `update_time asc, create_time desc`. + string order_by = 6; } -// Response message for [ModelService.ListModelVersions][google.cloud.aiplatform.v1beta1.ModelService.ListModelVersions] +// Response message for +// [ModelService.ListModelVersions][google.cloud.aiplatform.v1beta1.ModelService.ListModelVersions] message ListModelVersionsResponse { // List of Model versions in the requested page. // In the returned Model name field, version ID instead of regvision tag will @@ -370,11 +418,14 @@ message ListModelVersionsResponse { repeated Model models = 1; // A token to retrieve the next page of results. - // Pass to [ListModelVersionsRequest.page_token][google.cloud.aiplatform.v1beta1.ListModelVersionsRequest.page_token] to obtain that page. + // Pass to + // [ListModelVersionsRequest.page_token][google.cloud.aiplatform.v1beta1.ListModelVersionsRequest.page_token] + // to obtain that page. string next_page_token = 2; } -// Request message for [ModelService.UpdateModel][google.cloud.aiplatform.v1beta1.ModelService.UpdateModel]. +// Request message for +// [ModelService.UpdateModel][google.cloud.aiplatform.v1beta1.ModelService.UpdateModel]. message UpdateModelRequest { // Required. The Model which replaces the resource on the server. // When Model Versioning is enabled, the model.name will be used to determine @@ -397,8 +448,10 @@ message UpdateModelRequest { Model model = 1 [(google.api.field_behavior) = REQUIRED]; // Required. The update mask applies to the resource. - // For the `FieldMask` definition, see [google.protobuf.FieldMask][google.protobuf.FieldMask]. - google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED]; + // For the `FieldMask` definition, see + // [google.protobuf.FieldMask][google.protobuf.FieldMask]. + google.protobuf.FieldMask update_mask = 2 + [(google.api.field_behavior) = REQUIRED]; } // Request message for @@ -424,7 +477,8 @@ message UpdateExplanationDatasetOperationMetadata { GenericOperationMetadata generic_metadata = 1; } -// Request message for [ModelService.DeleteModel][google.cloud.aiplatform.v1beta1.ModelService.DeleteModel]. +// Request message for +// [ModelService.DeleteModel][google.cloud.aiplatform.v1beta1.ModelService.DeleteModel]. message DeleteModelRequest { // Required. The name of the Model resource to be deleted. // Format: `projects/{project}/locations/{location}/models/{model}` @@ -436,10 +490,11 @@ message DeleteModelRequest { ]; } -// Request message for [ModelService.DeleteModelVersion][google.cloud.aiplatform.v1beta1.ModelService.DeleteModelVersion]. +// Request message for +// [ModelService.DeleteModelVersion][google.cloud.aiplatform.v1beta1.ModelService.DeleteModelVersion]. message DeleteModelVersionRequest { - // Required. The name of the model version to be deleted, with a version ID explicitly - // included. + // Required. The name of the model version to be deleted, with a version ID + // explicitly included. // // Example: `projects/{project}/locations/{location}/models/{model}@1234` string name = 1 [ @@ -450,7 +505,8 @@ message DeleteModelVersionRequest { ]; } -// Request message for [ModelService.MergeVersionAliases][google.cloud.aiplatform.v1beta1.ModelService.MergeVersionAliases]. +// Request message for +// [ModelService.MergeVersionAliases][google.cloud.aiplatform.v1beta1.ModelService.MergeVersionAliases]. message MergeVersionAliasesRequest { // Required. The name of the model version to merge aliases, with a version ID // explicitly included. @@ -478,12 +534,14 @@ message MergeVersionAliasesRequest { repeated string version_aliases = 2 [(google.api.field_behavior) = REQUIRED]; } -// Request message for [ModelService.ExportModel][google.cloud.aiplatform.v1beta1.ModelService.ExportModel]. +// Request message for +// [ModelService.ExportModel][google.cloud.aiplatform.v1beta1.ModelService.ExportModel]. message ExportModelRequest { // Output configuration for the Model export. message OutputConfig { // The ID of the format in which the Model must be exported. Each Model - // lists the [export formats it supports][google.cloud.aiplatform.v1beta1.Model.supported_export_formats]. + // lists the [export formats it + // supports][google.cloud.aiplatform.v1beta1.Model.supported_export_formats]. // If no value is provided here, then the first from the list of the Model's // supported formats is used by default. string export_format_id = 1; @@ -519,39 +577,43 @@ message ExportModelRequest { OutputConfig output_config = 2 [(google.api.field_behavior) = REQUIRED]; } -// Details of [ModelService.ExportModel][google.cloud.aiplatform.v1beta1.ModelService.ExportModel] operation. +// Details of +// [ModelService.ExportModel][google.cloud.aiplatform.v1beta1.ModelService.ExportModel] +// operation. message ExportModelOperationMetadata { // Further describes the output of the ExportModel. Supplements // [ExportModelRequest.OutputConfig][google.cloud.aiplatform.v1beta1.ExportModelRequest.OutputConfig]. message OutputInfo { - // Output only. If the Model artifact is being exported to Google Cloud Storage this is - // the full path of the directory created, into which the Model files are - // being written to. + // Output only. If the Model artifact is being exported to Google Cloud + // Storage this is the full path of the directory created, into which the + // Model files are being written to. string artifact_output_uri = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. If the Model image is being exported to Google Container Registry or - // Artifact Registry this is the full path of the image created. + // Output only. If the Model image is being exported to Google Container + // Registry or Artifact Registry this is the full path of the image created. string image_output_uri = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; } // The common part of the operation metadata. GenericOperationMetadata generic_metadata = 1; - // Output only. Information further describing the output of this Model export. + // Output only. Information further describing the output of this Model + // export. OutputInfo output_info = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; } -// Response message of [ModelService.UpdateExplanationDataset][google.cloud.aiplatform.v1beta1.ModelService.UpdateExplanationDataset] operation. -message UpdateExplanationDatasetResponse { - -} - -// Response message of [ModelService.ExportModel][google.cloud.aiplatform.v1beta1.ModelService.ExportModel] operation. -message ExportModelResponse { +// Response message of +// [ModelService.UpdateExplanationDataset][google.cloud.aiplatform.v1beta1.ModelService.UpdateExplanationDataset] +// operation. +message UpdateExplanationDatasetResponse {} -} +// Response message of +// [ModelService.ExportModel][google.cloud.aiplatform.v1beta1.ModelService.ExportModel] +// operation. +message ExportModelResponse {} -// Request message for [ModelService.ImportModelEvaluation][google.cloud.aiplatform.v1beta1.ModelService.ImportModelEvaluation] +// Request message for +// [ModelService.ImportModelEvaluation][google.cloud.aiplatform.v1beta1.ModelService.ImportModelEvaluation] message ImportModelEvaluationRequest { // Required. The name of the parent model resource. // Format: `projects/{project}/locations/{location}/models/{model}` @@ -566,7 +628,8 @@ message ImportModelEvaluationRequest { ModelEvaluation model_evaluation = 2 [(google.api.field_behavior) = REQUIRED]; } -// Request message for [ModelService.BatchImportModelEvaluationSlices][google.cloud.aiplatform.v1beta1.ModelService.BatchImportModelEvaluationSlices] +// Request message for +// [ModelService.BatchImportModelEvaluationSlices][google.cloud.aiplatform.v1beta1.ModelService.BatchImportModelEvaluationSlices] message BatchImportModelEvaluationSlicesRequest { // Required. The name of the parent ModelEvaluation resource. // Format: @@ -579,16 +642,21 @@ message BatchImportModelEvaluationSlicesRequest { ]; // Required. Model evaluation slice resource to be imported. - repeated ModelEvaluationSlice model_evaluation_slices = 2 [(google.api.field_behavior) = REQUIRED]; + repeated ModelEvaluationSlice model_evaluation_slices = 2 + [(google.api.field_behavior) = REQUIRED]; } -// Response message for [ModelService.BatchImportModelEvaluationSlices][google.cloud.aiplatform.v1beta1.ModelService.BatchImportModelEvaluationSlices] +// Response message for +// [ModelService.BatchImportModelEvaluationSlices][google.cloud.aiplatform.v1beta1.ModelService.BatchImportModelEvaluationSlices] message BatchImportModelEvaluationSlicesResponse { - // Output only. List of imported [ModelEvaluationSlice.name][google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.name]. - repeated string imported_model_evaluation_slices = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. List of imported + // [ModelEvaluationSlice.name][google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.name]. + repeated string imported_model_evaluation_slices = 1 + [(google.api.field_behavior) = OUTPUT_ONLY]; } -// Request message for [ModelService.GetModelEvaluation][google.cloud.aiplatform.v1beta1.ModelService.GetModelEvaluation]. +// Request message for +// [ModelService.GetModelEvaluation][google.cloud.aiplatform.v1beta1.ModelService.GetModelEvaluation]. message GetModelEvaluationRequest { // Required. The name of the ModelEvaluation resource. // Format: @@ -601,7 +669,8 @@ message GetModelEvaluationRequest { ]; } -// Request message for [ModelService.ListModelEvaluations][google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluations]. +// Request message for +// [ModelService.ListModelEvaluations][google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluations]. message ListModelEvaluationsRequest { // Required. The resource name of the Model to list the ModelEvaluations from. // Format: `projects/{project}/locations/{location}/models/{model}` @@ -620,25 +689,31 @@ message ListModelEvaluationsRequest { // The standard list page token. // Typically obtained via - // [ListModelEvaluationsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListModelEvaluationsResponse.next_page_token] of the previous - // [ModelService.ListModelEvaluations][google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluations] call. + // [ListModelEvaluationsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListModelEvaluationsResponse.next_page_token] + // of the previous + // [ModelService.ListModelEvaluations][google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluations] + // call. string page_token = 4; // Mask specifying which fields to read. google.protobuf.FieldMask read_mask = 5; } -// Response message for [ModelService.ListModelEvaluations][google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluations]. +// Response message for +// [ModelService.ListModelEvaluations][google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluations]. message ListModelEvaluationsResponse { // List of ModelEvaluations in the requested page. repeated ModelEvaluation model_evaluations = 1; // A token to retrieve next page of results. - // Pass to [ListModelEvaluationsRequest.page_token][google.cloud.aiplatform.v1beta1.ListModelEvaluationsRequest.page_token] to obtain that page. + // Pass to + // [ListModelEvaluationsRequest.page_token][google.cloud.aiplatform.v1beta1.ListModelEvaluationsRequest.page_token] + // to obtain that page. string next_page_token = 2; } -// Request message for [ModelService.GetModelEvaluationSlice][google.cloud.aiplatform.v1beta1.ModelService.GetModelEvaluationSlice]. +// Request message for +// [ModelService.GetModelEvaluationSlice][google.cloud.aiplatform.v1beta1.ModelService.GetModelEvaluationSlice]. message GetModelEvaluationSliceRequest { // Required. The name of the ModelEvaluationSlice resource. // Format: @@ -651,10 +726,11 @@ message GetModelEvaluationSliceRequest { ]; } -// Request message for [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluationSlices]. +// Request message for +// [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluationSlices]. message ListModelEvaluationSlicesRequest { - // Required. The resource name of the ModelEvaluation to list the ModelEvaluationSlices - // from. Format: + // Required. The resource name of the ModelEvaluation to list the + // ModelEvaluationSlices from. Format: // `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, @@ -673,21 +749,25 @@ message ListModelEvaluationSlicesRequest { // The standard list page token. // Typically obtained via - // [ListModelEvaluationSlicesResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListModelEvaluationSlicesResponse.next_page_token] of the previous - // [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluationSlices] call. + // [ListModelEvaluationSlicesResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListModelEvaluationSlicesResponse.next_page_token] + // of the previous + // [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluationSlices] + // call. string page_token = 4; // Mask specifying which fields to read. google.protobuf.FieldMask read_mask = 5; } -// Response message for [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluationSlices]. +// Response message for +// [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluationSlices]. message ListModelEvaluationSlicesResponse { // List of ModelEvaluations in the requested page. repeated ModelEvaluationSlice model_evaluation_slices = 1; // A token to retrieve next page of results. - // Pass to [ListModelEvaluationSlicesRequest.page_token][google.cloud.aiplatform.v1beta1.ListModelEvaluationSlicesRequest.page_token] to obtain that - // page. + // Pass to + // [ListModelEvaluationSlicesRequest.page_token][google.cloud.aiplatform.v1beta1.ListModelEvaluationSlicesRequest.page_token] + // to obtain that page. string next_page_token = 2; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/operation.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/operation.proto index 04e04b20108..330ab6245a0 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/operation.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/operation.proto @@ -33,16 +33,19 @@ message GenericOperationMetadata { // Output only. Partial failures encountered. // E.g. single files that couldn't be read. // This field should never exceed 20 entries. - // Status details field will contain standard GCP error details. - repeated google.rpc.Status partial_failures = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Status details field will contain standard Google Cloud error details. + repeated google.rpc.Status partial_failures = 1 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Time when the operation was created. - google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 2 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Time when the operation was updated for the last time. // If the operation has finished (successfully or not), this is the finish // time. - google.protobuf.Timestamp update_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // Details of operations that perform deletes of any entities. diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/pipeline_job.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/pipeline_job.proto index cb450ee569a..637707f3a77 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/pipeline_job.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/pipeline_job.proto @@ -54,24 +54,26 @@ message PipelineJob { message InputArtifact { oneof kind { // Artifact resource id from MLMD. Which is the last portion of an - // artifact resource - // name(projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}). + // artifact resource name: + // `projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}`. // The artifact must stay within the same project, location and default // metadatastore as the pipeline. string artifact_id = 1; } } - // Deprecated. Use [RuntimeConfig.parameter_values][google.cloud.aiplatform.v1beta1.PipelineJob.RuntimeConfig.parameter_values] instead. The runtime - // parameters of the PipelineJob. The parameters will be passed into - // [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1beta1.PipelineJob.pipeline_spec] to replace the placeholders at runtime. - // This field is used by pipelines built using - // `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower, such as - // pipelines built using Kubeflow Pipelines SDK 1.8 or lower. + // Deprecated. Use + // [RuntimeConfig.parameter_values][google.cloud.aiplatform.v1beta1.PipelineJob.RuntimeConfig.parameter_values] + // instead. The runtime parameters of the PipelineJob. The parameters will + // be passed into + // [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1beta1.PipelineJob.pipeline_spec] + // to replace the placeholders at runtime. This field is used by pipelines + // built using `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower, + // such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower. map parameters = 1 [deprecated = true]; - // Required. A path in a Cloud Storage bucket, which will be treated as the root - // output directory of the pipeline. It is used by the system to + // Required. A path in a Cloud Storage bucket, which will be treated as the + // root output directory of the pipeline. It is used by the system to // generate the paths of output artifacts. The artifact paths are generated // with a sub-path pattern `{job_id}/{task_id}/{output_key}` under the // specified output directory. The service account specified in this @@ -80,10 +82,12 @@ message PipelineJob { string gcs_output_directory = 2 [(google.api.field_behavior) = REQUIRED]; // The runtime parameters of the PipelineJob. The parameters will be - // passed into [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1beta1.PipelineJob.pipeline_spec] to replace the placeholders - // at runtime. This field is used by pipelines built using - // `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as pipelines built - // using Kubeflow Pipelines SDK 1.9 or higher and the v2 DSL. + // passed into + // [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1beta1.PipelineJob.pipeline_spec] + // to replace the placeholders at runtime. This field is used by pipelines + // built using `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as + // pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2 + // DSL. map parameter_values = 3; // Represents the failure policy of a pipeline. Currently, the default of a @@ -103,21 +107,25 @@ message PipelineJob { string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // The display name of the Pipeline. - // The name can be up to 128 characters long and can be consist of any UTF-8 + // The name can be up to 128 characters long and can consist of any UTF-8 // characters. string display_name = 2; // Output only. Pipeline creation time. - google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Pipeline start time. - google.protobuf.Timestamp start_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp start_time = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Pipeline end time. - google.protobuf.Timestamp end_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp end_time = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this PipelineJob was most recently updated. - google.protobuf.Timestamp update_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 6 + [(google.api.field_behavior) = OUTPUT_ONLY]; // The spec of the pipeline. google.protobuf.Struct pipeline_spec = 7; @@ -168,31 +176,36 @@ message PipelineJob { // network name. // // Private services access must already be configured for the network. - // Pipeline job will apply the network configuration to the GCP resources - // being launched, if applied, such as Vertex AI + // Pipeline job will apply the network configuration to the Google Cloud + // resources being launched, if applied, such as Vertex AI // Training or Dataflow job. If left unspecified, the workload is not peered // with any network. - string network = 18 [(google.api.resource_reference) = { - type: "compute.googleapis.com/Network" - }]; + string network = 18 [ + (google.api.resource_reference) = { type: "compute.googleapis.com/Network" } + ]; - // A template uri from where the [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1beta1.PipelineJob.pipeline_spec], if empty, will - // be downloaded. + // A template uri from where the + // [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1beta1.PipelineJob.pipeline_spec], + // if empty, will be downloaded. string template_uri = 19; // Output only. Pipeline template metadata. Will fill up fields if - // [PipelineJob.template_uri][google.cloud.aiplatform.v1beta1.PipelineJob.template_uri] is from supported template registry. - PipelineTemplateMetadata template_metadata = 20 [(google.api.field_behavior) = OUTPUT_ONLY]; + // [PipelineJob.template_uri][google.cloud.aiplatform.v1beta1.PipelineJob.template_uri] + // is from supported template registry. + PipelineTemplateMetadata template_metadata = 20 + [(google.api.field_behavior) = OUTPUT_ONLY]; } -// Pipeline template metadata if [PipelineJob.template_uri][google.cloud.aiplatform.v1beta1.PipelineJob.template_uri] is from supported -// template registry. Currently, the only supported registry is Artifact -// Registry. +// Pipeline template metadata if +// [PipelineJob.template_uri][google.cloud.aiplatform.v1beta1.PipelineJob.template_uri] +// is from supported template registry. Currently, the only supported registry +// is Artifact Registry. message PipelineTemplateMetadata { // The version_name in artifact registry. // - // Will always be presented in output if the [PipelineJob.template_uri][google.cloud.aiplatform.v1beta1.PipelineJob.template_uri] is - // from supported template registry. + // Will always be presented in output if the + // [PipelineJob.template_uri][google.cloud.aiplatform.v1beta1.PipelineJob.template_uri] + // is from supported template registry. // // Format is "sha256:abcdef123456...". string version = 3; @@ -207,7 +220,8 @@ message PipelineJobDetail { Context pipeline_run_context = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The runtime details of the tasks under the pipeline. - repeated PipelineTaskDetail task_details = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + repeated PipelineTaskDetail task_details = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // The runtime detail of a task execution. @@ -215,17 +229,17 @@ message PipelineTaskDetail { // A single record of the task status. message PipelineTaskStatus { // Output only. Update time of this status. - google.protobuf.Timestamp update_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 1 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The state of the task. State state = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. The error that occurred during the state. May be set when the state is - // any of the non-final state (PENDING/RUNNING/CANCELLING) or FAILED state. - // If the state is FAILED, the error here is final and not going to be - // retried. - // If the state is a non-final state, the error indicates a system-error - // being retried. + // Output only. The error that occurred during the state. May be set when + // the state is any of the non-final state (PENDING/RUNNING/CANCELLING) or + // FAILED state. If the state is FAILED, the error here is final and not + // going to be retried. If the state is a non-final state, the error + // indicates a system-error being retried. google.rpc.Status error = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; } @@ -266,15 +280,16 @@ message PipelineTaskDetail { // Specifies that the task was not triggered because the task's trigger // policy is not satisfied. The trigger policy is specified in the - // `condition` field of [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1beta1.PipelineJob.pipeline_spec]. + // `condition` field of + // [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1beta1.PipelineJob.pipeline_spec]. NOT_TRIGGERED = 9; } // Output only. The system generated ID of the task. int64 task_id = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. The id of the parent task if the task is within a component scope. - // Empty if the task is at the root level. + // Output only. The id of the parent task if the task is within a component + // scope. Empty if the task is at the root level. int64 parent_task_id = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The user specified name of the task that is defined in @@ -282,16 +297,20 @@ message PipelineTaskDetail { string task_name = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Task create time. - google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Task start time. - google.protobuf.Timestamp start_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp start_time = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Task end time. - google.protobuf.Timestamp end_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp end_time = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The detailed execution info. - PipelineTaskExecutorDetail executor_detail = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + PipelineTaskExecutorDetail executor_detail = 6 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. State of the task. State state = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; @@ -303,15 +322,18 @@ message PipelineTaskDetail { // Only populated when the task's state is FAILED or CANCELLED. google.rpc.Status error = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. A list of task status. This field keeps a record of task status evolving - // over time. - repeated PipelineTaskStatus pipeline_task_status = 13 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. A list of task status. This field keeps a record of task + // status evolving over time. + repeated PipelineTaskStatus pipeline_task_status = 13 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The runtime input artifacts of the task. - map inputs = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; + map inputs = 10 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The runtime output artifacts of the task. - map outputs = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; + map outputs = 11 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // The runtime detail of a pipeline executor. @@ -319,7 +341,9 @@ message PipelineTaskExecutorDetail { // The detail of a container execution. It contains the job names of the // lifecycle of a container execution. message ContainerDetail { - // Output only. The name of the [CustomJob][google.cloud.aiplatform.v1beta1.CustomJob] for the main container execution. + // Output only. The name of the + // [CustomJob][google.cloud.aiplatform.v1beta1.CustomJob] for the main + // container execution. string main_job = 1 [ (google.api.field_behavior) = OUTPUT_ONLY, (google.api.resource_reference) = { @@ -327,23 +351,41 @@ message PipelineTaskExecutorDetail { } ]; - // Output only. The name of the [CustomJob][google.cloud.aiplatform.v1beta1.CustomJob] for the pre-caching-check container - // execution. This job will be available if the - // [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1beta1.PipelineJob.pipeline_spec] specifies the `pre_caching_check` hook in - // the lifecycle events. + // Output only. The name of the + // [CustomJob][google.cloud.aiplatform.v1beta1.CustomJob] for the + // pre-caching-check container execution. This job will be available if the + // [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1beta1.PipelineJob.pipeline_spec] + // specifies the `pre_caching_check` hook in the lifecycle events. string pre_caching_check_job = 2 [ (google.api.field_behavior) = OUTPUT_ONLY, (google.api.resource_reference) = { type: "aiplatform.googleapis.com/CustomJob" } ]; + + // Output only. The names of the previously failed + // [CustomJob][google.cloud.aiplatform.v1beta1.CustomJob] for the main + // container executions. The list includes the all attempts in chronological + // order. + repeated string failed_main_jobs = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Output only. The names of the previously failed + // [CustomJob][google.cloud.aiplatform.v1beta1.CustomJob] for the + // pre-caching-check container executions. This job will be available if the + // [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1beta1.PipelineJob.pipeline_spec] + // specifies the `pre_caching_check` hook in the lifecycle events. The list + // includes the all attempts in chronological order. + repeated string failed_pre_caching_check_jobs = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // The detailed info for a custom job executor. message CustomJobDetail { option deprecated = true; - // Output only. The name of the [CustomJob][google.cloud.aiplatform.v1beta1.CustomJob]. + // Output only. The name of the + // [CustomJob][google.cloud.aiplatform.v1beta1.CustomJob]. string job = 1 [ (google.api.field_behavior) = OUTPUT_ONLY, (google.api.resource_reference) = { @@ -354,12 +396,11 @@ message PipelineTaskExecutorDetail { oneof details { // Output only. The detailed info for a container executor. - ContainerDetail container_detail = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + ContainerDetail container_detail = 1 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The detailed info for a custom job executor. - CustomJobDetail custom_job_detail = 2 [ - deprecated = true, - (google.api.field_behavior) = OUTPUT_ONLY - ]; + CustomJobDetail custom_job_detail = 2 + [deprecated = true, (google.api.field_behavior) = OUTPUT_ONLY]; } } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/pipeline_service.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/pipeline_service.proto index 8126d7b8839..26ea0fb6704 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/pipeline_service.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/pipeline_service.proto @@ -39,11 +39,13 @@ option ruby_package = "Google::Cloud::AIPlatform::V1beta1"; // `PipelineJob` resources (used for Vertex AI Pipelines). service PipelineService { option (google.api.default_host) = "aiplatform.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/cloud-platform"; // Creates a TrainingPipeline. A created TrainingPipeline right away will be // attempted to be run. - rpc CreateTrainingPipeline(CreateTrainingPipelineRequest) returns (TrainingPipeline) { + rpc CreateTrainingPipeline(CreateTrainingPipelineRequest) + returns (TrainingPipeline) { option (google.api.http) = { post: "/v1beta1/{parent=projects/*/locations/*}/trainingPipelines" body: "training_pipeline" @@ -52,7 +54,8 @@ service PipelineService { } // Gets a TrainingPipeline. - rpc GetTrainingPipeline(GetTrainingPipelineRequest) returns (TrainingPipeline) { + rpc GetTrainingPipeline(GetTrainingPipelineRequest) + returns (TrainingPipeline) { option (google.api.http) = { get: "/v1beta1/{name=projects/*/locations/*/trainingPipelines/*}" }; @@ -60,7 +63,8 @@ service PipelineService { } // Lists TrainingPipelines in a Location. - rpc ListTrainingPipelines(ListTrainingPipelinesRequest) returns (ListTrainingPipelinesResponse) { + rpc ListTrainingPipelines(ListTrainingPipelinesRequest) + returns (ListTrainingPipelinesResponse) { option (google.api.http) = { get: "/v1beta1/{parent=projects/*/locations/*}/trainingPipelines" }; @@ -68,7 +72,8 @@ service PipelineService { } // Deletes a TrainingPipeline. - rpc DeleteTrainingPipeline(DeleteTrainingPipelineRequest) returns (google.longrunning.Operation) { + rpc DeleteTrainingPipeline(DeleteTrainingPipelineRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1beta1/{name=projects/*/locations/*/trainingPipelines/*}" }; @@ -82,14 +87,19 @@ service PipelineService { // 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 + // 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`. - rpc CancelTrainingPipeline(CancelTrainingPipelineRequest) returns (google.protobuf.Empty) { + // 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`. + rpc CancelTrainingPipeline(CancelTrainingPipelineRequest) + returns (google.protobuf.Empty) { option (google.api.http) = { post: "/v1beta1/{name=projects/*/locations/*/trainingPipelines/*}:cancel" body: "*" @@ -103,7 +113,8 @@ service PipelineService { post: "/v1beta1/{parent=projects/*/locations/*}/pipelineJobs" body: "pipeline_job" }; - option (google.api.method_signature) = "parent,pipeline_job,pipeline_job_id"; + option (google.api.method_signature) = + "parent,pipeline_job,pipeline_job_id"; } // Gets a PipelineJob. @@ -115,7 +126,8 @@ service PipelineService { } // Lists PipelineJobs in a Location. - rpc ListPipelineJobs(ListPipelineJobsRequest) returns (ListPipelineJobsResponse) { + rpc ListPipelineJobs(ListPipelineJobsRequest) + returns (ListPipelineJobsResponse) { option (google.api.http) = { get: "/v1beta1/{parent=projects/*/locations/*}/pipelineJobs" }; @@ -123,7 +135,8 @@ service PipelineService { } // Deletes a PipelineJob. - rpc DeletePipelineJob(DeletePipelineJobRequest) returns (google.longrunning.Operation) { + rpc DeletePipelineJob(DeletePipelineJobRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1beta1/{name=projects/*/locations/*/pipelineJobs/*}" }; @@ -137,14 +150,18 @@ service PipelineService { // 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 + // 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`. - rpc CancelPipelineJob(CancelPipelineJobRequest) returns (google.protobuf.Empty) { + // 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`. + rpc CancelPipelineJob(CancelPipelineJobRequest) + returns (google.protobuf.Empty) { option (google.api.http) = { post: "/v1beta1/{name=projects/*/locations/*/pipelineJobs/*}:cancel" body: "*" @@ -153,10 +170,11 @@ service PipelineService { } } -// Request message for [PipelineService.CreateTrainingPipeline][google.cloud.aiplatform.v1beta1.PipelineService.CreateTrainingPipeline]. +// Request message for +// [PipelineService.CreateTrainingPipeline][google.cloud.aiplatform.v1beta1.PipelineService.CreateTrainingPipeline]. message CreateTrainingPipelineRequest { - // Required. The resource name of the Location to create the TrainingPipeline in. - // Format: `projects/{project}/locations/{location}` + // Required. The resource name of the Location to create the TrainingPipeline + // in. Format: `projects/{project}/locations/{location}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -165,10 +183,12 @@ message CreateTrainingPipelineRequest { ]; // Required. The TrainingPipeline to create. - TrainingPipeline training_pipeline = 2 [(google.api.field_behavior) = REQUIRED]; + TrainingPipeline training_pipeline = 2 + [(google.api.field_behavior) = REQUIRED]; } -// Request message for [PipelineService.GetTrainingPipeline][google.cloud.aiplatform.v1beta1.PipelineService.GetTrainingPipeline]. +// Request message for +// [PipelineService.GetTrainingPipeline][google.cloud.aiplatform.v1beta1.PipelineService.GetTrainingPipeline]. message GetTrainingPipelineRequest { // Required. The name of the TrainingPipeline resource. // Format: @@ -181,10 +201,11 @@ message GetTrainingPipelineRequest { ]; } -// Request message for [PipelineService.ListTrainingPipelines][google.cloud.aiplatform.v1beta1.PipelineService.ListTrainingPipelines]. +// Request message for +// [PipelineService.ListTrainingPipelines][google.cloud.aiplatform.v1beta1.PipelineService.ListTrainingPipelines]. message ListTrainingPipelinesRequest { - // Required. The resource name of the Location to list the TrainingPipelines from. - // Format: `projects/{project}/locations/{location}` + // Required. The resource name of the Location to list the TrainingPipelines + // from. Format: `projects/{project}/locations/{location}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -219,25 +240,31 @@ message ListTrainingPipelinesRequest { // The standard list page token. // Typically obtained via - // [ListTrainingPipelinesResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListTrainingPipelinesResponse.next_page_token] of the previous - // [PipelineService.ListTrainingPipelines][google.cloud.aiplatform.v1beta1.PipelineService.ListTrainingPipelines] call. + // [ListTrainingPipelinesResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListTrainingPipelinesResponse.next_page_token] + // of the previous + // [PipelineService.ListTrainingPipelines][google.cloud.aiplatform.v1beta1.PipelineService.ListTrainingPipelines] + // call. string page_token = 4; // Mask specifying which fields to read. google.protobuf.FieldMask read_mask = 5; } -// Response message for [PipelineService.ListTrainingPipelines][google.cloud.aiplatform.v1beta1.PipelineService.ListTrainingPipelines] +// Response message for +// [PipelineService.ListTrainingPipelines][google.cloud.aiplatform.v1beta1.PipelineService.ListTrainingPipelines] message ListTrainingPipelinesResponse { // List of TrainingPipelines in the requested page. repeated TrainingPipeline training_pipelines = 1; // A token to retrieve the next page of results. - // Pass to [ListTrainingPipelinesRequest.page_token][google.cloud.aiplatform.v1beta1.ListTrainingPipelinesRequest.page_token] to obtain that page. + // Pass to + // [ListTrainingPipelinesRequest.page_token][google.cloud.aiplatform.v1beta1.ListTrainingPipelinesRequest.page_token] + // to obtain that page. string next_page_token = 2; } -// Request message for [PipelineService.DeleteTrainingPipeline][google.cloud.aiplatform.v1beta1.PipelineService.DeleteTrainingPipeline]. +// Request message for +// [PipelineService.DeleteTrainingPipeline][google.cloud.aiplatform.v1beta1.PipelineService.DeleteTrainingPipeline]. message DeleteTrainingPipelineRequest { // Required. The name of the TrainingPipeline resource to be deleted. // Format: @@ -250,7 +277,8 @@ message DeleteTrainingPipelineRequest { ]; } -// Request message for [PipelineService.CancelTrainingPipeline][google.cloud.aiplatform.v1beta1.PipelineService.CancelTrainingPipeline]. +// Request message for +// [PipelineService.CancelTrainingPipeline][google.cloud.aiplatform.v1beta1.PipelineService.CancelTrainingPipeline]. message CancelTrainingPipelineRequest { // Required. The name of the TrainingPipeline to cancel. // Format: @@ -263,7 +291,8 @@ message CancelTrainingPipelineRequest { ]; } -// Request message for [PipelineService.CreatePipelineJob][google.cloud.aiplatform.v1beta1.PipelineService.CreatePipelineJob]. +// Request message for +// [PipelineService.CreatePipelineJob][google.cloud.aiplatform.v1beta1.PipelineService.CreatePipelineJob]. message CreatePipelineJobRequest { // Required. The resource name of the Location to create the PipelineJob in. // Format: `projects/{project}/locations/{location}` @@ -286,7 +315,8 @@ message CreatePipelineJobRequest { string pipeline_job_id = 3; } -// Request message for [PipelineService.GetPipelineJob][google.cloud.aiplatform.v1beta1.PipelineService.GetPipelineJob]. +// Request message for +// [PipelineService.GetPipelineJob][google.cloud.aiplatform.v1beta1.PipelineService.GetPipelineJob]. message GetPipelineJobRequest { // Required. The name of the PipelineJob resource. // Format: @@ -299,7 +329,8 @@ message GetPipelineJobRequest { ]; } -// Request message for [PipelineService.ListPipelineJobs][google.cloud.aiplatform.v1beta1.PipelineService.ListPipelineJobs]. +// Request message for +// [PipelineService.ListPipelineJobs][google.cloud.aiplatform.v1beta1.PipelineService.ListPipelineJobs]. message ListPipelineJobsRequest { // Required. The resource name of the Location to list the PipelineJobs from. // Format: `projects/{project}/locations/{location}` @@ -351,8 +382,10 @@ message ListPipelineJobsRequest { // The standard list page token. // Typically obtained via - // [ListPipelineJobsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListPipelineJobsResponse.next_page_token] of the previous - // [PipelineService.ListPipelineJobs][google.cloud.aiplatform.v1beta1.PipelineService.ListPipelineJobs] call. + // [ListPipelineJobsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListPipelineJobsResponse.next_page_token] + // of the previous + // [PipelineService.ListPipelineJobs][google.cloud.aiplatform.v1beta1.PipelineService.ListPipelineJobs] + // call. string page_token = 4; // A comma-separated list of fields to order by. The default sort order is in @@ -374,17 +407,21 @@ message ListPipelineJobsRequest { google.protobuf.FieldMask read_mask = 7; } -// Response message for [PipelineService.ListPipelineJobs][google.cloud.aiplatform.v1beta1.PipelineService.ListPipelineJobs] +// Response message for +// [PipelineService.ListPipelineJobs][google.cloud.aiplatform.v1beta1.PipelineService.ListPipelineJobs] message ListPipelineJobsResponse { // List of PipelineJobs in the requested page. repeated PipelineJob pipeline_jobs = 1; // A token to retrieve the next page of results. - // Pass to [ListPipelineJobsRequest.page_token][google.cloud.aiplatform.v1beta1.ListPipelineJobsRequest.page_token] to obtain that page. + // Pass to + // [ListPipelineJobsRequest.page_token][google.cloud.aiplatform.v1beta1.ListPipelineJobsRequest.page_token] + // to obtain that page. string next_page_token = 2; } -// Request message for [PipelineService.DeletePipelineJob][google.cloud.aiplatform.v1beta1.PipelineService.DeletePipelineJob]. +// Request message for +// [PipelineService.DeletePipelineJob][google.cloud.aiplatform.v1beta1.PipelineService.DeletePipelineJob]. message DeletePipelineJobRequest { // Required. The name of the PipelineJob resource to be deleted. // Format: @@ -397,7 +434,8 @@ message DeletePipelineJobRequest { ]; } -// Request message for [PipelineService.CancelPipelineJob][google.cloud.aiplatform.v1beta1.PipelineService.CancelPipelineJob]. +// Request message for +// [PipelineService.CancelPipelineJob][google.cloud.aiplatform.v1beta1.PipelineService.CancelPipelineJob]. message CancelPipelineJobRequest { // Required. The name of the PipelineJob to cancel. // Format: diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/prediction_service.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/prediction_service.proto index e2452420516..72e516fe6e7 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/prediction_service.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/prediction_service.proto @@ -35,7 +35,8 @@ option ruby_package = "Google::Cloud::AIPlatform::V1beta1"; // A service for online predictions and explanations. service PredictionService { option (google.api.default_host) = "aiplatform.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/cloud-platform"; // Perform an online prediction. rpc Predict(PredictRequest) returns (PredictResponse) { @@ -50,11 +51,13 @@ service PredictionService { // // The response includes the following HTTP headers: // - // * `X-Vertex-AI-Endpoint-Id`: ID of the [Endpoint][google.cloud.aiplatform.v1beta1.Endpoint] that served this + // * `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. + // * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's + // [DeployedModel][google.cloud.aiplatform.v1beta1.DeployedModel] that served + // this prediction. rpc RawPredict(RawPredictRequest) returns (google.api.HttpBody) { option (google.api.http) = { post: "/v1beta1/{endpoint=projects/*/locations/*/endpoints/*}:rawPredict" @@ -65,10 +68,12 @@ service PredictionService { // Perform an online explanation. // - // If [deployed_model_id][google.cloud.aiplatform.v1beta1.ExplainRequest.deployed_model_id] is specified, - // the corresponding DeployModel must have + // 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] + // 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 @@ -78,11 +83,13 @@ service PredictionService { post: "/v1beta1/{endpoint=projects/*/locations/*/endpoints/*}:explain" body: "*" }; - option (google.api.method_signature) = "endpoint,instances,parameters,deployed_model_id"; + option (google.api.method_signature) = + "endpoint,instances,parameters,deployed_model_id"; } } -// Request message for [PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict]. +// Request message for +// [PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict]. message PredictRequest { // Required. The name of the Endpoint requested to serve the prediction. // Format: @@ -100,23 +107,28 @@ message PredictRequest { // in case of AutoML Models, or, in case of customer created Models, the // behaviour is as documented by that Model. // The schema of any single instance may be specified via Endpoint's - // DeployedModels' [Model's][google.cloud.aiplatform.v1beta1.DeployedModel.model] + // DeployedModels' + // [Model's][google.cloud.aiplatform.v1beta1.DeployedModel.model] // [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata] // [instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri]. - repeated google.protobuf.Value instances = 2 [(google.api.field_behavior) = REQUIRED]; + repeated google.protobuf.Value instances = 2 + [(google.api.field_behavior) = REQUIRED]; // The parameters that govern the prediction. The schema of the parameters may - // be specified via Endpoint's DeployedModels' [Model's ][google.cloud.aiplatform.v1beta1.DeployedModel.model] + // be specified via Endpoint's DeployedModels' [Model's + // ][google.cloud.aiplatform.v1beta1.DeployedModel.model] // [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata] // [parameters_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.parameters_schema_uri]. google.protobuf.Value parameters = 3; } -// Response message for [PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict]. +// Response message for +// [PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict]. message PredictResponse { // The predictions that are the output of the predictions call. // The schema of any single prediction may be specified via Endpoint's - // DeployedModels' [Model's ][google.cloud.aiplatform.v1beta1.DeployedModel.model] + // DeployedModels' [Model's + // ][google.cloud.aiplatform.v1beta1.DeployedModel.model] // [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata] // [prediction_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.prediction_schema_uri]. repeated google.protobuf.Value predictions = 1; @@ -124,8 +136,8 @@ message PredictResponse { // ID of the Endpoint's DeployedModel that served this prediction. string deployed_model_id = 2; - // Output only. The resource name of the Model which is deployed as the DeployedModel that - // this prediction hits. + // Output only. The resource name of the Model which is deployed as the + // DeployedModel that this prediction hits. string model = 3 [ (google.api.field_behavior) = OUTPUT_ONLY, (google.api.resource_reference) = { @@ -133,16 +145,18 @@ message PredictResponse { } ]; - // Output only. The version ID of the Model which is deployed as the DeployedModel that - // this prediction hits. + // Output only. The version ID of the Model which is deployed as the + // DeployedModel that this prediction hits. string model_version_id = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. The [display name][google.cloud.aiplatform.v1beta1.Model.display_name] of the Model which is deployed as - // the DeployedModel that this prediction hits. + // Output only. The [display + // name][google.cloud.aiplatform.v1beta1.Model.display_name] of the Model + // which is deployed as the DeployedModel that this prediction hits. string model_display_name = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; } -// Request message for [PredictionService.RawPredict][google.cloud.aiplatform.v1beta1.PredictionService.RawPredict]. +// Request message for +// [PredictionService.RawPredict][google.cloud.aiplatform.v1beta1.PredictionService.RawPredict]. message RawPredictRequest { // Required. The name of the Endpoint requested to serve the prediction. // Format: @@ -156,21 +170,24 @@ message RawPredictRequest { // The prediction input. Supports HTTP headers and arbitrary data payload. // - // A [DeployedModel][google.cloud.aiplatform.v1beta1.DeployedModel] may have an upper limit on the number of instances it - // supports per request. When this limit it is exceeded for an AutoML model, - // the [RawPredict][google.cloud.aiplatform.v1beta1.PredictionService.RawPredict] method returns an error. - // When this limit is exceeded for a custom-trained model, the behavior varies - // depending on the model. + // A [DeployedModel][google.cloud.aiplatform.v1beta1.DeployedModel] may have + // an upper limit on the number of instances it supports per request. When + // this limit it is exceeded for an AutoML model, the + // [RawPredict][google.cloud.aiplatform.v1beta1.PredictionService.RawPredict] + // method returns an error. When this limit is exceeded for a custom-trained + // model, the behavior varies depending on the model. // // You can specify the schema for each instance in the // [predict_schemata.instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri] - // field when you create a [Model][google.cloud.aiplatform.v1beta1.Model]. This schema applies when you deploy the - // `Model` as a `DeployedModel` to an [Endpoint][google.cloud.aiplatform.v1beta1.Endpoint] and use the `RawPredict` - // method. + // field when you create a [Model][google.cloud.aiplatform.v1beta1.Model]. + // This schema applies when you deploy the `Model` as a `DeployedModel` to an + // [Endpoint][google.cloud.aiplatform.v1beta1.Endpoint] and use the + // `RawPredict` method. google.api.HttpBody http_body = 2; } -// Request message for [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain]. +// Request message for +// [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain]. message ExplainRequest { // Required. The name of the Endpoint requested to serve the explanation. // Format: @@ -188,21 +205,24 @@ message ExplainRequest { // in case of AutoML Models, or, in case of customer created Models, the // behaviour is as documented by that Model. // The schema of any single instance may be specified via Endpoint's - // DeployedModels' [Model's][google.cloud.aiplatform.v1beta1.DeployedModel.model] + // DeployedModels' + // [Model's][google.cloud.aiplatform.v1beta1.DeployedModel.model] // [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata] // [instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri]. - repeated google.protobuf.Value instances = 2 [(google.api.field_behavior) = REQUIRED]; + repeated google.protobuf.Value instances = 2 + [(google.api.field_behavior) = REQUIRED]; // The parameters that govern the prediction. The schema of the parameters may - // be specified via Endpoint's DeployedModels' [Model's ][google.cloud.aiplatform.v1beta1.DeployedModel.model] + // be specified via Endpoint's DeployedModels' [Model's + // ][google.cloud.aiplatform.v1beta1.DeployedModel.model] // [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata] // [parameters_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.parameters_schema_uri]. google.protobuf.Value parameters = 4; // If specified, overrides the - // [explanation_spec][google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec] of the DeployedModel. - // Can be used for explaining prediction results with different - // configurations, such as: + // [explanation_spec][google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec] + // of the DeployedModel. Can be used for explaining prediction results with + // different configurations, such as: // - Explaining top-5 predictions results as opposed to top-1; // - Increasing path count or step count of the attribution methods to reduce // approximate errors; @@ -210,22 +230,27 @@ message ExplainRequest { ExplanationSpecOverride explanation_spec_override = 5; // If specified, this ExplainRequest will be served by the chosen - // DeployedModel, overriding [Endpoint.traffic_split][google.cloud.aiplatform.v1beta1.Endpoint.traffic_split]. + // DeployedModel, overriding + // [Endpoint.traffic_split][google.cloud.aiplatform.v1beta1.Endpoint.traffic_split]. string deployed_model_id = 3; } -// Response message for [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain]. +// Response message for +// [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain]. message ExplainResponse { - // The explanations of the Model's [PredictResponse.predictions][google.cloud.aiplatform.v1beta1.PredictResponse.predictions]. + // The explanations of the Model's + // [PredictResponse.predictions][google.cloud.aiplatform.v1beta1.PredictResponse.predictions]. // - // It has the same number of elements as [instances][google.cloud.aiplatform.v1beta1.ExplainRequest.instances] - // to be explained. + // It has the same number of elements as + // [instances][google.cloud.aiplatform.v1beta1.ExplainRequest.instances] to be + // explained. repeated Explanation explanations = 1; // ID of the Endpoint's DeployedModel that served this explanation. string deployed_model_id = 2; // The predictions that are the output of the predictions call. - // Same as [PredictResponse.predictions][google.cloud.aiplatform.v1beta1.PredictResponse.predictions]. + // Same as + // [PredictResponse.predictions][google.cloud.aiplatform.v1beta1.PredictResponse.predictions]. repeated google.protobuf.Value predictions = 3; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/saved_query.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/saved_query.proto index da02d8a501d..e7c03ff9e26 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/saved_query.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/saved_query.proto @@ -49,10 +49,12 @@ message SavedQuery { google.protobuf.Value metadata = 12; // Output only. Timestamp when this SavedQuery was created. - google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when SavedQuery was last updated. - google.protobuf.Timestamp update_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Filters on the Annotations in the dataset. string annotation_filter = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; @@ -79,7 +81,7 @@ message SavedQuery { // "overwrite" update happens. string etag = 8; - // Output only. If the Annotations belonging to the SavedQuery can be used for AutoML - // training. + // Output only. If the Annotations belonging to the SavedQuery can be used for + // AutoML training. bool support_automl_training = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/specialist_pool.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/specialist_pool.proto index 49be7b793f2..0e0fe024817 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/specialist_pool.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/specialist_pool.proto @@ -43,19 +43,21 @@ message SpecialistPool { string name = 1 [(google.api.field_behavior) = REQUIRED]; // Required. The user-defined name of the SpecialistPool. - // The name can be up to 128 characters long and can be consist of any UTF-8 + // The name can be up to 128 characters long and can consist of any UTF-8 // characters. // This field should be unique on project-level. string display_name = 2 [(google.api.field_behavior) = REQUIRED]; // Output only. The number of managers in this SpecialistPool. - int32 specialist_managers_count = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + int32 specialist_managers_count = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; // The email addresses of the managers in the SpecialistPool. repeated string specialist_manager_emails = 4; // Output only. The resource name of the pending data labeling jobs. - repeated string pending_data_labeling_jobs = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + repeated string pending_data_labeling_jobs = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; // The email addresses of workers in the SpecialistPool. repeated string specialist_worker_emails = 7; diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/specialist_pool_service.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/specialist_pool_service.proto index a110b9cb838..204e4de1099 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/specialist_pool_service.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/specialist_pool_service.proto @@ -41,10 +41,12 @@ option ruby_package = "Google::Cloud::AIPlatform::V1beta1"; // CrowdCompute console. service SpecialistPoolService { option (google.api.default_host) = "aiplatform.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/cloud-platform"; // Creates a SpecialistPool. - rpc CreateSpecialistPool(CreateSpecialistPoolRequest) returns (google.longrunning.Operation) { + rpc CreateSpecialistPool(CreateSpecialistPoolRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta1/{parent=projects/*/locations/*}/specialistPools" body: "specialist_pool" @@ -65,7 +67,8 @@ service SpecialistPoolService { } // Lists SpecialistPools in a Location. - rpc ListSpecialistPools(ListSpecialistPoolsRequest) returns (ListSpecialistPoolsResponse) { + rpc ListSpecialistPools(ListSpecialistPoolsRequest) + returns (ListSpecialistPoolsResponse) { option (google.api.http) = { get: "/v1beta1/{parent=projects/*/locations/*}/specialistPools" }; @@ -73,7 +76,8 @@ service SpecialistPoolService { } // Deletes a SpecialistPool as well as all Specialists in the pool. - rpc DeleteSpecialistPool(DeleteSpecialistPoolRequest) returns (google.longrunning.Operation) { + rpc DeleteSpecialistPool(DeleteSpecialistPoolRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1beta1/{name=projects/*/locations/*/specialistPools/*}" }; @@ -85,7 +89,8 @@ service SpecialistPoolService { } // Updates a SpecialistPool. - rpc UpdateSpecialistPool(UpdateSpecialistPoolRequest) returns (google.longrunning.Operation) { + rpc UpdateSpecialistPool(UpdateSpecialistPoolRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { patch: "/v1beta1/{specialist_pool.name=projects/*/locations/*/specialistPools/*}" body: "specialist_pool" @@ -98,7 +103,8 @@ service SpecialistPoolService { } } -// Request message for [SpecialistPoolService.CreateSpecialistPool][google.cloud.aiplatform.v1beta1.SpecialistPoolService.CreateSpecialistPool]. +// Request message for +// [SpecialistPoolService.CreateSpecialistPool][google.cloud.aiplatform.v1beta1.SpecialistPoolService.CreateSpecialistPool]. message CreateSpecialistPoolRequest { // Required. The parent Project name for the new SpecialistPool. // The form is `projects/{project}/locations/{location}`. @@ -120,7 +126,8 @@ message CreateSpecialistPoolOperationMetadata { GenericOperationMetadata generic_metadata = 1; } -// Request message for [SpecialistPoolService.GetSpecialistPool][google.cloud.aiplatform.v1beta1.SpecialistPoolService.GetSpecialistPool]. +// Request message for +// [SpecialistPoolService.GetSpecialistPool][google.cloud.aiplatform.v1beta1.SpecialistPoolService.GetSpecialistPool]. message GetSpecialistPoolRequest { // Required. The name of the SpecialistPool resource. // The form is @@ -133,7 +140,8 @@ message GetSpecialistPoolRequest { ]; } -// Request message for [SpecialistPoolService.ListSpecialistPools][google.cloud.aiplatform.v1beta1.SpecialistPoolService.ListSpecialistPools]. +// Request message for +// [SpecialistPoolService.ListSpecialistPools][google.cloud.aiplatform.v1beta1.SpecialistPoolService.ListSpecialistPools]. message ListSpecialistPoolsRequest { // Required. The name of the SpecialistPool's parent resource. // Format: `projects/{project}/locations/{location}` @@ -148,16 +156,19 @@ message ListSpecialistPoolsRequest { int32 page_size = 2; // The standard list page token. - // Typically obtained by [ListSpecialistPoolsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListSpecialistPoolsResponse.next_page_token] of - // the previous [SpecialistPoolService.ListSpecialistPools][google.cloud.aiplatform.v1beta1.SpecialistPoolService.ListSpecialistPools] call. Return - // first page if empty. + // Typically obtained by + // [ListSpecialistPoolsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListSpecialistPoolsResponse.next_page_token] + // of the previous + // [SpecialistPoolService.ListSpecialistPools][google.cloud.aiplatform.v1beta1.SpecialistPoolService.ListSpecialistPools] + // call. Return first page if empty. string page_token = 3; // Mask specifying which fields to read. FieldMask represents a set of google.protobuf.FieldMask read_mask = 4; } -// Response message for [SpecialistPoolService.ListSpecialistPools][google.cloud.aiplatform.v1beta1.SpecialistPoolService.ListSpecialistPools]. +// Response message for +// [SpecialistPoolService.ListSpecialistPools][google.cloud.aiplatform.v1beta1.SpecialistPoolService.ListSpecialistPools]. message ListSpecialistPoolsResponse { // A list of SpecialistPools that matches the specified filter in the request. repeated SpecialistPool specialist_pools = 1; @@ -166,7 +177,8 @@ message ListSpecialistPoolsResponse { string next_page_token = 2; } -// Request message for [SpecialistPoolService.DeleteSpecialistPool][google.cloud.aiplatform.v1beta1.SpecialistPoolService.DeleteSpecialistPool]. +// Request message for +// [SpecialistPoolService.DeleteSpecialistPool][google.cloud.aiplatform.v1beta1.SpecialistPoolService.DeleteSpecialistPool]. message DeleteSpecialistPoolRequest { // Required. The resource name of the SpecialistPool to delete. Format: // `projects/{project}/locations/{location}/specialistPools/{specialist_pool}` @@ -183,20 +195,22 @@ message DeleteSpecialistPoolRequest { bool force = 2; } -// Request message for [SpecialistPoolService.UpdateSpecialistPool][google.cloud.aiplatform.v1beta1.SpecialistPoolService.UpdateSpecialistPool]. +// Request message for +// [SpecialistPoolService.UpdateSpecialistPool][google.cloud.aiplatform.v1beta1.SpecialistPoolService.UpdateSpecialistPool]. message UpdateSpecialistPoolRequest { // Required. The SpecialistPool which replaces the resource on the server. SpecialistPool specialist_pool = 1 [(google.api.field_behavior) = REQUIRED]; // Required. The update mask applies to the resource. - google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.FieldMask update_mask = 2 + [(google.api.field_behavior) = REQUIRED]; } // Runtime operation metadata for // [SpecialistPoolService.UpdateSpecialistPool][google.cloud.aiplatform.v1beta1.SpecialistPoolService.UpdateSpecialistPool]. message UpdateSpecialistPoolOperationMetadata { - // Output only. The name of the SpecialistPool to which the specialists are being added. - // Format: + // Output only. The name of the SpecialistPool to which the specialists are + // being added. Format: // `projects/{project_id}/locations/{location_id}/specialistPools/{specialist_pool}` string specialist_pool = 1 [ (google.api.field_behavior) = OUTPUT_ONLY, diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/study.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/study.proto index 5ca0eb1a0eb..8d27d555bcd 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/study.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/study.proto @@ -67,7 +67,8 @@ message Study { State state = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Time at which the study was created. - google.protobuf.Timestamp create_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. A human readable reason why the Study is inactive. // This should be empty if a study is ACTIVE or COMPLETED. @@ -86,7 +87,8 @@ message Trial { // A message representing a parameter to be tuned. message Parameter { // Output only. The ID of the parameter. The parameter should be defined in - // [StudySpec's Parameters][google.cloud.aiplatform.v1beta1.StudySpec.parameters]. + // [StudySpec's + // Parameters][google.cloud.aiplatform.v1beta1.StudySpec.parameters]. string parameter_id = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The value of the parameter. @@ -139,17 +141,21 @@ message Trial { // Output only. A list of measurements that are strictly lexicographically // ordered by their induced tuples (steps, elapsed_duration). // These are used for early stopping computations. - repeated Measurement measurements = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + repeated Measurement measurements = 6 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Time when the Trial was started. - google.protobuf.Timestamp start_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp start_time = 7 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. Time when the Trial's status changed to `SUCCEEDED` or `INFEASIBLE`. - google.protobuf.Timestamp end_time = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. Time when the Trial's status changed to `SUCCEEDED` or + // `INFEASIBLE`. + google.protobuf.Timestamp end_time = 8 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. The identifier of the client that originally requested this Trial. - // Each client is identified by a unique client_id. When a client - // asks for a suggestion, Vertex AI Vizier will assign it a Trial. The client + // Output only. The identifier of the client that originally requested this + // Trial. Each client is identified by a unique client_id. When a client asks + // for a suggestion, Vertex AI Vizier will assign it a Trial. The client // should evaluate the Trial, complete it, and report back to Vertex AI // Vizier. If suggestion is asked again by same client_id before the Trial is // completed, the same Trial will be returned. Multiple clients with @@ -173,9 +179,11 @@ message Trial { // Output only. URIs for accessing [interactive // shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) // (one URI for each training node). Only available if this trial is part of - // a [HyperparameterTuningJob][google.cloud.aiplatform.v1beta1.HyperparameterTuningJob] and the job's - // [trial_job_spec.enable_web_access][google.cloud.aiplatform.v1beta1.CustomJobSpec.enable_web_access] field - // is `true`. + // a + // [HyperparameterTuningJob][google.cloud.aiplatform.v1beta1.HyperparameterTuningJob] + // and the job's + // [trial_job_spec.enable_web_access][google.cloud.aiplatform.v1beta1.CustomJobSpec.enable_web_access] + // field is `true`. // // The keys are names of each node used for the trial; for example, // `workerpool0-0` for the primary node, `workerpool1-0` for the first node in @@ -183,7 +191,8 @@ message Trial { // second worker pool. // // The values are the URIs for each node's interactive shell. - map web_access_uris = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; + map web_access_uris = 12 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // Represents specification of a Study. @@ -202,8 +211,8 @@ message StudySpec { MINIMIZE = 2; } - // Required. The ID of the metric. Must not contain whitespaces and must be unique - // amongst all MetricSpecs. + // Required. The ID of the metric. Must not contain whitespaces and must be + // unique amongst all MetricSpecs. string metric_id = 1 [(google.api.field_behavior) = REQUIRED]; // Required. The optimization goal of the metric. @@ -298,8 +307,8 @@ message StudySpec { // Represents the spec to match categorical values from parent parameter. message CategoricalValueCondition { - // Required. Matches values of the parent parameter of 'CATEGORICAL' type. - // All values must exist in `categorical_value_spec` of parent + // Required. Matches values of the parent parameter of 'CATEGORICAL' + // type. All values must exist in `categorical_value_spec` of parent // parameter. repeated string values = 1 [(google.api.field_behavior) = REQUIRED]; } @@ -357,8 +366,8 @@ message StudySpec { DiscreteValueSpec discrete_value_spec = 5; } - // Required. The ID of the parameter. Must not contain whitespaces and must be unique - // amongst all ParameterSpecs. + // Required. The ID of the parameter. Must not contain whitespaces and must + // be unique amongst all ParameterSpecs. string parameter_id = 1 [(google.api.field_behavior) = REQUIRED]; // How the parameter should be scaled. @@ -379,9 +388,11 @@ message StudySpec { // Trial. Early stopping is requested for the current Trial if there is very // low probability to exceed the optimal value found so far. message DecayCurveAutomatedStoppingSpec { - // True if [Measurement.elapsed_duration][google.cloud.aiplatform.v1beta1.Measurement.elapsed_duration] is used as the x-axis of each - // Trials Decay Curve. Otherwise, [Measurement.step_count][google.cloud.aiplatform.v1beta1.Measurement.step_count] will be used - // as the x-axis. + // True if + // [Measurement.elapsed_duration][google.cloud.aiplatform.v1beta1.Measurement.elapsed_duration] + // is used as the x-axis of each Trials Decay Curve. Otherwise, + // [Measurement.step_count][google.cloud.aiplatform.v1beta1.Measurement.step_count] + // will be used as the x-axis. bool use_elapsed_duration = 1; } @@ -392,9 +403,10 @@ message StudySpec { // values reported by the Trial in each measurement. message MedianAutomatedStoppingSpec { // True if median automated stopping rule applies on - // [Measurement.elapsed_duration][google.cloud.aiplatform.v1beta1.Measurement.elapsed_duration]. It means that elapsed_duration - // field of latest measurement of current Trial is used to compute median - // objective value for each completed Trials. + // [Measurement.elapsed_duration][google.cloud.aiplatform.v1beta1.Measurement.elapsed_duration]. + // It means that elapsed_duration field of latest measurement of current + // Trial is used to compute median objective value for each completed + // Trials. bool use_elapsed_duration = 1; } @@ -444,6 +456,15 @@ message StudySpec { // min_num_steps are overloaded to contain max_elapsed_seconds and // min_elapsed_seconds. bool use_elapsed_duration = 5; + + // ConvexAutomatedStoppingSpec by default only updates the trials that needs + // to be early stopped using a newly trained auto-regressive model. When + // this flag is set to True, all stopped trials from the beginning are + // potentially updated in terms of their `final_measurement`. Also, note + // that the training logic of autoregressive models is different in this + // case. Enabling this option has shown better results and this may be the + // default option in the future. + optional bool update_all_stopped_trials = 6; } // Configuration for ConvexStopPolicy. @@ -495,7 +516,8 @@ message StudySpec { bool disable_transfer_learning = 1; // Output only. Names of previously completed studies - repeated string prior_study_names = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + repeated string prior_study_names = 2 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // The available search algorithms for the Study. @@ -574,7 +596,8 @@ message StudySpec { repeated MetricSpec metrics = 1 [(google.api.field_behavior) = REQUIRED]; // Required. The set of parameters to tune. - repeated ParameterSpec parameters = 2 [(google.api.field_behavior) = REQUIRED]; + repeated ParameterSpec parameters = 2 + [(google.api.field_behavior) = REQUIRED]; // The search algorithm specified for the Study. Algorithm algorithm = 3; @@ -606,14 +629,16 @@ message Measurement { double value = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; } - // Output only. Time that the Trial has been running at the point of this Measurement. - google.protobuf.Duration elapsed_duration = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. Time that the Trial has been running at the point of this + // Measurement. + google.protobuf.Duration elapsed_duration = 1 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. The number of steps the machine learning model has been trained for. - // Must be non-negative. + // Output only. The number of steps the machine learning model has been + // trained for. Must be non-negative. int64 step_count = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. A list of metrics got by evaluating the objective functions using suggested - // Parameter values. + // Output only. A list of metrics got by evaluating the objective functions + // using suggested Parameter values. repeated Metric metrics = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/tensorboard.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/tensorboard.proto index 640e636e5cf..ef7d56470ab 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/tensorboard.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/tensorboard.proto @@ -30,7 +30,7 @@ option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1"; option ruby_package = "Google::Cloud::AIPlatform::V1beta1"; // Tensorboard is a physical database that stores users' training metrics. -// A default Tensorboard is provided in each region of a GCP project. +// A default Tensorboard is provided in each region of a Google Cloud project. // If needed users can also create extra Tensorboards in their projects. message Tensorboard { option (google.api.resource) = { @@ -54,18 +54,21 @@ message Tensorboard { // this key. EncryptionSpec encryption_spec = 11; - // Output only. Consumer project Cloud Storage path prefix used to store blob data, which - // can either be a bucket or directory. Does not end with a '/'. - string blob_storage_path_prefix = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. Consumer project Cloud Storage path prefix used to store blob + // data, which can either be a bucket or directory. Does not end with a '/'. + string blob_storage_path_prefix = 10 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The number of Runs stored in this Tensorboard. int32 run_count = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this Tensorboard was created. - google.protobuf.Timestamp create_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 6 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this Tensorboard was last updated. - google.protobuf.Timestamp update_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 7 + [(google.api.field_behavior) = OUTPUT_ONLY]; // The labels with user-defined metadata to organize your Tensorboards. // diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/tensorboard_data.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/tensorboard_data.proto index cfc36e3026a..90d883bf4f3 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/tensorboard_data.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/tensorboard_data.proto @@ -30,19 +30,21 @@ option ruby_package = "Google::Cloud::AIPlatform::V1beta1"; // All the data stored in a TensorboardTimeSeries. message TimeSeriesData { - // Required. The ID of the TensorboardTimeSeries, which will become the final component - // of the TensorboardTimeSeries' resource name - string tensorboard_time_series_id = 1 [(google.api.field_behavior) = REQUIRED]; + // Required. The ID of the TensorboardTimeSeries, which will become the final + // component of the TensorboardTimeSeries' resource name + string tensorboard_time_series_id = 1 + [(google.api.field_behavior) = REQUIRED]; - // Required. Immutable. The value type of this time series. All the values in this time series data - // must match this value type. + // Required. Immutable. The value type of this time series. All the values in + // this time series data must match this value type. TensorboardTimeSeries.ValueType value_type = 2 [ (google.api.field_behavior) = REQUIRED, (google.api.field_behavior) = IMMUTABLE ]; // Required. Data points in this time series. - repeated TimeSeriesDataPoint values = 3 [(google.api.field_behavior) = REQUIRED]; + repeated TimeSeriesDataPoint values = 3 + [(google.api.field_behavior) = REQUIRED]; } // A TensorboardTimeSeries data point. @@ -78,7 +80,8 @@ message TensorboardTensor { // https://github.com/tensorflow/tensorflow/blob/master/tensorflow/core/framework/tensor.proto bytes value = 1 [(google.api.field_behavior) = REQUIRED]; - // Optional. Version number of TensorProto used to serialize [value][google.cloud.aiplatform.v1beta1.TensorboardTensor.value]. + // Optional. Version number of TensorProto used to serialize + // [value][google.cloud.aiplatform.v1beta1.TensorboardTensor.value]. int32 version_number = 2 [(google.api.field_behavior) = OPTIONAL]; } @@ -91,8 +94,8 @@ message TensorboardBlobSequence { // One blob (e.g, image, graph) viewable on a blob metric plot. message TensorboardBlob { - // Output only. A URI safe key uniquely identifying a blob. Can be used to locate the blob - // stored in the Cloud Storage bucket of the consumer project. + // Output only. A URI safe key uniquely identifying a blob. Can be used to + // locate the blob stored in the Cloud Storage bucket of the consumer project. string id = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Optional. The bytes of the blob is not present unless it's returned by the diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/tensorboard_experiment.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/tensorboard_experiment.proto index 0258ef6d1fc..01c6007753b 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/tensorboard_experiment.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/tensorboard_experiment.proto @@ -48,10 +48,12 @@ message TensorboardExperiment { string description = 3; // Output only. Timestamp when this TensorboardExperiment was created. - google.protobuf.Timestamp create_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this TensorboardExperiment was last updated. - google.protobuf.Timestamp update_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; // The labels with user-defined metadata to organize your Datasets. // @@ -73,6 +75,7 @@ message TensorboardExperiment { // "overwrite" update happens. string etag = 7; - // Immutable. Source of the TensorboardExperiment. Example: a custom training job. + // Immutable. Source of the TensorboardExperiment. Example: a custom training + // job. string source = 8 [(google.api.field_behavior) = IMMUTABLE]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/tensorboard_run.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/tensorboard_run.proto index b5f570c875f..d13446ae341 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/tensorboard_run.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/tensorboard_run.proto @@ -50,10 +50,12 @@ message TensorboardRun { string description = 3; // Output only. Timestamp when this TensorboardRun was created. - google.protobuf.Timestamp create_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 6 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this TensorboardRun was last updated. - google.protobuf.Timestamp update_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 7 + [(google.api.field_behavior) = OUTPUT_ONLY]; // The labels with user-defined metadata to organize your TensorboardRuns. // diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/tensorboard_service.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/tensorboard_service.proto index 629e5d7935a..955e050610f 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/tensorboard_service.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/tensorboard_service.proto @@ -40,10 +40,12 @@ option ruby_package = "Google::Cloud::AIPlatform::V1beta1"; // TensorboardService service TensorboardService { option (google.api.default_host) = "aiplatform.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/cloud-platform"; // Creates a Tensorboard. - rpc CreateTensorboard(CreateTensorboardRequest) returns (google.longrunning.Operation) { + rpc CreateTensorboard(CreateTensorboardRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta1/{parent=projects/*/locations/*}/tensorboards" body: "tensorboard" @@ -63,8 +65,18 @@ service TensorboardService { option (google.api.method_signature) = "name"; } + // Returns a list of monthly active users for a given TensorBoard instance. + rpc ReadTensorboardUsage(ReadTensorboardUsageRequest) + returns (ReadTensorboardUsageResponse) { + option (google.api.http) = { + get: "/v1beta1/{tensorboard=projects/*/locations/*/tensorboards/*}:readUsage" + }; + option (google.api.method_signature) = "tensorboard"; + } + // Updates a Tensorboard. - rpc UpdateTensorboard(UpdateTensorboardRequest) returns (google.longrunning.Operation) { + rpc UpdateTensorboard(UpdateTensorboardRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { patch: "/v1beta1/{tensorboard.name=projects/*/locations/*/tensorboards/*}" body: "tensorboard" @@ -77,7 +89,8 @@ service TensorboardService { } // Lists Tensorboards in a Location. - rpc ListTensorboards(ListTensorboardsRequest) returns (ListTensorboardsResponse) { + rpc ListTensorboards(ListTensorboardsRequest) + returns (ListTensorboardsResponse) { option (google.api.http) = { get: "/v1beta1/{parent=projects/*/locations/*}/tensorboards" }; @@ -85,7 +98,8 @@ service TensorboardService { } // Deletes a Tensorboard. - rpc DeleteTensorboard(DeleteTensorboardRequest) returns (google.longrunning.Operation) { + rpc DeleteTensorboard(DeleteTensorboardRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1beta1/{name=projects/*/locations/*/tensorboards/*}" }; @@ -97,16 +111,19 @@ service TensorboardService { } // Creates a TensorboardExperiment. - rpc CreateTensorboardExperiment(CreateTensorboardExperimentRequest) returns (TensorboardExperiment) { + rpc CreateTensorboardExperiment(CreateTensorboardExperimentRequest) + returns (TensorboardExperiment) { option (google.api.http) = { post: "/v1beta1/{parent=projects/*/locations/*/tensorboards/*}/experiments" body: "tensorboard_experiment" }; - option (google.api.method_signature) = "parent,tensorboard_experiment,tensorboard_experiment_id"; + option (google.api.method_signature) = + "parent,tensorboard_experiment,tensorboard_experiment_id"; } // Gets a TensorboardExperiment. - rpc GetTensorboardExperiment(GetTensorboardExperimentRequest) returns (TensorboardExperiment) { + rpc GetTensorboardExperiment(GetTensorboardExperimentRequest) + returns (TensorboardExperiment) { option (google.api.http) = { get: "/v1beta1/{name=projects/*/locations/*/tensorboards/*/experiments/*}" }; @@ -114,7 +131,8 @@ service TensorboardService { } // Updates a TensorboardExperiment. - rpc UpdateTensorboardExperiment(UpdateTensorboardExperimentRequest) returns (TensorboardExperiment) { + rpc UpdateTensorboardExperiment(UpdateTensorboardExperimentRequest) + returns (TensorboardExperiment) { option (google.api.http) = { patch: "/v1beta1/{tensorboard_experiment.name=projects/*/locations/*/tensorboards/*/experiments/*}" body: "tensorboard_experiment" @@ -123,7 +141,8 @@ service TensorboardService { } // Lists TensorboardExperiments in a Location. - rpc ListTensorboardExperiments(ListTensorboardExperimentsRequest) returns (ListTensorboardExperimentsResponse) { + rpc ListTensorboardExperiments(ListTensorboardExperimentsRequest) + returns (ListTensorboardExperimentsResponse) { option (google.api.http) = { get: "/v1beta1/{parent=projects/*/locations/*/tensorboards/*}/experiments" }; @@ -131,7 +150,8 @@ service TensorboardService { } // Deletes a TensorboardExperiment. - rpc DeleteTensorboardExperiment(DeleteTensorboardExperimentRequest) returns (google.longrunning.Operation) { + rpc DeleteTensorboardExperiment(DeleteTensorboardExperimentRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1beta1/{name=projects/*/locations/*/tensorboards/*/experiments/*}" }; @@ -143,16 +163,19 @@ service TensorboardService { } // Creates a TensorboardRun. - rpc CreateTensorboardRun(CreateTensorboardRunRequest) returns (TensorboardRun) { + rpc CreateTensorboardRun(CreateTensorboardRunRequest) + returns (TensorboardRun) { option (google.api.http) = { post: "/v1beta1/{parent=projects/*/locations/*/tensorboards/*/experiments/*}/runs" body: "tensorboard_run" }; - option (google.api.method_signature) = "parent,tensorboard_run,tensorboard_run_id"; + option (google.api.method_signature) = + "parent,tensorboard_run,tensorboard_run_id"; } // Batch create TensorboardRuns. - rpc BatchCreateTensorboardRuns(BatchCreateTensorboardRunsRequest) returns (BatchCreateTensorboardRunsResponse) { + rpc BatchCreateTensorboardRuns(BatchCreateTensorboardRunsRequest) + returns (BatchCreateTensorboardRunsResponse) { option (google.api.http) = { post: "/v1beta1/{parent=projects/*/locations/*/tensorboards/*/experiments/*}/runs:batchCreate" body: "*" @@ -169,7 +192,8 @@ service TensorboardService { } // Updates a TensorboardRun. - rpc UpdateTensorboardRun(UpdateTensorboardRunRequest) returns (TensorboardRun) { + rpc UpdateTensorboardRun(UpdateTensorboardRunRequest) + returns (TensorboardRun) { option (google.api.http) = { patch: "/v1beta1/{tensorboard_run.name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*}" body: "tensorboard_run" @@ -178,7 +202,8 @@ service TensorboardService { } // Lists TensorboardRuns in a Location. - rpc ListTensorboardRuns(ListTensorboardRunsRequest) returns (ListTensorboardRunsResponse) { + rpc ListTensorboardRuns(ListTensorboardRunsRequest) + returns (ListTensorboardRunsResponse) { option (google.api.http) = { get: "/v1beta1/{parent=projects/*/locations/*/tensorboards/*/experiments/*}/runs" }; @@ -186,7 +211,8 @@ service TensorboardService { } // Deletes a TensorboardRun. - rpc DeleteTensorboardRun(DeleteTensorboardRunRequest) returns (google.longrunning.Operation) { + rpc DeleteTensorboardRun(DeleteTensorboardRunRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1beta1/{name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*}" }; @@ -198,7 +224,8 @@ service TensorboardService { } // Batch create TensorboardTimeSeries that belong to a TensorboardExperiment. - rpc BatchCreateTensorboardTimeSeries(BatchCreateTensorboardTimeSeriesRequest) returns (BatchCreateTensorboardTimeSeriesResponse) { + rpc BatchCreateTensorboardTimeSeries(BatchCreateTensorboardTimeSeriesRequest) + returns (BatchCreateTensorboardTimeSeriesResponse) { option (google.api.http) = { post: "/v1beta1/{parent=projects/*/locations/*/tensorboards/*/experiments/*}/runs/*/timeSeries:batchCreate" body: "*" @@ -207,7 +234,8 @@ service TensorboardService { } // Creates a TensorboardTimeSeries. - rpc CreateTensorboardTimeSeries(CreateTensorboardTimeSeriesRequest) returns (TensorboardTimeSeries) { + rpc CreateTensorboardTimeSeries(CreateTensorboardTimeSeriesRequest) + returns (TensorboardTimeSeries) { option (google.api.http) = { post: "/v1beta1/{parent=projects/*/locations/*/tensorboards/*/experiments/*/runs/*}/timeSeries" body: "tensorboard_time_series" @@ -216,7 +244,8 @@ service TensorboardService { } // Gets a TensorboardTimeSeries. - rpc GetTensorboardTimeSeries(GetTensorboardTimeSeriesRequest) returns (TensorboardTimeSeries) { + rpc GetTensorboardTimeSeries(GetTensorboardTimeSeriesRequest) + returns (TensorboardTimeSeries) { option (google.api.http) = { get: "/v1beta1/{name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*}" }; @@ -224,16 +253,19 @@ service TensorboardService { } // Updates a TensorboardTimeSeries. - rpc UpdateTensorboardTimeSeries(UpdateTensorboardTimeSeriesRequest) returns (TensorboardTimeSeries) { + rpc UpdateTensorboardTimeSeries(UpdateTensorboardTimeSeriesRequest) + returns (TensorboardTimeSeries) { option (google.api.http) = { patch: "/v1beta1/{tensorboard_time_series.name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*}" body: "tensorboard_time_series" }; - option (google.api.method_signature) = "tensorboard_time_series,update_mask"; + option (google.api.method_signature) = + "tensorboard_time_series,update_mask"; } // Lists TensorboardTimeSeries in a Location. - rpc ListTensorboardTimeSeries(ListTensorboardTimeSeriesRequest) returns (ListTensorboardTimeSeriesResponse) { + rpc ListTensorboardTimeSeries(ListTensorboardTimeSeriesRequest) + returns (ListTensorboardTimeSeriesResponse) { option (google.api.http) = { get: "/v1beta1/{parent=projects/*/locations/*/tensorboards/*/experiments/*/runs/*}/timeSeries" }; @@ -241,7 +273,8 @@ service TensorboardService { } // Deletes a TensorboardTimeSeries. - rpc DeleteTensorboardTimeSeries(DeleteTensorboardTimeSeriesRequest) returns (google.longrunning.Operation) { + rpc DeleteTensorboardTimeSeries(DeleteTensorboardTimeSeriesRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1beta1/{name=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*}" }; @@ -254,10 +287,12 @@ service TensorboardService { // 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 + // data points stored is less than the limit, all data is returned. + // Otherwise, the number limit of data points is randomly selected from // this time series and returned. - rpc BatchReadTensorboardTimeSeriesData(BatchReadTensorboardTimeSeriesDataRequest) returns (BatchReadTensorboardTimeSeriesDataResponse) { + rpc BatchReadTensorboardTimeSeriesData( + BatchReadTensorboardTimeSeriesDataRequest) + returns (BatchReadTensorboardTimeSeriesDataResponse) { option (google.api.http) = { get: "/v1beta1/{tensorboard=projects/*/locations/*/tensorboards/*}/experiments/*/runs/*/timeSeries:batchRead" }; @@ -265,11 +300,12 @@ service TensorboardService { } // 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. + // points stored is less than 1000, all data is returned. Otherwise, 1000 + // data points is randomly selected from this time series and returned. // This value can be changed by changing max_data_points, which can't be // greater than 10k. - rpc ReadTensorboardTimeSeriesData(ReadTensorboardTimeSeriesDataRequest) returns (ReadTensorboardTimeSeriesDataResponse) { + rpc ReadTensorboardTimeSeriesData(ReadTensorboardTimeSeriesDataRequest) + returns (ReadTensorboardTimeSeriesDataResponse) { option (google.api.http) = { get: "/v1beta1/{tensorboard_time_series=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*}:read" }; @@ -280,7 +316,8 @@ service TensorboardService { // This is to allow reading blob data stored in consumer project's Cloud // Storage bucket without users having to obtain Cloud Storage access // permission. - rpc ReadTensorboardBlobData(ReadTensorboardBlobDataRequest) returns (stream ReadTensorboardBlobDataResponse) { + rpc ReadTensorboardBlobData(ReadTensorboardBlobDataRequest) + returns (stream ReadTensorboardBlobDataResponse) { option (google.api.http) = { get: "/v1beta1/{time_series=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*}:readBlobData" }; @@ -288,20 +325,21 @@ service TensorboardService { } // Write time series data points of multiple TensorboardTimeSeries in multiple - // TensorboardRun's. If any data fail to be ingested, an error will be - // returned. - rpc WriteTensorboardExperimentData(WriteTensorboardExperimentDataRequest) returns (WriteTensorboardExperimentDataResponse) { + // TensorboardRun's. If any data fail to be ingested, an error is returned. + rpc WriteTensorboardExperimentData(WriteTensorboardExperimentDataRequest) + returns (WriteTensorboardExperimentDataResponse) { option (google.api.http) = { post: "/v1beta1/{tensorboard_experiment=projects/*/locations/*/tensorboards/*/experiments/*}:write" body: "*" }; - option (google.api.method_signature) = "tensorboard_experiment,write_run_data_requests"; + option (google.api.method_signature) = + "tensorboard_experiment,write_run_data_requests"; } // Write time series data points into multiple TensorboardTimeSeries under - // a TensorboardRun. If any data fail to be ingested, an error will be - // returned. - rpc WriteTensorboardRunData(WriteTensorboardRunDataRequest) returns (WriteTensorboardRunDataResponse) { + // a TensorboardRun. If any data fail to be ingested, an error is returned. + rpc WriteTensorboardRunData(WriteTensorboardRunDataRequest) + returns (WriteTensorboardRunDataResponse) { option (google.api.http) = { post: "/v1beta1/{tensorboard_run=projects/*/locations/*/tensorboards/*/experiments/*/runs/*}:write" body: "*" @@ -311,7 +349,8 @@ service TensorboardService { // Exports a TensorboardTimeSeries' data. Data is returned in paginated // responses. - rpc ExportTensorboardTimeSeriesData(ExportTensorboardTimeSeriesDataRequest) returns (ExportTensorboardTimeSeriesDataResponse) { + rpc ExportTensorboardTimeSeriesData(ExportTensorboardTimeSeriesDataRequest) + returns (ExportTensorboardTimeSeriesDataResponse) { option (google.api.http) = { post: "/v1beta1/{tensorboard_time_series=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*}:exportTensorboardTimeSeries" body: "*" @@ -320,7 +359,8 @@ service TensorboardService { } } -// Request message for [TensorboardService.CreateTensorboard][google.cloud.aiplatform.v1beta1.TensorboardService.CreateTensorboard]. +// Request message for +// [TensorboardService.CreateTensorboard][google.cloud.aiplatform.v1beta1.TensorboardService.CreateTensorboard]. message CreateTensorboardRequest { // Required. The resource name of the Location to create the Tensorboard in. // Format: `projects/{project}/locations/{location}` @@ -335,7 +375,8 @@ message CreateTensorboardRequest { Tensorboard tensorboard = 2 [(google.api.field_behavior) = REQUIRED]; } -// Request message for [TensorboardService.GetTensorboard][google.cloud.aiplatform.v1beta1.TensorboardService.GetTensorboard]. +// Request message for +// [TensorboardService.GetTensorboard][google.cloud.aiplatform.v1beta1.TensorboardService.GetTensorboard]. message GetTensorboardRequest { // Required. The name of the Tensorboard resource. // Format: @@ -348,7 +389,42 @@ message GetTensorboardRequest { ]; } -// Request message for [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards]. +// Request message for [TensorboardService.GetTensorboardUsage][]. +message ReadTensorboardUsageRequest { + // Required. The name of the Tensorboard resource. + // Format: + // `projects/{project}/locations/{location}/tensorboards/{tensorboard}` + string tensorboard = 1 [ + (google.api.field_behavior) = REQUIRED, + (google.api.resource_reference) = { + type: "aiplatform.googleapis.com/Tensorboard" + } + ]; +} + +// Response message for [TensorboardService.GetTensorboardUsage][]. +message ReadTensorboardUsageResponse { + // Per user usage data. + message PerUserUsageData { + // User's username + string username = 1; + + // Number of times the user has read data within the Tensorboard. + int64 view_count = 2; + } + + // Per month usage data + message PerMonthUsageData { + // Usage data for each user in the given month. + repeated PerUserUsageData user_usage_data = 1; + } + + // Maps year-month (YYYYMM) string to per month usage data. + map monthly_usage_data = 1; +} + +// Request message for +// [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards]. message ListTensorboardsRequest { // Required. The resource name of the Location to list Tensorboards. // Format: @@ -364,18 +440,18 @@ message ListTensorboardsRequest { string filter = 2; // The maximum number of Tensorboards to return. The service may return - // fewer than this value. If unspecified, at most 100 Tensorboards will be - // returned. The maximum value is 100; values above 100 will be coerced to + // fewer than this value. If unspecified, at most 100 Tensorboards are + // returned. The maximum value is 100; values above 100 are coerced to // 100. int32 page_size = 3; // A page token, received from a previous - // [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards] call. - // Provide this to retrieve the subsequent page. + // [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards] + // call. Provide this to retrieve the subsequent page. // // When paginating, all other parameters provided to - // [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards] must - // match the call that provided the page token. + // [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards] + // must match the call that provided the page token. string page_token = 4; // Field to use to sort the list. @@ -385,26 +461,30 @@ message ListTensorboardsRequest { google.protobuf.FieldMask read_mask = 6; } -// Response message for [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards]. +// Response message for +// [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards]. message ListTensorboardsResponse { // The Tensorboards mathching the request. repeated Tensorboard tensorboards = 1; - // A token, which can be sent as [ListTensorboardsRequest.page_token][google.cloud.aiplatform.v1beta1.ListTensorboardsRequest.page_token] + // A token, which can be sent as + // [ListTensorboardsRequest.page_token][google.cloud.aiplatform.v1beta1.ListTensorboardsRequest.page_token] // to retrieve the next page. If this field is omitted, there are no // subsequent pages. string next_page_token = 2; } -// Request message for [TensorboardService.UpdateTensorboard][google.cloud.aiplatform.v1beta1.TensorboardService.UpdateTensorboard]. +// Request message for +// [TensorboardService.UpdateTensorboard][google.cloud.aiplatform.v1beta1.TensorboardService.UpdateTensorboard]. message UpdateTensorboardRequest { // Required. Field mask is used to specify the fields to be overwritten in the // Tensorboard resource by the update. // The fields specified in the update_mask are relative to the resource, not - // the full request. A field will be overwritten if it is in the mask. If the - // user does not provide a mask then all fields will be overwritten if new + // the full request. A field is overwritten if it's in the mask. If the + // user does not provide a mask then all fields are overwritten if new // values are specified. - google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.FieldMask update_mask = 1 + [(google.api.field_behavior) = REQUIRED]; // Required. The Tensorboard's `name` field is used to identify the // Tensorboard to be updated. Format: @@ -412,7 +492,8 @@ message UpdateTensorboardRequest { Tensorboard tensorboard = 2 [(google.api.field_behavior) = REQUIRED]; } -// Request message for [TensorboardService.DeleteTensorboard][google.cloud.aiplatform.v1beta1.TensorboardService.DeleteTensorboard]. +// Request message for +// [TensorboardService.DeleteTensorboard][google.cloud.aiplatform.v1beta1.TensorboardService.DeleteTensorboard]. message DeleteTensorboardRequest { // Required. The name of the Tensorboard to be deleted. // Format: @@ -425,10 +506,11 @@ message DeleteTensorboardRequest { ]; } -// Request message for [TensorboardService.CreateTensorboardExperiment][google.cloud.aiplatform.v1beta1.TensorboardService.CreateTensorboardExperiment]. +// Request message for +// [TensorboardService.CreateTensorboardExperiment][google.cloud.aiplatform.v1beta1.TensorboardService.CreateTensorboardExperiment]. message CreateTensorboardExperimentRequest { - // Required. The resource name of the Tensorboard to create the TensorboardExperiment - // in. Format: + // Required. The resource name of the Tensorboard to create the + // TensorboardExperiment in. Format: // `projects/{project}/locations/{location}/tensorboards/{tensorboard}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, @@ -440,15 +522,16 @@ message CreateTensorboardExperimentRequest { // The TensorboardExperiment to create. TensorboardExperiment tensorboard_experiment = 2; - // Required. The ID to use for the Tensorboard experiment, which will become the final - // component of the Tensorboard experiment's resource name. + // Required. The ID to use for the Tensorboard experiment, which becomes the + // final component of the Tensorboard experiment's resource name. // // This value should be 1-128 characters, and valid characters // are /[a-z][0-9]-/. string tensorboard_experiment_id = 3 [(google.api.field_behavior) = REQUIRED]; } -// Request message for [TensorboardService.GetTensorboardExperiment][google.cloud.aiplatform.v1beta1.TensorboardService.GetTensorboardExperiment]. +// Request message for +// [TensorboardService.GetTensorboardExperiment][google.cloud.aiplatform.v1beta1.TensorboardService.GetTensorboardExperiment]. message GetTensorboardExperimentRequest { // Required. The name of the TensorboardExperiment resource. // Format: @@ -461,11 +544,12 @@ message GetTensorboardExperimentRequest { ]; } -// Request message for [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments]. +// Request message for +// [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments]. message ListTensorboardExperimentsRequest { - // Required. The resource name of the Tensorboard to list TensorboardExperiments. - // Format: - // 'projects/{project}/locations/{location}/tensorboards/{tensorboard}' + // Required. The resource name of the Tensorboard to list + // TensorboardExperiments. Format: + // `projects/{project}/locations/{location}/tensorboards/{tensorboard}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -478,17 +562,17 @@ message ListTensorboardExperimentsRequest { // The maximum number of TensorboardExperiments to return. The service may // return fewer than this value. If unspecified, at most 50 - // TensorboardExperiments will be returned. The maximum value is 1000; values - // above 1000 will be coerced to 1000. + // TensorboardExperiments are returned. The maximum value is 1000; values + // above 1000 are coerced to 1000. int32 page_size = 3; // A page token, received from a previous - // [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments] call. - // Provide this to retrieve the subsequent page. + // [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments] + // call. Provide this to retrieve the subsequent page. // // When paginating, all other parameters provided to - // [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments] must - // match the call that provided the page token. + // [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments] + // must match the call that provided the page token. string page_token = 4; // Field to use to sort the list. @@ -498,34 +582,40 @@ message ListTensorboardExperimentsRequest { google.protobuf.FieldMask read_mask = 6; } -// Response message for [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments]. +// Response message for +// [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments]. message ListTensorboardExperimentsResponse { // The TensorboardExperiments mathching the request. repeated TensorboardExperiment tensorboard_experiments = 1; // A token, which can be sent as - // [ListTensorboardExperimentsRequest.page_token][google.cloud.aiplatform.v1beta1.ListTensorboardExperimentsRequest.page_token] to retrieve the next page. - // If this field is omitted, there are no subsequent pages. + // [ListTensorboardExperimentsRequest.page_token][google.cloud.aiplatform.v1beta1.ListTensorboardExperimentsRequest.page_token] + // to retrieve the next page. If this field is omitted, there are no + // subsequent pages. string next_page_token = 2; } -// Request message for [TensorboardService.UpdateTensorboardExperiment][google.cloud.aiplatform.v1beta1.TensorboardService.UpdateTensorboardExperiment]. +// Request message for +// [TensorboardService.UpdateTensorboardExperiment][google.cloud.aiplatform.v1beta1.TensorboardService.UpdateTensorboardExperiment]. message UpdateTensorboardExperimentRequest { // Required. Field mask is used to specify the fields to be overwritten in the // TensorboardExperiment resource by the update. // The fields specified in the update_mask are relative to the resource, not - // the full request. A field will be overwritten if it is in the mask. If the - // user does not provide a mask then all fields will be overwritten if new + // the full request. A field is overwritten if it's in the mask. If the + // user does not provide a mask then all fields are overwritten if new // values are specified. - google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.FieldMask update_mask = 1 + [(google.api.field_behavior) = REQUIRED]; // Required. The TensorboardExperiment's `name` field is used to identify the // TensorboardExperiment to be updated. Format: // `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` - TensorboardExperiment tensorboard_experiment = 2 [(google.api.field_behavior) = REQUIRED]; + TensorboardExperiment tensorboard_experiment = 2 + [(google.api.field_behavior) = REQUIRED]; } -// Request message for [TensorboardService.DeleteTensorboardExperiment][google.cloud.aiplatform.v1beta1.TensorboardService.DeleteTensorboardExperiment]. +// Request message for +// [TensorboardService.DeleteTensorboardExperiment][google.cloud.aiplatform.v1beta1.TensorboardService.DeleteTensorboardExperiment]. message DeleteTensorboardExperimentRequest { // Required. The name of the TensorboardExperiment to be deleted. // Format: @@ -538,7 +628,8 @@ message DeleteTensorboardExperimentRequest { ]; } -// Request message for [TensorboardService.BatchCreateTensorboardRuns][google.cloud.aiplatform.v1beta1.TensorboardService.BatchCreateTensorboardRuns]. +// Request message for +// [TensorboardService.BatchCreateTensorboardRuns][google.cloud.aiplatform.v1beta1.TensorboardService.BatchCreateTensorboardRuns]. message BatchCreateTensorboardRunsRequest { // Required. The resource name of the TensorboardExperiment to create the // TensorboardRuns in. Format: @@ -554,19 +645,22 @@ message BatchCreateTensorboardRunsRequest { // Required. The request message specifying the TensorboardRuns to create. // A maximum of 1000 TensorboardRuns can be created in a batch. - repeated CreateTensorboardRunRequest requests = 2 [(google.api.field_behavior) = REQUIRED]; + repeated CreateTensorboardRunRequest requests = 2 + [(google.api.field_behavior) = REQUIRED]; } -// Response message for [TensorboardService.BatchCreateTensorboardRuns][google.cloud.aiplatform.v1beta1.TensorboardService.BatchCreateTensorboardRuns]. +// Response message for +// [TensorboardService.BatchCreateTensorboardRuns][google.cloud.aiplatform.v1beta1.TensorboardService.BatchCreateTensorboardRuns]. message BatchCreateTensorboardRunsResponse { // The created TensorboardRuns. repeated TensorboardRun tensorboard_runs = 1; } -// Request message for [TensorboardService.CreateTensorboardRun][google.cloud.aiplatform.v1beta1.TensorboardService.CreateTensorboardRun]. +// Request message for +// [TensorboardService.CreateTensorboardRun][google.cloud.aiplatform.v1beta1.TensorboardService.CreateTensorboardRun]. message CreateTensorboardRunRequest { - // Required. The resource name of the TensorboardExperiment to create the TensorboardRun - // in. Format: + // Required. The resource name of the TensorboardExperiment to create the + // TensorboardRun in. Format: // `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, @@ -578,7 +672,7 @@ message CreateTensorboardRunRequest { // Required. The TensorboardRun to create. TensorboardRun tensorboard_run = 2 [(google.api.field_behavior) = REQUIRED]; - // Required. The ID to use for the Tensorboard run, which will become the final + // Required. The ID to use for the Tensorboard run, which becomes the final // component of the Tensorboard run's resource name. // // This value should be 1-128 characters, and valid characters @@ -586,7 +680,8 @@ message CreateTensorboardRunRequest { string tensorboard_run_id = 3 [(google.api.field_behavior) = REQUIRED]; } -// Request message for [TensorboardService.GetTensorboardRun][google.cloud.aiplatform.v1beta1.TensorboardService.GetTensorboardRun]. +// Request message for +// [TensorboardService.GetTensorboardRun][google.cloud.aiplatform.v1beta1.TensorboardService.GetTensorboardRun]. message GetTensorboardRunRequest { // Required. The name of the TensorboardRun resource. // Format: @@ -599,11 +694,12 @@ message GetTensorboardRunRequest { ]; } -// Request message for [TensorboardService.ReadTensorboardBlobData][google.cloud.aiplatform.v1beta1.TensorboardService.ReadTensorboardBlobData]. +// Request message for +// [TensorboardService.ReadTensorboardBlobData][google.cloud.aiplatform.v1beta1.TensorboardService.ReadTensorboardBlobData]. message ReadTensorboardBlobDataRequest { // Required. The resource name of the TensorboardTimeSeries to list Blobs. // Format: - // 'projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}' + // `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}` string time_series = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -615,17 +711,19 @@ message ReadTensorboardBlobDataRequest { repeated string blob_ids = 2; } -// Response message for [TensorboardService.ReadTensorboardBlobData][google.cloud.aiplatform.v1beta1.TensorboardService.ReadTensorboardBlobData]. +// Response message for +// [TensorboardService.ReadTensorboardBlobData][google.cloud.aiplatform.v1beta1.TensorboardService.ReadTensorboardBlobData]. message ReadTensorboardBlobDataResponse { // Blob messages containing blob bytes. repeated TensorboardBlob blobs = 1; } -// Request message for [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns]. +// Request message for +// [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns]. message ListTensorboardRunsRequest { - // Required. The resource name of the TensorboardExperiment to list TensorboardRuns. - // Format: - // 'projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}' + // Required. The resource name of the TensorboardExperiment to list + // TensorboardRuns. Format: + // `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -637,18 +735,18 @@ message ListTensorboardRunsRequest { string filter = 2; // The maximum number of TensorboardRuns to return. The service may return - // fewer than this value. If unspecified, at most 50 TensorboardRuns will be - // returned. The maximum value is 1000; values above 1000 will be coerced to + // fewer than this value. If unspecified, at most 50 TensorboardRuns are + // returned. The maximum value is 1000; values above 1000 are coerced to // 1000. int32 page_size = 3; // A page token, received from a previous - // [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns] call. - // Provide this to retrieve the subsequent page. + // [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns] + // call. Provide this to retrieve the subsequent page. // // When paginating, all other parameters provided to - // [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns] must - // match the call that provided the page token. + // [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns] + // must match the call that provided the page token. string page_token = 4; // Field to use to sort the list. @@ -658,34 +756,39 @@ message ListTensorboardRunsRequest { google.protobuf.FieldMask read_mask = 6; } -// Response message for [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns]. +// Response message for +// [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns]. message ListTensorboardRunsResponse { // The TensorboardRuns mathching the request. repeated TensorboardRun tensorboard_runs = 1; - // A token, which can be sent as [ListTensorboardRunsRequest.page_token][google.cloud.aiplatform.v1beta1.ListTensorboardRunsRequest.page_token] to - // retrieve the next page. - // If this field is omitted, there are no subsequent pages. + // A token, which can be sent as + // [ListTensorboardRunsRequest.page_token][google.cloud.aiplatform.v1beta1.ListTensorboardRunsRequest.page_token] + // to retrieve the next page. If this field is omitted, there are no + // subsequent pages. string next_page_token = 2; } -// Request message for [TensorboardService.UpdateTensorboardRun][google.cloud.aiplatform.v1beta1.TensorboardService.UpdateTensorboardRun]. +// Request message for +// [TensorboardService.UpdateTensorboardRun][google.cloud.aiplatform.v1beta1.TensorboardService.UpdateTensorboardRun]. message UpdateTensorboardRunRequest { // Required. Field mask is used to specify the fields to be overwritten in the // TensorboardRun resource by the update. // The fields specified in the update_mask are relative to the resource, not - // the full request. A field will be overwritten if it is in the mask. If the - // user does not provide a mask then all fields will be overwritten if new + // the full request. A field is overwritten if it's in the mask. If the + // user does not provide a mask then all fields are overwritten if new // values are specified. - google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.FieldMask update_mask = 1 + [(google.api.field_behavior) = REQUIRED]; - // Required. The TensorboardRun's `name` field is used to identify the TensorboardRun to - // be updated. Format: + // Required. The TensorboardRun's `name` field is used to identify the + // TensorboardRun to be updated. Format: // `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` TensorboardRun tensorboard_run = 2 [(google.api.field_behavior) = REQUIRED]; } -// Request message for [TensorboardService.DeleteTensorboardRun][google.cloud.aiplatform.v1beta1.TensorboardService.DeleteTensorboardRun]. +// Request message for +// [TensorboardService.DeleteTensorboardRun][google.cloud.aiplatform.v1beta1.TensorboardService.DeleteTensorboardRun]. message DeleteTensorboardRunRequest { // Required. The name of the TensorboardRun to be deleted. // Format: @@ -698,7 +801,8 @@ message DeleteTensorboardRunRequest { ]; } -// Request message for [TensorboardService.BatchCreateTensorboardTimeSeries][google.cloud.aiplatform.v1beta1.TensorboardService.BatchCreateTensorboardTimeSeries]. +// Request message for +// [TensorboardService.BatchCreateTensorboardTimeSeries][google.cloud.aiplatform.v1beta1.TensorboardService.BatchCreateTensorboardTimeSeries]. message BatchCreateTensorboardTimeSeriesRequest { // Required. The resource name of the TensorboardExperiment to create the // TensorboardTimeSeries in. @@ -714,18 +818,21 @@ message BatchCreateTensorboardTimeSeriesRequest { } ]; - // Required. The request message specifying the TensorboardTimeSeries to create. - // A maximum of 1000 TensorboardTimeSeries can be created in a batch. - repeated CreateTensorboardTimeSeriesRequest requests = 2 [(google.api.field_behavior) = REQUIRED]; + // Required. The request message specifying the TensorboardTimeSeries to + // create. A maximum of 1000 TensorboardTimeSeries can be created in a batch. + repeated CreateTensorboardTimeSeriesRequest requests = 2 + [(google.api.field_behavior) = REQUIRED]; } -// Response message for [TensorboardService.BatchCreateTensorboardTimeSeries][google.cloud.aiplatform.v1beta1.TensorboardService.BatchCreateTensorboardTimeSeries]. +// Response message for +// [TensorboardService.BatchCreateTensorboardTimeSeries][google.cloud.aiplatform.v1beta1.TensorboardService.BatchCreateTensorboardTimeSeries]. message BatchCreateTensorboardTimeSeriesResponse { // The created TensorboardTimeSeries. repeated TensorboardTimeSeries tensorboard_time_series = 1; } -// Request message for [TensorboardService.CreateTensorboardTimeSeries][google.cloud.aiplatform.v1beta1.TensorboardService.CreateTensorboardTimeSeries]. +// Request message for +// [TensorboardService.CreateTensorboardTimeSeries][google.cloud.aiplatform.v1beta1.TensorboardService.CreateTensorboardTimeSeries]. message CreateTensorboardTimeSeriesRequest { // Required. The resource name of the TensorboardRun to create the // TensorboardTimeSeries in. @@ -738,17 +845,20 @@ message CreateTensorboardTimeSeriesRequest { } ]; - // Optional. The user specified unique ID to use for the TensorboardTimeSeries, which - // will become the final component of the TensorboardTimeSeries's resource - // name. - // This value should match "[a-z0-9][a-z0-9-]{0, 127}" - string tensorboard_time_series_id = 3 [(google.api.field_behavior) = OPTIONAL]; + // Optional. The user specified unique ID to use for the + // TensorboardTimeSeries, which becomes the final component of the + // TensorboardTimeSeries's resource name. This value should match + // "[a-z0-9][a-z0-9-]{0, 127}" + string tensorboard_time_series_id = 3 + [(google.api.field_behavior) = OPTIONAL]; // Required. The TensorboardTimeSeries to create. - TensorboardTimeSeries tensorboard_time_series = 2 [(google.api.field_behavior) = REQUIRED]; + TensorboardTimeSeries tensorboard_time_series = 2 + [(google.api.field_behavior) = REQUIRED]; } -// Request message for [TensorboardService.GetTensorboardTimeSeries][google.cloud.aiplatform.v1beta1.TensorboardService.GetTensorboardTimeSeries]. +// Request message for +// [TensorboardService.GetTensorboardTimeSeries][google.cloud.aiplatform.v1beta1.TensorboardService.GetTensorboardTimeSeries]. message GetTensorboardTimeSeriesRequest { // Required. The name of the TensorboardTimeSeries resource. // Format: @@ -761,11 +871,12 @@ message GetTensorboardTimeSeriesRequest { ]; } -// Request message for [TensorboardService.ListTensorboardTimeSeries][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries]. +// Request message for +// [TensorboardService.ListTensorboardTimeSeries][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries]. message ListTensorboardTimeSeriesRequest { - // Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. - // Format: - // 'projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}' + // Required. The resource name of the TensorboardRun to list + // TensorboardTimeSeries. Format: + // `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -778,17 +889,17 @@ message ListTensorboardTimeSeriesRequest { // The maximum number of TensorboardTimeSeries to return. The service may // return fewer than this value. If unspecified, at most 50 - // TensorboardTimeSeries will be returned. The maximum value is 1000; values - // above 1000 will be coerced to 1000. + // TensorboardTimeSeries are returned. The maximum value is 1000; values + // above 1000 are coerced to 1000. int32 page_size = 3; // A page token, received from a previous - // [TensorboardService.ListTensorboardTimeSeries][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries] call. - // Provide this to retrieve the subsequent page. + // [TensorboardService.ListTensorboardTimeSeries][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries] + // call. Provide this to retrieve the subsequent page. // // When paginating, all other parameters provided to - // [TensorboardService.ListTensorboardTimeSeries][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries] must - // match the call that provided the page token. + // [TensorboardService.ListTensorboardTimeSeries][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries] + // must match the call that provided the page token. string page_token = 4; // Field to use to sort the list. @@ -798,35 +909,41 @@ message ListTensorboardTimeSeriesRequest { google.protobuf.FieldMask read_mask = 6; } -// Response message for [TensorboardService.ListTensorboardTimeSeries][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries]. +// Response message for +// [TensorboardService.ListTensorboardTimeSeries][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries]. message ListTensorboardTimeSeriesResponse { // The TensorboardTimeSeries mathching the request. repeated TensorboardTimeSeries tensorboard_time_series = 1; // A token, which can be sent as - // [ListTensorboardTimeSeriesRequest.page_token][google.cloud.aiplatform.v1beta1.ListTensorboardTimeSeriesRequest.page_token] to retrieve the next page. - // If this field is omitted, there are no subsequent pages. + // [ListTensorboardTimeSeriesRequest.page_token][google.cloud.aiplatform.v1beta1.ListTensorboardTimeSeriesRequest.page_token] + // to retrieve the next page. If this field is omitted, there are no + // subsequent pages. string next_page_token = 2; } -// Request message for [TensorboardService.UpdateTensorboardTimeSeries][google.cloud.aiplatform.v1beta1.TensorboardService.UpdateTensorboardTimeSeries]. +// Request message for +// [TensorboardService.UpdateTensorboardTimeSeries][google.cloud.aiplatform.v1beta1.TensorboardService.UpdateTensorboardTimeSeries]. message UpdateTensorboardTimeSeriesRequest { // Required. Field mask is used to specify the fields to be overwritten in the // TensorboardTimeSeries resource by the update. // The fields specified in the update_mask are relative to the resource, not - // the full request. A field will be overwritten if it is in the mask. If the - // user does not provide a mask then all fields will be overwritten if new + // the full request. A field is overwritten if it's in the mask. If the + // user does not provide a mask then all fields are overwritten if new // values are specified. - google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.FieldMask update_mask = 1 + [(google.api.field_behavior) = REQUIRED]; // Required. The TensorboardTimeSeries' `name` field is used to identify the // TensorboardTimeSeries to be updated. // Format: // `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}` - TensorboardTimeSeries tensorboard_time_series = 2 [(google.api.field_behavior) = REQUIRED]; + TensorboardTimeSeries tensorboard_time_series = 2 + [(google.api.field_behavior) = REQUIRED]; } -// Request message for [TensorboardService.DeleteTensorboardTimeSeries][google.cloud.aiplatform.v1beta1.TensorboardService.DeleteTensorboardTimeSeries]. +// Request message for +// [TensorboardService.DeleteTensorboardTimeSeries][google.cloud.aiplatform.v1beta1.TensorboardService.DeleteTensorboardTimeSeries]. message DeleteTensorboardTimeSeriesRequest { // Required. The name of the TensorboardTimeSeries to be deleted. // Format: @@ -842,11 +959,12 @@ message DeleteTensorboardTimeSeriesRequest { // Request message for // [TensorboardService.BatchReadTensorboardTimeSeriesData][google.cloud.aiplatform.v1beta1.TensorboardService.BatchReadTensorboardTimeSeriesData]. message BatchReadTensorboardTimeSeriesDataRequest { - // Required. The resource name of the Tensorboard containing TensorboardTimeSeries to - // read data from. Format: + // Required. The resource name of the Tensorboard containing + // TensorboardTimeSeries to read data from. Format: // `projects/{project}/locations/{location}/tensorboards/{tensorboard}`. - // The TensorboardTimeSeries referenced by [time_series][google.cloud.aiplatform.v1beta1.BatchReadTensorboardTimeSeriesDataRequest.time_series] must be sub - // resources of this Tensorboard. + // The TensorboardTimeSeries referenced by + // [time_series][google.cloud.aiplatform.v1beta1.BatchReadTensorboardTimeSeriesDataRequest.time_series] + // must be sub resources of this Tensorboard. string tensorboard = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -854,7 +972,8 @@ message BatchReadTensorboardTimeSeriesDataRequest { } ]; - // Required. The resource names of the TensorboardTimeSeries to read data from. Format: + // Required. The resource names of the TensorboardTimeSeries to read data + // from. Format: // `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}` repeated string time_series = 2 [ (google.api.field_behavior) = REQUIRED, @@ -871,7 +990,8 @@ message BatchReadTensorboardTimeSeriesDataResponse { repeated TimeSeriesData time_series_data = 1; } -// Request message for [TensorboardService.ReadTensorboardTimeSeriesData][google.cloud.aiplatform.v1beta1.TensorboardService.ReadTensorboardTimeSeriesData]. +// Request message for +// [TensorboardService.ReadTensorboardTimeSeriesData][google.cloud.aiplatform.v1beta1.TensorboardService.ReadTensorboardTimeSeriesData]. message ReadTensorboardTimeSeriesDataRequest { // Required. The resource name of the TensorboardTimeSeries to read data from. // Format: @@ -893,13 +1013,15 @@ message ReadTensorboardTimeSeriesDataRequest { string filter = 3; } -// Response message for [TensorboardService.ReadTensorboardTimeSeriesData][google.cloud.aiplatform.v1beta1.TensorboardService.ReadTensorboardTimeSeriesData]. +// Response message for +// [TensorboardService.ReadTensorboardTimeSeriesData][google.cloud.aiplatform.v1beta1.TensorboardService.ReadTensorboardTimeSeriesData]. message ReadTensorboardTimeSeriesDataResponse { // The returned time series data. TimeSeriesData time_series_data = 1; } -// Request message for [TensorboardService.WriteTensorboardExperimentData][google.cloud.aiplatform.v1beta1.TensorboardService.WriteTensorboardExperimentData]. +// Request message for +// [TensorboardService.WriteTensorboardExperimentData][google.cloud.aiplatform.v1beta1.TensorboardService.WriteTensorboardExperimentData]. message WriteTensorboardExperimentDataRequest { // Required. The resource name of the TensorboardExperiment to write data to. // Format: @@ -912,15 +1034,16 @@ message WriteTensorboardExperimentDataRequest { ]; // Required. Requests containing per-run TensorboardTimeSeries data to write. - repeated WriteTensorboardRunDataRequest write_run_data_requests = 2 [(google.api.field_behavior) = REQUIRED]; + repeated WriteTensorboardRunDataRequest write_run_data_requests = 2 + [(google.api.field_behavior) = REQUIRED]; } -// Response message for [TensorboardService.WriteTensorboardExperimentData][google.cloud.aiplatform.v1beta1.TensorboardService.WriteTensorboardExperimentData]. -message WriteTensorboardExperimentDataResponse { - -} +// Response message for +// [TensorboardService.WriteTensorboardExperimentData][google.cloud.aiplatform.v1beta1.TensorboardService.WriteTensorboardExperimentData]. +message WriteTensorboardExperimentDataResponse {} -// Request message for [TensorboardService.WriteTensorboardRunData][google.cloud.aiplatform.v1beta1.TensorboardService.WriteTensorboardRunData]. +// Request message for +// [TensorboardService.WriteTensorboardRunData][google.cloud.aiplatform.v1beta1.TensorboardService.WriteTensorboardRunData]. message WriteTensorboardRunDataRequest { // Required. The resource name of the TensorboardRun to write data to. // Format: @@ -937,18 +1060,19 @@ message WriteTensorboardRunDataRequest { // Repeated writes to the same step will overwrite the existing value for that // step. // The upper limit of data points per write request is 5000. - repeated TimeSeriesData time_series_data = 2 [(google.api.field_behavior) = REQUIRED]; + repeated TimeSeriesData time_series_data = 2 + [(google.api.field_behavior) = REQUIRED]; } -// Response message for [TensorboardService.WriteTensorboardRunData][google.cloud.aiplatform.v1beta1.TensorboardService.WriteTensorboardRunData]. -message WriteTensorboardRunDataResponse { - -} +// Response message for +// [TensorboardService.WriteTensorboardRunData][google.cloud.aiplatform.v1beta1.TensorboardService.WriteTensorboardRunData]. +message WriteTensorboardRunDataResponse {} -// Request message for [TensorboardService.ExportTensorboardTimeSeriesData][google.cloud.aiplatform.v1beta1.TensorboardService.ExportTensorboardTimeSeriesData]. +// Request message for +// [TensorboardService.ExportTensorboardTimeSeriesData][google.cloud.aiplatform.v1beta1.TensorboardService.ExportTensorboardTimeSeriesData]. message ExportTensorboardTimeSeriesDataRequest { - // Required. The resource name of the TensorboardTimeSeries to export data from. - // Format: + // Required. The resource name of the TensorboardTimeSeries to export data + // from. Format: // `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}` string tensorboard_time_series = 1 [ (google.api.field_behavior) = REQUIRED, @@ -961,8 +1085,8 @@ message ExportTensorboardTimeSeriesDataRequest { string filter = 2; // The maximum number of data points to return per page. - // The default page_size will be 1000. Values must be between 1 and 10000. - // Values above 10000 will be coerced to 10000. + // The default page_size is 1000. Values must be between 1 and 10000. + // Values above 10000 are coerced to 10000. int32 page_size = 3; // A page token, received from a previous @@ -975,12 +1099,13 @@ message ExportTensorboardTimeSeriesDataRequest { string page_token = 4; // Field to use to sort the TensorboardTimeSeries' data. - // By default, TensorboardTimeSeries' data will be returned in a pseudo random + // By default, TensorboardTimeSeries' data is returned in a pseudo random // order. string order_by = 5; } -// Response message for [TensorboardService.ExportTensorboardTimeSeriesData][google.cloud.aiplatform.v1beta1.TensorboardService.ExportTensorboardTimeSeriesData]. +// Response message for +// [TensorboardService.ExportTensorboardTimeSeriesData][google.cloud.aiplatform.v1beta1.TensorboardService.ExportTensorboardTimeSeriesData]. message ExportTensorboardTimeSeriesDataResponse { // The returned time series data points. repeated TimeSeriesDataPoint time_series_data_points = 1; diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/tensorboard_time_series.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/tensorboard_time_series.proto index 6e202a6ef92..22d01783d92 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/tensorboard_time_series.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/tensorboard_time_series.proto @@ -37,16 +37,19 @@ message TensorboardTimeSeries { // Describes metadata for a TensorboardTimeSeries. message Metadata { - // Output only. Max step index of all data points within a TensorboardTimeSeries. + // Output only. Max step index of all data points within a + // TensorboardTimeSeries. int64 max_step = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Max wall clock timestamp of all data points within a // TensorboardTimeSeries. - google.protobuf.Timestamp max_wall_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp max_wall_time = 2 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. The largest blob sequence length (number of blobs) of all data points in - // this time series, if its ValueType is BLOB_SEQUENCE. - int64 max_blob_sequence_length = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. The largest blob sequence length (number of blobs) of all + // data points in this time series, if its ValueType is BLOB_SEQUENCE. + int64 max_blob_sequence_length = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // An enum representing the value type of a TensorboardTimeSeries. @@ -85,22 +88,25 @@ message TensorboardTimeSeries { ]; // Output only. Timestamp when this TensorboardTimeSeries was created. - google.protobuf.Timestamp create_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Timestamp when this TensorboardTimeSeries was last updated. - google.protobuf.Timestamp update_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 6 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Used to perform a consistent read-modify-write updates. If not set, a blind // "overwrite" update happens. string etag = 7; - // Immutable. Name of the plugin this time series pertain to. Such as Scalar, Tensor, - // Blob + // Immutable. Name of the plugin this time series pertain to. Such as Scalar, + // Tensor, Blob string plugin_name = 8 [(google.api.field_behavior) = IMMUTABLE]; // Data of the current plugin, with the size limited to 65KB. bytes plugin_data = 9; - // Output only. Scalar, Tensor, or Blob metadata for this TensorboardTimeSeries. + // Output only. Scalar, Tensor, or Blob metadata for this + // TensorboardTimeSeries. Metadata metadata = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/training_pipeline.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/training_pipeline.proto index 138fbc3c8a4..b5c09f0ce3b 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/training_pipeline.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/training_pipeline.proto @@ -37,8 +37,8 @@ option ruby_package = "Google::Cloud::AIPlatform::V1beta1"; // The TrainingPipeline orchestrates tasks associated with training a Model. It // always executes the training task, and optionally may also // export data from Vertex AI's Dataset which becomes the training input, -// [upload][google.cloud.aiplatform.v1beta1.ModelService.UploadModel] the Model to Vertex AI, and evaluate the -// Model. +// [upload][google.cloud.aiplatform.v1beta1.ModelService.UploadModel] the Model +// to Vertex AI, and evaluate the Model. message TrainingPipeline { option (google.api.resource) = { type: "aiplatform.googleapis.com/TrainingPipeline" @@ -52,17 +52,20 @@ message TrainingPipeline { string display_name = 2 [(google.api.field_behavior) = REQUIRED]; // Specifies Vertex AI owned input data that may be used for training the - // Model. The TrainingPipeline's [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition] should make - // clear whether this config is used and if there are any special requirements - // on how it should be filled. If nothing about this config is mentioned in - // the [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition], then it should be assumed that the - // TrainingPipeline does not depend on this configuration. + // Model. The TrainingPipeline's + // [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition] + // should make clear whether this config is used and if there are any special + // requirements on how it should be filled. If nothing about this config is + // mentioned in the + // [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition], + // then it should be assumed that the TrainingPipeline does not depend on this + // configuration. InputDataConfig input_data_config = 3; - // Required. A Google Cloud Storage path to the YAML file that defines the training task - // which is responsible for producing the model artifact, and may also include - // additional auxiliary work. - // The definition files that can be used here are found in + // Required. A Google Cloud Storage path to the YAML file that defines the + // training task which is responsible for producing the model artifact, and + // may also include additional auxiliary work. The definition files that can + // be used here are found in // gs://google-cloud-aiplatform/schema/trainingjob/definition/. // Note: The URI given on output will be immutable and probably different, // including the URI scheme, than the one given on input. The output URI will @@ -70,28 +73,37 @@ message TrainingPipeline { string training_task_definition = 4 [(google.api.field_behavior) = REQUIRED]; // Required. The training task's parameter(s), as specified in the - // [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition]'s `inputs`. - google.protobuf.Value training_task_inputs = 5 [(google.api.field_behavior) = REQUIRED]; + // [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition]'s + // `inputs`. + google.protobuf.Value training_task_inputs = 5 + [(google.api.field_behavior) = REQUIRED]; - // Output only. The metadata information as specified in the [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition]'s + // Output only. The metadata information as specified in the + // [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition]'s // `metadata`. This metadata is an auxiliary runtime and final information // about the training task. While the pipeline is running this information is // populated only at a best effort basis. Only present if the - // pipeline's [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition] contains `metadata` object. - google.protobuf.Value training_task_metadata = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Describes the Model that may be uploaded (via [ModelService.UploadModel][google.cloud.aiplatform.v1beta1.ModelService.UploadModel]) + // pipeline's + // [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition] + // contains `metadata` object. + google.protobuf.Value training_task_metadata = 6 + [(google.api.field_behavior) = OUTPUT_ONLY]; + + // Describes the Model that may be uploaded (via + // [ModelService.UploadModel][google.cloud.aiplatform.v1beta1.ModelService.UploadModel]) // by this TrainingPipeline. The TrainingPipeline's - // [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition] should make clear whether this Model - // description should be populated, and if there are any special requirements - // regarding how it should be filled. If nothing is mentioned in the - // [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition], then it should be assumed that this field - // should not be filled and the training task either uploads the Model without - // a need of this information, or that training task does not support - // uploading a Model as part of the pipeline. - // When the Pipeline's state becomes `PIPELINE_STATE_SUCCEEDED` and + // [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition] + // should make clear whether this Model description should be populated, and + // if there are any special requirements regarding how it should be filled. If + // nothing is mentioned in the + // [training_task_definition][google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition], + // then it should be assumed that this field should not be filled and the + // training task either uploads the Model without a need of this information, + // or that training task does not support uploading a Model as part of the + // pipeline. When the Pipeline's state becomes `PIPELINE_STATE_SUCCEEDED` and // the trained Model had been uploaded into Vertex AI, then the - // model_to_upload's resource [name][google.cloud.aiplatform.v1beta1.Model.name] is populated. The Model + // model_to_upload's resource + // [name][google.cloud.aiplatform.v1beta1.Model.name] is populated. The Model // is always uploaded into the Project and Location in which this pipeline // is. Model model_to_upload = 7; @@ -103,31 +115,36 @@ message TrainingPipeline { // `[a-z0-9_-]`. The first character cannot be a number or hyphen. string model_id = 22 [(google.api.field_behavior) = OPTIONAL]; - // Optional. When specify this field, the `model_to_upload` will not be uploaded as a - // new model, instead, it will become a new version of this `parent_model`. + // Optional. When specify this field, the `model_to_upload` will not be + // uploaded as a new model, instead, it will become a new version of this + // `parent_model`. string parent_model = 21 [(google.api.field_behavior) = OPTIONAL]; // Output only. The detailed state of the pipeline. PipelineState state = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. Only populated when the pipeline's state is `PIPELINE_STATE_FAILED` or - // `PIPELINE_STATE_CANCELLED`. + // Output only. Only populated when the pipeline's state is + // `PIPELINE_STATE_FAILED` or `PIPELINE_STATE_CANCELLED`. google.rpc.Status error = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Time when the TrainingPipeline was created. - google.protobuf.Timestamp create_time = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 11 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Time when the TrainingPipeline for the first time entered the // `PIPELINE_STATE_RUNNING` state. - google.protobuf.Timestamp start_time = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp start_time = 12 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. Time when the TrainingPipeline entered any of the following states: - // `PIPELINE_STATE_SUCCEEDED`, `PIPELINE_STATE_FAILED`, + // Output only. Time when the TrainingPipeline entered any of the following + // states: `PIPELINE_STATE_SUCCEEDED`, `PIPELINE_STATE_FAILED`, // `PIPELINE_STATE_CANCELLED`. - google.protobuf.Timestamp end_time = 13 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp end_time = 13 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Time when the TrainingPipeline was most recently updated. - google.protobuf.Timestamp update_time = 14 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 14 + [(google.api.field_behavior) = OUTPUT_ONLY]; // The labels with user-defined metadata to organize TrainingPipelines. // @@ -142,7 +159,8 @@ message TrainingPipeline { // TrainingPipeline will be secured by this key. // // Note: Model trained by this TrainingPipeline is also secured by this key if - // [model_to_upload][google.cloud.aiplatform.v1beta1.TrainingPipeline.encryption_spec] is not set separately. + // [model_to_upload][google.cloud.aiplatform.v1beta1.TrainingPipeline.encryption_spec] + // is not set separately. EncryptionSpec encryption_spec = 18; } @@ -151,7 +169,9 @@ message TrainingPipeline { message InputDataConfig { // The instructions how the input data should be split between the // training, validation and test sets. - // If no split type is provided, the [fraction_split][google.cloud.aiplatform.v1beta1.InputDataConfig.fraction_split] is used by default. + // If no split type is provided, the + // [fraction_split][google.cloud.aiplatform.v1beta1.InputDataConfig.fraction_split] + // is used by default. oneof split { // Split based on fractions defining the size of each set. FractionSplit fraction_split = 2; @@ -235,9 +255,9 @@ message InputDataConfig { BigQueryDestination bigquery_destination = 10; } - // Required. The ID of the Dataset in the same Project and Location which data will be - // used to train the Model. The Dataset must use schema compatible with - // Model being trained, and what is compatible should be described in the + // Required. The ID of the Dataset in the same Project and Location which data + // will be used to train the Model. The Dataset must use schema compatible + // with Model being trained, and what is compatible should be described in the // used TrainingPipeline's [training_task_definition] // [google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition]. // For tabular Datasets, all their data is exported to training, to pick @@ -251,9 +271,9 @@ message InputDataConfig { // are used in respectively training, validation or test role, depending on // the role of the DataItem they are on (for the auto-assigned that role is // decided by Vertex AI). A filter with same syntax as the one used in - // [ListAnnotations][google.cloud.aiplatform.v1beta1.DatasetService.ListAnnotations] may be used, but note - // here it filters across all Annotations of the Dataset, and not just within - // a single DataItem. + // [ListAnnotations][google.cloud.aiplatform.v1beta1.DatasetService.ListAnnotations] + // may be used, but note here it filters across all Annotations of the + // Dataset, and not just within a single DataItem. string annotations_filter = 6; // Applicable only to custom training with Datasets that have DataItems and @@ -265,31 +285,45 @@ message InputDataConfig { // The schema files that can be used here are found in // gs://google-cloud-aiplatform/schema/dataset/annotation/ , note that the // chosen schema must be consistent with - // [metadata][google.cloud.aiplatform.v1beta1.Dataset.metadata_schema_uri] of the Dataset specified by + // [metadata][google.cloud.aiplatform.v1beta1.Dataset.metadata_schema_uri] of + // the Dataset specified by // [dataset_id][google.cloud.aiplatform.v1beta1.InputDataConfig.dataset_id]. // // Only Annotations that both match this schema and belong to DataItems not // ignored by the split method are used in respectively training, validation // or test role, depending on the role of the DataItem they are on. // - // When used in conjunction with [annotations_filter][google.cloud.aiplatform.v1beta1.InputDataConfig.annotations_filter], the Annotations used - // for training are filtered by both [annotations_filter][google.cloud.aiplatform.v1beta1.InputDataConfig.annotations_filter] and + // When used in conjunction with + // [annotations_filter][google.cloud.aiplatform.v1beta1.InputDataConfig.annotations_filter], + // the Annotations used for training are filtered by both + // [annotations_filter][google.cloud.aiplatform.v1beta1.InputDataConfig.annotations_filter] + // and // [annotation_schema_uri][google.cloud.aiplatform.v1beta1.InputDataConfig.annotation_schema_uri]. string annotation_schema_uri = 9; // Only applicable to Datasets that have SavedQueries. // // The ID of a SavedQuery (annotation set) under the Dataset specified by - // [dataset_id][google.cloud.aiplatform.v1beta1.InputDataConfig.dataset_id] used for filtering Annotations for training. + // [dataset_id][google.cloud.aiplatform.v1beta1.InputDataConfig.dataset_id] + // used for filtering Annotations for training. // // Only Annotations that are associated with this SavedQuery are used in // respectively training. When used in conjunction with - // [annotations_filter][google.cloud.aiplatform.v1beta1.InputDataConfig.annotations_filter], the Annotations used for training are filtered by - // both [saved_query_id][google.cloud.aiplatform.v1beta1.InputDataConfig.saved_query_id] and [annotations_filter][google.cloud.aiplatform.v1beta1.InputDataConfig.annotations_filter]. + // [annotations_filter][google.cloud.aiplatform.v1beta1.InputDataConfig.annotations_filter], + // the Annotations used for training are filtered by both + // [saved_query_id][google.cloud.aiplatform.v1beta1.InputDataConfig.saved_query_id] + // and + // [annotations_filter][google.cloud.aiplatform.v1beta1.InputDataConfig.annotations_filter]. // - // Only one of [saved_query_id][google.cloud.aiplatform.v1beta1.InputDataConfig.saved_query_id] and [annotation_schema_uri][google.cloud.aiplatform.v1beta1.InputDataConfig.annotation_schema_uri] should be - // specified as both of them represent the same thing: problem type. + // Only one of + // [saved_query_id][google.cloud.aiplatform.v1beta1.InputDataConfig.saved_query_id] + // and + // [annotation_schema_uri][google.cloud.aiplatform.v1beta1.InputDataConfig.annotation_schema_uri] + // should be specified as both of them represent the same thing: problem type. string saved_query_id = 7; + + // Whether to persist the ML use assignment to data item system labels. + bool persist_ml_use_assignment = 11; } // Assigns the input data to training, validation, and test sets as per the @@ -320,26 +354,29 @@ message FractionSplit { message FilterSplit { // Required. A filter on DataItems of the Dataset. DataItems that match // this filter are used to train the Model. A filter with same syntax - // as the one used in [DatasetService.ListDataItems][google.cloud.aiplatform.v1beta1.DatasetService.ListDataItems] may be used. If a - // single DataItem is matched by more than one of the FilterSplit filters, - // then it is assigned to the first set that applies to it in the - // training, validation, test order. + // as the one used in + // [DatasetService.ListDataItems][google.cloud.aiplatform.v1beta1.DatasetService.ListDataItems] + // may be used. If a single DataItem is matched by more than one of the + // FilterSplit filters, then it is assigned to the first set that applies to + // it in the training, validation, test order. string training_filter = 1 [(google.api.field_behavior) = REQUIRED]; // Required. A filter on DataItems of the Dataset. DataItems that match // this filter are used to validate the Model. A filter with same syntax - // as the one used in [DatasetService.ListDataItems][google.cloud.aiplatform.v1beta1.DatasetService.ListDataItems] may be used. If a - // single DataItem is matched by more than one of the FilterSplit filters, - // then it is assigned to the first set that applies to it in the - // training, validation, test order. + // as the one used in + // [DatasetService.ListDataItems][google.cloud.aiplatform.v1beta1.DatasetService.ListDataItems] + // may be used. If a single DataItem is matched by more than one of the + // FilterSplit filters, then it is assigned to the first set that applies to + // it in the training, validation, test order. string validation_filter = 2 [(google.api.field_behavior) = REQUIRED]; // Required. A filter on DataItems of the Dataset. DataItems that match // this filter are used to test the Model. A filter with same syntax - // as the one used in [DatasetService.ListDataItems][google.cloud.aiplatform.v1beta1.DatasetService.ListDataItems] may be used. If a - // single DataItem is matched by more than one of the FilterSplit filters, - // then it is assigned to the first set that applies to it in the - // training, validation, test order. + // as the one used in + // [DatasetService.ListDataItems][google.cloud.aiplatform.v1beta1.DatasetService.ListDataItems] + // may be used. If a single DataItem is matched by more than one of the + // FilterSplit filters, then it is assigned to the first set that applies to + // it in the training, validation, test order. string test_filter = 3 [(google.api.field_behavior) = REQUIRED]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/unmanaged_container_model.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/unmanaged_container_model.proto index 7b0d6bdcdfa..6e176608a89 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/unmanaged_container_model.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/unmanaged_container_model.proto @@ -37,7 +37,8 @@ message UnmanagedContainerModel { // Contains the schemata used in Model's predictions and explanations PredictSchemata predict_schemata = 2; - // Input only. The specification of the container that is to be used when deploying - // this Model. - ModelContainerSpec container_spec = 3 [(google.api.field_behavior) = INPUT_ONLY]; + // Input only. The specification of the container that is to be used when + // deploying this Model. + ModelContainerSpec container_spec = 3 + [(google.api.field_behavior) = INPUT_ONLY]; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/user_action_reference.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/user_action_reference.proto index 3d4633b5952..4ecf45989c9 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/user_action_reference.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/user_action_reference.proto @@ -31,13 +31,13 @@ message UserActionReference { // For API calls that return a long running operation. // Resource name of the long running operation. // Format: - // 'projects/{project}/locations/{location}/operations/{operation}' + // `projects/{project}/locations/{location}/operations/{operation}` string operation = 1; // For API calls that start a LabelingJob. // Resource name of the LabelingJob. // Format: - // 'projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}' + // `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` string data_labeling_job = 2; } diff --git a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/vizier_service.proto b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/vizier_service.proto index 88aec042e85..2967bfafa82 100644 --- a/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/vizier_service.proto +++ b/packages/google-cloud-aiplatform/protos/google/cloud/aiplatform/v1beta1/vizier_service.proto @@ -41,7 +41,8 @@ option ruby_package = "Google::Cloud::AIPlatform::V1beta1"; // learning architectures. service VizierService { option (google.api.default_host) = "aiplatform.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/cloud-platform"; // Creates a Study. A resource name will be generated after creation of the // Study. @@ -92,7 +93,8 @@ service VizierService { // operation associated with the generation of Trial suggestions. // When this long-running operation succeeds, it will contain // a [SuggestTrialsResponse][google.cloud.ml.v1.SuggestTrialsResponse]. - rpc SuggestTrials(SuggestTrialsRequest) returns (google.longrunning.Operation) { + rpc SuggestTrials(SuggestTrialsRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta1/{parent=projects/*/locations/*/studies/*}/trials:suggest" body: "*" @@ -157,7 +159,8 @@ service VizierService { // long-running operation. When the operation is successful, // it will contain a // [CheckTrialEarlyStoppingStateResponse][google.cloud.ml.v1.CheckTrialEarlyStoppingStateResponse]. - rpc CheckTrialEarlyStoppingState(CheckTrialEarlyStoppingStateRequest) returns (google.longrunning.Operation) { + rpc CheckTrialEarlyStoppingState(CheckTrialEarlyStoppingStateRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta1/{trial_name=projects/*/locations/*/studies/*/trials/*}:checkTrialEarlyStoppingState" body: "*" @@ -180,7 +183,8 @@ service VizierService { // optimal Trials for single-objective Study. The definition of // pareto-optimal can be checked in wiki page. // https://en.wikipedia.org/wiki/Pareto_efficiency - rpc ListOptimalTrials(ListOptimalTrialsRequest) returns (ListOptimalTrialsResponse) { + rpc ListOptimalTrials(ListOptimalTrialsRequest) + returns (ListOptimalTrialsResponse) { option (google.api.http) = { post: "/v1beta1/{parent=projects/*/locations/*/studies/*}/trials:listOptimalTrials" body: "*" @@ -189,7 +193,8 @@ service VizierService { } } -// Request message for [VizierService.GetStudy][google.cloud.aiplatform.v1beta1.VizierService.GetStudy]. +// Request message for +// [VizierService.GetStudy][google.cloud.aiplatform.v1beta1.VizierService.GetStudy]. message GetStudyRequest { // Required. The name of the Study resource. // Format: `projects/{project}/locations/{location}/studies/{study}` @@ -201,7 +206,8 @@ message GetStudyRequest { ]; } -// Request message for [VizierService.CreateStudy][google.cloud.aiplatform.v1beta1.VizierService.CreateStudy]. +// Request message for +// [VizierService.CreateStudy][google.cloud.aiplatform.v1beta1.VizierService.CreateStudy]. message CreateStudyRequest { // Required. The resource name of the Location to create the CustomJob in. // Format: `projects/{project}/locations/{location}` @@ -216,7 +222,8 @@ message CreateStudyRequest { Study study = 2 [(google.api.field_behavior) = REQUIRED]; } -// Request message for [VizierService.ListStudies][google.cloud.aiplatform.v1beta1.VizierService.ListStudies]. +// Request message for +// [VizierService.ListStudies][google.cloud.aiplatform.v1beta1.VizierService.ListStudies]. message ListStudiesRequest { // Required. The resource name of the Location to list the Study from. // Format: `projects/{project}/locations/{location}` @@ -236,7 +243,8 @@ message ListStudiesRequest { int32 page_size = 3 [(google.api.field_behavior) = OPTIONAL]; } -// Response message for [VizierService.ListStudies][google.cloud.aiplatform.v1beta1.VizierService.ListStudies]. +// Response message for +// [VizierService.ListStudies][google.cloud.aiplatform.v1beta1.VizierService.ListStudies]. message ListStudiesResponse { // The studies associated with the project. repeated Study studies = 1; @@ -247,7 +255,8 @@ message ListStudiesResponse { string next_page_token = 2; } -// Request message for [VizierService.DeleteStudy][google.cloud.aiplatform.v1beta1.VizierService.DeleteStudy]. +// Request message for +// [VizierService.DeleteStudy][google.cloud.aiplatform.v1beta1.VizierService.DeleteStudy]. message DeleteStudyRequest { // Required. The name of the Study resource to be deleted. // Format: `projects/{project}/locations/{location}/studies/{study}` @@ -259,7 +268,8 @@ message DeleteStudyRequest { ]; } -// Request message for [VizierService.LookupStudy][google.cloud.aiplatform.v1beta1.VizierService.LookupStudy]. +// Request message for +// [VizierService.LookupStudy][google.cloud.aiplatform.v1beta1.VizierService.LookupStudy]. message LookupStudyRequest { // Required. The resource name of the Location to get the Study from. // Format: `projects/{project}/locations/{location}` @@ -274,7 +284,8 @@ message LookupStudyRequest { string display_name = 2 [(google.api.field_behavior) = REQUIRED]; } -// Request message for [VizierService.SuggestTrials][google.cloud.aiplatform.v1beta1.VizierService.SuggestTrials]. +// Request message for +// [VizierService.SuggestTrials][google.cloud.aiplatform.v1beta1.VizierService.SuggestTrials]. message SuggestTrialsRequest { // Required. The project and location that the Study belongs to. // Format: `projects/{project}/locations/{location}/studies/{study}` @@ -296,7 +307,8 @@ message SuggestTrialsRequest { string client_id = 3 [(google.api.field_behavior) = REQUIRED]; } -// Response message for [VizierService.SuggestTrials][google.cloud.aiplatform.v1beta1.VizierService.SuggestTrials]. +// Response message for +// [VizierService.SuggestTrials][google.cloud.aiplatform.v1beta1.VizierService.SuggestTrials]. message SuggestTrialsResponse { // A list of Trials. repeated Trial trials = 1; @@ -324,7 +336,8 @@ message SuggestTrialsMetadata { string client_id = 2; } -// Request message for [VizierService.CreateTrial][google.cloud.aiplatform.v1beta1.VizierService.CreateTrial]. +// Request message for +// [VizierService.CreateTrial][google.cloud.aiplatform.v1beta1.VizierService.CreateTrial]. message CreateTrialRequest { // Required. The resource name of the Study to create the Trial in. // Format: `projects/{project}/locations/{location}/studies/{study}` @@ -339,7 +352,8 @@ message CreateTrialRequest { Trial trial = 2 [(google.api.field_behavior) = REQUIRED]; } -// Request message for [VizierService.GetTrial][google.cloud.aiplatform.v1beta1.VizierService.GetTrial]. +// Request message for +// [VizierService.GetTrial][google.cloud.aiplatform.v1beta1.VizierService.GetTrial]. message GetTrialRequest { // Required. The name of the Trial resource. // Format: @@ -352,7 +366,8 @@ message GetTrialRequest { ]; } -// Request message for [VizierService.ListTrials][google.cloud.aiplatform.v1beta1.VizierService.ListTrials]. +// Request message for +// [VizierService.ListTrials][google.cloud.aiplatform.v1beta1.VizierService.ListTrials]. message ListTrialsRequest { // Required. The resource name of the Study to list the Trial from. // Format: `projects/{project}/locations/{location}/studies/{study}` @@ -372,7 +387,8 @@ message ListTrialsRequest { int32 page_size = 3 [(google.api.field_behavior) = OPTIONAL]; } -// Response message for [VizierService.ListTrials][google.cloud.aiplatform.v1beta1.VizierService.ListTrials]. +// Response message for +// [VizierService.ListTrials][google.cloud.aiplatform.v1beta1.VizierService.ListTrials]. message ListTrialsResponse { // The Trials associated with the Study. repeated Trial trials = 1; @@ -383,7 +399,8 @@ message ListTrialsResponse { string next_page_token = 2; } -// Request message for [VizierService.AddTrialMeasurement][google.cloud.aiplatform.v1beta1.VizierService.AddTrialMeasurement]. +// Request message for +// [VizierService.AddTrialMeasurement][google.cloud.aiplatform.v1beta1.VizierService.AddTrialMeasurement]. message AddTrialMeasurementRequest { // Required. The name of the trial to add measurement. // Format: @@ -399,7 +416,8 @@ message AddTrialMeasurementRequest { Measurement measurement = 3 [(google.api.field_behavior) = REQUIRED]; } -// Request message for [VizierService.CompleteTrial][google.cloud.aiplatform.v1beta1.VizierService.CompleteTrial]. +// Request message for +// [VizierService.CompleteTrial][google.cloud.aiplatform.v1beta1.VizierService.CompleteTrial]. message CompleteTrialRequest { // Required. The Trial's name. // Format: @@ -425,7 +443,8 @@ message CompleteTrialRequest { string infeasible_reason = 4 [(google.api.field_behavior) = OPTIONAL]; } -// Request message for [VizierService.DeleteTrial][google.cloud.aiplatform.v1beta1.VizierService.DeleteTrial]. +// Request message for +// [VizierService.DeleteTrial][google.cloud.aiplatform.v1beta1.VizierService.DeleteTrial]. message DeleteTrialRequest { // Required. The Trial's name. // Format: @@ -438,7 +457,8 @@ message DeleteTrialRequest { ]; } -// Request message for [VizierService.CheckTrialEarlyStoppingState][google.cloud.aiplatform.v1beta1.VizierService.CheckTrialEarlyStoppingState]. +// Request message for +// [VizierService.CheckTrialEarlyStoppingState][google.cloud.aiplatform.v1beta1.VizierService.CheckTrialEarlyStoppingState]. message CheckTrialEarlyStoppingStateRequest { // Required. The Trial's name. // Format: @@ -451,7 +471,8 @@ message CheckTrialEarlyStoppingStateRequest { ]; } -// Response message for [VizierService.CheckTrialEarlyStoppingState][google.cloud.aiplatform.v1beta1.VizierService.CheckTrialEarlyStoppingState]. +// Response message for +// [VizierService.CheckTrialEarlyStoppingState][google.cloud.aiplatform.v1beta1.VizierService.CheckTrialEarlyStoppingState]. message CheckTrialEarlyStoppingStateResponse { // True if the Trial should stop. bool should_stop = 1; @@ -471,7 +492,8 @@ message CheckTrialEarlyStoppingStateMetatdata { string trial = 3; } -// Request message for [VizierService.StopTrial][google.cloud.aiplatform.v1beta1.VizierService.StopTrial]. +// Request message for +// [VizierService.StopTrial][google.cloud.aiplatform.v1beta1.VizierService.StopTrial]. message StopTrialRequest { // Required. The Trial's name. // Format: @@ -484,7 +506,8 @@ message StopTrialRequest { ]; } -// Request message for [VizierService.ListOptimalTrials][google.cloud.aiplatform.v1beta1.VizierService.ListOptimalTrials]. +// Request message for +// [VizierService.ListOptimalTrials][google.cloud.aiplatform.v1beta1.VizierService.ListOptimalTrials]. message ListOptimalTrialsRequest { // Required. The name of the Study that the optimal Trial belongs to. string parent = 1 [ @@ -495,7 +518,8 @@ message ListOptimalTrialsRequest { ]; } -// Response message for [VizierService.ListOptimalTrials][google.cloud.aiplatform.v1beta1.VizierService.ListOptimalTrials]. +// Response message for +// [VizierService.ListOptimalTrials][google.cloud.aiplatform.v1beta1.VizierService.ListOptimalTrials]. message ListOptimalTrialsResponse { // The pareto-optimal Trials for multiple objective Study or the // optimal trial for single objective Study. The definition of diff --git a/packages/google-cloud-aiplatform/protos/protos.d.ts b/packages/google-cloud-aiplatform/protos/protos.d.ts index 2889e368a18..6f816ce8cda 100644 --- a/packages/google-cloud-aiplatform/protos/protos.d.ts +++ b/packages/google-cloud-aiplatform/protos/protos.d.ts @@ -605,6 +605,9 @@ export namespace google { /** BatchPredictionJob inputConfig */ inputConfig?: (google.cloud.aiplatform.v1.BatchPredictionJob.IInputConfig|null); + /** BatchPredictionJob instanceConfig */ + instanceConfig?: (google.cloud.aiplatform.v1.BatchPredictionJob.IInstanceConfig|null); + /** BatchPredictionJob modelParameters */ modelParameters?: (google.protobuf.IValue|null); @@ -614,6 +617,9 @@ export namespace google { /** BatchPredictionJob dedicatedResources */ dedicatedResources?: (google.cloud.aiplatform.v1.IBatchDedicatedResources|null); + /** BatchPredictionJob serviceAccount */ + serviceAccount?: (string|null); + /** BatchPredictionJob manualBatchTuningParameters */ manualBatchTuningParameters?: (google.cloud.aiplatform.v1.IManualBatchTuningParameters|null); @@ -687,6 +693,9 @@ export namespace google { /** BatchPredictionJob inputConfig. */ public inputConfig?: (google.cloud.aiplatform.v1.BatchPredictionJob.IInputConfig|null); + /** BatchPredictionJob instanceConfig. */ + public instanceConfig?: (google.cloud.aiplatform.v1.BatchPredictionJob.IInstanceConfig|null); + /** BatchPredictionJob modelParameters. */ public modelParameters?: (google.protobuf.IValue|null); @@ -696,6 +705,9 @@ export namespace google { /** BatchPredictionJob dedicatedResources. */ public dedicatedResources?: (google.cloud.aiplatform.v1.IBatchDedicatedResources|null); + /** BatchPredictionJob serviceAccount. */ + public serviceAccount: string; + /** BatchPredictionJob manualBatchTuningParameters. */ public manualBatchTuningParameters?: (google.cloud.aiplatform.v1.IManualBatchTuningParameters|null); @@ -933,6 +945,121 @@ export namespace google { public static getTypeUrl(typeUrlPrefix?: string): string; } + /** Properties of an InstanceConfig. */ + interface IInstanceConfig { + + /** InstanceConfig instanceType */ + instanceType?: (string|null); + + /** InstanceConfig keyField */ + keyField?: (string|null); + + /** InstanceConfig includedFields */ + includedFields?: (string[]|null); + + /** InstanceConfig excludedFields */ + excludedFields?: (string[]|null); + } + + /** Represents an InstanceConfig. */ + class InstanceConfig implements IInstanceConfig { + + /** + * Constructs a new InstanceConfig. + * @param [properties] Properties to set + */ + constructor(properties?: google.cloud.aiplatform.v1.BatchPredictionJob.IInstanceConfig); + + /** InstanceConfig instanceType. */ + public instanceType: string; + + /** InstanceConfig keyField. */ + public keyField: string; + + /** InstanceConfig includedFields. */ + public includedFields: string[]; + + /** InstanceConfig excludedFields. */ + public excludedFields: string[]; + + /** + * Creates a new InstanceConfig instance using the specified properties. + * @param [properties] Properties to set + * @returns InstanceConfig instance + */ + public static create(properties?: google.cloud.aiplatform.v1.BatchPredictionJob.IInstanceConfig): google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig; + + /** + * Encodes the specified InstanceConfig message. Does not implicitly {@link google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.verify|verify} messages. + * @param message InstanceConfig message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encode(message: google.cloud.aiplatform.v1.BatchPredictionJob.IInstanceConfig, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Encodes the specified InstanceConfig message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.verify|verify} messages. + * @param message InstanceConfig message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encodeDelimited(message: google.cloud.aiplatform.v1.BatchPredictionJob.IInstanceConfig, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Decodes an InstanceConfig message from the specified reader or buffer. + * @param reader Reader or buffer to decode from + * @param [length] Message length if known beforehand + * @returns InstanceConfig + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig; + + /** + * Decodes an InstanceConfig message from the specified reader or buffer, length delimited. + * @param reader Reader or buffer to decode from + * @returns InstanceConfig + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig; + + /** + * Verifies an InstanceConfig message. + * @param message Plain object to verify + * @returns `null` if valid, otherwise the reason why it is not + */ + public static verify(message: { [k: string]: any }): (string|null); + + /** + * Creates an InstanceConfig message from a plain object. Also converts values to their respective internal types. + * @param object Plain object + * @returns InstanceConfig + */ + public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig; + + /** + * Creates a plain object from an InstanceConfig message. Also converts values to other types if specified. + * @param message InstanceConfig + * @param [options] Conversion options + * @returns Plain object + */ + public static toObject(message: google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig, options?: $protobuf.IConversionOptions): { [k: string]: any }; + + /** + * Converts this InstanceConfig to JSON. + * @returns JSON object + */ + public toJSON(): { [k: string]: any }; + + /** + * Gets the default type url for InstanceConfig + * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns The default type url + */ + public static getTypeUrl(typeUrlPrefix?: string): string; + } + /** Properties of an OutputConfig. */ interface IOutputConfig { @@ -6015,6 +6142,9 @@ export namespace google { /** Model modelSourceInfo */ modelSourceInfo?: (google.cloud.aiplatform.v1.IModelSourceInfo|null); + + /** Model metadataArtifact */ + metadataArtifact?: (string|null); } /** Represents a Model. */ @@ -6104,6 +6234,9 @@ export namespace google { /** Model modelSourceInfo. */ public modelSourceInfo?: (google.cloud.aiplatform.v1.IModelSourceInfo|null); + /** Model metadataArtifact. */ + public metadataArtifact: string; + /** * Creates a new Model instance using the specified properties. * @param [properties] Properties to set @@ -7305,6 +7438,9 @@ export namespace google { /** CustomJobSpec enableWebAccess */ enableWebAccess?: (boolean|null); + + /** CustomJobSpec enableDashboardAccess */ + enableDashboardAccess?: (boolean|null); } /** Represents a CustomJobSpec. */ @@ -7340,6 +7476,9 @@ export namespace google { /** CustomJobSpec enableWebAccess. */ public enableWebAccess: boolean; + /** CustomJobSpec enableDashboardAccess. */ + public enableDashboardAccess: boolean; + /** * Creates a new CustomJobSpec instance using the specified properties. * @param [properties] Properties to set @@ -8582,8 +8721,14 @@ export namespace google { /** Dataset labels */ labels?: ({ [k: string]: string }|null); + /** Dataset savedQueries */ + savedQueries?: (google.cloud.aiplatform.v1.ISavedQuery[]|null); + /** Dataset encryptionSpec */ encryptionSpec?: (google.cloud.aiplatform.v1.IEncryptionSpec|null); + + /** Dataset metadataArtifact */ + metadataArtifact?: (string|null); } /** Represents a Dataset. */ @@ -8622,9 +8767,15 @@ export namespace google { /** Dataset labels. */ public labels: { [k: string]: string }; + /** Dataset savedQueries. */ + public savedQueries: google.cloud.aiplatform.v1.ISavedQuery[]; + /** Dataset encryptionSpec. */ public encryptionSpec?: (google.cloud.aiplatform.v1.IEncryptionSpec|null); + /** Dataset metadataArtifact. */ + public metadataArtifact: string; + /** * Creates a new Dataset instance using the specified properties. * @param [properties] Properties to set @@ -8712,6 +8863,9 @@ export namespace google { /** ImportDataConfig dataItemLabels */ dataItemLabels?: ({ [k: string]: string }|null); + /** ImportDataConfig annotationLabels */ + annotationLabels?: ({ [k: string]: string }|null); + /** ImportDataConfig importSchemaUri */ importSchemaUri?: (string|null); } @@ -8731,6 +8885,9 @@ export namespace google { /** ImportDataConfig dataItemLabels. */ public dataItemLabels: { [k: string]: string }; + /** ImportDataConfig annotationLabels. */ + public annotationLabels: { [k: string]: string }; + /** ImportDataConfig importSchemaUri. */ public importSchemaUri: string; @@ -8921,6 +9078,157 @@ export namespace google { public static getTypeUrl(typeUrlPrefix?: string): string; } + /** Properties of a SavedQuery. */ + interface ISavedQuery { + + /** SavedQuery name */ + name?: (string|null); + + /** SavedQuery displayName */ + displayName?: (string|null); + + /** SavedQuery metadata */ + metadata?: (google.protobuf.IValue|null); + + /** SavedQuery createTime */ + createTime?: (google.protobuf.ITimestamp|null); + + /** SavedQuery updateTime */ + updateTime?: (google.protobuf.ITimestamp|null); + + /** SavedQuery annotationFilter */ + annotationFilter?: (string|null); + + /** SavedQuery problemType */ + problemType?: (string|null); + + /** SavedQuery annotationSpecCount */ + annotationSpecCount?: (number|null); + + /** SavedQuery etag */ + etag?: (string|null); + + /** SavedQuery supportAutomlTraining */ + supportAutomlTraining?: (boolean|null); + } + + /** Represents a SavedQuery. */ + class SavedQuery implements ISavedQuery { + + /** + * Constructs a new SavedQuery. + * @param [properties] Properties to set + */ + constructor(properties?: google.cloud.aiplatform.v1.ISavedQuery); + + /** SavedQuery name. */ + public name: string; + + /** SavedQuery displayName. */ + public displayName: string; + + /** SavedQuery metadata. */ + public metadata?: (google.protobuf.IValue|null); + + /** SavedQuery createTime. */ + public createTime?: (google.protobuf.ITimestamp|null); + + /** SavedQuery updateTime. */ + public updateTime?: (google.protobuf.ITimestamp|null); + + /** SavedQuery annotationFilter. */ + public annotationFilter: string; + + /** SavedQuery problemType. */ + public problemType: string; + + /** SavedQuery annotationSpecCount. */ + public annotationSpecCount: number; + + /** SavedQuery etag. */ + public etag: string; + + /** SavedQuery supportAutomlTraining. */ + public supportAutomlTraining: boolean; + + /** + * Creates a new SavedQuery instance using the specified properties. + * @param [properties] Properties to set + * @returns SavedQuery instance + */ + public static create(properties?: google.cloud.aiplatform.v1.ISavedQuery): google.cloud.aiplatform.v1.SavedQuery; + + /** + * Encodes the specified SavedQuery message. Does not implicitly {@link google.cloud.aiplatform.v1.SavedQuery.verify|verify} messages. + * @param message SavedQuery message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encode(message: google.cloud.aiplatform.v1.ISavedQuery, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Encodes the specified SavedQuery message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.SavedQuery.verify|verify} messages. + * @param message SavedQuery message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encodeDelimited(message: google.cloud.aiplatform.v1.ISavedQuery, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Decodes a SavedQuery message from the specified reader or buffer. + * @param reader Reader or buffer to decode from + * @param [length] Message length if known beforehand + * @returns SavedQuery + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.SavedQuery; + + /** + * Decodes a SavedQuery message from the specified reader or buffer, length delimited. + * @param reader Reader or buffer to decode from + * @returns SavedQuery + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.SavedQuery; + + /** + * Verifies a SavedQuery message. + * @param message Plain object to verify + * @returns `null` if valid, otherwise the reason why it is not + */ + public static verify(message: { [k: string]: any }): (string|null); + + /** + * Creates a SavedQuery message from a plain object. Also converts values to their respective internal types. + * @param object Plain object + * @returns SavedQuery + */ + public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.SavedQuery; + + /** + * Creates a plain object from a SavedQuery message. Also converts values to other types if specified. + * @param message SavedQuery + * @param [options] Conversion options + * @returns Plain object + */ + public static toObject(message: google.cloud.aiplatform.v1.SavedQuery, options?: $protobuf.IConversionOptions): { [k: string]: any }; + + /** + * Converts this SavedQuery to JSON. + * @returns JSON object + */ + public toJSON(): { [k: string]: any }; + + /** + * Gets the default type url for SavedQuery + * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns The default type url + */ + public static getTypeUrl(typeUrlPrefix?: string): string; + } + /** Represents a DatasetService */ class DatasetService extends $protobuf.rpc.Service { @@ -9053,6 +9361,20 @@ export namespace google { */ public listDataItems(request: google.cloud.aiplatform.v1.IListDataItemsRequest): Promise; + /** + * Calls SearchDataItems. + * @param request SearchDataItemsRequest message or plain object + * @param callback Node-style callback called with the error, if any, and SearchDataItemsResponse + */ + public searchDataItems(request: google.cloud.aiplatform.v1.ISearchDataItemsRequest, callback: google.cloud.aiplatform.v1.DatasetService.SearchDataItemsCallback): void; + + /** + * Calls SearchDataItems. + * @param request SearchDataItemsRequest message or plain object + * @returns Promise + */ + public searchDataItems(request: google.cloud.aiplatform.v1.ISearchDataItemsRequest): Promise; + /** * Calls ListSavedQueries. * @param request ListSavedQueriesRequest message or plain object @@ -9154,6 +9476,13 @@ export namespace google { */ type ListDataItemsCallback = (error: (Error|null), response?: google.cloud.aiplatform.v1.ListDataItemsResponse) => void; + /** + * Callback as used by {@link google.cloud.aiplatform.v1.DatasetService|searchDataItems}. + * @param error Error, if any + * @param [response] SearchDataItemsResponse + */ + type SearchDataItemsCallback = (error: (Error|null), response?: google.cloud.aiplatform.v1.SearchDataItemsResponse) => void; + /** * Callback as used by {@link google.cloud.aiplatform.v1.DatasetService|listSavedQueries}. * @param error Error, if any @@ -10733,6 +11062,496 @@ export namespace google { public static getTypeUrl(typeUrlPrefix?: string): string; } + /** Properties of a SearchDataItemsRequest. */ + interface ISearchDataItemsRequest { + + /** SearchDataItemsRequest orderByDataItem */ + orderByDataItem?: (string|null); + + /** SearchDataItemsRequest orderByAnnotation */ + orderByAnnotation?: (google.cloud.aiplatform.v1.SearchDataItemsRequest.IOrderByAnnotation|null); + + /** SearchDataItemsRequest dataset */ + dataset?: (string|null); + + /** SearchDataItemsRequest savedQuery */ + savedQuery?: (string|null); + + /** SearchDataItemsRequest dataLabelingJob */ + dataLabelingJob?: (string|null); + + /** SearchDataItemsRequest dataItemFilter */ + dataItemFilter?: (string|null); + + /** SearchDataItemsRequest annotationsFilter */ + annotationsFilter?: (string|null); + + /** SearchDataItemsRequest annotationFilters */ + annotationFilters?: (string[]|null); + + /** SearchDataItemsRequest fieldMask */ + fieldMask?: (google.protobuf.IFieldMask|null); + + /** SearchDataItemsRequest annotationsLimit */ + annotationsLimit?: (number|null); + + /** SearchDataItemsRequest pageSize */ + pageSize?: (number|null); + + /** SearchDataItemsRequest orderBy */ + orderBy?: (string|null); + + /** SearchDataItemsRequest pageToken */ + pageToken?: (string|null); + } + + /** Represents a SearchDataItemsRequest. */ + class SearchDataItemsRequest implements ISearchDataItemsRequest { + + /** + * Constructs a new SearchDataItemsRequest. + * @param [properties] Properties to set + */ + constructor(properties?: google.cloud.aiplatform.v1.ISearchDataItemsRequest); + + /** SearchDataItemsRequest orderByDataItem. */ + public orderByDataItem?: (string|null); + + /** SearchDataItemsRequest orderByAnnotation. */ + public orderByAnnotation?: (google.cloud.aiplatform.v1.SearchDataItemsRequest.IOrderByAnnotation|null); + + /** SearchDataItemsRequest dataset. */ + public dataset: string; + + /** SearchDataItemsRequest savedQuery. */ + public savedQuery: string; + + /** SearchDataItemsRequest dataLabelingJob. */ + public dataLabelingJob: string; + + /** SearchDataItemsRequest dataItemFilter. */ + public dataItemFilter: string; + + /** SearchDataItemsRequest annotationsFilter. */ + public annotationsFilter: string; + + /** SearchDataItemsRequest annotationFilters. */ + public annotationFilters: string[]; + + /** SearchDataItemsRequest fieldMask. */ + public fieldMask?: (google.protobuf.IFieldMask|null); + + /** SearchDataItemsRequest annotationsLimit. */ + public annotationsLimit: number; + + /** SearchDataItemsRequest pageSize. */ + public pageSize: number; + + /** SearchDataItemsRequest orderBy. */ + public orderBy: string; + + /** SearchDataItemsRequest pageToken. */ + public pageToken: string; + + /** SearchDataItemsRequest order. */ + public order?: ("orderByDataItem"|"orderByAnnotation"); + + /** + * Creates a new SearchDataItemsRequest instance using the specified properties. + * @param [properties] Properties to set + * @returns SearchDataItemsRequest instance + */ + public static create(properties?: google.cloud.aiplatform.v1.ISearchDataItemsRequest): google.cloud.aiplatform.v1.SearchDataItemsRequest; + + /** + * Encodes the specified SearchDataItemsRequest message. Does not implicitly {@link google.cloud.aiplatform.v1.SearchDataItemsRequest.verify|verify} messages. + * @param message SearchDataItemsRequest message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encode(message: google.cloud.aiplatform.v1.ISearchDataItemsRequest, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Encodes the specified SearchDataItemsRequest message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.SearchDataItemsRequest.verify|verify} messages. + * @param message SearchDataItemsRequest message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encodeDelimited(message: google.cloud.aiplatform.v1.ISearchDataItemsRequest, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Decodes a SearchDataItemsRequest message from the specified reader or buffer. + * @param reader Reader or buffer to decode from + * @param [length] Message length if known beforehand + * @returns SearchDataItemsRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.SearchDataItemsRequest; + + /** + * Decodes a SearchDataItemsRequest message from the specified reader or buffer, length delimited. + * @param reader Reader or buffer to decode from + * @returns SearchDataItemsRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.SearchDataItemsRequest; + + /** + * Verifies a SearchDataItemsRequest message. + * @param message Plain object to verify + * @returns `null` if valid, otherwise the reason why it is not + */ + public static verify(message: { [k: string]: any }): (string|null); + + /** + * Creates a SearchDataItemsRequest message from a plain object. Also converts values to their respective internal types. + * @param object Plain object + * @returns SearchDataItemsRequest + */ + public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.SearchDataItemsRequest; + + /** + * Creates a plain object from a SearchDataItemsRequest message. Also converts values to other types if specified. + * @param message SearchDataItemsRequest + * @param [options] Conversion options + * @returns Plain object + */ + public static toObject(message: google.cloud.aiplatform.v1.SearchDataItemsRequest, options?: $protobuf.IConversionOptions): { [k: string]: any }; + + /** + * Converts this SearchDataItemsRequest to JSON. + * @returns JSON object + */ + public toJSON(): { [k: string]: any }; + + /** + * Gets the default type url for SearchDataItemsRequest + * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns The default type url + */ + public static getTypeUrl(typeUrlPrefix?: string): string; + } + + namespace SearchDataItemsRequest { + + /** Properties of an OrderByAnnotation. */ + interface IOrderByAnnotation { + + /** OrderByAnnotation savedQuery */ + savedQuery?: (string|null); + + /** OrderByAnnotation orderBy */ + orderBy?: (string|null); + } + + /** Represents an OrderByAnnotation. */ + class OrderByAnnotation implements IOrderByAnnotation { + + /** + * Constructs a new OrderByAnnotation. + * @param [properties] Properties to set + */ + constructor(properties?: google.cloud.aiplatform.v1.SearchDataItemsRequest.IOrderByAnnotation); + + /** OrderByAnnotation savedQuery. */ + public savedQuery: string; + + /** OrderByAnnotation orderBy. */ + public orderBy: string; + + /** + * Creates a new OrderByAnnotation instance using the specified properties. + * @param [properties] Properties to set + * @returns OrderByAnnotation instance + */ + public static create(properties?: google.cloud.aiplatform.v1.SearchDataItemsRequest.IOrderByAnnotation): google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation; + + /** + * Encodes the specified OrderByAnnotation message. Does not implicitly {@link google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation.verify|verify} messages. + * @param message OrderByAnnotation message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encode(message: google.cloud.aiplatform.v1.SearchDataItemsRequest.IOrderByAnnotation, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Encodes the specified OrderByAnnotation message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation.verify|verify} messages. + * @param message OrderByAnnotation message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encodeDelimited(message: google.cloud.aiplatform.v1.SearchDataItemsRequest.IOrderByAnnotation, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Decodes an OrderByAnnotation message from the specified reader or buffer. + * @param reader Reader or buffer to decode from + * @param [length] Message length if known beforehand + * @returns OrderByAnnotation + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation; + + /** + * Decodes an OrderByAnnotation message from the specified reader or buffer, length delimited. + * @param reader Reader or buffer to decode from + * @returns OrderByAnnotation + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation; + + /** + * Verifies an OrderByAnnotation message. + * @param message Plain object to verify + * @returns `null` if valid, otherwise the reason why it is not + */ + public static verify(message: { [k: string]: any }): (string|null); + + /** + * Creates an OrderByAnnotation message from a plain object. Also converts values to their respective internal types. + * @param object Plain object + * @returns OrderByAnnotation + */ + public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation; + + /** + * Creates a plain object from an OrderByAnnotation message. Also converts values to other types if specified. + * @param message OrderByAnnotation + * @param [options] Conversion options + * @returns Plain object + */ + public static toObject(message: google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation, options?: $protobuf.IConversionOptions): { [k: string]: any }; + + /** + * Converts this OrderByAnnotation to JSON. + * @returns JSON object + */ + public toJSON(): { [k: string]: any }; + + /** + * Gets the default type url for OrderByAnnotation + * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns The default type url + */ + public static getTypeUrl(typeUrlPrefix?: string): string; + } + } + + /** Properties of a SearchDataItemsResponse. */ + interface ISearchDataItemsResponse { + + /** SearchDataItemsResponse dataItemViews */ + dataItemViews?: (google.cloud.aiplatform.v1.IDataItemView[]|null); + + /** SearchDataItemsResponse nextPageToken */ + nextPageToken?: (string|null); + } + + /** Represents a SearchDataItemsResponse. */ + class SearchDataItemsResponse implements ISearchDataItemsResponse { + + /** + * Constructs a new SearchDataItemsResponse. + * @param [properties] Properties to set + */ + constructor(properties?: google.cloud.aiplatform.v1.ISearchDataItemsResponse); + + /** SearchDataItemsResponse dataItemViews. */ + public dataItemViews: google.cloud.aiplatform.v1.IDataItemView[]; + + /** SearchDataItemsResponse nextPageToken. */ + public nextPageToken: string; + + /** + * Creates a new SearchDataItemsResponse instance using the specified properties. + * @param [properties] Properties to set + * @returns SearchDataItemsResponse instance + */ + public static create(properties?: google.cloud.aiplatform.v1.ISearchDataItemsResponse): google.cloud.aiplatform.v1.SearchDataItemsResponse; + + /** + * Encodes the specified SearchDataItemsResponse message. Does not implicitly {@link google.cloud.aiplatform.v1.SearchDataItemsResponse.verify|verify} messages. + * @param message SearchDataItemsResponse message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encode(message: google.cloud.aiplatform.v1.ISearchDataItemsResponse, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Encodes the specified SearchDataItemsResponse message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.SearchDataItemsResponse.verify|verify} messages. + * @param message SearchDataItemsResponse message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encodeDelimited(message: google.cloud.aiplatform.v1.ISearchDataItemsResponse, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Decodes a SearchDataItemsResponse message from the specified reader or buffer. + * @param reader Reader or buffer to decode from + * @param [length] Message length if known beforehand + * @returns SearchDataItemsResponse + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.SearchDataItemsResponse; + + /** + * Decodes a SearchDataItemsResponse message from the specified reader or buffer, length delimited. + * @param reader Reader or buffer to decode from + * @returns SearchDataItemsResponse + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.SearchDataItemsResponse; + + /** + * Verifies a SearchDataItemsResponse message. + * @param message Plain object to verify + * @returns `null` if valid, otherwise the reason why it is not + */ + public static verify(message: { [k: string]: any }): (string|null); + + /** + * Creates a SearchDataItemsResponse message from a plain object. Also converts values to their respective internal types. + * @param object Plain object + * @returns SearchDataItemsResponse + */ + public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.SearchDataItemsResponse; + + /** + * Creates a plain object from a SearchDataItemsResponse message. Also converts values to other types if specified. + * @param message SearchDataItemsResponse + * @param [options] Conversion options + * @returns Plain object + */ + public static toObject(message: google.cloud.aiplatform.v1.SearchDataItemsResponse, options?: $protobuf.IConversionOptions): { [k: string]: any }; + + /** + * Converts this SearchDataItemsResponse to JSON. + * @returns JSON object + */ + public toJSON(): { [k: string]: any }; + + /** + * Gets the default type url for SearchDataItemsResponse + * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns The default type url + */ + public static getTypeUrl(typeUrlPrefix?: string): string; + } + + /** Properties of a DataItemView. */ + interface IDataItemView { + + /** DataItemView dataItem */ + dataItem?: (google.cloud.aiplatform.v1.IDataItem|null); + + /** DataItemView annotations */ + annotations?: (google.cloud.aiplatform.v1.IAnnotation[]|null); + + /** DataItemView hasTruncatedAnnotations */ + hasTruncatedAnnotations?: (boolean|null); + } + + /** Represents a DataItemView. */ + class DataItemView implements IDataItemView { + + /** + * Constructs a new DataItemView. + * @param [properties] Properties to set + */ + constructor(properties?: google.cloud.aiplatform.v1.IDataItemView); + + /** DataItemView dataItem. */ + public dataItem?: (google.cloud.aiplatform.v1.IDataItem|null); + + /** DataItemView annotations. */ + public annotations: google.cloud.aiplatform.v1.IAnnotation[]; + + /** DataItemView hasTruncatedAnnotations. */ + public hasTruncatedAnnotations: boolean; + + /** + * Creates a new DataItemView instance using the specified properties. + * @param [properties] Properties to set + * @returns DataItemView instance + */ + public static create(properties?: google.cloud.aiplatform.v1.IDataItemView): google.cloud.aiplatform.v1.DataItemView; + + /** + * Encodes the specified DataItemView message. Does not implicitly {@link google.cloud.aiplatform.v1.DataItemView.verify|verify} messages. + * @param message DataItemView message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encode(message: google.cloud.aiplatform.v1.IDataItemView, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Encodes the specified DataItemView message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.DataItemView.verify|verify} messages. + * @param message DataItemView message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encodeDelimited(message: google.cloud.aiplatform.v1.IDataItemView, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Decodes a DataItemView message from the specified reader or buffer. + * @param reader Reader or buffer to decode from + * @param [length] Message length if known beforehand + * @returns DataItemView + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.DataItemView; + + /** + * Decodes a DataItemView message from the specified reader or buffer, length delimited. + * @param reader Reader or buffer to decode from + * @returns DataItemView + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.DataItemView; + + /** + * Verifies a DataItemView message. + * @param message Plain object to verify + * @returns `null` if valid, otherwise the reason why it is not + */ + public static verify(message: { [k: string]: any }): (string|null); + + /** + * Creates a DataItemView message from a plain object. Also converts values to their respective internal types. + * @param object Plain object + * @returns DataItemView + */ + public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.DataItemView; + + /** + * Creates a plain object from a DataItemView message. Also converts values to other types if specified. + * @param message DataItemView + * @param [options] Conversion options + * @returns Plain object + */ + public static toObject(message: google.cloud.aiplatform.v1.DataItemView, options?: $protobuf.IConversionOptions): { [k: string]: any }; + + /** + * Converts this DataItemView to JSON. + * @returns JSON object + */ + public toJSON(): { [k: string]: any }; + + /** + * Gets the default type url for DataItemView + * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns The default type url + */ + public static getTypeUrl(typeUrlPrefix?: string): string; + } + /** Properties of a ListSavedQueriesRequest. */ interface IListSavedQueriesRequest { @@ -11502,157 +12321,6 @@ export namespace google { public static getTypeUrl(typeUrlPrefix?: string): string; } - /** Properties of a SavedQuery. */ - interface ISavedQuery { - - /** SavedQuery name */ - name?: (string|null); - - /** SavedQuery displayName */ - displayName?: (string|null); - - /** SavedQuery metadata */ - metadata?: (google.protobuf.IValue|null); - - /** SavedQuery createTime */ - createTime?: (google.protobuf.ITimestamp|null); - - /** SavedQuery updateTime */ - updateTime?: (google.protobuf.ITimestamp|null); - - /** SavedQuery annotationFilter */ - annotationFilter?: (string|null); - - /** SavedQuery problemType */ - problemType?: (string|null); - - /** SavedQuery annotationSpecCount */ - annotationSpecCount?: (number|null); - - /** SavedQuery etag */ - etag?: (string|null); - - /** SavedQuery supportAutomlTraining */ - supportAutomlTraining?: (boolean|null); - } - - /** Represents a SavedQuery. */ - class SavedQuery implements ISavedQuery { - - /** - * Constructs a new SavedQuery. - * @param [properties] Properties to set - */ - constructor(properties?: google.cloud.aiplatform.v1.ISavedQuery); - - /** SavedQuery name. */ - public name: string; - - /** SavedQuery displayName. */ - public displayName: string; - - /** SavedQuery metadata. */ - public metadata?: (google.protobuf.IValue|null); - - /** SavedQuery createTime. */ - public createTime?: (google.protobuf.ITimestamp|null); - - /** SavedQuery updateTime. */ - public updateTime?: (google.protobuf.ITimestamp|null); - - /** SavedQuery annotationFilter. */ - public annotationFilter: string; - - /** SavedQuery problemType. */ - public problemType: string; - - /** SavedQuery annotationSpecCount. */ - public annotationSpecCount: number; - - /** SavedQuery etag. */ - public etag: string; - - /** SavedQuery supportAutomlTraining. */ - public supportAutomlTraining: boolean; - - /** - * Creates a new SavedQuery instance using the specified properties. - * @param [properties] Properties to set - * @returns SavedQuery instance - */ - public static create(properties?: google.cloud.aiplatform.v1.ISavedQuery): google.cloud.aiplatform.v1.SavedQuery; - - /** - * Encodes the specified SavedQuery message. Does not implicitly {@link google.cloud.aiplatform.v1.SavedQuery.verify|verify} messages. - * @param message SavedQuery message or plain object to encode - * @param [writer] Writer to encode to - * @returns Writer - */ - public static encode(message: google.cloud.aiplatform.v1.ISavedQuery, writer?: $protobuf.Writer): $protobuf.Writer; - - /** - * Encodes the specified SavedQuery message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.SavedQuery.verify|verify} messages. - * @param message SavedQuery message or plain object to encode - * @param [writer] Writer to encode to - * @returns Writer - */ - public static encodeDelimited(message: google.cloud.aiplatform.v1.ISavedQuery, writer?: $protobuf.Writer): $protobuf.Writer; - - /** - * Decodes a SavedQuery message from the specified reader or buffer. - * @param reader Reader or buffer to decode from - * @param [length] Message length if known beforehand - * @returns SavedQuery - * @throws {Error} If the payload is not a reader or valid buffer - * @throws {$protobuf.util.ProtocolError} If required fields are missing - */ - public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.SavedQuery; - - /** - * Decodes a SavedQuery message from the specified reader or buffer, length delimited. - * @param reader Reader or buffer to decode from - * @returns SavedQuery - * @throws {Error} If the payload is not a reader or valid buffer - * @throws {$protobuf.util.ProtocolError} If required fields are missing - */ - public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.SavedQuery; - - /** - * Verifies a SavedQuery message. - * @param message Plain object to verify - * @returns `null` if valid, otherwise the reason why it is not - */ - public static verify(message: { [k: string]: any }): (string|null); - - /** - * Creates a SavedQuery message from a plain object. Also converts values to their respective internal types. - * @param object Plain object - * @returns SavedQuery - */ - public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.SavedQuery; - - /** - * Creates a plain object from a SavedQuery message. Also converts values to other types if specified. - * @param message SavedQuery - * @param [options] Conversion options - * @returns Plain object - */ - public static toObject(message: google.cloud.aiplatform.v1.SavedQuery, options?: $protobuf.IConversionOptions): { [k: string]: any }; - - /** - * Converts this SavedQuery to JSON. - * @returns JSON object - */ - public toJSON(): { [k: string]: any }; - - /** - * Gets the default type url for SavedQuery - * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") - * @returns The default type url - */ - public static getTypeUrl(typeUrlPrefix?: string): string; - } - /** Properties of a DeployedIndexRef. */ interface IDeployedIndexRef { @@ -15716,6 +16384,20 @@ export namespace google { * @returns Promise */ public streamingReadFeatureValues(request: google.cloud.aiplatform.v1.IStreamingReadFeatureValuesRequest): Promise; + + /** + * Calls WriteFeatureValues. + * @param request WriteFeatureValuesRequest message or plain object + * @param callback Node-style callback called with the error, if any, and WriteFeatureValuesResponse + */ + public writeFeatureValues(request: google.cloud.aiplatform.v1.IWriteFeatureValuesRequest, callback: google.cloud.aiplatform.v1.FeaturestoreOnlineServingService.WriteFeatureValuesCallback): void; + + /** + * Calls WriteFeatureValues. + * @param request WriteFeatureValuesRequest message or plain object + * @returns Promise + */ + public writeFeatureValues(request: google.cloud.aiplatform.v1.IWriteFeatureValuesRequest): Promise; } namespace FeaturestoreOnlineServingService { @@ -15733,6 +16415,310 @@ export namespace google { * @param [response] ReadFeatureValuesResponse */ type StreamingReadFeatureValuesCallback = (error: (Error|null), response?: google.cloud.aiplatform.v1.ReadFeatureValuesResponse) => void; + + /** + * Callback as used by {@link google.cloud.aiplatform.v1.FeaturestoreOnlineServingService|writeFeatureValues}. + * @param error Error, if any + * @param [response] WriteFeatureValuesResponse + */ + type WriteFeatureValuesCallback = (error: (Error|null), response?: google.cloud.aiplatform.v1.WriteFeatureValuesResponse) => void; + } + + /** Properties of a WriteFeatureValuesRequest. */ + interface IWriteFeatureValuesRequest { + + /** WriteFeatureValuesRequest entityType */ + entityType?: (string|null); + + /** WriteFeatureValuesRequest payloads */ + payloads?: (google.cloud.aiplatform.v1.IWriteFeatureValuesPayload[]|null); + } + + /** Represents a WriteFeatureValuesRequest. */ + class WriteFeatureValuesRequest implements IWriteFeatureValuesRequest { + + /** + * Constructs a new WriteFeatureValuesRequest. + * @param [properties] Properties to set + */ + constructor(properties?: google.cloud.aiplatform.v1.IWriteFeatureValuesRequest); + + /** WriteFeatureValuesRequest entityType. */ + public entityType: string; + + /** WriteFeatureValuesRequest payloads. */ + public payloads: google.cloud.aiplatform.v1.IWriteFeatureValuesPayload[]; + + /** + * Creates a new WriteFeatureValuesRequest instance using the specified properties. + * @param [properties] Properties to set + * @returns WriteFeatureValuesRequest instance + */ + public static create(properties?: google.cloud.aiplatform.v1.IWriteFeatureValuesRequest): google.cloud.aiplatform.v1.WriteFeatureValuesRequest; + + /** + * Encodes the specified WriteFeatureValuesRequest message. Does not implicitly {@link google.cloud.aiplatform.v1.WriteFeatureValuesRequest.verify|verify} messages. + * @param message WriteFeatureValuesRequest message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encode(message: google.cloud.aiplatform.v1.IWriteFeatureValuesRequest, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Encodes the specified WriteFeatureValuesRequest message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.WriteFeatureValuesRequest.verify|verify} messages. + * @param message WriteFeatureValuesRequest message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encodeDelimited(message: google.cloud.aiplatform.v1.IWriteFeatureValuesRequest, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Decodes a WriteFeatureValuesRequest message from the specified reader or buffer. + * @param reader Reader or buffer to decode from + * @param [length] Message length if known beforehand + * @returns WriteFeatureValuesRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.WriteFeatureValuesRequest; + + /** + * Decodes a WriteFeatureValuesRequest message from the specified reader or buffer, length delimited. + * @param reader Reader or buffer to decode from + * @returns WriteFeatureValuesRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.WriteFeatureValuesRequest; + + /** + * Verifies a WriteFeatureValuesRequest message. + * @param message Plain object to verify + * @returns `null` if valid, otherwise the reason why it is not + */ + public static verify(message: { [k: string]: any }): (string|null); + + /** + * Creates a WriteFeatureValuesRequest message from a plain object. Also converts values to their respective internal types. + * @param object Plain object + * @returns WriteFeatureValuesRequest + */ + public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.WriteFeatureValuesRequest; + + /** + * Creates a plain object from a WriteFeatureValuesRequest message. Also converts values to other types if specified. + * @param message WriteFeatureValuesRequest + * @param [options] Conversion options + * @returns Plain object + */ + public static toObject(message: google.cloud.aiplatform.v1.WriteFeatureValuesRequest, options?: $protobuf.IConversionOptions): { [k: string]: any }; + + /** + * Converts this WriteFeatureValuesRequest to JSON. + * @returns JSON object + */ + public toJSON(): { [k: string]: any }; + + /** + * Gets the default type url for WriteFeatureValuesRequest + * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns The default type url + */ + public static getTypeUrl(typeUrlPrefix?: string): string; + } + + /** Properties of a WriteFeatureValuesPayload. */ + interface IWriteFeatureValuesPayload { + + /** WriteFeatureValuesPayload entityId */ + entityId?: (string|null); + + /** WriteFeatureValuesPayload featureValues */ + featureValues?: ({ [k: string]: google.cloud.aiplatform.v1.IFeatureValue }|null); + } + + /** Represents a WriteFeatureValuesPayload. */ + class WriteFeatureValuesPayload implements IWriteFeatureValuesPayload { + + /** + * Constructs a new WriteFeatureValuesPayload. + * @param [properties] Properties to set + */ + constructor(properties?: google.cloud.aiplatform.v1.IWriteFeatureValuesPayload); + + /** WriteFeatureValuesPayload entityId. */ + public entityId: string; + + /** WriteFeatureValuesPayload featureValues. */ + public featureValues: { [k: string]: google.cloud.aiplatform.v1.IFeatureValue }; + + /** + * Creates a new WriteFeatureValuesPayload instance using the specified properties. + * @param [properties] Properties to set + * @returns WriteFeatureValuesPayload instance + */ + public static create(properties?: google.cloud.aiplatform.v1.IWriteFeatureValuesPayload): google.cloud.aiplatform.v1.WriteFeatureValuesPayload; + + /** + * Encodes the specified WriteFeatureValuesPayload message. Does not implicitly {@link google.cloud.aiplatform.v1.WriteFeatureValuesPayload.verify|verify} messages. + * @param message WriteFeatureValuesPayload message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encode(message: google.cloud.aiplatform.v1.IWriteFeatureValuesPayload, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Encodes the specified WriteFeatureValuesPayload message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.WriteFeatureValuesPayload.verify|verify} messages. + * @param message WriteFeatureValuesPayload message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encodeDelimited(message: google.cloud.aiplatform.v1.IWriteFeatureValuesPayload, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Decodes a WriteFeatureValuesPayload message from the specified reader or buffer. + * @param reader Reader or buffer to decode from + * @param [length] Message length if known beforehand + * @returns WriteFeatureValuesPayload + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.WriteFeatureValuesPayload; + + /** + * Decodes a WriteFeatureValuesPayload message from the specified reader or buffer, length delimited. + * @param reader Reader or buffer to decode from + * @returns WriteFeatureValuesPayload + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.WriteFeatureValuesPayload; + + /** + * Verifies a WriteFeatureValuesPayload message. + * @param message Plain object to verify + * @returns `null` if valid, otherwise the reason why it is not + */ + public static verify(message: { [k: string]: any }): (string|null); + + /** + * Creates a WriteFeatureValuesPayload message from a plain object. Also converts values to their respective internal types. + * @param object Plain object + * @returns WriteFeatureValuesPayload + */ + public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.WriteFeatureValuesPayload; + + /** + * Creates a plain object from a WriteFeatureValuesPayload message. Also converts values to other types if specified. + * @param message WriteFeatureValuesPayload + * @param [options] Conversion options + * @returns Plain object + */ + public static toObject(message: google.cloud.aiplatform.v1.WriteFeatureValuesPayload, options?: $protobuf.IConversionOptions): { [k: string]: any }; + + /** + * Converts this WriteFeatureValuesPayload to JSON. + * @returns JSON object + */ + public toJSON(): { [k: string]: any }; + + /** + * Gets the default type url for WriteFeatureValuesPayload + * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns The default type url + */ + public static getTypeUrl(typeUrlPrefix?: string): string; + } + + /** Properties of a WriteFeatureValuesResponse. */ + interface IWriteFeatureValuesResponse { + } + + /** Represents a WriteFeatureValuesResponse. */ + class WriteFeatureValuesResponse implements IWriteFeatureValuesResponse { + + /** + * Constructs a new WriteFeatureValuesResponse. + * @param [properties] Properties to set + */ + constructor(properties?: google.cloud.aiplatform.v1.IWriteFeatureValuesResponse); + + /** + * Creates a new WriteFeatureValuesResponse instance using the specified properties. + * @param [properties] Properties to set + * @returns WriteFeatureValuesResponse instance + */ + public static create(properties?: google.cloud.aiplatform.v1.IWriteFeatureValuesResponse): google.cloud.aiplatform.v1.WriteFeatureValuesResponse; + + /** + * Encodes the specified WriteFeatureValuesResponse message. Does not implicitly {@link google.cloud.aiplatform.v1.WriteFeatureValuesResponse.verify|verify} messages. + * @param message WriteFeatureValuesResponse message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encode(message: google.cloud.aiplatform.v1.IWriteFeatureValuesResponse, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Encodes the specified WriteFeatureValuesResponse message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.WriteFeatureValuesResponse.verify|verify} messages. + * @param message WriteFeatureValuesResponse message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encodeDelimited(message: google.cloud.aiplatform.v1.IWriteFeatureValuesResponse, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Decodes a WriteFeatureValuesResponse message from the specified reader or buffer. + * @param reader Reader or buffer to decode from + * @param [length] Message length if known beforehand + * @returns WriteFeatureValuesResponse + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.WriteFeatureValuesResponse; + + /** + * Decodes a WriteFeatureValuesResponse message from the specified reader or buffer, length delimited. + * @param reader Reader or buffer to decode from + * @returns WriteFeatureValuesResponse + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.WriteFeatureValuesResponse; + + /** + * Verifies a WriteFeatureValuesResponse message. + * @param message Plain object to verify + * @returns `null` if valid, otherwise the reason why it is not + */ + public static verify(message: { [k: string]: any }): (string|null); + + /** + * Creates a WriteFeatureValuesResponse message from a plain object. Also converts values to their respective internal types. + * @param object Plain object + * @returns WriteFeatureValuesResponse + */ + public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.WriteFeatureValuesResponse; + + /** + * Creates a plain object from a WriteFeatureValuesResponse message. Also converts values to other types if specified. + * @param message WriteFeatureValuesResponse + * @param [options] Conversion options + * @returns Plain object + */ + public static toObject(message: google.cloud.aiplatform.v1.WriteFeatureValuesResponse, options?: $protobuf.IConversionOptions): { [k: string]: any }; + + /** + * Converts this WriteFeatureValuesResponse to JSON. + * @returns JSON object + */ + public toJSON(): { [k: string]: any }; + + /** + * Gets the default type url for WriteFeatureValuesResponse + * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns The default type url + */ + public static getTypeUrl(typeUrlPrefix?: string): string; } /** Properties of a ReadFeatureValuesRequest. */ @@ -18700,6 +19686,9 @@ export namespace google { /** BatchReadFeatureValuesRequest entityTypeSpecs */ entityTypeSpecs?: (google.cloud.aiplatform.v1.BatchReadFeatureValuesRequest.IEntityTypeSpec[]|null); + + /** BatchReadFeatureValuesRequest startTime */ + startTime?: (google.protobuf.ITimestamp|null); } /** Represents a BatchReadFeatureValuesRequest. */ @@ -18729,6 +19718,9 @@ export namespace google { /** BatchReadFeatureValuesRequest entityTypeSpecs. */ public entityTypeSpecs: google.cloud.aiplatform.v1.BatchReadFeatureValuesRequest.IEntityTypeSpec[]; + /** BatchReadFeatureValuesRequest startTime. */ + public startTime?: (google.protobuf.ITimestamp|null); + /** BatchReadFeatureValuesRequest readOption. */ public readOption?: ("csvReadInstances"|"bigqueryReadInstances"); @@ -21663,6 +22655,9 @@ export namespace google { /** ImportFeatureValuesOperationMetadata importedFeatureValueCount */ importedFeatureValueCount?: (number|Long|string|null); + /** ImportFeatureValuesOperationMetadata sourceUris */ + sourceUris?: (string[]|null); + /** ImportFeatureValuesOperationMetadata invalidRowCount */ invalidRowCount?: (number|Long|string|null); @@ -21688,6 +22683,9 @@ export namespace google { /** ImportFeatureValuesOperationMetadata importedFeatureValueCount. */ public importedFeatureValueCount: (number|Long|string); + /** ImportFeatureValuesOperationMetadata sourceUris. */ + public sourceUris: string[]; + /** ImportFeatureValuesOperationMetadata invalidRowCount. */ public invalidRowCount: (number|Long|string); @@ -24324,6 +25322,9 @@ export namespace google { /** ConvexAutomatedStoppingSpec useElapsedDuration */ useElapsedDuration?: (boolean|null); + + /** ConvexAutomatedStoppingSpec updateAllStoppedTrials */ + updateAllStoppedTrials?: (boolean|null); } /** Represents a ConvexAutomatedStoppingSpec. */ @@ -24350,6 +25351,12 @@ export namespace google { /** ConvexAutomatedStoppingSpec useElapsedDuration. */ public useElapsedDuration: boolean; + /** ConvexAutomatedStoppingSpec updateAllStoppedTrials. */ + public updateAllStoppedTrials?: (boolean|null); + + /** ConvexAutomatedStoppingSpec _updateAllStoppedTrials. */ + public _updateAllStoppedTrials?: "updateAllStoppedTrials"; + /** * Creates a new ConvexAutomatedStoppingSpec instance using the specified properties. * @param [properties] Properties to set @@ -45126,6 +46133,9 @@ export namespace google { /** UploadModelRequest model */ model?: (google.cloud.aiplatform.v1.IModel|null); + + /** UploadModelRequest serviceAccount */ + serviceAccount?: (string|null); } /** Represents an UploadModelRequest. */ @@ -45149,6 +46159,9 @@ export namespace google { /** UploadModelRequest model. */ public model?: (google.cloud.aiplatform.v1.IModel|null); + /** UploadModelRequest serviceAccount. */ + public serviceAccount: string; + /** * Creates a new UploadModelRequest instance using the specified properties. * @param [properties] Properties to set @@ -45771,6 +46784,9 @@ export namespace google { /** ListModelVersionsRequest readMask */ readMask?: (google.protobuf.IFieldMask|null); + + /** ListModelVersionsRequest orderBy */ + orderBy?: (string|null); } /** Represents a ListModelVersionsRequest. */ @@ -45797,6 +46813,9 @@ export namespace google { /** ListModelVersionsRequest readMask. */ public readMask?: (google.protobuf.IFieldMask|null); + /** ListModelVersionsRequest orderBy. */ + public orderBy: string; + /** * Creates a new ListModelVersionsRequest instance using the specified properties. * @param [properties] Properties to set @@ -48979,6 +49998,12 @@ export namespace google { /** ContainerDetail preCachingCheckJob */ preCachingCheckJob?: (string|null); + + /** ContainerDetail failedMainJobs */ + failedMainJobs?: (string[]|null); + + /** ContainerDetail failedPreCachingCheckJobs */ + failedPreCachingCheckJobs?: (string[]|null); } /** Represents a ContainerDetail. */ @@ -48996,6 +50021,12 @@ export namespace google { /** ContainerDetail preCachingCheckJob. */ public preCachingCheckJob: string; + /** ContainerDetail failedMainJobs. */ + public failedMainJobs: string[]; + + /** ContainerDetail failedPreCachingCheckJobs. */ + public failedPreCachingCheckJobs: string[]; + /** * Creates a new ContainerDetail instance using the specified properties. * @param [properties] Properties to set @@ -51007,6 +52038,9 @@ export namespace google { /** InputDataConfig savedQueryId */ savedQueryId?: (string|null); + + /** InputDataConfig persistMlUseAssignment */ + persistMlUseAssignment?: (boolean|null); } /** Represents an InputDataConfig. */ @@ -51051,6 +52085,9 @@ export namespace google { /** InputDataConfig savedQueryId. */ public savedQueryId: string; + /** InputDataConfig persistMlUseAssignment. */ + public persistMlUseAssignment: boolean; + /** InputDataConfig split. */ public split?: ("fractionSplit"|"filterSplit"|"predefinedSplit"|"timestampSplit"|"stratifiedSplit"); @@ -61303,6 +62340,20 @@ export namespace google { */ public getTensorboard(request: google.cloud.aiplatform.v1.IGetTensorboardRequest): Promise; + /** + * Calls ReadTensorboardUsage. + * @param request ReadTensorboardUsageRequest message or plain object + * @param callback Node-style callback called with the error, if any, and ReadTensorboardUsageResponse + */ + public readTensorboardUsage(request: google.cloud.aiplatform.v1.IReadTensorboardUsageRequest, callback: google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardUsageCallback): void; + + /** + * Calls ReadTensorboardUsage. + * @param request ReadTensorboardUsageRequest message or plain object + * @returns Promise + */ + public readTensorboardUsage(request: google.cloud.aiplatform.v1.IReadTensorboardUsageRequest): Promise; + /** * Calls UpdateTensorboard. * @param request UpdateTensorboardRequest message or plain object @@ -61684,6 +62735,13 @@ export namespace google { */ type GetTensorboardCallback = (error: (Error|null), response?: google.cloud.aiplatform.v1.Tensorboard) => void; + /** + * Callback as used by {@link google.cloud.aiplatform.v1.TensorboardService|readTensorboardUsage}. + * @param error Error, if any + * @param [response] ReadTensorboardUsageResponse + */ + type ReadTensorboardUsageCallback = (error: (Error|null), response?: google.cloud.aiplatform.v1.ReadTensorboardUsageResponse) => void; + /** * Callback as used by {@link google.cloud.aiplatform.v1.TensorboardService|updateTensorboard}. * @param error Error, if any @@ -62067,6 +63125,403 @@ export namespace google { public static getTypeUrl(typeUrlPrefix?: string): string; } + /** Properties of a ReadTensorboardUsageRequest. */ + interface IReadTensorboardUsageRequest { + + /** ReadTensorboardUsageRequest tensorboard */ + tensorboard?: (string|null); + } + + /** Represents a ReadTensorboardUsageRequest. */ + class ReadTensorboardUsageRequest implements IReadTensorboardUsageRequest { + + /** + * Constructs a new ReadTensorboardUsageRequest. + * @param [properties] Properties to set + */ + constructor(properties?: google.cloud.aiplatform.v1.IReadTensorboardUsageRequest); + + /** ReadTensorboardUsageRequest tensorboard. */ + public tensorboard: string; + + /** + * Creates a new ReadTensorboardUsageRequest instance using the specified properties. + * @param [properties] Properties to set + * @returns ReadTensorboardUsageRequest instance + */ + public static create(properties?: google.cloud.aiplatform.v1.IReadTensorboardUsageRequest): google.cloud.aiplatform.v1.ReadTensorboardUsageRequest; + + /** + * Encodes the specified ReadTensorboardUsageRequest message. Does not implicitly {@link google.cloud.aiplatform.v1.ReadTensorboardUsageRequest.verify|verify} messages. + * @param message ReadTensorboardUsageRequest message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encode(message: google.cloud.aiplatform.v1.IReadTensorboardUsageRequest, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Encodes the specified ReadTensorboardUsageRequest message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.ReadTensorboardUsageRequest.verify|verify} messages. + * @param message ReadTensorboardUsageRequest message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encodeDelimited(message: google.cloud.aiplatform.v1.IReadTensorboardUsageRequest, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Decodes a ReadTensorboardUsageRequest message from the specified reader or buffer. + * @param reader Reader or buffer to decode from + * @param [length] Message length if known beforehand + * @returns ReadTensorboardUsageRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.ReadTensorboardUsageRequest; + + /** + * Decodes a ReadTensorboardUsageRequest message from the specified reader or buffer, length delimited. + * @param reader Reader or buffer to decode from + * @returns ReadTensorboardUsageRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.ReadTensorboardUsageRequest; + + /** + * Verifies a ReadTensorboardUsageRequest message. + * @param message Plain object to verify + * @returns `null` if valid, otherwise the reason why it is not + */ + public static verify(message: { [k: string]: any }): (string|null); + + /** + * Creates a ReadTensorboardUsageRequest message from a plain object. Also converts values to their respective internal types. + * @param object Plain object + * @returns ReadTensorboardUsageRequest + */ + public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.ReadTensorboardUsageRequest; + + /** + * Creates a plain object from a ReadTensorboardUsageRequest message. Also converts values to other types if specified. + * @param message ReadTensorboardUsageRequest + * @param [options] Conversion options + * @returns Plain object + */ + public static toObject(message: google.cloud.aiplatform.v1.ReadTensorboardUsageRequest, options?: $protobuf.IConversionOptions): { [k: string]: any }; + + /** + * Converts this ReadTensorboardUsageRequest to JSON. + * @returns JSON object + */ + public toJSON(): { [k: string]: any }; + + /** + * Gets the default type url for ReadTensorboardUsageRequest + * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns The default type url + */ + public static getTypeUrl(typeUrlPrefix?: string): string; + } + + /** Properties of a ReadTensorboardUsageResponse. */ + interface IReadTensorboardUsageResponse { + + /** ReadTensorboardUsageResponse monthlyUsageData */ + monthlyUsageData?: ({ [k: string]: google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.IPerMonthUsageData }|null); + } + + /** Represents a ReadTensorboardUsageResponse. */ + class ReadTensorboardUsageResponse implements IReadTensorboardUsageResponse { + + /** + * Constructs a new ReadTensorboardUsageResponse. + * @param [properties] Properties to set + */ + constructor(properties?: google.cloud.aiplatform.v1.IReadTensorboardUsageResponse); + + /** ReadTensorboardUsageResponse monthlyUsageData. */ + public monthlyUsageData: { [k: string]: google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.IPerMonthUsageData }; + + /** + * Creates a new ReadTensorboardUsageResponse instance using the specified properties. + * @param [properties] Properties to set + * @returns ReadTensorboardUsageResponse instance + */ + public static create(properties?: google.cloud.aiplatform.v1.IReadTensorboardUsageResponse): google.cloud.aiplatform.v1.ReadTensorboardUsageResponse; + + /** + * Encodes the specified ReadTensorboardUsageResponse message. Does not implicitly {@link google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.verify|verify} messages. + * @param message ReadTensorboardUsageResponse message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encode(message: google.cloud.aiplatform.v1.IReadTensorboardUsageResponse, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Encodes the specified ReadTensorboardUsageResponse message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.verify|verify} messages. + * @param message ReadTensorboardUsageResponse message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encodeDelimited(message: google.cloud.aiplatform.v1.IReadTensorboardUsageResponse, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Decodes a ReadTensorboardUsageResponse message from the specified reader or buffer. + * @param reader Reader or buffer to decode from + * @param [length] Message length if known beforehand + * @returns ReadTensorboardUsageResponse + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.ReadTensorboardUsageResponse; + + /** + * Decodes a ReadTensorboardUsageResponse message from the specified reader or buffer, length delimited. + * @param reader Reader or buffer to decode from + * @returns ReadTensorboardUsageResponse + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.ReadTensorboardUsageResponse; + + /** + * Verifies a ReadTensorboardUsageResponse message. + * @param message Plain object to verify + * @returns `null` if valid, otherwise the reason why it is not + */ + public static verify(message: { [k: string]: any }): (string|null); + + /** + * Creates a ReadTensorboardUsageResponse message from a plain object. Also converts values to their respective internal types. + * @param object Plain object + * @returns ReadTensorboardUsageResponse + */ + public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.ReadTensorboardUsageResponse; + + /** + * Creates a plain object from a ReadTensorboardUsageResponse message. Also converts values to other types if specified. + * @param message ReadTensorboardUsageResponse + * @param [options] Conversion options + * @returns Plain object + */ + public static toObject(message: google.cloud.aiplatform.v1.ReadTensorboardUsageResponse, options?: $protobuf.IConversionOptions): { [k: string]: any }; + + /** + * Converts this ReadTensorboardUsageResponse to JSON. + * @returns JSON object + */ + public toJSON(): { [k: string]: any }; + + /** + * Gets the default type url for ReadTensorboardUsageResponse + * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns The default type url + */ + public static getTypeUrl(typeUrlPrefix?: string): string; + } + + namespace ReadTensorboardUsageResponse { + + /** Properties of a PerUserUsageData. */ + interface IPerUserUsageData { + + /** PerUserUsageData username */ + username?: (string|null); + + /** PerUserUsageData viewCount */ + viewCount?: (number|Long|string|null); + } + + /** Represents a PerUserUsageData. */ + class PerUserUsageData implements IPerUserUsageData { + + /** + * Constructs a new PerUserUsageData. + * @param [properties] Properties to set + */ + constructor(properties?: google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.IPerUserUsageData); + + /** PerUserUsageData username. */ + public username: string; + + /** PerUserUsageData viewCount. */ + public viewCount: (number|Long|string); + + /** + * Creates a new PerUserUsageData instance using the specified properties. + * @param [properties] Properties to set + * @returns PerUserUsageData instance + */ + public static create(properties?: google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.IPerUserUsageData): google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerUserUsageData; + + /** + * Encodes the specified PerUserUsageData message. Does not implicitly {@link google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerUserUsageData.verify|verify} messages. + * @param message PerUserUsageData message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encode(message: google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.IPerUserUsageData, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Encodes the specified PerUserUsageData message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerUserUsageData.verify|verify} messages. + * @param message PerUserUsageData message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encodeDelimited(message: google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.IPerUserUsageData, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Decodes a PerUserUsageData message from the specified reader or buffer. + * @param reader Reader or buffer to decode from + * @param [length] Message length if known beforehand + * @returns PerUserUsageData + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerUserUsageData; + + /** + * Decodes a PerUserUsageData message from the specified reader or buffer, length delimited. + * @param reader Reader or buffer to decode from + * @returns PerUserUsageData + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerUserUsageData; + + /** + * Verifies a PerUserUsageData message. + * @param message Plain object to verify + * @returns `null` if valid, otherwise the reason why it is not + */ + public static verify(message: { [k: string]: any }): (string|null); + + /** + * Creates a PerUserUsageData message from a plain object. Also converts values to their respective internal types. + * @param object Plain object + * @returns PerUserUsageData + */ + public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerUserUsageData; + + /** + * Creates a plain object from a PerUserUsageData message. Also converts values to other types if specified. + * @param message PerUserUsageData + * @param [options] Conversion options + * @returns Plain object + */ + public static toObject(message: google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerUserUsageData, options?: $protobuf.IConversionOptions): { [k: string]: any }; + + /** + * Converts this PerUserUsageData to JSON. + * @returns JSON object + */ + public toJSON(): { [k: string]: any }; + + /** + * Gets the default type url for PerUserUsageData + * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns The default type url + */ + public static getTypeUrl(typeUrlPrefix?: string): string; + } + + /** Properties of a PerMonthUsageData. */ + interface IPerMonthUsageData { + + /** PerMonthUsageData userUsageData */ + userUsageData?: (google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.IPerUserUsageData[]|null); + } + + /** Represents a PerMonthUsageData. */ + class PerMonthUsageData implements IPerMonthUsageData { + + /** + * Constructs a new PerMonthUsageData. + * @param [properties] Properties to set + */ + constructor(properties?: google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.IPerMonthUsageData); + + /** PerMonthUsageData userUsageData. */ + public userUsageData: google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.IPerUserUsageData[]; + + /** + * Creates a new PerMonthUsageData instance using the specified properties. + * @param [properties] Properties to set + * @returns PerMonthUsageData instance + */ + public static create(properties?: google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.IPerMonthUsageData): google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerMonthUsageData; + + /** + * Encodes the specified PerMonthUsageData message. Does not implicitly {@link google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerMonthUsageData.verify|verify} messages. + * @param message PerMonthUsageData message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encode(message: google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.IPerMonthUsageData, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Encodes the specified PerMonthUsageData message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerMonthUsageData.verify|verify} messages. + * @param message PerMonthUsageData message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encodeDelimited(message: google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.IPerMonthUsageData, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Decodes a PerMonthUsageData message from the specified reader or buffer. + * @param reader Reader or buffer to decode from + * @param [length] Message length if known beforehand + * @returns PerMonthUsageData + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerMonthUsageData; + + /** + * Decodes a PerMonthUsageData message from the specified reader or buffer, length delimited. + * @param reader Reader or buffer to decode from + * @returns PerMonthUsageData + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerMonthUsageData; + + /** + * Verifies a PerMonthUsageData message. + * @param message Plain object to verify + * @returns `null` if valid, otherwise the reason why it is not + */ + public static verify(message: { [k: string]: any }): (string|null); + + /** + * Creates a PerMonthUsageData message from a plain object. Also converts values to their respective internal types. + * @param object Plain object + * @returns PerMonthUsageData + */ + public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerMonthUsageData; + + /** + * Creates a plain object from a PerMonthUsageData message. Also converts values to other types if specified. + * @param message PerMonthUsageData + * @param [options] Conversion options + * @returns Plain object + */ + public static toObject(message: google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerMonthUsageData, options?: $protobuf.IConversionOptions): { [k: string]: any }; + + /** + * Converts this PerMonthUsageData to JSON. + * @returns JSON object + */ + public toJSON(): { [k: string]: any }; + + /** + * Gets the default type url for PerMonthUsageData + * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns The default type url + */ + public static getTypeUrl(typeUrlPrefix?: string): string; + } + } + /** Properties of a ListTensorboardsRequest. */ interface IListTensorboardsRequest { @@ -68829,6 +70284,7 @@ export namespace google { NVIDIA_TESLA_P4 = 4, NVIDIA_TESLA_T4 = 5, NVIDIA_TESLA_A100 = 8, + NVIDIA_A100_80GB = 9, TPU_V2 = 6, TPU_V3 = 7 } @@ -69399,6 +70855,9 @@ export namespace google { /** BatchPredictionJob inputConfig */ inputConfig?: (google.cloud.aiplatform.v1beta1.BatchPredictionJob.IInputConfig|null); + /** BatchPredictionJob instanceConfig */ + instanceConfig?: (google.cloud.aiplatform.v1beta1.BatchPredictionJob.IInstanceConfig|null); + /** BatchPredictionJob modelParameters */ modelParameters?: (google.protobuf.IValue|null); @@ -69493,6 +70952,9 @@ export namespace google { /** BatchPredictionJob inputConfig. */ public inputConfig?: (google.cloud.aiplatform.v1beta1.BatchPredictionJob.IInputConfig|null); + /** BatchPredictionJob instanceConfig. */ + public instanceConfig?: (google.cloud.aiplatform.v1beta1.BatchPredictionJob.IInstanceConfig|null); + /** BatchPredictionJob modelParameters. */ public modelParameters?: (google.protobuf.IValue|null); @@ -69751,6 +71213,121 @@ export namespace google { public static getTypeUrl(typeUrlPrefix?: string): string; } + /** Properties of an InstanceConfig. */ + interface IInstanceConfig { + + /** InstanceConfig instanceType */ + instanceType?: (string|null); + + /** InstanceConfig keyField */ + keyField?: (string|null); + + /** InstanceConfig includedFields */ + includedFields?: (string[]|null); + + /** InstanceConfig excludedFields */ + excludedFields?: (string[]|null); + } + + /** Represents an InstanceConfig. */ + class InstanceConfig implements IInstanceConfig { + + /** + * Constructs a new InstanceConfig. + * @param [properties] Properties to set + */ + constructor(properties?: google.cloud.aiplatform.v1beta1.BatchPredictionJob.IInstanceConfig); + + /** InstanceConfig instanceType. */ + public instanceType: string; + + /** InstanceConfig keyField. */ + public keyField: string; + + /** InstanceConfig includedFields. */ + public includedFields: string[]; + + /** InstanceConfig excludedFields. */ + public excludedFields: string[]; + + /** + * Creates a new InstanceConfig instance using the specified properties. + * @param [properties] Properties to set + * @returns InstanceConfig instance + */ + public static create(properties?: google.cloud.aiplatform.v1beta1.BatchPredictionJob.IInstanceConfig): google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig; + + /** + * Encodes the specified InstanceConfig message. Does not implicitly {@link google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig.verify|verify} messages. + * @param message InstanceConfig message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encode(message: google.cloud.aiplatform.v1beta1.BatchPredictionJob.IInstanceConfig, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Encodes the specified InstanceConfig message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig.verify|verify} messages. + * @param message InstanceConfig message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encodeDelimited(message: google.cloud.aiplatform.v1beta1.BatchPredictionJob.IInstanceConfig, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Decodes an InstanceConfig message from the specified reader or buffer. + * @param reader Reader or buffer to decode from + * @param [length] Message length if known beforehand + * @returns InstanceConfig + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig; + + /** + * Decodes an InstanceConfig message from the specified reader or buffer, length delimited. + * @param reader Reader or buffer to decode from + * @returns InstanceConfig + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig; + + /** + * Verifies an InstanceConfig message. + * @param message Plain object to verify + * @returns `null` if valid, otherwise the reason why it is not + */ + public static verify(message: { [k: string]: any }): (string|null); + + /** + * Creates an InstanceConfig message from a plain object. Also converts values to their respective internal types. + * @param object Plain object + * @returns InstanceConfig + */ + public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig; + + /** + * Creates a plain object from an InstanceConfig message. Also converts values to other types if specified. + * @param message InstanceConfig + * @param [options] Conversion options + * @returns Plain object + */ + public static toObject(message: google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig, options?: $protobuf.IConversionOptions): { [k: string]: any }; + + /** + * Converts this InstanceConfig to JSON. + * @returns JSON object + */ + public toJSON(): { [k: string]: any }; + + /** + * Gets the default type url for InstanceConfig + * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns The default type url + */ + public static getTypeUrl(typeUrlPrefix?: string): string; + } + /** Properties of an OutputConfig. */ interface IOutputConfig { @@ -77442,6 +79019,9 @@ export namespace google { /** Model modelSourceInfo */ modelSourceInfo?: (google.cloud.aiplatform.v1beta1.IModelSourceInfo|null); + + /** Model metadataArtifact */ + metadataArtifact?: (string|null); } /** Represents a Model. */ @@ -77531,6 +79111,9 @@ export namespace google { /** Model modelSourceInfo. */ public modelSourceInfo?: (google.cloud.aiplatform.v1beta1.IModelSourceInfo|null); + /** Model metadataArtifact. */ + public metadataArtifact: string; + /** * Creates a new Model instance using the specified properties. * @param [properties] Properties to set @@ -78732,6 +80315,9 @@ export namespace google { /** CustomJobSpec enableWebAccess */ enableWebAccess?: (boolean|null); + + /** CustomJobSpec enableDashboardAccess */ + enableDashboardAccess?: (boolean|null); } /** Represents a CustomJobSpec. */ @@ -78767,6 +80353,9 @@ export namespace google { /** CustomJobSpec enableWebAccess. */ public enableWebAccess: boolean; + /** CustomJobSpec enableDashboardAccess. */ + public enableDashboardAccess: boolean; + /** * Creates a new CustomJobSpec instance using the specified properties. * @param [properties] Properties to set @@ -80009,8 +81598,14 @@ export namespace google { /** Dataset labels */ labels?: ({ [k: string]: string }|null); + /** Dataset savedQueries */ + savedQueries?: (google.cloud.aiplatform.v1beta1.ISavedQuery[]|null); + /** Dataset encryptionSpec */ encryptionSpec?: (google.cloud.aiplatform.v1beta1.IEncryptionSpec|null); + + /** Dataset metadataArtifact */ + metadataArtifact?: (string|null); } /** Represents a Dataset. */ @@ -80049,9 +81644,15 @@ export namespace google { /** Dataset labels. */ public labels: { [k: string]: string }; + /** Dataset savedQueries. */ + public savedQueries: google.cloud.aiplatform.v1beta1.ISavedQuery[]; + /** Dataset encryptionSpec. */ public encryptionSpec?: (google.cloud.aiplatform.v1beta1.IEncryptionSpec|null); + /** Dataset metadataArtifact. */ + public metadataArtifact: string; + /** * Creates a new Dataset instance using the specified properties. * @param [properties] Properties to set @@ -80139,6 +81740,9 @@ export namespace google { /** ImportDataConfig dataItemLabels */ dataItemLabels?: ({ [k: string]: string }|null); + /** ImportDataConfig annotationLabels */ + annotationLabels?: ({ [k: string]: string }|null); + /** ImportDataConfig importSchemaUri */ importSchemaUri?: (string|null); } @@ -80158,6 +81762,9 @@ export namespace google { /** ImportDataConfig dataItemLabels. */ public dataItemLabels: { [k: string]: string }; + /** ImportDataConfig annotationLabels. */ + public annotationLabels: { [k: string]: string }; + /** ImportDataConfig importSchemaUri. */ public importSchemaUri: string; @@ -80348,6 +81955,157 @@ export namespace google { public static getTypeUrl(typeUrlPrefix?: string): string; } + /** Properties of a SavedQuery. */ + interface ISavedQuery { + + /** SavedQuery name */ + name?: (string|null); + + /** SavedQuery displayName */ + displayName?: (string|null); + + /** SavedQuery metadata */ + metadata?: (google.protobuf.IValue|null); + + /** SavedQuery createTime */ + createTime?: (google.protobuf.ITimestamp|null); + + /** SavedQuery updateTime */ + updateTime?: (google.protobuf.ITimestamp|null); + + /** SavedQuery annotationFilter */ + annotationFilter?: (string|null); + + /** SavedQuery problemType */ + problemType?: (string|null); + + /** SavedQuery annotationSpecCount */ + annotationSpecCount?: (number|null); + + /** SavedQuery etag */ + etag?: (string|null); + + /** SavedQuery supportAutomlTraining */ + supportAutomlTraining?: (boolean|null); + } + + /** Represents a SavedQuery. */ + class SavedQuery implements ISavedQuery { + + /** + * Constructs a new SavedQuery. + * @param [properties] Properties to set + */ + constructor(properties?: google.cloud.aiplatform.v1beta1.ISavedQuery); + + /** SavedQuery name. */ + public name: string; + + /** SavedQuery displayName. */ + public displayName: string; + + /** SavedQuery metadata. */ + public metadata?: (google.protobuf.IValue|null); + + /** SavedQuery createTime. */ + public createTime?: (google.protobuf.ITimestamp|null); + + /** SavedQuery updateTime. */ + public updateTime?: (google.protobuf.ITimestamp|null); + + /** SavedQuery annotationFilter. */ + public annotationFilter: string; + + /** SavedQuery problemType. */ + public problemType: string; + + /** SavedQuery annotationSpecCount. */ + public annotationSpecCount: number; + + /** SavedQuery etag. */ + public etag: string; + + /** SavedQuery supportAutomlTraining. */ + public supportAutomlTraining: boolean; + + /** + * Creates a new SavedQuery instance using the specified properties. + * @param [properties] Properties to set + * @returns SavedQuery instance + */ + public static create(properties?: google.cloud.aiplatform.v1beta1.ISavedQuery): google.cloud.aiplatform.v1beta1.SavedQuery; + + /** + * Encodes the specified SavedQuery message. Does not implicitly {@link google.cloud.aiplatform.v1beta1.SavedQuery.verify|verify} messages. + * @param message SavedQuery message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encode(message: google.cloud.aiplatform.v1beta1.ISavedQuery, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Encodes the specified SavedQuery message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1beta1.SavedQuery.verify|verify} messages. + * @param message SavedQuery message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encodeDelimited(message: google.cloud.aiplatform.v1beta1.ISavedQuery, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Decodes a SavedQuery message from the specified reader or buffer. + * @param reader Reader or buffer to decode from + * @param [length] Message length if known beforehand + * @returns SavedQuery + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1beta1.SavedQuery; + + /** + * Decodes a SavedQuery message from the specified reader or buffer, length delimited. + * @param reader Reader or buffer to decode from + * @returns SavedQuery + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1beta1.SavedQuery; + + /** + * Verifies a SavedQuery message. + * @param message Plain object to verify + * @returns `null` if valid, otherwise the reason why it is not + */ + public static verify(message: { [k: string]: any }): (string|null); + + /** + * Creates a SavedQuery message from a plain object. Also converts values to their respective internal types. + * @param object Plain object + * @returns SavedQuery + */ + public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1beta1.SavedQuery; + + /** + * Creates a plain object from a SavedQuery message. Also converts values to other types if specified. + * @param message SavedQuery + * @param [options] Conversion options + * @returns Plain object + */ + public static toObject(message: google.cloud.aiplatform.v1beta1.SavedQuery, options?: $protobuf.IConversionOptions): { [k: string]: any }; + + /** + * Converts this SavedQuery to JSON. + * @returns JSON object + */ + public toJSON(): { [k: string]: any }; + + /** + * Gets the default type url for SavedQuery + * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns The default type url + */ + public static getTypeUrl(typeUrlPrefix?: string): string; + } + /** Represents a DatasetService */ class DatasetService extends $protobuf.rpc.Service { @@ -80480,6 +82238,20 @@ export namespace google { */ public listDataItems(request: google.cloud.aiplatform.v1beta1.IListDataItemsRequest): Promise; + /** + * Calls SearchDataItems. + * @param request SearchDataItemsRequest message or plain object + * @param callback Node-style callback called with the error, if any, and SearchDataItemsResponse + */ + public searchDataItems(request: google.cloud.aiplatform.v1beta1.ISearchDataItemsRequest, callback: google.cloud.aiplatform.v1beta1.DatasetService.SearchDataItemsCallback): void; + + /** + * Calls SearchDataItems. + * @param request SearchDataItemsRequest message or plain object + * @returns Promise + */ + public searchDataItems(request: google.cloud.aiplatform.v1beta1.ISearchDataItemsRequest): Promise; + /** * Calls ListSavedQueries. * @param request ListSavedQueriesRequest message or plain object @@ -80581,6 +82353,13 @@ export namespace google { */ type ListDataItemsCallback = (error: (Error|null), response?: google.cloud.aiplatform.v1beta1.ListDataItemsResponse) => void; + /** + * Callback as used by {@link google.cloud.aiplatform.v1beta1.DatasetService|searchDataItems}. + * @param error Error, if any + * @param [response] SearchDataItemsResponse + */ + type SearchDataItemsCallback = (error: (Error|null), response?: google.cloud.aiplatform.v1beta1.SearchDataItemsResponse) => void; + /** * Callback as used by {@link google.cloud.aiplatform.v1beta1.DatasetService|listSavedQueries}. * @param error Error, if any @@ -82160,6 +83939,496 @@ export namespace google { public static getTypeUrl(typeUrlPrefix?: string): string; } + /** Properties of a SearchDataItemsRequest. */ + interface ISearchDataItemsRequest { + + /** SearchDataItemsRequest orderByDataItem */ + orderByDataItem?: (string|null); + + /** SearchDataItemsRequest orderByAnnotation */ + orderByAnnotation?: (google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.IOrderByAnnotation|null); + + /** SearchDataItemsRequest dataset */ + dataset?: (string|null); + + /** SearchDataItemsRequest savedQuery */ + savedQuery?: (string|null); + + /** SearchDataItemsRequest dataLabelingJob */ + dataLabelingJob?: (string|null); + + /** SearchDataItemsRequest dataItemFilter */ + dataItemFilter?: (string|null); + + /** SearchDataItemsRequest annotationsFilter */ + annotationsFilter?: (string|null); + + /** SearchDataItemsRequest annotationFilters */ + annotationFilters?: (string[]|null); + + /** SearchDataItemsRequest fieldMask */ + fieldMask?: (google.protobuf.IFieldMask|null); + + /** SearchDataItemsRequest annotationsLimit */ + annotationsLimit?: (number|null); + + /** SearchDataItemsRequest pageSize */ + pageSize?: (number|null); + + /** SearchDataItemsRequest orderBy */ + orderBy?: (string|null); + + /** SearchDataItemsRequest pageToken */ + pageToken?: (string|null); + } + + /** Represents a SearchDataItemsRequest. */ + class SearchDataItemsRequest implements ISearchDataItemsRequest { + + /** + * Constructs a new SearchDataItemsRequest. + * @param [properties] Properties to set + */ + constructor(properties?: google.cloud.aiplatform.v1beta1.ISearchDataItemsRequest); + + /** SearchDataItemsRequest orderByDataItem. */ + public orderByDataItem?: (string|null); + + /** SearchDataItemsRequest orderByAnnotation. */ + public orderByAnnotation?: (google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.IOrderByAnnotation|null); + + /** SearchDataItemsRequest dataset. */ + public dataset: string; + + /** SearchDataItemsRequest savedQuery. */ + public savedQuery: string; + + /** SearchDataItemsRequest dataLabelingJob. */ + public dataLabelingJob: string; + + /** SearchDataItemsRequest dataItemFilter. */ + public dataItemFilter: string; + + /** SearchDataItemsRequest annotationsFilter. */ + public annotationsFilter: string; + + /** SearchDataItemsRequest annotationFilters. */ + public annotationFilters: string[]; + + /** SearchDataItemsRequest fieldMask. */ + public fieldMask?: (google.protobuf.IFieldMask|null); + + /** SearchDataItemsRequest annotationsLimit. */ + public annotationsLimit: number; + + /** SearchDataItemsRequest pageSize. */ + public pageSize: number; + + /** SearchDataItemsRequest orderBy. */ + public orderBy: string; + + /** SearchDataItemsRequest pageToken. */ + public pageToken: string; + + /** SearchDataItemsRequest order. */ + public order?: ("orderByDataItem"|"orderByAnnotation"); + + /** + * Creates a new SearchDataItemsRequest instance using the specified properties. + * @param [properties] Properties to set + * @returns SearchDataItemsRequest instance + */ + public static create(properties?: google.cloud.aiplatform.v1beta1.ISearchDataItemsRequest): google.cloud.aiplatform.v1beta1.SearchDataItemsRequest; + + /** + * Encodes the specified SearchDataItemsRequest message. Does not implicitly {@link google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.verify|verify} messages. + * @param message SearchDataItemsRequest message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encode(message: google.cloud.aiplatform.v1beta1.ISearchDataItemsRequest, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Encodes the specified SearchDataItemsRequest message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.verify|verify} messages. + * @param message SearchDataItemsRequest message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encodeDelimited(message: google.cloud.aiplatform.v1beta1.ISearchDataItemsRequest, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Decodes a SearchDataItemsRequest message from the specified reader or buffer. + * @param reader Reader or buffer to decode from + * @param [length] Message length if known beforehand + * @returns SearchDataItemsRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1beta1.SearchDataItemsRequest; + + /** + * Decodes a SearchDataItemsRequest message from the specified reader or buffer, length delimited. + * @param reader Reader or buffer to decode from + * @returns SearchDataItemsRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1beta1.SearchDataItemsRequest; + + /** + * Verifies a SearchDataItemsRequest message. + * @param message Plain object to verify + * @returns `null` if valid, otherwise the reason why it is not + */ + public static verify(message: { [k: string]: any }): (string|null); + + /** + * Creates a SearchDataItemsRequest message from a plain object. Also converts values to their respective internal types. + * @param object Plain object + * @returns SearchDataItemsRequest + */ + public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1beta1.SearchDataItemsRequest; + + /** + * Creates a plain object from a SearchDataItemsRequest message. Also converts values to other types if specified. + * @param message SearchDataItemsRequest + * @param [options] Conversion options + * @returns Plain object + */ + public static toObject(message: google.cloud.aiplatform.v1beta1.SearchDataItemsRequest, options?: $protobuf.IConversionOptions): { [k: string]: any }; + + /** + * Converts this SearchDataItemsRequest to JSON. + * @returns JSON object + */ + public toJSON(): { [k: string]: any }; + + /** + * Gets the default type url for SearchDataItemsRequest + * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns The default type url + */ + public static getTypeUrl(typeUrlPrefix?: string): string; + } + + namespace SearchDataItemsRequest { + + /** Properties of an OrderByAnnotation. */ + interface IOrderByAnnotation { + + /** OrderByAnnotation savedQuery */ + savedQuery?: (string|null); + + /** OrderByAnnotation orderBy */ + orderBy?: (string|null); + } + + /** Represents an OrderByAnnotation. */ + class OrderByAnnotation implements IOrderByAnnotation { + + /** + * Constructs a new OrderByAnnotation. + * @param [properties] Properties to set + */ + constructor(properties?: google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.IOrderByAnnotation); + + /** OrderByAnnotation savedQuery. */ + public savedQuery: string; + + /** OrderByAnnotation orderBy. */ + public orderBy: string; + + /** + * Creates a new OrderByAnnotation instance using the specified properties. + * @param [properties] Properties to set + * @returns OrderByAnnotation instance + */ + public static create(properties?: google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.IOrderByAnnotation): google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation; + + /** + * Encodes the specified OrderByAnnotation message. Does not implicitly {@link google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation.verify|verify} messages. + * @param message OrderByAnnotation message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encode(message: google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.IOrderByAnnotation, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Encodes the specified OrderByAnnotation message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation.verify|verify} messages. + * @param message OrderByAnnotation message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encodeDelimited(message: google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.IOrderByAnnotation, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Decodes an OrderByAnnotation message from the specified reader or buffer. + * @param reader Reader or buffer to decode from + * @param [length] Message length if known beforehand + * @returns OrderByAnnotation + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation; + + /** + * Decodes an OrderByAnnotation message from the specified reader or buffer, length delimited. + * @param reader Reader or buffer to decode from + * @returns OrderByAnnotation + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation; + + /** + * Verifies an OrderByAnnotation message. + * @param message Plain object to verify + * @returns `null` if valid, otherwise the reason why it is not + */ + public static verify(message: { [k: string]: any }): (string|null); + + /** + * Creates an OrderByAnnotation message from a plain object. Also converts values to their respective internal types. + * @param object Plain object + * @returns OrderByAnnotation + */ + public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation; + + /** + * Creates a plain object from an OrderByAnnotation message. Also converts values to other types if specified. + * @param message OrderByAnnotation + * @param [options] Conversion options + * @returns Plain object + */ + public static toObject(message: google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation, options?: $protobuf.IConversionOptions): { [k: string]: any }; + + /** + * Converts this OrderByAnnotation to JSON. + * @returns JSON object + */ + public toJSON(): { [k: string]: any }; + + /** + * Gets the default type url for OrderByAnnotation + * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns The default type url + */ + public static getTypeUrl(typeUrlPrefix?: string): string; + } + } + + /** Properties of a SearchDataItemsResponse. */ + interface ISearchDataItemsResponse { + + /** SearchDataItemsResponse dataItemViews */ + dataItemViews?: (google.cloud.aiplatform.v1beta1.IDataItemView[]|null); + + /** SearchDataItemsResponse nextPageToken */ + nextPageToken?: (string|null); + } + + /** Represents a SearchDataItemsResponse. */ + class SearchDataItemsResponse implements ISearchDataItemsResponse { + + /** + * Constructs a new SearchDataItemsResponse. + * @param [properties] Properties to set + */ + constructor(properties?: google.cloud.aiplatform.v1beta1.ISearchDataItemsResponse); + + /** SearchDataItemsResponse dataItemViews. */ + public dataItemViews: google.cloud.aiplatform.v1beta1.IDataItemView[]; + + /** SearchDataItemsResponse nextPageToken. */ + public nextPageToken: string; + + /** + * Creates a new SearchDataItemsResponse instance using the specified properties. + * @param [properties] Properties to set + * @returns SearchDataItemsResponse instance + */ + public static create(properties?: google.cloud.aiplatform.v1beta1.ISearchDataItemsResponse): google.cloud.aiplatform.v1beta1.SearchDataItemsResponse; + + /** + * Encodes the specified SearchDataItemsResponse message. Does not implicitly {@link google.cloud.aiplatform.v1beta1.SearchDataItemsResponse.verify|verify} messages. + * @param message SearchDataItemsResponse message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encode(message: google.cloud.aiplatform.v1beta1.ISearchDataItemsResponse, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Encodes the specified SearchDataItemsResponse message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1beta1.SearchDataItemsResponse.verify|verify} messages. + * @param message SearchDataItemsResponse message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encodeDelimited(message: google.cloud.aiplatform.v1beta1.ISearchDataItemsResponse, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Decodes a SearchDataItemsResponse message from the specified reader or buffer. + * @param reader Reader or buffer to decode from + * @param [length] Message length if known beforehand + * @returns SearchDataItemsResponse + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1beta1.SearchDataItemsResponse; + + /** + * Decodes a SearchDataItemsResponse message from the specified reader or buffer, length delimited. + * @param reader Reader or buffer to decode from + * @returns SearchDataItemsResponse + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1beta1.SearchDataItemsResponse; + + /** + * Verifies a SearchDataItemsResponse message. + * @param message Plain object to verify + * @returns `null` if valid, otherwise the reason why it is not + */ + public static verify(message: { [k: string]: any }): (string|null); + + /** + * Creates a SearchDataItemsResponse message from a plain object. Also converts values to their respective internal types. + * @param object Plain object + * @returns SearchDataItemsResponse + */ + public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1beta1.SearchDataItemsResponse; + + /** + * Creates a plain object from a SearchDataItemsResponse message. Also converts values to other types if specified. + * @param message SearchDataItemsResponse + * @param [options] Conversion options + * @returns Plain object + */ + public static toObject(message: google.cloud.aiplatform.v1beta1.SearchDataItemsResponse, options?: $protobuf.IConversionOptions): { [k: string]: any }; + + /** + * Converts this SearchDataItemsResponse to JSON. + * @returns JSON object + */ + public toJSON(): { [k: string]: any }; + + /** + * Gets the default type url for SearchDataItemsResponse + * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns The default type url + */ + public static getTypeUrl(typeUrlPrefix?: string): string; + } + + /** Properties of a DataItemView. */ + interface IDataItemView { + + /** DataItemView dataItem */ + dataItem?: (google.cloud.aiplatform.v1beta1.IDataItem|null); + + /** DataItemView annotations */ + annotations?: (google.cloud.aiplatform.v1beta1.IAnnotation[]|null); + + /** DataItemView hasTruncatedAnnotations */ + hasTruncatedAnnotations?: (boolean|null); + } + + /** Represents a DataItemView. */ + class DataItemView implements IDataItemView { + + /** + * Constructs a new DataItemView. + * @param [properties] Properties to set + */ + constructor(properties?: google.cloud.aiplatform.v1beta1.IDataItemView); + + /** DataItemView dataItem. */ + public dataItem?: (google.cloud.aiplatform.v1beta1.IDataItem|null); + + /** DataItemView annotations. */ + public annotations: google.cloud.aiplatform.v1beta1.IAnnotation[]; + + /** DataItemView hasTruncatedAnnotations. */ + public hasTruncatedAnnotations: boolean; + + /** + * Creates a new DataItemView instance using the specified properties. + * @param [properties] Properties to set + * @returns DataItemView instance + */ + public static create(properties?: google.cloud.aiplatform.v1beta1.IDataItemView): google.cloud.aiplatform.v1beta1.DataItemView; + + /** + * Encodes the specified DataItemView message. Does not implicitly {@link google.cloud.aiplatform.v1beta1.DataItemView.verify|verify} messages. + * @param message DataItemView message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encode(message: google.cloud.aiplatform.v1beta1.IDataItemView, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Encodes the specified DataItemView message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1beta1.DataItemView.verify|verify} messages. + * @param message DataItemView message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encodeDelimited(message: google.cloud.aiplatform.v1beta1.IDataItemView, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Decodes a DataItemView message from the specified reader or buffer. + * @param reader Reader or buffer to decode from + * @param [length] Message length if known beforehand + * @returns DataItemView + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1beta1.DataItemView; + + /** + * Decodes a DataItemView message from the specified reader or buffer, length delimited. + * @param reader Reader or buffer to decode from + * @returns DataItemView + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1beta1.DataItemView; + + /** + * Verifies a DataItemView message. + * @param message Plain object to verify + * @returns `null` if valid, otherwise the reason why it is not + */ + public static verify(message: { [k: string]: any }): (string|null); + + /** + * Creates a DataItemView message from a plain object. Also converts values to their respective internal types. + * @param object Plain object + * @returns DataItemView + */ + public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1beta1.DataItemView; + + /** + * Creates a plain object from a DataItemView message. Also converts values to other types if specified. + * @param message DataItemView + * @param [options] Conversion options + * @returns Plain object + */ + public static toObject(message: google.cloud.aiplatform.v1beta1.DataItemView, options?: $protobuf.IConversionOptions): { [k: string]: any }; + + /** + * Converts this DataItemView to JSON. + * @returns JSON object + */ + public toJSON(): { [k: string]: any }; + + /** + * Gets the default type url for DataItemView + * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns The default type url + */ + public static getTypeUrl(typeUrlPrefix?: string): string; + } + /** Properties of a ListSavedQueriesRequest. */ interface IListSavedQueriesRequest { @@ -82929,157 +85198,6 @@ export namespace google { public static getTypeUrl(typeUrlPrefix?: string): string; } - /** Properties of a SavedQuery. */ - interface ISavedQuery { - - /** SavedQuery name */ - name?: (string|null); - - /** SavedQuery displayName */ - displayName?: (string|null); - - /** SavedQuery metadata */ - metadata?: (google.protobuf.IValue|null); - - /** SavedQuery createTime */ - createTime?: (google.protobuf.ITimestamp|null); - - /** SavedQuery updateTime */ - updateTime?: (google.protobuf.ITimestamp|null); - - /** SavedQuery annotationFilter */ - annotationFilter?: (string|null); - - /** SavedQuery problemType */ - problemType?: (string|null); - - /** SavedQuery annotationSpecCount */ - annotationSpecCount?: (number|null); - - /** SavedQuery etag */ - etag?: (string|null); - - /** SavedQuery supportAutomlTraining */ - supportAutomlTraining?: (boolean|null); - } - - /** Represents a SavedQuery. */ - class SavedQuery implements ISavedQuery { - - /** - * Constructs a new SavedQuery. - * @param [properties] Properties to set - */ - constructor(properties?: google.cloud.aiplatform.v1beta1.ISavedQuery); - - /** SavedQuery name. */ - public name: string; - - /** SavedQuery displayName. */ - public displayName: string; - - /** SavedQuery metadata. */ - public metadata?: (google.protobuf.IValue|null); - - /** SavedQuery createTime. */ - public createTime?: (google.protobuf.ITimestamp|null); - - /** SavedQuery updateTime. */ - public updateTime?: (google.protobuf.ITimestamp|null); - - /** SavedQuery annotationFilter. */ - public annotationFilter: string; - - /** SavedQuery problemType. */ - public problemType: string; - - /** SavedQuery annotationSpecCount. */ - public annotationSpecCount: number; - - /** SavedQuery etag. */ - public etag: string; - - /** SavedQuery supportAutomlTraining. */ - public supportAutomlTraining: boolean; - - /** - * Creates a new SavedQuery instance using the specified properties. - * @param [properties] Properties to set - * @returns SavedQuery instance - */ - public static create(properties?: google.cloud.aiplatform.v1beta1.ISavedQuery): google.cloud.aiplatform.v1beta1.SavedQuery; - - /** - * Encodes the specified SavedQuery message. Does not implicitly {@link google.cloud.aiplatform.v1beta1.SavedQuery.verify|verify} messages. - * @param message SavedQuery message or plain object to encode - * @param [writer] Writer to encode to - * @returns Writer - */ - public static encode(message: google.cloud.aiplatform.v1beta1.ISavedQuery, writer?: $protobuf.Writer): $protobuf.Writer; - - /** - * Encodes the specified SavedQuery message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1beta1.SavedQuery.verify|verify} messages. - * @param message SavedQuery message or plain object to encode - * @param [writer] Writer to encode to - * @returns Writer - */ - public static encodeDelimited(message: google.cloud.aiplatform.v1beta1.ISavedQuery, writer?: $protobuf.Writer): $protobuf.Writer; - - /** - * Decodes a SavedQuery message from the specified reader or buffer. - * @param reader Reader or buffer to decode from - * @param [length] Message length if known beforehand - * @returns SavedQuery - * @throws {Error} If the payload is not a reader or valid buffer - * @throws {$protobuf.util.ProtocolError} If required fields are missing - */ - public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1beta1.SavedQuery; - - /** - * Decodes a SavedQuery message from the specified reader or buffer, length delimited. - * @param reader Reader or buffer to decode from - * @returns SavedQuery - * @throws {Error} If the payload is not a reader or valid buffer - * @throws {$protobuf.util.ProtocolError} If required fields are missing - */ - public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1beta1.SavedQuery; - - /** - * Verifies a SavedQuery message. - * @param message Plain object to verify - * @returns `null` if valid, otherwise the reason why it is not - */ - public static verify(message: { [k: string]: any }): (string|null); - - /** - * Creates a SavedQuery message from a plain object. Also converts values to their respective internal types. - * @param object Plain object - * @returns SavedQuery - */ - public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1beta1.SavedQuery; - - /** - * Creates a plain object from a SavedQuery message. Also converts values to other types if specified. - * @param message SavedQuery - * @param [options] Conversion options - * @returns Plain object - */ - public static toObject(message: google.cloud.aiplatform.v1beta1.SavedQuery, options?: $protobuf.IConversionOptions): { [k: string]: any }; - - /** - * Converts this SavedQuery to JSON. - * @returns JSON object - */ - public toJSON(): { [k: string]: any }; - - /** - * Gets the default type url for SavedQuery - * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") - * @returns The default type url - */ - public static getTypeUrl(typeUrlPrefix?: string): string; - } - /** Properties of a DeployedIndexRef. */ interface IDeployedIndexRef { @@ -84250,6 +86368,12 @@ export namespace google { /** QueryDeployedModelsResponse deployedModelRefs */ deployedModelRefs?: (google.cloud.aiplatform.v1beta1.IDeployedModelRef[]|null); + + /** QueryDeployedModelsResponse totalDeployedModelCount */ + totalDeployedModelCount?: (number|null); + + /** QueryDeployedModelsResponse totalEndpointCount */ + totalEndpointCount?: (number|null); } /** Represents a QueryDeployedModelsResponse. */ @@ -84270,6 +86394,12 @@ export namespace google { /** QueryDeployedModelsResponse deployedModelRefs. */ public deployedModelRefs: google.cloud.aiplatform.v1beta1.IDeployedModelRef[]; + /** QueryDeployedModelsResponse totalDeployedModelCount. */ + public totalDeployedModelCount: number; + + /** QueryDeployedModelsResponse totalEndpointCount. */ + public totalEndpointCount: number; + /** * Creates a new QueryDeployedModelsResponse instance using the specified properties. * @param [properties] Properties to set @@ -86440,6 +88570,9 @@ export namespace google { /** EntityType monitoringConfig */ monitoringConfig?: (google.cloud.aiplatform.v1beta1.IFeaturestoreMonitoringConfig|null); + + /** EntityType offlineStorageTtlDays */ + offlineStorageTtlDays?: (number|null); } /** Represents an EntityType. */ @@ -86472,6 +88605,9 @@ export namespace google { /** EntityType monitoringConfig. */ public monitoringConfig?: (google.cloud.aiplatform.v1beta1.IFeaturestoreMonitoringConfig|null); + /** EntityType offlineStorageTtlDays. */ + public offlineStorageTtlDays: number; + /** * Creates a new EntityType instance using the specified properties. * @param [properties] Properties to set @@ -87812,6 +89948,9 @@ export namespace google { /** Featurestore state */ state?: (google.cloud.aiplatform.v1beta1.Featurestore.State|keyof typeof google.cloud.aiplatform.v1beta1.Featurestore.State|null); + /** Featurestore onlineStorageTtlDays */ + onlineStorageTtlDays?: (number|null); + /** Featurestore encryptionSpec */ encryptionSpec?: (google.cloud.aiplatform.v1beta1.IEncryptionSpec|null); } @@ -87846,6 +89985,9 @@ export namespace google { /** Featurestore state. */ public state: (google.cloud.aiplatform.v1beta1.Featurestore.State|keyof typeof google.cloud.aiplatform.v1beta1.Featurestore.State); + /** Featurestore onlineStorageTtlDays. */ + public onlineStorageTtlDays: number; + /** Featurestore encryptionSpec. */ public encryptionSpec?: (google.cloud.aiplatform.v1beta1.IEncryptionSpec|null); @@ -91516,6 +93658,9 @@ export namespace google { /** BatchReadFeatureValuesRequest entityTypeSpecs */ entityTypeSpecs?: (google.cloud.aiplatform.v1beta1.BatchReadFeatureValuesRequest.IEntityTypeSpec[]|null); + + /** BatchReadFeatureValuesRequest startTime */ + startTime?: (google.protobuf.ITimestamp|null); } /** Represents a BatchReadFeatureValuesRequest. */ @@ -91545,6 +93690,9 @@ export namespace google { /** BatchReadFeatureValuesRequest entityTypeSpecs. */ public entityTypeSpecs: google.cloud.aiplatform.v1beta1.BatchReadFeatureValuesRequest.IEntityTypeSpec[]; + /** BatchReadFeatureValuesRequest startTime. */ + public startTime?: (google.protobuf.ITimestamp|null); + /** BatchReadFeatureValuesRequest readOption. */ public readOption?: ("csvReadInstances"|"bigqueryReadInstances"); @@ -94479,6 +96627,9 @@ export namespace google { /** ImportFeatureValuesOperationMetadata importedFeatureValueCount */ importedFeatureValueCount?: (number|Long|string|null); + /** ImportFeatureValuesOperationMetadata sourceUris */ + sourceUris?: (string[]|null); + /** ImportFeatureValuesOperationMetadata invalidRowCount */ invalidRowCount?: (number|Long|string|null); @@ -94504,6 +96655,9 @@ export namespace google { /** ImportFeatureValuesOperationMetadata importedFeatureValueCount. */ public importedFeatureValueCount: (number|Long|string); + /** ImportFeatureValuesOperationMetadata sourceUris. */ + public sourceUris: string[]; + /** ImportFeatureValuesOperationMetadata invalidRowCount. */ public invalidRowCount: (number|Long|string); @@ -97767,6 +99921,9 @@ export namespace google { /** ConvexAutomatedStoppingSpec useElapsedDuration */ useElapsedDuration?: (boolean|null); + + /** ConvexAutomatedStoppingSpec updateAllStoppedTrials */ + updateAllStoppedTrials?: (boolean|null); } /** Represents a ConvexAutomatedStoppingSpec. */ @@ -97793,6 +99950,12 @@ export namespace google { /** ConvexAutomatedStoppingSpec useElapsedDuration. */ public useElapsedDuration: boolean; + /** ConvexAutomatedStoppingSpec updateAllStoppedTrials. */ + public updateAllStoppedTrials?: (boolean|null); + + /** ConvexAutomatedStoppingSpec _updateAllStoppedTrials. */ + public _updateAllStoppedTrials?: "updateAllStoppedTrials"; + /** * Creates a new ConvexAutomatedStoppingSpec instance using the specified properties. * @param [properties] Properties to set @@ -116688,6 +118851,9 @@ export namespace google { /** UploadModelRequest model */ model?: (google.cloud.aiplatform.v1beta1.IModel|null); + + /** UploadModelRequest serviceAccount */ + serviceAccount?: (string|null); } /** Represents an UploadModelRequest. */ @@ -116711,6 +118877,9 @@ export namespace google { /** UploadModelRequest model. */ public model?: (google.cloud.aiplatform.v1beta1.IModel|null); + /** UploadModelRequest serviceAccount. */ + public serviceAccount: string; + /** * Creates a new UploadModelRequest instance using the specified properties. * @param [properties] Properties to set @@ -117327,6 +119496,9 @@ export namespace google { /** ListModelVersionsRequest readMask */ readMask?: (google.protobuf.IFieldMask|null); + + /** ListModelVersionsRequest orderBy */ + orderBy?: (string|null); } /** Represents a ListModelVersionsRequest. */ @@ -117353,6 +119525,9 @@ export namespace google { /** ListModelVersionsRequest readMask. */ public readMask?: (google.protobuf.IFieldMask|null); + /** ListModelVersionsRequest orderBy. */ + public orderBy: string; + /** * Creates a new ListModelVersionsRequest instance using the specified properties. * @param [properties] Properties to set @@ -120826,6 +123001,12 @@ export namespace google { /** ContainerDetail preCachingCheckJob */ preCachingCheckJob?: (string|null); + + /** ContainerDetail failedMainJobs */ + failedMainJobs?: (string[]|null); + + /** ContainerDetail failedPreCachingCheckJobs */ + failedPreCachingCheckJobs?: (string[]|null); } /** Represents a ContainerDetail. */ @@ -120843,6 +123024,12 @@ export namespace google { /** ContainerDetail preCachingCheckJob. */ public preCachingCheckJob: string; + /** ContainerDetail failedMainJobs. */ + public failedMainJobs: string[]; + + /** ContainerDetail failedPreCachingCheckJobs. */ + public failedPreCachingCheckJobs: string[]; + /** * Creates a new ContainerDetail instance using the specified properties. * @param [properties] Properties to set @@ -122854,6 +125041,9 @@ export namespace google { /** InputDataConfig savedQueryId */ savedQueryId?: (string|null); + + /** InputDataConfig persistMlUseAssignment */ + persistMlUseAssignment?: (boolean|null); } /** Represents an InputDataConfig. */ @@ -122898,6 +125088,9 @@ export namespace google { /** InputDataConfig savedQueryId. */ public savedQueryId: string; + /** InputDataConfig persistMlUseAssignment. */ + public persistMlUseAssignment: boolean; + /** InputDataConfig split. */ public split?: ("fractionSplit"|"filterSplit"|"predefinedSplit"|"timestampSplit"|"stratifiedSplit"); @@ -137562,6 +139755,20 @@ export namespace google { */ public getTensorboard(request: google.cloud.aiplatform.v1beta1.IGetTensorboardRequest): Promise; + /** + * Calls ReadTensorboardUsage. + * @param request ReadTensorboardUsageRequest message or plain object + * @param callback Node-style callback called with the error, if any, and ReadTensorboardUsageResponse + */ + public readTensorboardUsage(request: google.cloud.aiplatform.v1beta1.IReadTensorboardUsageRequest, callback: google.cloud.aiplatform.v1beta1.TensorboardService.ReadTensorboardUsageCallback): void; + + /** + * Calls ReadTensorboardUsage. + * @param request ReadTensorboardUsageRequest message or plain object + * @returns Promise + */ + public readTensorboardUsage(request: google.cloud.aiplatform.v1beta1.IReadTensorboardUsageRequest): Promise; + /** * Calls UpdateTensorboard. * @param request UpdateTensorboardRequest message or plain object @@ -137943,6 +140150,13 @@ export namespace google { */ type GetTensorboardCallback = (error: (Error|null), response?: google.cloud.aiplatform.v1beta1.Tensorboard) => void; + /** + * Callback as used by {@link google.cloud.aiplatform.v1beta1.TensorboardService|readTensorboardUsage}. + * @param error Error, if any + * @param [response] ReadTensorboardUsageResponse + */ + type ReadTensorboardUsageCallback = (error: (Error|null), response?: google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse) => void; + /** * Callback as used by {@link google.cloud.aiplatform.v1beta1.TensorboardService|updateTensorboard}. * @param error Error, if any @@ -138326,6 +140540,403 @@ export namespace google { public static getTypeUrl(typeUrlPrefix?: string): string; } + /** Properties of a ReadTensorboardUsageRequest. */ + interface IReadTensorboardUsageRequest { + + /** ReadTensorboardUsageRequest tensorboard */ + tensorboard?: (string|null); + } + + /** Represents a ReadTensorboardUsageRequest. */ + class ReadTensorboardUsageRequest implements IReadTensorboardUsageRequest { + + /** + * Constructs a new ReadTensorboardUsageRequest. + * @param [properties] Properties to set + */ + constructor(properties?: google.cloud.aiplatform.v1beta1.IReadTensorboardUsageRequest); + + /** ReadTensorboardUsageRequest tensorboard. */ + public tensorboard: string; + + /** + * Creates a new ReadTensorboardUsageRequest instance using the specified properties. + * @param [properties] Properties to set + * @returns ReadTensorboardUsageRequest instance + */ + public static create(properties?: google.cloud.aiplatform.v1beta1.IReadTensorboardUsageRequest): google.cloud.aiplatform.v1beta1.ReadTensorboardUsageRequest; + + /** + * Encodes the specified ReadTensorboardUsageRequest message. Does not implicitly {@link google.cloud.aiplatform.v1beta1.ReadTensorboardUsageRequest.verify|verify} messages. + * @param message ReadTensorboardUsageRequest message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encode(message: google.cloud.aiplatform.v1beta1.IReadTensorboardUsageRequest, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Encodes the specified ReadTensorboardUsageRequest message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1beta1.ReadTensorboardUsageRequest.verify|verify} messages. + * @param message ReadTensorboardUsageRequest message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encodeDelimited(message: google.cloud.aiplatform.v1beta1.IReadTensorboardUsageRequest, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Decodes a ReadTensorboardUsageRequest message from the specified reader or buffer. + * @param reader Reader or buffer to decode from + * @param [length] Message length if known beforehand + * @returns ReadTensorboardUsageRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1beta1.ReadTensorboardUsageRequest; + + /** + * Decodes a ReadTensorboardUsageRequest message from the specified reader or buffer, length delimited. + * @param reader Reader or buffer to decode from + * @returns ReadTensorboardUsageRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1beta1.ReadTensorboardUsageRequest; + + /** + * Verifies a ReadTensorboardUsageRequest message. + * @param message Plain object to verify + * @returns `null` if valid, otherwise the reason why it is not + */ + public static verify(message: { [k: string]: any }): (string|null); + + /** + * Creates a ReadTensorboardUsageRequest message from a plain object. Also converts values to their respective internal types. + * @param object Plain object + * @returns ReadTensorboardUsageRequest + */ + public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1beta1.ReadTensorboardUsageRequest; + + /** + * Creates a plain object from a ReadTensorboardUsageRequest message. Also converts values to other types if specified. + * @param message ReadTensorboardUsageRequest + * @param [options] Conversion options + * @returns Plain object + */ + public static toObject(message: google.cloud.aiplatform.v1beta1.ReadTensorboardUsageRequest, options?: $protobuf.IConversionOptions): { [k: string]: any }; + + /** + * Converts this ReadTensorboardUsageRequest to JSON. + * @returns JSON object + */ + public toJSON(): { [k: string]: any }; + + /** + * Gets the default type url for ReadTensorboardUsageRequest + * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns The default type url + */ + public static getTypeUrl(typeUrlPrefix?: string): string; + } + + /** Properties of a ReadTensorboardUsageResponse. */ + interface IReadTensorboardUsageResponse { + + /** ReadTensorboardUsageResponse monthlyUsageData */ + monthlyUsageData?: ({ [k: string]: google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.IPerMonthUsageData }|null); + } + + /** Represents a ReadTensorboardUsageResponse. */ + class ReadTensorboardUsageResponse implements IReadTensorboardUsageResponse { + + /** + * Constructs a new ReadTensorboardUsageResponse. + * @param [properties] Properties to set + */ + constructor(properties?: google.cloud.aiplatform.v1beta1.IReadTensorboardUsageResponse); + + /** ReadTensorboardUsageResponse monthlyUsageData. */ + public monthlyUsageData: { [k: string]: google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.IPerMonthUsageData }; + + /** + * Creates a new ReadTensorboardUsageResponse instance using the specified properties. + * @param [properties] Properties to set + * @returns ReadTensorboardUsageResponse instance + */ + public static create(properties?: google.cloud.aiplatform.v1beta1.IReadTensorboardUsageResponse): google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse; + + /** + * Encodes the specified ReadTensorboardUsageResponse message. Does not implicitly {@link google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.verify|verify} messages. + * @param message ReadTensorboardUsageResponse message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encode(message: google.cloud.aiplatform.v1beta1.IReadTensorboardUsageResponse, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Encodes the specified ReadTensorboardUsageResponse message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.verify|verify} messages. + * @param message ReadTensorboardUsageResponse message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encodeDelimited(message: google.cloud.aiplatform.v1beta1.IReadTensorboardUsageResponse, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Decodes a ReadTensorboardUsageResponse message from the specified reader or buffer. + * @param reader Reader or buffer to decode from + * @param [length] Message length if known beforehand + * @returns ReadTensorboardUsageResponse + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse; + + /** + * Decodes a ReadTensorboardUsageResponse message from the specified reader or buffer, length delimited. + * @param reader Reader or buffer to decode from + * @returns ReadTensorboardUsageResponse + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse; + + /** + * Verifies a ReadTensorboardUsageResponse message. + * @param message Plain object to verify + * @returns `null` if valid, otherwise the reason why it is not + */ + public static verify(message: { [k: string]: any }): (string|null); + + /** + * Creates a ReadTensorboardUsageResponse message from a plain object. Also converts values to their respective internal types. + * @param object Plain object + * @returns ReadTensorboardUsageResponse + */ + public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse; + + /** + * Creates a plain object from a ReadTensorboardUsageResponse message. Also converts values to other types if specified. + * @param message ReadTensorboardUsageResponse + * @param [options] Conversion options + * @returns Plain object + */ + public static toObject(message: google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse, options?: $protobuf.IConversionOptions): { [k: string]: any }; + + /** + * Converts this ReadTensorboardUsageResponse to JSON. + * @returns JSON object + */ + public toJSON(): { [k: string]: any }; + + /** + * Gets the default type url for ReadTensorboardUsageResponse + * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns The default type url + */ + public static getTypeUrl(typeUrlPrefix?: string): string; + } + + namespace ReadTensorboardUsageResponse { + + /** Properties of a PerUserUsageData. */ + interface IPerUserUsageData { + + /** PerUserUsageData username */ + username?: (string|null); + + /** PerUserUsageData viewCount */ + viewCount?: (number|Long|string|null); + } + + /** Represents a PerUserUsageData. */ + class PerUserUsageData implements IPerUserUsageData { + + /** + * Constructs a new PerUserUsageData. + * @param [properties] Properties to set + */ + constructor(properties?: google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.IPerUserUsageData); + + /** PerUserUsageData username. */ + public username: string; + + /** PerUserUsageData viewCount. */ + public viewCount: (number|Long|string); + + /** + * Creates a new PerUserUsageData instance using the specified properties. + * @param [properties] Properties to set + * @returns PerUserUsageData instance + */ + public static create(properties?: google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.IPerUserUsageData): google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerUserUsageData; + + /** + * Encodes the specified PerUserUsageData message. Does not implicitly {@link google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerUserUsageData.verify|verify} messages. + * @param message PerUserUsageData message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encode(message: google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.IPerUserUsageData, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Encodes the specified PerUserUsageData message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerUserUsageData.verify|verify} messages. + * @param message PerUserUsageData message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encodeDelimited(message: google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.IPerUserUsageData, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Decodes a PerUserUsageData message from the specified reader or buffer. + * @param reader Reader or buffer to decode from + * @param [length] Message length if known beforehand + * @returns PerUserUsageData + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerUserUsageData; + + /** + * Decodes a PerUserUsageData message from the specified reader or buffer, length delimited. + * @param reader Reader or buffer to decode from + * @returns PerUserUsageData + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerUserUsageData; + + /** + * Verifies a PerUserUsageData message. + * @param message Plain object to verify + * @returns `null` if valid, otherwise the reason why it is not + */ + public static verify(message: { [k: string]: any }): (string|null); + + /** + * Creates a PerUserUsageData message from a plain object. Also converts values to their respective internal types. + * @param object Plain object + * @returns PerUserUsageData + */ + public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerUserUsageData; + + /** + * Creates a plain object from a PerUserUsageData message. Also converts values to other types if specified. + * @param message PerUserUsageData + * @param [options] Conversion options + * @returns Plain object + */ + public static toObject(message: google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerUserUsageData, options?: $protobuf.IConversionOptions): { [k: string]: any }; + + /** + * Converts this PerUserUsageData to JSON. + * @returns JSON object + */ + public toJSON(): { [k: string]: any }; + + /** + * Gets the default type url for PerUserUsageData + * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns The default type url + */ + public static getTypeUrl(typeUrlPrefix?: string): string; + } + + /** Properties of a PerMonthUsageData. */ + interface IPerMonthUsageData { + + /** PerMonthUsageData userUsageData */ + userUsageData?: (google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.IPerUserUsageData[]|null); + } + + /** Represents a PerMonthUsageData. */ + class PerMonthUsageData implements IPerMonthUsageData { + + /** + * Constructs a new PerMonthUsageData. + * @param [properties] Properties to set + */ + constructor(properties?: google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.IPerMonthUsageData); + + /** PerMonthUsageData userUsageData. */ + public userUsageData: google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.IPerUserUsageData[]; + + /** + * Creates a new PerMonthUsageData instance using the specified properties. + * @param [properties] Properties to set + * @returns PerMonthUsageData instance + */ + public static create(properties?: google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.IPerMonthUsageData): google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerMonthUsageData; + + /** + * Encodes the specified PerMonthUsageData message. Does not implicitly {@link google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerMonthUsageData.verify|verify} messages. + * @param message PerMonthUsageData message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encode(message: google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.IPerMonthUsageData, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Encodes the specified PerMonthUsageData message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerMonthUsageData.verify|verify} messages. + * @param message PerMonthUsageData message or plain object to encode + * @param [writer] Writer to encode to + * @returns Writer + */ + public static encodeDelimited(message: google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.IPerMonthUsageData, writer?: $protobuf.Writer): $protobuf.Writer; + + /** + * Decodes a PerMonthUsageData message from the specified reader or buffer. + * @param reader Reader or buffer to decode from + * @param [length] Message length if known beforehand + * @returns PerMonthUsageData + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerMonthUsageData; + + /** + * Decodes a PerMonthUsageData message from the specified reader or buffer, length delimited. + * @param reader Reader or buffer to decode from + * @returns PerMonthUsageData + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerMonthUsageData; + + /** + * Verifies a PerMonthUsageData message. + * @param message Plain object to verify + * @returns `null` if valid, otherwise the reason why it is not + */ + public static verify(message: { [k: string]: any }): (string|null); + + /** + * Creates a PerMonthUsageData message from a plain object. Also converts values to their respective internal types. + * @param object Plain object + * @returns PerMonthUsageData + */ + public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerMonthUsageData; + + /** + * Creates a plain object from a PerMonthUsageData message. Also converts values to other types if specified. + * @param message PerMonthUsageData + * @param [options] Conversion options + * @returns Plain object + */ + public static toObject(message: google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerMonthUsageData, options?: $protobuf.IConversionOptions): { [k: string]: any }; + + /** + * Converts this PerMonthUsageData to JSON. + * @returns JSON object + */ + public toJSON(): { [k: string]: any }; + + /** + * Gets the default type url for PerMonthUsageData + * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns The default type url + */ + public static getTypeUrl(typeUrlPrefix?: string): string; + } + } + /** Properties of a ListTensorboardsRequest. */ interface IListTensorboardsRequest { diff --git a/packages/google-cloud-aiplatform/protos/protos.js b/packages/google-cloud-aiplatform/protos/protos.js index 8477e63f695..9abbc2b61d4 100644 --- a/packages/google-cloud-aiplatform/protos/protos.js +++ b/packages/google-cloud-aiplatform/protos/protos.js @@ -1655,9 +1655,11 @@ * @property {string|null} [modelVersionId] BatchPredictionJob modelVersionId * @property {google.cloud.aiplatform.v1.IUnmanagedContainerModel|null} [unmanagedContainerModel] BatchPredictionJob unmanagedContainerModel * @property {google.cloud.aiplatform.v1.BatchPredictionJob.IInputConfig|null} [inputConfig] BatchPredictionJob inputConfig + * @property {google.cloud.aiplatform.v1.BatchPredictionJob.IInstanceConfig|null} [instanceConfig] BatchPredictionJob instanceConfig * @property {google.protobuf.IValue|null} [modelParameters] BatchPredictionJob modelParameters * @property {google.cloud.aiplatform.v1.BatchPredictionJob.IOutputConfig|null} [outputConfig] BatchPredictionJob outputConfig * @property {google.cloud.aiplatform.v1.IBatchDedicatedResources|null} [dedicatedResources] BatchPredictionJob dedicatedResources + * @property {string|null} [serviceAccount] BatchPredictionJob serviceAccount * @property {google.cloud.aiplatform.v1.IManualBatchTuningParameters|null} [manualBatchTuningParameters] BatchPredictionJob manualBatchTuningParameters * @property {boolean|null} [generateExplanation] BatchPredictionJob generateExplanation * @property {google.cloud.aiplatform.v1.IExplanationSpec|null} [explanationSpec] BatchPredictionJob explanationSpec @@ -1740,6 +1742,14 @@ */ BatchPredictionJob.prototype.inputConfig = null; + /** + * BatchPredictionJob instanceConfig. + * @member {google.cloud.aiplatform.v1.BatchPredictionJob.IInstanceConfig|null|undefined} instanceConfig + * @memberof google.cloud.aiplatform.v1.BatchPredictionJob + * @instance + */ + BatchPredictionJob.prototype.instanceConfig = null; + /** * BatchPredictionJob modelParameters. * @member {google.protobuf.IValue|null|undefined} modelParameters @@ -1764,6 +1774,14 @@ */ BatchPredictionJob.prototype.dedicatedResources = null; + /** + * BatchPredictionJob serviceAccount. + * @member {string} serviceAccount + * @memberof google.cloud.aiplatform.v1.BatchPredictionJob + * @instance + */ + BatchPredictionJob.prototype.serviceAccount = ""; + /** * BatchPredictionJob manualBatchTuningParameters. * @member {google.cloud.aiplatform.v1.IManualBatchTuningParameters|null|undefined} manualBatchTuningParameters @@ -1954,8 +1972,12 @@ $root.google.cloud.aiplatform.v1.EncryptionSpec.encode(message.encryptionSpec, writer.uint32(/* id 24, wireType 2 =*/194).fork()).ldelim(); if (message.explanationSpec != null && Object.hasOwnProperty.call(message, "explanationSpec")) $root.google.cloud.aiplatform.v1.ExplanationSpec.encode(message.explanationSpec, writer.uint32(/* id 25, wireType 2 =*/202).fork()).ldelim(); + if (message.instanceConfig != null && Object.hasOwnProperty.call(message, "instanceConfig")) + $root.google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.encode(message.instanceConfig, writer.uint32(/* id 27, wireType 2 =*/218).fork()).ldelim(); if (message.unmanagedContainerModel != null && Object.hasOwnProperty.call(message, "unmanagedContainerModel")) $root.google.cloud.aiplatform.v1.UnmanagedContainerModel.encode(message.unmanagedContainerModel, writer.uint32(/* id 28, wireType 2 =*/226).fork()).ldelim(); + if (message.serviceAccount != null && Object.hasOwnProperty.call(message, "serviceAccount")) + writer.uint32(/* id 29, wireType 2 =*/234).string(message.serviceAccount); if (message.modelVersionId != null && Object.hasOwnProperty.call(message, "modelVersionId")) writer.uint32(/* id 30, wireType 2 =*/242).string(message.modelVersionId); return writer; @@ -2016,6 +2038,10 @@ message.inputConfig = $root.google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.decode(reader, reader.uint32()); break; } + case 27: { + message.instanceConfig = $root.google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.decode(reader, reader.uint32()); + break; + } case 5: { message.modelParameters = $root.google.protobuf.Value.decode(reader, reader.uint32()); break; @@ -2028,6 +2054,10 @@ message.dedicatedResources = $root.google.cloud.aiplatform.v1.BatchDedicatedResources.decode(reader, reader.uint32()); break; } + case 29: { + message.serviceAccount = reader.string(); + break; + } case 8: { message.manualBatchTuningParameters = $root.google.cloud.aiplatform.v1.ManualBatchTuningParameters.decode(reader, reader.uint32()); break; @@ -2166,6 +2196,11 @@ if (error) return "inputConfig." + error; } + if (message.instanceConfig != null && message.hasOwnProperty("instanceConfig")) { + var error = $root.google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.verify(message.instanceConfig); + if (error) + return "instanceConfig." + error; + } if (message.modelParameters != null && message.hasOwnProperty("modelParameters")) { var error = $root.google.protobuf.Value.verify(message.modelParameters); if (error) @@ -2181,6 +2216,9 @@ if (error) return "dedicatedResources." + error; } + if (message.serviceAccount != null && message.hasOwnProperty("serviceAccount")) + if (!$util.isString(message.serviceAccount)) + return "serviceAccount: string expected"; if (message.manualBatchTuningParameters != null && message.hasOwnProperty("manualBatchTuningParameters")) { var error = $root.google.cloud.aiplatform.v1.ManualBatchTuningParameters.verify(message.manualBatchTuningParameters); if (error) @@ -2306,6 +2344,11 @@ throw TypeError(".google.cloud.aiplatform.v1.BatchPredictionJob.inputConfig: object expected"); message.inputConfig = $root.google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.fromObject(object.inputConfig); } + if (object.instanceConfig != null) { + if (typeof object.instanceConfig !== "object") + throw TypeError(".google.cloud.aiplatform.v1.BatchPredictionJob.instanceConfig: object expected"); + message.instanceConfig = $root.google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.fromObject(object.instanceConfig); + } if (object.modelParameters != null) { if (typeof object.modelParameters !== "object") throw TypeError(".google.cloud.aiplatform.v1.BatchPredictionJob.modelParameters: object expected"); @@ -2321,6 +2364,8 @@ throw TypeError(".google.cloud.aiplatform.v1.BatchPredictionJob.dedicatedResources: object expected"); message.dedicatedResources = $root.google.cloud.aiplatform.v1.BatchDedicatedResources.fromObject(object.dedicatedResources); } + if (object.serviceAccount != null) + message.serviceAccount = String(object.serviceAccount); if (object.manualBatchTuningParameters != null) { if (typeof object.manualBatchTuningParameters !== "object") throw TypeError(".google.cloud.aiplatform.v1.BatchPredictionJob.manualBatchTuningParameters: object expected"); @@ -2488,7 +2533,9 @@ object.generateExplanation = false; object.encryptionSpec = null; object.explanationSpec = null; + object.instanceConfig = null; object.unmanagedContainerModel = null; + object.serviceAccount = ""; object.modelVersionId = ""; } if (message.name != null && message.hasOwnProperty("name")) @@ -2542,8 +2589,12 @@ object.encryptionSpec = $root.google.cloud.aiplatform.v1.EncryptionSpec.toObject(message.encryptionSpec, options); if (message.explanationSpec != null && message.hasOwnProperty("explanationSpec")) object.explanationSpec = $root.google.cloud.aiplatform.v1.ExplanationSpec.toObject(message.explanationSpec, options); + if (message.instanceConfig != null && message.hasOwnProperty("instanceConfig")) + object.instanceConfig = $root.google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.toObject(message.instanceConfig, options); if (message.unmanagedContainerModel != null && message.hasOwnProperty("unmanagedContainerModel")) object.unmanagedContainerModel = $root.google.cloud.aiplatform.v1.UnmanagedContainerModel.toObject(message.unmanagedContainerModel, options); + if (message.serviceAccount != null && message.hasOwnProperty("serviceAccount")) + object.serviceAccount = message.serviceAccount; if (message.modelVersionId != null && message.hasOwnProperty("modelVersionId")) object.modelVersionId = message.modelVersionId; return object; @@ -2861,6 +2912,313 @@ return InputConfig; })(); + BatchPredictionJob.InstanceConfig = (function() { + + /** + * Properties of an InstanceConfig. + * @memberof google.cloud.aiplatform.v1.BatchPredictionJob + * @interface IInstanceConfig + * @property {string|null} [instanceType] InstanceConfig instanceType + * @property {string|null} [keyField] InstanceConfig keyField + * @property {Array.|null} [includedFields] InstanceConfig includedFields + * @property {Array.|null} [excludedFields] InstanceConfig excludedFields + */ + + /** + * Constructs a new InstanceConfig. + * @memberof google.cloud.aiplatform.v1.BatchPredictionJob + * @classdesc Represents an InstanceConfig. + * @implements IInstanceConfig + * @constructor + * @param {google.cloud.aiplatform.v1.BatchPredictionJob.IInstanceConfig=} [properties] Properties to set + */ + function InstanceConfig(properties) { + this.includedFields = []; + this.excludedFields = []; + if (properties) + for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) + if (properties[keys[i]] != null) + this[keys[i]] = properties[keys[i]]; + } + + /** + * InstanceConfig instanceType. + * @member {string} instanceType + * @memberof google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig + * @instance + */ + InstanceConfig.prototype.instanceType = ""; + + /** + * InstanceConfig keyField. + * @member {string} keyField + * @memberof google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig + * @instance + */ + InstanceConfig.prototype.keyField = ""; + + /** + * InstanceConfig includedFields. + * @member {Array.} includedFields + * @memberof google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig + * @instance + */ + InstanceConfig.prototype.includedFields = $util.emptyArray; + + /** + * InstanceConfig excludedFields. + * @member {Array.} excludedFields + * @memberof google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig + * @instance + */ + InstanceConfig.prototype.excludedFields = $util.emptyArray; + + /** + * Creates a new InstanceConfig instance using the specified properties. + * @function create + * @memberof google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig + * @static + * @param {google.cloud.aiplatform.v1.BatchPredictionJob.IInstanceConfig=} [properties] Properties to set + * @returns {google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig} InstanceConfig instance + */ + InstanceConfig.create = function create(properties) { + return new InstanceConfig(properties); + }; + + /** + * Encodes the specified InstanceConfig message. Does not implicitly {@link google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.verify|verify} messages. + * @function encode + * @memberof google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig + * @static + * @param {google.cloud.aiplatform.v1.BatchPredictionJob.IInstanceConfig} message InstanceConfig message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + InstanceConfig.encode = function encode(message, writer) { + if (!writer) + writer = $Writer.create(); + if (message.instanceType != null && Object.hasOwnProperty.call(message, "instanceType")) + writer.uint32(/* id 1, wireType 2 =*/10).string(message.instanceType); + if (message.keyField != null && Object.hasOwnProperty.call(message, "keyField")) + writer.uint32(/* id 2, wireType 2 =*/18).string(message.keyField); + if (message.includedFields != null && message.includedFields.length) + for (var i = 0; i < message.includedFields.length; ++i) + writer.uint32(/* id 3, wireType 2 =*/26).string(message.includedFields[i]); + if (message.excludedFields != null && message.excludedFields.length) + for (var i = 0; i < message.excludedFields.length; ++i) + writer.uint32(/* id 4, wireType 2 =*/34).string(message.excludedFields[i]); + return writer; + }; + + /** + * Encodes the specified InstanceConfig message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.verify|verify} messages. + * @function encodeDelimited + * @memberof google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig + * @static + * @param {google.cloud.aiplatform.v1.BatchPredictionJob.IInstanceConfig} message InstanceConfig message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + InstanceConfig.encodeDelimited = function encodeDelimited(message, writer) { + return this.encode(message, writer).ldelim(); + }; + + /** + * Decodes an InstanceConfig message from the specified reader or buffer. + * @function decode + * @memberof google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @param {number} [length] Message length if known beforehand + * @returns {google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig} InstanceConfig + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + InstanceConfig.decode = function decode(reader, length) { + if (!(reader instanceof $Reader)) + reader = $Reader.create(reader); + var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig(); + while (reader.pos < end) { + var tag = reader.uint32(); + switch (tag >>> 3) { + case 1: { + message.instanceType = reader.string(); + break; + } + case 2: { + message.keyField = reader.string(); + break; + } + case 3: { + if (!(message.includedFields && message.includedFields.length)) + message.includedFields = []; + message.includedFields.push(reader.string()); + break; + } + case 4: { + if (!(message.excludedFields && message.excludedFields.length)) + message.excludedFields = []; + message.excludedFields.push(reader.string()); + break; + } + default: + reader.skipType(tag & 7); + break; + } + } + return message; + }; + + /** + * Decodes an InstanceConfig message from the specified reader or buffer, length delimited. + * @function decodeDelimited + * @memberof google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @returns {google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig} InstanceConfig + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + InstanceConfig.decodeDelimited = function decodeDelimited(reader) { + if (!(reader instanceof $Reader)) + reader = new $Reader(reader); + return this.decode(reader, reader.uint32()); + }; + + /** + * Verifies an InstanceConfig message. + * @function verify + * @memberof google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig + * @static + * @param {Object.} message Plain object to verify + * @returns {string|null} `null` if valid, otherwise the reason why it is not + */ + InstanceConfig.verify = function verify(message) { + if (typeof message !== "object" || message === null) + return "object expected"; + if (message.instanceType != null && message.hasOwnProperty("instanceType")) + if (!$util.isString(message.instanceType)) + return "instanceType: string expected"; + if (message.keyField != null && message.hasOwnProperty("keyField")) + if (!$util.isString(message.keyField)) + return "keyField: string expected"; + if (message.includedFields != null && message.hasOwnProperty("includedFields")) { + if (!Array.isArray(message.includedFields)) + return "includedFields: array expected"; + for (var i = 0; i < message.includedFields.length; ++i) + if (!$util.isString(message.includedFields[i])) + return "includedFields: string[] expected"; + } + if (message.excludedFields != null && message.hasOwnProperty("excludedFields")) { + if (!Array.isArray(message.excludedFields)) + return "excludedFields: array expected"; + for (var i = 0; i < message.excludedFields.length; ++i) + if (!$util.isString(message.excludedFields[i])) + return "excludedFields: string[] expected"; + } + return null; + }; + + /** + * Creates an InstanceConfig message from a plain object. Also converts values to their respective internal types. + * @function fromObject + * @memberof google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig + * @static + * @param {Object.} object Plain object + * @returns {google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig} InstanceConfig + */ + InstanceConfig.fromObject = function fromObject(object) { + if (object instanceof $root.google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig) + return object; + var message = new $root.google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig(); + if (object.instanceType != null) + message.instanceType = String(object.instanceType); + if (object.keyField != null) + message.keyField = String(object.keyField); + if (object.includedFields) { + if (!Array.isArray(object.includedFields)) + throw TypeError(".google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.includedFields: array expected"); + message.includedFields = []; + for (var i = 0; i < object.includedFields.length; ++i) + message.includedFields[i] = String(object.includedFields[i]); + } + if (object.excludedFields) { + if (!Array.isArray(object.excludedFields)) + throw TypeError(".google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.excludedFields: array expected"); + message.excludedFields = []; + for (var i = 0; i < object.excludedFields.length; ++i) + message.excludedFields[i] = String(object.excludedFields[i]); + } + return message; + }; + + /** + * Creates a plain object from an InstanceConfig message. Also converts values to other types if specified. + * @function toObject + * @memberof google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig + * @static + * @param {google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig} message InstanceConfig + * @param {$protobuf.IConversionOptions} [options] Conversion options + * @returns {Object.} Plain object + */ + InstanceConfig.toObject = function toObject(message, options) { + if (!options) + options = {}; + var object = {}; + if (options.arrays || options.defaults) { + object.includedFields = []; + object.excludedFields = []; + } + if (options.defaults) { + object.instanceType = ""; + object.keyField = ""; + } + if (message.instanceType != null && message.hasOwnProperty("instanceType")) + object.instanceType = message.instanceType; + if (message.keyField != null && message.hasOwnProperty("keyField")) + object.keyField = message.keyField; + if (message.includedFields && message.includedFields.length) { + object.includedFields = []; + for (var j = 0; j < message.includedFields.length; ++j) + object.includedFields[j] = message.includedFields[j]; + } + if (message.excludedFields && message.excludedFields.length) { + object.excludedFields = []; + for (var j = 0; j < message.excludedFields.length; ++j) + object.excludedFields[j] = message.excludedFields[j]; + } + return object; + }; + + /** + * Converts this InstanceConfig to JSON. + * @function toJSON + * @memberof google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig + * @instance + * @returns {Object.} JSON object + */ + InstanceConfig.prototype.toJSON = function toJSON() { + return this.constructor.toObject(this, $protobuf.util.toJSONOptions); + }; + + /** + * Gets the default type url for InstanceConfig + * @function getTypeUrl + * @memberof google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig + * @static + * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns {string} The default type url + */ + InstanceConfig.getTypeUrl = function getTypeUrl(typeUrlPrefix) { + if (typeUrlPrefix === undefined) { + typeUrlPrefix = "type.googleapis.com"; + } + return typeUrlPrefix + "/google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig"; + }; + + return InstanceConfig; + })(); + BatchPredictionJob.OutputConfig = (function() { /** @@ -15084,6 +15442,7 @@ * @property {Object.|null} [labels] Model labels * @property {google.cloud.aiplatform.v1.IEncryptionSpec|null} [encryptionSpec] Model encryptionSpec * @property {google.cloud.aiplatform.v1.IModelSourceInfo|null} [modelSourceInfo] Model modelSourceInfo + * @property {string|null} [metadataArtifact] Model metadataArtifact */ /** @@ -15316,6 +15675,14 @@ */ Model.prototype.modelSourceInfo = null; + /** + * Model metadataArtifact. + * @member {string} metadataArtifact + * @memberof google.cloud.aiplatform.v1.Model + * @instance + */ + Model.prototype.metadataArtifact = ""; + /** * Creates a new Model instance using the specified properties. * @function create @@ -15402,6 +15769,8 @@ $root.google.protobuf.Timestamp.encode(message.versionUpdateTime, writer.uint32(/* id 32, wireType 2 =*/258).fork()).ldelim(); if (message.modelSourceInfo != null && Object.hasOwnProperty.call(message, "modelSourceInfo")) $root.google.cloud.aiplatform.v1.ModelSourceInfo.encode(message.modelSourceInfo, writer.uint32(/* id 38, wireType 2 =*/306).fork()).ldelim(); + if (message.metadataArtifact != null && Object.hasOwnProperty.call(message, "metadataArtifact")) + writer.uint32(/* id 44, wireType 2 =*/354).string(message.metadataArtifact); return writer; }; @@ -15576,6 +15945,10 @@ message.modelSourceInfo = $root.google.cloud.aiplatform.v1.ModelSourceInfo.decode(reader, reader.uint32()); break; } + case 44: { + message.metadataArtifact = reader.string(); + break; + } default: reader.skipType(tag & 7); break; @@ -15749,6 +16122,9 @@ if (error) return "modelSourceInfo." + error; } + if (message.metadataArtifact != null && message.hasOwnProperty("metadataArtifact")) + if (!$util.isString(message.metadataArtifact)) + return "metadataArtifact: string expected"; return null; }; @@ -15909,6 +16285,8 @@ throw TypeError(".google.cloud.aiplatform.v1.Model.modelSourceInfo: object expected"); message.modelSourceInfo = $root.google.cloud.aiplatform.v1.ModelSourceInfo.fromObject(object.modelSourceInfo); } + if (object.metadataArtifact != null) + message.metadataArtifact = String(object.metadataArtifact); return message; }; @@ -15955,6 +16333,7 @@ object.versionCreateTime = null; object.versionUpdateTime = null; object.modelSourceInfo = null; + object.metadataArtifact = ""; } if (message.name != null && message.hasOwnProperty("name")) object.name = message.name; @@ -16030,6 +16409,8 @@ object.versionUpdateTime = $root.google.protobuf.Timestamp.toObject(message.versionUpdateTime, options); if (message.modelSourceInfo != null && message.hasOwnProperty("modelSourceInfo")) object.modelSourceInfo = $root.google.cloud.aiplatform.v1.ModelSourceInfo.toObject(message.modelSourceInfo, options); + if (message.metadataArtifact != null && message.hasOwnProperty("metadataArtifact")) + object.metadataArtifact = message.metadataArtifact; return object; }; @@ -19089,6 +19470,7 @@ * @property {google.cloud.aiplatform.v1.IGcsDestination|null} [baseOutputDirectory] CustomJobSpec baseOutputDirectory * @property {string|null} [tensorboard] CustomJobSpec tensorboard * @property {boolean|null} [enableWebAccess] CustomJobSpec enableWebAccess + * @property {boolean|null} [enableDashboardAccess] CustomJobSpec enableDashboardAccess */ /** @@ -19172,6 +19554,14 @@ */ CustomJobSpec.prototype.enableWebAccess = false; + /** + * CustomJobSpec enableDashboardAccess. + * @member {boolean} enableDashboardAccess + * @memberof google.cloud.aiplatform.v1.CustomJobSpec + * @instance + */ + CustomJobSpec.prototype.enableDashboardAccess = false; + /** * Creates a new CustomJobSpec instance using the specified properties. * @function create @@ -19214,6 +19604,8 @@ if (message.reservedIpRanges != null && message.reservedIpRanges.length) for (var i = 0; i < message.reservedIpRanges.length; ++i) writer.uint32(/* id 13, wireType 2 =*/106).string(message.reservedIpRanges[i]); + if (message.enableDashboardAccess != null && Object.hasOwnProperty.call(message, "enableDashboardAccess")) + writer.uint32(/* id 16, wireType 0 =*/128).bool(message.enableDashboardAccess); return writer; }; @@ -19284,6 +19676,10 @@ message.enableWebAccess = reader.bool(); break; } + case 16: { + message.enableDashboardAccess = reader.bool(); + break; + } default: reader.skipType(tag & 7); break; @@ -19357,6 +19753,9 @@ if (message.enableWebAccess != null && message.hasOwnProperty("enableWebAccess")) if (typeof message.enableWebAccess !== "boolean") return "enableWebAccess: boolean expected"; + if (message.enableDashboardAccess != null && message.hasOwnProperty("enableDashboardAccess")) + if (typeof message.enableDashboardAccess !== "boolean") + return "enableDashboardAccess: boolean expected"; return null; }; @@ -19407,6 +19806,8 @@ message.tensorboard = String(object.tensorboard); if (object.enableWebAccess != null) message.enableWebAccess = Boolean(object.enableWebAccess); + if (object.enableDashboardAccess != null) + message.enableDashboardAccess = Boolean(object.enableDashboardAccess); return message; }; @@ -19434,6 +19835,7 @@ object.baseOutputDirectory = null; object.tensorboard = ""; object.enableWebAccess = false; + object.enableDashboardAccess = false; } if (message.workerPoolSpecs && message.workerPoolSpecs.length) { object.workerPoolSpecs = []; @@ -19457,6 +19859,8 @@ for (var j = 0; j < message.reservedIpRanges.length; ++j) object.reservedIpRanges[j] = message.reservedIpRanges[j]; } + if (message.enableDashboardAccess != null && message.hasOwnProperty("enableDashboardAccess")) + object.enableDashboardAccess = message.enableDashboardAccess; return object; }; @@ -22836,7 +23240,9 @@ * @property {google.protobuf.ITimestamp|null} [updateTime] Dataset updateTime * @property {string|null} [etag] Dataset etag * @property {Object.|null} [labels] Dataset labels + * @property {Array.|null} [savedQueries] Dataset savedQueries * @property {google.cloud.aiplatform.v1.IEncryptionSpec|null} [encryptionSpec] Dataset encryptionSpec + * @property {string|null} [metadataArtifact] Dataset metadataArtifact */ /** @@ -22849,6 +23255,7 @@ */ function Dataset(properties) { this.labels = {}; + this.savedQueries = []; if (properties) for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) if (properties[keys[i]] != null) @@ -22927,6 +23334,14 @@ */ Dataset.prototype.labels = $util.emptyObject; + /** + * Dataset savedQueries. + * @member {Array.} savedQueries + * @memberof google.cloud.aiplatform.v1.Dataset + * @instance + */ + Dataset.prototype.savedQueries = $util.emptyArray; + /** * Dataset encryptionSpec. * @member {google.cloud.aiplatform.v1.IEncryptionSpec|null|undefined} encryptionSpec @@ -22935,6 +23350,14 @@ */ Dataset.prototype.encryptionSpec = null; + /** + * Dataset metadataArtifact. + * @member {string} metadataArtifact + * @memberof google.cloud.aiplatform.v1.Dataset + * @instance + */ + Dataset.prototype.metadataArtifact = ""; + /** * Creates a new Dataset instance using the specified properties. * @function create @@ -22976,10 +23399,15 @@ writer.uint32(/* id 7, wireType 2 =*/58).fork().uint32(/* id 1, wireType 2 =*/10).string(keys[i]).uint32(/* id 2, wireType 2 =*/18).string(message.labels[keys[i]]).ldelim(); if (message.metadata != null && Object.hasOwnProperty.call(message, "metadata")) $root.google.protobuf.Value.encode(message.metadata, writer.uint32(/* id 8, wireType 2 =*/66).fork()).ldelim(); + if (message.savedQueries != null && message.savedQueries.length) + for (var i = 0; i < message.savedQueries.length; ++i) + $root.google.cloud.aiplatform.v1.SavedQuery.encode(message.savedQueries[i], writer.uint32(/* id 9, wireType 2 =*/74).fork()).ldelim(); if (message.encryptionSpec != null && Object.hasOwnProperty.call(message, "encryptionSpec")) $root.google.cloud.aiplatform.v1.EncryptionSpec.encode(message.encryptionSpec, writer.uint32(/* id 11, wireType 2 =*/90).fork()).ldelim(); if (message.description != null && Object.hasOwnProperty.call(message, "description")) writer.uint32(/* id 16, wireType 2 =*/130).string(message.description); + if (message.metadataArtifact != null && Object.hasOwnProperty.call(message, "metadataArtifact")) + writer.uint32(/* id 17, wireType 2 =*/138).string(message.metadataArtifact); return writer; }; @@ -23069,10 +23497,20 @@ message.labels[key] = value; break; } + case 9: { + if (!(message.savedQueries && message.savedQueries.length)) + message.savedQueries = []; + message.savedQueries.push($root.google.cloud.aiplatform.v1.SavedQuery.decode(reader, reader.uint32())); + break; + } case 11: { message.encryptionSpec = $root.google.cloud.aiplatform.v1.EncryptionSpec.decode(reader, reader.uint32()); break; } + case 17: { + message.metadataArtifact = reader.string(); + break; + } default: reader.skipType(tag & 7); break; @@ -23146,11 +23584,23 @@ if (!$util.isString(message.labels[key[i]])) return "labels: string{k:string} expected"; } + if (message.savedQueries != null && message.hasOwnProperty("savedQueries")) { + if (!Array.isArray(message.savedQueries)) + return "savedQueries: array expected"; + for (var i = 0; i < message.savedQueries.length; ++i) { + var error = $root.google.cloud.aiplatform.v1.SavedQuery.verify(message.savedQueries[i]); + if (error) + return "savedQueries." + error; + } + } if (message.encryptionSpec != null && message.hasOwnProperty("encryptionSpec")) { var error = $root.google.cloud.aiplatform.v1.EncryptionSpec.verify(message.encryptionSpec); if (error) return "encryptionSpec." + error; } + if (message.metadataArtifact != null && message.hasOwnProperty("metadataArtifact")) + if (!$util.isString(message.metadataArtifact)) + return "metadataArtifact: string expected"; return null; }; @@ -23198,11 +23648,23 @@ for (var keys = Object.keys(object.labels), i = 0; i < keys.length; ++i) message.labels[keys[i]] = String(object.labels[keys[i]]); } + if (object.savedQueries) { + if (!Array.isArray(object.savedQueries)) + throw TypeError(".google.cloud.aiplatform.v1.Dataset.savedQueries: array expected"); + message.savedQueries = []; + for (var i = 0; i < object.savedQueries.length; ++i) { + if (typeof object.savedQueries[i] !== "object") + throw TypeError(".google.cloud.aiplatform.v1.Dataset.savedQueries: object expected"); + message.savedQueries[i] = $root.google.cloud.aiplatform.v1.SavedQuery.fromObject(object.savedQueries[i]); + } + } if (object.encryptionSpec != null) { if (typeof object.encryptionSpec !== "object") throw TypeError(".google.cloud.aiplatform.v1.Dataset.encryptionSpec: object expected"); message.encryptionSpec = $root.google.cloud.aiplatform.v1.EncryptionSpec.fromObject(object.encryptionSpec); } + if (object.metadataArtifact != null) + message.metadataArtifact = String(object.metadataArtifact); return message; }; @@ -23219,6 +23681,8 @@ if (!options) options = {}; var object = {}; + if (options.arrays || options.defaults) + object.savedQueries = []; if (options.objects || options.defaults) object.labels = {}; if (options.defaults) { @@ -23231,6 +23695,7 @@ object.metadata = null; object.encryptionSpec = null; object.description = ""; + object.metadataArtifact = ""; } if (message.name != null && message.hasOwnProperty("name")) object.name = message.name; @@ -23252,10 +23717,17 @@ } if (message.metadata != null && message.hasOwnProperty("metadata")) object.metadata = $root.google.protobuf.Value.toObject(message.metadata, options); + if (message.savedQueries && message.savedQueries.length) { + object.savedQueries = []; + for (var j = 0; j < message.savedQueries.length; ++j) + object.savedQueries[j] = $root.google.cloud.aiplatform.v1.SavedQuery.toObject(message.savedQueries[j], options); + } if (message.encryptionSpec != null && message.hasOwnProperty("encryptionSpec")) object.encryptionSpec = $root.google.cloud.aiplatform.v1.EncryptionSpec.toObject(message.encryptionSpec, options); if (message.description != null && message.hasOwnProperty("description")) object.description = message.description; + if (message.metadataArtifact != null && message.hasOwnProperty("metadataArtifact")) + object.metadataArtifact = message.metadataArtifact; return object; }; @@ -23296,6 +23768,7 @@ * @interface IImportDataConfig * @property {google.cloud.aiplatform.v1.IGcsSource|null} [gcsSource] ImportDataConfig gcsSource * @property {Object.|null} [dataItemLabels] ImportDataConfig dataItemLabels + * @property {Object.|null} [annotationLabels] ImportDataConfig annotationLabels * @property {string|null} [importSchemaUri] ImportDataConfig importSchemaUri */ @@ -23309,6 +23782,7 @@ */ function ImportDataConfig(properties) { this.dataItemLabels = {}; + this.annotationLabels = {}; if (properties) for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) if (properties[keys[i]] != null) @@ -23331,6 +23805,14 @@ */ ImportDataConfig.prototype.dataItemLabels = $util.emptyObject; + /** + * ImportDataConfig annotationLabels. + * @member {Object.} annotationLabels + * @memberof google.cloud.aiplatform.v1.ImportDataConfig + * @instance + */ + ImportDataConfig.prototype.annotationLabels = $util.emptyObject; + /** * ImportDataConfig importSchemaUri. * @member {string} importSchemaUri @@ -23382,6 +23864,9 @@ if (message.dataItemLabels != null && Object.hasOwnProperty.call(message, "dataItemLabels")) for (var keys = Object.keys(message.dataItemLabels), i = 0; i < keys.length; ++i) writer.uint32(/* id 2, wireType 2 =*/18).fork().uint32(/* id 1, wireType 2 =*/10).string(keys[i]).uint32(/* id 2, wireType 2 =*/18).string(message.dataItemLabels[keys[i]]).ldelim(); + if (message.annotationLabels != null && Object.hasOwnProperty.call(message, "annotationLabels")) + for (var keys = Object.keys(message.annotationLabels), i = 0; i < keys.length; ++i) + writer.uint32(/* id 3, wireType 2 =*/26).fork().uint32(/* id 1, wireType 2 =*/10).string(keys[i]).uint32(/* id 2, wireType 2 =*/18).string(message.annotationLabels[keys[i]]).ldelim(); if (message.importSchemaUri != null && Object.hasOwnProperty.call(message, "importSchemaUri")) writer.uint32(/* id 4, wireType 2 =*/34).string(message.importSchemaUri); return writer; @@ -23445,6 +23930,29 @@ message.dataItemLabels[key] = value; break; } + case 3: { + if (message.annotationLabels === $util.emptyObject) + message.annotationLabels = {}; + var end2 = reader.uint32() + reader.pos; + key = ""; + value = ""; + while (reader.pos < end2) { + var tag2 = reader.uint32(); + switch (tag2 >>> 3) { + case 1: + key = reader.string(); + break; + case 2: + value = reader.string(); + break; + default: + reader.skipType(tag2 & 7); + break; + } + } + message.annotationLabels[key] = value; + break; + } case 4: { message.importSchemaUri = reader.string(); break; @@ -23501,6 +24009,14 @@ if (!$util.isString(message.dataItemLabels[key[i]])) return "dataItemLabels: string{k:string} expected"; } + if (message.annotationLabels != null && message.hasOwnProperty("annotationLabels")) { + if (!$util.isObject(message.annotationLabels)) + return "annotationLabels: object expected"; + var key = Object.keys(message.annotationLabels); + for (var i = 0; i < key.length; ++i) + if (!$util.isString(message.annotationLabels[key[i]])) + return "annotationLabels: string{k:string} expected"; + } if (message.importSchemaUri != null && message.hasOwnProperty("importSchemaUri")) if (!$util.isString(message.importSchemaUri)) return "importSchemaUri: string expected"; @@ -23531,6 +24047,13 @@ for (var keys = Object.keys(object.dataItemLabels), i = 0; i < keys.length; ++i) message.dataItemLabels[keys[i]] = String(object.dataItemLabels[keys[i]]); } + if (object.annotationLabels) { + if (typeof object.annotationLabels !== "object") + throw TypeError(".google.cloud.aiplatform.v1.ImportDataConfig.annotationLabels: object expected"); + message.annotationLabels = {}; + for (var keys = Object.keys(object.annotationLabels), i = 0; i < keys.length; ++i) + message.annotationLabels[keys[i]] = String(object.annotationLabels[keys[i]]); + } if (object.importSchemaUri != null) message.importSchemaUri = String(object.importSchemaUri); return message; @@ -23549,8 +24072,10 @@ if (!options) options = {}; var object = {}; - if (options.objects || options.defaults) + if (options.objects || options.defaults) { object.dataItemLabels = {}; + object.annotationLabels = {}; + } if (options.defaults) object.importSchemaUri = ""; if (message.gcsSource != null && message.hasOwnProperty("gcsSource")) { @@ -23564,6 +24089,11 @@ for (var j = 0; j < keys2.length; ++j) object.dataItemLabels[keys2[j]] = message.dataItemLabels[keys2[j]]; } + if (message.annotationLabels && (keys2 = Object.keys(message.annotationLabels)).length) { + object.annotationLabels = {}; + for (var j = 0; j < keys2.length; ++j) + object.annotationLabels[keys2[j]] = message.annotationLabels[keys2[j]]; + } if (message.importSchemaUri != null && message.hasOwnProperty("importSchemaUri")) object.importSchemaUri = message.importSchemaUri; return object; @@ -23849,6 +24379,432 @@ return ExportDataConfig; })(); + v1.SavedQuery = (function() { + + /** + * Properties of a SavedQuery. + * @memberof google.cloud.aiplatform.v1 + * @interface ISavedQuery + * @property {string|null} [name] SavedQuery name + * @property {string|null} [displayName] SavedQuery displayName + * @property {google.protobuf.IValue|null} [metadata] SavedQuery metadata + * @property {google.protobuf.ITimestamp|null} [createTime] SavedQuery createTime + * @property {google.protobuf.ITimestamp|null} [updateTime] SavedQuery updateTime + * @property {string|null} [annotationFilter] SavedQuery annotationFilter + * @property {string|null} [problemType] SavedQuery problemType + * @property {number|null} [annotationSpecCount] SavedQuery annotationSpecCount + * @property {string|null} [etag] SavedQuery etag + * @property {boolean|null} [supportAutomlTraining] SavedQuery supportAutomlTraining + */ + + /** + * Constructs a new SavedQuery. + * @memberof google.cloud.aiplatform.v1 + * @classdesc Represents a SavedQuery. + * @implements ISavedQuery + * @constructor + * @param {google.cloud.aiplatform.v1.ISavedQuery=} [properties] Properties to set + */ + function SavedQuery(properties) { + if (properties) + for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) + if (properties[keys[i]] != null) + this[keys[i]] = properties[keys[i]]; + } + + /** + * SavedQuery name. + * @member {string} name + * @memberof google.cloud.aiplatform.v1.SavedQuery + * @instance + */ + SavedQuery.prototype.name = ""; + + /** + * SavedQuery displayName. + * @member {string} displayName + * @memberof google.cloud.aiplatform.v1.SavedQuery + * @instance + */ + SavedQuery.prototype.displayName = ""; + + /** + * SavedQuery metadata. + * @member {google.protobuf.IValue|null|undefined} metadata + * @memberof google.cloud.aiplatform.v1.SavedQuery + * @instance + */ + SavedQuery.prototype.metadata = null; + + /** + * SavedQuery createTime. + * @member {google.protobuf.ITimestamp|null|undefined} createTime + * @memberof google.cloud.aiplatform.v1.SavedQuery + * @instance + */ + SavedQuery.prototype.createTime = null; + + /** + * SavedQuery updateTime. + * @member {google.protobuf.ITimestamp|null|undefined} updateTime + * @memberof google.cloud.aiplatform.v1.SavedQuery + * @instance + */ + SavedQuery.prototype.updateTime = null; + + /** + * SavedQuery annotationFilter. + * @member {string} annotationFilter + * @memberof google.cloud.aiplatform.v1.SavedQuery + * @instance + */ + SavedQuery.prototype.annotationFilter = ""; + + /** + * SavedQuery problemType. + * @member {string} problemType + * @memberof google.cloud.aiplatform.v1.SavedQuery + * @instance + */ + SavedQuery.prototype.problemType = ""; + + /** + * SavedQuery annotationSpecCount. + * @member {number} annotationSpecCount + * @memberof google.cloud.aiplatform.v1.SavedQuery + * @instance + */ + SavedQuery.prototype.annotationSpecCount = 0; + + /** + * SavedQuery etag. + * @member {string} etag + * @memberof google.cloud.aiplatform.v1.SavedQuery + * @instance + */ + SavedQuery.prototype.etag = ""; + + /** + * SavedQuery supportAutomlTraining. + * @member {boolean} supportAutomlTraining + * @memberof google.cloud.aiplatform.v1.SavedQuery + * @instance + */ + SavedQuery.prototype.supportAutomlTraining = false; + + /** + * Creates a new SavedQuery instance using the specified properties. + * @function create + * @memberof google.cloud.aiplatform.v1.SavedQuery + * @static + * @param {google.cloud.aiplatform.v1.ISavedQuery=} [properties] Properties to set + * @returns {google.cloud.aiplatform.v1.SavedQuery} SavedQuery instance + */ + SavedQuery.create = function create(properties) { + return new SavedQuery(properties); + }; + + /** + * Encodes the specified SavedQuery message. Does not implicitly {@link google.cloud.aiplatform.v1.SavedQuery.verify|verify} messages. + * @function encode + * @memberof google.cloud.aiplatform.v1.SavedQuery + * @static + * @param {google.cloud.aiplatform.v1.ISavedQuery} message SavedQuery message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + SavedQuery.encode = function encode(message, writer) { + if (!writer) + writer = $Writer.create(); + if (message.name != null && Object.hasOwnProperty.call(message, "name")) + writer.uint32(/* id 1, wireType 2 =*/10).string(message.name); + if (message.displayName != null && Object.hasOwnProperty.call(message, "displayName")) + writer.uint32(/* id 2, wireType 2 =*/18).string(message.displayName); + if (message.createTime != null && Object.hasOwnProperty.call(message, "createTime")) + $root.google.protobuf.Timestamp.encode(message.createTime, writer.uint32(/* id 3, wireType 2 =*/26).fork()).ldelim(); + if (message.updateTime != null && Object.hasOwnProperty.call(message, "updateTime")) + $root.google.protobuf.Timestamp.encode(message.updateTime, writer.uint32(/* id 4, wireType 2 =*/34).fork()).ldelim(); + if (message.annotationFilter != null && Object.hasOwnProperty.call(message, "annotationFilter")) + writer.uint32(/* id 5, wireType 2 =*/42).string(message.annotationFilter); + if (message.problemType != null && Object.hasOwnProperty.call(message, "problemType")) + writer.uint32(/* id 6, wireType 2 =*/50).string(message.problemType); + if (message.etag != null && Object.hasOwnProperty.call(message, "etag")) + writer.uint32(/* id 8, wireType 2 =*/66).string(message.etag); + if (message.supportAutomlTraining != null && Object.hasOwnProperty.call(message, "supportAutomlTraining")) + writer.uint32(/* id 9, wireType 0 =*/72).bool(message.supportAutomlTraining); + if (message.annotationSpecCount != null && Object.hasOwnProperty.call(message, "annotationSpecCount")) + writer.uint32(/* id 10, wireType 0 =*/80).int32(message.annotationSpecCount); + if (message.metadata != null && Object.hasOwnProperty.call(message, "metadata")) + $root.google.protobuf.Value.encode(message.metadata, writer.uint32(/* id 12, wireType 2 =*/98).fork()).ldelim(); + return writer; + }; + + /** + * Encodes the specified SavedQuery message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.SavedQuery.verify|verify} messages. + * @function encodeDelimited + * @memberof google.cloud.aiplatform.v1.SavedQuery + * @static + * @param {google.cloud.aiplatform.v1.ISavedQuery} message SavedQuery message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + SavedQuery.encodeDelimited = function encodeDelimited(message, writer) { + return this.encode(message, writer).ldelim(); + }; + + /** + * Decodes a SavedQuery message from the specified reader or buffer. + * @function decode + * @memberof google.cloud.aiplatform.v1.SavedQuery + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @param {number} [length] Message length if known beforehand + * @returns {google.cloud.aiplatform.v1.SavedQuery} SavedQuery + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + SavedQuery.decode = function decode(reader, length) { + if (!(reader instanceof $Reader)) + reader = $Reader.create(reader); + var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.aiplatform.v1.SavedQuery(); + while (reader.pos < end) { + var tag = reader.uint32(); + switch (tag >>> 3) { + case 1: { + message.name = reader.string(); + break; + } + case 2: { + message.displayName = reader.string(); + break; + } + case 12: { + message.metadata = $root.google.protobuf.Value.decode(reader, reader.uint32()); + break; + } + case 3: { + message.createTime = $root.google.protobuf.Timestamp.decode(reader, reader.uint32()); + break; + } + case 4: { + message.updateTime = $root.google.protobuf.Timestamp.decode(reader, reader.uint32()); + break; + } + case 5: { + message.annotationFilter = reader.string(); + break; + } + case 6: { + message.problemType = reader.string(); + break; + } + case 10: { + message.annotationSpecCount = reader.int32(); + break; + } + case 8: { + message.etag = reader.string(); + break; + } + case 9: { + message.supportAutomlTraining = reader.bool(); + break; + } + default: + reader.skipType(tag & 7); + break; + } + } + return message; + }; + + /** + * Decodes a SavedQuery message from the specified reader or buffer, length delimited. + * @function decodeDelimited + * @memberof google.cloud.aiplatform.v1.SavedQuery + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @returns {google.cloud.aiplatform.v1.SavedQuery} SavedQuery + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + SavedQuery.decodeDelimited = function decodeDelimited(reader) { + if (!(reader instanceof $Reader)) + reader = new $Reader(reader); + return this.decode(reader, reader.uint32()); + }; + + /** + * Verifies a SavedQuery message. + * @function verify + * @memberof google.cloud.aiplatform.v1.SavedQuery + * @static + * @param {Object.} message Plain object to verify + * @returns {string|null} `null` if valid, otherwise the reason why it is not + */ + SavedQuery.verify = function verify(message) { + if (typeof message !== "object" || message === null) + return "object expected"; + if (message.name != null && message.hasOwnProperty("name")) + if (!$util.isString(message.name)) + return "name: string expected"; + if (message.displayName != null && message.hasOwnProperty("displayName")) + if (!$util.isString(message.displayName)) + return "displayName: string expected"; + if (message.metadata != null && message.hasOwnProperty("metadata")) { + var error = $root.google.protobuf.Value.verify(message.metadata); + if (error) + return "metadata." + error; + } + if (message.createTime != null && message.hasOwnProperty("createTime")) { + var error = $root.google.protobuf.Timestamp.verify(message.createTime); + if (error) + return "createTime." + error; + } + if (message.updateTime != null && message.hasOwnProperty("updateTime")) { + var error = $root.google.protobuf.Timestamp.verify(message.updateTime); + if (error) + return "updateTime." + error; + } + if (message.annotationFilter != null && message.hasOwnProperty("annotationFilter")) + if (!$util.isString(message.annotationFilter)) + return "annotationFilter: string expected"; + if (message.problemType != null && message.hasOwnProperty("problemType")) + if (!$util.isString(message.problemType)) + return "problemType: string expected"; + if (message.annotationSpecCount != null && message.hasOwnProperty("annotationSpecCount")) + if (!$util.isInteger(message.annotationSpecCount)) + return "annotationSpecCount: integer expected"; + if (message.etag != null && message.hasOwnProperty("etag")) + if (!$util.isString(message.etag)) + return "etag: string expected"; + if (message.supportAutomlTraining != null && message.hasOwnProperty("supportAutomlTraining")) + if (typeof message.supportAutomlTraining !== "boolean") + return "supportAutomlTraining: boolean expected"; + return null; + }; + + /** + * Creates a SavedQuery message from a plain object. Also converts values to their respective internal types. + * @function fromObject + * @memberof google.cloud.aiplatform.v1.SavedQuery + * @static + * @param {Object.} object Plain object + * @returns {google.cloud.aiplatform.v1.SavedQuery} SavedQuery + */ + SavedQuery.fromObject = function fromObject(object) { + if (object instanceof $root.google.cloud.aiplatform.v1.SavedQuery) + return object; + var message = new $root.google.cloud.aiplatform.v1.SavedQuery(); + if (object.name != null) + message.name = String(object.name); + if (object.displayName != null) + message.displayName = String(object.displayName); + if (object.metadata != null) { + if (typeof object.metadata !== "object") + throw TypeError(".google.cloud.aiplatform.v1.SavedQuery.metadata: object expected"); + message.metadata = $root.google.protobuf.Value.fromObject(object.metadata); + } + if (object.createTime != null) { + if (typeof object.createTime !== "object") + throw TypeError(".google.cloud.aiplatform.v1.SavedQuery.createTime: object expected"); + message.createTime = $root.google.protobuf.Timestamp.fromObject(object.createTime); + } + if (object.updateTime != null) { + if (typeof object.updateTime !== "object") + throw TypeError(".google.cloud.aiplatform.v1.SavedQuery.updateTime: object expected"); + message.updateTime = $root.google.protobuf.Timestamp.fromObject(object.updateTime); + } + if (object.annotationFilter != null) + message.annotationFilter = String(object.annotationFilter); + if (object.problemType != null) + message.problemType = String(object.problemType); + if (object.annotationSpecCount != null) + message.annotationSpecCount = object.annotationSpecCount | 0; + if (object.etag != null) + message.etag = String(object.etag); + if (object.supportAutomlTraining != null) + message.supportAutomlTraining = Boolean(object.supportAutomlTraining); + return message; + }; + + /** + * Creates a plain object from a SavedQuery message. Also converts values to other types if specified. + * @function toObject + * @memberof google.cloud.aiplatform.v1.SavedQuery + * @static + * @param {google.cloud.aiplatform.v1.SavedQuery} message SavedQuery + * @param {$protobuf.IConversionOptions} [options] Conversion options + * @returns {Object.} Plain object + */ + SavedQuery.toObject = function toObject(message, options) { + if (!options) + options = {}; + var object = {}; + if (options.defaults) { + object.name = ""; + object.displayName = ""; + object.createTime = null; + object.updateTime = null; + object.annotationFilter = ""; + object.problemType = ""; + object.etag = ""; + object.supportAutomlTraining = false; + object.annotationSpecCount = 0; + object.metadata = null; + } + if (message.name != null && message.hasOwnProperty("name")) + object.name = message.name; + if (message.displayName != null && message.hasOwnProperty("displayName")) + object.displayName = message.displayName; + if (message.createTime != null && message.hasOwnProperty("createTime")) + object.createTime = $root.google.protobuf.Timestamp.toObject(message.createTime, options); + if (message.updateTime != null && message.hasOwnProperty("updateTime")) + object.updateTime = $root.google.protobuf.Timestamp.toObject(message.updateTime, options); + if (message.annotationFilter != null && message.hasOwnProperty("annotationFilter")) + object.annotationFilter = message.annotationFilter; + if (message.problemType != null && message.hasOwnProperty("problemType")) + object.problemType = message.problemType; + if (message.etag != null && message.hasOwnProperty("etag")) + object.etag = message.etag; + if (message.supportAutomlTraining != null && message.hasOwnProperty("supportAutomlTraining")) + object.supportAutomlTraining = message.supportAutomlTraining; + if (message.annotationSpecCount != null && message.hasOwnProperty("annotationSpecCount")) + object.annotationSpecCount = message.annotationSpecCount; + if (message.metadata != null && message.hasOwnProperty("metadata")) + object.metadata = $root.google.protobuf.Value.toObject(message.metadata, options); + return object; + }; + + /** + * Converts this SavedQuery to JSON. + * @function toJSON + * @memberof google.cloud.aiplatform.v1.SavedQuery + * @instance + * @returns {Object.} JSON object + */ + SavedQuery.prototype.toJSON = function toJSON() { + return this.constructor.toObject(this, $protobuf.util.toJSONOptions); + }; + + /** + * Gets the default type url for SavedQuery + * @function getTypeUrl + * @memberof google.cloud.aiplatform.v1.SavedQuery + * @static + * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns {string} The default type url + */ + SavedQuery.getTypeUrl = function getTypeUrl(typeUrlPrefix) { + if (typeUrlPrefix === undefined) { + typeUrlPrefix = "type.googleapis.com"; + } + return typeUrlPrefix + "/google.cloud.aiplatform.v1.SavedQuery"; + }; + + return SavedQuery; + })(); + v1.DatasetService = (function() { /** @@ -24145,6 +25101,39 @@ * @variation 2 */ + /** + * Callback as used by {@link google.cloud.aiplatform.v1.DatasetService|searchDataItems}. + * @memberof google.cloud.aiplatform.v1.DatasetService + * @typedef SearchDataItemsCallback + * @type {function} + * @param {Error|null} error Error, if any + * @param {google.cloud.aiplatform.v1.SearchDataItemsResponse} [response] SearchDataItemsResponse + */ + + /** + * Calls SearchDataItems. + * @function searchDataItems + * @memberof google.cloud.aiplatform.v1.DatasetService + * @instance + * @param {google.cloud.aiplatform.v1.ISearchDataItemsRequest} request SearchDataItemsRequest message or plain object + * @param {google.cloud.aiplatform.v1.DatasetService.SearchDataItemsCallback} callback Node-style callback called with the error, if any, and SearchDataItemsResponse + * @returns {undefined} + * @variation 1 + */ + Object.defineProperty(DatasetService.prototype.searchDataItems = function searchDataItems(request, callback) { + return this.rpcCall(searchDataItems, $root.google.cloud.aiplatform.v1.SearchDataItemsRequest, $root.google.cloud.aiplatform.v1.SearchDataItemsResponse, request, callback); + }, "name", { value: "SearchDataItems" }); + + /** + * Calls SearchDataItems. + * @function searchDataItems + * @memberof google.cloud.aiplatform.v1.DatasetService + * @instance + * @param {google.cloud.aiplatform.v1.ISearchDataItemsRequest} request SearchDataItemsRequest message or plain object + * @returns {Promise} Promise + * @variation 2 + */ + /** * Callback as used by {@link google.cloud.aiplatform.v1.DatasetService|listSavedQueries}. * @memberof google.cloud.aiplatform.v1.DatasetService @@ -27817,6 +28806,1291 @@ return ListDataItemsResponse; })(); + v1.SearchDataItemsRequest = (function() { + + /** + * Properties of a SearchDataItemsRequest. + * @memberof google.cloud.aiplatform.v1 + * @interface ISearchDataItemsRequest + * @property {string|null} [orderByDataItem] SearchDataItemsRequest orderByDataItem + * @property {google.cloud.aiplatform.v1.SearchDataItemsRequest.IOrderByAnnotation|null} [orderByAnnotation] SearchDataItemsRequest orderByAnnotation + * @property {string|null} [dataset] SearchDataItemsRequest dataset + * @property {string|null} [savedQuery] SearchDataItemsRequest savedQuery + * @property {string|null} [dataLabelingJob] SearchDataItemsRequest dataLabelingJob + * @property {string|null} [dataItemFilter] SearchDataItemsRequest dataItemFilter + * @property {string|null} [annotationsFilter] SearchDataItemsRequest annotationsFilter + * @property {Array.|null} [annotationFilters] SearchDataItemsRequest annotationFilters + * @property {google.protobuf.IFieldMask|null} [fieldMask] SearchDataItemsRequest fieldMask + * @property {number|null} [annotationsLimit] SearchDataItemsRequest annotationsLimit + * @property {number|null} [pageSize] SearchDataItemsRequest pageSize + * @property {string|null} [orderBy] SearchDataItemsRequest orderBy + * @property {string|null} [pageToken] SearchDataItemsRequest pageToken + */ + + /** + * Constructs a new SearchDataItemsRequest. + * @memberof google.cloud.aiplatform.v1 + * @classdesc Represents a SearchDataItemsRequest. + * @implements ISearchDataItemsRequest + * @constructor + * @param {google.cloud.aiplatform.v1.ISearchDataItemsRequest=} [properties] Properties to set + */ + function SearchDataItemsRequest(properties) { + this.annotationFilters = []; + if (properties) + for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) + if (properties[keys[i]] != null) + this[keys[i]] = properties[keys[i]]; + } + + /** + * SearchDataItemsRequest orderByDataItem. + * @member {string|null|undefined} orderByDataItem + * @memberof google.cloud.aiplatform.v1.SearchDataItemsRequest + * @instance + */ + SearchDataItemsRequest.prototype.orderByDataItem = null; + + /** + * SearchDataItemsRequest orderByAnnotation. + * @member {google.cloud.aiplatform.v1.SearchDataItemsRequest.IOrderByAnnotation|null|undefined} orderByAnnotation + * @memberof google.cloud.aiplatform.v1.SearchDataItemsRequest + * @instance + */ + SearchDataItemsRequest.prototype.orderByAnnotation = null; + + /** + * SearchDataItemsRequest dataset. + * @member {string} dataset + * @memberof google.cloud.aiplatform.v1.SearchDataItemsRequest + * @instance + */ + SearchDataItemsRequest.prototype.dataset = ""; + + /** + * SearchDataItemsRequest savedQuery. + * @member {string} savedQuery + * @memberof google.cloud.aiplatform.v1.SearchDataItemsRequest + * @instance + */ + SearchDataItemsRequest.prototype.savedQuery = ""; + + /** + * SearchDataItemsRequest dataLabelingJob. + * @member {string} dataLabelingJob + * @memberof google.cloud.aiplatform.v1.SearchDataItemsRequest + * @instance + */ + SearchDataItemsRequest.prototype.dataLabelingJob = ""; + + /** + * SearchDataItemsRequest dataItemFilter. + * @member {string} dataItemFilter + * @memberof google.cloud.aiplatform.v1.SearchDataItemsRequest + * @instance + */ + SearchDataItemsRequest.prototype.dataItemFilter = ""; + + /** + * SearchDataItemsRequest annotationsFilter. + * @member {string} annotationsFilter + * @memberof google.cloud.aiplatform.v1.SearchDataItemsRequest + * @instance + */ + SearchDataItemsRequest.prototype.annotationsFilter = ""; + + /** + * SearchDataItemsRequest annotationFilters. + * @member {Array.} annotationFilters + * @memberof google.cloud.aiplatform.v1.SearchDataItemsRequest + * @instance + */ + SearchDataItemsRequest.prototype.annotationFilters = $util.emptyArray; + + /** + * SearchDataItemsRequest fieldMask. + * @member {google.protobuf.IFieldMask|null|undefined} fieldMask + * @memberof google.cloud.aiplatform.v1.SearchDataItemsRequest + * @instance + */ + SearchDataItemsRequest.prototype.fieldMask = null; + + /** + * SearchDataItemsRequest annotationsLimit. + * @member {number} annotationsLimit + * @memberof google.cloud.aiplatform.v1.SearchDataItemsRequest + * @instance + */ + SearchDataItemsRequest.prototype.annotationsLimit = 0; + + /** + * SearchDataItemsRequest pageSize. + * @member {number} pageSize + * @memberof google.cloud.aiplatform.v1.SearchDataItemsRequest + * @instance + */ + SearchDataItemsRequest.prototype.pageSize = 0; + + /** + * SearchDataItemsRequest orderBy. + * @member {string} orderBy + * @memberof google.cloud.aiplatform.v1.SearchDataItemsRequest + * @instance + */ + SearchDataItemsRequest.prototype.orderBy = ""; + + /** + * SearchDataItemsRequest pageToken. + * @member {string} pageToken + * @memberof google.cloud.aiplatform.v1.SearchDataItemsRequest + * @instance + */ + SearchDataItemsRequest.prototype.pageToken = ""; + + // OneOf field names bound to virtual getters and setters + var $oneOfFields; + + /** + * SearchDataItemsRequest order. + * @member {"orderByDataItem"|"orderByAnnotation"|undefined} order + * @memberof google.cloud.aiplatform.v1.SearchDataItemsRequest + * @instance + */ + Object.defineProperty(SearchDataItemsRequest.prototype, "order", { + get: $util.oneOfGetter($oneOfFields = ["orderByDataItem", "orderByAnnotation"]), + set: $util.oneOfSetter($oneOfFields) + }); + + /** + * Creates a new SearchDataItemsRequest instance using the specified properties. + * @function create + * @memberof google.cloud.aiplatform.v1.SearchDataItemsRequest + * @static + * @param {google.cloud.aiplatform.v1.ISearchDataItemsRequest=} [properties] Properties to set + * @returns {google.cloud.aiplatform.v1.SearchDataItemsRequest} SearchDataItemsRequest instance + */ + SearchDataItemsRequest.create = function create(properties) { + return new SearchDataItemsRequest(properties); + }; + + /** + * Encodes the specified SearchDataItemsRequest message. Does not implicitly {@link google.cloud.aiplatform.v1.SearchDataItemsRequest.verify|verify} messages. + * @function encode + * @memberof google.cloud.aiplatform.v1.SearchDataItemsRequest + * @static + * @param {google.cloud.aiplatform.v1.ISearchDataItemsRequest} message SearchDataItemsRequest message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + SearchDataItemsRequest.encode = function encode(message, writer) { + if (!writer) + writer = $Writer.create(); + if (message.dataset != null && Object.hasOwnProperty.call(message, "dataset")) + writer.uint32(/* id 1, wireType 2 =*/10).string(message.dataset); + if (message.savedQuery != null && Object.hasOwnProperty.call(message, "savedQuery")) + writer.uint32(/* id 2, wireType 2 =*/18).string(message.savedQuery); + if (message.dataLabelingJob != null && Object.hasOwnProperty.call(message, "dataLabelingJob")) + writer.uint32(/* id 3, wireType 2 =*/26).string(message.dataLabelingJob); + if (message.dataItemFilter != null && Object.hasOwnProperty.call(message, "dataItemFilter")) + writer.uint32(/* id 4, wireType 2 =*/34).string(message.dataItemFilter); + if (message.annotationsFilter != null && Object.hasOwnProperty.call(message, "annotationsFilter")) + writer.uint32(/* id 5, wireType 2 =*/42).string(message.annotationsFilter); + if (message.fieldMask != null && Object.hasOwnProperty.call(message, "fieldMask")) + $root.google.protobuf.FieldMask.encode(message.fieldMask, writer.uint32(/* id 6, wireType 2 =*/50).fork()).ldelim(); + if (message.annotationsLimit != null && Object.hasOwnProperty.call(message, "annotationsLimit")) + writer.uint32(/* id 7, wireType 0 =*/56).int32(message.annotationsLimit); + if (message.pageSize != null && Object.hasOwnProperty.call(message, "pageSize")) + writer.uint32(/* id 8, wireType 0 =*/64).int32(message.pageSize); + if (message.orderBy != null && Object.hasOwnProperty.call(message, "orderBy")) + writer.uint32(/* id 9, wireType 2 =*/74).string(message.orderBy); + if (message.pageToken != null && Object.hasOwnProperty.call(message, "pageToken")) + writer.uint32(/* id 10, wireType 2 =*/82).string(message.pageToken); + if (message.annotationFilters != null && message.annotationFilters.length) + for (var i = 0; i < message.annotationFilters.length; ++i) + writer.uint32(/* id 11, wireType 2 =*/90).string(message.annotationFilters[i]); + if (message.orderByDataItem != null && Object.hasOwnProperty.call(message, "orderByDataItem")) + writer.uint32(/* id 12, wireType 2 =*/98).string(message.orderByDataItem); + if (message.orderByAnnotation != null && Object.hasOwnProperty.call(message, "orderByAnnotation")) + $root.google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation.encode(message.orderByAnnotation, writer.uint32(/* id 13, wireType 2 =*/106).fork()).ldelim(); + return writer; + }; + + /** + * Encodes the specified SearchDataItemsRequest message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.SearchDataItemsRequest.verify|verify} messages. + * @function encodeDelimited + * @memberof google.cloud.aiplatform.v1.SearchDataItemsRequest + * @static + * @param {google.cloud.aiplatform.v1.ISearchDataItemsRequest} message SearchDataItemsRequest message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + SearchDataItemsRequest.encodeDelimited = function encodeDelimited(message, writer) { + return this.encode(message, writer).ldelim(); + }; + + /** + * Decodes a SearchDataItemsRequest message from the specified reader or buffer. + * @function decode + * @memberof google.cloud.aiplatform.v1.SearchDataItemsRequest + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @param {number} [length] Message length if known beforehand + * @returns {google.cloud.aiplatform.v1.SearchDataItemsRequest} SearchDataItemsRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + SearchDataItemsRequest.decode = function decode(reader, length) { + if (!(reader instanceof $Reader)) + reader = $Reader.create(reader); + var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.aiplatform.v1.SearchDataItemsRequest(); + while (reader.pos < end) { + var tag = reader.uint32(); + switch (tag >>> 3) { + case 12: { + message.orderByDataItem = reader.string(); + break; + } + case 13: { + message.orderByAnnotation = $root.google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation.decode(reader, reader.uint32()); + break; + } + case 1: { + message.dataset = reader.string(); + break; + } + case 2: { + message.savedQuery = reader.string(); + break; + } + case 3: { + message.dataLabelingJob = reader.string(); + break; + } + case 4: { + message.dataItemFilter = reader.string(); + break; + } + case 5: { + message.annotationsFilter = reader.string(); + break; + } + case 11: { + if (!(message.annotationFilters && message.annotationFilters.length)) + message.annotationFilters = []; + message.annotationFilters.push(reader.string()); + break; + } + case 6: { + message.fieldMask = $root.google.protobuf.FieldMask.decode(reader, reader.uint32()); + break; + } + case 7: { + message.annotationsLimit = reader.int32(); + break; + } + case 8: { + message.pageSize = reader.int32(); + break; + } + case 9: { + message.orderBy = reader.string(); + break; + } + case 10: { + message.pageToken = reader.string(); + break; + } + default: + reader.skipType(tag & 7); + break; + } + } + return message; + }; + + /** + * Decodes a SearchDataItemsRequest message from the specified reader or buffer, length delimited. + * @function decodeDelimited + * @memberof google.cloud.aiplatform.v1.SearchDataItemsRequest + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @returns {google.cloud.aiplatform.v1.SearchDataItemsRequest} SearchDataItemsRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + SearchDataItemsRequest.decodeDelimited = function decodeDelimited(reader) { + if (!(reader instanceof $Reader)) + reader = new $Reader(reader); + return this.decode(reader, reader.uint32()); + }; + + /** + * Verifies a SearchDataItemsRequest message. + * @function verify + * @memberof google.cloud.aiplatform.v1.SearchDataItemsRequest + * @static + * @param {Object.} message Plain object to verify + * @returns {string|null} `null` if valid, otherwise the reason why it is not + */ + SearchDataItemsRequest.verify = function verify(message) { + if (typeof message !== "object" || message === null) + return "object expected"; + var properties = {}; + if (message.orderByDataItem != null && message.hasOwnProperty("orderByDataItem")) { + properties.order = 1; + if (!$util.isString(message.orderByDataItem)) + return "orderByDataItem: string expected"; + } + if (message.orderByAnnotation != null && message.hasOwnProperty("orderByAnnotation")) { + if (properties.order === 1) + return "order: multiple values"; + properties.order = 1; + { + var error = $root.google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation.verify(message.orderByAnnotation); + if (error) + return "orderByAnnotation." + error; + } + } + if (message.dataset != null && message.hasOwnProperty("dataset")) + if (!$util.isString(message.dataset)) + return "dataset: string expected"; + if (message.savedQuery != null && message.hasOwnProperty("savedQuery")) + if (!$util.isString(message.savedQuery)) + return "savedQuery: string expected"; + if (message.dataLabelingJob != null && message.hasOwnProperty("dataLabelingJob")) + if (!$util.isString(message.dataLabelingJob)) + return "dataLabelingJob: string expected"; + if (message.dataItemFilter != null && message.hasOwnProperty("dataItemFilter")) + if (!$util.isString(message.dataItemFilter)) + return "dataItemFilter: string expected"; + if (message.annotationsFilter != null && message.hasOwnProperty("annotationsFilter")) + if (!$util.isString(message.annotationsFilter)) + return "annotationsFilter: string expected"; + if (message.annotationFilters != null && message.hasOwnProperty("annotationFilters")) { + if (!Array.isArray(message.annotationFilters)) + return "annotationFilters: array expected"; + for (var i = 0; i < message.annotationFilters.length; ++i) + if (!$util.isString(message.annotationFilters[i])) + return "annotationFilters: string[] expected"; + } + if (message.fieldMask != null && message.hasOwnProperty("fieldMask")) { + var error = $root.google.protobuf.FieldMask.verify(message.fieldMask); + if (error) + return "fieldMask." + error; + } + if (message.annotationsLimit != null && message.hasOwnProperty("annotationsLimit")) + if (!$util.isInteger(message.annotationsLimit)) + return "annotationsLimit: integer expected"; + if (message.pageSize != null && message.hasOwnProperty("pageSize")) + if (!$util.isInteger(message.pageSize)) + return "pageSize: integer expected"; + if (message.orderBy != null && message.hasOwnProperty("orderBy")) + if (!$util.isString(message.orderBy)) + return "orderBy: string expected"; + if (message.pageToken != null && message.hasOwnProperty("pageToken")) + if (!$util.isString(message.pageToken)) + return "pageToken: string expected"; + return null; + }; + + /** + * Creates a SearchDataItemsRequest message from a plain object. Also converts values to their respective internal types. + * @function fromObject + * @memberof google.cloud.aiplatform.v1.SearchDataItemsRequest + * @static + * @param {Object.} object Plain object + * @returns {google.cloud.aiplatform.v1.SearchDataItemsRequest} SearchDataItemsRequest + */ + SearchDataItemsRequest.fromObject = function fromObject(object) { + if (object instanceof $root.google.cloud.aiplatform.v1.SearchDataItemsRequest) + return object; + var message = new $root.google.cloud.aiplatform.v1.SearchDataItemsRequest(); + if (object.orderByDataItem != null) + message.orderByDataItem = String(object.orderByDataItem); + if (object.orderByAnnotation != null) { + if (typeof object.orderByAnnotation !== "object") + throw TypeError(".google.cloud.aiplatform.v1.SearchDataItemsRequest.orderByAnnotation: object expected"); + message.orderByAnnotation = $root.google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation.fromObject(object.orderByAnnotation); + } + if (object.dataset != null) + message.dataset = String(object.dataset); + if (object.savedQuery != null) + message.savedQuery = String(object.savedQuery); + if (object.dataLabelingJob != null) + message.dataLabelingJob = String(object.dataLabelingJob); + if (object.dataItemFilter != null) + message.dataItemFilter = String(object.dataItemFilter); + if (object.annotationsFilter != null) + message.annotationsFilter = String(object.annotationsFilter); + if (object.annotationFilters) { + if (!Array.isArray(object.annotationFilters)) + throw TypeError(".google.cloud.aiplatform.v1.SearchDataItemsRequest.annotationFilters: array expected"); + message.annotationFilters = []; + for (var i = 0; i < object.annotationFilters.length; ++i) + message.annotationFilters[i] = String(object.annotationFilters[i]); + } + if (object.fieldMask != null) { + if (typeof object.fieldMask !== "object") + throw TypeError(".google.cloud.aiplatform.v1.SearchDataItemsRequest.fieldMask: object expected"); + message.fieldMask = $root.google.protobuf.FieldMask.fromObject(object.fieldMask); + } + if (object.annotationsLimit != null) + message.annotationsLimit = object.annotationsLimit | 0; + if (object.pageSize != null) + message.pageSize = object.pageSize | 0; + if (object.orderBy != null) + message.orderBy = String(object.orderBy); + if (object.pageToken != null) + message.pageToken = String(object.pageToken); + return message; + }; + + /** + * Creates a plain object from a SearchDataItemsRequest message. Also converts values to other types if specified. + * @function toObject + * @memberof google.cloud.aiplatform.v1.SearchDataItemsRequest + * @static + * @param {google.cloud.aiplatform.v1.SearchDataItemsRequest} message SearchDataItemsRequest + * @param {$protobuf.IConversionOptions} [options] Conversion options + * @returns {Object.} Plain object + */ + SearchDataItemsRequest.toObject = function toObject(message, options) { + if (!options) + options = {}; + var object = {}; + if (options.arrays || options.defaults) + object.annotationFilters = []; + if (options.defaults) { + object.dataset = ""; + object.savedQuery = ""; + object.dataLabelingJob = ""; + object.dataItemFilter = ""; + object.annotationsFilter = ""; + object.fieldMask = null; + object.annotationsLimit = 0; + object.pageSize = 0; + object.orderBy = ""; + object.pageToken = ""; + } + if (message.dataset != null && message.hasOwnProperty("dataset")) + object.dataset = message.dataset; + if (message.savedQuery != null && message.hasOwnProperty("savedQuery")) + object.savedQuery = message.savedQuery; + if (message.dataLabelingJob != null && message.hasOwnProperty("dataLabelingJob")) + object.dataLabelingJob = message.dataLabelingJob; + if (message.dataItemFilter != null && message.hasOwnProperty("dataItemFilter")) + object.dataItemFilter = message.dataItemFilter; + if (message.annotationsFilter != null && message.hasOwnProperty("annotationsFilter")) + object.annotationsFilter = message.annotationsFilter; + if (message.fieldMask != null && message.hasOwnProperty("fieldMask")) + object.fieldMask = $root.google.protobuf.FieldMask.toObject(message.fieldMask, options); + if (message.annotationsLimit != null && message.hasOwnProperty("annotationsLimit")) + object.annotationsLimit = message.annotationsLimit; + if (message.pageSize != null && message.hasOwnProperty("pageSize")) + object.pageSize = message.pageSize; + if (message.orderBy != null && message.hasOwnProperty("orderBy")) + object.orderBy = message.orderBy; + if (message.pageToken != null && message.hasOwnProperty("pageToken")) + object.pageToken = message.pageToken; + if (message.annotationFilters && message.annotationFilters.length) { + object.annotationFilters = []; + for (var j = 0; j < message.annotationFilters.length; ++j) + object.annotationFilters[j] = message.annotationFilters[j]; + } + if (message.orderByDataItem != null && message.hasOwnProperty("orderByDataItem")) { + object.orderByDataItem = message.orderByDataItem; + if (options.oneofs) + object.order = "orderByDataItem"; + } + if (message.orderByAnnotation != null && message.hasOwnProperty("orderByAnnotation")) { + object.orderByAnnotation = $root.google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation.toObject(message.orderByAnnotation, options); + if (options.oneofs) + object.order = "orderByAnnotation"; + } + return object; + }; + + /** + * Converts this SearchDataItemsRequest to JSON. + * @function toJSON + * @memberof google.cloud.aiplatform.v1.SearchDataItemsRequest + * @instance + * @returns {Object.} JSON object + */ + SearchDataItemsRequest.prototype.toJSON = function toJSON() { + return this.constructor.toObject(this, $protobuf.util.toJSONOptions); + }; + + /** + * Gets the default type url for SearchDataItemsRequest + * @function getTypeUrl + * @memberof google.cloud.aiplatform.v1.SearchDataItemsRequest + * @static + * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns {string} The default type url + */ + SearchDataItemsRequest.getTypeUrl = function getTypeUrl(typeUrlPrefix) { + if (typeUrlPrefix === undefined) { + typeUrlPrefix = "type.googleapis.com"; + } + return typeUrlPrefix + "/google.cloud.aiplatform.v1.SearchDataItemsRequest"; + }; + + SearchDataItemsRequest.OrderByAnnotation = (function() { + + /** + * Properties of an OrderByAnnotation. + * @memberof google.cloud.aiplatform.v1.SearchDataItemsRequest + * @interface IOrderByAnnotation + * @property {string|null} [savedQuery] OrderByAnnotation savedQuery + * @property {string|null} [orderBy] OrderByAnnotation orderBy + */ + + /** + * Constructs a new OrderByAnnotation. + * @memberof google.cloud.aiplatform.v1.SearchDataItemsRequest + * @classdesc Represents an OrderByAnnotation. + * @implements IOrderByAnnotation + * @constructor + * @param {google.cloud.aiplatform.v1.SearchDataItemsRequest.IOrderByAnnotation=} [properties] Properties to set + */ + function OrderByAnnotation(properties) { + if (properties) + for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) + if (properties[keys[i]] != null) + this[keys[i]] = properties[keys[i]]; + } + + /** + * OrderByAnnotation savedQuery. + * @member {string} savedQuery + * @memberof google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation + * @instance + */ + OrderByAnnotation.prototype.savedQuery = ""; + + /** + * OrderByAnnotation orderBy. + * @member {string} orderBy + * @memberof google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation + * @instance + */ + OrderByAnnotation.prototype.orderBy = ""; + + /** + * Creates a new OrderByAnnotation instance using the specified properties. + * @function create + * @memberof google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation + * @static + * @param {google.cloud.aiplatform.v1.SearchDataItemsRequest.IOrderByAnnotation=} [properties] Properties to set + * @returns {google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation} OrderByAnnotation instance + */ + OrderByAnnotation.create = function create(properties) { + return new OrderByAnnotation(properties); + }; + + /** + * Encodes the specified OrderByAnnotation message. Does not implicitly {@link google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation.verify|verify} messages. + * @function encode + * @memberof google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation + * @static + * @param {google.cloud.aiplatform.v1.SearchDataItemsRequest.IOrderByAnnotation} message OrderByAnnotation message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + OrderByAnnotation.encode = function encode(message, writer) { + if (!writer) + writer = $Writer.create(); + if (message.savedQuery != null && Object.hasOwnProperty.call(message, "savedQuery")) + writer.uint32(/* id 1, wireType 2 =*/10).string(message.savedQuery); + if (message.orderBy != null && Object.hasOwnProperty.call(message, "orderBy")) + writer.uint32(/* id 2, wireType 2 =*/18).string(message.orderBy); + return writer; + }; + + /** + * Encodes the specified OrderByAnnotation message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation.verify|verify} messages. + * @function encodeDelimited + * @memberof google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation + * @static + * @param {google.cloud.aiplatform.v1.SearchDataItemsRequest.IOrderByAnnotation} message OrderByAnnotation message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + OrderByAnnotation.encodeDelimited = function encodeDelimited(message, writer) { + return this.encode(message, writer).ldelim(); + }; + + /** + * Decodes an OrderByAnnotation message from the specified reader or buffer. + * @function decode + * @memberof google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @param {number} [length] Message length if known beforehand + * @returns {google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation} OrderByAnnotation + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + OrderByAnnotation.decode = function decode(reader, length) { + if (!(reader instanceof $Reader)) + reader = $Reader.create(reader); + var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation(); + while (reader.pos < end) { + var tag = reader.uint32(); + switch (tag >>> 3) { + case 1: { + message.savedQuery = reader.string(); + break; + } + case 2: { + message.orderBy = reader.string(); + break; + } + default: + reader.skipType(tag & 7); + break; + } + } + return message; + }; + + /** + * Decodes an OrderByAnnotation message from the specified reader or buffer, length delimited. + * @function decodeDelimited + * @memberof google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @returns {google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation} OrderByAnnotation + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + OrderByAnnotation.decodeDelimited = function decodeDelimited(reader) { + if (!(reader instanceof $Reader)) + reader = new $Reader(reader); + return this.decode(reader, reader.uint32()); + }; + + /** + * Verifies an OrderByAnnotation message. + * @function verify + * @memberof google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation + * @static + * @param {Object.} message Plain object to verify + * @returns {string|null} `null` if valid, otherwise the reason why it is not + */ + OrderByAnnotation.verify = function verify(message) { + if (typeof message !== "object" || message === null) + return "object expected"; + if (message.savedQuery != null && message.hasOwnProperty("savedQuery")) + if (!$util.isString(message.savedQuery)) + return "savedQuery: string expected"; + if (message.orderBy != null && message.hasOwnProperty("orderBy")) + if (!$util.isString(message.orderBy)) + return "orderBy: string expected"; + return null; + }; + + /** + * Creates an OrderByAnnotation message from a plain object. Also converts values to their respective internal types. + * @function fromObject + * @memberof google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation + * @static + * @param {Object.} object Plain object + * @returns {google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation} OrderByAnnotation + */ + OrderByAnnotation.fromObject = function fromObject(object) { + if (object instanceof $root.google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation) + return object; + var message = new $root.google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation(); + if (object.savedQuery != null) + message.savedQuery = String(object.savedQuery); + if (object.orderBy != null) + message.orderBy = String(object.orderBy); + return message; + }; + + /** + * Creates a plain object from an OrderByAnnotation message. Also converts values to other types if specified. + * @function toObject + * @memberof google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation + * @static + * @param {google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation} message OrderByAnnotation + * @param {$protobuf.IConversionOptions} [options] Conversion options + * @returns {Object.} Plain object + */ + OrderByAnnotation.toObject = function toObject(message, options) { + if (!options) + options = {}; + var object = {}; + if (options.defaults) { + object.savedQuery = ""; + object.orderBy = ""; + } + if (message.savedQuery != null && message.hasOwnProperty("savedQuery")) + object.savedQuery = message.savedQuery; + if (message.orderBy != null && message.hasOwnProperty("orderBy")) + object.orderBy = message.orderBy; + return object; + }; + + /** + * Converts this OrderByAnnotation to JSON. + * @function toJSON + * @memberof google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation + * @instance + * @returns {Object.} JSON object + */ + OrderByAnnotation.prototype.toJSON = function toJSON() { + return this.constructor.toObject(this, $protobuf.util.toJSONOptions); + }; + + /** + * Gets the default type url for OrderByAnnotation + * @function getTypeUrl + * @memberof google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation + * @static + * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns {string} The default type url + */ + OrderByAnnotation.getTypeUrl = function getTypeUrl(typeUrlPrefix) { + if (typeUrlPrefix === undefined) { + typeUrlPrefix = "type.googleapis.com"; + } + return typeUrlPrefix + "/google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation"; + }; + + return OrderByAnnotation; + })(); + + return SearchDataItemsRequest; + })(); + + v1.SearchDataItemsResponse = (function() { + + /** + * Properties of a SearchDataItemsResponse. + * @memberof google.cloud.aiplatform.v1 + * @interface ISearchDataItemsResponse + * @property {Array.|null} [dataItemViews] SearchDataItemsResponse dataItemViews + * @property {string|null} [nextPageToken] SearchDataItemsResponse nextPageToken + */ + + /** + * Constructs a new SearchDataItemsResponse. + * @memberof google.cloud.aiplatform.v1 + * @classdesc Represents a SearchDataItemsResponse. + * @implements ISearchDataItemsResponse + * @constructor + * @param {google.cloud.aiplatform.v1.ISearchDataItemsResponse=} [properties] Properties to set + */ + function SearchDataItemsResponse(properties) { + this.dataItemViews = []; + if (properties) + for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) + if (properties[keys[i]] != null) + this[keys[i]] = properties[keys[i]]; + } + + /** + * SearchDataItemsResponse dataItemViews. + * @member {Array.} dataItemViews + * @memberof google.cloud.aiplatform.v1.SearchDataItemsResponse + * @instance + */ + SearchDataItemsResponse.prototype.dataItemViews = $util.emptyArray; + + /** + * SearchDataItemsResponse nextPageToken. + * @member {string} nextPageToken + * @memberof google.cloud.aiplatform.v1.SearchDataItemsResponse + * @instance + */ + SearchDataItemsResponse.prototype.nextPageToken = ""; + + /** + * Creates a new SearchDataItemsResponse instance using the specified properties. + * @function create + * @memberof google.cloud.aiplatform.v1.SearchDataItemsResponse + * @static + * @param {google.cloud.aiplatform.v1.ISearchDataItemsResponse=} [properties] Properties to set + * @returns {google.cloud.aiplatform.v1.SearchDataItemsResponse} SearchDataItemsResponse instance + */ + SearchDataItemsResponse.create = function create(properties) { + return new SearchDataItemsResponse(properties); + }; + + /** + * Encodes the specified SearchDataItemsResponse message. Does not implicitly {@link google.cloud.aiplatform.v1.SearchDataItemsResponse.verify|verify} messages. + * @function encode + * @memberof google.cloud.aiplatform.v1.SearchDataItemsResponse + * @static + * @param {google.cloud.aiplatform.v1.ISearchDataItemsResponse} message SearchDataItemsResponse message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + SearchDataItemsResponse.encode = function encode(message, writer) { + if (!writer) + writer = $Writer.create(); + if (message.dataItemViews != null && message.dataItemViews.length) + for (var i = 0; i < message.dataItemViews.length; ++i) + $root.google.cloud.aiplatform.v1.DataItemView.encode(message.dataItemViews[i], writer.uint32(/* id 1, wireType 2 =*/10).fork()).ldelim(); + if (message.nextPageToken != null && Object.hasOwnProperty.call(message, "nextPageToken")) + writer.uint32(/* id 2, wireType 2 =*/18).string(message.nextPageToken); + return writer; + }; + + /** + * Encodes the specified SearchDataItemsResponse message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.SearchDataItemsResponse.verify|verify} messages. + * @function encodeDelimited + * @memberof google.cloud.aiplatform.v1.SearchDataItemsResponse + * @static + * @param {google.cloud.aiplatform.v1.ISearchDataItemsResponse} message SearchDataItemsResponse message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + SearchDataItemsResponse.encodeDelimited = function encodeDelimited(message, writer) { + return this.encode(message, writer).ldelim(); + }; + + /** + * Decodes a SearchDataItemsResponse message from the specified reader or buffer. + * @function decode + * @memberof google.cloud.aiplatform.v1.SearchDataItemsResponse + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @param {number} [length] Message length if known beforehand + * @returns {google.cloud.aiplatform.v1.SearchDataItemsResponse} SearchDataItemsResponse + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + SearchDataItemsResponse.decode = function decode(reader, length) { + if (!(reader instanceof $Reader)) + reader = $Reader.create(reader); + var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.aiplatform.v1.SearchDataItemsResponse(); + while (reader.pos < end) { + var tag = reader.uint32(); + switch (tag >>> 3) { + case 1: { + if (!(message.dataItemViews && message.dataItemViews.length)) + message.dataItemViews = []; + message.dataItemViews.push($root.google.cloud.aiplatform.v1.DataItemView.decode(reader, reader.uint32())); + break; + } + case 2: { + message.nextPageToken = reader.string(); + break; + } + default: + reader.skipType(tag & 7); + break; + } + } + return message; + }; + + /** + * Decodes a SearchDataItemsResponse message from the specified reader or buffer, length delimited. + * @function decodeDelimited + * @memberof google.cloud.aiplatform.v1.SearchDataItemsResponse + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @returns {google.cloud.aiplatform.v1.SearchDataItemsResponse} SearchDataItemsResponse + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + SearchDataItemsResponse.decodeDelimited = function decodeDelimited(reader) { + if (!(reader instanceof $Reader)) + reader = new $Reader(reader); + return this.decode(reader, reader.uint32()); + }; + + /** + * Verifies a SearchDataItemsResponse message. + * @function verify + * @memberof google.cloud.aiplatform.v1.SearchDataItemsResponse + * @static + * @param {Object.} message Plain object to verify + * @returns {string|null} `null` if valid, otherwise the reason why it is not + */ + SearchDataItemsResponse.verify = function verify(message) { + if (typeof message !== "object" || message === null) + return "object expected"; + if (message.dataItemViews != null && message.hasOwnProperty("dataItemViews")) { + if (!Array.isArray(message.dataItemViews)) + return "dataItemViews: array expected"; + for (var i = 0; i < message.dataItemViews.length; ++i) { + var error = $root.google.cloud.aiplatform.v1.DataItemView.verify(message.dataItemViews[i]); + if (error) + return "dataItemViews." + error; + } + } + if (message.nextPageToken != null && message.hasOwnProperty("nextPageToken")) + if (!$util.isString(message.nextPageToken)) + return "nextPageToken: string expected"; + return null; + }; + + /** + * Creates a SearchDataItemsResponse message from a plain object. Also converts values to their respective internal types. + * @function fromObject + * @memberof google.cloud.aiplatform.v1.SearchDataItemsResponse + * @static + * @param {Object.} object Plain object + * @returns {google.cloud.aiplatform.v1.SearchDataItemsResponse} SearchDataItemsResponse + */ + SearchDataItemsResponse.fromObject = function fromObject(object) { + if (object instanceof $root.google.cloud.aiplatform.v1.SearchDataItemsResponse) + return object; + var message = new $root.google.cloud.aiplatform.v1.SearchDataItemsResponse(); + if (object.dataItemViews) { + if (!Array.isArray(object.dataItemViews)) + throw TypeError(".google.cloud.aiplatform.v1.SearchDataItemsResponse.dataItemViews: array expected"); + message.dataItemViews = []; + for (var i = 0; i < object.dataItemViews.length; ++i) { + if (typeof object.dataItemViews[i] !== "object") + throw TypeError(".google.cloud.aiplatform.v1.SearchDataItemsResponse.dataItemViews: object expected"); + message.dataItemViews[i] = $root.google.cloud.aiplatform.v1.DataItemView.fromObject(object.dataItemViews[i]); + } + } + if (object.nextPageToken != null) + message.nextPageToken = String(object.nextPageToken); + return message; + }; + + /** + * Creates a plain object from a SearchDataItemsResponse message. Also converts values to other types if specified. + * @function toObject + * @memberof google.cloud.aiplatform.v1.SearchDataItemsResponse + * @static + * @param {google.cloud.aiplatform.v1.SearchDataItemsResponse} message SearchDataItemsResponse + * @param {$protobuf.IConversionOptions} [options] Conversion options + * @returns {Object.} Plain object + */ + SearchDataItemsResponse.toObject = function toObject(message, options) { + if (!options) + options = {}; + var object = {}; + if (options.arrays || options.defaults) + object.dataItemViews = []; + if (options.defaults) + object.nextPageToken = ""; + if (message.dataItemViews && message.dataItemViews.length) { + object.dataItemViews = []; + for (var j = 0; j < message.dataItemViews.length; ++j) + object.dataItemViews[j] = $root.google.cloud.aiplatform.v1.DataItemView.toObject(message.dataItemViews[j], options); + } + if (message.nextPageToken != null && message.hasOwnProperty("nextPageToken")) + object.nextPageToken = message.nextPageToken; + return object; + }; + + /** + * Converts this SearchDataItemsResponse to JSON. + * @function toJSON + * @memberof google.cloud.aiplatform.v1.SearchDataItemsResponse + * @instance + * @returns {Object.} JSON object + */ + SearchDataItemsResponse.prototype.toJSON = function toJSON() { + return this.constructor.toObject(this, $protobuf.util.toJSONOptions); + }; + + /** + * Gets the default type url for SearchDataItemsResponse + * @function getTypeUrl + * @memberof google.cloud.aiplatform.v1.SearchDataItemsResponse + * @static + * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns {string} The default type url + */ + SearchDataItemsResponse.getTypeUrl = function getTypeUrl(typeUrlPrefix) { + if (typeUrlPrefix === undefined) { + typeUrlPrefix = "type.googleapis.com"; + } + return typeUrlPrefix + "/google.cloud.aiplatform.v1.SearchDataItemsResponse"; + }; + + return SearchDataItemsResponse; + })(); + + v1.DataItemView = (function() { + + /** + * Properties of a DataItemView. + * @memberof google.cloud.aiplatform.v1 + * @interface IDataItemView + * @property {google.cloud.aiplatform.v1.IDataItem|null} [dataItem] DataItemView dataItem + * @property {Array.|null} [annotations] DataItemView annotations + * @property {boolean|null} [hasTruncatedAnnotations] DataItemView hasTruncatedAnnotations + */ + + /** + * Constructs a new DataItemView. + * @memberof google.cloud.aiplatform.v1 + * @classdesc Represents a DataItemView. + * @implements IDataItemView + * @constructor + * @param {google.cloud.aiplatform.v1.IDataItemView=} [properties] Properties to set + */ + function DataItemView(properties) { + this.annotations = []; + if (properties) + for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) + if (properties[keys[i]] != null) + this[keys[i]] = properties[keys[i]]; + } + + /** + * DataItemView dataItem. + * @member {google.cloud.aiplatform.v1.IDataItem|null|undefined} dataItem + * @memberof google.cloud.aiplatform.v1.DataItemView + * @instance + */ + DataItemView.prototype.dataItem = null; + + /** + * DataItemView annotations. + * @member {Array.} annotations + * @memberof google.cloud.aiplatform.v1.DataItemView + * @instance + */ + DataItemView.prototype.annotations = $util.emptyArray; + + /** + * DataItemView hasTruncatedAnnotations. + * @member {boolean} hasTruncatedAnnotations + * @memberof google.cloud.aiplatform.v1.DataItemView + * @instance + */ + DataItemView.prototype.hasTruncatedAnnotations = false; + + /** + * Creates a new DataItemView instance using the specified properties. + * @function create + * @memberof google.cloud.aiplatform.v1.DataItemView + * @static + * @param {google.cloud.aiplatform.v1.IDataItemView=} [properties] Properties to set + * @returns {google.cloud.aiplatform.v1.DataItemView} DataItemView instance + */ + DataItemView.create = function create(properties) { + return new DataItemView(properties); + }; + + /** + * Encodes the specified DataItemView message. Does not implicitly {@link google.cloud.aiplatform.v1.DataItemView.verify|verify} messages. + * @function encode + * @memberof google.cloud.aiplatform.v1.DataItemView + * @static + * @param {google.cloud.aiplatform.v1.IDataItemView} message DataItemView message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + DataItemView.encode = function encode(message, writer) { + if (!writer) + writer = $Writer.create(); + if (message.dataItem != null && Object.hasOwnProperty.call(message, "dataItem")) + $root.google.cloud.aiplatform.v1.DataItem.encode(message.dataItem, writer.uint32(/* id 1, wireType 2 =*/10).fork()).ldelim(); + if (message.annotations != null && message.annotations.length) + for (var i = 0; i < message.annotations.length; ++i) + $root.google.cloud.aiplatform.v1.Annotation.encode(message.annotations[i], writer.uint32(/* id 2, wireType 2 =*/18).fork()).ldelim(); + if (message.hasTruncatedAnnotations != null && Object.hasOwnProperty.call(message, "hasTruncatedAnnotations")) + writer.uint32(/* id 3, wireType 0 =*/24).bool(message.hasTruncatedAnnotations); + return writer; + }; + + /** + * Encodes the specified DataItemView message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.DataItemView.verify|verify} messages. + * @function encodeDelimited + * @memberof google.cloud.aiplatform.v1.DataItemView + * @static + * @param {google.cloud.aiplatform.v1.IDataItemView} message DataItemView message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + DataItemView.encodeDelimited = function encodeDelimited(message, writer) { + return this.encode(message, writer).ldelim(); + }; + + /** + * Decodes a DataItemView message from the specified reader or buffer. + * @function decode + * @memberof google.cloud.aiplatform.v1.DataItemView + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @param {number} [length] Message length if known beforehand + * @returns {google.cloud.aiplatform.v1.DataItemView} DataItemView + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + DataItemView.decode = function decode(reader, length) { + if (!(reader instanceof $Reader)) + reader = $Reader.create(reader); + var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.aiplatform.v1.DataItemView(); + while (reader.pos < end) { + var tag = reader.uint32(); + switch (tag >>> 3) { + case 1: { + message.dataItem = $root.google.cloud.aiplatform.v1.DataItem.decode(reader, reader.uint32()); + break; + } + case 2: { + if (!(message.annotations && message.annotations.length)) + message.annotations = []; + message.annotations.push($root.google.cloud.aiplatform.v1.Annotation.decode(reader, reader.uint32())); + break; + } + case 3: { + message.hasTruncatedAnnotations = reader.bool(); + break; + } + default: + reader.skipType(tag & 7); + break; + } + } + return message; + }; + + /** + * Decodes a DataItemView message from the specified reader or buffer, length delimited. + * @function decodeDelimited + * @memberof google.cloud.aiplatform.v1.DataItemView + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @returns {google.cloud.aiplatform.v1.DataItemView} DataItemView + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + DataItemView.decodeDelimited = function decodeDelimited(reader) { + if (!(reader instanceof $Reader)) + reader = new $Reader(reader); + return this.decode(reader, reader.uint32()); + }; + + /** + * Verifies a DataItemView message. + * @function verify + * @memberof google.cloud.aiplatform.v1.DataItemView + * @static + * @param {Object.} message Plain object to verify + * @returns {string|null} `null` if valid, otherwise the reason why it is not + */ + DataItemView.verify = function verify(message) { + if (typeof message !== "object" || message === null) + return "object expected"; + if (message.dataItem != null && message.hasOwnProperty("dataItem")) { + var error = $root.google.cloud.aiplatform.v1.DataItem.verify(message.dataItem); + if (error) + return "dataItem." + error; + } + if (message.annotations != null && message.hasOwnProperty("annotations")) { + if (!Array.isArray(message.annotations)) + return "annotations: array expected"; + for (var i = 0; i < message.annotations.length; ++i) { + var error = $root.google.cloud.aiplatform.v1.Annotation.verify(message.annotations[i]); + if (error) + return "annotations." + error; + } + } + if (message.hasTruncatedAnnotations != null && message.hasOwnProperty("hasTruncatedAnnotations")) + if (typeof message.hasTruncatedAnnotations !== "boolean") + return "hasTruncatedAnnotations: boolean expected"; + return null; + }; + + /** + * Creates a DataItemView message from a plain object. Also converts values to their respective internal types. + * @function fromObject + * @memberof google.cloud.aiplatform.v1.DataItemView + * @static + * @param {Object.} object Plain object + * @returns {google.cloud.aiplatform.v1.DataItemView} DataItemView + */ + DataItemView.fromObject = function fromObject(object) { + if (object instanceof $root.google.cloud.aiplatform.v1.DataItemView) + return object; + var message = new $root.google.cloud.aiplatform.v1.DataItemView(); + if (object.dataItem != null) { + if (typeof object.dataItem !== "object") + throw TypeError(".google.cloud.aiplatform.v1.DataItemView.dataItem: object expected"); + message.dataItem = $root.google.cloud.aiplatform.v1.DataItem.fromObject(object.dataItem); + } + if (object.annotations) { + if (!Array.isArray(object.annotations)) + throw TypeError(".google.cloud.aiplatform.v1.DataItemView.annotations: array expected"); + message.annotations = []; + for (var i = 0; i < object.annotations.length; ++i) { + if (typeof object.annotations[i] !== "object") + throw TypeError(".google.cloud.aiplatform.v1.DataItemView.annotations: object expected"); + message.annotations[i] = $root.google.cloud.aiplatform.v1.Annotation.fromObject(object.annotations[i]); + } + } + if (object.hasTruncatedAnnotations != null) + message.hasTruncatedAnnotations = Boolean(object.hasTruncatedAnnotations); + return message; + }; + + /** + * Creates a plain object from a DataItemView message. Also converts values to other types if specified. + * @function toObject + * @memberof google.cloud.aiplatform.v1.DataItemView + * @static + * @param {google.cloud.aiplatform.v1.DataItemView} message DataItemView + * @param {$protobuf.IConversionOptions} [options] Conversion options + * @returns {Object.} Plain object + */ + DataItemView.toObject = function toObject(message, options) { + if (!options) + options = {}; + var object = {}; + if (options.arrays || options.defaults) + object.annotations = []; + if (options.defaults) { + object.dataItem = null; + object.hasTruncatedAnnotations = false; + } + if (message.dataItem != null && message.hasOwnProperty("dataItem")) + object.dataItem = $root.google.cloud.aiplatform.v1.DataItem.toObject(message.dataItem, options); + if (message.annotations && message.annotations.length) { + object.annotations = []; + for (var j = 0; j < message.annotations.length; ++j) + object.annotations[j] = $root.google.cloud.aiplatform.v1.Annotation.toObject(message.annotations[j], options); + } + if (message.hasTruncatedAnnotations != null && message.hasOwnProperty("hasTruncatedAnnotations")) + object.hasTruncatedAnnotations = message.hasTruncatedAnnotations; + return object; + }; + + /** + * Converts this DataItemView to JSON. + * @function toJSON + * @memberof google.cloud.aiplatform.v1.DataItemView + * @instance + * @returns {Object.} JSON object + */ + DataItemView.prototype.toJSON = function toJSON() { + return this.constructor.toObject(this, $protobuf.util.toJSONOptions); + }; + + /** + * Gets the default type url for DataItemView + * @function getTypeUrl + * @memberof google.cloud.aiplatform.v1.DataItemView + * @static + * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns {string} The default type url + */ + DataItemView.getTypeUrl = function getTypeUrl(typeUrlPrefix) { + if (typeUrlPrefix === undefined) { + typeUrlPrefix = "type.googleapis.com"; + } + return typeUrlPrefix + "/google.cloud.aiplatform.v1.DataItemView"; + }; + + return DataItemView; + })(); + v1.ListSavedQueriesRequest = (function() { /** @@ -29683,432 +31957,6 @@ return DeleteOperationMetadata; })(); - v1.SavedQuery = (function() { - - /** - * Properties of a SavedQuery. - * @memberof google.cloud.aiplatform.v1 - * @interface ISavedQuery - * @property {string|null} [name] SavedQuery name - * @property {string|null} [displayName] SavedQuery displayName - * @property {google.protobuf.IValue|null} [metadata] SavedQuery metadata - * @property {google.protobuf.ITimestamp|null} [createTime] SavedQuery createTime - * @property {google.protobuf.ITimestamp|null} [updateTime] SavedQuery updateTime - * @property {string|null} [annotationFilter] SavedQuery annotationFilter - * @property {string|null} [problemType] SavedQuery problemType - * @property {number|null} [annotationSpecCount] SavedQuery annotationSpecCount - * @property {string|null} [etag] SavedQuery etag - * @property {boolean|null} [supportAutomlTraining] SavedQuery supportAutomlTraining - */ - - /** - * Constructs a new SavedQuery. - * @memberof google.cloud.aiplatform.v1 - * @classdesc Represents a SavedQuery. - * @implements ISavedQuery - * @constructor - * @param {google.cloud.aiplatform.v1.ISavedQuery=} [properties] Properties to set - */ - function SavedQuery(properties) { - if (properties) - for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) - if (properties[keys[i]] != null) - this[keys[i]] = properties[keys[i]]; - } - - /** - * SavedQuery name. - * @member {string} name - * @memberof google.cloud.aiplatform.v1.SavedQuery - * @instance - */ - SavedQuery.prototype.name = ""; - - /** - * SavedQuery displayName. - * @member {string} displayName - * @memberof google.cloud.aiplatform.v1.SavedQuery - * @instance - */ - SavedQuery.prototype.displayName = ""; - - /** - * SavedQuery metadata. - * @member {google.protobuf.IValue|null|undefined} metadata - * @memberof google.cloud.aiplatform.v1.SavedQuery - * @instance - */ - SavedQuery.prototype.metadata = null; - - /** - * SavedQuery createTime. - * @member {google.protobuf.ITimestamp|null|undefined} createTime - * @memberof google.cloud.aiplatform.v1.SavedQuery - * @instance - */ - SavedQuery.prototype.createTime = null; - - /** - * SavedQuery updateTime. - * @member {google.protobuf.ITimestamp|null|undefined} updateTime - * @memberof google.cloud.aiplatform.v1.SavedQuery - * @instance - */ - SavedQuery.prototype.updateTime = null; - - /** - * SavedQuery annotationFilter. - * @member {string} annotationFilter - * @memberof google.cloud.aiplatform.v1.SavedQuery - * @instance - */ - SavedQuery.prototype.annotationFilter = ""; - - /** - * SavedQuery problemType. - * @member {string} problemType - * @memberof google.cloud.aiplatform.v1.SavedQuery - * @instance - */ - SavedQuery.prototype.problemType = ""; - - /** - * SavedQuery annotationSpecCount. - * @member {number} annotationSpecCount - * @memberof google.cloud.aiplatform.v1.SavedQuery - * @instance - */ - SavedQuery.prototype.annotationSpecCount = 0; - - /** - * SavedQuery etag. - * @member {string} etag - * @memberof google.cloud.aiplatform.v1.SavedQuery - * @instance - */ - SavedQuery.prototype.etag = ""; - - /** - * SavedQuery supportAutomlTraining. - * @member {boolean} supportAutomlTraining - * @memberof google.cloud.aiplatform.v1.SavedQuery - * @instance - */ - SavedQuery.prototype.supportAutomlTraining = false; - - /** - * Creates a new SavedQuery instance using the specified properties. - * @function create - * @memberof google.cloud.aiplatform.v1.SavedQuery - * @static - * @param {google.cloud.aiplatform.v1.ISavedQuery=} [properties] Properties to set - * @returns {google.cloud.aiplatform.v1.SavedQuery} SavedQuery instance - */ - SavedQuery.create = function create(properties) { - return new SavedQuery(properties); - }; - - /** - * Encodes the specified SavedQuery message. Does not implicitly {@link google.cloud.aiplatform.v1.SavedQuery.verify|verify} messages. - * @function encode - * @memberof google.cloud.aiplatform.v1.SavedQuery - * @static - * @param {google.cloud.aiplatform.v1.ISavedQuery} message SavedQuery message or plain object to encode - * @param {$protobuf.Writer} [writer] Writer to encode to - * @returns {$protobuf.Writer} Writer - */ - SavedQuery.encode = function encode(message, writer) { - if (!writer) - writer = $Writer.create(); - if (message.name != null && Object.hasOwnProperty.call(message, "name")) - writer.uint32(/* id 1, wireType 2 =*/10).string(message.name); - if (message.displayName != null && Object.hasOwnProperty.call(message, "displayName")) - writer.uint32(/* id 2, wireType 2 =*/18).string(message.displayName); - if (message.createTime != null && Object.hasOwnProperty.call(message, "createTime")) - $root.google.protobuf.Timestamp.encode(message.createTime, writer.uint32(/* id 3, wireType 2 =*/26).fork()).ldelim(); - if (message.updateTime != null && Object.hasOwnProperty.call(message, "updateTime")) - $root.google.protobuf.Timestamp.encode(message.updateTime, writer.uint32(/* id 4, wireType 2 =*/34).fork()).ldelim(); - if (message.annotationFilter != null && Object.hasOwnProperty.call(message, "annotationFilter")) - writer.uint32(/* id 5, wireType 2 =*/42).string(message.annotationFilter); - if (message.problemType != null && Object.hasOwnProperty.call(message, "problemType")) - writer.uint32(/* id 6, wireType 2 =*/50).string(message.problemType); - if (message.etag != null && Object.hasOwnProperty.call(message, "etag")) - writer.uint32(/* id 8, wireType 2 =*/66).string(message.etag); - if (message.supportAutomlTraining != null && Object.hasOwnProperty.call(message, "supportAutomlTraining")) - writer.uint32(/* id 9, wireType 0 =*/72).bool(message.supportAutomlTraining); - if (message.annotationSpecCount != null && Object.hasOwnProperty.call(message, "annotationSpecCount")) - writer.uint32(/* id 10, wireType 0 =*/80).int32(message.annotationSpecCount); - if (message.metadata != null && Object.hasOwnProperty.call(message, "metadata")) - $root.google.protobuf.Value.encode(message.metadata, writer.uint32(/* id 12, wireType 2 =*/98).fork()).ldelim(); - return writer; - }; - - /** - * Encodes the specified SavedQuery message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.SavedQuery.verify|verify} messages. - * @function encodeDelimited - * @memberof google.cloud.aiplatform.v1.SavedQuery - * @static - * @param {google.cloud.aiplatform.v1.ISavedQuery} message SavedQuery message or plain object to encode - * @param {$protobuf.Writer} [writer] Writer to encode to - * @returns {$protobuf.Writer} Writer - */ - SavedQuery.encodeDelimited = function encodeDelimited(message, writer) { - return this.encode(message, writer).ldelim(); - }; - - /** - * Decodes a SavedQuery message from the specified reader or buffer. - * @function decode - * @memberof google.cloud.aiplatform.v1.SavedQuery - * @static - * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from - * @param {number} [length] Message length if known beforehand - * @returns {google.cloud.aiplatform.v1.SavedQuery} SavedQuery - * @throws {Error} If the payload is not a reader or valid buffer - * @throws {$protobuf.util.ProtocolError} If required fields are missing - */ - SavedQuery.decode = function decode(reader, length) { - if (!(reader instanceof $Reader)) - reader = $Reader.create(reader); - var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.aiplatform.v1.SavedQuery(); - while (reader.pos < end) { - var tag = reader.uint32(); - switch (tag >>> 3) { - case 1: { - message.name = reader.string(); - break; - } - case 2: { - message.displayName = reader.string(); - break; - } - case 12: { - message.metadata = $root.google.protobuf.Value.decode(reader, reader.uint32()); - break; - } - case 3: { - message.createTime = $root.google.protobuf.Timestamp.decode(reader, reader.uint32()); - break; - } - case 4: { - message.updateTime = $root.google.protobuf.Timestamp.decode(reader, reader.uint32()); - break; - } - case 5: { - message.annotationFilter = reader.string(); - break; - } - case 6: { - message.problemType = reader.string(); - break; - } - case 10: { - message.annotationSpecCount = reader.int32(); - break; - } - case 8: { - message.etag = reader.string(); - break; - } - case 9: { - message.supportAutomlTraining = reader.bool(); - break; - } - default: - reader.skipType(tag & 7); - break; - } - } - return message; - }; - - /** - * Decodes a SavedQuery message from the specified reader or buffer, length delimited. - * @function decodeDelimited - * @memberof google.cloud.aiplatform.v1.SavedQuery - * @static - * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from - * @returns {google.cloud.aiplatform.v1.SavedQuery} SavedQuery - * @throws {Error} If the payload is not a reader or valid buffer - * @throws {$protobuf.util.ProtocolError} If required fields are missing - */ - SavedQuery.decodeDelimited = function decodeDelimited(reader) { - if (!(reader instanceof $Reader)) - reader = new $Reader(reader); - return this.decode(reader, reader.uint32()); - }; - - /** - * Verifies a SavedQuery message. - * @function verify - * @memberof google.cloud.aiplatform.v1.SavedQuery - * @static - * @param {Object.} message Plain object to verify - * @returns {string|null} `null` if valid, otherwise the reason why it is not - */ - SavedQuery.verify = function verify(message) { - if (typeof message !== "object" || message === null) - return "object expected"; - if (message.name != null && message.hasOwnProperty("name")) - if (!$util.isString(message.name)) - return "name: string expected"; - if (message.displayName != null && message.hasOwnProperty("displayName")) - if (!$util.isString(message.displayName)) - return "displayName: string expected"; - if (message.metadata != null && message.hasOwnProperty("metadata")) { - var error = $root.google.protobuf.Value.verify(message.metadata); - if (error) - return "metadata." + error; - } - if (message.createTime != null && message.hasOwnProperty("createTime")) { - var error = $root.google.protobuf.Timestamp.verify(message.createTime); - if (error) - return "createTime." + error; - } - if (message.updateTime != null && message.hasOwnProperty("updateTime")) { - var error = $root.google.protobuf.Timestamp.verify(message.updateTime); - if (error) - return "updateTime." + error; - } - if (message.annotationFilter != null && message.hasOwnProperty("annotationFilter")) - if (!$util.isString(message.annotationFilter)) - return "annotationFilter: string expected"; - if (message.problemType != null && message.hasOwnProperty("problemType")) - if (!$util.isString(message.problemType)) - return "problemType: string expected"; - if (message.annotationSpecCount != null && message.hasOwnProperty("annotationSpecCount")) - if (!$util.isInteger(message.annotationSpecCount)) - return "annotationSpecCount: integer expected"; - if (message.etag != null && message.hasOwnProperty("etag")) - if (!$util.isString(message.etag)) - return "etag: string expected"; - if (message.supportAutomlTraining != null && message.hasOwnProperty("supportAutomlTraining")) - if (typeof message.supportAutomlTraining !== "boolean") - return "supportAutomlTraining: boolean expected"; - return null; - }; - - /** - * Creates a SavedQuery message from a plain object. Also converts values to their respective internal types. - * @function fromObject - * @memberof google.cloud.aiplatform.v1.SavedQuery - * @static - * @param {Object.} object Plain object - * @returns {google.cloud.aiplatform.v1.SavedQuery} SavedQuery - */ - SavedQuery.fromObject = function fromObject(object) { - if (object instanceof $root.google.cloud.aiplatform.v1.SavedQuery) - return object; - var message = new $root.google.cloud.aiplatform.v1.SavedQuery(); - if (object.name != null) - message.name = String(object.name); - if (object.displayName != null) - message.displayName = String(object.displayName); - if (object.metadata != null) { - if (typeof object.metadata !== "object") - throw TypeError(".google.cloud.aiplatform.v1.SavedQuery.metadata: object expected"); - message.metadata = $root.google.protobuf.Value.fromObject(object.metadata); - } - if (object.createTime != null) { - if (typeof object.createTime !== "object") - throw TypeError(".google.cloud.aiplatform.v1.SavedQuery.createTime: object expected"); - message.createTime = $root.google.protobuf.Timestamp.fromObject(object.createTime); - } - if (object.updateTime != null) { - if (typeof object.updateTime !== "object") - throw TypeError(".google.cloud.aiplatform.v1.SavedQuery.updateTime: object expected"); - message.updateTime = $root.google.protobuf.Timestamp.fromObject(object.updateTime); - } - if (object.annotationFilter != null) - message.annotationFilter = String(object.annotationFilter); - if (object.problemType != null) - message.problemType = String(object.problemType); - if (object.annotationSpecCount != null) - message.annotationSpecCount = object.annotationSpecCount | 0; - if (object.etag != null) - message.etag = String(object.etag); - if (object.supportAutomlTraining != null) - message.supportAutomlTraining = Boolean(object.supportAutomlTraining); - return message; - }; - - /** - * Creates a plain object from a SavedQuery message. Also converts values to other types if specified. - * @function toObject - * @memberof google.cloud.aiplatform.v1.SavedQuery - * @static - * @param {google.cloud.aiplatform.v1.SavedQuery} message SavedQuery - * @param {$protobuf.IConversionOptions} [options] Conversion options - * @returns {Object.} Plain object - */ - SavedQuery.toObject = function toObject(message, options) { - if (!options) - options = {}; - var object = {}; - if (options.defaults) { - object.name = ""; - object.displayName = ""; - object.createTime = null; - object.updateTime = null; - object.annotationFilter = ""; - object.problemType = ""; - object.etag = ""; - object.supportAutomlTraining = false; - object.annotationSpecCount = 0; - object.metadata = null; - } - if (message.name != null && message.hasOwnProperty("name")) - object.name = message.name; - if (message.displayName != null && message.hasOwnProperty("displayName")) - object.displayName = message.displayName; - if (message.createTime != null && message.hasOwnProperty("createTime")) - object.createTime = $root.google.protobuf.Timestamp.toObject(message.createTime, options); - if (message.updateTime != null && message.hasOwnProperty("updateTime")) - object.updateTime = $root.google.protobuf.Timestamp.toObject(message.updateTime, options); - if (message.annotationFilter != null && message.hasOwnProperty("annotationFilter")) - object.annotationFilter = message.annotationFilter; - if (message.problemType != null && message.hasOwnProperty("problemType")) - object.problemType = message.problemType; - if (message.etag != null && message.hasOwnProperty("etag")) - object.etag = message.etag; - if (message.supportAutomlTraining != null && message.hasOwnProperty("supportAutomlTraining")) - object.supportAutomlTraining = message.supportAutomlTraining; - if (message.annotationSpecCount != null && message.hasOwnProperty("annotationSpecCount")) - object.annotationSpecCount = message.annotationSpecCount; - if (message.metadata != null && message.hasOwnProperty("metadata")) - object.metadata = $root.google.protobuf.Value.toObject(message.metadata, options); - return object; - }; - - /** - * Converts this SavedQuery to JSON. - * @function toJSON - * @memberof google.cloud.aiplatform.v1.SavedQuery - * @instance - * @returns {Object.} JSON object - */ - SavedQuery.prototype.toJSON = function toJSON() { - return this.constructor.toObject(this, $protobuf.util.toJSONOptions); - }; - - /** - * Gets the default type url for SavedQuery - * @function getTypeUrl - * @memberof google.cloud.aiplatform.v1.SavedQuery - * @static - * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") - * @returns {string} The default type url - */ - SavedQuery.getTypeUrl = function getTypeUrl(typeUrlPrefix) { - if (typeUrlPrefix === undefined) { - typeUrlPrefix = "type.googleapis.com"; - } - return typeUrlPrefix + "/google.cloud.aiplatform.v1.SavedQuery"; - }; - - return SavedQuery; - })(); - v1.DeployedIndexRef = (function() { /** @@ -40331,9 +42179,734 @@ * @variation 2 */ + /** + * Callback as used by {@link google.cloud.aiplatform.v1.FeaturestoreOnlineServingService|writeFeatureValues}. + * @memberof google.cloud.aiplatform.v1.FeaturestoreOnlineServingService + * @typedef WriteFeatureValuesCallback + * @type {function} + * @param {Error|null} error Error, if any + * @param {google.cloud.aiplatform.v1.WriteFeatureValuesResponse} [response] WriteFeatureValuesResponse + */ + + /** + * Calls WriteFeatureValues. + * @function writeFeatureValues + * @memberof google.cloud.aiplatform.v1.FeaturestoreOnlineServingService + * @instance + * @param {google.cloud.aiplatform.v1.IWriteFeatureValuesRequest} request WriteFeatureValuesRequest message or plain object + * @param {google.cloud.aiplatform.v1.FeaturestoreOnlineServingService.WriteFeatureValuesCallback} callback Node-style callback called with the error, if any, and WriteFeatureValuesResponse + * @returns {undefined} + * @variation 1 + */ + Object.defineProperty(FeaturestoreOnlineServingService.prototype.writeFeatureValues = function writeFeatureValues(request, callback) { + return this.rpcCall(writeFeatureValues, $root.google.cloud.aiplatform.v1.WriteFeatureValuesRequest, $root.google.cloud.aiplatform.v1.WriteFeatureValuesResponse, request, callback); + }, "name", { value: "WriteFeatureValues" }); + + /** + * Calls WriteFeatureValues. + * @function writeFeatureValues + * @memberof google.cloud.aiplatform.v1.FeaturestoreOnlineServingService + * @instance + * @param {google.cloud.aiplatform.v1.IWriteFeatureValuesRequest} request WriteFeatureValuesRequest message or plain object + * @returns {Promise} Promise + * @variation 2 + */ + return FeaturestoreOnlineServingService; })(); + v1.WriteFeatureValuesRequest = (function() { + + /** + * Properties of a WriteFeatureValuesRequest. + * @memberof google.cloud.aiplatform.v1 + * @interface IWriteFeatureValuesRequest + * @property {string|null} [entityType] WriteFeatureValuesRequest entityType + * @property {Array.|null} [payloads] WriteFeatureValuesRequest payloads + */ + + /** + * Constructs a new WriteFeatureValuesRequest. + * @memberof google.cloud.aiplatform.v1 + * @classdesc Represents a WriteFeatureValuesRequest. + * @implements IWriteFeatureValuesRequest + * @constructor + * @param {google.cloud.aiplatform.v1.IWriteFeatureValuesRequest=} [properties] Properties to set + */ + function WriteFeatureValuesRequest(properties) { + this.payloads = []; + if (properties) + for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) + if (properties[keys[i]] != null) + this[keys[i]] = properties[keys[i]]; + } + + /** + * WriteFeatureValuesRequest entityType. + * @member {string} entityType + * @memberof google.cloud.aiplatform.v1.WriteFeatureValuesRequest + * @instance + */ + WriteFeatureValuesRequest.prototype.entityType = ""; + + /** + * WriteFeatureValuesRequest payloads. + * @member {Array.} payloads + * @memberof google.cloud.aiplatform.v1.WriteFeatureValuesRequest + * @instance + */ + WriteFeatureValuesRequest.prototype.payloads = $util.emptyArray; + + /** + * Creates a new WriteFeatureValuesRequest instance using the specified properties. + * @function create + * @memberof google.cloud.aiplatform.v1.WriteFeatureValuesRequest + * @static + * @param {google.cloud.aiplatform.v1.IWriteFeatureValuesRequest=} [properties] Properties to set + * @returns {google.cloud.aiplatform.v1.WriteFeatureValuesRequest} WriteFeatureValuesRequest instance + */ + WriteFeatureValuesRequest.create = function create(properties) { + return new WriteFeatureValuesRequest(properties); + }; + + /** + * Encodes the specified WriteFeatureValuesRequest message. Does not implicitly {@link google.cloud.aiplatform.v1.WriteFeatureValuesRequest.verify|verify} messages. + * @function encode + * @memberof google.cloud.aiplatform.v1.WriteFeatureValuesRequest + * @static + * @param {google.cloud.aiplatform.v1.IWriteFeatureValuesRequest} message WriteFeatureValuesRequest message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + WriteFeatureValuesRequest.encode = function encode(message, writer) { + if (!writer) + writer = $Writer.create(); + if (message.entityType != null && Object.hasOwnProperty.call(message, "entityType")) + writer.uint32(/* id 1, wireType 2 =*/10).string(message.entityType); + if (message.payloads != null && message.payloads.length) + for (var i = 0; i < message.payloads.length; ++i) + $root.google.cloud.aiplatform.v1.WriteFeatureValuesPayload.encode(message.payloads[i], writer.uint32(/* id 2, wireType 2 =*/18).fork()).ldelim(); + return writer; + }; + + /** + * Encodes the specified WriteFeatureValuesRequest message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.WriteFeatureValuesRequest.verify|verify} messages. + * @function encodeDelimited + * @memberof google.cloud.aiplatform.v1.WriteFeatureValuesRequest + * @static + * @param {google.cloud.aiplatform.v1.IWriteFeatureValuesRequest} message WriteFeatureValuesRequest message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + WriteFeatureValuesRequest.encodeDelimited = function encodeDelimited(message, writer) { + return this.encode(message, writer).ldelim(); + }; + + /** + * Decodes a WriteFeatureValuesRequest message from the specified reader or buffer. + * @function decode + * @memberof google.cloud.aiplatform.v1.WriteFeatureValuesRequest + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @param {number} [length] Message length if known beforehand + * @returns {google.cloud.aiplatform.v1.WriteFeatureValuesRequest} WriteFeatureValuesRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + WriteFeatureValuesRequest.decode = function decode(reader, length) { + if (!(reader instanceof $Reader)) + reader = $Reader.create(reader); + var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.aiplatform.v1.WriteFeatureValuesRequest(); + while (reader.pos < end) { + var tag = reader.uint32(); + switch (tag >>> 3) { + case 1: { + message.entityType = reader.string(); + break; + } + case 2: { + if (!(message.payloads && message.payloads.length)) + message.payloads = []; + message.payloads.push($root.google.cloud.aiplatform.v1.WriteFeatureValuesPayload.decode(reader, reader.uint32())); + break; + } + default: + reader.skipType(tag & 7); + break; + } + } + return message; + }; + + /** + * Decodes a WriteFeatureValuesRequest message from the specified reader or buffer, length delimited. + * @function decodeDelimited + * @memberof google.cloud.aiplatform.v1.WriteFeatureValuesRequest + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @returns {google.cloud.aiplatform.v1.WriteFeatureValuesRequest} WriteFeatureValuesRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + WriteFeatureValuesRequest.decodeDelimited = function decodeDelimited(reader) { + if (!(reader instanceof $Reader)) + reader = new $Reader(reader); + return this.decode(reader, reader.uint32()); + }; + + /** + * Verifies a WriteFeatureValuesRequest message. + * @function verify + * @memberof google.cloud.aiplatform.v1.WriteFeatureValuesRequest + * @static + * @param {Object.} message Plain object to verify + * @returns {string|null} `null` if valid, otherwise the reason why it is not + */ + WriteFeatureValuesRequest.verify = function verify(message) { + if (typeof message !== "object" || message === null) + return "object expected"; + if (message.entityType != null && message.hasOwnProperty("entityType")) + if (!$util.isString(message.entityType)) + return "entityType: string expected"; + if (message.payloads != null && message.hasOwnProperty("payloads")) { + if (!Array.isArray(message.payloads)) + return "payloads: array expected"; + for (var i = 0; i < message.payloads.length; ++i) { + var error = $root.google.cloud.aiplatform.v1.WriteFeatureValuesPayload.verify(message.payloads[i]); + if (error) + return "payloads." + error; + } + } + return null; + }; + + /** + * Creates a WriteFeatureValuesRequest message from a plain object. Also converts values to their respective internal types. + * @function fromObject + * @memberof google.cloud.aiplatform.v1.WriteFeatureValuesRequest + * @static + * @param {Object.} object Plain object + * @returns {google.cloud.aiplatform.v1.WriteFeatureValuesRequest} WriteFeatureValuesRequest + */ + WriteFeatureValuesRequest.fromObject = function fromObject(object) { + if (object instanceof $root.google.cloud.aiplatform.v1.WriteFeatureValuesRequest) + return object; + var message = new $root.google.cloud.aiplatform.v1.WriteFeatureValuesRequest(); + if (object.entityType != null) + message.entityType = String(object.entityType); + if (object.payloads) { + if (!Array.isArray(object.payloads)) + throw TypeError(".google.cloud.aiplatform.v1.WriteFeatureValuesRequest.payloads: array expected"); + message.payloads = []; + for (var i = 0; i < object.payloads.length; ++i) { + if (typeof object.payloads[i] !== "object") + throw TypeError(".google.cloud.aiplatform.v1.WriteFeatureValuesRequest.payloads: object expected"); + message.payloads[i] = $root.google.cloud.aiplatform.v1.WriteFeatureValuesPayload.fromObject(object.payloads[i]); + } + } + return message; + }; + + /** + * Creates a plain object from a WriteFeatureValuesRequest message. Also converts values to other types if specified. + * @function toObject + * @memberof google.cloud.aiplatform.v1.WriteFeatureValuesRequest + * @static + * @param {google.cloud.aiplatform.v1.WriteFeatureValuesRequest} message WriteFeatureValuesRequest + * @param {$protobuf.IConversionOptions} [options] Conversion options + * @returns {Object.} Plain object + */ + WriteFeatureValuesRequest.toObject = function toObject(message, options) { + if (!options) + options = {}; + var object = {}; + if (options.arrays || options.defaults) + object.payloads = []; + if (options.defaults) + object.entityType = ""; + if (message.entityType != null && message.hasOwnProperty("entityType")) + object.entityType = message.entityType; + if (message.payloads && message.payloads.length) { + object.payloads = []; + for (var j = 0; j < message.payloads.length; ++j) + object.payloads[j] = $root.google.cloud.aiplatform.v1.WriteFeatureValuesPayload.toObject(message.payloads[j], options); + } + return object; + }; + + /** + * Converts this WriteFeatureValuesRequest to JSON. + * @function toJSON + * @memberof google.cloud.aiplatform.v1.WriteFeatureValuesRequest + * @instance + * @returns {Object.} JSON object + */ + WriteFeatureValuesRequest.prototype.toJSON = function toJSON() { + return this.constructor.toObject(this, $protobuf.util.toJSONOptions); + }; + + /** + * Gets the default type url for WriteFeatureValuesRequest + * @function getTypeUrl + * @memberof google.cloud.aiplatform.v1.WriteFeatureValuesRequest + * @static + * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns {string} The default type url + */ + WriteFeatureValuesRequest.getTypeUrl = function getTypeUrl(typeUrlPrefix) { + if (typeUrlPrefix === undefined) { + typeUrlPrefix = "type.googleapis.com"; + } + return typeUrlPrefix + "/google.cloud.aiplatform.v1.WriteFeatureValuesRequest"; + }; + + return WriteFeatureValuesRequest; + })(); + + v1.WriteFeatureValuesPayload = (function() { + + /** + * Properties of a WriteFeatureValuesPayload. + * @memberof google.cloud.aiplatform.v1 + * @interface IWriteFeatureValuesPayload + * @property {string|null} [entityId] WriteFeatureValuesPayload entityId + * @property {Object.|null} [featureValues] WriteFeatureValuesPayload featureValues + */ + + /** + * Constructs a new WriteFeatureValuesPayload. + * @memberof google.cloud.aiplatform.v1 + * @classdesc Represents a WriteFeatureValuesPayload. + * @implements IWriteFeatureValuesPayload + * @constructor + * @param {google.cloud.aiplatform.v1.IWriteFeatureValuesPayload=} [properties] Properties to set + */ + function WriteFeatureValuesPayload(properties) { + this.featureValues = {}; + if (properties) + for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) + if (properties[keys[i]] != null) + this[keys[i]] = properties[keys[i]]; + } + + /** + * WriteFeatureValuesPayload entityId. + * @member {string} entityId + * @memberof google.cloud.aiplatform.v1.WriteFeatureValuesPayload + * @instance + */ + WriteFeatureValuesPayload.prototype.entityId = ""; + + /** + * WriteFeatureValuesPayload featureValues. + * @member {Object.} featureValues + * @memberof google.cloud.aiplatform.v1.WriteFeatureValuesPayload + * @instance + */ + WriteFeatureValuesPayload.prototype.featureValues = $util.emptyObject; + + /** + * Creates a new WriteFeatureValuesPayload instance using the specified properties. + * @function create + * @memberof google.cloud.aiplatform.v1.WriteFeatureValuesPayload + * @static + * @param {google.cloud.aiplatform.v1.IWriteFeatureValuesPayload=} [properties] Properties to set + * @returns {google.cloud.aiplatform.v1.WriteFeatureValuesPayload} WriteFeatureValuesPayload instance + */ + WriteFeatureValuesPayload.create = function create(properties) { + return new WriteFeatureValuesPayload(properties); + }; + + /** + * Encodes the specified WriteFeatureValuesPayload message. Does not implicitly {@link google.cloud.aiplatform.v1.WriteFeatureValuesPayload.verify|verify} messages. + * @function encode + * @memberof google.cloud.aiplatform.v1.WriteFeatureValuesPayload + * @static + * @param {google.cloud.aiplatform.v1.IWriteFeatureValuesPayload} message WriteFeatureValuesPayload message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + WriteFeatureValuesPayload.encode = function encode(message, writer) { + if (!writer) + writer = $Writer.create(); + if (message.entityId != null && Object.hasOwnProperty.call(message, "entityId")) + writer.uint32(/* id 1, wireType 2 =*/10).string(message.entityId); + if (message.featureValues != null && Object.hasOwnProperty.call(message, "featureValues")) + for (var keys = Object.keys(message.featureValues), i = 0; i < keys.length; ++i) { + writer.uint32(/* id 2, wireType 2 =*/18).fork().uint32(/* id 1, wireType 2 =*/10).string(keys[i]); + $root.google.cloud.aiplatform.v1.FeatureValue.encode(message.featureValues[keys[i]], writer.uint32(/* id 2, wireType 2 =*/18).fork()).ldelim().ldelim(); + } + return writer; + }; + + /** + * Encodes the specified WriteFeatureValuesPayload message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.WriteFeatureValuesPayload.verify|verify} messages. + * @function encodeDelimited + * @memberof google.cloud.aiplatform.v1.WriteFeatureValuesPayload + * @static + * @param {google.cloud.aiplatform.v1.IWriteFeatureValuesPayload} message WriteFeatureValuesPayload message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + WriteFeatureValuesPayload.encodeDelimited = function encodeDelimited(message, writer) { + return this.encode(message, writer).ldelim(); + }; + + /** + * Decodes a WriteFeatureValuesPayload message from the specified reader or buffer. + * @function decode + * @memberof google.cloud.aiplatform.v1.WriteFeatureValuesPayload + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @param {number} [length] Message length if known beforehand + * @returns {google.cloud.aiplatform.v1.WriteFeatureValuesPayload} WriteFeatureValuesPayload + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + WriteFeatureValuesPayload.decode = function decode(reader, length) { + if (!(reader instanceof $Reader)) + reader = $Reader.create(reader); + var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.aiplatform.v1.WriteFeatureValuesPayload(), key, value; + while (reader.pos < end) { + var tag = reader.uint32(); + switch (tag >>> 3) { + case 1: { + message.entityId = reader.string(); + break; + } + case 2: { + if (message.featureValues === $util.emptyObject) + message.featureValues = {}; + var end2 = reader.uint32() + reader.pos; + key = ""; + value = null; + while (reader.pos < end2) { + var tag2 = reader.uint32(); + switch (tag2 >>> 3) { + case 1: + key = reader.string(); + break; + case 2: + value = $root.google.cloud.aiplatform.v1.FeatureValue.decode(reader, reader.uint32()); + break; + default: + reader.skipType(tag2 & 7); + break; + } + } + message.featureValues[key] = value; + break; + } + default: + reader.skipType(tag & 7); + break; + } + } + return message; + }; + + /** + * Decodes a WriteFeatureValuesPayload message from the specified reader or buffer, length delimited. + * @function decodeDelimited + * @memberof google.cloud.aiplatform.v1.WriteFeatureValuesPayload + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @returns {google.cloud.aiplatform.v1.WriteFeatureValuesPayload} WriteFeatureValuesPayload + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + WriteFeatureValuesPayload.decodeDelimited = function decodeDelimited(reader) { + if (!(reader instanceof $Reader)) + reader = new $Reader(reader); + return this.decode(reader, reader.uint32()); + }; + + /** + * Verifies a WriteFeatureValuesPayload message. + * @function verify + * @memberof google.cloud.aiplatform.v1.WriteFeatureValuesPayload + * @static + * @param {Object.} message Plain object to verify + * @returns {string|null} `null` if valid, otherwise the reason why it is not + */ + WriteFeatureValuesPayload.verify = function verify(message) { + if (typeof message !== "object" || message === null) + return "object expected"; + if (message.entityId != null && message.hasOwnProperty("entityId")) + if (!$util.isString(message.entityId)) + return "entityId: string expected"; + if (message.featureValues != null && message.hasOwnProperty("featureValues")) { + if (!$util.isObject(message.featureValues)) + return "featureValues: object expected"; + var key = Object.keys(message.featureValues); + for (var i = 0; i < key.length; ++i) { + var error = $root.google.cloud.aiplatform.v1.FeatureValue.verify(message.featureValues[key[i]]); + if (error) + return "featureValues." + error; + } + } + return null; + }; + + /** + * Creates a WriteFeatureValuesPayload message from a plain object. Also converts values to their respective internal types. + * @function fromObject + * @memberof google.cloud.aiplatform.v1.WriteFeatureValuesPayload + * @static + * @param {Object.} object Plain object + * @returns {google.cloud.aiplatform.v1.WriteFeatureValuesPayload} WriteFeatureValuesPayload + */ + WriteFeatureValuesPayload.fromObject = function fromObject(object) { + if (object instanceof $root.google.cloud.aiplatform.v1.WriteFeatureValuesPayload) + return object; + var message = new $root.google.cloud.aiplatform.v1.WriteFeatureValuesPayload(); + if (object.entityId != null) + message.entityId = String(object.entityId); + if (object.featureValues) { + if (typeof object.featureValues !== "object") + throw TypeError(".google.cloud.aiplatform.v1.WriteFeatureValuesPayload.featureValues: object expected"); + message.featureValues = {}; + for (var keys = Object.keys(object.featureValues), i = 0; i < keys.length; ++i) { + if (typeof object.featureValues[keys[i]] !== "object") + throw TypeError(".google.cloud.aiplatform.v1.WriteFeatureValuesPayload.featureValues: object expected"); + message.featureValues[keys[i]] = $root.google.cloud.aiplatform.v1.FeatureValue.fromObject(object.featureValues[keys[i]]); + } + } + return message; + }; + + /** + * Creates a plain object from a WriteFeatureValuesPayload message. Also converts values to other types if specified. + * @function toObject + * @memberof google.cloud.aiplatform.v1.WriteFeatureValuesPayload + * @static + * @param {google.cloud.aiplatform.v1.WriteFeatureValuesPayload} message WriteFeatureValuesPayload + * @param {$protobuf.IConversionOptions} [options] Conversion options + * @returns {Object.} Plain object + */ + WriteFeatureValuesPayload.toObject = function toObject(message, options) { + if (!options) + options = {}; + var object = {}; + if (options.objects || options.defaults) + object.featureValues = {}; + if (options.defaults) + object.entityId = ""; + if (message.entityId != null && message.hasOwnProperty("entityId")) + object.entityId = message.entityId; + var keys2; + if (message.featureValues && (keys2 = Object.keys(message.featureValues)).length) { + object.featureValues = {}; + for (var j = 0; j < keys2.length; ++j) + object.featureValues[keys2[j]] = $root.google.cloud.aiplatform.v1.FeatureValue.toObject(message.featureValues[keys2[j]], options); + } + return object; + }; + + /** + * Converts this WriteFeatureValuesPayload to JSON. + * @function toJSON + * @memberof google.cloud.aiplatform.v1.WriteFeatureValuesPayload + * @instance + * @returns {Object.} JSON object + */ + WriteFeatureValuesPayload.prototype.toJSON = function toJSON() { + return this.constructor.toObject(this, $protobuf.util.toJSONOptions); + }; + + /** + * Gets the default type url for WriteFeatureValuesPayload + * @function getTypeUrl + * @memberof google.cloud.aiplatform.v1.WriteFeatureValuesPayload + * @static + * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns {string} The default type url + */ + WriteFeatureValuesPayload.getTypeUrl = function getTypeUrl(typeUrlPrefix) { + if (typeUrlPrefix === undefined) { + typeUrlPrefix = "type.googleapis.com"; + } + return typeUrlPrefix + "/google.cloud.aiplatform.v1.WriteFeatureValuesPayload"; + }; + + return WriteFeatureValuesPayload; + })(); + + v1.WriteFeatureValuesResponse = (function() { + + /** + * Properties of a WriteFeatureValuesResponse. + * @memberof google.cloud.aiplatform.v1 + * @interface IWriteFeatureValuesResponse + */ + + /** + * Constructs a new WriteFeatureValuesResponse. + * @memberof google.cloud.aiplatform.v1 + * @classdesc Represents a WriteFeatureValuesResponse. + * @implements IWriteFeatureValuesResponse + * @constructor + * @param {google.cloud.aiplatform.v1.IWriteFeatureValuesResponse=} [properties] Properties to set + */ + function WriteFeatureValuesResponse(properties) { + if (properties) + for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) + if (properties[keys[i]] != null) + this[keys[i]] = properties[keys[i]]; + } + + /** + * Creates a new WriteFeatureValuesResponse instance using the specified properties. + * @function create + * @memberof google.cloud.aiplatform.v1.WriteFeatureValuesResponse + * @static + * @param {google.cloud.aiplatform.v1.IWriteFeatureValuesResponse=} [properties] Properties to set + * @returns {google.cloud.aiplatform.v1.WriteFeatureValuesResponse} WriteFeatureValuesResponse instance + */ + WriteFeatureValuesResponse.create = function create(properties) { + return new WriteFeatureValuesResponse(properties); + }; + + /** + * Encodes the specified WriteFeatureValuesResponse message. Does not implicitly {@link google.cloud.aiplatform.v1.WriteFeatureValuesResponse.verify|verify} messages. + * @function encode + * @memberof google.cloud.aiplatform.v1.WriteFeatureValuesResponse + * @static + * @param {google.cloud.aiplatform.v1.IWriteFeatureValuesResponse} message WriteFeatureValuesResponse message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + WriteFeatureValuesResponse.encode = function encode(message, writer) { + if (!writer) + writer = $Writer.create(); + return writer; + }; + + /** + * Encodes the specified WriteFeatureValuesResponse message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.WriteFeatureValuesResponse.verify|verify} messages. + * @function encodeDelimited + * @memberof google.cloud.aiplatform.v1.WriteFeatureValuesResponse + * @static + * @param {google.cloud.aiplatform.v1.IWriteFeatureValuesResponse} message WriteFeatureValuesResponse message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + WriteFeatureValuesResponse.encodeDelimited = function encodeDelimited(message, writer) { + return this.encode(message, writer).ldelim(); + }; + + /** + * Decodes a WriteFeatureValuesResponse message from the specified reader or buffer. + * @function decode + * @memberof google.cloud.aiplatform.v1.WriteFeatureValuesResponse + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @param {number} [length] Message length if known beforehand + * @returns {google.cloud.aiplatform.v1.WriteFeatureValuesResponse} WriteFeatureValuesResponse + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + WriteFeatureValuesResponse.decode = function decode(reader, length) { + if (!(reader instanceof $Reader)) + reader = $Reader.create(reader); + var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.aiplatform.v1.WriteFeatureValuesResponse(); + while (reader.pos < end) { + var tag = reader.uint32(); + switch (tag >>> 3) { + default: + reader.skipType(tag & 7); + break; + } + } + return message; + }; + + /** + * Decodes a WriteFeatureValuesResponse message from the specified reader or buffer, length delimited. + * @function decodeDelimited + * @memberof google.cloud.aiplatform.v1.WriteFeatureValuesResponse + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @returns {google.cloud.aiplatform.v1.WriteFeatureValuesResponse} WriteFeatureValuesResponse + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + WriteFeatureValuesResponse.decodeDelimited = function decodeDelimited(reader) { + if (!(reader instanceof $Reader)) + reader = new $Reader(reader); + return this.decode(reader, reader.uint32()); + }; + + /** + * Verifies a WriteFeatureValuesResponse message. + * @function verify + * @memberof google.cloud.aiplatform.v1.WriteFeatureValuesResponse + * @static + * @param {Object.} message Plain object to verify + * @returns {string|null} `null` if valid, otherwise the reason why it is not + */ + WriteFeatureValuesResponse.verify = function verify(message) { + if (typeof message !== "object" || message === null) + return "object expected"; + return null; + }; + + /** + * Creates a WriteFeatureValuesResponse message from a plain object. Also converts values to their respective internal types. + * @function fromObject + * @memberof google.cloud.aiplatform.v1.WriteFeatureValuesResponse + * @static + * @param {Object.} object Plain object + * @returns {google.cloud.aiplatform.v1.WriteFeatureValuesResponse} WriteFeatureValuesResponse + */ + WriteFeatureValuesResponse.fromObject = function fromObject(object) { + if (object instanceof $root.google.cloud.aiplatform.v1.WriteFeatureValuesResponse) + return object; + return new $root.google.cloud.aiplatform.v1.WriteFeatureValuesResponse(); + }; + + /** + * Creates a plain object from a WriteFeatureValuesResponse message. Also converts values to other types if specified. + * @function toObject + * @memberof google.cloud.aiplatform.v1.WriteFeatureValuesResponse + * @static + * @param {google.cloud.aiplatform.v1.WriteFeatureValuesResponse} message WriteFeatureValuesResponse + * @param {$protobuf.IConversionOptions} [options] Conversion options + * @returns {Object.} Plain object + */ + WriteFeatureValuesResponse.toObject = function toObject() { + return {}; + }; + + /** + * Converts this WriteFeatureValuesResponse to JSON. + * @function toJSON + * @memberof google.cloud.aiplatform.v1.WriteFeatureValuesResponse + * @instance + * @returns {Object.} JSON object + */ + WriteFeatureValuesResponse.prototype.toJSON = function toJSON() { + return this.constructor.toObject(this, $protobuf.util.toJSONOptions); + }; + + /** + * Gets the default type url for WriteFeatureValuesResponse + * @function getTypeUrl + * @memberof google.cloud.aiplatform.v1.WriteFeatureValuesResponse + * @static + * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns {string} The default type url + */ + WriteFeatureValuesResponse.getTypeUrl = function getTypeUrl(typeUrlPrefix) { + if (typeUrlPrefix === undefined) { + typeUrlPrefix = "type.googleapis.com"; + } + return typeUrlPrefix + "/google.cloud.aiplatform.v1.WriteFeatureValuesResponse"; + }; + + return WriteFeatureValuesResponse; + })(); + v1.ReadFeatureValuesRequest = (function() { /** @@ -47209,6 +49782,7 @@ * @property {google.cloud.aiplatform.v1.IFeatureValueDestination|null} [destination] BatchReadFeatureValuesRequest destination * @property {Array.|null} [passThroughFields] BatchReadFeatureValuesRequest passThroughFields * @property {Array.|null} [entityTypeSpecs] BatchReadFeatureValuesRequest entityTypeSpecs + * @property {google.protobuf.ITimestamp|null} [startTime] BatchReadFeatureValuesRequest startTime */ /** @@ -47276,6 +49850,14 @@ */ BatchReadFeatureValuesRequest.prototype.entityTypeSpecs = $util.emptyArray; + /** + * BatchReadFeatureValuesRequest startTime. + * @member {google.protobuf.ITimestamp|null|undefined} startTime + * @memberof google.cloud.aiplatform.v1.BatchReadFeatureValuesRequest + * @instance + */ + BatchReadFeatureValuesRequest.prototype.startTime = null; + // OneOf field names bound to virtual getters and setters var $oneOfFields; @@ -47328,6 +49910,8 @@ if (message.passThroughFields != null && message.passThroughFields.length) for (var i = 0; i < message.passThroughFields.length; ++i) $root.google.cloud.aiplatform.v1.BatchReadFeatureValuesRequest.PassThroughField.encode(message.passThroughFields[i], writer.uint32(/* id 8, wireType 2 =*/66).fork()).ldelim(); + if (message.startTime != null && Object.hasOwnProperty.call(message, "startTime")) + $root.google.protobuf.Timestamp.encode(message.startTime, writer.uint32(/* id 11, wireType 2 =*/90).fork()).ldelim(); return writer; }; @@ -47390,6 +49974,10 @@ message.entityTypeSpecs.push($root.google.cloud.aiplatform.v1.BatchReadFeatureValuesRequest.EntityTypeSpec.decode(reader, reader.uint32())); break; } + case 11: { + message.startTime = $root.google.protobuf.Timestamp.decode(reader, reader.uint32()); + break; + } default: reader.skipType(tag & 7); break; @@ -47470,6 +50058,11 @@ return "entityTypeSpecs." + error; } } + if (message.startTime != null && message.hasOwnProperty("startTime")) { + var error = $root.google.protobuf.Timestamp.verify(message.startTime); + if (error) + return "startTime." + error; + } return null; }; @@ -47522,6 +50115,11 @@ message.entityTypeSpecs[i] = $root.google.cloud.aiplatform.v1.BatchReadFeatureValuesRequest.EntityTypeSpec.fromObject(object.entityTypeSpecs[i]); } } + if (object.startTime != null) { + if (typeof object.startTime !== "object") + throw TypeError(".google.cloud.aiplatform.v1.BatchReadFeatureValuesRequest.startTime: object expected"); + message.startTime = $root.google.protobuf.Timestamp.fromObject(object.startTime); + } return message; }; @@ -47545,6 +50143,7 @@ if (options.defaults) { object.featurestore = ""; object.destination = null; + object.startTime = null; } if (message.featurestore != null && message.hasOwnProperty("featurestore")) object.featurestore = message.featurestore; @@ -47570,6 +50169,8 @@ for (var j = 0; j < message.passThroughFields.length; ++j) object.passThroughFields[j] = $root.google.cloud.aiplatform.v1.BatchReadFeatureValuesRequest.PassThroughField.toObject(message.passThroughFields[j], options); } + if (message.startTime != null && message.hasOwnProperty("startTime")) + object.startTime = $root.google.protobuf.Timestamp.toObject(message.startTime, options); return object; }; @@ -54223,6 +56824,7 @@ * @property {google.cloud.aiplatform.v1.IGenericOperationMetadata|null} [genericMetadata] ImportFeatureValuesOperationMetadata genericMetadata * @property {number|Long|null} [importedEntityCount] ImportFeatureValuesOperationMetadata importedEntityCount * @property {number|Long|null} [importedFeatureValueCount] ImportFeatureValuesOperationMetadata importedFeatureValueCount + * @property {Array.|null} [sourceUris] ImportFeatureValuesOperationMetadata sourceUris * @property {number|Long|null} [invalidRowCount] ImportFeatureValuesOperationMetadata invalidRowCount * @property {number|Long|null} [timestampOutsideRetentionRowsCount] ImportFeatureValuesOperationMetadata timestampOutsideRetentionRowsCount */ @@ -54236,6 +56838,7 @@ * @param {google.cloud.aiplatform.v1.IImportFeatureValuesOperationMetadata=} [properties] Properties to set */ function ImportFeatureValuesOperationMetadata(properties) { + this.sourceUris = []; if (properties) for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) if (properties[keys[i]] != null) @@ -54266,6 +56869,14 @@ */ ImportFeatureValuesOperationMetadata.prototype.importedFeatureValueCount = $util.Long ? $util.Long.fromBits(0,0,false) : 0; + /** + * ImportFeatureValuesOperationMetadata sourceUris. + * @member {Array.} sourceUris + * @memberof google.cloud.aiplatform.v1.ImportFeatureValuesOperationMetadata + * @instance + */ + ImportFeatureValuesOperationMetadata.prototype.sourceUris = $util.emptyArray; + /** * ImportFeatureValuesOperationMetadata invalidRowCount. * @member {number|Long} invalidRowCount @@ -54312,6 +56923,9 @@ writer.uint32(/* id 2, wireType 0 =*/16).int64(message.importedEntityCount); if (message.importedFeatureValueCount != null && Object.hasOwnProperty.call(message, "importedFeatureValueCount")) writer.uint32(/* id 3, wireType 0 =*/24).int64(message.importedFeatureValueCount); + if (message.sourceUris != null && message.sourceUris.length) + for (var i = 0; i < message.sourceUris.length; ++i) + writer.uint32(/* id 4, wireType 2 =*/34).string(message.sourceUris[i]); if (message.invalidRowCount != null && Object.hasOwnProperty.call(message, "invalidRowCount")) writer.uint32(/* id 6, wireType 0 =*/48).int64(message.invalidRowCount); if (message.timestampOutsideRetentionRowsCount != null && Object.hasOwnProperty.call(message, "timestampOutsideRetentionRowsCount")) @@ -54362,6 +56976,12 @@ message.importedFeatureValueCount = reader.int64(); break; } + case 4: { + if (!(message.sourceUris && message.sourceUris.length)) + message.sourceUris = []; + message.sourceUris.push(reader.string()); + break; + } case 6: { message.invalidRowCount = reader.int64(); break; @@ -54416,6 +57036,13 @@ if (message.importedFeatureValueCount != null && message.hasOwnProperty("importedFeatureValueCount")) if (!$util.isInteger(message.importedFeatureValueCount) && !(message.importedFeatureValueCount && $util.isInteger(message.importedFeatureValueCount.low) && $util.isInteger(message.importedFeatureValueCount.high))) return "importedFeatureValueCount: integer|Long expected"; + if (message.sourceUris != null && message.hasOwnProperty("sourceUris")) { + if (!Array.isArray(message.sourceUris)) + return "sourceUris: array expected"; + for (var i = 0; i < message.sourceUris.length; ++i) + if (!$util.isString(message.sourceUris[i])) + return "sourceUris: string[] expected"; + } if (message.invalidRowCount != null && message.hasOwnProperty("invalidRowCount")) if (!$util.isInteger(message.invalidRowCount) && !(message.invalidRowCount && $util.isInteger(message.invalidRowCount.low) && $util.isInteger(message.invalidRowCount.high))) return "invalidRowCount: integer|Long expected"; @@ -54460,6 +57087,13 @@ message.importedFeatureValueCount = object.importedFeatureValueCount; else if (typeof object.importedFeatureValueCount === "object") message.importedFeatureValueCount = new $util.LongBits(object.importedFeatureValueCount.low >>> 0, object.importedFeatureValueCount.high >>> 0).toNumber(); + if (object.sourceUris) { + if (!Array.isArray(object.sourceUris)) + throw TypeError(".google.cloud.aiplatform.v1.ImportFeatureValuesOperationMetadata.sourceUris: array expected"); + message.sourceUris = []; + for (var i = 0; i < object.sourceUris.length; ++i) + message.sourceUris[i] = String(object.sourceUris[i]); + } if (object.invalidRowCount != null) if ($util.Long) (message.invalidRowCount = $util.Long.fromValue(object.invalidRowCount)).unsigned = false; @@ -54494,6 +57128,8 @@ if (!options) options = {}; var object = {}; + if (options.arrays || options.defaults) + object.sourceUris = []; if (options.defaults) { object.genericMetadata = null; if ($util.Long) { @@ -54529,6 +57165,11 @@ object.importedFeatureValueCount = options.longs === String ? String(message.importedFeatureValueCount) : message.importedFeatureValueCount; else object.importedFeatureValueCount = options.longs === String ? $util.Long.prototype.toString.call(message.importedFeatureValueCount) : options.longs === Number ? new $util.LongBits(message.importedFeatureValueCount.low >>> 0, message.importedFeatureValueCount.high >>> 0).toNumber() : message.importedFeatureValueCount; + if (message.sourceUris && message.sourceUris.length) { + object.sourceUris = []; + for (var j = 0; j < message.sourceUris.length; ++j) + object.sourceUris[j] = message.sourceUris[j]; + } if (message.invalidRowCount != null && message.hasOwnProperty("invalidRowCount")) if (typeof message.invalidRowCount === "number") object.invalidRowCount = options.longs === String ? String(message.invalidRowCount) : message.invalidRowCount; @@ -61341,6 +63982,7 @@ * @property {number|Long|null} [minMeasurementCount] ConvexAutomatedStoppingSpec minMeasurementCount * @property {string|null} [learningRateParameterName] ConvexAutomatedStoppingSpec learningRateParameterName * @property {boolean|null} [useElapsedDuration] ConvexAutomatedStoppingSpec useElapsedDuration + * @property {boolean|null} [updateAllStoppedTrials] ConvexAutomatedStoppingSpec updateAllStoppedTrials */ /** @@ -61398,6 +64040,28 @@ */ ConvexAutomatedStoppingSpec.prototype.useElapsedDuration = false; + /** + * ConvexAutomatedStoppingSpec updateAllStoppedTrials. + * @member {boolean|null|undefined} updateAllStoppedTrials + * @memberof google.cloud.aiplatform.v1.StudySpec.ConvexAutomatedStoppingSpec + * @instance + */ + ConvexAutomatedStoppingSpec.prototype.updateAllStoppedTrials = null; + + // OneOf field names bound to virtual getters and setters + var $oneOfFields; + + /** + * ConvexAutomatedStoppingSpec _updateAllStoppedTrials. + * @member {"updateAllStoppedTrials"|undefined} _updateAllStoppedTrials + * @memberof google.cloud.aiplatform.v1.StudySpec.ConvexAutomatedStoppingSpec + * @instance + */ + Object.defineProperty(ConvexAutomatedStoppingSpec.prototype, "_updateAllStoppedTrials", { + get: $util.oneOfGetter($oneOfFields = ["updateAllStoppedTrials"]), + set: $util.oneOfSetter($oneOfFields) + }); + /** * Creates a new ConvexAutomatedStoppingSpec instance using the specified properties. * @function create @@ -61432,6 +64096,8 @@ writer.uint32(/* id 4, wireType 2 =*/34).string(message.learningRateParameterName); if (message.useElapsedDuration != null && Object.hasOwnProperty.call(message, "useElapsedDuration")) writer.uint32(/* id 5, wireType 0 =*/40).bool(message.useElapsedDuration); + if (message.updateAllStoppedTrials != null && Object.hasOwnProperty.call(message, "updateAllStoppedTrials")) + writer.uint32(/* id 6, wireType 0 =*/48).bool(message.updateAllStoppedTrials); return writer; }; @@ -61486,6 +64152,10 @@ message.useElapsedDuration = reader.bool(); break; } + case 6: { + message.updateAllStoppedTrials = reader.bool(); + break; + } default: reader.skipType(tag & 7); break; @@ -61521,6 +64191,7 @@ ConvexAutomatedStoppingSpec.verify = function verify(message) { if (typeof message !== "object" || message === null) return "object expected"; + var properties = {}; if (message.maxStepCount != null && message.hasOwnProperty("maxStepCount")) if (!$util.isInteger(message.maxStepCount) && !(message.maxStepCount && $util.isInteger(message.maxStepCount.low) && $util.isInteger(message.maxStepCount.high))) return "maxStepCount: integer|Long expected"; @@ -61536,6 +64207,11 @@ if (message.useElapsedDuration != null && message.hasOwnProperty("useElapsedDuration")) if (typeof message.useElapsedDuration !== "boolean") return "useElapsedDuration: boolean expected"; + if (message.updateAllStoppedTrials != null && message.hasOwnProperty("updateAllStoppedTrials")) { + properties._updateAllStoppedTrials = 1; + if (typeof message.updateAllStoppedTrials !== "boolean") + return "updateAllStoppedTrials: boolean expected"; + } return null; }; @@ -61582,6 +64258,8 @@ message.learningRateParameterName = String(object.learningRateParameterName); if (object.useElapsedDuration != null) message.useElapsedDuration = Boolean(object.useElapsedDuration); + if (object.updateAllStoppedTrials != null) + message.updateAllStoppedTrials = Boolean(object.updateAllStoppedTrials); return message; }; @@ -61636,6 +64314,11 @@ object.learningRateParameterName = message.learningRateParameterName; if (message.useElapsedDuration != null && message.hasOwnProperty("useElapsedDuration")) object.useElapsedDuration = message.useElapsedDuration; + if (message.updateAllStoppedTrials != null && message.hasOwnProperty("updateAllStoppedTrials")) { + object.updateAllStoppedTrials = message.updateAllStoppedTrials; + if (options.oneofs) + object._updateAllStoppedTrials = "updateAllStoppedTrials"; + } return object; }; @@ -109263,6 +111946,7 @@ * @property {string|null} [parentModel] UploadModelRequest parentModel * @property {string|null} [modelId] UploadModelRequest modelId * @property {google.cloud.aiplatform.v1.IModel|null} [model] UploadModelRequest model + * @property {string|null} [serviceAccount] UploadModelRequest serviceAccount */ /** @@ -109312,6 +111996,14 @@ */ UploadModelRequest.prototype.model = null; + /** + * UploadModelRequest serviceAccount. + * @member {string} serviceAccount + * @memberof google.cloud.aiplatform.v1.UploadModelRequest + * @instance + */ + UploadModelRequest.prototype.serviceAccount = ""; + /** * Creates a new UploadModelRequest instance using the specified properties. * @function create @@ -109344,6 +112036,8 @@ writer.uint32(/* id 4, wireType 2 =*/34).string(message.parentModel); if (message.modelId != null && Object.hasOwnProperty.call(message, "modelId")) writer.uint32(/* id 5, wireType 2 =*/42).string(message.modelId); + if (message.serviceAccount != null && Object.hasOwnProperty.call(message, "serviceAccount")) + writer.uint32(/* id 6, wireType 2 =*/50).string(message.serviceAccount); return writer; }; @@ -109394,6 +112088,10 @@ message.model = $root.google.cloud.aiplatform.v1.Model.decode(reader, reader.uint32()); break; } + case 6: { + message.serviceAccount = reader.string(); + break; + } default: reader.skipType(tag & 7); break; @@ -109443,6 +112141,9 @@ if (error) return "model." + error; } + if (message.serviceAccount != null && message.hasOwnProperty("serviceAccount")) + if (!$util.isString(message.serviceAccount)) + return "serviceAccount: string expected"; return null; }; @@ -109469,6 +112170,8 @@ throw TypeError(".google.cloud.aiplatform.v1.UploadModelRequest.model: object expected"); message.model = $root.google.cloud.aiplatform.v1.Model.fromObject(object.model); } + if (object.serviceAccount != null) + message.serviceAccount = String(object.serviceAccount); return message; }; @@ -109490,6 +112193,7 @@ object.model = null; object.parentModel = ""; object.modelId = ""; + object.serviceAccount = ""; } if (message.parent != null && message.hasOwnProperty("parent")) object.parent = message.parent; @@ -109499,6 +112203,8 @@ object.parentModel = message.parentModel; if (message.modelId != null && message.hasOwnProperty("modelId")) object.modelId = message.modelId; + if (message.serviceAccount != null && message.hasOwnProperty("serviceAccount")) + object.serviceAccount = message.serviceAccount; return object; }; @@ -110752,6 +113458,7 @@ * @property {string|null} [pageToken] ListModelVersionsRequest pageToken * @property {string|null} [filter] ListModelVersionsRequest filter * @property {google.protobuf.IFieldMask|null} [readMask] ListModelVersionsRequest readMask + * @property {string|null} [orderBy] ListModelVersionsRequest orderBy */ /** @@ -110809,6 +113516,14 @@ */ ListModelVersionsRequest.prototype.readMask = null; + /** + * ListModelVersionsRequest orderBy. + * @member {string} orderBy + * @memberof google.cloud.aiplatform.v1.ListModelVersionsRequest + * @instance + */ + ListModelVersionsRequest.prototype.orderBy = ""; + /** * Creates a new ListModelVersionsRequest instance using the specified properties. * @function create @@ -110843,6 +113558,8 @@ writer.uint32(/* id 4, wireType 2 =*/34).string(message.filter); if (message.readMask != null && Object.hasOwnProperty.call(message, "readMask")) $root.google.protobuf.FieldMask.encode(message.readMask, writer.uint32(/* id 5, wireType 2 =*/42).fork()).ldelim(); + if (message.orderBy != null && Object.hasOwnProperty.call(message, "orderBy")) + writer.uint32(/* id 6, wireType 2 =*/50).string(message.orderBy); return writer; }; @@ -110897,6 +113614,10 @@ message.readMask = $root.google.protobuf.FieldMask.decode(reader, reader.uint32()); break; } + case 6: { + message.orderBy = reader.string(); + break; + } default: reader.skipType(tag & 7); break; @@ -110949,6 +113670,9 @@ if (error) return "readMask." + error; } + if (message.orderBy != null && message.hasOwnProperty("orderBy")) + if (!$util.isString(message.orderBy)) + return "orderBy: string expected"; return null; }; @@ -110977,6 +113701,8 @@ throw TypeError(".google.cloud.aiplatform.v1.ListModelVersionsRequest.readMask: object expected"); message.readMask = $root.google.protobuf.FieldMask.fromObject(object.readMask); } + if (object.orderBy != null) + message.orderBy = String(object.orderBy); return message; }; @@ -110999,6 +113725,7 @@ object.pageToken = ""; object.filter = ""; object.readMask = null; + object.orderBy = ""; } if (message.name != null && message.hasOwnProperty("name")) object.name = message.name; @@ -111010,6 +113737,8 @@ object.filter = message.filter; if (message.readMask != null && message.hasOwnProperty("readMask")) object.readMask = $root.google.protobuf.FieldMask.toObject(message.readMask, options); + if (message.orderBy != null && message.hasOwnProperty("orderBy")) + object.orderBy = message.orderBy; return object; }; @@ -118934,6 +121663,8 @@ * @interface IContainerDetail * @property {string|null} [mainJob] ContainerDetail mainJob * @property {string|null} [preCachingCheckJob] ContainerDetail preCachingCheckJob + * @property {Array.|null} [failedMainJobs] ContainerDetail failedMainJobs + * @property {Array.|null} [failedPreCachingCheckJobs] ContainerDetail failedPreCachingCheckJobs */ /** @@ -118945,6 +121676,8 @@ * @param {google.cloud.aiplatform.v1.PipelineTaskExecutorDetail.IContainerDetail=} [properties] Properties to set */ function ContainerDetail(properties) { + this.failedMainJobs = []; + this.failedPreCachingCheckJobs = []; if (properties) for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) if (properties[keys[i]] != null) @@ -118967,6 +121700,22 @@ */ ContainerDetail.prototype.preCachingCheckJob = ""; + /** + * ContainerDetail failedMainJobs. + * @member {Array.} failedMainJobs + * @memberof google.cloud.aiplatform.v1.PipelineTaskExecutorDetail.ContainerDetail + * @instance + */ + ContainerDetail.prototype.failedMainJobs = $util.emptyArray; + + /** + * ContainerDetail failedPreCachingCheckJobs. + * @member {Array.} failedPreCachingCheckJobs + * @memberof google.cloud.aiplatform.v1.PipelineTaskExecutorDetail.ContainerDetail + * @instance + */ + ContainerDetail.prototype.failedPreCachingCheckJobs = $util.emptyArray; + /** * Creates a new ContainerDetail instance using the specified properties. * @function create @@ -118995,6 +121744,12 @@ writer.uint32(/* id 1, wireType 2 =*/10).string(message.mainJob); if (message.preCachingCheckJob != null && Object.hasOwnProperty.call(message, "preCachingCheckJob")) writer.uint32(/* id 2, wireType 2 =*/18).string(message.preCachingCheckJob); + if (message.failedMainJobs != null && message.failedMainJobs.length) + for (var i = 0; i < message.failedMainJobs.length; ++i) + writer.uint32(/* id 3, wireType 2 =*/26).string(message.failedMainJobs[i]); + if (message.failedPreCachingCheckJobs != null && message.failedPreCachingCheckJobs.length) + for (var i = 0; i < message.failedPreCachingCheckJobs.length; ++i) + writer.uint32(/* id 4, wireType 2 =*/34).string(message.failedPreCachingCheckJobs[i]); return writer; }; @@ -119037,6 +121792,18 @@ message.preCachingCheckJob = reader.string(); break; } + case 3: { + if (!(message.failedMainJobs && message.failedMainJobs.length)) + message.failedMainJobs = []; + message.failedMainJobs.push(reader.string()); + break; + } + case 4: { + if (!(message.failedPreCachingCheckJobs && message.failedPreCachingCheckJobs.length)) + message.failedPreCachingCheckJobs = []; + message.failedPreCachingCheckJobs.push(reader.string()); + break; + } default: reader.skipType(tag & 7); break; @@ -119078,6 +121845,20 @@ if (message.preCachingCheckJob != null && message.hasOwnProperty("preCachingCheckJob")) if (!$util.isString(message.preCachingCheckJob)) return "preCachingCheckJob: string expected"; + if (message.failedMainJobs != null && message.hasOwnProperty("failedMainJobs")) { + if (!Array.isArray(message.failedMainJobs)) + return "failedMainJobs: array expected"; + for (var i = 0; i < message.failedMainJobs.length; ++i) + if (!$util.isString(message.failedMainJobs[i])) + return "failedMainJobs: string[] expected"; + } + if (message.failedPreCachingCheckJobs != null && message.hasOwnProperty("failedPreCachingCheckJobs")) { + if (!Array.isArray(message.failedPreCachingCheckJobs)) + return "failedPreCachingCheckJobs: array expected"; + for (var i = 0; i < message.failedPreCachingCheckJobs.length; ++i) + if (!$util.isString(message.failedPreCachingCheckJobs[i])) + return "failedPreCachingCheckJobs: string[] expected"; + } return null; }; @@ -119097,6 +121878,20 @@ message.mainJob = String(object.mainJob); if (object.preCachingCheckJob != null) message.preCachingCheckJob = String(object.preCachingCheckJob); + if (object.failedMainJobs) { + if (!Array.isArray(object.failedMainJobs)) + throw TypeError(".google.cloud.aiplatform.v1.PipelineTaskExecutorDetail.ContainerDetail.failedMainJobs: array expected"); + message.failedMainJobs = []; + for (var i = 0; i < object.failedMainJobs.length; ++i) + message.failedMainJobs[i] = String(object.failedMainJobs[i]); + } + if (object.failedPreCachingCheckJobs) { + if (!Array.isArray(object.failedPreCachingCheckJobs)) + throw TypeError(".google.cloud.aiplatform.v1.PipelineTaskExecutorDetail.ContainerDetail.failedPreCachingCheckJobs: array expected"); + message.failedPreCachingCheckJobs = []; + for (var i = 0; i < object.failedPreCachingCheckJobs.length; ++i) + message.failedPreCachingCheckJobs[i] = String(object.failedPreCachingCheckJobs[i]); + } return message; }; @@ -119113,6 +121908,10 @@ if (!options) options = {}; var object = {}; + if (options.arrays || options.defaults) { + object.failedMainJobs = []; + object.failedPreCachingCheckJobs = []; + } if (options.defaults) { object.mainJob = ""; object.preCachingCheckJob = ""; @@ -119121,6 +121920,16 @@ object.mainJob = message.mainJob; if (message.preCachingCheckJob != null && message.hasOwnProperty("preCachingCheckJob")) object.preCachingCheckJob = message.preCachingCheckJob; + if (message.failedMainJobs && message.failedMainJobs.length) { + object.failedMainJobs = []; + for (var j = 0; j < message.failedMainJobs.length; ++j) + object.failedMainJobs[j] = message.failedMainJobs[j]; + } + if (message.failedPreCachingCheckJobs && message.failedPreCachingCheckJobs.length) { + object.failedPreCachingCheckJobs = []; + for (var j = 0; j < message.failedPreCachingCheckJobs.length; ++j) + object.failedPreCachingCheckJobs[j] = message.failedPreCachingCheckJobs[j]; + } return object; }; @@ -123596,6 +126405,7 @@ * @property {string|null} [annotationsFilter] InputDataConfig annotationsFilter * @property {string|null} [annotationSchemaUri] InputDataConfig annotationSchemaUri * @property {string|null} [savedQueryId] InputDataConfig savedQueryId + * @property {boolean|null} [persistMlUseAssignment] InputDataConfig persistMlUseAssignment */ /** @@ -123701,6 +126511,14 @@ */ InputDataConfig.prototype.savedQueryId = ""; + /** + * InputDataConfig persistMlUseAssignment. + * @member {boolean} persistMlUseAssignment + * @memberof google.cloud.aiplatform.v1.InputDataConfig + * @instance + */ + InputDataConfig.prototype.persistMlUseAssignment = false; + // OneOf field names bound to virtual getters and setters var $oneOfFields; @@ -123770,6 +126588,8 @@ writer.uint32(/* id 9, wireType 2 =*/74).string(message.annotationSchemaUri); if (message.bigqueryDestination != null && Object.hasOwnProperty.call(message, "bigqueryDestination")) $root.google.cloud.aiplatform.v1.BigQueryDestination.encode(message.bigqueryDestination, writer.uint32(/* id 10, wireType 2 =*/82).fork()).ldelim(); + if (message.persistMlUseAssignment != null && Object.hasOwnProperty.call(message, "persistMlUseAssignment")) + writer.uint32(/* id 11, wireType 0 =*/88).bool(message.persistMlUseAssignment); if (message.stratifiedSplit != null && Object.hasOwnProperty.call(message, "stratifiedSplit")) $root.google.cloud.aiplatform.v1.StratifiedSplit.encode(message.stratifiedSplit, writer.uint32(/* id 12, wireType 2 =*/98).fork()).ldelim(); return writer; @@ -123850,6 +126670,10 @@ message.savedQueryId = reader.string(); break; } + case 11: { + message.persistMlUseAssignment = reader.bool(); + break; + } default: reader.skipType(tag & 7); break; @@ -123964,6 +126788,9 @@ if (message.savedQueryId != null && message.hasOwnProperty("savedQueryId")) if (!$util.isString(message.savedQueryId)) return "savedQueryId: string expected"; + if (message.persistMlUseAssignment != null && message.hasOwnProperty("persistMlUseAssignment")) + if (typeof message.persistMlUseAssignment !== "boolean") + return "persistMlUseAssignment: boolean expected"; return null; }; @@ -124022,6 +126849,8 @@ message.annotationSchemaUri = String(object.annotationSchemaUri); if (object.savedQueryId != null) message.savedQueryId = String(object.savedQueryId); + if (object.persistMlUseAssignment != null) + message.persistMlUseAssignment = Boolean(object.persistMlUseAssignment); return message; }; @@ -124043,6 +126872,7 @@ object.annotationsFilter = ""; object.savedQueryId = ""; object.annotationSchemaUri = ""; + object.persistMlUseAssignment = false; } if (message.datasetId != null && message.hasOwnProperty("datasetId")) object.datasetId = message.datasetId; @@ -124082,6 +126912,8 @@ if (options.oneofs) object.destination = "bigqueryDestination"; } + if (message.persistMlUseAssignment != null && message.hasOwnProperty("persistMlUseAssignment")) + object.persistMlUseAssignment = message.persistMlUseAssignment; if (message.stratifiedSplit != null && message.hasOwnProperty("stratifiedSplit")) { object.stratifiedSplit = $root.google.cloud.aiplatform.v1.StratifiedSplit.toObject(message.stratifiedSplit, options); if (options.oneofs) @@ -148739,6 +151571,39 @@ * @variation 2 */ + /** + * Callback as used by {@link google.cloud.aiplatform.v1.TensorboardService|readTensorboardUsage}. + * @memberof google.cloud.aiplatform.v1.TensorboardService + * @typedef ReadTensorboardUsageCallback + * @type {function} + * @param {Error|null} error Error, if any + * @param {google.cloud.aiplatform.v1.ReadTensorboardUsageResponse} [response] ReadTensorboardUsageResponse + */ + + /** + * Calls ReadTensorboardUsage. + * @function readTensorboardUsage + * @memberof google.cloud.aiplatform.v1.TensorboardService + * @instance + * @param {google.cloud.aiplatform.v1.IReadTensorboardUsageRequest} request ReadTensorboardUsageRequest message or plain object + * @param {google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardUsageCallback} callback Node-style callback called with the error, if any, and ReadTensorboardUsageResponse + * @returns {undefined} + * @variation 1 + */ + Object.defineProperty(TensorboardService.prototype.readTensorboardUsage = function readTensorboardUsage(request, callback) { + return this.rpcCall(readTensorboardUsage, $root.google.cloud.aiplatform.v1.ReadTensorboardUsageRequest, $root.google.cloud.aiplatform.v1.ReadTensorboardUsageResponse, request, callback); + }, "name", { value: "ReadTensorboardUsage" }); + + /** + * Calls ReadTensorboardUsage. + * @function readTensorboardUsage + * @memberof google.cloud.aiplatform.v1.TensorboardService + * @instance + * @param {google.cloud.aiplatform.v1.IReadTensorboardUsageRequest} request ReadTensorboardUsageRequest message or plain object + * @returns {Promise} Promise + * @variation 2 + */ + /** * Callback as used by {@link google.cloud.aiplatform.v1.TensorboardService|updateTensorboard}. * @memberof google.cloud.aiplatform.v1.TensorboardService @@ -150035,6 +152900,919 @@ return GetTensorboardRequest; })(); + v1.ReadTensorboardUsageRequest = (function() { + + /** + * Properties of a ReadTensorboardUsageRequest. + * @memberof google.cloud.aiplatform.v1 + * @interface IReadTensorboardUsageRequest + * @property {string|null} [tensorboard] ReadTensorboardUsageRequest tensorboard + */ + + /** + * Constructs a new ReadTensorboardUsageRequest. + * @memberof google.cloud.aiplatform.v1 + * @classdesc Represents a ReadTensorboardUsageRequest. + * @implements IReadTensorboardUsageRequest + * @constructor + * @param {google.cloud.aiplatform.v1.IReadTensorboardUsageRequest=} [properties] Properties to set + */ + function ReadTensorboardUsageRequest(properties) { + if (properties) + for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) + if (properties[keys[i]] != null) + this[keys[i]] = properties[keys[i]]; + } + + /** + * ReadTensorboardUsageRequest tensorboard. + * @member {string} tensorboard + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageRequest + * @instance + */ + ReadTensorboardUsageRequest.prototype.tensorboard = ""; + + /** + * Creates a new ReadTensorboardUsageRequest instance using the specified properties. + * @function create + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageRequest + * @static + * @param {google.cloud.aiplatform.v1.IReadTensorboardUsageRequest=} [properties] Properties to set + * @returns {google.cloud.aiplatform.v1.ReadTensorboardUsageRequest} ReadTensorboardUsageRequest instance + */ + ReadTensorboardUsageRequest.create = function create(properties) { + return new ReadTensorboardUsageRequest(properties); + }; + + /** + * Encodes the specified ReadTensorboardUsageRequest message. Does not implicitly {@link google.cloud.aiplatform.v1.ReadTensorboardUsageRequest.verify|verify} messages. + * @function encode + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageRequest + * @static + * @param {google.cloud.aiplatform.v1.IReadTensorboardUsageRequest} message ReadTensorboardUsageRequest message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + ReadTensorboardUsageRequest.encode = function encode(message, writer) { + if (!writer) + writer = $Writer.create(); + if (message.tensorboard != null && Object.hasOwnProperty.call(message, "tensorboard")) + writer.uint32(/* id 1, wireType 2 =*/10).string(message.tensorboard); + return writer; + }; + + /** + * Encodes the specified ReadTensorboardUsageRequest message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.ReadTensorboardUsageRequest.verify|verify} messages. + * @function encodeDelimited + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageRequest + * @static + * @param {google.cloud.aiplatform.v1.IReadTensorboardUsageRequest} message ReadTensorboardUsageRequest message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + ReadTensorboardUsageRequest.encodeDelimited = function encodeDelimited(message, writer) { + return this.encode(message, writer).ldelim(); + }; + + /** + * Decodes a ReadTensorboardUsageRequest message from the specified reader or buffer. + * @function decode + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageRequest + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @param {number} [length] Message length if known beforehand + * @returns {google.cloud.aiplatform.v1.ReadTensorboardUsageRequest} ReadTensorboardUsageRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + ReadTensorboardUsageRequest.decode = function decode(reader, length) { + if (!(reader instanceof $Reader)) + reader = $Reader.create(reader); + var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.aiplatform.v1.ReadTensorboardUsageRequest(); + while (reader.pos < end) { + var tag = reader.uint32(); + switch (tag >>> 3) { + case 1: { + message.tensorboard = reader.string(); + break; + } + default: + reader.skipType(tag & 7); + break; + } + } + return message; + }; + + /** + * Decodes a ReadTensorboardUsageRequest message from the specified reader or buffer, length delimited. + * @function decodeDelimited + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageRequest + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @returns {google.cloud.aiplatform.v1.ReadTensorboardUsageRequest} ReadTensorboardUsageRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + ReadTensorboardUsageRequest.decodeDelimited = function decodeDelimited(reader) { + if (!(reader instanceof $Reader)) + reader = new $Reader(reader); + return this.decode(reader, reader.uint32()); + }; + + /** + * Verifies a ReadTensorboardUsageRequest message. + * @function verify + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageRequest + * @static + * @param {Object.} message Plain object to verify + * @returns {string|null} `null` if valid, otherwise the reason why it is not + */ + ReadTensorboardUsageRequest.verify = function verify(message) { + if (typeof message !== "object" || message === null) + return "object expected"; + if (message.tensorboard != null && message.hasOwnProperty("tensorboard")) + if (!$util.isString(message.tensorboard)) + return "tensorboard: string expected"; + return null; + }; + + /** + * Creates a ReadTensorboardUsageRequest message from a plain object. Also converts values to their respective internal types. + * @function fromObject + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageRequest + * @static + * @param {Object.} object Plain object + * @returns {google.cloud.aiplatform.v1.ReadTensorboardUsageRequest} ReadTensorboardUsageRequest + */ + ReadTensorboardUsageRequest.fromObject = function fromObject(object) { + if (object instanceof $root.google.cloud.aiplatform.v1.ReadTensorboardUsageRequest) + return object; + var message = new $root.google.cloud.aiplatform.v1.ReadTensorboardUsageRequest(); + if (object.tensorboard != null) + message.tensorboard = String(object.tensorboard); + return message; + }; + + /** + * Creates a plain object from a ReadTensorboardUsageRequest message. Also converts values to other types if specified. + * @function toObject + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageRequest + * @static + * @param {google.cloud.aiplatform.v1.ReadTensorboardUsageRequest} message ReadTensorboardUsageRequest + * @param {$protobuf.IConversionOptions} [options] Conversion options + * @returns {Object.} Plain object + */ + ReadTensorboardUsageRequest.toObject = function toObject(message, options) { + if (!options) + options = {}; + var object = {}; + if (options.defaults) + object.tensorboard = ""; + if (message.tensorboard != null && message.hasOwnProperty("tensorboard")) + object.tensorboard = message.tensorboard; + return object; + }; + + /** + * Converts this ReadTensorboardUsageRequest to JSON. + * @function toJSON + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageRequest + * @instance + * @returns {Object.} JSON object + */ + ReadTensorboardUsageRequest.prototype.toJSON = function toJSON() { + return this.constructor.toObject(this, $protobuf.util.toJSONOptions); + }; + + /** + * Gets the default type url for ReadTensorboardUsageRequest + * @function getTypeUrl + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageRequest + * @static + * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns {string} The default type url + */ + ReadTensorboardUsageRequest.getTypeUrl = function getTypeUrl(typeUrlPrefix) { + if (typeUrlPrefix === undefined) { + typeUrlPrefix = "type.googleapis.com"; + } + return typeUrlPrefix + "/google.cloud.aiplatform.v1.ReadTensorboardUsageRequest"; + }; + + return ReadTensorboardUsageRequest; + })(); + + v1.ReadTensorboardUsageResponse = (function() { + + /** + * Properties of a ReadTensorboardUsageResponse. + * @memberof google.cloud.aiplatform.v1 + * @interface IReadTensorboardUsageResponse + * @property {Object.|null} [monthlyUsageData] ReadTensorboardUsageResponse monthlyUsageData + */ + + /** + * Constructs a new ReadTensorboardUsageResponse. + * @memberof google.cloud.aiplatform.v1 + * @classdesc Represents a ReadTensorboardUsageResponse. + * @implements IReadTensorboardUsageResponse + * @constructor + * @param {google.cloud.aiplatform.v1.IReadTensorboardUsageResponse=} [properties] Properties to set + */ + function ReadTensorboardUsageResponse(properties) { + this.monthlyUsageData = {}; + if (properties) + for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) + if (properties[keys[i]] != null) + this[keys[i]] = properties[keys[i]]; + } + + /** + * ReadTensorboardUsageResponse monthlyUsageData. + * @member {Object.} monthlyUsageData + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageResponse + * @instance + */ + ReadTensorboardUsageResponse.prototype.monthlyUsageData = $util.emptyObject; + + /** + * Creates a new ReadTensorboardUsageResponse instance using the specified properties. + * @function create + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageResponse + * @static + * @param {google.cloud.aiplatform.v1.IReadTensorboardUsageResponse=} [properties] Properties to set + * @returns {google.cloud.aiplatform.v1.ReadTensorboardUsageResponse} ReadTensorboardUsageResponse instance + */ + ReadTensorboardUsageResponse.create = function create(properties) { + return new ReadTensorboardUsageResponse(properties); + }; + + /** + * Encodes the specified ReadTensorboardUsageResponse message. Does not implicitly {@link google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.verify|verify} messages. + * @function encode + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageResponse + * @static + * @param {google.cloud.aiplatform.v1.IReadTensorboardUsageResponse} message ReadTensorboardUsageResponse message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + ReadTensorboardUsageResponse.encode = function encode(message, writer) { + if (!writer) + writer = $Writer.create(); + if (message.monthlyUsageData != null && Object.hasOwnProperty.call(message, "monthlyUsageData")) + for (var keys = Object.keys(message.monthlyUsageData), i = 0; i < keys.length; ++i) { + writer.uint32(/* id 1, wireType 2 =*/10).fork().uint32(/* id 1, wireType 2 =*/10).string(keys[i]); + $root.google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerMonthUsageData.encode(message.monthlyUsageData[keys[i]], writer.uint32(/* id 2, wireType 2 =*/18).fork()).ldelim().ldelim(); + } + return writer; + }; + + /** + * Encodes the specified ReadTensorboardUsageResponse message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.verify|verify} messages. + * @function encodeDelimited + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageResponse + * @static + * @param {google.cloud.aiplatform.v1.IReadTensorboardUsageResponse} message ReadTensorboardUsageResponse message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + ReadTensorboardUsageResponse.encodeDelimited = function encodeDelimited(message, writer) { + return this.encode(message, writer).ldelim(); + }; + + /** + * Decodes a ReadTensorboardUsageResponse message from the specified reader or buffer. + * @function decode + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageResponse + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @param {number} [length] Message length if known beforehand + * @returns {google.cloud.aiplatform.v1.ReadTensorboardUsageResponse} ReadTensorboardUsageResponse + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + ReadTensorboardUsageResponse.decode = function decode(reader, length) { + if (!(reader instanceof $Reader)) + reader = $Reader.create(reader); + var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.aiplatform.v1.ReadTensorboardUsageResponse(), key, value; + while (reader.pos < end) { + var tag = reader.uint32(); + switch (tag >>> 3) { + case 1: { + if (message.monthlyUsageData === $util.emptyObject) + message.monthlyUsageData = {}; + var end2 = reader.uint32() + reader.pos; + key = ""; + value = null; + while (reader.pos < end2) { + var tag2 = reader.uint32(); + switch (tag2 >>> 3) { + case 1: + key = reader.string(); + break; + case 2: + value = $root.google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerMonthUsageData.decode(reader, reader.uint32()); + break; + default: + reader.skipType(tag2 & 7); + break; + } + } + message.monthlyUsageData[key] = value; + break; + } + default: + reader.skipType(tag & 7); + break; + } + } + return message; + }; + + /** + * Decodes a ReadTensorboardUsageResponse message from the specified reader or buffer, length delimited. + * @function decodeDelimited + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageResponse + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @returns {google.cloud.aiplatform.v1.ReadTensorboardUsageResponse} ReadTensorboardUsageResponse + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + ReadTensorboardUsageResponse.decodeDelimited = function decodeDelimited(reader) { + if (!(reader instanceof $Reader)) + reader = new $Reader(reader); + return this.decode(reader, reader.uint32()); + }; + + /** + * Verifies a ReadTensorboardUsageResponse message. + * @function verify + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageResponse + * @static + * @param {Object.} message Plain object to verify + * @returns {string|null} `null` if valid, otherwise the reason why it is not + */ + ReadTensorboardUsageResponse.verify = function verify(message) { + if (typeof message !== "object" || message === null) + return "object expected"; + if (message.monthlyUsageData != null && message.hasOwnProperty("monthlyUsageData")) { + if (!$util.isObject(message.monthlyUsageData)) + return "monthlyUsageData: object expected"; + var key = Object.keys(message.monthlyUsageData); + for (var i = 0; i < key.length; ++i) { + var error = $root.google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerMonthUsageData.verify(message.monthlyUsageData[key[i]]); + if (error) + return "monthlyUsageData." + error; + } + } + return null; + }; + + /** + * Creates a ReadTensorboardUsageResponse message from a plain object. Also converts values to their respective internal types. + * @function fromObject + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageResponse + * @static + * @param {Object.} object Plain object + * @returns {google.cloud.aiplatform.v1.ReadTensorboardUsageResponse} ReadTensorboardUsageResponse + */ + ReadTensorboardUsageResponse.fromObject = function fromObject(object) { + if (object instanceof $root.google.cloud.aiplatform.v1.ReadTensorboardUsageResponse) + return object; + var message = new $root.google.cloud.aiplatform.v1.ReadTensorboardUsageResponse(); + if (object.monthlyUsageData) { + if (typeof object.monthlyUsageData !== "object") + throw TypeError(".google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.monthlyUsageData: object expected"); + message.monthlyUsageData = {}; + for (var keys = Object.keys(object.monthlyUsageData), i = 0; i < keys.length; ++i) { + if (typeof object.monthlyUsageData[keys[i]] !== "object") + throw TypeError(".google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.monthlyUsageData: object expected"); + message.monthlyUsageData[keys[i]] = $root.google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerMonthUsageData.fromObject(object.monthlyUsageData[keys[i]]); + } + } + return message; + }; + + /** + * Creates a plain object from a ReadTensorboardUsageResponse message. Also converts values to other types if specified. + * @function toObject + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageResponse + * @static + * @param {google.cloud.aiplatform.v1.ReadTensorboardUsageResponse} message ReadTensorboardUsageResponse + * @param {$protobuf.IConversionOptions} [options] Conversion options + * @returns {Object.} Plain object + */ + ReadTensorboardUsageResponse.toObject = function toObject(message, options) { + if (!options) + options = {}; + var object = {}; + if (options.objects || options.defaults) + object.monthlyUsageData = {}; + var keys2; + if (message.monthlyUsageData && (keys2 = Object.keys(message.monthlyUsageData)).length) { + object.monthlyUsageData = {}; + for (var j = 0; j < keys2.length; ++j) + object.monthlyUsageData[keys2[j]] = $root.google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerMonthUsageData.toObject(message.monthlyUsageData[keys2[j]], options); + } + return object; + }; + + /** + * Converts this ReadTensorboardUsageResponse to JSON. + * @function toJSON + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageResponse + * @instance + * @returns {Object.} JSON object + */ + ReadTensorboardUsageResponse.prototype.toJSON = function toJSON() { + return this.constructor.toObject(this, $protobuf.util.toJSONOptions); + }; + + /** + * Gets the default type url for ReadTensorboardUsageResponse + * @function getTypeUrl + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageResponse + * @static + * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns {string} The default type url + */ + ReadTensorboardUsageResponse.getTypeUrl = function getTypeUrl(typeUrlPrefix) { + if (typeUrlPrefix === undefined) { + typeUrlPrefix = "type.googleapis.com"; + } + return typeUrlPrefix + "/google.cloud.aiplatform.v1.ReadTensorboardUsageResponse"; + }; + + ReadTensorboardUsageResponse.PerUserUsageData = (function() { + + /** + * Properties of a PerUserUsageData. + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageResponse + * @interface IPerUserUsageData + * @property {string|null} [username] PerUserUsageData username + * @property {number|Long|null} [viewCount] PerUserUsageData viewCount + */ + + /** + * Constructs a new PerUserUsageData. + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageResponse + * @classdesc Represents a PerUserUsageData. + * @implements IPerUserUsageData + * @constructor + * @param {google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.IPerUserUsageData=} [properties] Properties to set + */ + function PerUserUsageData(properties) { + if (properties) + for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) + if (properties[keys[i]] != null) + this[keys[i]] = properties[keys[i]]; + } + + /** + * PerUserUsageData username. + * @member {string} username + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerUserUsageData + * @instance + */ + PerUserUsageData.prototype.username = ""; + + /** + * PerUserUsageData viewCount. + * @member {number|Long} viewCount + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerUserUsageData + * @instance + */ + PerUserUsageData.prototype.viewCount = $util.Long ? $util.Long.fromBits(0,0,false) : 0; + + /** + * Creates a new PerUserUsageData instance using the specified properties. + * @function create + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerUserUsageData + * @static + * @param {google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.IPerUserUsageData=} [properties] Properties to set + * @returns {google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerUserUsageData} PerUserUsageData instance + */ + PerUserUsageData.create = function create(properties) { + return new PerUserUsageData(properties); + }; + + /** + * Encodes the specified PerUserUsageData message. Does not implicitly {@link google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerUserUsageData.verify|verify} messages. + * @function encode + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerUserUsageData + * @static + * @param {google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.IPerUserUsageData} message PerUserUsageData message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + PerUserUsageData.encode = function encode(message, writer) { + if (!writer) + writer = $Writer.create(); + if (message.username != null && Object.hasOwnProperty.call(message, "username")) + writer.uint32(/* id 1, wireType 2 =*/10).string(message.username); + if (message.viewCount != null && Object.hasOwnProperty.call(message, "viewCount")) + writer.uint32(/* id 2, wireType 0 =*/16).int64(message.viewCount); + return writer; + }; + + /** + * Encodes the specified PerUserUsageData message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerUserUsageData.verify|verify} messages. + * @function encodeDelimited + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerUserUsageData + * @static + * @param {google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.IPerUserUsageData} message PerUserUsageData message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + PerUserUsageData.encodeDelimited = function encodeDelimited(message, writer) { + return this.encode(message, writer).ldelim(); + }; + + /** + * Decodes a PerUserUsageData message from the specified reader or buffer. + * @function decode + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerUserUsageData + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @param {number} [length] Message length if known beforehand + * @returns {google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerUserUsageData} PerUserUsageData + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + PerUserUsageData.decode = function decode(reader, length) { + if (!(reader instanceof $Reader)) + reader = $Reader.create(reader); + var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerUserUsageData(); + while (reader.pos < end) { + var tag = reader.uint32(); + switch (tag >>> 3) { + case 1: { + message.username = reader.string(); + break; + } + case 2: { + message.viewCount = reader.int64(); + break; + } + default: + reader.skipType(tag & 7); + break; + } + } + return message; + }; + + /** + * Decodes a PerUserUsageData message from the specified reader or buffer, length delimited. + * @function decodeDelimited + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerUserUsageData + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @returns {google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerUserUsageData} PerUserUsageData + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + PerUserUsageData.decodeDelimited = function decodeDelimited(reader) { + if (!(reader instanceof $Reader)) + reader = new $Reader(reader); + return this.decode(reader, reader.uint32()); + }; + + /** + * Verifies a PerUserUsageData message. + * @function verify + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerUserUsageData + * @static + * @param {Object.} message Plain object to verify + * @returns {string|null} `null` if valid, otherwise the reason why it is not + */ + PerUserUsageData.verify = function verify(message) { + if (typeof message !== "object" || message === null) + return "object expected"; + if (message.username != null && message.hasOwnProperty("username")) + if (!$util.isString(message.username)) + return "username: string expected"; + if (message.viewCount != null && message.hasOwnProperty("viewCount")) + if (!$util.isInteger(message.viewCount) && !(message.viewCount && $util.isInteger(message.viewCount.low) && $util.isInteger(message.viewCount.high))) + return "viewCount: integer|Long expected"; + return null; + }; + + /** + * Creates a PerUserUsageData message from a plain object. Also converts values to their respective internal types. + * @function fromObject + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerUserUsageData + * @static + * @param {Object.} object Plain object + * @returns {google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerUserUsageData} PerUserUsageData + */ + PerUserUsageData.fromObject = function fromObject(object) { + if (object instanceof $root.google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerUserUsageData) + return object; + var message = new $root.google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerUserUsageData(); + if (object.username != null) + message.username = String(object.username); + if (object.viewCount != null) + if ($util.Long) + (message.viewCount = $util.Long.fromValue(object.viewCount)).unsigned = false; + else if (typeof object.viewCount === "string") + message.viewCount = parseInt(object.viewCount, 10); + else if (typeof object.viewCount === "number") + message.viewCount = object.viewCount; + else if (typeof object.viewCount === "object") + message.viewCount = new $util.LongBits(object.viewCount.low >>> 0, object.viewCount.high >>> 0).toNumber(); + return message; + }; + + /** + * Creates a plain object from a PerUserUsageData message. Also converts values to other types if specified. + * @function toObject + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerUserUsageData + * @static + * @param {google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerUserUsageData} message PerUserUsageData + * @param {$protobuf.IConversionOptions} [options] Conversion options + * @returns {Object.} Plain object + */ + PerUserUsageData.toObject = function toObject(message, options) { + if (!options) + options = {}; + var object = {}; + if (options.defaults) { + object.username = ""; + if ($util.Long) { + var long = new $util.Long(0, 0, false); + object.viewCount = options.longs === String ? long.toString() : options.longs === Number ? long.toNumber() : long; + } else + object.viewCount = options.longs === String ? "0" : 0; + } + if (message.username != null && message.hasOwnProperty("username")) + object.username = message.username; + if (message.viewCount != null && message.hasOwnProperty("viewCount")) + if (typeof message.viewCount === "number") + object.viewCount = options.longs === String ? String(message.viewCount) : message.viewCount; + else + object.viewCount = options.longs === String ? $util.Long.prototype.toString.call(message.viewCount) : options.longs === Number ? new $util.LongBits(message.viewCount.low >>> 0, message.viewCount.high >>> 0).toNumber() : message.viewCount; + return object; + }; + + /** + * Converts this PerUserUsageData to JSON. + * @function toJSON + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerUserUsageData + * @instance + * @returns {Object.} JSON object + */ + PerUserUsageData.prototype.toJSON = function toJSON() { + return this.constructor.toObject(this, $protobuf.util.toJSONOptions); + }; + + /** + * Gets the default type url for PerUserUsageData + * @function getTypeUrl + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerUserUsageData + * @static + * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns {string} The default type url + */ + PerUserUsageData.getTypeUrl = function getTypeUrl(typeUrlPrefix) { + if (typeUrlPrefix === undefined) { + typeUrlPrefix = "type.googleapis.com"; + } + return typeUrlPrefix + "/google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerUserUsageData"; + }; + + return PerUserUsageData; + })(); + + ReadTensorboardUsageResponse.PerMonthUsageData = (function() { + + /** + * Properties of a PerMonthUsageData. + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageResponse + * @interface IPerMonthUsageData + * @property {Array.|null} [userUsageData] PerMonthUsageData userUsageData + */ + + /** + * Constructs a new PerMonthUsageData. + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageResponse + * @classdesc Represents a PerMonthUsageData. + * @implements IPerMonthUsageData + * @constructor + * @param {google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.IPerMonthUsageData=} [properties] Properties to set + */ + function PerMonthUsageData(properties) { + this.userUsageData = []; + if (properties) + for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) + if (properties[keys[i]] != null) + this[keys[i]] = properties[keys[i]]; + } + + /** + * PerMonthUsageData userUsageData. + * @member {Array.} userUsageData + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerMonthUsageData + * @instance + */ + PerMonthUsageData.prototype.userUsageData = $util.emptyArray; + + /** + * Creates a new PerMonthUsageData instance using the specified properties. + * @function create + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerMonthUsageData + * @static + * @param {google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.IPerMonthUsageData=} [properties] Properties to set + * @returns {google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerMonthUsageData} PerMonthUsageData instance + */ + PerMonthUsageData.create = function create(properties) { + return new PerMonthUsageData(properties); + }; + + /** + * Encodes the specified PerMonthUsageData message. Does not implicitly {@link google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerMonthUsageData.verify|verify} messages. + * @function encode + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerMonthUsageData + * @static + * @param {google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.IPerMonthUsageData} message PerMonthUsageData message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + PerMonthUsageData.encode = function encode(message, writer) { + if (!writer) + writer = $Writer.create(); + if (message.userUsageData != null && message.userUsageData.length) + for (var i = 0; i < message.userUsageData.length; ++i) + $root.google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerUserUsageData.encode(message.userUsageData[i], writer.uint32(/* id 1, wireType 2 =*/10).fork()).ldelim(); + return writer; + }; + + /** + * Encodes the specified PerMonthUsageData message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerMonthUsageData.verify|verify} messages. + * @function encodeDelimited + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerMonthUsageData + * @static + * @param {google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.IPerMonthUsageData} message PerMonthUsageData message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + PerMonthUsageData.encodeDelimited = function encodeDelimited(message, writer) { + return this.encode(message, writer).ldelim(); + }; + + /** + * Decodes a PerMonthUsageData message from the specified reader or buffer. + * @function decode + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerMonthUsageData + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @param {number} [length] Message length if known beforehand + * @returns {google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerMonthUsageData} PerMonthUsageData + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + PerMonthUsageData.decode = function decode(reader, length) { + if (!(reader instanceof $Reader)) + reader = $Reader.create(reader); + var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerMonthUsageData(); + while (reader.pos < end) { + var tag = reader.uint32(); + switch (tag >>> 3) { + case 1: { + if (!(message.userUsageData && message.userUsageData.length)) + message.userUsageData = []; + message.userUsageData.push($root.google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerUserUsageData.decode(reader, reader.uint32())); + break; + } + default: + reader.skipType(tag & 7); + break; + } + } + return message; + }; + + /** + * Decodes a PerMonthUsageData message from the specified reader or buffer, length delimited. + * @function decodeDelimited + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerMonthUsageData + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @returns {google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerMonthUsageData} PerMonthUsageData + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + PerMonthUsageData.decodeDelimited = function decodeDelimited(reader) { + if (!(reader instanceof $Reader)) + reader = new $Reader(reader); + return this.decode(reader, reader.uint32()); + }; + + /** + * Verifies a PerMonthUsageData message. + * @function verify + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerMonthUsageData + * @static + * @param {Object.} message Plain object to verify + * @returns {string|null} `null` if valid, otherwise the reason why it is not + */ + PerMonthUsageData.verify = function verify(message) { + if (typeof message !== "object" || message === null) + return "object expected"; + if (message.userUsageData != null && message.hasOwnProperty("userUsageData")) { + if (!Array.isArray(message.userUsageData)) + return "userUsageData: array expected"; + for (var i = 0; i < message.userUsageData.length; ++i) { + var error = $root.google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerUserUsageData.verify(message.userUsageData[i]); + if (error) + return "userUsageData." + error; + } + } + return null; + }; + + /** + * Creates a PerMonthUsageData message from a plain object. Also converts values to their respective internal types. + * @function fromObject + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerMonthUsageData + * @static + * @param {Object.} object Plain object + * @returns {google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerMonthUsageData} PerMonthUsageData + */ + PerMonthUsageData.fromObject = function fromObject(object) { + if (object instanceof $root.google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerMonthUsageData) + return object; + var message = new $root.google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerMonthUsageData(); + if (object.userUsageData) { + if (!Array.isArray(object.userUsageData)) + throw TypeError(".google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerMonthUsageData.userUsageData: array expected"); + message.userUsageData = []; + for (var i = 0; i < object.userUsageData.length; ++i) { + if (typeof object.userUsageData[i] !== "object") + throw TypeError(".google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerMonthUsageData.userUsageData: object expected"); + message.userUsageData[i] = $root.google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerUserUsageData.fromObject(object.userUsageData[i]); + } + } + return message; + }; + + /** + * Creates a plain object from a PerMonthUsageData message. Also converts values to other types if specified. + * @function toObject + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerMonthUsageData + * @static + * @param {google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerMonthUsageData} message PerMonthUsageData + * @param {$protobuf.IConversionOptions} [options] Conversion options + * @returns {Object.} Plain object + */ + PerMonthUsageData.toObject = function toObject(message, options) { + if (!options) + options = {}; + var object = {}; + if (options.arrays || options.defaults) + object.userUsageData = []; + if (message.userUsageData && message.userUsageData.length) { + object.userUsageData = []; + for (var j = 0; j < message.userUsageData.length; ++j) + object.userUsageData[j] = $root.google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerUserUsageData.toObject(message.userUsageData[j], options); + } + return object; + }; + + /** + * Converts this PerMonthUsageData to JSON. + * @function toJSON + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerMonthUsageData + * @instance + * @returns {Object.} JSON object + */ + PerMonthUsageData.prototype.toJSON = function toJSON() { + return this.constructor.toObject(this, $protobuf.util.toJSONOptions); + }; + + /** + * Gets the default type url for PerMonthUsageData + * @function getTypeUrl + * @memberof google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerMonthUsageData + * @static + * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns {string} The default type url + */ + PerMonthUsageData.getTypeUrl = function getTypeUrl(typeUrlPrefix) { + if (typeUrlPrefix === undefined) { + typeUrlPrefix = "type.googleapis.com"; + } + return typeUrlPrefix + "/google.cloud.aiplatform.v1.ReadTensorboardUsageResponse.PerMonthUsageData"; + }; + + return PerMonthUsageData; + })(); + + return ReadTensorboardUsageResponse; + })(); + v1.ListTensorboardsRequest = (function() { /** @@ -165268,6 +169046,7 @@ * @property {number} NVIDIA_TESLA_P4=4 NVIDIA_TESLA_P4 value * @property {number} NVIDIA_TESLA_T4=5 NVIDIA_TESLA_T4 value * @property {number} NVIDIA_TESLA_A100=8 NVIDIA_TESLA_A100 value + * @property {number} NVIDIA_A100_80GB=9 NVIDIA_A100_80GB value * @property {number} TPU_V2=6 TPU_V2 value * @property {number} TPU_V3=7 TPU_V3 value */ @@ -165280,6 +169059,7 @@ values[valuesById[4] = "NVIDIA_TESLA_P4"] = 4; values[valuesById[5] = "NVIDIA_TESLA_T4"] = 5; values[valuesById[8] = "NVIDIA_TESLA_A100"] = 8; + values[valuesById[9] = "NVIDIA_A100_80GB"] = 9; values[valuesById[6] = "TPU_V2"] = 6; values[valuesById[7] = "TPU_V3"] = 7; return values; @@ -166846,6 +170626,7 @@ * @property {string|null} [modelVersionId] BatchPredictionJob modelVersionId * @property {google.cloud.aiplatform.v1beta1.IUnmanagedContainerModel|null} [unmanagedContainerModel] BatchPredictionJob unmanagedContainerModel * @property {google.cloud.aiplatform.v1beta1.BatchPredictionJob.IInputConfig|null} [inputConfig] BatchPredictionJob inputConfig + * @property {google.cloud.aiplatform.v1beta1.BatchPredictionJob.IInstanceConfig|null} [instanceConfig] BatchPredictionJob instanceConfig * @property {google.protobuf.IValue|null} [modelParameters] BatchPredictionJob modelParameters * @property {google.cloud.aiplatform.v1beta1.BatchPredictionJob.IOutputConfig|null} [outputConfig] BatchPredictionJob outputConfig * @property {google.cloud.aiplatform.v1beta1.IBatchDedicatedResources|null} [dedicatedResources] BatchPredictionJob dedicatedResources @@ -166936,6 +170717,14 @@ */ BatchPredictionJob.prototype.inputConfig = null; + /** + * BatchPredictionJob instanceConfig. + * @member {google.cloud.aiplatform.v1beta1.BatchPredictionJob.IInstanceConfig|null|undefined} instanceConfig + * @memberof google.cloud.aiplatform.v1beta1.BatchPredictionJob + * @instance + */ + BatchPredictionJob.prototype.instanceConfig = null; + /** * BatchPredictionJob modelParameters. * @member {google.protobuf.IValue|null|undefined} modelParameters @@ -167184,6 +170973,8 @@ $root.google.cloud.aiplatform.v1beta1.ExplanationSpec.encode(message.explanationSpec, writer.uint32(/* id 25, wireType 2 =*/202).fork()).ldelim(); if (message.modelMonitoringConfig != null && Object.hasOwnProperty.call(message, "modelMonitoringConfig")) $root.google.cloud.aiplatform.v1beta1.ModelMonitoringConfig.encode(message.modelMonitoringConfig, writer.uint32(/* id 26, wireType 2 =*/210).fork()).ldelim(); + if (message.instanceConfig != null && Object.hasOwnProperty.call(message, "instanceConfig")) + $root.google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig.encode(message.instanceConfig, writer.uint32(/* id 27, wireType 2 =*/218).fork()).ldelim(); if (message.unmanagedContainerModel != null && Object.hasOwnProperty.call(message, "unmanagedContainerModel")) $root.google.cloud.aiplatform.v1beta1.UnmanagedContainerModel.encode(message.unmanagedContainerModel, writer.uint32(/* id 28, wireType 2 =*/226).fork()).ldelim(); if (message.serviceAccount != null && Object.hasOwnProperty.call(message, "serviceAccount")) @@ -167253,6 +171044,10 @@ message.inputConfig = $root.google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig.decode(reader, reader.uint32()); break; } + case 27: { + message.instanceConfig = $root.google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig.decode(reader, reader.uint32()); + break; + } case 5: { message.modelParameters = $root.google.protobuf.Value.decode(reader, reader.uint32()); break; @@ -167421,6 +171216,11 @@ if (error) return "inputConfig." + error; } + if (message.instanceConfig != null && message.hasOwnProperty("instanceConfig")) { + var error = $root.google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig.verify(message.instanceConfig); + if (error) + return "instanceConfig." + error; + } if (message.modelParameters != null && message.hasOwnProperty("modelParameters")) { var error = $root.google.protobuf.Value.verify(message.modelParameters); if (error) @@ -167583,6 +171383,11 @@ throw TypeError(".google.cloud.aiplatform.v1beta1.BatchPredictionJob.inputConfig: object expected"); message.inputConfig = $root.google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig.fromObject(object.inputConfig); } + if (object.instanceConfig != null) { + if (typeof object.instanceConfig !== "object") + throw TypeError(".google.cloud.aiplatform.v1beta1.BatchPredictionJob.instanceConfig: object expected"); + message.instanceConfig = $root.google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig.fromObject(object.instanceConfig); + } if (object.modelParameters != null) { if (typeof object.modelParameters !== "object") throw TypeError(".google.cloud.aiplatform.v1beta1.BatchPredictionJob.modelParameters: object expected"); @@ -167790,6 +171595,7 @@ object.encryptionSpec = null; object.explanationSpec = null; object.modelMonitoringConfig = null; + object.instanceConfig = null; object.unmanagedContainerModel = null; object.serviceAccount = ""; object.modelVersionId = ""; @@ -167848,6 +171654,8 @@ object.explanationSpec = $root.google.cloud.aiplatform.v1beta1.ExplanationSpec.toObject(message.explanationSpec, options); if (message.modelMonitoringConfig != null && message.hasOwnProperty("modelMonitoringConfig")) object.modelMonitoringConfig = $root.google.cloud.aiplatform.v1beta1.ModelMonitoringConfig.toObject(message.modelMonitoringConfig, options); + if (message.instanceConfig != null && message.hasOwnProperty("instanceConfig")) + object.instanceConfig = $root.google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig.toObject(message.instanceConfig, options); if (message.unmanagedContainerModel != null && message.hasOwnProperty("unmanagedContainerModel")) object.unmanagedContainerModel = $root.google.cloud.aiplatform.v1beta1.UnmanagedContainerModel.toObject(message.unmanagedContainerModel, options); if (message.serviceAccount != null && message.hasOwnProperty("serviceAccount")) @@ -168176,6 +171984,313 @@ return InputConfig; })(); + BatchPredictionJob.InstanceConfig = (function() { + + /** + * Properties of an InstanceConfig. + * @memberof google.cloud.aiplatform.v1beta1.BatchPredictionJob + * @interface IInstanceConfig + * @property {string|null} [instanceType] InstanceConfig instanceType + * @property {string|null} [keyField] InstanceConfig keyField + * @property {Array.|null} [includedFields] InstanceConfig includedFields + * @property {Array.|null} [excludedFields] InstanceConfig excludedFields + */ + + /** + * Constructs a new InstanceConfig. + * @memberof google.cloud.aiplatform.v1beta1.BatchPredictionJob + * @classdesc Represents an InstanceConfig. + * @implements IInstanceConfig + * @constructor + * @param {google.cloud.aiplatform.v1beta1.BatchPredictionJob.IInstanceConfig=} [properties] Properties to set + */ + function InstanceConfig(properties) { + this.includedFields = []; + this.excludedFields = []; + if (properties) + for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) + if (properties[keys[i]] != null) + this[keys[i]] = properties[keys[i]]; + } + + /** + * InstanceConfig instanceType. + * @member {string} instanceType + * @memberof google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig + * @instance + */ + InstanceConfig.prototype.instanceType = ""; + + /** + * InstanceConfig keyField. + * @member {string} keyField + * @memberof google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig + * @instance + */ + InstanceConfig.prototype.keyField = ""; + + /** + * InstanceConfig includedFields. + * @member {Array.} includedFields + * @memberof google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig + * @instance + */ + InstanceConfig.prototype.includedFields = $util.emptyArray; + + /** + * InstanceConfig excludedFields. + * @member {Array.} excludedFields + * @memberof google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig + * @instance + */ + InstanceConfig.prototype.excludedFields = $util.emptyArray; + + /** + * Creates a new InstanceConfig instance using the specified properties. + * @function create + * @memberof google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig + * @static + * @param {google.cloud.aiplatform.v1beta1.BatchPredictionJob.IInstanceConfig=} [properties] Properties to set + * @returns {google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig} InstanceConfig instance + */ + InstanceConfig.create = function create(properties) { + return new InstanceConfig(properties); + }; + + /** + * Encodes the specified InstanceConfig message. Does not implicitly {@link google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig.verify|verify} messages. + * @function encode + * @memberof google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig + * @static + * @param {google.cloud.aiplatform.v1beta1.BatchPredictionJob.IInstanceConfig} message InstanceConfig message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + InstanceConfig.encode = function encode(message, writer) { + if (!writer) + writer = $Writer.create(); + if (message.instanceType != null && Object.hasOwnProperty.call(message, "instanceType")) + writer.uint32(/* id 1, wireType 2 =*/10).string(message.instanceType); + if (message.keyField != null && Object.hasOwnProperty.call(message, "keyField")) + writer.uint32(/* id 2, wireType 2 =*/18).string(message.keyField); + if (message.includedFields != null && message.includedFields.length) + for (var i = 0; i < message.includedFields.length; ++i) + writer.uint32(/* id 3, wireType 2 =*/26).string(message.includedFields[i]); + if (message.excludedFields != null && message.excludedFields.length) + for (var i = 0; i < message.excludedFields.length; ++i) + writer.uint32(/* id 4, wireType 2 =*/34).string(message.excludedFields[i]); + return writer; + }; + + /** + * Encodes the specified InstanceConfig message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig.verify|verify} messages. + * @function encodeDelimited + * @memberof google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig + * @static + * @param {google.cloud.aiplatform.v1beta1.BatchPredictionJob.IInstanceConfig} message InstanceConfig message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + InstanceConfig.encodeDelimited = function encodeDelimited(message, writer) { + return this.encode(message, writer).ldelim(); + }; + + /** + * Decodes an InstanceConfig message from the specified reader or buffer. + * @function decode + * @memberof google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @param {number} [length] Message length if known beforehand + * @returns {google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig} InstanceConfig + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + InstanceConfig.decode = function decode(reader, length) { + if (!(reader instanceof $Reader)) + reader = $Reader.create(reader); + var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig(); + while (reader.pos < end) { + var tag = reader.uint32(); + switch (tag >>> 3) { + case 1: { + message.instanceType = reader.string(); + break; + } + case 2: { + message.keyField = reader.string(); + break; + } + case 3: { + if (!(message.includedFields && message.includedFields.length)) + message.includedFields = []; + message.includedFields.push(reader.string()); + break; + } + case 4: { + if (!(message.excludedFields && message.excludedFields.length)) + message.excludedFields = []; + message.excludedFields.push(reader.string()); + break; + } + default: + reader.skipType(tag & 7); + break; + } + } + return message; + }; + + /** + * Decodes an InstanceConfig message from the specified reader or buffer, length delimited. + * @function decodeDelimited + * @memberof google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @returns {google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig} InstanceConfig + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + InstanceConfig.decodeDelimited = function decodeDelimited(reader) { + if (!(reader instanceof $Reader)) + reader = new $Reader(reader); + return this.decode(reader, reader.uint32()); + }; + + /** + * Verifies an InstanceConfig message. + * @function verify + * @memberof google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig + * @static + * @param {Object.} message Plain object to verify + * @returns {string|null} `null` if valid, otherwise the reason why it is not + */ + InstanceConfig.verify = function verify(message) { + if (typeof message !== "object" || message === null) + return "object expected"; + if (message.instanceType != null && message.hasOwnProperty("instanceType")) + if (!$util.isString(message.instanceType)) + return "instanceType: string expected"; + if (message.keyField != null && message.hasOwnProperty("keyField")) + if (!$util.isString(message.keyField)) + return "keyField: string expected"; + if (message.includedFields != null && message.hasOwnProperty("includedFields")) { + if (!Array.isArray(message.includedFields)) + return "includedFields: array expected"; + for (var i = 0; i < message.includedFields.length; ++i) + if (!$util.isString(message.includedFields[i])) + return "includedFields: string[] expected"; + } + if (message.excludedFields != null && message.hasOwnProperty("excludedFields")) { + if (!Array.isArray(message.excludedFields)) + return "excludedFields: array expected"; + for (var i = 0; i < message.excludedFields.length; ++i) + if (!$util.isString(message.excludedFields[i])) + return "excludedFields: string[] expected"; + } + return null; + }; + + /** + * Creates an InstanceConfig message from a plain object. Also converts values to their respective internal types. + * @function fromObject + * @memberof google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig + * @static + * @param {Object.} object Plain object + * @returns {google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig} InstanceConfig + */ + InstanceConfig.fromObject = function fromObject(object) { + if (object instanceof $root.google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig) + return object; + var message = new $root.google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig(); + if (object.instanceType != null) + message.instanceType = String(object.instanceType); + if (object.keyField != null) + message.keyField = String(object.keyField); + if (object.includedFields) { + if (!Array.isArray(object.includedFields)) + throw TypeError(".google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig.includedFields: array expected"); + message.includedFields = []; + for (var i = 0; i < object.includedFields.length; ++i) + message.includedFields[i] = String(object.includedFields[i]); + } + if (object.excludedFields) { + if (!Array.isArray(object.excludedFields)) + throw TypeError(".google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig.excludedFields: array expected"); + message.excludedFields = []; + for (var i = 0; i < object.excludedFields.length; ++i) + message.excludedFields[i] = String(object.excludedFields[i]); + } + return message; + }; + + /** + * Creates a plain object from an InstanceConfig message. Also converts values to other types if specified. + * @function toObject + * @memberof google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig + * @static + * @param {google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig} message InstanceConfig + * @param {$protobuf.IConversionOptions} [options] Conversion options + * @returns {Object.} Plain object + */ + InstanceConfig.toObject = function toObject(message, options) { + if (!options) + options = {}; + var object = {}; + if (options.arrays || options.defaults) { + object.includedFields = []; + object.excludedFields = []; + } + if (options.defaults) { + object.instanceType = ""; + object.keyField = ""; + } + if (message.instanceType != null && message.hasOwnProperty("instanceType")) + object.instanceType = message.instanceType; + if (message.keyField != null && message.hasOwnProperty("keyField")) + object.keyField = message.keyField; + if (message.includedFields && message.includedFields.length) { + object.includedFields = []; + for (var j = 0; j < message.includedFields.length; ++j) + object.includedFields[j] = message.includedFields[j]; + } + if (message.excludedFields && message.excludedFields.length) { + object.excludedFields = []; + for (var j = 0; j < message.excludedFields.length; ++j) + object.excludedFields[j] = message.excludedFields[j]; + } + return object; + }; + + /** + * Converts this InstanceConfig to JSON. + * @function toJSON + * @memberof google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig + * @instance + * @returns {Object.} JSON object + */ + InstanceConfig.prototype.toJSON = function toJSON() { + return this.constructor.toObject(this, $protobuf.util.toJSONOptions); + }; + + /** + * Gets the default type url for InstanceConfig + * @function getTypeUrl + * @memberof google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig + * @static + * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns {string} The default type url + */ + InstanceConfig.getTypeUrl = function getTypeUrl(typeUrlPrefix) { + if (typeUrlPrefix === undefined) { + typeUrlPrefix = "type.googleapis.com"; + } + return typeUrlPrefix + "/google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig"; + }; + + return InstanceConfig; + })(); + BatchPredictionJob.OutputConfig = (function() { /** @@ -178761,6 +182876,7 @@ case 4: case 5: case 8: + case 9: case 6: case 7: break; @@ -178820,6 +182936,10 @@ case 8: message.acceleratorType = 8; break; + case "NVIDIA_A100_80GB": + case 9: + message.acceleratorType = 9; + break; case "TPU_V2": case 6: message.acceleratorType = 6; @@ -187380,6 +191500,7 @@ * @property {Object.|null} [labels] Model labels * @property {google.cloud.aiplatform.v1beta1.IEncryptionSpec|null} [encryptionSpec] Model encryptionSpec * @property {google.cloud.aiplatform.v1beta1.IModelSourceInfo|null} [modelSourceInfo] Model modelSourceInfo + * @property {string|null} [metadataArtifact] Model metadataArtifact */ /** @@ -187612,6 +191733,14 @@ */ Model.prototype.modelSourceInfo = null; + /** + * Model metadataArtifact. + * @member {string} metadataArtifact + * @memberof google.cloud.aiplatform.v1beta1.Model + * @instance + */ + Model.prototype.metadataArtifact = ""; + /** * Creates a new Model instance using the specified properties. * @function create @@ -187698,6 +191827,8 @@ $root.google.protobuf.Timestamp.encode(message.versionUpdateTime, writer.uint32(/* id 32, wireType 2 =*/258).fork()).ldelim(); if (message.modelSourceInfo != null && Object.hasOwnProperty.call(message, "modelSourceInfo")) $root.google.cloud.aiplatform.v1beta1.ModelSourceInfo.encode(message.modelSourceInfo, writer.uint32(/* id 38, wireType 2 =*/306).fork()).ldelim(); + if (message.metadataArtifact != null && Object.hasOwnProperty.call(message, "metadataArtifact")) + writer.uint32(/* id 44, wireType 2 =*/354).string(message.metadataArtifact); return writer; }; @@ -187872,6 +192003,10 @@ message.modelSourceInfo = $root.google.cloud.aiplatform.v1beta1.ModelSourceInfo.decode(reader, reader.uint32()); break; } + case 44: { + message.metadataArtifact = reader.string(); + break; + } default: reader.skipType(tag & 7); break; @@ -188045,6 +192180,9 @@ if (error) return "modelSourceInfo." + error; } + if (message.metadataArtifact != null && message.hasOwnProperty("metadataArtifact")) + if (!$util.isString(message.metadataArtifact)) + return "metadataArtifact: string expected"; return null; }; @@ -188205,6 +192343,8 @@ throw TypeError(".google.cloud.aiplatform.v1beta1.Model.modelSourceInfo: object expected"); message.modelSourceInfo = $root.google.cloud.aiplatform.v1beta1.ModelSourceInfo.fromObject(object.modelSourceInfo); } + if (object.metadataArtifact != null) + message.metadataArtifact = String(object.metadataArtifact); return message; }; @@ -188251,6 +192391,7 @@ object.versionCreateTime = null; object.versionUpdateTime = null; object.modelSourceInfo = null; + object.metadataArtifact = ""; } if (message.name != null && message.hasOwnProperty("name")) object.name = message.name; @@ -188326,6 +192467,8 @@ object.versionUpdateTime = $root.google.protobuf.Timestamp.toObject(message.versionUpdateTime, options); if (message.modelSourceInfo != null && message.hasOwnProperty("modelSourceInfo")) object.modelSourceInfo = $root.google.cloud.aiplatform.v1beta1.ModelSourceInfo.toObject(message.modelSourceInfo, options); + if (message.metadataArtifact != null && message.hasOwnProperty("metadataArtifact")) + object.metadataArtifact = message.metadataArtifact; return object; }; @@ -191385,6 +195528,7 @@ * @property {google.cloud.aiplatform.v1beta1.IGcsDestination|null} [baseOutputDirectory] CustomJobSpec baseOutputDirectory * @property {string|null} [tensorboard] CustomJobSpec tensorboard * @property {boolean|null} [enableWebAccess] CustomJobSpec enableWebAccess + * @property {boolean|null} [enableDashboardAccess] CustomJobSpec enableDashboardAccess */ /** @@ -191468,6 +195612,14 @@ */ CustomJobSpec.prototype.enableWebAccess = false; + /** + * CustomJobSpec enableDashboardAccess. + * @member {boolean} enableDashboardAccess + * @memberof google.cloud.aiplatform.v1beta1.CustomJobSpec + * @instance + */ + CustomJobSpec.prototype.enableDashboardAccess = false; + /** * Creates a new CustomJobSpec instance using the specified properties. * @function create @@ -191510,6 +195662,8 @@ if (message.reservedIpRanges != null && message.reservedIpRanges.length) for (var i = 0; i < message.reservedIpRanges.length; ++i) writer.uint32(/* id 13, wireType 2 =*/106).string(message.reservedIpRanges[i]); + if (message.enableDashboardAccess != null && Object.hasOwnProperty.call(message, "enableDashboardAccess")) + writer.uint32(/* id 16, wireType 0 =*/128).bool(message.enableDashboardAccess); return writer; }; @@ -191580,6 +195734,10 @@ message.enableWebAccess = reader.bool(); break; } + case 16: { + message.enableDashboardAccess = reader.bool(); + break; + } default: reader.skipType(tag & 7); break; @@ -191653,6 +195811,9 @@ if (message.enableWebAccess != null && message.hasOwnProperty("enableWebAccess")) if (typeof message.enableWebAccess !== "boolean") return "enableWebAccess: boolean expected"; + if (message.enableDashboardAccess != null && message.hasOwnProperty("enableDashboardAccess")) + if (typeof message.enableDashboardAccess !== "boolean") + return "enableDashboardAccess: boolean expected"; return null; }; @@ -191703,6 +195864,8 @@ message.tensorboard = String(object.tensorboard); if (object.enableWebAccess != null) message.enableWebAccess = Boolean(object.enableWebAccess); + if (object.enableDashboardAccess != null) + message.enableDashboardAccess = Boolean(object.enableDashboardAccess); return message; }; @@ -191730,6 +195893,7 @@ object.baseOutputDirectory = null; object.tensorboard = ""; object.enableWebAccess = false; + object.enableDashboardAccess = false; } if (message.workerPoolSpecs && message.workerPoolSpecs.length) { object.workerPoolSpecs = []; @@ -191753,6 +195917,8 @@ for (var j = 0; j < message.reservedIpRanges.length; ++j) object.reservedIpRanges[j] = message.reservedIpRanges[j]; } + if (message.enableDashboardAccess != null && message.hasOwnProperty("enableDashboardAccess")) + object.enableDashboardAccess = message.enableDashboardAccess; return object; }; @@ -195132,7 +199298,9 @@ * @property {google.protobuf.ITimestamp|null} [updateTime] Dataset updateTime * @property {string|null} [etag] Dataset etag * @property {Object.|null} [labels] Dataset labels + * @property {Array.|null} [savedQueries] Dataset savedQueries * @property {google.cloud.aiplatform.v1beta1.IEncryptionSpec|null} [encryptionSpec] Dataset encryptionSpec + * @property {string|null} [metadataArtifact] Dataset metadataArtifact */ /** @@ -195145,6 +199313,7 @@ */ function Dataset(properties) { this.labels = {}; + this.savedQueries = []; if (properties) for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) if (properties[keys[i]] != null) @@ -195223,6 +199392,14 @@ */ Dataset.prototype.labels = $util.emptyObject; + /** + * Dataset savedQueries. + * @member {Array.} savedQueries + * @memberof google.cloud.aiplatform.v1beta1.Dataset + * @instance + */ + Dataset.prototype.savedQueries = $util.emptyArray; + /** * Dataset encryptionSpec. * @member {google.cloud.aiplatform.v1beta1.IEncryptionSpec|null|undefined} encryptionSpec @@ -195231,6 +199408,14 @@ */ Dataset.prototype.encryptionSpec = null; + /** + * Dataset metadataArtifact. + * @member {string} metadataArtifact + * @memberof google.cloud.aiplatform.v1beta1.Dataset + * @instance + */ + Dataset.prototype.metadataArtifact = ""; + /** * Creates a new Dataset instance using the specified properties. * @function create @@ -195272,10 +199457,15 @@ writer.uint32(/* id 7, wireType 2 =*/58).fork().uint32(/* id 1, wireType 2 =*/10).string(keys[i]).uint32(/* id 2, wireType 2 =*/18).string(message.labels[keys[i]]).ldelim(); if (message.metadata != null && Object.hasOwnProperty.call(message, "metadata")) $root.google.protobuf.Value.encode(message.metadata, writer.uint32(/* id 8, wireType 2 =*/66).fork()).ldelim(); + if (message.savedQueries != null && message.savedQueries.length) + for (var i = 0; i < message.savedQueries.length; ++i) + $root.google.cloud.aiplatform.v1beta1.SavedQuery.encode(message.savedQueries[i], writer.uint32(/* id 9, wireType 2 =*/74).fork()).ldelim(); if (message.encryptionSpec != null && Object.hasOwnProperty.call(message, "encryptionSpec")) $root.google.cloud.aiplatform.v1beta1.EncryptionSpec.encode(message.encryptionSpec, writer.uint32(/* id 11, wireType 2 =*/90).fork()).ldelim(); if (message.description != null && Object.hasOwnProperty.call(message, "description")) writer.uint32(/* id 16, wireType 2 =*/130).string(message.description); + if (message.metadataArtifact != null && Object.hasOwnProperty.call(message, "metadataArtifact")) + writer.uint32(/* id 17, wireType 2 =*/138).string(message.metadataArtifact); return writer; }; @@ -195365,10 +199555,20 @@ message.labels[key] = value; break; } + case 9: { + if (!(message.savedQueries && message.savedQueries.length)) + message.savedQueries = []; + message.savedQueries.push($root.google.cloud.aiplatform.v1beta1.SavedQuery.decode(reader, reader.uint32())); + break; + } case 11: { message.encryptionSpec = $root.google.cloud.aiplatform.v1beta1.EncryptionSpec.decode(reader, reader.uint32()); break; } + case 17: { + message.metadataArtifact = reader.string(); + break; + } default: reader.skipType(tag & 7); break; @@ -195442,11 +199642,23 @@ if (!$util.isString(message.labels[key[i]])) return "labels: string{k:string} expected"; } + if (message.savedQueries != null && message.hasOwnProperty("savedQueries")) { + if (!Array.isArray(message.savedQueries)) + return "savedQueries: array expected"; + for (var i = 0; i < message.savedQueries.length; ++i) { + var error = $root.google.cloud.aiplatform.v1beta1.SavedQuery.verify(message.savedQueries[i]); + if (error) + return "savedQueries." + error; + } + } if (message.encryptionSpec != null && message.hasOwnProperty("encryptionSpec")) { var error = $root.google.cloud.aiplatform.v1beta1.EncryptionSpec.verify(message.encryptionSpec); if (error) return "encryptionSpec." + error; } + if (message.metadataArtifact != null && message.hasOwnProperty("metadataArtifact")) + if (!$util.isString(message.metadataArtifact)) + return "metadataArtifact: string expected"; return null; }; @@ -195494,11 +199706,23 @@ for (var keys = Object.keys(object.labels), i = 0; i < keys.length; ++i) message.labels[keys[i]] = String(object.labels[keys[i]]); } + if (object.savedQueries) { + if (!Array.isArray(object.savedQueries)) + throw TypeError(".google.cloud.aiplatform.v1beta1.Dataset.savedQueries: array expected"); + message.savedQueries = []; + for (var i = 0; i < object.savedQueries.length; ++i) { + if (typeof object.savedQueries[i] !== "object") + throw TypeError(".google.cloud.aiplatform.v1beta1.Dataset.savedQueries: object expected"); + message.savedQueries[i] = $root.google.cloud.aiplatform.v1beta1.SavedQuery.fromObject(object.savedQueries[i]); + } + } if (object.encryptionSpec != null) { if (typeof object.encryptionSpec !== "object") throw TypeError(".google.cloud.aiplatform.v1beta1.Dataset.encryptionSpec: object expected"); message.encryptionSpec = $root.google.cloud.aiplatform.v1beta1.EncryptionSpec.fromObject(object.encryptionSpec); } + if (object.metadataArtifact != null) + message.metadataArtifact = String(object.metadataArtifact); return message; }; @@ -195515,6 +199739,8 @@ if (!options) options = {}; var object = {}; + if (options.arrays || options.defaults) + object.savedQueries = []; if (options.objects || options.defaults) object.labels = {}; if (options.defaults) { @@ -195527,6 +199753,7 @@ object.metadata = null; object.encryptionSpec = null; object.description = ""; + object.metadataArtifact = ""; } if (message.name != null && message.hasOwnProperty("name")) object.name = message.name; @@ -195548,10 +199775,17 @@ } if (message.metadata != null && message.hasOwnProperty("metadata")) object.metadata = $root.google.protobuf.Value.toObject(message.metadata, options); + if (message.savedQueries && message.savedQueries.length) { + object.savedQueries = []; + for (var j = 0; j < message.savedQueries.length; ++j) + object.savedQueries[j] = $root.google.cloud.aiplatform.v1beta1.SavedQuery.toObject(message.savedQueries[j], options); + } if (message.encryptionSpec != null && message.hasOwnProperty("encryptionSpec")) object.encryptionSpec = $root.google.cloud.aiplatform.v1beta1.EncryptionSpec.toObject(message.encryptionSpec, options); if (message.description != null && message.hasOwnProperty("description")) object.description = message.description; + if (message.metadataArtifact != null && message.hasOwnProperty("metadataArtifact")) + object.metadataArtifact = message.metadataArtifact; return object; }; @@ -195592,6 +199826,7 @@ * @interface IImportDataConfig * @property {google.cloud.aiplatform.v1beta1.IGcsSource|null} [gcsSource] ImportDataConfig gcsSource * @property {Object.|null} [dataItemLabels] ImportDataConfig dataItemLabels + * @property {Object.|null} [annotationLabels] ImportDataConfig annotationLabels * @property {string|null} [importSchemaUri] ImportDataConfig importSchemaUri */ @@ -195605,6 +199840,7 @@ */ function ImportDataConfig(properties) { this.dataItemLabels = {}; + this.annotationLabels = {}; if (properties) for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) if (properties[keys[i]] != null) @@ -195627,6 +199863,14 @@ */ ImportDataConfig.prototype.dataItemLabels = $util.emptyObject; + /** + * ImportDataConfig annotationLabels. + * @member {Object.} annotationLabels + * @memberof google.cloud.aiplatform.v1beta1.ImportDataConfig + * @instance + */ + ImportDataConfig.prototype.annotationLabels = $util.emptyObject; + /** * ImportDataConfig importSchemaUri. * @member {string} importSchemaUri @@ -195678,6 +199922,9 @@ if (message.dataItemLabels != null && Object.hasOwnProperty.call(message, "dataItemLabels")) for (var keys = Object.keys(message.dataItemLabels), i = 0; i < keys.length; ++i) writer.uint32(/* id 2, wireType 2 =*/18).fork().uint32(/* id 1, wireType 2 =*/10).string(keys[i]).uint32(/* id 2, wireType 2 =*/18).string(message.dataItemLabels[keys[i]]).ldelim(); + if (message.annotationLabels != null && Object.hasOwnProperty.call(message, "annotationLabels")) + for (var keys = Object.keys(message.annotationLabels), i = 0; i < keys.length; ++i) + writer.uint32(/* id 3, wireType 2 =*/26).fork().uint32(/* id 1, wireType 2 =*/10).string(keys[i]).uint32(/* id 2, wireType 2 =*/18).string(message.annotationLabels[keys[i]]).ldelim(); if (message.importSchemaUri != null && Object.hasOwnProperty.call(message, "importSchemaUri")) writer.uint32(/* id 4, wireType 2 =*/34).string(message.importSchemaUri); return writer; @@ -195741,6 +199988,29 @@ message.dataItemLabels[key] = value; break; } + case 3: { + if (message.annotationLabels === $util.emptyObject) + message.annotationLabels = {}; + var end2 = reader.uint32() + reader.pos; + key = ""; + value = ""; + while (reader.pos < end2) { + var tag2 = reader.uint32(); + switch (tag2 >>> 3) { + case 1: + key = reader.string(); + break; + case 2: + value = reader.string(); + break; + default: + reader.skipType(tag2 & 7); + break; + } + } + message.annotationLabels[key] = value; + break; + } case 4: { message.importSchemaUri = reader.string(); break; @@ -195797,6 +200067,14 @@ if (!$util.isString(message.dataItemLabels[key[i]])) return "dataItemLabels: string{k:string} expected"; } + if (message.annotationLabels != null && message.hasOwnProperty("annotationLabels")) { + if (!$util.isObject(message.annotationLabels)) + return "annotationLabels: object expected"; + var key = Object.keys(message.annotationLabels); + for (var i = 0; i < key.length; ++i) + if (!$util.isString(message.annotationLabels[key[i]])) + return "annotationLabels: string{k:string} expected"; + } if (message.importSchemaUri != null && message.hasOwnProperty("importSchemaUri")) if (!$util.isString(message.importSchemaUri)) return "importSchemaUri: string expected"; @@ -195827,6 +200105,13 @@ for (var keys = Object.keys(object.dataItemLabels), i = 0; i < keys.length; ++i) message.dataItemLabels[keys[i]] = String(object.dataItemLabels[keys[i]]); } + if (object.annotationLabels) { + if (typeof object.annotationLabels !== "object") + throw TypeError(".google.cloud.aiplatform.v1beta1.ImportDataConfig.annotationLabels: object expected"); + message.annotationLabels = {}; + for (var keys = Object.keys(object.annotationLabels), i = 0; i < keys.length; ++i) + message.annotationLabels[keys[i]] = String(object.annotationLabels[keys[i]]); + } if (object.importSchemaUri != null) message.importSchemaUri = String(object.importSchemaUri); return message; @@ -195845,8 +200130,10 @@ if (!options) options = {}; var object = {}; - if (options.objects || options.defaults) + if (options.objects || options.defaults) { object.dataItemLabels = {}; + object.annotationLabels = {}; + } if (options.defaults) object.importSchemaUri = ""; if (message.gcsSource != null && message.hasOwnProperty("gcsSource")) { @@ -195860,6 +200147,11 @@ for (var j = 0; j < keys2.length; ++j) object.dataItemLabels[keys2[j]] = message.dataItemLabels[keys2[j]]; } + if (message.annotationLabels && (keys2 = Object.keys(message.annotationLabels)).length) { + object.annotationLabels = {}; + for (var j = 0; j < keys2.length; ++j) + object.annotationLabels[keys2[j]] = message.annotationLabels[keys2[j]]; + } if (message.importSchemaUri != null && message.hasOwnProperty("importSchemaUri")) object.importSchemaUri = message.importSchemaUri; return object; @@ -196145,6 +200437,432 @@ return ExportDataConfig; })(); + v1beta1.SavedQuery = (function() { + + /** + * Properties of a SavedQuery. + * @memberof google.cloud.aiplatform.v1beta1 + * @interface ISavedQuery + * @property {string|null} [name] SavedQuery name + * @property {string|null} [displayName] SavedQuery displayName + * @property {google.protobuf.IValue|null} [metadata] SavedQuery metadata + * @property {google.protobuf.ITimestamp|null} [createTime] SavedQuery createTime + * @property {google.protobuf.ITimestamp|null} [updateTime] SavedQuery updateTime + * @property {string|null} [annotationFilter] SavedQuery annotationFilter + * @property {string|null} [problemType] SavedQuery problemType + * @property {number|null} [annotationSpecCount] SavedQuery annotationSpecCount + * @property {string|null} [etag] SavedQuery etag + * @property {boolean|null} [supportAutomlTraining] SavedQuery supportAutomlTraining + */ + + /** + * Constructs a new SavedQuery. + * @memberof google.cloud.aiplatform.v1beta1 + * @classdesc Represents a SavedQuery. + * @implements ISavedQuery + * @constructor + * @param {google.cloud.aiplatform.v1beta1.ISavedQuery=} [properties] Properties to set + */ + function SavedQuery(properties) { + if (properties) + for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) + if (properties[keys[i]] != null) + this[keys[i]] = properties[keys[i]]; + } + + /** + * SavedQuery name. + * @member {string} name + * @memberof google.cloud.aiplatform.v1beta1.SavedQuery + * @instance + */ + SavedQuery.prototype.name = ""; + + /** + * SavedQuery displayName. + * @member {string} displayName + * @memberof google.cloud.aiplatform.v1beta1.SavedQuery + * @instance + */ + SavedQuery.prototype.displayName = ""; + + /** + * SavedQuery metadata. + * @member {google.protobuf.IValue|null|undefined} metadata + * @memberof google.cloud.aiplatform.v1beta1.SavedQuery + * @instance + */ + SavedQuery.prototype.metadata = null; + + /** + * SavedQuery createTime. + * @member {google.protobuf.ITimestamp|null|undefined} createTime + * @memberof google.cloud.aiplatform.v1beta1.SavedQuery + * @instance + */ + SavedQuery.prototype.createTime = null; + + /** + * SavedQuery updateTime. + * @member {google.protobuf.ITimestamp|null|undefined} updateTime + * @memberof google.cloud.aiplatform.v1beta1.SavedQuery + * @instance + */ + SavedQuery.prototype.updateTime = null; + + /** + * SavedQuery annotationFilter. + * @member {string} annotationFilter + * @memberof google.cloud.aiplatform.v1beta1.SavedQuery + * @instance + */ + SavedQuery.prototype.annotationFilter = ""; + + /** + * SavedQuery problemType. + * @member {string} problemType + * @memberof google.cloud.aiplatform.v1beta1.SavedQuery + * @instance + */ + SavedQuery.prototype.problemType = ""; + + /** + * SavedQuery annotationSpecCount. + * @member {number} annotationSpecCount + * @memberof google.cloud.aiplatform.v1beta1.SavedQuery + * @instance + */ + SavedQuery.prototype.annotationSpecCount = 0; + + /** + * SavedQuery etag. + * @member {string} etag + * @memberof google.cloud.aiplatform.v1beta1.SavedQuery + * @instance + */ + SavedQuery.prototype.etag = ""; + + /** + * SavedQuery supportAutomlTraining. + * @member {boolean} supportAutomlTraining + * @memberof google.cloud.aiplatform.v1beta1.SavedQuery + * @instance + */ + SavedQuery.prototype.supportAutomlTraining = false; + + /** + * Creates a new SavedQuery instance using the specified properties. + * @function create + * @memberof google.cloud.aiplatform.v1beta1.SavedQuery + * @static + * @param {google.cloud.aiplatform.v1beta1.ISavedQuery=} [properties] Properties to set + * @returns {google.cloud.aiplatform.v1beta1.SavedQuery} SavedQuery instance + */ + SavedQuery.create = function create(properties) { + return new SavedQuery(properties); + }; + + /** + * Encodes the specified SavedQuery message. Does not implicitly {@link google.cloud.aiplatform.v1beta1.SavedQuery.verify|verify} messages. + * @function encode + * @memberof google.cloud.aiplatform.v1beta1.SavedQuery + * @static + * @param {google.cloud.aiplatform.v1beta1.ISavedQuery} message SavedQuery message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + SavedQuery.encode = function encode(message, writer) { + if (!writer) + writer = $Writer.create(); + if (message.name != null && Object.hasOwnProperty.call(message, "name")) + writer.uint32(/* id 1, wireType 2 =*/10).string(message.name); + if (message.displayName != null && Object.hasOwnProperty.call(message, "displayName")) + writer.uint32(/* id 2, wireType 2 =*/18).string(message.displayName); + if (message.createTime != null && Object.hasOwnProperty.call(message, "createTime")) + $root.google.protobuf.Timestamp.encode(message.createTime, writer.uint32(/* id 3, wireType 2 =*/26).fork()).ldelim(); + if (message.updateTime != null && Object.hasOwnProperty.call(message, "updateTime")) + $root.google.protobuf.Timestamp.encode(message.updateTime, writer.uint32(/* id 4, wireType 2 =*/34).fork()).ldelim(); + if (message.annotationFilter != null && Object.hasOwnProperty.call(message, "annotationFilter")) + writer.uint32(/* id 5, wireType 2 =*/42).string(message.annotationFilter); + if (message.problemType != null && Object.hasOwnProperty.call(message, "problemType")) + writer.uint32(/* id 6, wireType 2 =*/50).string(message.problemType); + if (message.etag != null && Object.hasOwnProperty.call(message, "etag")) + writer.uint32(/* id 8, wireType 2 =*/66).string(message.etag); + if (message.supportAutomlTraining != null && Object.hasOwnProperty.call(message, "supportAutomlTraining")) + writer.uint32(/* id 9, wireType 0 =*/72).bool(message.supportAutomlTraining); + if (message.annotationSpecCount != null && Object.hasOwnProperty.call(message, "annotationSpecCount")) + writer.uint32(/* id 10, wireType 0 =*/80).int32(message.annotationSpecCount); + if (message.metadata != null && Object.hasOwnProperty.call(message, "metadata")) + $root.google.protobuf.Value.encode(message.metadata, writer.uint32(/* id 12, wireType 2 =*/98).fork()).ldelim(); + return writer; + }; + + /** + * Encodes the specified SavedQuery message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1beta1.SavedQuery.verify|verify} messages. + * @function encodeDelimited + * @memberof google.cloud.aiplatform.v1beta1.SavedQuery + * @static + * @param {google.cloud.aiplatform.v1beta1.ISavedQuery} message SavedQuery message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + SavedQuery.encodeDelimited = function encodeDelimited(message, writer) { + return this.encode(message, writer).ldelim(); + }; + + /** + * Decodes a SavedQuery message from the specified reader or buffer. + * @function decode + * @memberof google.cloud.aiplatform.v1beta1.SavedQuery + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @param {number} [length] Message length if known beforehand + * @returns {google.cloud.aiplatform.v1beta1.SavedQuery} SavedQuery + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + SavedQuery.decode = function decode(reader, length) { + if (!(reader instanceof $Reader)) + reader = $Reader.create(reader); + var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.aiplatform.v1beta1.SavedQuery(); + while (reader.pos < end) { + var tag = reader.uint32(); + switch (tag >>> 3) { + case 1: { + message.name = reader.string(); + break; + } + case 2: { + message.displayName = reader.string(); + break; + } + case 12: { + message.metadata = $root.google.protobuf.Value.decode(reader, reader.uint32()); + break; + } + case 3: { + message.createTime = $root.google.protobuf.Timestamp.decode(reader, reader.uint32()); + break; + } + case 4: { + message.updateTime = $root.google.protobuf.Timestamp.decode(reader, reader.uint32()); + break; + } + case 5: { + message.annotationFilter = reader.string(); + break; + } + case 6: { + message.problemType = reader.string(); + break; + } + case 10: { + message.annotationSpecCount = reader.int32(); + break; + } + case 8: { + message.etag = reader.string(); + break; + } + case 9: { + message.supportAutomlTraining = reader.bool(); + break; + } + default: + reader.skipType(tag & 7); + break; + } + } + return message; + }; + + /** + * Decodes a SavedQuery message from the specified reader or buffer, length delimited. + * @function decodeDelimited + * @memberof google.cloud.aiplatform.v1beta1.SavedQuery + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @returns {google.cloud.aiplatform.v1beta1.SavedQuery} SavedQuery + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + SavedQuery.decodeDelimited = function decodeDelimited(reader) { + if (!(reader instanceof $Reader)) + reader = new $Reader(reader); + return this.decode(reader, reader.uint32()); + }; + + /** + * Verifies a SavedQuery message. + * @function verify + * @memberof google.cloud.aiplatform.v1beta1.SavedQuery + * @static + * @param {Object.} message Plain object to verify + * @returns {string|null} `null` if valid, otherwise the reason why it is not + */ + SavedQuery.verify = function verify(message) { + if (typeof message !== "object" || message === null) + return "object expected"; + if (message.name != null && message.hasOwnProperty("name")) + if (!$util.isString(message.name)) + return "name: string expected"; + if (message.displayName != null && message.hasOwnProperty("displayName")) + if (!$util.isString(message.displayName)) + return "displayName: string expected"; + if (message.metadata != null && message.hasOwnProperty("metadata")) { + var error = $root.google.protobuf.Value.verify(message.metadata); + if (error) + return "metadata." + error; + } + if (message.createTime != null && message.hasOwnProperty("createTime")) { + var error = $root.google.protobuf.Timestamp.verify(message.createTime); + if (error) + return "createTime." + error; + } + if (message.updateTime != null && message.hasOwnProperty("updateTime")) { + var error = $root.google.protobuf.Timestamp.verify(message.updateTime); + if (error) + return "updateTime." + error; + } + if (message.annotationFilter != null && message.hasOwnProperty("annotationFilter")) + if (!$util.isString(message.annotationFilter)) + return "annotationFilter: string expected"; + if (message.problemType != null && message.hasOwnProperty("problemType")) + if (!$util.isString(message.problemType)) + return "problemType: string expected"; + if (message.annotationSpecCount != null && message.hasOwnProperty("annotationSpecCount")) + if (!$util.isInteger(message.annotationSpecCount)) + return "annotationSpecCount: integer expected"; + if (message.etag != null && message.hasOwnProperty("etag")) + if (!$util.isString(message.etag)) + return "etag: string expected"; + if (message.supportAutomlTraining != null && message.hasOwnProperty("supportAutomlTraining")) + if (typeof message.supportAutomlTraining !== "boolean") + return "supportAutomlTraining: boolean expected"; + return null; + }; + + /** + * Creates a SavedQuery message from a plain object. Also converts values to their respective internal types. + * @function fromObject + * @memberof google.cloud.aiplatform.v1beta1.SavedQuery + * @static + * @param {Object.} object Plain object + * @returns {google.cloud.aiplatform.v1beta1.SavedQuery} SavedQuery + */ + SavedQuery.fromObject = function fromObject(object) { + if (object instanceof $root.google.cloud.aiplatform.v1beta1.SavedQuery) + return object; + var message = new $root.google.cloud.aiplatform.v1beta1.SavedQuery(); + if (object.name != null) + message.name = String(object.name); + if (object.displayName != null) + message.displayName = String(object.displayName); + if (object.metadata != null) { + if (typeof object.metadata !== "object") + throw TypeError(".google.cloud.aiplatform.v1beta1.SavedQuery.metadata: object expected"); + message.metadata = $root.google.protobuf.Value.fromObject(object.metadata); + } + if (object.createTime != null) { + if (typeof object.createTime !== "object") + throw TypeError(".google.cloud.aiplatform.v1beta1.SavedQuery.createTime: object expected"); + message.createTime = $root.google.protobuf.Timestamp.fromObject(object.createTime); + } + if (object.updateTime != null) { + if (typeof object.updateTime !== "object") + throw TypeError(".google.cloud.aiplatform.v1beta1.SavedQuery.updateTime: object expected"); + message.updateTime = $root.google.protobuf.Timestamp.fromObject(object.updateTime); + } + if (object.annotationFilter != null) + message.annotationFilter = String(object.annotationFilter); + if (object.problemType != null) + message.problemType = String(object.problemType); + if (object.annotationSpecCount != null) + message.annotationSpecCount = object.annotationSpecCount | 0; + if (object.etag != null) + message.etag = String(object.etag); + if (object.supportAutomlTraining != null) + message.supportAutomlTraining = Boolean(object.supportAutomlTraining); + return message; + }; + + /** + * Creates a plain object from a SavedQuery message. Also converts values to other types if specified. + * @function toObject + * @memberof google.cloud.aiplatform.v1beta1.SavedQuery + * @static + * @param {google.cloud.aiplatform.v1beta1.SavedQuery} message SavedQuery + * @param {$protobuf.IConversionOptions} [options] Conversion options + * @returns {Object.} Plain object + */ + SavedQuery.toObject = function toObject(message, options) { + if (!options) + options = {}; + var object = {}; + if (options.defaults) { + object.name = ""; + object.displayName = ""; + object.createTime = null; + object.updateTime = null; + object.annotationFilter = ""; + object.problemType = ""; + object.etag = ""; + object.supportAutomlTraining = false; + object.annotationSpecCount = 0; + object.metadata = null; + } + if (message.name != null && message.hasOwnProperty("name")) + object.name = message.name; + if (message.displayName != null && message.hasOwnProperty("displayName")) + object.displayName = message.displayName; + if (message.createTime != null && message.hasOwnProperty("createTime")) + object.createTime = $root.google.protobuf.Timestamp.toObject(message.createTime, options); + if (message.updateTime != null && message.hasOwnProperty("updateTime")) + object.updateTime = $root.google.protobuf.Timestamp.toObject(message.updateTime, options); + if (message.annotationFilter != null && message.hasOwnProperty("annotationFilter")) + object.annotationFilter = message.annotationFilter; + if (message.problemType != null && message.hasOwnProperty("problemType")) + object.problemType = message.problemType; + if (message.etag != null && message.hasOwnProperty("etag")) + object.etag = message.etag; + if (message.supportAutomlTraining != null && message.hasOwnProperty("supportAutomlTraining")) + object.supportAutomlTraining = message.supportAutomlTraining; + if (message.annotationSpecCount != null && message.hasOwnProperty("annotationSpecCount")) + object.annotationSpecCount = message.annotationSpecCount; + if (message.metadata != null && message.hasOwnProperty("metadata")) + object.metadata = $root.google.protobuf.Value.toObject(message.metadata, options); + return object; + }; + + /** + * Converts this SavedQuery to JSON. + * @function toJSON + * @memberof google.cloud.aiplatform.v1beta1.SavedQuery + * @instance + * @returns {Object.} JSON object + */ + SavedQuery.prototype.toJSON = function toJSON() { + return this.constructor.toObject(this, $protobuf.util.toJSONOptions); + }; + + /** + * Gets the default type url for SavedQuery + * @function getTypeUrl + * @memberof google.cloud.aiplatform.v1beta1.SavedQuery + * @static + * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns {string} The default type url + */ + SavedQuery.getTypeUrl = function getTypeUrl(typeUrlPrefix) { + if (typeUrlPrefix === undefined) { + typeUrlPrefix = "type.googleapis.com"; + } + return typeUrlPrefix + "/google.cloud.aiplatform.v1beta1.SavedQuery"; + }; + + return SavedQuery; + })(); + v1beta1.DatasetService = (function() { /** @@ -196441,6 +201159,39 @@ * @variation 2 */ + /** + * Callback as used by {@link google.cloud.aiplatform.v1beta1.DatasetService|searchDataItems}. + * @memberof google.cloud.aiplatform.v1beta1.DatasetService + * @typedef SearchDataItemsCallback + * @type {function} + * @param {Error|null} error Error, if any + * @param {google.cloud.aiplatform.v1beta1.SearchDataItemsResponse} [response] SearchDataItemsResponse + */ + + /** + * Calls SearchDataItems. + * @function searchDataItems + * @memberof google.cloud.aiplatform.v1beta1.DatasetService + * @instance + * @param {google.cloud.aiplatform.v1beta1.ISearchDataItemsRequest} request SearchDataItemsRequest message or plain object + * @param {google.cloud.aiplatform.v1beta1.DatasetService.SearchDataItemsCallback} callback Node-style callback called with the error, if any, and SearchDataItemsResponse + * @returns {undefined} + * @variation 1 + */ + Object.defineProperty(DatasetService.prototype.searchDataItems = function searchDataItems(request, callback) { + return this.rpcCall(searchDataItems, $root.google.cloud.aiplatform.v1beta1.SearchDataItemsRequest, $root.google.cloud.aiplatform.v1beta1.SearchDataItemsResponse, request, callback); + }, "name", { value: "SearchDataItems" }); + + /** + * Calls SearchDataItems. + * @function searchDataItems + * @memberof google.cloud.aiplatform.v1beta1.DatasetService + * @instance + * @param {google.cloud.aiplatform.v1beta1.ISearchDataItemsRequest} request SearchDataItemsRequest message or plain object + * @returns {Promise} Promise + * @variation 2 + */ + /** * Callback as used by {@link google.cloud.aiplatform.v1beta1.DatasetService|listSavedQueries}. * @memberof google.cloud.aiplatform.v1beta1.DatasetService @@ -200113,6 +204864,1291 @@ return ListDataItemsResponse; })(); + v1beta1.SearchDataItemsRequest = (function() { + + /** + * Properties of a SearchDataItemsRequest. + * @memberof google.cloud.aiplatform.v1beta1 + * @interface ISearchDataItemsRequest + * @property {string|null} [orderByDataItem] SearchDataItemsRequest orderByDataItem + * @property {google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.IOrderByAnnotation|null} [orderByAnnotation] SearchDataItemsRequest orderByAnnotation + * @property {string|null} [dataset] SearchDataItemsRequest dataset + * @property {string|null} [savedQuery] SearchDataItemsRequest savedQuery + * @property {string|null} [dataLabelingJob] SearchDataItemsRequest dataLabelingJob + * @property {string|null} [dataItemFilter] SearchDataItemsRequest dataItemFilter + * @property {string|null} [annotationsFilter] SearchDataItemsRequest annotationsFilter + * @property {Array.|null} [annotationFilters] SearchDataItemsRequest annotationFilters + * @property {google.protobuf.IFieldMask|null} [fieldMask] SearchDataItemsRequest fieldMask + * @property {number|null} [annotationsLimit] SearchDataItemsRequest annotationsLimit + * @property {number|null} [pageSize] SearchDataItemsRequest pageSize + * @property {string|null} [orderBy] SearchDataItemsRequest orderBy + * @property {string|null} [pageToken] SearchDataItemsRequest pageToken + */ + + /** + * Constructs a new SearchDataItemsRequest. + * @memberof google.cloud.aiplatform.v1beta1 + * @classdesc Represents a SearchDataItemsRequest. + * @implements ISearchDataItemsRequest + * @constructor + * @param {google.cloud.aiplatform.v1beta1.ISearchDataItemsRequest=} [properties] Properties to set + */ + function SearchDataItemsRequest(properties) { + this.annotationFilters = []; + if (properties) + for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) + if (properties[keys[i]] != null) + this[keys[i]] = properties[keys[i]]; + } + + /** + * SearchDataItemsRequest orderByDataItem. + * @member {string|null|undefined} orderByDataItem + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsRequest + * @instance + */ + SearchDataItemsRequest.prototype.orderByDataItem = null; + + /** + * SearchDataItemsRequest orderByAnnotation. + * @member {google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.IOrderByAnnotation|null|undefined} orderByAnnotation + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsRequest + * @instance + */ + SearchDataItemsRequest.prototype.orderByAnnotation = null; + + /** + * SearchDataItemsRequest dataset. + * @member {string} dataset + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsRequest + * @instance + */ + SearchDataItemsRequest.prototype.dataset = ""; + + /** + * SearchDataItemsRequest savedQuery. + * @member {string} savedQuery + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsRequest + * @instance + */ + SearchDataItemsRequest.prototype.savedQuery = ""; + + /** + * SearchDataItemsRequest dataLabelingJob. + * @member {string} dataLabelingJob + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsRequest + * @instance + */ + SearchDataItemsRequest.prototype.dataLabelingJob = ""; + + /** + * SearchDataItemsRequest dataItemFilter. + * @member {string} dataItemFilter + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsRequest + * @instance + */ + SearchDataItemsRequest.prototype.dataItemFilter = ""; + + /** + * SearchDataItemsRequest annotationsFilter. + * @member {string} annotationsFilter + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsRequest + * @instance + */ + SearchDataItemsRequest.prototype.annotationsFilter = ""; + + /** + * SearchDataItemsRequest annotationFilters. + * @member {Array.} annotationFilters + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsRequest + * @instance + */ + SearchDataItemsRequest.prototype.annotationFilters = $util.emptyArray; + + /** + * SearchDataItemsRequest fieldMask. + * @member {google.protobuf.IFieldMask|null|undefined} fieldMask + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsRequest + * @instance + */ + SearchDataItemsRequest.prototype.fieldMask = null; + + /** + * SearchDataItemsRequest annotationsLimit. + * @member {number} annotationsLimit + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsRequest + * @instance + */ + SearchDataItemsRequest.prototype.annotationsLimit = 0; + + /** + * SearchDataItemsRequest pageSize. + * @member {number} pageSize + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsRequest + * @instance + */ + SearchDataItemsRequest.prototype.pageSize = 0; + + /** + * SearchDataItemsRequest orderBy. + * @member {string} orderBy + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsRequest + * @instance + */ + SearchDataItemsRequest.prototype.orderBy = ""; + + /** + * SearchDataItemsRequest pageToken. + * @member {string} pageToken + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsRequest + * @instance + */ + SearchDataItemsRequest.prototype.pageToken = ""; + + // OneOf field names bound to virtual getters and setters + var $oneOfFields; + + /** + * SearchDataItemsRequest order. + * @member {"orderByDataItem"|"orderByAnnotation"|undefined} order + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsRequest + * @instance + */ + Object.defineProperty(SearchDataItemsRequest.prototype, "order", { + get: $util.oneOfGetter($oneOfFields = ["orderByDataItem", "orderByAnnotation"]), + set: $util.oneOfSetter($oneOfFields) + }); + + /** + * Creates a new SearchDataItemsRequest instance using the specified properties. + * @function create + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsRequest + * @static + * @param {google.cloud.aiplatform.v1beta1.ISearchDataItemsRequest=} [properties] Properties to set + * @returns {google.cloud.aiplatform.v1beta1.SearchDataItemsRequest} SearchDataItemsRequest instance + */ + SearchDataItemsRequest.create = function create(properties) { + return new SearchDataItemsRequest(properties); + }; + + /** + * Encodes the specified SearchDataItemsRequest message. Does not implicitly {@link google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.verify|verify} messages. + * @function encode + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsRequest + * @static + * @param {google.cloud.aiplatform.v1beta1.ISearchDataItemsRequest} message SearchDataItemsRequest message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + SearchDataItemsRequest.encode = function encode(message, writer) { + if (!writer) + writer = $Writer.create(); + if (message.dataset != null && Object.hasOwnProperty.call(message, "dataset")) + writer.uint32(/* id 1, wireType 2 =*/10).string(message.dataset); + if (message.savedQuery != null && Object.hasOwnProperty.call(message, "savedQuery")) + writer.uint32(/* id 2, wireType 2 =*/18).string(message.savedQuery); + if (message.dataLabelingJob != null && Object.hasOwnProperty.call(message, "dataLabelingJob")) + writer.uint32(/* id 3, wireType 2 =*/26).string(message.dataLabelingJob); + if (message.dataItemFilter != null && Object.hasOwnProperty.call(message, "dataItemFilter")) + writer.uint32(/* id 4, wireType 2 =*/34).string(message.dataItemFilter); + if (message.annotationsFilter != null && Object.hasOwnProperty.call(message, "annotationsFilter")) + writer.uint32(/* id 5, wireType 2 =*/42).string(message.annotationsFilter); + if (message.fieldMask != null && Object.hasOwnProperty.call(message, "fieldMask")) + $root.google.protobuf.FieldMask.encode(message.fieldMask, writer.uint32(/* id 6, wireType 2 =*/50).fork()).ldelim(); + if (message.annotationsLimit != null && Object.hasOwnProperty.call(message, "annotationsLimit")) + writer.uint32(/* id 7, wireType 0 =*/56).int32(message.annotationsLimit); + if (message.pageSize != null && Object.hasOwnProperty.call(message, "pageSize")) + writer.uint32(/* id 8, wireType 0 =*/64).int32(message.pageSize); + if (message.orderBy != null && Object.hasOwnProperty.call(message, "orderBy")) + writer.uint32(/* id 9, wireType 2 =*/74).string(message.orderBy); + if (message.pageToken != null && Object.hasOwnProperty.call(message, "pageToken")) + writer.uint32(/* id 10, wireType 2 =*/82).string(message.pageToken); + if (message.annotationFilters != null && message.annotationFilters.length) + for (var i = 0; i < message.annotationFilters.length; ++i) + writer.uint32(/* id 11, wireType 2 =*/90).string(message.annotationFilters[i]); + if (message.orderByDataItem != null && Object.hasOwnProperty.call(message, "orderByDataItem")) + writer.uint32(/* id 12, wireType 2 =*/98).string(message.orderByDataItem); + if (message.orderByAnnotation != null && Object.hasOwnProperty.call(message, "orderByAnnotation")) + $root.google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation.encode(message.orderByAnnotation, writer.uint32(/* id 13, wireType 2 =*/106).fork()).ldelim(); + return writer; + }; + + /** + * Encodes the specified SearchDataItemsRequest message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.verify|verify} messages. + * @function encodeDelimited + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsRequest + * @static + * @param {google.cloud.aiplatform.v1beta1.ISearchDataItemsRequest} message SearchDataItemsRequest message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + SearchDataItemsRequest.encodeDelimited = function encodeDelimited(message, writer) { + return this.encode(message, writer).ldelim(); + }; + + /** + * Decodes a SearchDataItemsRequest message from the specified reader or buffer. + * @function decode + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsRequest + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @param {number} [length] Message length if known beforehand + * @returns {google.cloud.aiplatform.v1beta1.SearchDataItemsRequest} SearchDataItemsRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + SearchDataItemsRequest.decode = function decode(reader, length) { + if (!(reader instanceof $Reader)) + reader = $Reader.create(reader); + var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.aiplatform.v1beta1.SearchDataItemsRequest(); + while (reader.pos < end) { + var tag = reader.uint32(); + switch (tag >>> 3) { + case 12: { + message.orderByDataItem = reader.string(); + break; + } + case 13: { + message.orderByAnnotation = $root.google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation.decode(reader, reader.uint32()); + break; + } + case 1: { + message.dataset = reader.string(); + break; + } + case 2: { + message.savedQuery = reader.string(); + break; + } + case 3: { + message.dataLabelingJob = reader.string(); + break; + } + case 4: { + message.dataItemFilter = reader.string(); + break; + } + case 5: { + message.annotationsFilter = reader.string(); + break; + } + case 11: { + if (!(message.annotationFilters && message.annotationFilters.length)) + message.annotationFilters = []; + message.annotationFilters.push(reader.string()); + break; + } + case 6: { + message.fieldMask = $root.google.protobuf.FieldMask.decode(reader, reader.uint32()); + break; + } + case 7: { + message.annotationsLimit = reader.int32(); + break; + } + case 8: { + message.pageSize = reader.int32(); + break; + } + case 9: { + message.orderBy = reader.string(); + break; + } + case 10: { + message.pageToken = reader.string(); + break; + } + default: + reader.skipType(tag & 7); + break; + } + } + return message; + }; + + /** + * Decodes a SearchDataItemsRequest message from the specified reader or buffer, length delimited. + * @function decodeDelimited + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsRequest + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @returns {google.cloud.aiplatform.v1beta1.SearchDataItemsRequest} SearchDataItemsRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + SearchDataItemsRequest.decodeDelimited = function decodeDelimited(reader) { + if (!(reader instanceof $Reader)) + reader = new $Reader(reader); + return this.decode(reader, reader.uint32()); + }; + + /** + * Verifies a SearchDataItemsRequest message. + * @function verify + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsRequest + * @static + * @param {Object.} message Plain object to verify + * @returns {string|null} `null` if valid, otherwise the reason why it is not + */ + SearchDataItemsRequest.verify = function verify(message) { + if (typeof message !== "object" || message === null) + return "object expected"; + var properties = {}; + if (message.orderByDataItem != null && message.hasOwnProperty("orderByDataItem")) { + properties.order = 1; + if (!$util.isString(message.orderByDataItem)) + return "orderByDataItem: string expected"; + } + if (message.orderByAnnotation != null && message.hasOwnProperty("orderByAnnotation")) { + if (properties.order === 1) + return "order: multiple values"; + properties.order = 1; + { + var error = $root.google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation.verify(message.orderByAnnotation); + if (error) + return "orderByAnnotation." + error; + } + } + if (message.dataset != null && message.hasOwnProperty("dataset")) + if (!$util.isString(message.dataset)) + return "dataset: string expected"; + if (message.savedQuery != null && message.hasOwnProperty("savedQuery")) + if (!$util.isString(message.savedQuery)) + return "savedQuery: string expected"; + if (message.dataLabelingJob != null && message.hasOwnProperty("dataLabelingJob")) + if (!$util.isString(message.dataLabelingJob)) + return "dataLabelingJob: string expected"; + if (message.dataItemFilter != null && message.hasOwnProperty("dataItemFilter")) + if (!$util.isString(message.dataItemFilter)) + return "dataItemFilter: string expected"; + if (message.annotationsFilter != null && message.hasOwnProperty("annotationsFilter")) + if (!$util.isString(message.annotationsFilter)) + return "annotationsFilter: string expected"; + if (message.annotationFilters != null && message.hasOwnProperty("annotationFilters")) { + if (!Array.isArray(message.annotationFilters)) + return "annotationFilters: array expected"; + for (var i = 0; i < message.annotationFilters.length; ++i) + if (!$util.isString(message.annotationFilters[i])) + return "annotationFilters: string[] expected"; + } + if (message.fieldMask != null && message.hasOwnProperty("fieldMask")) { + var error = $root.google.protobuf.FieldMask.verify(message.fieldMask); + if (error) + return "fieldMask." + error; + } + if (message.annotationsLimit != null && message.hasOwnProperty("annotationsLimit")) + if (!$util.isInteger(message.annotationsLimit)) + return "annotationsLimit: integer expected"; + if (message.pageSize != null && message.hasOwnProperty("pageSize")) + if (!$util.isInteger(message.pageSize)) + return "pageSize: integer expected"; + if (message.orderBy != null && message.hasOwnProperty("orderBy")) + if (!$util.isString(message.orderBy)) + return "orderBy: string expected"; + if (message.pageToken != null && message.hasOwnProperty("pageToken")) + if (!$util.isString(message.pageToken)) + return "pageToken: string expected"; + return null; + }; + + /** + * Creates a SearchDataItemsRequest message from a plain object. Also converts values to their respective internal types. + * @function fromObject + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsRequest + * @static + * @param {Object.} object Plain object + * @returns {google.cloud.aiplatform.v1beta1.SearchDataItemsRequest} SearchDataItemsRequest + */ + SearchDataItemsRequest.fromObject = function fromObject(object) { + if (object instanceof $root.google.cloud.aiplatform.v1beta1.SearchDataItemsRequest) + return object; + var message = new $root.google.cloud.aiplatform.v1beta1.SearchDataItemsRequest(); + if (object.orderByDataItem != null) + message.orderByDataItem = String(object.orderByDataItem); + if (object.orderByAnnotation != null) { + if (typeof object.orderByAnnotation !== "object") + throw TypeError(".google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.orderByAnnotation: object expected"); + message.orderByAnnotation = $root.google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation.fromObject(object.orderByAnnotation); + } + if (object.dataset != null) + message.dataset = String(object.dataset); + if (object.savedQuery != null) + message.savedQuery = String(object.savedQuery); + if (object.dataLabelingJob != null) + message.dataLabelingJob = String(object.dataLabelingJob); + if (object.dataItemFilter != null) + message.dataItemFilter = String(object.dataItemFilter); + if (object.annotationsFilter != null) + message.annotationsFilter = String(object.annotationsFilter); + if (object.annotationFilters) { + if (!Array.isArray(object.annotationFilters)) + throw TypeError(".google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.annotationFilters: array expected"); + message.annotationFilters = []; + for (var i = 0; i < object.annotationFilters.length; ++i) + message.annotationFilters[i] = String(object.annotationFilters[i]); + } + if (object.fieldMask != null) { + if (typeof object.fieldMask !== "object") + throw TypeError(".google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.fieldMask: object expected"); + message.fieldMask = $root.google.protobuf.FieldMask.fromObject(object.fieldMask); + } + if (object.annotationsLimit != null) + message.annotationsLimit = object.annotationsLimit | 0; + if (object.pageSize != null) + message.pageSize = object.pageSize | 0; + if (object.orderBy != null) + message.orderBy = String(object.orderBy); + if (object.pageToken != null) + message.pageToken = String(object.pageToken); + return message; + }; + + /** + * Creates a plain object from a SearchDataItemsRequest message. Also converts values to other types if specified. + * @function toObject + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsRequest + * @static + * @param {google.cloud.aiplatform.v1beta1.SearchDataItemsRequest} message SearchDataItemsRequest + * @param {$protobuf.IConversionOptions} [options] Conversion options + * @returns {Object.} Plain object + */ + SearchDataItemsRequest.toObject = function toObject(message, options) { + if (!options) + options = {}; + var object = {}; + if (options.arrays || options.defaults) + object.annotationFilters = []; + if (options.defaults) { + object.dataset = ""; + object.savedQuery = ""; + object.dataLabelingJob = ""; + object.dataItemFilter = ""; + object.annotationsFilter = ""; + object.fieldMask = null; + object.annotationsLimit = 0; + object.pageSize = 0; + object.orderBy = ""; + object.pageToken = ""; + } + if (message.dataset != null && message.hasOwnProperty("dataset")) + object.dataset = message.dataset; + if (message.savedQuery != null && message.hasOwnProperty("savedQuery")) + object.savedQuery = message.savedQuery; + if (message.dataLabelingJob != null && message.hasOwnProperty("dataLabelingJob")) + object.dataLabelingJob = message.dataLabelingJob; + if (message.dataItemFilter != null && message.hasOwnProperty("dataItemFilter")) + object.dataItemFilter = message.dataItemFilter; + if (message.annotationsFilter != null && message.hasOwnProperty("annotationsFilter")) + object.annotationsFilter = message.annotationsFilter; + if (message.fieldMask != null && message.hasOwnProperty("fieldMask")) + object.fieldMask = $root.google.protobuf.FieldMask.toObject(message.fieldMask, options); + if (message.annotationsLimit != null && message.hasOwnProperty("annotationsLimit")) + object.annotationsLimit = message.annotationsLimit; + if (message.pageSize != null && message.hasOwnProperty("pageSize")) + object.pageSize = message.pageSize; + if (message.orderBy != null && message.hasOwnProperty("orderBy")) + object.orderBy = message.orderBy; + if (message.pageToken != null && message.hasOwnProperty("pageToken")) + object.pageToken = message.pageToken; + if (message.annotationFilters && message.annotationFilters.length) { + object.annotationFilters = []; + for (var j = 0; j < message.annotationFilters.length; ++j) + object.annotationFilters[j] = message.annotationFilters[j]; + } + if (message.orderByDataItem != null && message.hasOwnProperty("orderByDataItem")) { + object.orderByDataItem = message.orderByDataItem; + if (options.oneofs) + object.order = "orderByDataItem"; + } + if (message.orderByAnnotation != null && message.hasOwnProperty("orderByAnnotation")) { + object.orderByAnnotation = $root.google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation.toObject(message.orderByAnnotation, options); + if (options.oneofs) + object.order = "orderByAnnotation"; + } + return object; + }; + + /** + * Converts this SearchDataItemsRequest to JSON. + * @function toJSON + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsRequest + * @instance + * @returns {Object.} JSON object + */ + SearchDataItemsRequest.prototype.toJSON = function toJSON() { + return this.constructor.toObject(this, $protobuf.util.toJSONOptions); + }; + + /** + * Gets the default type url for SearchDataItemsRequest + * @function getTypeUrl + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsRequest + * @static + * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns {string} The default type url + */ + SearchDataItemsRequest.getTypeUrl = function getTypeUrl(typeUrlPrefix) { + if (typeUrlPrefix === undefined) { + typeUrlPrefix = "type.googleapis.com"; + } + return typeUrlPrefix + "/google.cloud.aiplatform.v1beta1.SearchDataItemsRequest"; + }; + + SearchDataItemsRequest.OrderByAnnotation = (function() { + + /** + * Properties of an OrderByAnnotation. + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsRequest + * @interface IOrderByAnnotation + * @property {string|null} [savedQuery] OrderByAnnotation savedQuery + * @property {string|null} [orderBy] OrderByAnnotation orderBy + */ + + /** + * Constructs a new OrderByAnnotation. + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsRequest + * @classdesc Represents an OrderByAnnotation. + * @implements IOrderByAnnotation + * @constructor + * @param {google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.IOrderByAnnotation=} [properties] Properties to set + */ + function OrderByAnnotation(properties) { + if (properties) + for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) + if (properties[keys[i]] != null) + this[keys[i]] = properties[keys[i]]; + } + + /** + * OrderByAnnotation savedQuery. + * @member {string} savedQuery + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation + * @instance + */ + OrderByAnnotation.prototype.savedQuery = ""; + + /** + * OrderByAnnotation orderBy. + * @member {string} orderBy + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation + * @instance + */ + OrderByAnnotation.prototype.orderBy = ""; + + /** + * Creates a new OrderByAnnotation instance using the specified properties. + * @function create + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation + * @static + * @param {google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.IOrderByAnnotation=} [properties] Properties to set + * @returns {google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation} OrderByAnnotation instance + */ + OrderByAnnotation.create = function create(properties) { + return new OrderByAnnotation(properties); + }; + + /** + * Encodes the specified OrderByAnnotation message. Does not implicitly {@link google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation.verify|verify} messages. + * @function encode + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation + * @static + * @param {google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.IOrderByAnnotation} message OrderByAnnotation message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + OrderByAnnotation.encode = function encode(message, writer) { + if (!writer) + writer = $Writer.create(); + if (message.savedQuery != null && Object.hasOwnProperty.call(message, "savedQuery")) + writer.uint32(/* id 1, wireType 2 =*/10).string(message.savedQuery); + if (message.orderBy != null && Object.hasOwnProperty.call(message, "orderBy")) + writer.uint32(/* id 2, wireType 2 =*/18).string(message.orderBy); + return writer; + }; + + /** + * Encodes the specified OrderByAnnotation message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation.verify|verify} messages. + * @function encodeDelimited + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation + * @static + * @param {google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.IOrderByAnnotation} message OrderByAnnotation message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + OrderByAnnotation.encodeDelimited = function encodeDelimited(message, writer) { + return this.encode(message, writer).ldelim(); + }; + + /** + * Decodes an OrderByAnnotation message from the specified reader or buffer. + * @function decode + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @param {number} [length] Message length if known beforehand + * @returns {google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation} OrderByAnnotation + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + OrderByAnnotation.decode = function decode(reader, length) { + if (!(reader instanceof $Reader)) + reader = $Reader.create(reader); + var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation(); + while (reader.pos < end) { + var tag = reader.uint32(); + switch (tag >>> 3) { + case 1: { + message.savedQuery = reader.string(); + break; + } + case 2: { + message.orderBy = reader.string(); + break; + } + default: + reader.skipType(tag & 7); + break; + } + } + return message; + }; + + /** + * Decodes an OrderByAnnotation message from the specified reader or buffer, length delimited. + * @function decodeDelimited + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @returns {google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation} OrderByAnnotation + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + OrderByAnnotation.decodeDelimited = function decodeDelimited(reader) { + if (!(reader instanceof $Reader)) + reader = new $Reader(reader); + return this.decode(reader, reader.uint32()); + }; + + /** + * Verifies an OrderByAnnotation message. + * @function verify + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation + * @static + * @param {Object.} message Plain object to verify + * @returns {string|null} `null` if valid, otherwise the reason why it is not + */ + OrderByAnnotation.verify = function verify(message) { + if (typeof message !== "object" || message === null) + return "object expected"; + if (message.savedQuery != null && message.hasOwnProperty("savedQuery")) + if (!$util.isString(message.savedQuery)) + return "savedQuery: string expected"; + if (message.orderBy != null && message.hasOwnProperty("orderBy")) + if (!$util.isString(message.orderBy)) + return "orderBy: string expected"; + return null; + }; + + /** + * Creates an OrderByAnnotation message from a plain object. Also converts values to their respective internal types. + * @function fromObject + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation + * @static + * @param {Object.} object Plain object + * @returns {google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation} OrderByAnnotation + */ + OrderByAnnotation.fromObject = function fromObject(object) { + if (object instanceof $root.google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation) + return object; + var message = new $root.google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation(); + if (object.savedQuery != null) + message.savedQuery = String(object.savedQuery); + if (object.orderBy != null) + message.orderBy = String(object.orderBy); + return message; + }; + + /** + * Creates a plain object from an OrderByAnnotation message. Also converts values to other types if specified. + * @function toObject + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation + * @static + * @param {google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation} message OrderByAnnotation + * @param {$protobuf.IConversionOptions} [options] Conversion options + * @returns {Object.} Plain object + */ + OrderByAnnotation.toObject = function toObject(message, options) { + if (!options) + options = {}; + var object = {}; + if (options.defaults) { + object.savedQuery = ""; + object.orderBy = ""; + } + if (message.savedQuery != null && message.hasOwnProperty("savedQuery")) + object.savedQuery = message.savedQuery; + if (message.orderBy != null && message.hasOwnProperty("orderBy")) + object.orderBy = message.orderBy; + return object; + }; + + /** + * Converts this OrderByAnnotation to JSON. + * @function toJSON + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation + * @instance + * @returns {Object.} JSON object + */ + OrderByAnnotation.prototype.toJSON = function toJSON() { + return this.constructor.toObject(this, $protobuf.util.toJSONOptions); + }; + + /** + * Gets the default type url for OrderByAnnotation + * @function getTypeUrl + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation + * @static + * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns {string} The default type url + */ + OrderByAnnotation.getTypeUrl = function getTypeUrl(typeUrlPrefix) { + if (typeUrlPrefix === undefined) { + typeUrlPrefix = "type.googleapis.com"; + } + return typeUrlPrefix + "/google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation"; + }; + + return OrderByAnnotation; + })(); + + return SearchDataItemsRequest; + })(); + + v1beta1.SearchDataItemsResponse = (function() { + + /** + * Properties of a SearchDataItemsResponse. + * @memberof google.cloud.aiplatform.v1beta1 + * @interface ISearchDataItemsResponse + * @property {Array.|null} [dataItemViews] SearchDataItemsResponse dataItemViews + * @property {string|null} [nextPageToken] SearchDataItemsResponse nextPageToken + */ + + /** + * Constructs a new SearchDataItemsResponse. + * @memberof google.cloud.aiplatform.v1beta1 + * @classdesc Represents a SearchDataItemsResponse. + * @implements ISearchDataItemsResponse + * @constructor + * @param {google.cloud.aiplatform.v1beta1.ISearchDataItemsResponse=} [properties] Properties to set + */ + function SearchDataItemsResponse(properties) { + this.dataItemViews = []; + if (properties) + for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) + if (properties[keys[i]] != null) + this[keys[i]] = properties[keys[i]]; + } + + /** + * SearchDataItemsResponse dataItemViews. + * @member {Array.} dataItemViews + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsResponse + * @instance + */ + SearchDataItemsResponse.prototype.dataItemViews = $util.emptyArray; + + /** + * SearchDataItemsResponse nextPageToken. + * @member {string} nextPageToken + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsResponse + * @instance + */ + SearchDataItemsResponse.prototype.nextPageToken = ""; + + /** + * Creates a new SearchDataItemsResponse instance using the specified properties. + * @function create + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsResponse + * @static + * @param {google.cloud.aiplatform.v1beta1.ISearchDataItemsResponse=} [properties] Properties to set + * @returns {google.cloud.aiplatform.v1beta1.SearchDataItemsResponse} SearchDataItemsResponse instance + */ + SearchDataItemsResponse.create = function create(properties) { + return new SearchDataItemsResponse(properties); + }; + + /** + * Encodes the specified SearchDataItemsResponse message. Does not implicitly {@link google.cloud.aiplatform.v1beta1.SearchDataItemsResponse.verify|verify} messages. + * @function encode + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsResponse + * @static + * @param {google.cloud.aiplatform.v1beta1.ISearchDataItemsResponse} message SearchDataItemsResponse message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + SearchDataItemsResponse.encode = function encode(message, writer) { + if (!writer) + writer = $Writer.create(); + if (message.dataItemViews != null && message.dataItemViews.length) + for (var i = 0; i < message.dataItemViews.length; ++i) + $root.google.cloud.aiplatform.v1beta1.DataItemView.encode(message.dataItemViews[i], writer.uint32(/* id 1, wireType 2 =*/10).fork()).ldelim(); + if (message.nextPageToken != null && Object.hasOwnProperty.call(message, "nextPageToken")) + writer.uint32(/* id 2, wireType 2 =*/18).string(message.nextPageToken); + return writer; + }; + + /** + * Encodes the specified SearchDataItemsResponse message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1beta1.SearchDataItemsResponse.verify|verify} messages. + * @function encodeDelimited + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsResponse + * @static + * @param {google.cloud.aiplatform.v1beta1.ISearchDataItemsResponse} message SearchDataItemsResponse message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + SearchDataItemsResponse.encodeDelimited = function encodeDelimited(message, writer) { + return this.encode(message, writer).ldelim(); + }; + + /** + * Decodes a SearchDataItemsResponse message from the specified reader or buffer. + * @function decode + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsResponse + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @param {number} [length] Message length if known beforehand + * @returns {google.cloud.aiplatform.v1beta1.SearchDataItemsResponse} SearchDataItemsResponse + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + SearchDataItemsResponse.decode = function decode(reader, length) { + if (!(reader instanceof $Reader)) + reader = $Reader.create(reader); + var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.aiplatform.v1beta1.SearchDataItemsResponse(); + while (reader.pos < end) { + var tag = reader.uint32(); + switch (tag >>> 3) { + case 1: { + if (!(message.dataItemViews && message.dataItemViews.length)) + message.dataItemViews = []; + message.dataItemViews.push($root.google.cloud.aiplatform.v1beta1.DataItemView.decode(reader, reader.uint32())); + break; + } + case 2: { + message.nextPageToken = reader.string(); + break; + } + default: + reader.skipType(tag & 7); + break; + } + } + return message; + }; + + /** + * Decodes a SearchDataItemsResponse message from the specified reader or buffer, length delimited. + * @function decodeDelimited + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsResponse + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @returns {google.cloud.aiplatform.v1beta1.SearchDataItemsResponse} SearchDataItemsResponse + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + SearchDataItemsResponse.decodeDelimited = function decodeDelimited(reader) { + if (!(reader instanceof $Reader)) + reader = new $Reader(reader); + return this.decode(reader, reader.uint32()); + }; + + /** + * Verifies a SearchDataItemsResponse message. + * @function verify + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsResponse + * @static + * @param {Object.} message Plain object to verify + * @returns {string|null} `null` if valid, otherwise the reason why it is not + */ + SearchDataItemsResponse.verify = function verify(message) { + if (typeof message !== "object" || message === null) + return "object expected"; + if (message.dataItemViews != null && message.hasOwnProperty("dataItemViews")) { + if (!Array.isArray(message.dataItemViews)) + return "dataItemViews: array expected"; + for (var i = 0; i < message.dataItemViews.length; ++i) { + var error = $root.google.cloud.aiplatform.v1beta1.DataItemView.verify(message.dataItemViews[i]); + if (error) + return "dataItemViews." + error; + } + } + if (message.nextPageToken != null && message.hasOwnProperty("nextPageToken")) + if (!$util.isString(message.nextPageToken)) + return "nextPageToken: string expected"; + return null; + }; + + /** + * Creates a SearchDataItemsResponse message from a plain object. Also converts values to their respective internal types. + * @function fromObject + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsResponse + * @static + * @param {Object.} object Plain object + * @returns {google.cloud.aiplatform.v1beta1.SearchDataItemsResponse} SearchDataItemsResponse + */ + SearchDataItemsResponse.fromObject = function fromObject(object) { + if (object instanceof $root.google.cloud.aiplatform.v1beta1.SearchDataItemsResponse) + return object; + var message = new $root.google.cloud.aiplatform.v1beta1.SearchDataItemsResponse(); + if (object.dataItemViews) { + if (!Array.isArray(object.dataItemViews)) + throw TypeError(".google.cloud.aiplatform.v1beta1.SearchDataItemsResponse.dataItemViews: array expected"); + message.dataItemViews = []; + for (var i = 0; i < object.dataItemViews.length; ++i) { + if (typeof object.dataItemViews[i] !== "object") + throw TypeError(".google.cloud.aiplatform.v1beta1.SearchDataItemsResponse.dataItemViews: object expected"); + message.dataItemViews[i] = $root.google.cloud.aiplatform.v1beta1.DataItemView.fromObject(object.dataItemViews[i]); + } + } + if (object.nextPageToken != null) + message.nextPageToken = String(object.nextPageToken); + return message; + }; + + /** + * Creates a plain object from a SearchDataItemsResponse message. Also converts values to other types if specified. + * @function toObject + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsResponse + * @static + * @param {google.cloud.aiplatform.v1beta1.SearchDataItemsResponse} message SearchDataItemsResponse + * @param {$protobuf.IConversionOptions} [options] Conversion options + * @returns {Object.} Plain object + */ + SearchDataItemsResponse.toObject = function toObject(message, options) { + if (!options) + options = {}; + var object = {}; + if (options.arrays || options.defaults) + object.dataItemViews = []; + if (options.defaults) + object.nextPageToken = ""; + if (message.dataItemViews && message.dataItemViews.length) { + object.dataItemViews = []; + for (var j = 0; j < message.dataItemViews.length; ++j) + object.dataItemViews[j] = $root.google.cloud.aiplatform.v1beta1.DataItemView.toObject(message.dataItemViews[j], options); + } + if (message.nextPageToken != null && message.hasOwnProperty("nextPageToken")) + object.nextPageToken = message.nextPageToken; + return object; + }; + + /** + * Converts this SearchDataItemsResponse to JSON. + * @function toJSON + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsResponse + * @instance + * @returns {Object.} JSON object + */ + SearchDataItemsResponse.prototype.toJSON = function toJSON() { + return this.constructor.toObject(this, $protobuf.util.toJSONOptions); + }; + + /** + * Gets the default type url for SearchDataItemsResponse + * @function getTypeUrl + * @memberof google.cloud.aiplatform.v1beta1.SearchDataItemsResponse + * @static + * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns {string} The default type url + */ + SearchDataItemsResponse.getTypeUrl = function getTypeUrl(typeUrlPrefix) { + if (typeUrlPrefix === undefined) { + typeUrlPrefix = "type.googleapis.com"; + } + return typeUrlPrefix + "/google.cloud.aiplatform.v1beta1.SearchDataItemsResponse"; + }; + + return SearchDataItemsResponse; + })(); + + v1beta1.DataItemView = (function() { + + /** + * Properties of a DataItemView. + * @memberof google.cloud.aiplatform.v1beta1 + * @interface IDataItemView + * @property {google.cloud.aiplatform.v1beta1.IDataItem|null} [dataItem] DataItemView dataItem + * @property {Array.|null} [annotations] DataItemView annotations + * @property {boolean|null} [hasTruncatedAnnotations] DataItemView hasTruncatedAnnotations + */ + + /** + * Constructs a new DataItemView. + * @memberof google.cloud.aiplatform.v1beta1 + * @classdesc Represents a DataItemView. + * @implements IDataItemView + * @constructor + * @param {google.cloud.aiplatform.v1beta1.IDataItemView=} [properties] Properties to set + */ + function DataItemView(properties) { + this.annotations = []; + if (properties) + for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) + if (properties[keys[i]] != null) + this[keys[i]] = properties[keys[i]]; + } + + /** + * DataItemView dataItem. + * @member {google.cloud.aiplatform.v1beta1.IDataItem|null|undefined} dataItem + * @memberof google.cloud.aiplatform.v1beta1.DataItemView + * @instance + */ + DataItemView.prototype.dataItem = null; + + /** + * DataItemView annotations. + * @member {Array.} annotations + * @memberof google.cloud.aiplatform.v1beta1.DataItemView + * @instance + */ + DataItemView.prototype.annotations = $util.emptyArray; + + /** + * DataItemView hasTruncatedAnnotations. + * @member {boolean} hasTruncatedAnnotations + * @memberof google.cloud.aiplatform.v1beta1.DataItemView + * @instance + */ + DataItemView.prototype.hasTruncatedAnnotations = false; + + /** + * Creates a new DataItemView instance using the specified properties. + * @function create + * @memberof google.cloud.aiplatform.v1beta1.DataItemView + * @static + * @param {google.cloud.aiplatform.v1beta1.IDataItemView=} [properties] Properties to set + * @returns {google.cloud.aiplatform.v1beta1.DataItemView} DataItemView instance + */ + DataItemView.create = function create(properties) { + return new DataItemView(properties); + }; + + /** + * Encodes the specified DataItemView message. Does not implicitly {@link google.cloud.aiplatform.v1beta1.DataItemView.verify|verify} messages. + * @function encode + * @memberof google.cloud.aiplatform.v1beta1.DataItemView + * @static + * @param {google.cloud.aiplatform.v1beta1.IDataItemView} message DataItemView message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + DataItemView.encode = function encode(message, writer) { + if (!writer) + writer = $Writer.create(); + if (message.dataItem != null && Object.hasOwnProperty.call(message, "dataItem")) + $root.google.cloud.aiplatform.v1beta1.DataItem.encode(message.dataItem, writer.uint32(/* id 1, wireType 2 =*/10).fork()).ldelim(); + if (message.annotations != null && message.annotations.length) + for (var i = 0; i < message.annotations.length; ++i) + $root.google.cloud.aiplatform.v1beta1.Annotation.encode(message.annotations[i], writer.uint32(/* id 2, wireType 2 =*/18).fork()).ldelim(); + if (message.hasTruncatedAnnotations != null && Object.hasOwnProperty.call(message, "hasTruncatedAnnotations")) + writer.uint32(/* id 3, wireType 0 =*/24).bool(message.hasTruncatedAnnotations); + return writer; + }; + + /** + * Encodes the specified DataItemView message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1beta1.DataItemView.verify|verify} messages. + * @function encodeDelimited + * @memberof google.cloud.aiplatform.v1beta1.DataItemView + * @static + * @param {google.cloud.aiplatform.v1beta1.IDataItemView} message DataItemView message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + DataItemView.encodeDelimited = function encodeDelimited(message, writer) { + return this.encode(message, writer).ldelim(); + }; + + /** + * Decodes a DataItemView message from the specified reader or buffer. + * @function decode + * @memberof google.cloud.aiplatform.v1beta1.DataItemView + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @param {number} [length] Message length if known beforehand + * @returns {google.cloud.aiplatform.v1beta1.DataItemView} DataItemView + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + DataItemView.decode = function decode(reader, length) { + if (!(reader instanceof $Reader)) + reader = $Reader.create(reader); + var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.aiplatform.v1beta1.DataItemView(); + while (reader.pos < end) { + var tag = reader.uint32(); + switch (tag >>> 3) { + case 1: { + message.dataItem = $root.google.cloud.aiplatform.v1beta1.DataItem.decode(reader, reader.uint32()); + break; + } + case 2: { + if (!(message.annotations && message.annotations.length)) + message.annotations = []; + message.annotations.push($root.google.cloud.aiplatform.v1beta1.Annotation.decode(reader, reader.uint32())); + break; + } + case 3: { + message.hasTruncatedAnnotations = reader.bool(); + break; + } + default: + reader.skipType(tag & 7); + break; + } + } + return message; + }; + + /** + * Decodes a DataItemView message from the specified reader or buffer, length delimited. + * @function decodeDelimited + * @memberof google.cloud.aiplatform.v1beta1.DataItemView + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @returns {google.cloud.aiplatform.v1beta1.DataItemView} DataItemView + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + DataItemView.decodeDelimited = function decodeDelimited(reader) { + if (!(reader instanceof $Reader)) + reader = new $Reader(reader); + return this.decode(reader, reader.uint32()); + }; + + /** + * Verifies a DataItemView message. + * @function verify + * @memberof google.cloud.aiplatform.v1beta1.DataItemView + * @static + * @param {Object.} message Plain object to verify + * @returns {string|null} `null` if valid, otherwise the reason why it is not + */ + DataItemView.verify = function verify(message) { + if (typeof message !== "object" || message === null) + return "object expected"; + if (message.dataItem != null && message.hasOwnProperty("dataItem")) { + var error = $root.google.cloud.aiplatform.v1beta1.DataItem.verify(message.dataItem); + if (error) + return "dataItem." + error; + } + if (message.annotations != null && message.hasOwnProperty("annotations")) { + if (!Array.isArray(message.annotations)) + return "annotations: array expected"; + for (var i = 0; i < message.annotations.length; ++i) { + var error = $root.google.cloud.aiplatform.v1beta1.Annotation.verify(message.annotations[i]); + if (error) + return "annotations." + error; + } + } + if (message.hasTruncatedAnnotations != null && message.hasOwnProperty("hasTruncatedAnnotations")) + if (typeof message.hasTruncatedAnnotations !== "boolean") + return "hasTruncatedAnnotations: boolean expected"; + return null; + }; + + /** + * Creates a DataItemView message from a plain object. Also converts values to their respective internal types. + * @function fromObject + * @memberof google.cloud.aiplatform.v1beta1.DataItemView + * @static + * @param {Object.} object Plain object + * @returns {google.cloud.aiplatform.v1beta1.DataItemView} DataItemView + */ + DataItemView.fromObject = function fromObject(object) { + if (object instanceof $root.google.cloud.aiplatform.v1beta1.DataItemView) + return object; + var message = new $root.google.cloud.aiplatform.v1beta1.DataItemView(); + if (object.dataItem != null) { + if (typeof object.dataItem !== "object") + throw TypeError(".google.cloud.aiplatform.v1beta1.DataItemView.dataItem: object expected"); + message.dataItem = $root.google.cloud.aiplatform.v1beta1.DataItem.fromObject(object.dataItem); + } + if (object.annotations) { + if (!Array.isArray(object.annotations)) + throw TypeError(".google.cloud.aiplatform.v1beta1.DataItemView.annotations: array expected"); + message.annotations = []; + for (var i = 0; i < object.annotations.length; ++i) { + if (typeof object.annotations[i] !== "object") + throw TypeError(".google.cloud.aiplatform.v1beta1.DataItemView.annotations: object expected"); + message.annotations[i] = $root.google.cloud.aiplatform.v1beta1.Annotation.fromObject(object.annotations[i]); + } + } + if (object.hasTruncatedAnnotations != null) + message.hasTruncatedAnnotations = Boolean(object.hasTruncatedAnnotations); + return message; + }; + + /** + * Creates a plain object from a DataItemView message. Also converts values to other types if specified. + * @function toObject + * @memberof google.cloud.aiplatform.v1beta1.DataItemView + * @static + * @param {google.cloud.aiplatform.v1beta1.DataItemView} message DataItemView + * @param {$protobuf.IConversionOptions} [options] Conversion options + * @returns {Object.} Plain object + */ + DataItemView.toObject = function toObject(message, options) { + if (!options) + options = {}; + var object = {}; + if (options.arrays || options.defaults) + object.annotations = []; + if (options.defaults) { + object.dataItem = null; + object.hasTruncatedAnnotations = false; + } + if (message.dataItem != null && message.hasOwnProperty("dataItem")) + object.dataItem = $root.google.cloud.aiplatform.v1beta1.DataItem.toObject(message.dataItem, options); + if (message.annotations && message.annotations.length) { + object.annotations = []; + for (var j = 0; j < message.annotations.length; ++j) + object.annotations[j] = $root.google.cloud.aiplatform.v1beta1.Annotation.toObject(message.annotations[j], options); + } + if (message.hasTruncatedAnnotations != null && message.hasOwnProperty("hasTruncatedAnnotations")) + object.hasTruncatedAnnotations = message.hasTruncatedAnnotations; + return object; + }; + + /** + * Converts this DataItemView to JSON. + * @function toJSON + * @memberof google.cloud.aiplatform.v1beta1.DataItemView + * @instance + * @returns {Object.} JSON object + */ + DataItemView.prototype.toJSON = function toJSON() { + return this.constructor.toObject(this, $protobuf.util.toJSONOptions); + }; + + /** + * Gets the default type url for DataItemView + * @function getTypeUrl + * @memberof google.cloud.aiplatform.v1beta1.DataItemView + * @static + * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns {string} The default type url + */ + DataItemView.getTypeUrl = function getTypeUrl(typeUrlPrefix) { + if (typeUrlPrefix === undefined) { + typeUrlPrefix = "type.googleapis.com"; + } + return typeUrlPrefix + "/google.cloud.aiplatform.v1beta1.DataItemView"; + }; + + return DataItemView; + })(); + v1beta1.ListSavedQueriesRequest = (function() { /** @@ -201979,432 +208015,6 @@ return DeleteOperationMetadata; })(); - v1beta1.SavedQuery = (function() { - - /** - * Properties of a SavedQuery. - * @memberof google.cloud.aiplatform.v1beta1 - * @interface ISavedQuery - * @property {string|null} [name] SavedQuery name - * @property {string|null} [displayName] SavedQuery displayName - * @property {google.protobuf.IValue|null} [metadata] SavedQuery metadata - * @property {google.protobuf.ITimestamp|null} [createTime] SavedQuery createTime - * @property {google.protobuf.ITimestamp|null} [updateTime] SavedQuery updateTime - * @property {string|null} [annotationFilter] SavedQuery annotationFilter - * @property {string|null} [problemType] SavedQuery problemType - * @property {number|null} [annotationSpecCount] SavedQuery annotationSpecCount - * @property {string|null} [etag] SavedQuery etag - * @property {boolean|null} [supportAutomlTraining] SavedQuery supportAutomlTraining - */ - - /** - * Constructs a new SavedQuery. - * @memberof google.cloud.aiplatform.v1beta1 - * @classdesc Represents a SavedQuery. - * @implements ISavedQuery - * @constructor - * @param {google.cloud.aiplatform.v1beta1.ISavedQuery=} [properties] Properties to set - */ - function SavedQuery(properties) { - if (properties) - for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) - if (properties[keys[i]] != null) - this[keys[i]] = properties[keys[i]]; - } - - /** - * SavedQuery name. - * @member {string} name - * @memberof google.cloud.aiplatform.v1beta1.SavedQuery - * @instance - */ - SavedQuery.prototype.name = ""; - - /** - * SavedQuery displayName. - * @member {string} displayName - * @memberof google.cloud.aiplatform.v1beta1.SavedQuery - * @instance - */ - SavedQuery.prototype.displayName = ""; - - /** - * SavedQuery metadata. - * @member {google.protobuf.IValue|null|undefined} metadata - * @memberof google.cloud.aiplatform.v1beta1.SavedQuery - * @instance - */ - SavedQuery.prototype.metadata = null; - - /** - * SavedQuery createTime. - * @member {google.protobuf.ITimestamp|null|undefined} createTime - * @memberof google.cloud.aiplatform.v1beta1.SavedQuery - * @instance - */ - SavedQuery.prototype.createTime = null; - - /** - * SavedQuery updateTime. - * @member {google.protobuf.ITimestamp|null|undefined} updateTime - * @memberof google.cloud.aiplatform.v1beta1.SavedQuery - * @instance - */ - SavedQuery.prototype.updateTime = null; - - /** - * SavedQuery annotationFilter. - * @member {string} annotationFilter - * @memberof google.cloud.aiplatform.v1beta1.SavedQuery - * @instance - */ - SavedQuery.prototype.annotationFilter = ""; - - /** - * SavedQuery problemType. - * @member {string} problemType - * @memberof google.cloud.aiplatform.v1beta1.SavedQuery - * @instance - */ - SavedQuery.prototype.problemType = ""; - - /** - * SavedQuery annotationSpecCount. - * @member {number} annotationSpecCount - * @memberof google.cloud.aiplatform.v1beta1.SavedQuery - * @instance - */ - SavedQuery.prototype.annotationSpecCount = 0; - - /** - * SavedQuery etag. - * @member {string} etag - * @memberof google.cloud.aiplatform.v1beta1.SavedQuery - * @instance - */ - SavedQuery.prototype.etag = ""; - - /** - * SavedQuery supportAutomlTraining. - * @member {boolean} supportAutomlTraining - * @memberof google.cloud.aiplatform.v1beta1.SavedQuery - * @instance - */ - SavedQuery.prototype.supportAutomlTraining = false; - - /** - * Creates a new SavedQuery instance using the specified properties. - * @function create - * @memberof google.cloud.aiplatform.v1beta1.SavedQuery - * @static - * @param {google.cloud.aiplatform.v1beta1.ISavedQuery=} [properties] Properties to set - * @returns {google.cloud.aiplatform.v1beta1.SavedQuery} SavedQuery instance - */ - SavedQuery.create = function create(properties) { - return new SavedQuery(properties); - }; - - /** - * Encodes the specified SavedQuery message. Does not implicitly {@link google.cloud.aiplatform.v1beta1.SavedQuery.verify|verify} messages. - * @function encode - * @memberof google.cloud.aiplatform.v1beta1.SavedQuery - * @static - * @param {google.cloud.aiplatform.v1beta1.ISavedQuery} message SavedQuery message or plain object to encode - * @param {$protobuf.Writer} [writer] Writer to encode to - * @returns {$protobuf.Writer} Writer - */ - SavedQuery.encode = function encode(message, writer) { - if (!writer) - writer = $Writer.create(); - if (message.name != null && Object.hasOwnProperty.call(message, "name")) - writer.uint32(/* id 1, wireType 2 =*/10).string(message.name); - if (message.displayName != null && Object.hasOwnProperty.call(message, "displayName")) - writer.uint32(/* id 2, wireType 2 =*/18).string(message.displayName); - if (message.createTime != null && Object.hasOwnProperty.call(message, "createTime")) - $root.google.protobuf.Timestamp.encode(message.createTime, writer.uint32(/* id 3, wireType 2 =*/26).fork()).ldelim(); - if (message.updateTime != null && Object.hasOwnProperty.call(message, "updateTime")) - $root.google.protobuf.Timestamp.encode(message.updateTime, writer.uint32(/* id 4, wireType 2 =*/34).fork()).ldelim(); - if (message.annotationFilter != null && Object.hasOwnProperty.call(message, "annotationFilter")) - writer.uint32(/* id 5, wireType 2 =*/42).string(message.annotationFilter); - if (message.problemType != null && Object.hasOwnProperty.call(message, "problemType")) - writer.uint32(/* id 6, wireType 2 =*/50).string(message.problemType); - if (message.etag != null && Object.hasOwnProperty.call(message, "etag")) - writer.uint32(/* id 8, wireType 2 =*/66).string(message.etag); - if (message.supportAutomlTraining != null && Object.hasOwnProperty.call(message, "supportAutomlTraining")) - writer.uint32(/* id 9, wireType 0 =*/72).bool(message.supportAutomlTraining); - if (message.annotationSpecCount != null && Object.hasOwnProperty.call(message, "annotationSpecCount")) - writer.uint32(/* id 10, wireType 0 =*/80).int32(message.annotationSpecCount); - if (message.metadata != null && Object.hasOwnProperty.call(message, "metadata")) - $root.google.protobuf.Value.encode(message.metadata, writer.uint32(/* id 12, wireType 2 =*/98).fork()).ldelim(); - return writer; - }; - - /** - * Encodes the specified SavedQuery message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1beta1.SavedQuery.verify|verify} messages. - * @function encodeDelimited - * @memberof google.cloud.aiplatform.v1beta1.SavedQuery - * @static - * @param {google.cloud.aiplatform.v1beta1.ISavedQuery} message SavedQuery message or plain object to encode - * @param {$protobuf.Writer} [writer] Writer to encode to - * @returns {$protobuf.Writer} Writer - */ - SavedQuery.encodeDelimited = function encodeDelimited(message, writer) { - return this.encode(message, writer).ldelim(); - }; - - /** - * Decodes a SavedQuery message from the specified reader or buffer. - * @function decode - * @memberof google.cloud.aiplatform.v1beta1.SavedQuery - * @static - * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from - * @param {number} [length] Message length if known beforehand - * @returns {google.cloud.aiplatform.v1beta1.SavedQuery} SavedQuery - * @throws {Error} If the payload is not a reader or valid buffer - * @throws {$protobuf.util.ProtocolError} If required fields are missing - */ - SavedQuery.decode = function decode(reader, length) { - if (!(reader instanceof $Reader)) - reader = $Reader.create(reader); - var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.aiplatform.v1beta1.SavedQuery(); - while (reader.pos < end) { - var tag = reader.uint32(); - switch (tag >>> 3) { - case 1: { - message.name = reader.string(); - break; - } - case 2: { - message.displayName = reader.string(); - break; - } - case 12: { - message.metadata = $root.google.protobuf.Value.decode(reader, reader.uint32()); - break; - } - case 3: { - message.createTime = $root.google.protobuf.Timestamp.decode(reader, reader.uint32()); - break; - } - case 4: { - message.updateTime = $root.google.protobuf.Timestamp.decode(reader, reader.uint32()); - break; - } - case 5: { - message.annotationFilter = reader.string(); - break; - } - case 6: { - message.problemType = reader.string(); - break; - } - case 10: { - message.annotationSpecCount = reader.int32(); - break; - } - case 8: { - message.etag = reader.string(); - break; - } - case 9: { - message.supportAutomlTraining = reader.bool(); - break; - } - default: - reader.skipType(tag & 7); - break; - } - } - return message; - }; - - /** - * Decodes a SavedQuery message from the specified reader or buffer, length delimited. - * @function decodeDelimited - * @memberof google.cloud.aiplatform.v1beta1.SavedQuery - * @static - * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from - * @returns {google.cloud.aiplatform.v1beta1.SavedQuery} SavedQuery - * @throws {Error} If the payload is not a reader or valid buffer - * @throws {$protobuf.util.ProtocolError} If required fields are missing - */ - SavedQuery.decodeDelimited = function decodeDelimited(reader) { - if (!(reader instanceof $Reader)) - reader = new $Reader(reader); - return this.decode(reader, reader.uint32()); - }; - - /** - * Verifies a SavedQuery message. - * @function verify - * @memberof google.cloud.aiplatform.v1beta1.SavedQuery - * @static - * @param {Object.} message Plain object to verify - * @returns {string|null} `null` if valid, otherwise the reason why it is not - */ - SavedQuery.verify = function verify(message) { - if (typeof message !== "object" || message === null) - return "object expected"; - if (message.name != null && message.hasOwnProperty("name")) - if (!$util.isString(message.name)) - return "name: string expected"; - if (message.displayName != null && message.hasOwnProperty("displayName")) - if (!$util.isString(message.displayName)) - return "displayName: string expected"; - if (message.metadata != null && message.hasOwnProperty("metadata")) { - var error = $root.google.protobuf.Value.verify(message.metadata); - if (error) - return "metadata." + error; - } - if (message.createTime != null && message.hasOwnProperty("createTime")) { - var error = $root.google.protobuf.Timestamp.verify(message.createTime); - if (error) - return "createTime." + error; - } - if (message.updateTime != null && message.hasOwnProperty("updateTime")) { - var error = $root.google.protobuf.Timestamp.verify(message.updateTime); - if (error) - return "updateTime." + error; - } - if (message.annotationFilter != null && message.hasOwnProperty("annotationFilter")) - if (!$util.isString(message.annotationFilter)) - return "annotationFilter: string expected"; - if (message.problemType != null && message.hasOwnProperty("problemType")) - if (!$util.isString(message.problemType)) - return "problemType: string expected"; - if (message.annotationSpecCount != null && message.hasOwnProperty("annotationSpecCount")) - if (!$util.isInteger(message.annotationSpecCount)) - return "annotationSpecCount: integer expected"; - if (message.etag != null && message.hasOwnProperty("etag")) - if (!$util.isString(message.etag)) - return "etag: string expected"; - if (message.supportAutomlTraining != null && message.hasOwnProperty("supportAutomlTraining")) - if (typeof message.supportAutomlTraining !== "boolean") - return "supportAutomlTraining: boolean expected"; - return null; - }; - - /** - * Creates a SavedQuery message from a plain object. Also converts values to their respective internal types. - * @function fromObject - * @memberof google.cloud.aiplatform.v1beta1.SavedQuery - * @static - * @param {Object.} object Plain object - * @returns {google.cloud.aiplatform.v1beta1.SavedQuery} SavedQuery - */ - SavedQuery.fromObject = function fromObject(object) { - if (object instanceof $root.google.cloud.aiplatform.v1beta1.SavedQuery) - return object; - var message = new $root.google.cloud.aiplatform.v1beta1.SavedQuery(); - if (object.name != null) - message.name = String(object.name); - if (object.displayName != null) - message.displayName = String(object.displayName); - if (object.metadata != null) { - if (typeof object.metadata !== "object") - throw TypeError(".google.cloud.aiplatform.v1beta1.SavedQuery.metadata: object expected"); - message.metadata = $root.google.protobuf.Value.fromObject(object.metadata); - } - if (object.createTime != null) { - if (typeof object.createTime !== "object") - throw TypeError(".google.cloud.aiplatform.v1beta1.SavedQuery.createTime: object expected"); - message.createTime = $root.google.protobuf.Timestamp.fromObject(object.createTime); - } - if (object.updateTime != null) { - if (typeof object.updateTime !== "object") - throw TypeError(".google.cloud.aiplatform.v1beta1.SavedQuery.updateTime: object expected"); - message.updateTime = $root.google.protobuf.Timestamp.fromObject(object.updateTime); - } - if (object.annotationFilter != null) - message.annotationFilter = String(object.annotationFilter); - if (object.problemType != null) - message.problemType = String(object.problemType); - if (object.annotationSpecCount != null) - message.annotationSpecCount = object.annotationSpecCount | 0; - if (object.etag != null) - message.etag = String(object.etag); - if (object.supportAutomlTraining != null) - message.supportAutomlTraining = Boolean(object.supportAutomlTraining); - return message; - }; - - /** - * Creates a plain object from a SavedQuery message. Also converts values to other types if specified. - * @function toObject - * @memberof google.cloud.aiplatform.v1beta1.SavedQuery - * @static - * @param {google.cloud.aiplatform.v1beta1.SavedQuery} message SavedQuery - * @param {$protobuf.IConversionOptions} [options] Conversion options - * @returns {Object.} Plain object - */ - SavedQuery.toObject = function toObject(message, options) { - if (!options) - options = {}; - var object = {}; - if (options.defaults) { - object.name = ""; - object.displayName = ""; - object.createTime = null; - object.updateTime = null; - object.annotationFilter = ""; - object.problemType = ""; - object.etag = ""; - object.supportAutomlTraining = false; - object.annotationSpecCount = 0; - object.metadata = null; - } - if (message.name != null && message.hasOwnProperty("name")) - object.name = message.name; - if (message.displayName != null && message.hasOwnProperty("displayName")) - object.displayName = message.displayName; - if (message.createTime != null && message.hasOwnProperty("createTime")) - object.createTime = $root.google.protobuf.Timestamp.toObject(message.createTime, options); - if (message.updateTime != null && message.hasOwnProperty("updateTime")) - object.updateTime = $root.google.protobuf.Timestamp.toObject(message.updateTime, options); - if (message.annotationFilter != null && message.hasOwnProperty("annotationFilter")) - object.annotationFilter = message.annotationFilter; - if (message.problemType != null && message.hasOwnProperty("problemType")) - object.problemType = message.problemType; - if (message.etag != null && message.hasOwnProperty("etag")) - object.etag = message.etag; - if (message.supportAutomlTraining != null && message.hasOwnProperty("supportAutomlTraining")) - object.supportAutomlTraining = message.supportAutomlTraining; - if (message.annotationSpecCount != null && message.hasOwnProperty("annotationSpecCount")) - object.annotationSpecCount = message.annotationSpecCount; - if (message.metadata != null && message.hasOwnProperty("metadata")) - object.metadata = $root.google.protobuf.Value.toObject(message.metadata, options); - return object; - }; - - /** - * Converts this SavedQuery to JSON. - * @function toJSON - * @memberof google.cloud.aiplatform.v1beta1.SavedQuery - * @instance - * @returns {Object.} JSON object - */ - SavedQuery.prototype.toJSON = function toJSON() { - return this.constructor.toObject(this, $protobuf.util.toJSONOptions); - }; - - /** - * Gets the default type url for SavedQuery - * @function getTypeUrl - * @memberof google.cloud.aiplatform.v1beta1.SavedQuery - * @static - * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") - * @returns {string} The default type url - */ - SavedQuery.getTypeUrl = function getTypeUrl(typeUrlPrefix) { - if (typeUrlPrefix === undefined) { - typeUrlPrefix = "type.googleapis.com"; - } - return typeUrlPrefix + "/google.cloud.aiplatform.v1beta1.SavedQuery"; - }; - - return SavedQuery; - })(); - v1beta1.DeployedIndexRef = (function() { /** @@ -204926,6 +210536,8 @@ * @property {Array.|null} [deployedModels] QueryDeployedModelsResponse deployedModels * @property {string|null} [nextPageToken] QueryDeployedModelsResponse nextPageToken * @property {Array.|null} [deployedModelRefs] QueryDeployedModelsResponse deployedModelRefs + * @property {number|null} [totalDeployedModelCount] QueryDeployedModelsResponse totalDeployedModelCount + * @property {number|null} [totalEndpointCount] QueryDeployedModelsResponse totalEndpointCount */ /** @@ -204969,6 +210581,22 @@ */ QueryDeployedModelsResponse.prototype.deployedModelRefs = $util.emptyArray; + /** + * QueryDeployedModelsResponse totalDeployedModelCount. + * @member {number} totalDeployedModelCount + * @memberof google.cloud.aiplatform.v1beta1.QueryDeployedModelsResponse + * @instance + */ + QueryDeployedModelsResponse.prototype.totalDeployedModelCount = 0; + + /** + * QueryDeployedModelsResponse totalEndpointCount. + * @member {number} totalEndpointCount + * @memberof google.cloud.aiplatform.v1beta1.QueryDeployedModelsResponse + * @instance + */ + QueryDeployedModelsResponse.prototype.totalEndpointCount = 0; + /** * Creates a new QueryDeployedModelsResponse instance using the specified properties. * @function create @@ -205001,6 +210629,10 @@ if (message.deployedModelRefs != null && message.deployedModelRefs.length) for (var i = 0; i < message.deployedModelRefs.length; ++i) $root.google.cloud.aiplatform.v1beta1.DeployedModelRef.encode(message.deployedModelRefs[i], writer.uint32(/* id 3, wireType 2 =*/26).fork()).ldelim(); + if (message.totalDeployedModelCount != null && Object.hasOwnProperty.call(message, "totalDeployedModelCount")) + writer.uint32(/* id 4, wireType 0 =*/32).int32(message.totalDeployedModelCount); + if (message.totalEndpointCount != null && Object.hasOwnProperty.call(message, "totalEndpointCount")) + writer.uint32(/* id 5, wireType 0 =*/40).int32(message.totalEndpointCount); return writer; }; @@ -205051,6 +210683,14 @@ message.deployedModelRefs.push($root.google.cloud.aiplatform.v1beta1.DeployedModelRef.decode(reader, reader.uint32())); break; } + case 4: { + message.totalDeployedModelCount = reader.int32(); + break; + } + case 5: { + message.totalEndpointCount = reader.int32(); + break; + } default: reader.skipType(tag & 7); break; @@ -205107,6 +210747,12 @@ return "deployedModelRefs." + error; } } + if (message.totalDeployedModelCount != null && message.hasOwnProperty("totalDeployedModelCount")) + if (!$util.isInteger(message.totalDeployedModelCount)) + return "totalDeployedModelCount: integer expected"; + if (message.totalEndpointCount != null && message.hasOwnProperty("totalEndpointCount")) + if (!$util.isInteger(message.totalEndpointCount)) + return "totalEndpointCount: integer expected"; return null; }; @@ -205144,6 +210790,10 @@ message.deployedModelRefs[i] = $root.google.cloud.aiplatform.v1beta1.DeployedModelRef.fromObject(object.deployedModelRefs[i]); } } + if (object.totalDeployedModelCount != null) + message.totalDeployedModelCount = object.totalDeployedModelCount | 0; + if (object.totalEndpointCount != null) + message.totalEndpointCount = object.totalEndpointCount | 0; return message; }; @@ -205164,8 +210814,11 @@ object.deployedModels = []; object.deployedModelRefs = []; } - if (options.defaults) + if (options.defaults) { object.nextPageToken = ""; + object.totalDeployedModelCount = 0; + object.totalEndpointCount = 0; + } if (message.deployedModels && message.deployedModels.length) { object.deployedModels = []; for (var j = 0; j < message.deployedModels.length; ++j) @@ -205178,6 +210831,10 @@ for (var j = 0; j < message.deployedModelRefs.length; ++j) object.deployedModelRefs[j] = $root.google.cloud.aiplatform.v1beta1.DeployedModelRef.toObject(message.deployedModelRefs[j], options); } + if (message.totalDeployedModelCount != null && message.hasOwnProperty("totalDeployedModelCount")) + object.totalDeployedModelCount = message.totalDeployedModelCount; + if (message.totalEndpointCount != null && message.hasOwnProperty("totalEndpointCount")) + object.totalEndpointCount = message.totalEndpointCount; return object; }; @@ -210202,6 +215859,7 @@ * @property {Object.|null} [labels] EntityType labels * @property {string|null} [etag] EntityType etag * @property {google.cloud.aiplatform.v1beta1.IFeaturestoreMonitoringConfig|null} [monitoringConfig] EntityType monitoringConfig + * @property {number|null} [offlineStorageTtlDays] EntityType offlineStorageTtlDays */ /** @@ -210276,6 +215934,14 @@ */ EntityType.prototype.monitoringConfig = null; + /** + * EntityType offlineStorageTtlDays. + * @member {number} offlineStorageTtlDays + * @memberof google.cloud.aiplatform.v1beta1.EntityType + * @instance + */ + EntityType.prototype.offlineStorageTtlDays = 0; + /** * Creates a new EntityType instance using the specified properties. * @function create @@ -210315,6 +215981,8 @@ writer.uint32(/* id 7, wireType 2 =*/58).string(message.etag); if (message.monitoringConfig != null && Object.hasOwnProperty.call(message, "monitoringConfig")) $root.google.cloud.aiplatform.v1beta1.FeaturestoreMonitoringConfig.encode(message.monitoringConfig, writer.uint32(/* id 8, wireType 2 =*/66).fork()).ldelim(); + if (message.offlineStorageTtlDays != null && Object.hasOwnProperty.call(message, "offlineStorageTtlDays")) + writer.uint32(/* id 10, wireType 0 =*/80).int32(message.offlineStorageTtlDays); return writer; }; @@ -210396,6 +216064,10 @@ message.monitoringConfig = $root.google.cloud.aiplatform.v1beta1.FeaturestoreMonitoringConfig.decode(reader, reader.uint32()); break; } + case 10: { + message.offlineStorageTtlDays = reader.int32(); + break; + } default: reader.skipType(tag & 7); break; @@ -210463,6 +216135,9 @@ if (error) return "monitoringConfig." + error; } + if (message.offlineStorageTtlDays != null && message.hasOwnProperty("offlineStorageTtlDays")) + if (!$util.isInteger(message.offlineStorageTtlDays)) + return "offlineStorageTtlDays: integer expected"; return null; }; @@ -210506,6 +216181,8 @@ throw TypeError(".google.cloud.aiplatform.v1beta1.EntityType.monitoringConfig: object expected"); message.monitoringConfig = $root.google.cloud.aiplatform.v1beta1.FeaturestoreMonitoringConfig.fromObject(object.monitoringConfig); } + if (object.offlineStorageTtlDays != null) + message.offlineStorageTtlDays = object.offlineStorageTtlDays | 0; return message; }; @@ -210531,6 +216208,7 @@ object.updateTime = null; object.etag = ""; object.monitoringConfig = null; + object.offlineStorageTtlDays = 0; } if (message.name != null && message.hasOwnProperty("name")) object.name = message.name; @@ -210550,6 +216228,8 @@ object.etag = message.etag; if (message.monitoringConfig != null && message.hasOwnProperty("monitoringConfig")) object.monitoringConfig = $root.google.cloud.aiplatform.v1beta1.FeaturestoreMonitoringConfig.toObject(message.monitoringConfig, options); + if (message.offlineStorageTtlDays != null && message.hasOwnProperty("offlineStorageTtlDays")) + object.offlineStorageTtlDays = message.offlineStorageTtlDays; return object; }; @@ -213955,6 +219635,7 @@ * @property {Object.|null} [labels] Featurestore labels * @property {google.cloud.aiplatform.v1beta1.Featurestore.IOnlineServingConfig|null} [onlineServingConfig] Featurestore onlineServingConfig * @property {google.cloud.aiplatform.v1beta1.Featurestore.State|null} [state] Featurestore state + * @property {number|null} [onlineStorageTtlDays] Featurestore onlineStorageTtlDays * @property {google.cloud.aiplatform.v1beta1.IEncryptionSpec|null} [encryptionSpec] Featurestore encryptionSpec */ @@ -214030,6 +219711,14 @@ */ Featurestore.prototype.state = 0; + /** + * Featurestore onlineStorageTtlDays. + * @member {number} onlineStorageTtlDays + * @memberof google.cloud.aiplatform.v1beta1.Featurestore + * @instance + */ + Featurestore.prototype.onlineStorageTtlDays = 0; + /** * Featurestore encryptionSpec. * @member {google.cloud.aiplatform.v1beta1.IEncryptionSpec|null|undefined} encryptionSpec @@ -214079,6 +219768,8 @@ writer.uint32(/* id 8, wireType 0 =*/64).int32(message.state); if (message.encryptionSpec != null && Object.hasOwnProperty.call(message, "encryptionSpec")) $root.google.cloud.aiplatform.v1beta1.EncryptionSpec.encode(message.encryptionSpec, writer.uint32(/* id 10, wireType 2 =*/82).fork()).ldelim(); + if (message.onlineStorageTtlDays != null && Object.hasOwnProperty.call(message, "onlineStorageTtlDays")) + writer.uint32(/* id 13, wireType 0 =*/104).int32(message.onlineStorageTtlDays); return writer; }; @@ -214160,6 +219851,10 @@ message.state = reader.int32(); break; } + case 13: { + message.onlineStorageTtlDays = reader.int32(); + break; + } case 10: { message.encryptionSpec = $root.google.cloud.aiplatform.v1beta1.EncryptionSpec.decode(reader, reader.uint32()); break; @@ -214237,6 +219932,9 @@ case 2: break; } + if (message.onlineStorageTtlDays != null && message.hasOwnProperty("onlineStorageTtlDays")) + if (!$util.isInteger(message.onlineStorageTtlDays)) + return "onlineStorageTtlDays: integer expected"; if (message.encryptionSpec != null && message.hasOwnProperty("encryptionSpec")) { var error = $root.google.cloud.aiplatform.v1beta1.EncryptionSpec.verify(message.encryptionSpec); if (error) @@ -214303,6 +220001,8 @@ message.state = 2; break; } + if (object.onlineStorageTtlDays != null) + message.onlineStorageTtlDays = object.onlineStorageTtlDays | 0; if (object.encryptionSpec != null) { if (typeof object.encryptionSpec !== "object") throw TypeError(".google.cloud.aiplatform.v1beta1.Featurestore.encryptionSpec: object expected"); @@ -214334,6 +220034,7 @@ object.onlineServingConfig = null; object.state = options.enums === String ? "STATE_UNSPECIFIED" : 0; object.encryptionSpec = null; + object.onlineStorageTtlDays = 0; } if (message.name != null && message.hasOwnProperty("name")) object.name = message.name; @@ -214355,6 +220056,8 @@ object.state = options.enums === String ? $root.google.cloud.aiplatform.v1beta1.Featurestore.State[message.state] === undefined ? message.state : $root.google.cloud.aiplatform.v1beta1.Featurestore.State[message.state] : message.state; if (message.encryptionSpec != null && message.hasOwnProperty("encryptionSpec")) object.encryptionSpec = $root.google.cloud.aiplatform.v1beta1.EncryptionSpec.toObject(message.encryptionSpec, options); + if (message.onlineStorageTtlDays != null && message.hasOwnProperty("onlineStorageTtlDays")) + object.onlineStorageTtlDays = message.onlineStorageTtlDays; return object; }; @@ -222596,6 +228299,7 @@ * @property {google.cloud.aiplatform.v1beta1.IFeatureValueDestination|null} [destination] BatchReadFeatureValuesRequest destination * @property {Array.|null} [passThroughFields] BatchReadFeatureValuesRequest passThroughFields * @property {Array.|null} [entityTypeSpecs] BatchReadFeatureValuesRequest entityTypeSpecs + * @property {google.protobuf.ITimestamp|null} [startTime] BatchReadFeatureValuesRequest startTime */ /** @@ -222663,6 +228367,14 @@ */ BatchReadFeatureValuesRequest.prototype.entityTypeSpecs = $util.emptyArray; + /** + * BatchReadFeatureValuesRequest startTime. + * @member {google.protobuf.ITimestamp|null|undefined} startTime + * @memberof google.cloud.aiplatform.v1beta1.BatchReadFeatureValuesRequest + * @instance + */ + BatchReadFeatureValuesRequest.prototype.startTime = null; + // OneOf field names bound to virtual getters and setters var $oneOfFields; @@ -222715,6 +228427,8 @@ if (message.passThroughFields != null && message.passThroughFields.length) for (var i = 0; i < message.passThroughFields.length; ++i) $root.google.cloud.aiplatform.v1beta1.BatchReadFeatureValuesRequest.PassThroughField.encode(message.passThroughFields[i], writer.uint32(/* id 8, wireType 2 =*/66).fork()).ldelim(); + if (message.startTime != null && Object.hasOwnProperty.call(message, "startTime")) + $root.google.protobuf.Timestamp.encode(message.startTime, writer.uint32(/* id 11, wireType 2 =*/90).fork()).ldelim(); return writer; }; @@ -222777,6 +228491,10 @@ message.entityTypeSpecs.push($root.google.cloud.aiplatform.v1beta1.BatchReadFeatureValuesRequest.EntityTypeSpec.decode(reader, reader.uint32())); break; } + case 11: { + message.startTime = $root.google.protobuf.Timestamp.decode(reader, reader.uint32()); + break; + } default: reader.skipType(tag & 7); break; @@ -222857,6 +228575,11 @@ return "entityTypeSpecs." + error; } } + if (message.startTime != null && message.hasOwnProperty("startTime")) { + var error = $root.google.protobuf.Timestamp.verify(message.startTime); + if (error) + return "startTime." + error; + } return null; }; @@ -222909,6 +228632,11 @@ message.entityTypeSpecs[i] = $root.google.cloud.aiplatform.v1beta1.BatchReadFeatureValuesRequest.EntityTypeSpec.fromObject(object.entityTypeSpecs[i]); } } + if (object.startTime != null) { + if (typeof object.startTime !== "object") + throw TypeError(".google.cloud.aiplatform.v1beta1.BatchReadFeatureValuesRequest.startTime: object expected"); + message.startTime = $root.google.protobuf.Timestamp.fromObject(object.startTime); + } return message; }; @@ -222932,6 +228660,7 @@ if (options.defaults) { object.featurestore = ""; object.destination = null; + object.startTime = null; } if (message.featurestore != null && message.hasOwnProperty("featurestore")) object.featurestore = message.featurestore; @@ -222957,6 +228686,8 @@ for (var j = 0; j < message.passThroughFields.length; ++j) object.passThroughFields[j] = $root.google.cloud.aiplatform.v1beta1.BatchReadFeatureValuesRequest.PassThroughField.toObject(message.passThroughFields[j], options); } + if (message.startTime != null && message.hasOwnProperty("startTime")) + object.startTime = $root.google.protobuf.Timestamp.toObject(message.startTime, options); return object; }; @@ -229610,6 +235341,7 @@ * @property {google.cloud.aiplatform.v1beta1.IGenericOperationMetadata|null} [genericMetadata] ImportFeatureValuesOperationMetadata genericMetadata * @property {number|Long|null} [importedEntityCount] ImportFeatureValuesOperationMetadata importedEntityCount * @property {number|Long|null} [importedFeatureValueCount] ImportFeatureValuesOperationMetadata importedFeatureValueCount + * @property {Array.|null} [sourceUris] ImportFeatureValuesOperationMetadata sourceUris * @property {number|Long|null} [invalidRowCount] ImportFeatureValuesOperationMetadata invalidRowCount * @property {number|Long|null} [timestampOutsideRetentionRowsCount] ImportFeatureValuesOperationMetadata timestampOutsideRetentionRowsCount */ @@ -229623,6 +235355,7 @@ * @param {google.cloud.aiplatform.v1beta1.IImportFeatureValuesOperationMetadata=} [properties] Properties to set */ function ImportFeatureValuesOperationMetadata(properties) { + this.sourceUris = []; if (properties) for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) if (properties[keys[i]] != null) @@ -229653,6 +235386,14 @@ */ ImportFeatureValuesOperationMetadata.prototype.importedFeatureValueCount = $util.Long ? $util.Long.fromBits(0,0,false) : 0; + /** + * ImportFeatureValuesOperationMetadata sourceUris. + * @member {Array.} sourceUris + * @memberof google.cloud.aiplatform.v1beta1.ImportFeatureValuesOperationMetadata + * @instance + */ + ImportFeatureValuesOperationMetadata.prototype.sourceUris = $util.emptyArray; + /** * ImportFeatureValuesOperationMetadata invalidRowCount. * @member {number|Long} invalidRowCount @@ -229699,6 +235440,9 @@ writer.uint32(/* id 2, wireType 0 =*/16).int64(message.importedEntityCount); if (message.importedFeatureValueCount != null && Object.hasOwnProperty.call(message, "importedFeatureValueCount")) writer.uint32(/* id 3, wireType 0 =*/24).int64(message.importedFeatureValueCount); + if (message.sourceUris != null && message.sourceUris.length) + for (var i = 0; i < message.sourceUris.length; ++i) + writer.uint32(/* id 4, wireType 2 =*/34).string(message.sourceUris[i]); if (message.invalidRowCount != null && Object.hasOwnProperty.call(message, "invalidRowCount")) writer.uint32(/* id 6, wireType 0 =*/48).int64(message.invalidRowCount); if (message.timestampOutsideRetentionRowsCount != null && Object.hasOwnProperty.call(message, "timestampOutsideRetentionRowsCount")) @@ -229749,6 +235493,12 @@ message.importedFeatureValueCount = reader.int64(); break; } + case 4: { + if (!(message.sourceUris && message.sourceUris.length)) + message.sourceUris = []; + message.sourceUris.push(reader.string()); + break; + } case 6: { message.invalidRowCount = reader.int64(); break; @@ -229803,6 +235553,13 @@ if (message.importedFeatureValueCount != null && message.hasOwnProperty("importedFeatureValueCount")) if (!$util.isInteger(message.importedFeatureValueCount) && !(message.importedFeatureValueCount && $util.isInteger(message.importedFeatureValueCount.low) && $util.isInteger(message.importedFeatureValueCount.high))) return "importedFeatureValueCount: integer|Long expected"; + if (message.sourceUris != null && message.hasOwnProperty("sourceUris")) { + if (!Array.isArray(message.sourceUris)) + return "sourceUris: array expected"; + for (var i = 0; i < message.sourceUris.length; ++i) + if (!$util.isString(message.sourceUris[i])) + return "sourceUris: string[] expected"; + } if (message.invalidRowCount != null && message.hasOwnProperty("invalidRowCount")) if (!$util.isInteger(message.invalidRowCount) && !(message.invalidRowCount && $util.isInteger(message.invalidRowCount.low) && $util.isInteger(message.invalidRowCount.high))) return "invalidRowCount: integer|Long expected"; @@ -229847,6 +235604,13 @@ message.importedFeatureValueCount = object.importedFeatureValueCount; else if (typeof object.importedFeatureValueCount === "object") message.importedFeatureValueCount = new $util.LongBits(object.importedFeatureValueCount.low >>> 0, object.importedFeatureValueCount.high >>> 0).toNumber(); + if (object.sourceUris) { + if (!Array.isArray(object.sourceUris)) + throw TypeError(".google.cloud.aiplatform.v1beta1.ImportFeatureValuesOperationMetadata.sourceUris: array expected"); + message.sourceUris = []; + for (var i = 0; i < object.sourceUris.length; ++i) + message.sourceUris[i] = String(object.sourceUris[i]); + } if (object.invalidRowCount != null) if ($util.Long) (message.invalidRowCount = $util.Long.fromValue(object.invalidRowCount)).unsigned = false; @@ -229881,6 +235645,8 @@ if (!options) options = {}; var object = {}; + if (options.arrays || options.defaults) + object.sourceUris = []; if (options.defaults) { object.genericMetadata = null; if ($util.Long) { @@ -229916,6 +235682,11 @@ object.importedFeatureValueCount = options.longs === String ? String(message.importedFeatureValueCount) : message.importedFeatureValueCount; else object.importedFeatureValueCount = options.longs === String ? $util.Long.prototype.toString.call(message.importedFeatureValueCount) : options.longs === Number ? new $util.LongBits(message.importedFeatureValueCount.low >>> 0, message.importedFeatureValueCount.high >>> 0).toNumber() : message.importedFeatureValueCount; + if (message.sourceUris && message.sourceUris.length) { + object.sourceUris = []; + for (var j = 0; j < message.sourceUris.length; ++j) + object.sourceUris[j] = message.sourceUris[j]; + } if (message.invalidRowCount != null && message.hasOwnProperty("invalidRowCount")) if (typeof message.invalidRowCount === "number") object.invalidRowCount = options.longs === String ? String(message.invalidRowCount) : message.invalidRowCount; @@ -238179,6 +243950,7 @@ * @property {number|Long|null} [minMeasurementCount] ConvexAutomatedStoppingSpec minMeasurementCount * @property {string|null} [learningRateParameterName] ConvexAutomatedStoppingSpec learningRateParameterName * @property {boolean|null} [useElapsedDuration] ConvexAutomatedStoppingSpec useElapsedDuration + * @property {boolean|null} [updateAllStoppedTrials] ConvexAutomatedStoppingSpec updateAllStoppedTrials */ /** @@ -238236,6 +244008,28 @@ */ ConvexAutomatedStoppingSpec.prototype.useElapsedDuration = false; + /** + * ConvexAutomatedStoppingSpec updateAllStoppedTrials. + * @member {boolean|null|undefined} updateAllStoppedTrials + * @memberof google.cloud.aiplatform.v1beta1.StudySpec.ConvexAutomatedStoppingSpec + * @instance + */ + ConvexAutomatedStoppingSpec.prototype.updateAllStoppedTrials = null; + + // OneOf field names bound to virtual getters and setters + var $oneOfFields; + + /** + * ConvexAutomatedStoppingSpec _updateAllStoppedTrials. + * @member {"updateAllStoppedTrials"|undefined} _updateAllStoppedTrials + * @memberof google.cloud.aiplatform.v1beta1.StudySpec.ConvexAutomatedStoppingSpec + * @instance + */ + Object.defineProperty(ConvexAutomatedStoppingSpec.prototype, "_updateAllStoppedTrials", { + get: $util.oneOfGetter($oneOfFields = ["updateAllStoppedTrials"]), + set: $util.oneOfSetter($oneOfFields) + }); + /** * Creates a new ConvexAutomatedStoppingSpec instance using the specified properties. * @function create @@ -238270,6 +244064,8 @@ writer.uint32(/* id 4, wireType 2 =*/34).string(message.learningRateParameterName); if (message.useElapsedDuration != null && Object.hasOwnProperty.call(message, "useElapsedDuration")) writer.uint32(/* id 5, wireType 0 =*/40).bool(message.useElapsedDuration); + if (message.updateAllStoppedTrials != null && Object.hasOwnProperty.call(message, "updateAllStoppedTrials")) + writer.uint32(/* id 6, wireType 0 =*/48).bool(message.updateAllStoppedTrials); return writer; }; @@ -238324,6 +244120,10 @@ message.useElapsedDuration = reader.bool(); break; } + case 6: { + message.updateAllStoppedTrials = reader.bool(); + break; + } default: reader.skipType(tag & 7); break; @@ -238359,6 +244159,7 @@ ConvexAutomatedStoppingSpec.verify = function verify(message) { if (typeof message !== "object" || message === null) return "object expected"; + var properties = {}; if (message.maxStepCount != null && message.hasOwnProperty("maxStepCount")) if (!$util.isInteger(message.maxStepCount) && !(message.maxStepCount && $util.isInteger(message.maxStepCount.low) && $util.isInteger(message.maxStepCount.high))) return "maxStepCount: integer|Long expected"; @@ -238374,6 +244175,11 @@ if (message.useElapsedDuration != null && message.hasOwnProperty("useElapsedDuration")) if (typeof message.useElapsedDuration !== "boolean") return "useElapsedDuration: boolean expected"; + if (message.updateAllStoppedTrials != null && message.hasOwnProperty("updateAllStoppedTrials")) { + properties._updateAllStoppedTrials = 1; + if (typeof message.updateAllStoppedTrials !== "boolean") + return "updateAllStoppedTrials: boolean expected"; + } return null; }; @@ -238420,6 +244226,8 @@ message.learningRateParameterName = String(object.learningRateParameterName); if (object.useElapsedDuration != null) message.useElapsedDuration = Boolean(object.useElapsedDuration); + if (object.updateAllStoppedTrials != null) + message.updateAllStoppedTrials = Boolean(object.updateAllStoppedTrials); return message; }; @@ -238474,6 +244282,11 @@ object.learningRateParameterName = message.learningRateParameterName; if (message.useElapsedDuration != null && message.hasOwnProperty("useElapsedDuration")) object.useElapsedDuration = message.useElapsedDuration; + if (message.updateAllStoppedTrials != null && message.hasOwnProperty("updateAllStoppedTrials")) { + object.updateAllStoppedTrials = message.updateAllStoppedTrials; + if (options.oneofs) + object._updateAllStoppedTrials = "updateAllStoppedTrials"; + } return object; }; @@ -281020,6 +286833,7 @@ * @property {string|null} [parentModel] UploadModelRequest parentModel * @property {string|null} [modelId] UploadModelRequest modelId * @property {google.cloud.aiplatform.v1beta1.IModel|null} [model] UploadModelRequest model + * @property {string|null} [serviceAccount] UploadModelRequest serviceAccount */ /** @@ -281069,6 +286883,14 @@ */ UploadModelRequest.prototype.model = null; + /** + * UploadModelRequest serviceAccount. + * @member {string} serviceAccount + * @memberof google.cloud.aiplatform.v1beta1.UploadModelRequest + * @instance + */ + UploadModelRequest.prototype.serviceAccount = ""; + /** * Creates a new UploadModelRequest instance using the specified properties. * @function create @@ -281101,6 +286923,8 @@ writer.uint32(/* id 4, wireType 2 =*/34).string(message.parentModel); if (message.modelId != null && Object.hasOwnProperty.call(message, "modelId")) writer.uint32(/* id 5, wireType 2 =*/42).string(message.modelId); + if (message.serviceAccount != null && Object.hasOwnProperty.call(message, "serviceAccount")) + writer.uint32(/* id 6, wireType 2 =*/50).string(message.serviceAccount); return writer; }; @@ -281151,6 +286975,10 @@ message.model = $root.google.cloud.aiplatform.v1beta1.Model.decode(reader, reader.uint32()); break; } + case 6: { + message.serviceAccount = reader.string(); + break; + } default: reader.skipType(tag & 7); break; @@ -281200,6 +287028,9 @@ if (error) return "model." + error; } + if (message.serviceAccount != null && message.hasOwnProperty("serviceAccount")) + if (!$util.isString(message.serviceAccount)) + return "serviceAccount: string expected"; return null; }; @@ -281226,6 +287057,8 @@ throw TypeError(".google.cloud.aiplatform.v1beta1.UploadModelRequest.model: object expected"); message.model = $root.google.cloud.aiplatform.v1beta1.Model.fromObject(object.model); } + if (object.serviceAccount != null) + message.serviceAccount = String(object.serviceAccount); return message; }; @@ -281247,6 +287080,7 @@ object.model = null; object.parentModel = ""; object.modelId = ""; + object.serviceAccount = ""; } if (message.parent != null && message.hasOwnProperty("parent")) object.parent = message.parent; @@ -281256,6 +287090,8 @@ object.parentModel = message.parentModel; if (message.modelId != null && message.hasOwnProperty("modelId")) object.modelId = message.modelId; + if (message.serviceAccount != null && message.hasOwnProperty("serviceAccount")) + object.serviceAccount = message.serviceAccount; return object; }; @@ -282486,6 +288322,7 @@ * @property {string|null} [pageToken] ListModelVersionsRequest pageToken * @property {string|null} [filter] ListModelVersionsRequest filter * @property {google.protobuf.IFieldMask|null} [readMask] ListModelVersionsRequest readMask + * @property {string|null} [orderBy] ListModelVersionsRequest orderBy */ /** @@ -282543,6 +288380,14 @@ */ ListModelVersionsRequest.prototype.readMask = null; + /** + * ListModelVersionsRequest orderBy. + * @member {string} orderBy + * @memberof google.cloud.aiplatform.v1beta1.ListModelVersionsRequest + * @instance + */ + ListModelVersionsRequest.prototype.orderBy = ""; + /** * Creates a new ListModelVersionsRequest instance using the specified properties. * @function create @@ -282577,6 +288422,8 @@ writer.uint32(/* id 4, wireType 2 =*/34).string(message.filter); if (message.readMask != null && Object.hasOwnProperty.call(message, "readMask")) $root.google.protobuf.FieldMask.encode(message.readMask, writer.uint32(/* id 5, wireType 2 =*/42).fork()).ldelim(); + if (message.orderBy != null && Object.hasOwnProperty.call(message, "orderBy")) + writer.uint32(/* id 6, wireType 2 =*/50).string(message.orderBy); return writer; }; @@ -282631,6 +288478,10 @@ message.readMask = $root.google.protobuf.FieldMask.decode(reader, reader.uint32()); break; } + case 6: { + message.orderBy = reader.string(); + break; + } default: reader.skipType(tag & 7); break; @@ -282683,6 +288534,9 @@ if (error) return "readMask." + error; } + if (message.orderBy != null && message.hasOwnProperty("orderBy")) + if (!$util.isString(message.orderBy)) + return "orderBy: string expected"; return null; }; @@ -282711,6 +288565,8 @@ throw TypeError(".google.cloud.aiplatform.v1beta1.ListModelVersionsRequest.readMask: object expected"); message.readMask = $root.google.protobuf.FieldMask.fromObject(object.readMask); } + if (object.orderBy != null) + message.orderBy = String(object.orderBy); return message; }; @@ -282733,6 +288589,7 @@ object.pageToken = ""; object.filter = ""; object.readMask = null; + object.orderBy = ""; } if (message.name != null && message.hasOwnProperty("name")) object.name = message.name; @@ -282744,6 +288601,8 @@ object.filter = message.filter; if (message.readMask != null && message.hasOwnProperty("readMask")) object.readMask = $root.google.protobuf.FieldMask.toObject(message.readMask, options); + if (message.orderBy != null && message.hasOwnProperty("orderBy")) + object.orderBy = message.orderBy; return object; }; @@ -291283,6 +297142,8 @@ * @interface IContainerDetail * @property {string|null} [mainJob] ContainerDetail mainJob * @property {string|null} [preCachingCheckJob] ContainerDetail preCachingCheckJob + * @property {Array.|null} [failedMainJobs] ContainerDetail failedMainJobs + * @property {Array.|null} [failedPreCachingCheckJobs] ContainerDetail failedPreCachingCheckJobs */ /** @@ -291294,6 +297155,8 @@ * @param {google.cloud.aiplatform.v1beta1.PipelineTaskExecutorDetail.IContainerDetail=} [properties] Properties to set */ function ContainerDetail(properties) { + this.failedMainJobs = []; + this.failedPreCachingCheckJobs = []; if (properties) for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) if (properties[keys[i]] != null) @@ -291316,6 +297179,22 @@ */ ContainerDetail.prototype.preCachingCheckJob = ""; + /** + * ContainerDetail failedMainJobs. + * @member {Array.} failedMainJobs + * @memberof google.cloud.aiplatform.v1beta1.PipelineTaskExecutorDetail.ContainerDetail + * @instance + */ + ContainerDetail.prototype.failedMainJobs = $util.emptyArray; + + /** + * ContainerDetail failedPreCachingCheckJobs. + * @member {Array.} failedPreCachingCheckJobs + * @memberof google.cloud.aiplatform.v1beta1.PipelineTaskExecutorDetail.ContainerDetail + * @instance + */ + ContainerDetail.prototype.failedPreCachingCheckJobs = $util.emptyArray; + /** * Creates a new ContainerDetail instance using the specified properties. * @function create @@ -291344,6 +297223,12 @@ writer.uint32(/* id 1, wireType 2 =*/10).string(message.mainJob); if (message.preCachingCheckJob != null && Object.hasOwnProperty.call(message, "preCachingCheckJob")) writer.uint32(/* id 2, wireType 2 =*/18).string(message.preCachingCheckJob); + if (message.failedMainJobs != null && message.failedMainJobs.length) + for (var i = 0; i < message.failedMainJobs.length; ++i) + writer.uint32(/* id 3, wireType 2 =*/26).string(message.failedMainJobs[i]); + if (message.failedPreCachingCheckJobs != null && message.failedPreCachingCheckJobs.length) + for (var i = 0; i < message.failedPreCachingCheckJobs.length; ++i) + writer.uint32(/* id 4, wireType 2 =*/34).string(message.failedPreCachingCheckJobs[i]); return writer; }; @@ -291386,6 +297271,18 @@ message.preCachingCheckJob = reader.string(); break; } + case 3: { + if (!(message.failedMainJobs && message.failedMainJobs.length)) + message.failedMainJobs = []; + message.failedMainJobs.push(reader.string()); + break; + } + case 4: { + if (!(message.failedPreCachingCheckJobs && message.failedPreCachingCheckJobs.length)) + message.failedPreCachingCheckJobs = []; + message.failedPreCachingCheckJobs.push(reader.string()); + break; + } default: reader.skipType(tag & 7); break; @@ -291427,6 +297324,20 @@ if (message.preCachingCheckJob != null && message.hasOwnProperty("preCachingCheckJob")) if (!$util.isString(message.preCachingCheckJob)) return "preCachingCheckJob: string expected"; + if (message.failedMainJobs != null && message.hasOwnProperty("failedMainJobs")) { + if (!Array.isArray(message.failedMainJobs)) + return "failedMainJobs: array expected"; + for (var i = 0; i < message.failedMainJobs.length; ++i) + if (!$util.isString(message.failedMainJobs[i])) + return "failedMainJobs: string[] expected"; + } + if (message.failedPreCachingCheckJobs != null && message.hasOwnProperty("failedPreCachingCheckJobs")) { + if (!Array.isArray(message.failedPreCachingCheckJobs)) + return "failedPreCachingCheckJobs: array expected"; + for (var i = 0; i < message.failedPreCachingCheckJobs.length; ++i) + if (!$util.isString(message.failedPreCachingCheckJobs[i])) + return "failedPreCachingCheckJobs: string[] expected"; + } return null; }; @@ -291446,6 +297357,20 @@ message.mainJob = String(object.mainJob); if (object.preCachingCheckJob != null) message.preCachingCheckJob = String(object.preCachingCheckJob); + if (object.failedMainJobs) { + if (!Array.isArray(object.failedMainJobs)) + throw TypeError(".google.cloud.aiplatform.v1beta1.PipelineTaskExecutorDetail.ContainerDetail.failedMainJobs: array expected"); + message.failedMainJobs = []; + for (var i = 0; i < object.failedMainJobs.length; ++i) + message.failedMainJobs[i] = String(object.failedMainJobs[i]); + } + if (object.failedPreCachingCheckJobs) { + if (!Array.isArray(object.failedPreCachingCheckJobs)) + throw TypeError(".google.cloud.aiplatform.v1beta1.PipelineTaskExecutorDetail.ContainerDetail.failedPreCachingCheckJobs: array expected"); + message.failedPreCachingCheckJobs = []; + for (var i = 0; i < object.failedPreCachingCheckJobs.length; ++i) + message.failedPreCachingCheckJobs[i] = String(object.failedPreCachingCheckJobs[i]); + } return message; }; @@ -291462,6 +297387,10 @@ if (!options) options = {}; var object = {}; + if (options.arrays || options.defaults) { + object.failedMainJobs = []; + object.failedPreCachingCheckJobs = []; + } if (options.defaults) { object.mainJob = ""; object.preCachingCheckJob = ""; @@ -291470,6 +297399,16 @@ object.mainJob = message.mainJob; if (message.preCachingCheckJob != null && message.hasOwnProperty("preCachingCheckJob")) object.preCachingCheckJob = message.preCachingCheckJob; + if (message.failedMainJobs && message.failedMainJobs.length) { + object.failedMainJobs = []; + for (var j = 0; j < message.failedMainJobs.length; ++j) + object.failedMainJobs[j] = message.failedMainJobs[j]; + } + if (message.failedPreCachingCheckJobs && message.failedPreCachingCheckJobs.length) { + object.failedPreCachingCheckJobs = []; + for (var j = 0; j < message.failedPreCachingCheckJobs.length; ++j) + object.failedPreCachingCheckJobs[j] = message.failedPreCachingCheckJobs[j]; + } return object; }; @@ -295945,6 +301884,7 @@ * @property {string|null} [annotationsFilter] InputDataConfig annotationsFilter * @property {string|null} [annotationSchemaUri] InputDataConfig annotationSchemaUri * @property {string|null} [savedQueryId] InputDataConfig savedQueryId + * @property {boolean|null} [persistMlUseAssignment] InputDataConfig persistMlUseAssignment */ /** @@ -296050,6 +301990,14 @@ */ InputDataConfig.prototype.savedQueryId = ""; + /** + * InputDataConfig persistMlUseAssignment. + * @member {boolean} persistMlUseAssignment + * @memberof google.cloud.aiplatform.v1beta1.InputDataConfig + * @instance + */ + InputDataConfig.prototype.persistMlUseAssignment = false; + // OneOf field names bound to virtual getters and setters var $oneOfFields; @@ -296119,6 +302067,8 @@ writer.uint32(/* id 9, wireType 2 =*/74).string(message.annotationSchemaUri); if (message.bigqueryDestination != null && Object.hasOwnProperty.call(message, "bigqueryDestination")) $root.google.cloud.aiplatform.v1beta1.BigQueryDestination.encode(message.bigqueryDestination, writer.uint32(/* id 10, wireType 2 =*/82).fork()).ldelim(); + if (message.persistMlUseAssignment != null && Object.hasOwnProperty.call(message, "persistMlUseAssignment")) + writer.uint32(/* id 11, wireType 0 =*/88).bool(message.persistMlUseAssignment); if (message.stratifiedSplit != null && Object.hasOwnProperty.call(message, "stratifiedSplit")) $root.google.cloud.aiplatform.v1beta1.StratifiedSplit.encode(message.stratifiedSplit, writer.uint32(/* id 12, wireType 2 =*/98).fork()).ldelim(); return writer; @@ -296199,6 +302149,10 @@ message.savedQueryId = reader.string(); break; } + case 11: { + message.persistMlUseAssignment = reader.bool(); + break; + } default: reader.skipType(tag & 7); break; @@ -296313,6 +302267,9 @@ if (message.savedQueryId != null && message.hasOwnProperty("savedQueryId")) if (!$util.isString(message.savedQueryId)) return "savedQueryId: string expected"; + if (message.persistMlUseAssignment != null && message.hasOwnProperty("persistMlUseAssignment")) + if (typeof message.persistMlUseAssignment !== "boolean") + return "persistMlUseAssignment: boolean expected"; return null; }; @@ -296371,6 +302328,8 @@ message.annotationSchemaUri = String(object.annotationSchemaUri); if (object.savedQueryId != null) message.savedQueryId = String(object.savedQueryId); + if (object.persistMlUseAssignment != null) + message.persistMlUseAssignment = Boolean(object.persistMlUseAssignment); return message; }; @@ -296392,6 +302351,7 @@ object.annotationsFilter = ""; object.savedQueryId = ""; object.annotationSchemaUri = ""; + object.persistMlUseAssignment = false; } if (message.datasetId != null && message.hasOwnProperty("datasetId")) object.datasetId = message.datasetId; @@ -296431,6 +302391,8 @@ if (options.oneofs) object.destination = "bigqueryDestination"; } + if (message.persistMlUseAssignment != null && message.hasOwnProperty("persistMlUseAssignment")) + object.persistMlUseAssignment = message.persistMlUseAssignment; if (message.stratifiedSplit != null && message.hasOwnProperty("stratifiedSplit")) { object.stratifiedSplit = $root.google.cloud.aiplatform.v1beta1.StratifiedSplit.toObject(message.stratifiedSplit, options); if (options.oneofs) @@ -331577,6 +337539,39 @@ * @variation 2 */ + /** + * Callback as used by {@link google.cloud.aiplatform.v1beta1.TensorboardService|readTensorboardUsage}. + * @memberof google.cloud.aiplatform.v1beta1.TensorboardService + * @typedef ReadTensorboardUsageCallback + * @type {function} + * @param {Error|null} error Error, if any + * @param {google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse} [response] ReadTensorboardUsageResponse + */ + + /** + * Calls ReadTensorboardUsage. + * @function readTensorboardUsage + * @memberof google.cloud.aiplatform.v1beta1.TensorboardService + * @instance + * @param {google.cloud.aiplatform.v1beta1.IReadTensorboardUsageRequest} request ReadTensorboardUsageRequest message or plain object + * @param {google.cloud.aiplatform.v1beta1.TensorboardService.ReadTensorboardUsageCallback} callback Node-style callback called with the error, if any, and ReadTensorboardUsageResponse + * @returns {undefined} + * @variation 1 + */ + Object.defineProperty(TensorboardService.prototype.readTensorboardUsage = function readTensorboardUsage(request, callback) { + return this.rpcCall(readTensorboardUsage, $root.google.cloud.aiplatform.v1beta1.ReadTensorboardUsageRequest, $root.google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse, request, callback); + }, "name", { value: "ReadTensorboardUsage" }); + + /** + * Calls ReadTensorboardUsage. + * @function readTensorboardUsage + * @memberof google.cloud.aiplatform.v1beta1.TensorboardService + * @instance + * @param {google.cloud.aiplatform.v1beta1.IReadTensorboardUsageRequest} request ReadTensorboardUsageRequest message or plain object + * @returns {Promise} Promise + * @variation 2 + */ + /** * Callback as used by {@link google.cloud.aiplatform.v1beta1.TensorboardService|updateTensorboard}. * @memberof google.cloud.aiplatform.v1beta1.TensorboardService @@ -332873,6 +338868,919 @@ return GetTensorboardRequest; })(); + v1beta1.ReadTensorboardUsageRequest = (function() { + + /** + * Properties of a ReadTensorboardUsageRequest. + * @memberof google.cloud.aiplatform.v1beta1 + * @interface IReadTensorboardUsageRequest + * @property {string|null} [tensorboard] ReadTensorboardUsageRequest tensorboard + */ + + /** + * Constructs a new ReadTensorboardUsageRequest. + * @memberof google.cloud.aiplatform.v1beta1 + * @classdesc Represents a ReadTensorboardUsageRequest. + * @implements IReadTensorboardUsageRequest + * @constructor + * @param {google.cloud.aiplatform.v1beta1.IReadTensorboardUsageRequest=} [properties] Properties to set + */ + function ReadTensorboardUsageRequest(properties) { + if (properties) + for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) + if (properties[keys[i]] != null) + this[keys[i]] = properties[keys[i]]; + } + + /** + * ReadTensorboardUsageRequest tensorboard. + * @member {string} tensorboard + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageRequest + * @instance + */ + ReadTensorboardUsageRequest.prototype.tensorboard = ""; + + /** + * Creates a new ReadTensorboardUsageRequest instance using the specified properties. + * @function create + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageRequest + * @static + * @param {google.cloud.aiplatform.v1beta1.IReadTensorboardUsageRequest=} [properties] Properties to set + * @returns {google.cloud.aiplatform.v1beta1.ReadTensorboardUsageRequest} ReadTensorboardUsageRequest instance + */ + ReadTensorboardUsageRequest.create = function create(properties) { + return new ReadTensorboardUsageRequest(properties); + }; + + /** + * Encodes the specified ReadTensorboardUsageRequest message. Does not implicitly {@link google.cloud.aiplatform.v1beta1.ReadTensorboardUsageRequest.verify|verify} messages. + * @function encode + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageRequest + * @static + * @param {google.cloud.aiplatform.v1beta1.IReadTensorboardUsageRequest} message ReadTensorboardUsageRequest message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + ReadTensorboardUsageRequest.encode = function encode(message, writer) { + if (!writer) + writer = $Writer.create(); + if (message.tensorboard != null && Object.hasOwnProperty.call(message, "tensorboard")) + writer.uint32(/* id 1, wireType 2 =*/10).string(message.tensorboard); + return writer; + }; + + /** + * Encodes the specified ReadTensorboardUsageRequest message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1beta1.ReadTensorboardUsageRequest.verify|verify} messages. + * @function encodeDelimited + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageRequest + * @static + * @param {google.cloud.aiplatform.v1beta1.IReadTensorboardUsageRequest} message ReadTensorboardUsageRequest message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + ReadTensorboardUsageRequest.encodeDelimited = function encodeDelimited(message, writer) { + return this.encode(message, writer).ldelim(); + }; + + /** + * Decodes a ReadTensorboardUsageRequest message from the specified reader or buffer. + * @function decode + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageRequest + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @param {number} [length] Message length if known beforehand + * @returns {google.cloud.aiplatform.v1beta1.ReadTensorboardUsageRequest} ReadTensorboardUsageRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + ReadTensorboardUsageRequest.decode = function decode(reader, length) { + if (!(reader instanceof $Reader)) + reader = $Reader.create(reader); + var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.aiplatform.v1beta1.ReadTensorboardUsageRequest(); + while (reader.pos < end) { + var tag = reader.uint32(); + switch (tag >>> 3) { + case 1: { + message.tensorboard = reader.string(); + break; + } + default: + reader.skipType(tag & 7); + break; + } + } + return message; + }; + + /** + * Decodes a ReadTensorboardUsageRequest message from the specified reader or buffer, length delimited. + * @function decodeDelimited + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageRequest + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @returns {google.cloud.aiplatform.v1beta1.ReadTensorboardUsageRequest} ReadTensorboardUsageRequest + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + ReadTensorboardUsageRequest.decodeDelimited = function decodeDelimited(reader) { + if (!(reader instanceof $Reader)) + reader = new $Reader(reader); + return this.decode(reader, reader.uint32()); + }; + + /** + * Verifies a ReadTensorboardUsageRequest message. + * @function verify + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageRequest + * @static + * @param {Object.} message Plain object to verify + * @returns {string|null} `null` if valid, otherwise the reason why it is not + */ + ReadTensorboardUsageRequest.verify = function verify(message) { + if (typeof message !== "object" || message === null) + return "object expected"; + if (message.tensorboard != null && message.hasOwnProperty("tensorboard")) + if (!$util.isString(message.tensorboard)) + return "tensorboard: string expected"; + return null; + }; + + /** + * Creates a ReadTensorboardUsageRequest message from a plain object. Also converts values to their respective internal types. + * @function fromObject + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageRequest + * @static + * @param {Object.} object Plain object + * @returns {google.cloud.aiplatform.v1beta1.ReadTensorboardUsageRequest} ReadTensorboardUsageRequest + */ + ReadTensorboardUsageRequest.fromObject = function fromObject(object) { + if (object instanceof $root.google.cloud.aiplatform.v1beta1.ReadTensorboardUsageRequest) + return object; + var message = new $root.google.cloud.aiplatform.v1beta1.ReadTensorboardUsageRequest(); + if (object.tensorboard != null) + message.tensorboard = String(object.tensorboard); + return message; + }; + + /** + * Creates a plain object from a ReadTensorboardUsageRequest message. Also converts values to other types if specified. + * @function toObject + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageRequest + * @static + * @param {google.cloud.aiplatform.v1beta1.ReadTensorboardUsageRequest} message ReadTensorboardUsageRequest + * @param {$protobuf.IConversionOptions} [options] Conversion options + * @returns {Object.} Plain object + */ + ReadTensorboardUsageRequest.toObject = function toObject(message, options) { + if (!options) + options = {}; + var object = {}; + if (options.defaults) + object.tensorboard = ""; + if (message.tensorboard != null && message.hasOwnProperty("tensorboard")) + object.tensorboard = message.tensorboard; + return object; + }; + + /** + * Converts this ReadTensorboardUsageRequest to JSON. + * @function toJSON + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageRequest + * @instance + * @returns {Object.} JSON object + */ + ReadTensorboardUsageRequest.prototype.toJSON = function toJSON() { + return this.constructor.toObject(this, $protobuf.util.toJSONOptions); + }; + + /** + * Gets the default type url for ReadTensorboardUsageRequest + * @function getTypeUrl + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageRequest + * @static + * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns {string} The default type url + */ + ReadTensorboardUsageRequest.getTypeUrl = function getTypeUrl(typeUrlPrefix) { + if (typeUrlPrefix === undefined) { + typeUrlPrefix = "type.googleapis.com"; + } + return typeUrlPrefix + "/google.cloud.aiplatform.v1beta1.ReadTensorboardUsageRequest"; + }; + + return ReadTensorboardUsageRequest; + })(); + + v1beta1.ReadTensorboardUsageResponse = (function() { + + /** + * Properties of a ReadTensorboardUsageResponse. + * @memberof google.cloud.aiplatform.v1beta1 + * @interface IReadTensorboardUsageResponse + * @property {Object.|null} [monthlyUsageData] ReadTensorboardUsageResponse monthlyUsageData + */ + + /** + * Constructs a new ReadTensorboardUsageResponse. + * @memberof google.cloud.aiplatform.v1beta1 + * @classdesc Represents a ReadTensorboardUsageResponse. + * @implements IReadTensorboardUsageResponse + * @constructor + * @param {google.cloud.aiplatform.v1beta1.IReadTensorboardUsageResponse=} [properties] Properties to set + */ + function ReadTensorboardUsageResponse(properties) { + this.monthlyUsageData = {}; + if (properties) + for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) + if (properties[keys[i]] != null) + this[keys[i]] = properties[keys[i]]; + } + + /** + * ReadTensorboardUsageResponse monthlyUsageData. + * @member {Object.} monthlyUsageData + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse + * @instance + */ + ReadTensorboardUsageResponse.prototype.monthlyUsageData = $util.emptyObject; + + /** + * Creates a new ReadTensorboardUsageResponse instance using the specified properties. + * @function create + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse + * @static + * @param {google.cloud.aiplatform.v1beta1.IReadTensorboardUsageResponse=} [properties] Properties to set + * @returns {google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse} ReadTensorboardUsageResponse instance + */ + ReadTensorboardUsageResponse.create = function create(properties) { + return new ReadTensorboardUsageResponse(properties); + }; + + /** + * Encodes the specified ReadTensorboardUsageResponse message. Does not implicitly {@link google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.verify|verify} messages. + * @function encode + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse + * @static + * @param {google.cloud.aiplatform.v1beta1.IReadTensorboardUsageResponse} message ReadTensorboardUsageResponse message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + ReadTensorboardUsageResponse.encode = function encode(message, writer) { + if (!writer) + writer = $Writer.create(); + if (message.monthlyUsageData != null && Object.hasOwnProperty.call(message, "monthlyUsageData")) + for (var keys = Object.keys(message.monthlyUsageData), i = 0; i < keys.length; ++i) { + writer.uint32(/* id 1, wireType 2 =*/10).fork().uint32(/* id 1, wireType 2 =*/10).string(keys[i]); + $root.google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerMonthUsageData.encode(message.monthlyUsageData[keys[i]], writer.uint32(/* id 2, wireType 2 =*/18).fork()).ldelim().ldelim(); + } + return writer; + }; + + /** + * Encodes the specified ReadTensorboardUsageResponse message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.verify|verify} messages. + * @function encodeDelimited + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse + * @static + * @param {google.cloud.aiplatform.v1beta1.IReadTensorboardUsageResponse} message ReadTensorboardUsageResponse message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + ReadTensorboardUsageResponse.encodeDelimited = function encodeDelimited(message, writer) { + return this.encode(message, writer).ldelim(); + }; + + /** + * Decodes a ReadTensorboardUsageResponse message from the specified reader or buffer. + * @function decode + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @param {number} [length] Message length if known beforehand + * @returns {google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse} ReadTensorboardUsageResponse + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + ReadTensorboardUsageResponse.decode = function decode(reader, length) { + if (!(reader instanceof $Reader)) + reader = $Reader.create(reader); + var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse(), key, value; + while (reader.pos < end) { + var tag = reader.uint32(); + switch (tag >>> 3) { + case 1: { + if (message.monthlyUsageData === $util.emptyObject) + message.monthlyUsageData = {}; + var end2 = reader.uint32() + reader.pos; + key = ""; + value = null; + while (reader.pos < end2) { + var tag2 = reader.uint32(); + switch (tag2 >>> 3) { + case 1: + key = reader.string(); + break; + case 2: + value = $root.google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerMonthUsageData.decode(reader, reader.uint32()); + break; + default: + reader.skipType(tag2 & 7); + break; + } + } + message.monthlyUsageData[key] = value; + break; + } + default: + reader.skipType(tag & 7); + break; + } + } + return message; + }; + + /** + * Decodes a ReadTensorboardUsageResponse message from the specified reader or buffer, length delimited. + * @function decodeDelimited + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @returns {google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse} ReadTensorboardUsageResponse + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + ReadTensorboardUsageResponse.decodeDelimited = function decodeDelimited(reader) { + if (!(reader instanceof $Reader)) + reader = new $Reader(reader); + return this.decode(reader, reader.uint32()); + }; + + /** + * Verifies a ReadTensorboardUsageResponse message. + * @function verify + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse + * @static + * @param {Object.} message Plain object to verify + * @returns {string|null} `null` if valid, otherwise the reason why it is not + */ + ReadTensorboardUsageResponse.verify = function verify(message) { + if (typeof message !== "object" || message === null) + return "object expected"; + if (message.monthlyUsageData != null && message.hasOwnProperty("monthlyUsageData")) { + if (!$util.isObject(message.monthlyUsageData)) + return "monthlyUsageData: object expected"; + var key = Object.keys(message.monthlyUsageData); + for (var i = 0; i < key.length; ++i) { + var error = $root.google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerMonthUsageData.verify(message.monthlyUsageData[key[i]]); + if (error) + return "monthlyUsageData." + error; + } + } + return null; + }; + + /** + * Creates a ReadTensorboardUsageResponse message from a plain object. Also converts values to their respective internal types. + * @function fromObject + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse + * @static + * @param {Object.} object Plain object + * @returns {google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse} ReadTensorboardUsageResponse + */ + ReadTensorboardUsageResponse.fromObject = function fromObject(object) { + if (object instanceof $root.google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse) + return object; + var message = new $root.google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse(); + if (object.monthlyUsageData) { + if (typeof object.monthlyUsageData !== "object") + throw TypeError(".google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.monthlyUsageData: object expected"); + message.monthlyUsageData = {}; + for (var keys = Object.keys(object.monthlyUsageData), i = 0; i < keys.length; ++i) { + if (typeof object.monthlyUsageData[keys[i]] !== "object") + throw TypeError(".google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.monthlyUsageData: object expected"); + message.monthlyUsageData[keys[i]] = $root.google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerMonthUsageData.fromObject(object.monthlyUsageData[keys[i]]); + } + } + return message; + }; + + /** + * Creates a plain object from a ReadTensorboardUsageResponse message. Also converts values to other types if specified. + * @function toObject + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse + * @static + * @param {google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse} message ReadTensorboardUsageResponse + * @param {$protobuf.IConversionOptions} [options] Conversion options + * @returns {Object.} Plain object + */ + ReadTensorboardUsageResponse.toObject = function toObject(message, options) { + if (!options) + options = {}; + var object = {}; + if (options.objects || options.defaults) + object.monthlyUsageData = {}; + var keys2; + if (message.monthlyUsageData && (keys2 = Object.keys(message.monthlyUsageData)).length) { + object.monthlyUsageData = {}; + for (var j = 0; j < keys2.length; ++j) + object.monthlyUsageData[keys2[j]] = $root.google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerMonthUsageData.toObject(message.monthlyUsageData[keys2[j]], options); + } + return object; + }; + + /** + * Converts this ReadTensorboardUsageResponse to JSON. + * @function toJSON + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse + * @instance + * @returns {Object.} JSON object + */ + ReadTensorboardUsageResponse.prototype.toJSON = function toJSON() { + return this.constructor.toObject(this, $protobuf.util.toJSONOptions); + }; + + /** + * Gets the default type url for ReadTensorboardUsageResponse + * @function getTypeUrl + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse + * @static + * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns {string} The default type url + */ + ReadTensorboardUsageResponse.getTypeUrl = function getTypeUrl(typeUrlPrefix) { + if (typeUrlPrefix === undefined) { + typeUrlPrefix = "type.googleapis.com"; + } + return typeUrlPrefix + "/google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse"; + }; + + ReadTensorboardUsageResponse.PerUserUsageData = (function() { + + /** + * Properties of a PerUserUsageData. + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse + * @interface IPerUserUsageData + * @property {string|null} [username] PerUserUsageData username + * @property {number|Long|null} [viewCount] PerUserUsageData viewCount + */ + + /** + * Constructs a new PerUserUsageData. + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse + * @classdesc Represents a PerUserUsageData. + * @implements IPerUserUsageData + * @constructor + * @param {google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.IPerUserUsageData=} [properties] Properties to set + */ + function PerUserUsageData(properties) { + if (properties) + for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) + if (properties[keys[i]] != null) + this[keys[i]] = properties[keys[i]]; + } + + /** + * PerUserUsageData username. + * @member {string} username + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerUserUsageData + * @instance + */ + PerUserUsageData.prototype.username = ""; + + /** + * PerUserUsageData viewCount. + * @member {number|Long} viewCount + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerUserUsageData + * @instance + */ + PerUserUsageData.prototype.viewCount = $util.Long ? $util.Long.fromBits(0,0,false) : 0; + + /** + * Creates a new PerUserUsageData instance using the specified properties. + * @function create + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerUserUsageData + * @static + * @param {google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.IPerUserUsageData=} [properties] Properties to set + * @returns {google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerUserUsageData} PerUserUsageData instance + */ + PerUserUsageData.create = function create(properties) { + return new PerUserUsageData(properties); + }; + + /** + * Encodes the specified PerUserUsageData message. Does not implicitly {@link google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerUserUsageData.verify|verify} messages. + * @function encode + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerUserUsageData + * @static + * @param {google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.IPerUserUsageData} message PerUserUsageData message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + PerUserUsageData.encode = function encode(message, writer) { + if (!writer) + writer = $Writer.create(); + if (message.username != null && Object.hasOwnProperty.call(message, "username")) + writer.uint32(/* id 1, wireType 2 =*/10).string(message.username); + if (message.viewCount != null && Object.hasOwnProperty.call(message, "viewCount")) + writer.uint32(/* id 2, wireType 0 =*/16).int64(message.viewCount); + return writer; + }; + + /** + * Encodes the specified PerUserUsageData message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerUserUsageData.verify|verify} messages. + * @function encodeDelimited + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerUserUsageData + * @static + * @param {google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.IPerUserUsageData} message PerUserUsageData message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + PerUserUsageData.encodeDelimited = function encodeDelimited(message, writer) { + return this.encode(message, writer).ldelim(); + }; + + /** + * Decodes a PerUserUsageData message from the specified reader or buffer. + * @function decode + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerUserUsageData + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @param {number} [length] Message length if known beforehand + * @returns {google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerUserUsageData} PerUserUsageData + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + PerUserUsageData.decode = function decode(reader, length) { + if (!(reader instanceof $Reader)) + reader = $Reader.create(reader); + var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerUserUsageData(); + while (reader.pos < end) { + var tag = reader.uint32(); + switch (tag >>> 3) { + case 1: { + message.username = reader.string(); + break; + } + case 2: { + message.viewCount = reader.int64(); + break; + } + default: + reader.skipType(tag & 7); + break; + } + } + return message; + }; + + /** + * Decodes a PerUserUsageData message from the specified reader or buffer, length delimited. + * @function decodeDelimited + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerUserUsageData + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @returns {google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerUserUsageData} PerUserUsageData + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + PerUserUsageData.decodeDelimited = function decodeDelimited(reader) { + if (!(reader instanceof $Reader)) + reader = new $Reader(reader); + return this.decode(reader, reader.uint32()); + }; + + /** + * Verifies a PerUserUsageData message. + * @function verify + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerUserUsageData + * @static + * @param {Object.} message Plain object to verify + * @returns {string|null} `null` if valid, otherwise the reason why it is not + */ + PerUserUsageData.verify = function verify(message) { + if (typeof message !== "object" || message === null) + return "object expected"; + if (message.username != null && message.hasOwnProperty("username")) + if (!$util.isString(message.username)) + return "username: string expected"; + if (message.viewCount != null && message.hasOwnProperty("viewCount")) + if (!$util.isInteger(message.viewCount) && !(message.viewCount && $util.isInteger(message.viewCount.low) && $util.isInteger(message.viewCount.high))) + return "viewCount: integer|Long expected"; + return null; + }; + + /** + * Creates a PerUserUsageData message from a plain object. Also converts values to their respective internal types. + * @function fromObject + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerUserUsageData + * @static + * @param {Object.} object Plain object + * @returns {google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerUserUsageData} PerUserUsageData + */ + PerUserUsageData.fromObject = function fromObject(object) { + if (object instanceof $root.google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerUserUsageData) + return object; + var message = new $root.google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerUserUsageData(); + if (object.username != null) + message.username = String(object.username); + if (object.viewCount != null) + if ($util.Long) + (message.viewCount = $util.Long.fromValue(object.viewCount)).unsigned = false; + else if (typeof object.viewCount === "string") + message.viewCount = parseInt(object.viewCount, 10); + else if (typeof object.viewCount === "number") + message.viewCount = object.viewCount; + else if (typeof object.viewCount === "object") + message.viewCount = new $util.LongBits(object.viewCount.low >>> 0, object.viewCount.high >>> 0).toNumber(); + return message; + }; + + /** + * Creates a plain object from a PerUserUsageData message. Also converts values to other types if specified. + * @function toObject + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerUserUsageData + * @static + * @param {google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerUserUsageData} message PerUserUsageData + * @param {$protobuf.IConversionOptions} [options] Conversion options + * @returns {Object.} Plain object + */ + PerUserUsageData.toObject = function toObject(message, options) { + if (!options) + options = {}; + var object = {}; + if (options.defaults) { + object.username = ""; + if ($util.Long) { + var long = new $util.Long(0, 0, false); + object.viewCount = options.longs === String ? long.toString() : options.longs === Number ? long.toNumber() : long; + } else + object.viewCount = options.longs === String ? "0" : 0; + } + if (message.username != null && message.hasOwnProperty("username")) + object.username = message.username; + if (message.viewCount != null && message.hasOwnProperty("viewCount")) + if (typeof message.viewCount === "number") + object.viewCount = options.longs === String ? String(message.viewCount) : message.viewCount; + else + object.viewCount = options.longs === String ? $util.Long.prototype.toString.call(message.viewCount) : options.longs === Number ? new $util.LongBits(message.viewCount.low >>> 0, message.viewCount.high >>> 0).toNumber() : message.viewCount; + return object; + }; + + /** + * Converts this PerUserUsageData to JSON. + * @function toJSON + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerUserUsageData + * @instance + * @returns {Object.} JSON object + */ + PerUserUsageData.prototype.toJSON = function toJSON() { + return this.constructor.toObject(this, $protobuf.util.toJSONOptions); + }; + + /** + * Gets the default type url for PerUserUsageData + * @function getTypeUrl + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerUserUsageData + * @static + * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns {string} The default type url + */ + PerUserUsageData.getTypeUrl = function getTypeUrl(typeUrlPrefix) { + if (typeUrlPrefix === undefined) { + typeUrlPrefix = "type.googleapis.com"; + } + return typeUrlPrefix + "/google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerUserUsageData"; + }; + + return PerUserUsageData; + })(); + + ReadTensorboardUsageResponse.PerMonthUsageData = (function() { + + /** + * Properties of a PerMonthUsageData. + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse + * @interface IPerMonthUsageData + * @property {Array.|null} [userUsageData] PerMonthUsageData userUsageData + */ + + /** + * Constructs a new PerMonthUsageData. + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse + * @classdesc Represents a PerMonthUsageData. + * @implements IPerMonthUsageData + * @constructor + * @param {google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.IPerMonthUsageData=} [properties] Properties to set + */ + function PerMonthUsageData(properties) { + this.userUsageData = []; + if (properties) + for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i) + if (properties[keys[i]] != null) + this[keys[i]] = properties[keys[i]]; + } + + /** + * PerMonthUsageData userUsageData. + * @member {Array.} userUsageData + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerMonthUsageData + * @instance + */ + PerMonthUsageData.prototype.userUsageData = $util.emptyArray; + + /** + * Creates a new PerMonthUsageData instance using the specified properties. + * @function create + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerMonthUsageData + * @static + * @param {google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.IPerMonthUsageData=} [properties] Properties to set + * @returns {google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerMonthUsageData} PerMonthUsageData instance + */ + PerMonthUsageData.create = function create(properties) { + return new PerMonthUsageData(properties); + }; + + /** + * Encodes the specified PerMonthUsageData message. Does not implicitly {@link google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerMonthUsageData.verify|verify} messages. + * @function encode + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerMonthUsageData + * @static + * @param {google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.IPerMonthUsageData} message PerMonthUsageData message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + PerMonthUsageData.encode = function encode(message, writer) { + if (!writer) + writer = $Writer.create(); + if (message.userUsageData != null && message.userUsageData.length) + for (var i = 0; i < message.userUsageData.length; ++i) + $root.google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerUserUsageData.encode(message.userUsageData[i], writer.uint32(/* id 1, wireType 2 =*/10).fork()).ldelim(); + return writer; + }; + + /** + * Encodes the specified PerMonthUsageData message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerMonthUsageData.verify|verify} messages. + * @function encodeDelimited + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerMonthUsageData + * @static + * @param {google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.IPerMonthUsageData} message PerMonthUsageData message or plain object to encode + * @param {$protobuf.Writer} [writer] Writer to encode to + * @returns {$protobuf.Writer} Writer + */ + PerMonthUsageData.encodeDelimited = function encodeDelimited(message, writer) { + return this.encode(message, writer).ldelim(); + }; + + /** + * Decodes a PerMonthUsageData message from the specified reader or buffer. + * @function decode + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerMonthUsageData + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @param {number} [length] Message length if known beforehand + * @returns {google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerMonthUsageData} PerMonthUsageData + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + PerMonthUsageData.decode = function decode(reader, length) { + if (!(reader instanceof $Reader)) + reader = $Reader.create(reader); + var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerMonthUsageData(); + while (reader.pos < end) { + var tag = reader.uint32(); + switch (tag >>> 3) { + case 1: { + if (!(message.userUsageData && message.userUsageData.length)) + message.userUsageData = []; + message.userUsageData.push($root.google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerUserUsageData.decode(reader, reader.uint32())); + break; + } + default: + reader.skipType(tag & 7); + break; + } + } + return message; + }; + + /** + * Decodes a PerMonthUsageData message from the specified reader or buffer, length delimited. + * @function decodeDelimited + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerMonthUsageData + * @static + * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from + * @returns {google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerMonthUsageData} PerMonthUsageData + * @throws {Error} If the payload is not a reader or valid buffer + * @throws {$protobuf.util.ProtocolError} If required fields are missing + */ + PerMonthUsageData.decodeDelimited = function decodeDelimited(reader) { + if (!(reader instanceof $Reader)) + reader = new $Reader(reader); + return this.decode(reader, reader.uint32()); + }; + + /** + * Verifies a PerMonthUsageData message. + * @function verify + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerMonthUsageData + * @static + * @param {Object.} message Plain object to verify + * @returns {string|null} `null` if valid, otherwise the reason why it is not + */ + PerMonthUsageData.verify = function verify(message) { + if (typeof message !== "object" || message === null) + return "object expected"; + if (message.userUsageData != null && message.hasOwnProperty("userUsageData")) { + if (!Array.isArray(message.userUsageData)) + return "userUsageData: array expected"; + for (var i = 0; i < message.userUsageData.length; ++i) { + var error = $root.google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerUserUsageData.verify(message.userUsageData[i]); + if (error) + return "userUsageData." + error; + } + } + return null; + }; + + /** + * Creates a PerMonthUsageData message from a plain object. Also converts values to their respective internal types. + * @function fromObject + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerMonthUsageData + * @static + * @param {Object.} object Plain object + * @returns {google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerMonthUsageData} PerMonthUsageData + */ + PerMonthUsageData.fromObject = function fromObject(object) { + if (object instanceof $root.google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerMonthUsageData) + return object; + var message = new $root.google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerMonthUsageData(); + if (object.userUsageData) { + if (!Array.isArray(object.userUsageData)) + throw TypeError(".google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerMonthUsageData.userUsageData: array expected"); + message.userUsageData = []; + for (var i = 0; i < object.userUsageData.length; ++i) { + if (typeof object.userUsageData[i] !== "object") + throw TypeError(".google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerMonthUsageData.userUsageData: object expected"); + message.userUsageData[i] = $root.google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerUserUsageData.fromObject(object.userUsageData[i]); + } + } + return message; + }; + + /** + * Creates a plain object from a PerMonthUsageData message. Also converts values to other types if specified. + * @function toObject + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerMonthUsageData + * @static + * @param {google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerMonthUsageData} message PerMonthUsageData + * @param {$protobuf.IConversionOptions} [options] Conversion options + * @returns {Object.} Plain object + */ + PerMonthUsageData.toObject = function toObject(message, options) { + if (!options) + options = {}; + var object = {}; + if (options.arrays || options.defaults) + object.userUsageData = []; + if (message.userUsageData && message.userUsageData.length) { + object.userUsageData = []; + for (var j = 0; j < message.userUsageData.length; ++j) + object.userUsageData[j] = $root.google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerUserUsageData.toObject(message.userUsageData[j], options); + } + return object; + }; + + /** + * Converts this PerMonthUsageData to JSON. + * @function toJSON + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerMonthUsageData + * @instance + * @returns {Object.} JSON object + */ + PerMonthUsageData.prototype.toJSON = function toJSON() { + return this.constructor.toObject(this, $protobuf.util.toJSONOptions); + }; + + /** + * Gets the default type url for PerMonthUsageData + * @function getTypeUrl + * @memberof google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerMonthUsageData + * @static + * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") + * @returns {string} The default type url + */ + PerMonthUsageData.getTypeUrl = function getTypeUrl(typeUrlPrefix) { + if (typeUrlPrefix === undefined) { + typeUrlPrefix = "type.googleapis.com"; + } + return typeUrlPrefix + "/google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse.PerMonthUsageData"; + }; + + return PerMonthUsageData; + })(); + + return ReadTensorboardUsageResponse; + })(); + v1beta1.ListTensorboardsRequest = (function() { /** diff --git a/packages/google-cloud-aiplatform/protos/protos.json b/packages/google-cloud-aiplatform/protos/protos.json index 089aa119715..f2be2cf4b74 100644 --- a/packages/google-cloud-aiplatform/protos/protos.json +++ b/packages/google-cloud-aiplatform/protos/protos.json @@ -284,6 +284,10 @@ "(google.api.field_behavior)": "REQUIRED" } }, + "instanceConfig": { + "type": "InstanceConfig", + "id": 27 + }, "modelParameters": { "type": "google.protobuf.Value", "id": 5 @@ -299,6 +303,10 @@ "type": "BatchDedicatedResources", "id": 7 }, + "serviceAccount": { + "type": "string", + "id": 29 + }, "manualBatchTuningParameters": { "type": "ManualBatchTuningParameters", "id": 8, @@ -423,6 +431,28 @@ } } }, + "InstanceConfig": { + "fields": { + "instanceType": { + "type": "string", + "id": 1 + }, + "keyField": { + "type": "string", + "id": 2 + }, + "includedFields": { + "rule": "repeated", + "type": "string", + "id": 3 + }, + "excludedFields": { + "rule": "repeated", + "type": "string", + "id": 4 + } + } + }, "OutputConfig": { "oneofs": { "destination": { @@ -1559,6 +1589,13 @@ "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } + }, + "metadataArtifact": { + "type": "string", + "id": 44, + "options": { + "(google.api.field_behavior)": "OUTPUT_ONLY" + } } }, "nested": { @@ -1952,6 +1989,13 @@ "options": { "(google.api.field_behavior)": "OPTIONAL" } + }, + "enableDashboardAccess": { + "type": "bool", + "id": 16, + "options": { + "(google.api.field_behavior)": "OPTIONAL" + } } } }, @@ -2344,10 +2388,7 @@ }, "description": { "type": "string", - "id": 16, - "options": { - "(google.api.field_behavior)": "OPTIONAL" - } + "id": 16 }, "metadataSchemaUri": { "type": "string", @@ -2386,9 +2427,21 @@ "type": "string", "id": 7 }, + "savedQueries": { + "rule": "repeated", + "type": "SavedQuery", + "id": 9 + }, "encryptionSpec": { "type": "EncryptionSpec", "id": 11 + }, + "metadataArtifact": { + "type": "string", + "id": 17, + "options": { + "(google.api.field_behavior)": "OUTPUT_ONLY" + } } } }, @@ -2410,6 +2463,11 @@ "type": "string", "id": 2 }, + "annotationLabels": { + "keyType": "string", + "type": "string", + "id": 3 + }, "importSchemaUri": { "type": "string", "id": 4, @@ -2438,6 +2496,78 @@ } } }, + "SavedQuery": { + "options": { + "(google.api.resource).type": "aiplatform.googleapis.com/SavedQuery", + "(google.api.resource).pattern": "projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}" + }, + "fields": { + "name": { + "type": "string", + "id": 1, + "options": { + "(google.api.field_behavior)": "OUTPUT_ONLY" + } + }, + "displayName": { + "type": "string", + "id": 2, + "options": { + "(google.api.field_behavior)": "REQUIRED" + } + }, + "metadata": { + "type": "google.protobuf.Value", + "id": 12 + }, + "createTime": { + "type": "google.protobuf.Timestamp", + "id": 3, + "options": { + "(google.api.field_behavior)": "OUTPUT_ONLY" + } + }, + "updateTime": { + "type": "google.protobuf.Timestamp", + "id": 4, + "options": { + "(google.api.field_behavior)": "OUTPUT_ONLY" + } + }, + "annotationFilter": { + "type": "string", + "id": 5, + "options": { + "(google.api.field_behavior)": "OUTPUT_ONLY" + } + }, + "problemType": { + "type": "string", + "id": 6, + "options": { + "(google.api.field_behavior)": "REQUIRED" + } + }, + "annotationSpecCount": { + "type": "int32", + "id": 10, + "options": { + "(google.api.field_behavior)": "OUTPUT_ONLY" + } + }, + "etag": { + "type": "string", + "id": 8 + }, + "supportAutomlTraining": { + "type": "bool", + "id": 9, + "options": { + "(google.api.field_behavior)": "OUTPUT_ONLY" + } + } + } + }, "DatasetService": { "options": { "(google.api.default_host)": "aiplatform.googleapis.com", @@ -2628,6 +2758,20 @@ } ] }, + "SearchDataItems": { + "requestType": "SearchDataItemsRequest", + "responseType": "SearchDataItemsResponse", + "options": { + "(google.api.http).get": "/v1/{dataset=projects/*/locations/*/datasets/*}:searchDataItems" + }, + "parsedOptions": [ + { + "(google.api.http)": { + "get": "/v1/{dataset=projects/*/locations/*/datasets/*}:searchDataItems" + } + } + ] + }, "ListSavedQueries": { "requestType": "ListSavedQueriesRequest", "responseType": "ListSavedQueriesResponse", @@ -2918,6 +3062,132 @@ } } }, + "SearchDataItemsRequest": { + "oneofs": { + "order": { + "oneof": [ + "orderByDataItem", + "orderByAnnotation" + ] + } + }, + "fields": { + "orderByDataItem": { + "type": "string", + "id": 12 + }, + "orderByAnnotation": { + "type": "OrderByAnnotation", + "id": 13 + }, + "dataset": { + "type": "string", + "id": 1, + "options": { + "(google.api.field_behavior)": "REQUIRED", + "(google.api.resource_reference).type": "aiplatform.googleapis.com/Dataset" + } + }, + "savedQuery": { + "type": "string", + "id": 2, + "options": { + "deprecated": true, + "(google.api.resource_reference).type": "aiplatform.googleapis.com/SavedQuery" + } + }, + "dataLabelingJob": { + "type": "string", + "id": 3 + }, + "dataItemFilter": { + "type": "string", + "id": 4 + }, + "annotationsFilter": { + "type": "string", + "id": 5, + "options": { + "deprecated": true + } + }, + "annotationFilters": { + "rule": "repeated", + "type": "string", + "id": 11 + }, + "fieldMask": { + "type": "google.protobuf.FieldMask", + "id": 6 + }, + "annotationsLimit": { + "type": "int32", + "id": 7 + }, + "pageSize": { + "type": "int32", + "id": 8 + }, + "orderBy": { + "type": "string", + "id": 9, + "options": { + "deprecated": true + } + }, + "pageToken": { + "type": "string", + "id": 10 + } + }, + "nested": { + "OrderByAnnotation": { + "fields": { + "savedQuery": { + "type": "string", + "id": 1, + "options": { + "(google.api.field_behavior)": "REQUIRED" + } + }, + "orderBy": { + "type": "string", + "id": 2 + } + } + } + } + }, + "SearchDataItemsResponse": { + "fields": { + "dataItemViews": { + "rule": "repeated", + "type": "DataItemView", + "id": 1 + }, + "nextPageToken": { + "type": "string", + "id": 2 + } + } + }, + "DataItemView": { + "fields": { + "dataItem": { + "type": "DataItem", + "id": 1 + }, + "annotations": { + "rule": "repeated", + "type": "Annotation", + "id": 2 + }, + "hasTruncatedAnnotations": { + "type": "bool", + "id": 3 + } + } + }, "ListSavedQueriesRequest": { "fields": { "parent": { @@ -3058,78 +3328,6 @@ } } }, - "SavedQuery": { - "options": { - "(google.api.resource).type": "aiplatform.googleapis.com/SavedQuery", - "(google.api.resource).pattern": "projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}" - }, - "fields": { - "name": { - "type": "string", - "id": 1, - "options": { - "(google.api.field_behavior)": "OUTPUT_ONLY" - } - }, - "displayName": { - "type": "string", - "id": 2, - "options": { - "(google.api.field_behavior)": "REQUIRED" - } - }, - "metadata": { - "type": "google.protobuf.Value", - "id": 12 - }, - "createTime": { - "type": "google.protobuf.Timestamp", - "id": 3, - "options": { - "(google.api.field_behavior)": "OUTPUT_ONLY" - } - }, - "updateTime": { - "type": "google.protobuf.Timestamp", - "id": 4, - "options": { - "(google.api.field_behavior)": "OUTPUT_ONLY" - } - }, - "annotationFilter": { - "type": "string", - "id": 5, - "options": { - "(google.api.field_behavior)": "OUTPUT_ONLY" - } - }, - "problemType": { - "type": "string", - "id": 6, - "options": { - "(google.api.field_behavior)": "REQUIRED" - } - }, - "annotationSpecCount": { - "type": "int32", - "id": 10, - "options": { - "(google.api.field_behavior)": "OUTPUT_ONLY" - } - }, - "etag": { - "type": "string", - "id": 8 - }, - "supportAutomlTraining": { - "type": "bool", - "id": 9, - "options": { - "(google.api.field_behavior)": "OUTPUT_ONLY" - } - } - } - }, "DeployedIndexRef": { "fields": { "indexEndpoint": { @@ -4328,9 +4526,71 @@ "(google.api.method_signature)": "entity_type" } ] + }, + "WriteFeatureValues": { + "requestType": "WriteFeatureValuesRequest", + "responseType": "WriteFeatureValuesResponse", + "options": { + "(google.api.http).post": "/v1/{entity_type=projects/*/locations/*/featurestores/*/entityTypes/*}:writeFeatureValues", + "(google.api.http).body": "*", + "(google.api.method_signature)": "entity_type,payloads" + }, + "parsedOptions": [ + { + "(google.api.http)": { + "post": "/v1/{entity_type=projects/*/locations/*/featurestores/*/entityTypes/*}:writeFeatureValues", + "body": "*" + } + }, + { + "(google.api.method_signature)": "entity_type,payloads" + } + ] + } + } + }, + "WriteFeatureValuesRequest": { + "fields": { + "entityType": { + "type": "string", + "id": 1, + "options": { + "(google.api.field_behavior)": "REQUIRED", + "(google.api.resource_reference).type": "aiplatform.googleapis.com/EntityType" + } + }, + "payloads": { + "rule": "repeated", + "type": "WriteFeatureValuesPayload", + "id": 2, + "options": { + "(google.api.field_behavior)": "REQUIRED" + } + } + } + }, + "WriteFeatureValuesPayload": { + "fields": { + "entityId": { + "type": "string", + "id": 1, + "options": { + "(google.api.field_behavior)": "REQUIRED" + } + }, + "featureValues": { + "keyType": "string", + "type": "FeatureValue", + "id": 2, + "options": { + "(google.api.field_behavior)": "REQUIRED" + } } } }, + "WriteFeatureValuesResponse": { + "fields": {} + }, "ReadFeatureValuesRequest": { "fields": { "entityType": { @@ -5332,6 +5592,13 @@ "options": { "(google.api.field_behavior)": "REQUIRED" } + }, + "startTime": { + "type": "google.protobuf.Timestamp", + "id": 11, + "options": { + "(google.api.field_behavior)": "OPTIONAL" + } } }, "nested": { @@ -5811,6 +6078,11 @@ "type": "int64", "id": 3 }, + "sourceUris": { + "rule": "repeated", + "type": "string", + "id": 4 + }, "invalidRowCount": { "type": "int64", "id": 6 @@ -6499,6 +6771,13 @@ } }, "ConvexAutomatedStoppingSpec": { + "oneofs": { + "_updateAllStoppedTrials": { + "oneof": [ + "updateAllStoppedTrials" + ] + } + }, "fields": { "maxStepCount": { "type": "int64", @@ -6519,6 +6798,13 @@ "useElapsedDuration": { "type": "bool", "id": 5 + }, + "updateAllStoppedTrials": { + "type": "bool", + "id": 6, + "options": { + "proto3_optional": true + } } } }, @@ -12051,6 +12337,13 @@ "options": { "(google.api.field_behavior)": "REQUIRED" } + }, + "serviceAccount": { + "type": "string", + "id": 6, + "options": { + "(google.api.field_behavior)": "OPTIONAL" + } } } }, @@ -12162,6 +12455,10 @@ "readMask": { "type": "google.protobuf.FieldMask", "id": 5 + }, + "orderBy": { + "type": "string", + "id": 6 } } }, @@ -12867,6 +13164,22 @@ "(google.api.field_behavior)": "OUTPUT_ONLY", "(google.api.resource_reference).type": "aiplatform.googleapis.com/CustomJob" } + }, + "failedMainJobs": { + "rule": "repeated", + "type": "string", + "id": 3, + "options": { + "(google.api.field_behavior)": "OUTPUT_ONLY" + } + }, + "failedPreCachingCheckJobs": { + "rule": "repeated", + "type": "string", + "id": 4, + "options": { + "(google.api.field_behavior)": "OUTPUT_ONLY" + } } } }, @@ -13518,6 +13831,10 @@ "savedQueryId": { "type": "string", "id": 7 + }, + "persistMlUseAssignment": { + "type": "bool", + "id": 11 } } }, @@ -15598,6 +15915,24 @@ } ] }, + "ReadTensorboardUsage": { + "requestType": "ReadTensorboardUsageRequest", + "responseType": "ReadTensorboardUsageResponse", + "options": { + "(google.api.http).get": "/v1/{tensorboard=projects/*/locations/*/tensorboards/*}:readUsage", + "(google.api.method_signature)": "tensorboard" + }, + "parsedOptions": [ + { + "(google.api.http)": { + "get": "/v1/{tensorboard=projects/*/locations/*/tensorboards/*}:readUsage" + } + }, + { + "(google.api.method_signature)": "tensorboard" + } + ] + }, "UpdateTensorboard": { "requestType": "UpdateTensorboardRequest", "responseType": "google.longrunning.Operation", @@ -16164,6 +16499,50 @@ } } }, + "ReadTensorboardUsageRequest": { + "fields": { + "tensorboard": { + "type": "string", + "id": 1, + "options": { + "(google.api.field_behavior)": "REQUIRED", + "(google.api.resource_reference).type": "aiplatform.googleapis.com/Tensorboard" + } + } + } + }, + "ReadTensorboardUsageResponse": { + "fields": { + "monthlyUsageData": { + "keyType": "string", + "type": "PerMonthUsageData", + "id": 1 + } + }, + "nested": { + "PerUserUsageData": { + "fields": { + "username": { + "type": "string", + "id": 1 + }, + "viewCount": { + "type": "int64", + "id": 2 + } + } + }, + "PerMonthUsageData": { + "fields": { + "userUsageData": { + "rule": "repeated", + "type": "PerUserUsageData", + "id": 1 + } + } + } + } + }, "ListTensorboardsRequest": { "fields": { "parent": { @@ -17499,6 +17878,7 @@ "NVIDIA_TESLA_P4": 4, "NVIDIA_TESLA_T4": 5, "NVIDIA_TESLA_A100": 8, + "NVIDIA_A100_80GB": 9, "TPU_V2": 6, "TPU_V3": 7 } @@ -17755,6 +18135,10 @@ "(google.api.field_behavior)": "REQUIRED" } }, + "instanceConfig": { + "type": "InstanceConfig", + "id": 27 + }, "modelParameters": { "type": "google.protobuf.Value", "id": 5 @@ -17914,6 +18298,28 @@ } } }, + "InstanceConfig": { + "fields": { + "instanceType": { + "type": "string", + "id": 1 + }, + "keyField": { + "type": "string", + "id": 2 + }, + "includedFields": { + "rule": "repeated", + "type": "string", + "id": 3 + }, + "excludedFields": { + "rule": "repeated", + "type": "string", + "id": 4 + } + } + }, "OutputConfig": { "oneofs": { "destination": { @@ -19662,6 +20068,13 @@ "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } + }, + "metadataArtifact": { + "type": "string", + "id": 44, + "options": { + "(google.api.field_behavior)": "OUTPUT_ONLY" + } } }, "nested": { @@ -20055,6 +20468,13 @@ "options": { "(google.api.field_behavior)": "OPTIONAL" } + }, + "enableDashboardAccess": { + "type": "bool", + "id": 16, + "options": { + "(google.api.field_behavior)": "OPTIONAL" + } } } }, @@ -20447,10 +20867,7 @@ }, "description": { "type": "string", - "id": 16, - "options": { - "(google.api.field_behavior)": "OPTIONAL" - } + "id": 16 }, "metadataSchemaUri": { "type": "string", @@ -20489,9 +20906,21 @@ "type": "string", "id": 7 }, + "savedQueries": { + "rule": "repeated", + "type": "SavedQuery", + "id": 9 + }, "encryptionSpec": { "type": "EncryptionSpec", "id": 11 + }, + "metadataArtifact": { + "type": "string", + "id": 17, + "options": { + "(google.api.field_behavior)": "OUTPUT_ONLY" + } } } }, @@ -20513,6 +20942,11 @@ "type": "string", "id": 2 }, + "annotationLabels": { + "keyType": "string", + "type": "string", + "id": 3 + }, "importSchemaUri": { "type": "string", "id": 4, @@ -20541,6 +20975,78 @@ } } }, + "SavedQuery": { + "options": { + "(google.api.resource).type": "aiplatform.googleapis.com/SavedQuery", + "(google.api.resource).pattern": "projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}" + }, + "fields": { + "name": { + "type": "string", + "id": 1, + "options": { + "(google.api.field_behavior)": "OUTPUT_ONLY" + } + }, + "displayName": { + "type": "string", + "id": 2, + "options": { + "(google.api.field_behavior)": "REQUIRED" + } + }, + "metadata": { + "type": "google.protobuf.Value", + "id": 12 + }, + "createTime": { + "type": "google.protobuf.Timestamp", + "id": 3, + "options": { + "(google.api.field_behavior)": "OUTPUT_ONLY" + } + }, + "updateTime": { + "type": "google.protobuf.Timestamp", + "id": 4, + "options": { + "(google.api.field_behavior)": "OUTPUT_ONLY" + } + }, + "annotationFilter": { + "type": "string", + "id": 5, + "options": { + "(google.api.field_behavior)": "OUTPUT_ONLY" + } + }, + "problemType": { + "type": "string", + "id": 6, + "options": { + "(google.api.field_behavior)": "REQUIRED" + } + }, + "annotationSpecCount": { + "type": "int32", + "id": 10, + "options": { + "(google.api.field_behavior)": "OUTPUT_ONLY" + } + }, + "etag": { + "type": "string", + "id": 8 + }, + "supportAutomlTraining": { + "type": "bool", + "id": 9, + "options": { + "(google.api.field_behavior)": "OUTPUT_ONLY" + } + } + } + }, "DatasetService": { "options": { "(google.api.default_host)": "aiplatform.googleapis.com", @@ -20731,6 +21237,20 @@ } ] }, + "SearchDataItems": { + "requestType": "SearchDataItemsRequest", + "responseType": "SearchDataItemsResponse", + "options": { + "(google.api.http).get": "/v1beta1/{dataset=projects/*/locations/*/datasets/*}:searchDataItems" + }, + "parsedOptions": [ + { + "(google.api.http)": { + "get": "/v1beta1/{dataset=projects/*/locations/*/datasets/*}:searchDataItems" + } + } + ] + }, "ListSavedQueries": { "requestType": "ListSavedQueriesRequest", "responseType": "ListSavedQueriesResponse", @@ -21021,6 +21541,132 @@ } } }, + "SearchDataItemsRequest": { + "oneofs": { + "order": { + "oneof": [ + "orderByDataItem", + "orderByAnnotation" + ] + } + }, + "fields": { + "orderByDataItem": { + "type": "string", + "id": 12 + }, + "orderByAnnotation": { + "type": "OrderByAnnotation", + "id": 13 + }, + "dataset": { + "type": "string", + "id": 1, + "options": { + "(google.api.field_behavior)": "REQUIRED", + "(google.api.resource_reference).type": "aiplatform.googleapis.com/Dataset" + } + }, + "savedQuery": { + "type": "string", + "id": 2, + "options": { + "deprecated": true, + "(google.api.resource_reference).type": "aiplatform.googleapis.com/SavedQuery" + } + }, + "dataLabelingJob": { + "type": "string", + "id": 3 + }, + "dataItemFilter": { + "type": "string", + "id": 4 + }, + "annotationsFilter": { + "type": "string", + "id": 5, + "options": { + "deprecated": true + } + }, + "annotationFilters": { + "rule": "repeated", + "type": "string", + "id": 11 + }, + "fieldMask": { + "type": "google.protobuf.FieldMask", + "id": 6 + }, + "annotationsLimit": { + "type": "int32", + "id": 7 + }, + "pageSize": { + "type": "int32", + "id": 8 + }, + "orderBy": { + "type": "string", + "id": 9, + "options": { + "deprecated": true + } + }, + "pageToken": { + "type": "string", + "id": 10 + } + }, + "nested": { + "OrderByAnnotation": { + "fields": { + "savedQuery": { + "type": "string", + "id": 1, + "options": { + "(google.api.field_behavior)": "REQUIRED" + } + }, + "orderBy": { + "type": "string", + "id": 2 + } + } + } + } + }, + "SearchDataItemsResponse": { + "fields": { + "dataItemViews": { + "rule": "repeated", + "type": "DataItemView", + "id": 1 + }, + "nextPageToken": { + "type": "string", + "id": 2 + } + } + }, + "DataItemView": { + "fields": { + "dataItem": { + "type": "DataItem", + "id": 1 + }, + "annotations": { + "rule": "repeated", + "type": "Annotation", + "id": 2 + }, + "hasTruncatedAnnotations": { + "type": "bool", + "id": 3 + } + } + }, "ListSavedQueriesRequest": { "fields": { "parent": { @@ -21161,78 +21807,6 @@ } } }, - "SavedQuery": { - "options": { - "(google.api.resource).type": "aiplatform.googleapis.com/SavedQuery", - "(google.api.resource).pattern": "projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}" - }, - "fields": { - "name": { - "type": "string", - "id": 1, - "options": { - "(google.api.field_behavior)": "OUTPUT_ONLY" - } - }, - "displayName": { - "type": "string", - "id": 2, - "options": { - "(google.api.field_behavior)": "REQUIRED" - } - }, - "metadata": { - "type": "google.protobuf.Value", - "id": 12 - }, - "createTime": { - "type": "google.protobuf.Timestamp", - "id": 3, - "options": { - "(google.api.field_behavior)": "OUTPUT_ONLY" - } - }, - "updateTime": { - "type": "google.protobuf.Timestamp", - "id": 4, - "options": { - "(google.api.field_behavior)": "OUTPUT_ONLY" - } - }, - "annotationFilter": { - "type": "string", - "id": 5, - "options": { - "(google.api.field_behavior)": "OUTPUT_ONLY" - } - }, - "problemType": { - "type": "string", - "id": 6, - "options": { - "(google.api.field_behavior)": "REQUIRED" - } - }, - "annotationSpecCount": { - "type": "int32", - "id": 10, - "options": { - "(google.api.field_behavior)": "OUTPUT_ONLY" - } - }, - "etag": { - "type": "string", - "id": 8 - }, - "supportAutomlTraining": { - "type": "bool", - "id": 9, - "options": { - "(google.api.field_behavior)": "OUTPUT_ONLY" - } - } - } - }, "DeployedIndexRef": { "fields": { "indexEndpoint": { @@ -21533,6 +22107,14 @@ "rule": "repeated", "type": "DeployedModelRef", "id": 3 + }, + "totalDeployedModelCount": { + "type": "int32", + "id": 4 + }, + "totalEndpointCount": { + "type": "int32", + "id": 5 } } }, @@ -22196,6 +22778,13 @@ "options": { "(google.api.field_behavior)": "OPTIONAL" } + }, + "offlineStorageTtlDays": { + "type": "int32", + "id": 10, + "options": { + "(google.api.field_behavior)": "OPTIONAL" + } } } }, @@ -22617,6 +23206,13 @@ "(google.api.field_behavior)": "OUTPUT_ONLY" } }, + "onlineStorageTtlDays": { + "type": "int32", + "id": 13, + "options": { + "(google.api.field_behavior)": "OPTIONAL" + } + }, "encryptionSpec": { "type": "EncryptionSpec", "id": 10, @@ -23804,6 +24400,13 @@ "options": { "(google.api.field_behavior)": "REQUIRED" } + }, + "startTime": { + "type": "google.protobuf.Timestamp", + "id": 11, + "options": { + "(google.api.field_behavior)": "OPTIONAL" + } } }, "nested": { @@ -24283,6 +24886,11 @@ "type": "int64", "id": 3 }, + "sourceUris": { + "rule": "repeated", + "type": "string", + "id": 4 + }, "invalidRowCount": { "type": "int64", "id": 6 @@ -25076,6 +25684,13 @@ } }, "ConvexAutomatedStoppingSpec": { + "oneofs": { + "_updateAllStoppedTrials": { + "oneof": [ + "updateAllStoppedTrials" + ] + } + }, "fields": { "maxStepCount": { "type": "int64", @@ -25096,6 +25711,13 @@ "useElapsedDuration": { "type": "bool", "id": 5 + }, + "updateAllStoppedTrials": { + "type": "bool", + "id": 6, + "options": { + "proto3_optional": true + } } } }, @@ -30203,6 +30825,13 @@ "options": { "(google.api.field_behavior)": "REQUIRED" } + }, + "serviceAccount": { + "type": "string", + "id": 6, + "options": { + "(google.api.field_behavior)": "OPTIONAL" + } } } }, @@ -30310,6 +30939,10 @@ "readMask": { "type": "google.protobuf.FieldMask", "id": 5 + }, + "orderBy": { + "type": "string", + "id": 6 } } }, @@ -31042,6 +31675,22 @@ "(google.api.field_behavior)": "OUTPUT_ONLY", "(google.api.resource_reference).type": "aiplatform.googleapis.com/CustomJob" } + }, + "failedMainJobs": { + "rule": "repeated", + "type": "string", + "id": 3, + "options": { + "(google.api.field_behavior)": "OUTPUT_ONLY" + } + }, + "failedPreCachingCheckJobs": { + "rule": "repeated", + "type": "string", + "id": 4, + "options": { + "(google.api.field_behavior)": "OUTPUT_ONLY" + } } } }, @@ -31693,6 +32342,10 @@ "savedQueryId": { "type": "string", "id": 7 + }, + "persistMlUseAssignment": { + "type": "bool", + "id": 11 } } }, @@ -34454,6 +35107,24 @@ } ] }, + "ReadTensorboardUsage": { + "requestType": "ReadTensorboardUsageRequest", + "responseType": "ReadTensorboardUsageResponse", + "options": { + "(google.api.http).get": "/v1beta1/{tensorboard=projects/*/locations/*/tensorboards/*}:readUsage", + "(google.api.method_signature)": "tensorboard" + }, + "parsedOptions": [ + { + "(google.api.http)": { + "get": "/v1beta1/{tensorboard=projects/*/locations/*/tensorboards/*}:readUsage" + } + }, + { + "(google.api.method_signature)": "tensorboard" + } + ] + }, "UpdateTensorboard": { "requestType": "UpdateTensorboardRequest", "responseType": "google.longrunning.Operation", @@ -35020,6 +35691,50 @@ } } }, + "ReadTensorboardUsageRequest": { + "fields": { + "tensorboard": { + "type": "string", + "id": 1, + "options": { + "(google.api.field_behavior)": "REQUIRED", + "(google.api.resource_reference).type": "aiplatform.googleapis.com/Tensorboard" + } + } + } + }, + "ReadTensorboardUsageResponse": { + "fields": { + "monthlyUsageData": { + "keyType": "string", + "type": "PerMonthUsageData", + "id": 1 + } + }, + "nested": { + "PerUserUsageData": { + "fields": { + "username": { + "type": "string", + "id": 1 + }, + "viewCount": { + "type": "int64", + "id": 2 + } + } + }, + "PerMonthUsageData": { + "fields": { + "userUsageData": { + "rule": "repeated", + "type": "PerUserUsageData", + "id": 1 + } + } + } + } + }, "ListTensorboardsRequest": { "fields": { "parent": { diff --git a/packages/google-cloud-aiplatform/samples/README.md b/packages/google-cloud-aiplatform/samples/README.md new file mode 100644 index 00000000000..fdf0b4ace21 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/README.md @@ -0,0 +1,53 @@ +[//]: # "This README.md file is auto-generated, all changes to this file will be lost." +[//]: # "To regenerate it, use `python -m synthtool`." +Google Cloud Platform logo + +# [Vertex AI: Node.js Samples](https://github.com/googleapis/nodejs-ai-platform) + +[![Open in Cloud Shell][shell_img]][shell_link] + +Google Cloud Vertex AI is an integrated suite of machine learning tools +and services for building and using ML models with AutoML or custom code. +It offers both novices and experts the best workbench for the entire +machine learning development lifecycle. + +## Table of Contents + +* [Before you begin](#before-you-begin) +* [Samples](#samples) + * [Quickstart](#quickstart) + +## Before you begin + +Before running the samples, make sure you've followed the steps outlined in +[Using the client library](https://github.com/googleapis/nodejs-ai-platform#using-the-client-library). + +`cd samples` + +`npm install` + +`cd ..` + +## Samples + + + +### Quickstart + +View the [source code](https://github.com/googleapis/nodejs-ai-platform/blob/main/samples/quickstart.js). + +[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-ai-platform&page=editor&open_in_editor=samples/quickstart.js,samples/README.md) + +__Usage:__ + + +`node samples/quickstart.js` + + + + + + +[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png +[shell_link]: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-ai-platform&page=editor&open_in_editor=samples/README.md +[product-docs]: https://cloud.google.com/vertex-ai/docs diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/dataset_service.create_dataset.js b/packages/google-cloud-aiplatform/samples/generated/v1/dataset_service.create_dataset.js new file mode 100644 index 00000000000..5356b8210e5 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/dataset_service.create_dataset.js @@ -0,0 +1,68 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, dataset) { + // [START aiplatform_v1_generated_DatasetService_CreateDataset_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to create the Dataset in. + * Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Required. The Dataset to create. + */ + // const dataset = {} + + // Imports the Aiplatform library + const {DatasetServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new DatasetServiceClient(); + + async function callCreateDataset() { + // Construct request + const request = { + parent, + dataset, + }; + + // Run request + const [operation] = await aiplatformClient.createDataset(request); + const [response] = await operation.promise(); + console.log(response); + } + + callCreateDataset(); + // [END aiplatform_v1_generated_DatasetService_CreateDataset_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/dataset_service.delete_dataset.js b/packages/google-cloud-aiplatform/samples/generated/v1/dataset_service.delete_dataset.js new file mode 100644 index 00000000000..79e2d05fafe --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/dataset_service.delete_dataset.js @@ -0,0 +1,64 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_DatasetService_DeleteDataset_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Dataset to delete. + * Format: + * `projects/{project}/locations/{location}/datasets/{dataset}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {DatasetServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new DatasetServiceClient(); + + async function callDeleteDataset() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteDataset(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteDataset(); + // [END aiplatform_v1_generated_DatasetService_DeleteDataset_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/dataset_service.export_data.js b/packages/google-cloud-aiplatform/samples/generated/v1/dataset_service.export_data.js new file mode 100644 index 00000000000..73ebe54cd84 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/dataset_service.export_data.js @@ -0,0 +1,69 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name, exportConfig) { + // [START aiplatform_v1_generated_DatasetService_ExportData_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Dataset resource. + * Format: + * `projects/{project}/locations/{location}/datasets/{dataset}` + */ + // const name = 'abc123' + /** + * Required. The desired output location. + */ + // const exportConfig = {} + + // Imports the Aiplatform library + const {DatasetServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new DatasetServiceClient(); + + async function callExportData() { + // Construct request + const request = { + name, + exportConfig, + }; + + // Run request + const [operation] = await aiplatformClient.exportData(request); + const [response] = await operation.promise(); + console.log(response); + } + + callExportData(); + // [END aiplatform_v1_generated_DatasetService_ExportData_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/dataset_service.get_annotation_spec.js b/packages/google-cloud-aiplatform/samples/generated/v1/dataset_service.get_annotation_spec.js new file mode 100644 index 00000000000..19caf4cf9ea --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/dataset_service.get_annotation_spec.js @@ -0,0 +1,67 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_DatasetService_GetAnnotationSpec_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the AnnotationSpec resource. + * Format: + * `projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}` + */ + // const name = 'abc123' + /** + * Mask specifying which fields to read. + */ + // const readMask = {} + + // Imports the Aiplatform library + const {DatasetServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new DatasetServiceClient(); + + async function callGetAnnotationSpec() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getAnnotationSpec(request); + console.log(response); + } + + callGetAnnotationSpec(); + // [END aiplatform_v1_generated_DatasetService_GetAnnotationSpec_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/dataset_service.get_dataset.js b/packages/google-cloud-aiplatform/samples/generated/v1/dataset_service.get_dataset.js new file mode 100644 index 00000000000..150d8077f3a --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/dataset_service.get_dataset.js @@ -0,0 +1,65 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_DatasetService_GetDataset_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Dataset resource. + */ + // const name = 'abc123' + /** + * Mask specifying which fields to read. + */ + // const readMask = {} + + // Imports the Aiplatform library + const {DatasetServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new DatasetServiceClient(); + + async function callGetDataset() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getDataset(request); + console.log(response); + } + + callGetDataset(); + // [END aiplatform_v1_generated_DatasetService_GetDataset_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/dataset_service.import_data.js b/packages/google-cloud-aiplatform/samples/generated/v1/dataset_service.import_data.js new file mode 100644 index 00000000000..44bf6b741a2 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/dataset_service.import_data.js @@ -0,0 +1,70 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name, importConfigs) { + // [START aiplatform_v1_generated_DatasetService_ImportData_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Dataset resource. + * Format: + * `projects/{project}/locations/{location}/datasets/{dataset}` + */ + // const name = 'abc123' + /** + * Required. The desired input locations. The contents of all input locations + * will be imported in one batch. + */ + // const importConfigs = 1234 + + // Imports the Aiplatform library + const {DatasetServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new DatasetServiceClient(); + + async function callImportData() { + // Construct request + const request = { + name, + importConfigs, + }; + + // Run request + const [operation] = await aiplatformClient.importData(request); + const [response] = await operation.promise(); + console.log(response); + } + + callImportData(); + // [END aiplatform_v1_generated_DatasetService_ImportData_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/dataset_service.list_annotations.js b/packages/google-cloud-aiplatform/samples/generated/v1/dataset_service.list_annotations.js new file mode 100644 index 00000000000..e0afbba2eeb --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/dataset_service.list_annotations.js @@ -0,0 +1,86 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1_generated_DatasetService_ListAnnotations_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the DataItem to list Annotations from. + * Format: + * `projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}` + */ + // const parent = 'abc123' + /** + * The standard list filter. + */ + // const filter = 'abc123' + /** + * The standard list page size. + */ + // const pageSize = 1234 + /** + * The standard list page token. + */ + // const pageToken = 'abc123' + /** + * Mask specifying which fields to read. + */ + // const readMask = {} + /** + * A comma-separated list of fields to order by, sorted in ascending order. + * Use "desc" after a field name for descending. + */ + // const orderBy = 'abc123' + + // Imports the Aiplatform library + const {DatasetServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new DatasetServiceClient(); + + async function callListAnnotations() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listAnnotationsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListAnnotations(); + // [END aiplatform_v1_generated_DatasetService_ListAnnotations_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/dataset_service.list_data_items.js b/packages/google-cloud-aiplatform/samples/generated/v1/dataset_service.list_data_items.js new file mode 100644 index 00000000000..1031be07a56 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/dataset_service.list_data_items.js @@ -0,0 +1,86 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1_generated_DatasetService_ListDataItems_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Dataset to list DataItems from. + * Format: + * `projects/{project}/locations/{location}/datasets/{dataset}` + */ + // const parent = 'abc123' + /** + * The standard list filter. + */ + // const filter = 'abc123' + /** + * The standard list page size. + */ + // const pageSize = 1234 + /** + * The standard list page token. + */ + // const pageToken = 'abc123' + /** + * Mask specifying which fields to read. + */ + // const readMask = {} + /** + * A comma-separated list of fields to order by, sorted in ascending order. + * Use "desc" after a field name for descending. + */ + // const orderBy = 'abc123' + + // Imports the Aiplatform library + const {DatasetServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new DatasetServiceClient(); + + async function callListDataItems() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listDataItemsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListDataItems(); + // [END aiplatform_v1_generated_DatasetService_ListDataItems_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/dataset_service.list_datasets.js b/packages/google-cloud-aiplatform/samples/generated/v1/dataset_service.list_datasets.js new file mode 100644 index 00000000000..2365630719f --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/dataset_service.list_datasets.js @@ -0,0 +1,99 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1_generated_DatasetService_ListDatasets_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Dataset's parent resource. + * Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * An expression for filtering the results of the request. For field names + * both snake_case and camelCase are supported. + * * `display_name`: supports = and != + * * `metadata_schema_uri`: supports = and != + * * `labels` supports general map functions that is: + * * `labels.key=value` - key:value equality + * * `labels.key:* or labels:key - key existence + * * A key including a space must be quoted. `labels."a key"`. + * Some examples: + * * `displayName="myDisplayName"` + * * `labels.myKey="myValue"` + */ + // const filter = 'abc123' + /** + * The standard list page size. + */ + // const pageSize = 1234 + /** + * The standard list page token. + */ + // const pageToken = 'abc123' + /** + * Mask specifying which fields to read. + */ + // const readMask = {} + /** + * A comma-separated list of fields to order by, sorted in ascending order. + * Use "desc" after a field name for descending. + * Supported fields: + * * `display_name` + * * `create_time` + * * `update_time` + */ + // const orderBy = 'abc123' + + // Imports the Aiplatform library + const {DatasetServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new DatasetServiceClient(); + + async function callListDatasets() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listDatasetsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListDatasets(); + // [END aiplatform_v1_generated_DatasetService_ListDatasets_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/dataset_service.list_saved_queries.js b/packages/google-cloud-aiplatform/samples/generated/v1/dataset_service.list_saved_queries.js new file mode 100644 index 00000000000..ef3dbba0daf --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/dataset_service.list_saved_queries.js @@ -0,0 +1,86 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1_generated_DatasetService_ListSavedQueries_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Dataset to list SavedQueries from. + * Format: + * `projects/{project}/locations/{location}/datasets/{dataset}` + */ + // const parent = 'abc123' + /** + * The standard list filter. + */ + // const filter = 'abc123' + /** + * The standard list page size. + */ + // const pageSize = 1234 + /** + * The standard list page token. + */ + // const pageToken = 'abc123' + /** + * Mask specifying which fields to read. + */ + // const readMask = {} + /** + * A comma-separated list of fields to order by, sorted in ascending order. + * Use "desc" after a field name for descending. + */ + // const orderBy = 'abc123' + + // Imports the Aiplatform library + const {DatasetServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new DatasetServiceClient(); + + async function callListSavedQueries() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listSavedQueriesAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListSavedQueries(); + // [END aiplatform_v1_generated_DatasetService_ListSavedQueries_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/dataset_service.search_data_items.js b/packages/google-cloud-aiplatform/samples/generated/v1/dataset_service.search_data_items.js new file mode 100644 index 00000000000..16a5ad270ff --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/dataset_service.search_data_items.js @@ -0,0 +1,145 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(dataset) { + // [START aiplatform_v1_generated_DatasetService_SearchDataItems_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * A comma-separated list of data item fields to order by, sorted in + * ascending order. Use "desc" after a field name for descending. + */ + // const orderByDataItem = 'abc123' + /** + * Expression that allows ranking results based on annotation's property. + */ + // const orderByAnnotation = {} + /** + * Required. The resource name of the Dataset from which to search DataItems. + * Format: + * `projects/{project}/locations/{location}/datasets/{dataset}` + */ + // const dataset = 'abc123' + /** + * The resource name of a SavedQuery(annotation set in UI). + * Format: + * `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}` + * All of the search will be done in the context of this SavedQuery. + */ + // const savedQuery = 'abc123' + /** + * The resource name of a DataLabelingJob. + * Format: + * `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` + * If this field is set, all of the search will be done in the context of + * this DataLabelingJob. + */ + // const dataLabelingJob = 'abc123' + /** + * An expression for filtering the DataItem that will be returned. + * * `data_item_id` - for = or !=. + * * `labeled` - for = or !=. + * * `has_annotation(ANNOTATION_SPEC_ID)` - true only for DataItem that + * have at least one annotation with annotation_spec_id = + * `ANNOTATION_SPEC_ID` in the context of SavedQuery or DataLabelingJob. + * For example: + * * `data_item=1` + * * `has_annotation(5)` + */ + // const dataItemFilter = 'abc123' + /** + * An expression for filtering the Annotations that will be returned per + * DataItem. + * * `annotation_spec_id` - for = or !=. + */ + // const annotationsFilter = 'abc123' + /** + * An expression that specifies what Annotations will be returned per + * DataItem. Annotations satisfied either of the conditions will be returned. + * * `annotation_spec_id` - for = or !=. + * Must specify `saved_query_id=` - saved query id that annotations should + * belong to. + */ + // const annotationFilters = 'abc123' + /** + * Mask specifying which fields of + * DataItemView google.cloud.aiplatform.v1.DataItemView to read. + */ + // const fieldMask = {} + /** + * If set, only up to this many of Annotations will be returned per + * DataItemView. The maximum value is 1000. If not set, the maximum value will + * be used. + */ + // const annotationsLimit = 1234 + /** + * Requested page size. Server may return fewer results than requested. + * Default and maximum page size is 100. + */ + // const pageSize = 1234 + /** + * A comma-separated list of fields to order by, sorted in ascending order. + * Use "desc" after a field name for descending. + */ + // const orderBy = 'abc123' + /** + * A token identifying a page of results for the server to return + * Typically obtained via + * SearchDataItemsResponse.next_page_token google.cloud.aiplatform.v1.SearchDataItemsResponse.next_page_token + * of the previous + * DatasetService.SearchDataItems google.cloud.aiplatform.v1.DatasetService.SearchDataItems + * call. + */ + // const pageToken = 'abc123' + + // Imports the Aiplatform library + const {DatasetServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new DatasetServiceClient(); + + async function callSearchDataItems() { + // Construct request + const request = { + dataset, + }; + + // Run request + const iterable = await aiplatformClient.searchDataItemsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callSearchDataItems(); + // [END aiplatform_v1_generated_DatasetService_SearchDataItems_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/dataset_service.update_dataset.js b/packages/google-cloud-aiplatform/samples/generated/v1/dataset_service.update_dataset.js new file mode 100644 index 00000000000..2e0b8ea949d --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/dataset_service.update_dataset.js @@ -0,0 +1,71 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(dataset, updateMask) { + // [START aiplatform_v1_generated_DatasetService_UpdateDataset_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The Dataset which replaces the resource on the server. + */ + // const dataset = {} + /** + * Required. The update mask applies to the resource. + * For the `FieldMask` definition, see + * google.protobuf.FieldMask google.protobuf.FieldMask. Updatable fields: + * * `display_name` + * * `description` + * * `labels` + */ + // const updateMask = {} + + // Imports the Aiplatform library + const {DatasetServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new DatasetServiceClient(); + + async function callUpdateDataset() { + // Construct request + const request = { + dataset, + updateMask, + }; + + // Run request + const response = await aiplatformClient.updateDataset(request); + console.log(response); + } + + callUpdateDataset(); + // [END aiplatform_v1_generated_DatasetService_UpdateDataset_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/endpoint_service.create_endpoint.js b/packages/google-cloud-aiplatform/samples/generated/v1/endpoint_service.create_endpoint.js new file mode 100644 index 00000000000..c2f4b3d8f90 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/endpoint_service.create_endpoint.js @@ -0,0 +1,79 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, endpoint, endpointId) { + // [START aiplatform_v1_generated_EndpointService_CreateEndpoint_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to create the Endpoint in. + * Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Required. The Endpoint to create. + */ + // const endpoint = {} + /** + * Immutable. The ID to use for endpoint, which will become the final + * component of the endpoint resource name. + * If not provided, Vertex AI will generate a value for this ID. + * This value should be 1-10 characters, and valid characters are /[0-9]/. + * When using HTTP/JSON, this field is populated based on a query string + * argument, such as `?endpoint_id=12345`. This is the fallback for fields + * that are not included in either the URI or the body. + */ + // const endpointId = 'abc123' + + // Imports the Aiplatform library + const {EndpointServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new EndpointServiceClient(); + + async function callCreateEndpoint() { + // Construct request + const request = { + parent, + endpoint, + endpointId, + }; + + // Run request + const [operation] = await aiplatformClient.createEndpoint(request); + const [response] = await operation.promise(); + console.log(response); + } + + callCreateEndpoint(); + // [END aiplatform_v1_generated_EndpointService_CreateEndpoint_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/endpoint_service.delete_endpoint.js b/packages/google-cloud-aiplatform/samples/generated/v1/endpoint_service.delete_endpoint.js new file mode 100644 index 00000000000..1e376c6812d --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/endpoint_service.delete_endpoint.js @@ -0,0 +1,64 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_EndpointService_DeleteEndpoint_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Endpoint resource to be deleted. + * Format: + * `projects/{project}/locations/{location}/endpoints/{endpoint}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {EndpointServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new EndpointServiceClient(); + + async function callDeleteEndpoint() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteEndpoint(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteEndpoint(); + // [END aiplatform_v1_generated_EndpointService_DeleteEndpoint_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/endpoint_service.deploy_model.js b/packages/google-cloud-aiplatform/samples/generated/v1/endpoint_service.deploy_model.js new file mode 100644 index 00000000000..615edb73165 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/endpoint_service.deploy_model.js @@ -0,0 +1,87 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(endpoint, deployedModel) { + // [START aiplatform_v1_generated_EndpointService_DeployModel_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Endpoint resource into which to deploy a Model. + * Format: + * `projects/{project}/locations/{location}/endpoints/{endpoint}` + */ + // const endpoint = 'abc123' + /** + * Required. The DeployedModel to be created within the Endpoint. Note that + * Endpoint.traffic_split google.cloud.aiplatform.v1.Endpoint.traffic_split + * must be updated for the DeployedModel to start receiving traffic, either as + * part of this call, or via + * EndpointService.UpdateEndpoint google.cloud.aiplatform.v1.EndpointService.UpdateEndpoint. + */ + // const deployedModel = {} + /** + * A map from a DeployedModel's ID to the percentage of this Endpoint's + * traffic that should be forwarded to that DeployedModel. + * If this field is non-empty, then the Endpoint's + * traffic_split google.cloud.aiplatform.v1.Endpoint.traffic_split will be + * overwritten with it. To refer to the ID of the just being deployed Model, a + * "0" should be used, and the actual ID of the new DeployedModel will be + * filled in its place by this method. The traffic percentage values must add + * up to 100. + * If this field is empty, then the Endpoint's + * traffic_split google.cloud.aiplatform.v1.Endpoint.traffic_split is not + * updated. + */ + // const trafficSplit = 1234 + + // Imports the Aiplatform library + const {EndpointServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new EndpointServiceClient(); + + async function callDeployModel() { + // Construct request + const request = { + endpoint, + deployedModel, + }; + + // Run request + const [operation] = await aiplatformClient.deployModel(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeployModel(); + // [END aiplatform_v1_generated_EndpointService_DeployModel_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/endpoint_service.get_endpoint.js b/packages/google-cloud-aiplatform/samples/generated/v1/endpoint_service.get_endpoint.js new file mode 100644 index 00000000000..86f22f17381 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/endpoint_service.get_endpoint.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_EndpointService_GetEndpoint_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Endpoint resource. + * Format: + * `projects/{project}/locations/{location}/endpoints/{endpoint}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {EndpointServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new EndpointServiceClient(); + + async function callGetEndpoint() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getEndpoint(request); + console.log(response); + } + + callGetEndpoint(); + // [END aiplatform_v1_generated_EndpointService_GetEndpoint_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/endpoint_service.list_endpoints.js b/packages/google-cloud-aiplatform/samples/generated/v1/endpoint_service.list_endpoints.js new file mode 100644 index 00000000000..91933a3bd02 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/endpoint_service.list_endpoints.js @@ -0,0 +1,108 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1_generated_EndpointService_ListEndpoints_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location from which to list the + * Endpoints. Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Optional. An expression for filtering the results of the request. For field + * names both snake_case and camelCase are supported. + * * `endpoint` supports = and !=. `endpoint` represents the Endpoint ID, + * i.e. the last segment of the Endpoint's resource + * name google.cloud.aiplatform.v1.Endpoint.name. + * * `display_name` supports = and, != + * * `labels` supports general map functions that is: + * * `labels.key=value` - key:value equality + * * `labels.key:* or labels:key - key existence + * * A key including a space must be quoted. `labels."a key"`. + * Some examples: + * * `endpoint=1` + * * `displayName="myDisplayName"` + * * `labels.myKey="myValue"` + */ + // const filter = 'abc123' + /** + * Optional. The standard list page size. + */ + // const pageSize = 1234 + /** + * Optional. The standard list page token. + * Typically obtained via + * ListEndpointsResponse.next_page_token google.cloud.aiplatform.v1.ListEndpointsResponse.next_page_token + * of the previous + * EndpointService.ListEndpoints google.cloud.aiplatform.v1.EndpointService.ListEndpoints + * call. + */ + // const pageToken = 'abc123' + /** + * Optional. Mask specifying which fields to read. + */ + // const readMask = {} + /** + * A comma-separated list of fields to order by, sorted in ascending order. + * Use "desc" after a field name for descending. + * Supported fields: + * * `display_name` + * * `create_time` + * * `update_time` + * Example: `display_name, create_time desc`. + */ + // const orderBy = 'abc123' + + // Imports the Aiplatform library + const {EndpointServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new EndpointServiceClient(); + + async function callListEndpoints() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listEndpointsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListEndpoints(); + // [END aiplatform_v1_generated_EndpointService_ListEndpoints_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/endpoint_service.undeploy_model.js b/packages/google-cloud-aiplatform/samples/generated/v1/endpoint_service.undeploy_model.js new file mode 100644 index 00000000000..92dba5b524e --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/endpoint_service.undeploy_model.js @@ -0,0 +1,79 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(endpoint, deployedModelId) { + // [START aiplatform_v1_generated_EndpointService_UndeployModel_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Endpoint resource from which to undeploy a Model. + * Format: + * `projects/{project}/locations/{location}/endpoints/{endpoint}` + */ + // const endpoint = 'abc123' + /** + * Required. The ID of the DeployedModel to be undeployed from the Endpoint. + */ + // const deployedModelId = 'abc123' + /** + * If this field is provided, then the Endpoint's + * traffic_split google.cloud.aiplatform.v1.Endpoint.traffic_split will be + * overwritten with it. If last DeployedModel is being undeployed from the + * Endpoint, the Endpoint.traffic_split will always end up empty when this + * call returns. A DeployedModel will be successfully undeployed only if it + * doesn't have any traffic assigned to it when this method executes, or if + * this field unassigns any traffic to it. + */ + // const trafficSplit = 1234 + + // Imports the Aiplatform library + const {EndpointServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new EndpointServiceClient(); + + async function callUndeployModel() { + // Construct request + const request = { + endpoint, + deployedModelId, + }; + + // Run request + const [operation] = await aiplatformClient.undeployModel(request); + const [response] = await operation.promise(); + console.log(response); + } + + callUndeployModel(); + // [END aiplatform_v1_generated_EndpointService_UndeployModel_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/endpoint_service.update_endpoint.js b/packages/google-cloud-aiplatform/samples/generated/v1/endpoint_service.update_endpoint.js new file mode 100644 index 00000000000..c2dd3eb6aee --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/endpoint_service.update_endpoint.js @@ -0,0 +1,67 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(endpoint, updateMask) { + // [START aiplatform_v1_generated_EndpointService_UpdateEndpoint_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The Endpoint which replaces the resource on the server. + */ + // const endpoint = {} + /** + * Required. The update mask applies to the resource. See + * google.protobuf.FieldMask google.protobuf.FieldMask. + */ + // const updateMask = {} + + // Imports the Aiplatform library + const {EndpointServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new EndpointServiceClient(); + + async function callUpdateEndpoint() { + // Construct request + const request = { + endpoint, + updateMask, + }; + + // Run request + const response = await aiplatformClient.updateEndpoint(request); + console.log(response); + } + + callUpdateEndpoint(); + // [END aiplatform_v1_generated_EndpointService_UpdateEndpoint_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_online_serving_service.read_feature_values.js b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_online_serving_service.read_feature_values.js new file mode 100644 index 00000000000..b4af86e2374 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_online_serving_service.read_feature_values.js @@ -0,0 +1,77 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(entityType, entityId, featureSelector) { + // [START aiplatform_v1_generated_FeaturestoreOnlineServingService_ReadFeatureValues_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the EntityType for the entity being read. + * Value format: + * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`. + * For example, for a machine learning model predicting user clicks on a + * website, an EntityType ID could be `user`. + */ + // const entityType = 'abc123' + /** + * Required. ID for a specific entity. For example, + * for a machine learning model predicting user clicks on a website, an entity + * ID could be `user_123`. + */ + // const entityId = 'abc123' + /** + * Required. Selector choosing Features of the target EntityType. + */ + // const featureSelector = {} + + // Imports the Aiplatform library + const {FeaturestoreOnlineServingServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreOnlineServingServiceClient(); + + async function callReadFeatureValues() { + // Construct request + const request = { + entityType, + entityId, + featureSelector, + }; + + // Run request + const response = await aiplatformClient.readFeatureValues(request); + console.log(response); + } + + callReadFeatureValues(); + // [END aiplatform_v1_generated_FeaturestoreOnlineServingService_ReadFeatureValues_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_online_serving_service.streaming_read_feature_values.js b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_online_serving_service.streaming_read_feature_values.js new file mode 100644 index 00000000000..f5d3994a05a --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_online_serving_service.streaming_read_feature_values.js @@ -0,0 +1,81 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(entityType, entityIds, featureSelector) { + // [START aiplatform_v1_generated_FeaturestoreOnlineServingService_StreamingReadFeatureValues_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the entities' type. + * Value format: + * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`. + * For example, + * for a machine learning model predicting user clicks on a website, an + * EntityType ID could be `user`. + */ + // const entityType = 'abc123' + /** + * Required. IDs of entities to read Feature values of. The maximum number of + * IDs is 100. For example, for a machine learning model predicting user + * clicks on a website, an entity ID could be `user_123`. + */ + // const entityIds = 'abc123' + /** + * Required. Selector choosing Features of the target EntityType. Feature IDs + * will be deduplicated. + */ + // const featureSelector = {} + + // Imports the Aiplatform library + const {FeaturestoreOnlineServingServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreOnlineServingServiceClient(); + + async function callStreamingReadFeatureValues() { + // Construct request + const request = { + entityType, + entityIds, + featureSelector, + }; + + // Run request + const stream = await aiplatformClient.streamingReadFeatureValues(request); + stream.on('data', (response) => { console.log(response) }); + stream.on('error', (err) => { throw(err) }); + stream.on('end', () => { /* API call completed */ }); + } + + callStreamingReadFeatureValues(); + // [END aiplatform_v1_generated_FeaturestoreOnlineServingService_StreamingReadFeatureValues_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_online_serving_service.write_feature_values.js b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_online_serving_service.write_feature_values.js new file mode 100644 index 00000000000..04ebb53c6ce --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_online_serving_service.write_feature_values.js @@ -0,0 +1,72 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(entityType, payloads) { + // [START aiplatform_v1_generated_FeaturestoreOnlineServingService_WriteFeatureValues_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the EntityType for the entities being + * written. Value format: + * `projects/{project}/locations/{location}/featurestores/ + * {featurestore}/entityTypes/{entityType}`. For example, + * for a machine learning model predicting user clicks on a website, an + * EntityType ID could be `user`. + */ + // const entityType = 'abc123' + /** + * Required. The entities to be written. Up to 100,000 feature values can be + * written across all `payloads`. + */ + // const payloads = 1234 + + // Imports the Aiplatform library + const {FeaturestoreOnlineServingServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreOnlineServingServiceClient(); + + async function callWriteFeatureValues() { + // Construct request + const request = { + entityType, + payloads, + }; + + // Run request + const response = await aiplatformClient.writeFeatureValues(request); + console.log(response); + } + + callWriteFeatureValues(); + // [END aiplatform_v1_generated_FeaturestoreOnlineServingService_WriteFeatureValues_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.batch_create_features.js b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.batch_create_features.js new file mode 100644 index 00000000000..af3c004559a --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.batch_create_features.js @@ -0,0 +1,73 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, requests) { + // [START aiplatform_v1_generated_FeaturestoreService_BatchCreateFeatures_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the EntityType to create the batch of + * Features under. Format: + * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` + */ + // const parent = 'abc123' + /** + * Required. The request message specifying the Features to create. All + * Features must be created under the same parent EntityType. The `parent` + * field in each child request message can be omitted. If `parent` is set in a + * child request, then the value must match the `parent` value in this request + * message. + */ + // const requests = 1234 + + // Imports the Aiplatform library + const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreServiceClient(); + + async function callBatchCreateFeatures() { + // Construct request + const request = { + parent, + requests, + }; + + // Run request + const [operation] = await aiplatformClient.batchCreateFeatures(request); + const [response] = await operation.promise(); + console.log(response); + } + + callBatchCreateFeatures(); + // [END aiplatform_v1_generated_FeaturestoreService_BatchCreateFeatures_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.batch_read_feature_values.js b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.batch_read_feature_values.js new file mode 100644 index 00000000000..00984f1e714 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.batch_read_feature_values.js @@ -0,0 +1,117 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(featurestore, destination, entityTypeSpecs) { + // [START aiplatform_v1_generated_FeaturestoreService_BatchReadFeatureValues_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Each read instance consists of exactly one read timestamp and one or more + * entity IDs identifying entities of the corresponding EntityTypes whose + * Features are requested. + * Each output instance contains Feature values of requested entities + * concatenated together as of the read time. + * An example read instance may be `foo_entity_id, bar_entity_id, + * 2020-01-01T10:00:00.123Z`. + * An example output instance may be `foo_entity_id, bar_entity_id, + * 2020-01-01T10:00:00.123Z, foo_entity_feature1_value, + * bar_entity_feature2_value`. + * Timestamp in each read instance must be millisecond-aligned. + * `csv_read_instances` are read instances stored in a plain-text CSV file. + * The header should be: + * ENTITY_TYPE_ID1, ENTITY_TYPE_ID2, ..., timestamp + * The columns can be in any order. + * Values in the timestamp column must use the RFC 3339 format, e.g. + * `2012-07-30T10:43:17.123Z`. + */ + // const csvReadInstances = {} + /** + * Similar to csv_read_instances, but from BigQuery source. + */ + // const bigqueryReadInstances = {} + /** + * Required. The resource name of the Featurestore from which to query Feature + * values. Format: + * `projects/{project}/locations/{location}/featurestores/{featurestore}` + */ + // const featurestore = 'abc123' + /** + * Required. Specifies output location and format. + */ + // const destination = {} + /** + * When not empty, the specified fields in the *_read_instances source will be + * joined as-is in the output, in addition to those fields from the + * Featurestore Entity. + * For BigQuery source, the type of the pass-through values will be + * automatically inferred. For CSV source, the pass-through values will be + * passed as opaque bytes. + */ + // const passThroughFields = 1234 + /** + * Required. Specifies EntityType grouping Features to read values of and + * settings. Each EntityType referenced in + * BatchReadFeatureValuesRequest.entity_type_specs must have a column + * specifying entity IDs in the EntityType in + * BatchReadFeatureValuesRequest.request . + */ + // const entityTypeSpecs = 1234 + /** + * Optional. Excludes Feature values with feature generation timestamp before + * this timestamp. If not set, retrieve oldest values kept in Feature Store. + * Timestamp, if present, must not have higher than millisecond precision. + */ + // const startTime = {} + + // Imports the Aiplatform library + const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreServiceClient(); + + async function callBatchReadFeatureValues() { + // Construct request + const request = { + featurestore, + destination, + entityTypeSpecs, + }; + + // Run request + const [operation] = await aiplatformClient.batchReadFeatureValues(request); + const [response] = await operation.promise(); + console.log(response); + } + + callBatchReadFeatureValues(); + // [END aiplatform_v1_generated_FeaturestoreService_BatchReadFeatureValues_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.create_entity_type.js b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.create_entity_type.js new file mode 100644 index 00000000000..3e86f72acb9 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.create_entity_type.js @@ -0,0 +1,77 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, entityTypeId) { + // [START aiplatform_v1_generated_FeaturestoreService_CreateEntityType_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Featurestore to create EntityTypes. + * Format: + * `projects/{project}/locations/{location}/featurestores/{featurestore}` + */ + // const parent = 'abc123' + /** + * The EntityType to create. + */ + // const entityType = {} + /** + * Required. The ID to use for the EntityType, which will become the final + * component of the EntityType's resource name. + * This value may be up to 60 characters, and valid characters are + * `[a-z0-9_]`. The first character cannot be a number. + * The value must be unique within a featurestore. + */ + // const entityTypeId = 'abc123' + + // Imports the Aiplatform library + const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreServiceClient(); + + async function callCreateEntityType() { + // Construct request + const request = { + parent, + entityTypeId, + }; + + // Run request + const [operation] = await aiplatformClient.createEntityType(request); + const [response] = await operation.promise(); + console.log(response); + } + + callCreateEntityType(); + // [END aiplatform_v1_generated_FeaturestoreService_CreateEntityType_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.create_feature.js b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.create_feature.js new file mode 100644 index 00000000000..1106a1f23a7 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.create_feature.js @@ -0,0 +1,78 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, feature, featureId) { + // [START aiplatform_v1_generated_FeaturestoreService_CreateFeature_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the EntityType to create a Feature. + * Format: + * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` + */ + // const parent = 'abc123' + /** + * Required. The Feature to create. + */ + // const feature = {} + /** + * Required. The ID to use for the Feature, which will become the final + * component of the Feature's resource name. + * This value may be up to 128 characters, and valid characters are + * `[a-z0-9_]`. The first character cannot be a number. + * The value must be unique within an EntityType. + */ + // const featureId = 'abc123' + + // Imports the Aiplatform library + const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreServiceClient(); + + async function callCreateFeature() { + // Construct request + const request = { + parent, + feature, + featureId, + }; + + // Run request + const [operation] = await aiplatformClient.createFeature(request); + const [response] = await operation.promise(); + console.log(response); + } + + callCreateFeature(); + // [END aiplatform_v1_generated_FeaturestoreService_CreateFeature_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.create_featurestore.js b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.create_featurestore.js new file mode 100644 index 00000000000..68053dc84fc --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.create_featurestore.js @@ -0,0 +1,78 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, featurestore, featurestoreId) { + // [START aiplatform_v1_generated_FeaturestoreService_CreateFeaturestore_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to create Featurestores. + * Format: + * `projects/{project}/locations/{location}'` + */ + // const parent = 'abc123' + /** + * Required. The Featurestore to create. + */ + // const featurestore = {} + /** + * Required. The ID to use for this Featurestore, which will become the final + * component of the Featurestore's resource name. + * This value may be up to 60 characters, and valid characters are + * `[a-z0-9_]`. The first character cannot be a number. + * The value must be unique within the project and location. + */ + // const featurestoreId = 'abc123' + + // Imports the Aiplatform library + const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreServiceClient(); + + async function callCreateFeaturestore() { + // Construct request + const request = { + parent, + featurestore, + featurestoreId, + }; + + // Run request + const [operation] = await aiplatformClient.createFeaturestore(request); + const [response] = await operation.promise(); + console.log(response); + } + + callCreateFeaturestore(); + // [END aiplatform_v1_generated_FeaturestoreService_CreateFeaturestore_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.delete_entity_type.js b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.delete_entity_type.js new file mode 100644 index 00000000000..f25d0b95cdc --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.delete_entity_type.js @@ -0,0 +1,69 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_FeaturestoreService_DeleteEntityType_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the EntityType to be deleted. + * Format: + * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` + */ + // const name = 'abc123' + /** + * If set to true, any Features for this EntityType will also be deleted. + * (Otherwise, the request will only work if the EntityType has no Features.) + */ + // const force = true + + // Imports the Aiplatform library + const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreServiceClient(); + + async function callDeleteEntityType() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteEntityType(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteEntityType(); + // [END aiplatform_v1_generated_FeaturestoreService_DeleteEntityType_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.delete_feature.js b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.delete_feature.js new file mode 100644 index 00000000000..ed35f8e6f83 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.delete_feature.js @@ -0,0 +1,64 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_FeaturestoreService_DeleteFeature_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Features to be deleted. + * Format: + * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreServiceClient(); + + async function callDeleteFeature() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteFeature(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteFeature(); + // [END aiplatform_v1_generated_FeaturestoreService_DeleteFeature_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.delete_featurestore.js b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.delete_featurestore.js new file mode 100644 index 00000000000..4825fc1ed16 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.delete_featurestore.js @@ -0,0 +1,70 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_FeaturestoreService_DeleteFeaturestore_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Featurestore to be deleted. + * Format: + * `projects/{project}/locations/{location}/featurestores/{featurestore}` + */ + // const name = 'abc123' + /** + * If set to true, any EntityTypes and Features for this Featurestore will + * also be deleted. (Otherwise, the request will only work if the Featurestore + * has no EntityTypes.) + */ + // const force = true + + // Imports the Aiplatform library + const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreServiceClient(); + + async function callDeleteFeaturestore() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteFeaturestore(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteFeaturestore(); + // [END aiplatform_v1_generated_FeaturestoreService_DeleteFeaturestore_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.export_feature_values.js b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.export_feature_values.js new file mode 100644 index 00000000000..4f2572c668d --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.export_feature_values.js @@ -0,0 +1,88 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(entityType, destination, featureSelector) { + // [START aiplatform_v1_generated_FeaturestoreService_ExportFeatureValues_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Exports the latest Feature values of all entities of the EntityType + * within a time range. + */ + // const snapshotExport = {} + /** + * Exports all historical values of all entities of the EntityType within a + * time range + */ + // const fullExport = {} + /** + * Required. The resource name of the EntityType from which to export Feature + * values. Format: + * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` + */ + // const entityType = 'abc123' + /** + * Required. Specifies destination location and format. + */ + // const destination = {} + /** + * Required. Selects Features to export values of. + */ + // const featureSelector = {} + /** + * Per-Feature export settings. + */ + // const settings = 1234 + + // Imports the Aiplatform library + const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreServiceClient(); + + async function callExportFeatureValues() { + // Construct request + const request = { + entityType, + destination, + featureSelector, + }; + + // Run request + const [operation] = await aiplatformClient.exportFeatureValues(request); + const [response] = await operation.promise(); + console.log(response); + } + + callExportFeatureValues(); + // [END aiplatform_v1_generated_FeaturestoreService_ExportFeatureValues_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.get_entity_type.js b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.get_entity_type.js new file mode 100644 index 00000000000..d515bbfb4ec --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.get_entity_type.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_FeaturestoreService_GetEntityType_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the EntityType resource. + * Format: + * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreServiceClient(); + + async function callGetEntityType() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getEntityType(request); + console.log(response); + } + + callGetEntityType(); + // [END aiplatform_v1_generated_FeaturestoreService_GetEntityType_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.get_feature.js b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.get_feature.js new file mode 100644 index 00000000000..03a178d14e3 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.get_feature.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_FeaturestoreService_GetFeature_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Feature resource. + * Format: + * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreServiceClient(); + + async function callGetFeature() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getFeature(request); + console.log(response); + } + + callGetFeature(); + // [END aiplatform_v1_generated_FeaturestoreService_GetFeature_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.get_featurestore.js b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.get_featurestore.js new file mode 100644 index 00000000000..22aeb37173f --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.get_featurestore.js @@ -0,0 +1,61 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_FeaturestoreService_GetFeaturestore_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Featurestore resource. + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreServiceClient(); + + async function callGetFeaturestore() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getFeaturestore(request); + console.log(response); + } + + callGetFeaturestore(); + // [END aiplatform_v1_generated_FeaturestoreService_GetFeaturestore_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.import_feature_values.js b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.import_feature_values.js new file mode 100644 index 00000000000..516ec4982ce --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.import_feature_values.js @@ -0,0 +1,114 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(entityType, featureSpecs) { + // [START aiplatform_v1_generated_FeaturestoreService_ImportFeatureValues_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + */ + // const avroSource = {} + /** + */ + // const bigquerySource = {} + /** + */ + // const csvSource = {} + /** + * Source column that holds the Feature timestamp for all Feature + * values in each entity. + */ + // const featureTimeField = 'abc123' + /** + * Single Feature timestamp for all entities being imported. The + * timestamp must not have higher than millisecond precision. + */ + // const featureTime = {} + /** + * Required. The resource name of the EntityType grouping the Features for + * which values are being imported. Format: + * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}` + */ + // const entityType = 'abc123' + /** + * Source column that holds entity IDs. If not provided, entity IDs are + * extracted from the column named `entity_id`. + */ + // const entityIdField = 'abc123' + /** + * Required. Specifications defining which Feature values to import from the + * entity. The request fails if no feature_specs are provided, and having + * multiple feature_specs for one Feature is not allowed. + */ + // const featureSpecs = 1234 + /** + * If set, data will not be imported for online serving. This + * is typically used for backfilling, where Feature generation timestamps are + * not in the timestamp range needed for online serving. + */ + // const disableOnlineServing = true + /** + * Specifies the number of workers that are used to write data to the + * Featurestore. Consider the online serving capacity that you require to + * achieve the desired import throughput without interfering with online + * serving. The value must be positive, and less than or equal to 100. + * If not set, defaults to using 1 worker. The low count ensures minimal + * impact on online serving performance. + */ + // const workerCount = 1234 + /** + * If true, API doesn't start ingestion analysis pipeline. + */ + // const disableIngestionAnalysis = true + + // Imports the Aiplatform library + const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreServiceClient(); + + async function callImportFeatureValues() { + // Construct request + const request = { + entityType, + featureSpecs, + }; + + // Run request + const [operation] = await aiplatformClient.importFeatureValues(request); + const [response] = await operation.promise(); + console.log(response); + } + + callImportFeatureValues(); + // [END aiplatform_v1_generated_FeaturestoreService_ImportFeatureValues_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.list_entity_types.js b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.list_entity_types.js new file mode 100644 index 00000000000..f52be18a001 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.list_entity_types.js @@ -0,0 +1,112 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1_generated_FeaturestoreService_ListEntityTypes_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Featurestore to list EntityTypes. + * Format: + * `projects/{project}/locations/{location}/featurestores/{featurestore}` + */ + // const parent = 'abc123' + /** + * Lists the EntityTypes that match the filter expression. The following + * filters are supported: + * * `create_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. + * Values must be in RFC 3339 format. + * * `update_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. + * Values must be in RFC 3339 format. + * * `labels`: Supports key-value equality as well as key presence. + * Examples: + * * `create_time > \"2020-01-31T15:30:00.000000Z\" OR + * update_time > \"2020-01-31T15:30:00.000000Z\"` --> EntityTypes created + * or updated after 2020-01-31T15:30:00.000000Z. + * * `labels.active = yes AND labels.env = prod` --> EntityTypes having both + * (active: yes) and (env: prod) labels. + * * `labels.env: *` --> Any EntityType which has a label with 'env' as the + * key. + */ + // const filter = 'abc123' + /** + * The maximum number of EntityTypes to return. The service may return fewer + * than this value. If unspecified, at most 1000 EntityTypes will be returned. + * The maximum value is 1000; any value greater than 1000 will be coerced to + * 1000. + */ + // const pageSize = 1234 + /** + * A page token, received from a previous + * FeaturestoreService.ListEntityTypes google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes + * call. Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to + * FeaturestoreService.ListEntityTypes google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes + * must match the call that provided the page token. + */ + // const pageToken = 'abc123' + /** + * A comma-separated list of fields to order by, sorted in ascending order. + * Use "desc" after a field name for descending. + * Supported fields: + * * `entity_type_id` + * * `create_time` + * * `update_time` + */ + // const orderBy = 'abc123' + /** + * Mask specifying which fields to read. + */ + // const readMask = {} + + // Imports the Aiplatform library + const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreServiceClient(); + + async function callListEntityTypes() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listEntityTypesAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListEntityTypes(); + // [END aiplatform_v1_generated_FeaturestoreService_ListEntityTypes_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.list_features.js b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.list_features.js new file mode 100644 index 00000000000..13673eeefcd --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.list_features.js @@ -0,0 +1,124 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1_generated_FeaturestoreService_ListFeatures_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to list Features. + * Format: + * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` + */ + // const parent = 'abc123' + /** + * Lists the Features that match the filter expression. The following + * filters are supported: + * * `value_type`: Supports = and != comparisons. + * * `create_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must + * be in RFC 3339 format. + * * `update_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must + * be in RFC 3339 format. + * * `labels`: Supports key-value equality as well as key presence. + * Examples: + * * `value_type = DOUBLE` --> Features whose type is DOUBLE. + * * `create_time > \"2020-01-31T15:30:00.000000Z\" OR + * update_time > \"2020-01-31T15:30:00.000000Z\"` --> EntityTypes created + * or updated after 2020-01-31T15:30:00.000000Z. + * * `labels.active = yes AND labels.env = prod` --> Features having both + * (active: yes) and (env: prod) labels. + * * `labels.env: *` --> Any Feature which has a label with 'env' as the + * key. + */ + // const filter = 'abc123' + /** + * The maximum number of Features to return. The service may return fewer + * than this value. If unspecified, at most 1000 Features will be returned. + * The maximum value is 1000; any value greater than 1000 will be coerced to + * 1000. + */ + // const pageSize = 1234 + /** + * A page token, received from a previous + * FeaturestoreService.ListFeatures google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures + * call. Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to + * FeaturestoreService.ListFeatures google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures + * must match the call that provided the page token. + */ + // const pageToken = 'abc123' + /** + * A comma-separated list of fields to order by, sorted in ascending order. + * Use "desc" after a field name for descending. + * Supported fields: + * * `feature_id` + * * `value_type` + * * `create_time` + * * `update_time` + */ + // const orderBy = 'abc123' + /** + * Mask specifying which fields to read. + */ + // const readMask = {} + /** + * If set, return the most recent + * ListFeaturesRequest.latest_stats_count google.cloud.aiplatform.v1.ListFeaturesRequest.latest_stats_count + * of stats for each Feature in response. Valid value is 0, 10. If number of + * stats exists < + * ListFeaturesRequest.latest_stats_count google.cloud.aiplatform.v1.ListFeaturesRequest.latest_stats_count, + * return all existing stats. + */ + // const latestStatsCount = 1234 + + // Imports the Aiplatform library + const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreServiceClient(); + + async function callListFeatures() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listFeaturesAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListFeatures(); + // [END aiplatform_v1_generated_FeaturestoreService_ListFeatures_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.list_featurestores.js b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.list_featurestores.js new file mode 100644 index 00000000000..419164085fa --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.list_featurestores.js @@ -0,0 +1,113 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1_generated_FeaturestoreService_ListFeaturestores_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to list Featurestores. + * Format: + * `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Lists the featurestores that match the filter expression. The following + * fields are supported: + * * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. + * Values must be + * in RFC 3339 format. + * * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. + * Values must be + * in RFC 3339 format. + * * `online_serving_config.fixed_node_count`: Supports `=`, `!=`, `<`, `>`, + * `<=`, and `>=` comparisons. + * * `labels`: Supports key-value equality and key presence. + * Examples: + * * `create_time > "2020-01-01" OR update_time > "2020-01-01"` + * Featurestores created or updated after 2020-01-01. + * * `labels.env = "prod"` + * Featurestores with label "env" set to "prod". + */ + // const filter = 'abc123' + /** + * The maximum number of Featurestores to return. The service may return fewer + * than this value. If unspecified, at most 100 Featurestores will be + * returned. The maximum value is 100; any value greater than 100 will be + * coerced to 100. + */ + // const pageSize = 1234 + /** + * A page token, received from a previous + * FeaturestoreService.ListFeaturestores google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores + * call. Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to + * FeaturestoreService.ListFeaturestores google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores + * must match the call that provided the page token. + */ + // const pageToken = 'abc123' + /** + * A comma-separated list of fields to order by, sorted in ascending order. + * Use "desc" after a field name for descending. + * Supported Fields: + * * `create_time` + * * `update_time` + * * `online_serving_config.fixed_node_count` + */ + // const orderBy = 'abc123' + /** + * Mask specifying which fields to read. + */ + // const readMask = {} + + // Imports the Aiplatform library + const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreServiceClient(); + + async function callListFeaturestores() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listFeaturestoresAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListFeaturestores(); + // [END aiplatform_v1_generated_FeaturestoreService_ListFeaturestores_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.search_features.js b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.search_features.js new file mode 100644 index 00000000000..e88a7d8d4db --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.search_features.js @@ -0,0 +1,132 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(location) { + // [START aiplatform_v1_generated_FeaturestoreService_SearchFeatures_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to search Features. + * Format: + * `projects/{project}/locations/{location}` + */ + // const location = 'abc123' + /** + * Query string that is a conjunction of field-restricted queries and/or + * field-restricted filters. Field-restricted queries and filters can be + * combined using `AND` to form a conjunction. + * A field query is in the form FIELD:QUERY. This implicitly checks if QUERY + * exists as a substring within Feature's FIELD. The QUERY + * and the FIELD are converted to a sequence of words (i.e. tokens) for + * comparison. This is done by: + * * Removing leading/trailing whitespace and tokenizing the search value. + * Characters that are not one of alphanumeric `[a-zA-Z0-9]`, underscore + * `_`, or asterisk `*` are treated as delimiters for tokens. `*` is treated + * as a wildcard that matches characters within a token. + * * Ignoring case. + * * Prepending an asterisk to the first and appending an asterisk to the + * last token in QUERY. + * A QUERY must be either a singular token or a phrase. A phrase is one or + * multiple words enclosed in double quotation marks ("). With phrases, the + * order of the words is important. Words in the phrase must be matching in + * order and consecutively. + * Supported FIELDs for field-restricted queries: + * * `feature_id` + * * `description` + * * `entity_type_id` + * Examples: + * * `feature_id: foo` --> Matches a Feature with ID containing the substring + * `foo` (eg. `foo`, `foofeature`, `barfoo`). + * * `feature_id: foo*feature` --> Matches a Feature with ID containing the + * substring `foo*feature` (eg. `foobarfeature`). + * * `feature_id: foo AND description: bar` --> Matches a Feature with ID + * containing the substring `foo` and description containing the substring + * `bar`. + * Besides field queries, the following exact-match filters are + * supported. The exact-match filters do not support wildcards. Unlike + * field-restricted queries, exact-match filters are case-sensitive. + * * `feature_id`: Supports = comparisons. + * * `description`: Supports = comparisons. Multi-token filters should be + * enclosed in quotes. + * * `entity_type_id`: Supports = comparisons. + * * `value_type`: Supports = and != comparisons. + * * `labels`: Supports key-value equality as well as key presence. + * * `featurestore_id`: Supports = comparisons. + * Examples: + * * `description = "foo bar"` --> Any Feature with description exactly equal + * to `foo bar` + * * `value_type = DOUBLE` --> Features whose type is DOUBLE. + * * `labels.active = yes AND labels.env = prod` --> Features having both + * (active: yes) and (env: prod) labels. + * * `labels.env: *` --> Any Feature which has a label with `env` as the + * key. + */ + // const query = 'abc123' + /** + * The maximum number of Features to return. The service may return fewer + * than this value. If unspecified, at most 100 Features will be returned. + * The maximum value is 100; any value greater than 100 will be coerced to + * 100. + */ + // const pageSize = 1234 + /** + * A page token, received from a previous + * FeaturestoreService.SearchFeatures google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures + * call. Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to + * FeaturestoreService.SearchFeatures google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures, + * except `page_size`, must match the call that provided the page token. + */ + // const pageToken = 'abc123' + + // Imports the Aiplatform library + const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreServiceClient(); + + async function callSearchFeatures() { + // Construct request + const request = { + location, + }; + + // Run request + const iterable = await aiplatformClient.searchFeaturesAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callSearchFeatures(); + // [END aiplatform_v1_generated_FeaturestoreService_SearchFeatures_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.update_entity_type.js b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.update_entity_type.js new file mode 100644 index 00000000000..9178e15569b --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.update_entity_type.js @@ -0,0 +1,84 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(entityType) { + // [START aiplatform_v1_generated_FeaturestoreService_UpdateEntityType_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The EntityType's `name` field is used to identify the EntityType + * to be updated. Format: + * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` + */ + // const entityType = {} + /** + * Field mask is used to specify the fields to be overwritten in the + * EntityType resource by the update. + * The fields specified in the update_mask are relative to the resource, not + * the full request. A field will be overwritten if it is in the mask. If the + * user does not provide a mask then only the non-empty fields present in the + * request will be overwritten. Set the update_mask to `*` to override all + * fields. + * Updatable fields: + * * `description` + * * `labels` + * * `monitoring_config.snapshot_analysis.disabled` + * * `monitoring_config.snapshot_analysis.monitoring_interval_days` + * * `monitoring_config.snapshot_analysis.staleness_days` + * * `monitoring_config.import_features_analysis.state` + * * `monitoring_config.import_features_analysis.anomaly_detection_baseline` + * * `monitoring_config.numerical_threshold_config.value` + * * `monitoring_config.categorical_threshold_config.value` + * * `offline_storage_ttl_days` (available in Preview) + */ + // const updateMask = {} + + // Imports the Aiplatform library + const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreServiceClient(); + + async function callUpdateEntityType() { + // Construct request + const request = { + entityType, + }; + + // Run request + const response = await aiplatformClient.updateEntityType(request); + console.log(response); + } + + callUpdateEntityType(); + // [END aiplatform_v1_generated_FeaturestoreService_UpdateEntityType_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.update_feature.js b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.update_feature.js new file mode 100644 index 00000000000..45de7ac6523 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.update_feature.js @@ -0,0 +1,78 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(feature) { + // [START aiplatform_v1_generated_FeaturestoreService_UpdateFeature_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The Feature's `name` field is used to identify the Feature to be + * updated. + * Format: + * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` + */ + // const feature = {} + /** + * Field mask is used to specify the fields to be overwritten in the + * Features resource by the update. + * The fields specified in the update_mask are relative to the resource, not + * the full request. A field will be overwritten if it is in the mask. If the + * user does not provide a mask then only the non-empty fields present in the + * request will be overwritten. Set the update_mask to `*` to override all + * fields. + * Updatable fields: + * * `description` + * * `labels` + * * `disable_monitoring` + */ + // const updateMask = {} + + // Imports the Aiplatform library + const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreServiceClient(); + + async function callUpdateFeature() { + // Construct request + const request = { + feature, + }; + + // Run request + const response = await aiplatformClient.updateFeature(request); + console.log(response); + } + + callUpdateFeature(); + // [END aiplatform_v1_generated_FeaturestoreService_UpdateFeature_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.update_featurestore.js b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.update_featurestore.js new file mode 100644 index 00000000000..4b299d8bd77 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/featurestore_service.update_featurestore.js @@ -0,0 +1,79 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(featurestore) { + // [START aiplatform_v1_generated_FeaturestoreService_UpdateFeaturestore_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The Featurestore's `name` field is used to identify the + * Featurestore to be updated. Format: + * `projects/{project}/locations/{location}/featurestores/{featurestore}` + */ + // const featurestore = {} + /** + * Field mask is used to specify the fields to be overwritten in the + * Featurestore resource by the update. + * The fields specified in the update_mask are relative to the resource, not + * the full request. A field will be overwritten if it is in the mask. If the + * user does not provide a mask then only the non-empty fields present in the + * request will be overwritten. Set the update_mask to `*` to override all + * fields. + * Updatable fields: + * * `labels` + * * `online_serving_config.fixed_node_count` + * * `online_serving_config.scaling` + * * `online_storage_ttl_days` (available in Preview) + */ + // const updateMask = {} + + // Imports the Aiplatform library + const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreServiceClient(); + + async function callUpdateFeaturestore() { + // Construct request + const request = { + featurestore, + }; + + // Run request + const [operation] = await aiplatformClient.updateFeaturestore(request); + const [response] = await operation.promise(); + console.log(response); + } + + callUpdateFeaturestore(); + // [END aiplatform_v1_generated_FeaturestoreService_UpdateFeaturestore_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/index_endpoint_service.create_index_endpoint.js b/packages/google-cloud-aiplatform/samples/generated/v1/index_endpoint_service.create_index_endpoint.js new file mode 100644 index 00000000000..3688a520700 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/index_endpoint_service.create_index_endpoint.js @@ -0,0 +1,68 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, indexEndpoint) { + // [START aiplatform_v1_generated_IndexEndpointService_CreateIndexEndpoint_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to create the IndexEndpoint in. + * Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Required. The IndexEndpoint to create. + */ + // const indexEndpoint = {} + + // Imports the Aiplatform library + const {IndexEndpointServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new IndexEndpointServiceClient(); + + async function callCreateIndexEndpoint() { + // Construct request + const request = { + parent, + indexEndpoint, + }; + + // Run request + const [operation] = await aiplatformClient.createIndexEndpoint(request); + const [response] = await operation.promise(); + console.log(response); + } + + callCreateIndexEndpoint(); + // [END aiplatform_v1_generated_IndexEndpointService_CreateIndexEndpoint_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/index_endpoint_service.delete_index_endpoint.js b/packages/google-cloud-aiplatform/samples/generated/v1/index_endpoint_service.delete_index_endpoint.js new file mode 100644 index 00000000000..f6afc0de362 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/index_endpoint_service.delete_index_endpoint.js @@ -0,0 +1,64 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_IndexEndpointService_DeleteIndexEndpoint_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the IndexEndpoint resource to be deleted. + * Format: + * `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {IndexEndpointServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new IndexEndpointServiceClient(); + + async function callDeleteIndexEndpoint() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteIndexEndpoint(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteIndexEndpoint(); + // [END aiplatform_v1_generated_IndexEndpointService_DeleteIndexEndpoint_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/index_endpoint_service.deploy_index.js b/packages/google-cloud-aiplatform/samples/generated/v1/index_endpoint_service.deploy_index.js new file mode 100644 index 00000000000..b5668cca683 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/index_endpoint_service.deploy_index.js @@ -0,0 +1,69 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(indexEndpoint, deployedIndex) { + // [START aiplatform_v1_generated_IndexEndpointService_DeployIndex_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the IndexEndpoint resource into which to deploy an + * Index. Format: + * `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}` + */ + // const indexEndpoint = 'abc123' + /** + * Required. The DeployedIndex to be created within the IndexEndpoint. + */ + // const deployedIndex = {} + + // Imports the Aiplatform library + const {IndexEndpointServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new IndexEndpointServiceClient(); + + async function callDeployIndex() { + // Construct request + const request = { + indexEndpoint, + deployedIndex, + }; + + // Run request + const [operation] = await aiplatformClient.deployIndex(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeployIndex(); + // [END aiplatform_v1_generated_IndexEndpointService_DeployIndex_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/index_endpoint_service.get_index_endpoint.js b/packages/google-cloud-aiplatform/samples/generated/v1/index_endpoint_service.get_index_endpoint.js new file mode 100644 index 00000000000..c8074474d26 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/index_endpoint_service.get_index_endpoint.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_IndexEndpointService_GetIndexEndpoint_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the IndexEndpoint resource. + * Format: + * `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {IndexEndpointServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new IndexEndpointServiceClient(); + + async function callGetIndexEndpoint() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getIndexEndpoint(request); + console.log(response); + } + + callGetIndexEndpoint(); + // [END aiplatform_v1_generated_IndexEndpointService_GetIndexEndpoint_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/index_endpoint_service.list_index_endpoints.js b/packages/google-cloud-aiplatform/samples/generated/v1/index_endpoint_service.list_index_endpoints.js new file mode 100644 index 00000000000..4784443a4eb --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/index_endpoint_service.list_index_endpoints.js @@ -0,0 +1,100 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1_generated_IndexEndpointService_ListIndexEndpoints_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location from which to list the + * IndexEndpoints. Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Optional. An expression for filtering the results of the request. For field + * names both snake_case and camelCase are supported. + * * `index_endpoint` supports = and !=. `index_endpoint` represents the + * IndexEndpoint ID, ie. the last segment of the IndexEndpoint's + * resourcename google.cloud.aiplatform.v1.IndexEndpoint.name. + * * `display_name` supports =, != and regex() + * (uses re2 (https://github.com/google/re2/wiki/Syntax) syntax) + * * `labels` supports general map functions that is: + * `labels.key=value` - key:value equality + * `labels.key:* or labels:key - key existence + * A key including a space must be quoted. `labels."a key"`. + * Some examples: + * * `index_endpoint="1"` + * * `display_name="myDisplayName"` + * * `regex(display_name, "^A") -> The display name starts with an A. + * * `labels.myKey="myValue"` + */ + // const filter = 'abc123' + /** + * Optional. The standard list page size. + */ + // const pageSize = 1234 + /** + * Optional. The standard list page token. + * Typically obtained via + * ListIndexEndpointsResponse.next_page_token google.cloud.aiplatform.v1.ListIndexEndpointsResponse.next_page_token + * of the previous + * IndexEndpointService.ListIndexEndpoints google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints + * call. + */ + // const pageToken = 'abc123' + /** + * Optional. Mask specifying which fields to read. + */ + // const readMask = {} + + // Imports the Aiplatform library + const {IndexEndpointServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new IndexEndpointServiceClient(); + + async function callListIndexEndpoints() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listIndexEndpointsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListIndexEndpoints(); + // [END aiplatform_v1_generated_IndexEndpointService_ListIndexEndpoints_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/index_endpoint_service.mutate_deployed_index.js b/packages/google-cloud-aiplatform/samples/generated/v1/index_endpoint_service.mutate_deployed_index.js new file mode 100644 index 00000000000..ed5631cf01a --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/index_endpoint_service.mutate_deployed_index.js @@ -0,0 +1,71 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(indexEndpoint, deployedIndex) { + // [START aiplatform_v1_generated_IndexEndpointService_MutateDeployedIndex_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the IndexEndpoint resource into which to deploy an + * Index. Format: + * `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}` + */ + // const indexEndpoint = 'abc123' + /** + * Required. The DeployedIndex to be updated within the IndexEndpoint. + * Currently, the updatable fields are DeployedIndex automatic_resources + * and DeployedIndex dedicated_resources + */ + // const deployedIndex = {} + + // Imports the Aiplatform library + const {IndexEndpointServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new IndexEndpointServiceClient(); + + async function callMutateDeployedIndex() { + // Construct request + const request = { + indexEndpoint, + deployedIndex, + }; + + // Run request + const [operation] = await aiplatformClient.mutateDeployedIndex(request); + const [response] = await operation.promise(); + console.log(response); + } + + callMutateDeployedIndex(); + // [END aiplatform_v1_generated_IndexEndpointService_MutateDeployedIndex_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/index_endpoint_service.undeploy_index.js b/packages/google-cloud-aiplatform/samples/generated/v1/index_endpoint_service.undeploy_index.js new file mode 100644 index 00000000000..8d6dc0843a7 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/index_endpoint_service.undeploy_index.js @@ -0,0 +1,70 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(indexEndpoint, deployedIndexId) { + // [START aiplatform_v1_generated_IndexEndpointService_UndeployIndex_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the IndexEndpoint resource from which to undeploy an + * Index. Format: + * `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}` + */ + // const indexEndpoint = 'abc123' + /** + * Required. The ID of the DeployedIndex to be undeployed from the + * IndexEndpoint. + */ + // const deployedIndexId = 'abc123' + + // Imports the Aiplatform library + const {IndexEndpointServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new IndexEndpointServiceClient(); + + async function callUndeployIndex() { + // Construct request + const request = { + indexEndpoint, + deployedIndexId, + }; + + // Run request + const [operation] = await aiplatformClient.undeployIndex(request); + const [response] = await operation.promise(); + console.log(response); + } + + callUndeployIndex(); + // [END aiplatform_v1_generated_IndexEndpointService_UndeployIndex_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/index_endpoint_service.update_index_endpoint.js b/packages/google-cloud-aiplatform/samples/generated/v1/index_endpoint_service.update_index_endpoint.js new file mode 100644 index 00000000000..446f63e28d5 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/index_endpoint_service.update_index_endpoint.js @@ -0,0 +1,67 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(indexEndpoint, updateMask) { + // [START aiplatform_v1_generated_IndexEndpointService_UpdateIndexEndpoint_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The IndexEndpoint which replaces the resource on the server. + */ + // const indexEndpoint = {} + /** + * Required. The update mask applies to the resource. See + * google.protobuf.FieldMask google.protobuf.FieldMask. + */ + // const updateMask = {} + + // Imports the Aiplatform library + const {IndexEndpointServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new IndexEndpointServiceClient(); + + async function callUpdateIndexEndpoint() { + // Construct request + const request = { + indexEndpoint, + updateMask, + }; + + // Run request + const response = await aiplatformClient.updateIndexEndpoint(request); + console.log(response); + } + + callUpdateIndexEndpoint(); + // [END aiplatform_v1_generated_IndexEndpointService_UpdateIndexEndpoint_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/index_service.create_index.js b/packages/google-cloud-aiplatform/samples/generated/v1/index_service.create_index.js new file mode 100644 index 00000000000..96f719d0acd --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/index_service.create_index.js @@ -0,0 +1,68 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, index) { + // [START aiplatform_v1_generated_IndexService_CreateIndex_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to create the Index in. + * Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Required. The Index to create. + */ + // const index = {} + + // Imports the Aiplatform library + const {IndexServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new IndexServiceClient(); + + async function callCreateIndex() { + // Construct request + const request = { + parent, + index, + }; + + // Run request + const [operation] = await aiplatformClient.createIndex(request); + const [response] = await operation.promise(); + console.log(response); + } + + callCreateIndex(); + // [END aiplatform_v1_generated_IndexService_CreateIndex_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/index_service.delete_index.js b/packages/google-cloud-aiplatform/samples/generated/v1/index_service.delete_index.js new file mode 100644 index 00000000000..c8ea3119543 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/index_service.delete_index.js @@ -0,0 +1,64 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_IndexService_DeleteIndex_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Index resource to be deleted. + * Format: + * `projects/{project}/locations/{location}/indexes/{index}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {IndexServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new IndexServiceClient(); + + async function callDeleteIndex() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteIndex(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteIndex(); + // [END aiplatform_v1_generated_IndexService_DeleteIndex_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/index_service.get_index.js b/packages/google-cloud-aiplatform/samples/generated/v1/index_service.get_index.js new file mode 100644 index 00000000000..69dd9c076fe --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/index_service.get_index.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_IndexService_GetIndex_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Index resource. + * Format: + * `projects/{project}/locations/{location}/indexes/{index}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {IndexServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new IndexServiceClient(); + + async function callGetIndex() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getIndex(request); + console.log(response); + } + + callGetIndex(); + // [END aiplatform_v1_generated_IndexService_GetIndex_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/index_service.list_indexes.js b/packages/google-cloud-aiplatform/samples/generated/v1/index_service.list_indexes.js new file mode 100644 index 00000000000..474e55281f4 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/index_service.list_indexes.js @@ -0,0 +1,85 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1_generated_IndexService_ListIndexes_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location from which to list the Indexes. + * Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * The standard list filter. + */ + // const filter = 'abc123' + /** + * The standard list page size. + */ + // const pageSize = 1234 + /** + * The standard list page token. + * Typically obtained via + * ListIndexesResponse.next_page_token google.cloud.aiplatform.v1.ListIndexesResponse.next_page_token + * of the previous + * IndexService.ListIndexes google.cloud.aiplatform.v1.IndexService.ListIndexes + * call. + */ + // const pageToken = 'abc123' + /** + * Mask specifying which fields to read. + */ + // const readMask = {} + + // Imports the Aiplatform library + const {IndexServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new IndexServiceClient(); + + async function callListIndexes() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listIndexesAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListIndexes(); + // [END aiplatform_v1_generated_IndexService_ListIndexes_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/index_service.remove_datapoints.js b/packages/google-cloud-aiplatform/samples/generated/v1/index_service.remove_datapoints.js new file mode 100644 index 00000000000..4d5f4f26775 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/index_service.remove_datapoints.js @@ -0,0 +1,67 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(index) { + // [START aiplatform_v1_generated_IndexService_RemoveDatapoints_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Index resource to be updated. + * Format: + * `projects/{project}/locations/{location}/indexes/{index}` + */ + // const index = 'abc123' + /** + * A list of datapoint ids to be deleted. + */ + // const datapointIds = 'abc123' + + // Imports the Aiplatform library + const {IndexServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new IndexServiceClient(); + + async function callRemoveDatapoints() { + // Construct request + const request = { + index, + }; + + // Run request + const response = await aiplatformClient.removeDatapoints(request); + console.log(response); + } + + callRemoveDatapoints(); + // [END aiplatform_v1_generated_IndexService_RemoveDatapoints_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/index_service.update_index.js b/packages/google-cloud-aiplatform/samples/generated/v1/index_service.update_index.js new file mode 100644 index 00000000000..6f671bbe115 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/index_service.update_index.js @@ -0,0 +1,68 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(index) { + // [START aiplatform_v1_generated_IndexService_UpdateIndex_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The Index which updates the resource on the server. + */ + // const index = {} + /** + * The update mask applies to the resource. + * For the `FieldMask` definition, see + * google.protobuf.FieldMask google.protobuf.FieldMask. + */ + // const updateMask = {} + + // Imports the Aiplatform library + const {IndexServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new IndexServiceClient(); + + async function callUpdateIndex() { + // Construct request + const request = { + index, + }; + + // Run request + const [operation] = await aiplatformClient.updateIndex(request); + const [response] = await operation.promise(); + console.log(response); + } + + callUpdateIndex(); + // [END aiplatform_v1_generated_IndexService_UpdateIndex_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/index_service.upsert_datapoints.js b/packages/google-cloud-aiplatform/samples/generated/v1/index_service.upsert_datapoints.js new file mode 100644 index 00000000000..96dd27c0e06 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/index_service.upsert_datapoints.js @@ -0,0 +1,67 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(index) { + // [START aiplatform_v1_generated_IndexService_UpsertDatapoints_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Index resource to be updated. + * Format: + * `projects/{project}/locations/{location}/indexes/{index}` + */ + // const index = 'abc123' + /** + * A list of datapoints to be created/updated. + */ + // const datapoints = 1234 + + // Imports the Aiplatform library + const {IndexServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new IndexServiceClient(); + + async function callUpsertDatapoints() { + // Construct request + const request = { + index, + }; + + // Run request + const response = await aiplatformClient.upsertDatapoints(request); + console.log(response); + } + + callUpsertDatapoints(); + // [END aiplatform_v1_generated_IndexService_UpsertDatapoints_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/job_service.cancel_batch_prediction_job.js b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.cancel_batch_prediction_job.js new file mode 100644 index 00000000000..b3e689f0b2e --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.cancel_batch_prediction_job.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_JobService_CancelBatchPredictionJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the BatchPredictionJob to cancel. + * Format: + * `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callCancelBatchPredictionJob() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.cancelBatchPredictionJob(request); + console.log(response); + } + + callCancelBatchPredictionJob(); + // [END aiplatform_v1_generated_JobService_CancelBatchPredictionJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/job_service.cancel_custom_job.js b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.cancel_custom_job.js new file mode 100644 index 00000000000..aae106f67a3 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.cancel_custom_job.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_JobService_CancelCustomJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the CustomJob to cancel. + * Format: + * `projects/{project}/locations/{location}/customJobs/{custom_job}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callCancelCustomJob() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.cancelCustomJob(request); + console.log(response); + } + + callCancelCustomJob(); + // [END aiplatform_v1_generated_JobService_CancelCustomJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/job_service.cancel_data_labeling_job.js b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.cancel_data_labeling_job.js new file mode 100644 index 00000000000..78f26a4dffe --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.cancel_data_labeling_job.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_JobService_CancelDataLabelingJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the DataLabelingJob. + * Format: + * `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callCancelDataLabelingJob() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.cancelDataLabelingJob(request); + console.log(response); + } + + callCancelDataLabelingJob(); + // [END aiplatform_v1_generated_JobService_CancelDataLabelingJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/job_service.cancel_hyperparameter_tuning_job.js b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.cancel_hyperparameter_tuning_job.js new file mode 100644 index 00000000000..a4c1ba0fd37 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.cancel_hyperparameter_tuning_job.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_JobService_CancelHyperparameterTuningJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the HyperparameterTuningJob to cancel. + * Format: + * `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callCancelHyperparameterTuningJob() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.cancelHyperparameterTuningJob(request); + console.log(response); + } + + callCancelHyperparameterTuningJob(); + // [END aiplatform_v1_generated_JobService_CancelHyperparameterTuningJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/job_service.create_batch_prediction_job.js b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.create_batch_prediction_job.js new file mode 100644 index 00000000000..992c6879bcd --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.create_batch_prediction_job.js @@ -0,0 +1,67 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, batchPredictionJob) { + // [START aiplatform_v1_generated_JobService_CreateBatchPredictionJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to create the + * BatchPredictionJob in. Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Required. The BatchPredictionJob to create. + */ + // const batchPredictionJob = {} + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callCreateBatchPredictionJob() { + // Construct request + const request = { + parent, + batchPredictionJob, + }; + + // Run request + const response = await aiplatformClient.createBatchPredictionJob(request); + console.log(response); + } + + callCreateBatchPredictionJob(); + // [END aiplatform_v1_generated_JobService_CreateBatchPredictionJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/job_service.create_custom_job.js b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.create_custom_job.js new file mode 100644 index 00000000000..9d1f72ff699 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.create_custom_job.js @@ -0,0 +1,67 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, customJob) { + // [START aiplatform_v1_generated_JobService_CreateCustomJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to create the CustomJob in. + * Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Required. The CustomJob to create. + */ + // const customJob = {} + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callCreateCustomJob() { + // Construct request + const request = { + parent, + customJob, + }; + + // Run request + const response = await aiplatformClient.createCustomJob(request); + console.log(response); + } + + callCreateCustomJob(); + // [END aiplatform_v1_generated_JobService_CreateCustomJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/job_service.create_data_labeling_job.js b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.create_data_labeling_job.js new file mode 100644 index 00000000000..bbe87b63086 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.create_data_labeling_job.js @@ -0,0 +1,67 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, dataLabelingJob) { + // [START aiplatform_v1_generated_JobService_CreateDataLabelingJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The parent of the DataLabelingJob. + * Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Required. The DataLabelingJob to create. + */ + // const dataLabelingJob = {} + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callCreateDataLabelingJob() { + // Construct request + const request = { + parent, + dataLabelingJob, + }; + + // Run request + const response = await aiplatformClient.createDataLabelingJob(request); + console.log(response); + } + + callCreateDataLabelingJob(); + // [END aiplatform_v1_generated_JobService_CreateDataLabelingJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/job_service.create_hyperparameter_tuning_job.js b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.create_hyperparameter_tuning_job.js new file mode 100644 index 00000000000..3fb8e0f226e --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.create_hyperparameter_tuning_job.js @@ -0,0 +1,68 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, hyperparameterTuningJob) { + // [START aiplatform_v1_generated_JobService_CreateHyperparameterTuningJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to create the + * HyperparameterTuningJob in. Format: + * `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Required. The HyperparameterTuningJob to create. + */ + // const hyperparameterTuningJob = {} + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callCreateHyperparameterTuningJob() { + // Construct request + const request = { + parent, + hyperparameterTuningJob, + }; + + // Run request + const response = await aiplatformClient.createHyperparameterTuningJob(request); + console.log(response); + } + + callCreateHyperparameterTuningJob(); + // [END aiplatform_v1_generated_JobService_CreateHyperparameterTuningJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/job_service.create_model_deployment_monitoring_job.js b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.create_model_deployment_monitoring_job.js new file mode 100644 index 00000000000..f4576f81ed7 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.create_model_deployment_monitoring_job.js @@ -0,0 +1,67 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, modelDeploymentMonitoringJob) { + // [START aiplatform_v1_generated_JobService_CreateModelDeploymentMonitoringJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The parent of the ModelDeploymentMonitoringJob. + * Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Required. The ModelDeploymentMonitoringJob to create + */ + // const modelDeploymentMonitoringJob = {} + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callCreateModelDeploymentMonitoringJob() { + // Construct request + const request = { + parent, + modelDeploymentMonitoringJob, + }; + + // Run request + const response = await aiplatformClient.createModelDeploymentMonitoringJob(request); + console.log(response); + } + + callCreateModelDeploymentMonitoringJob(); + // [END aiplatform_v1_generated_JobService_CreateModelDeploymentMonitoringJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/job_service.delete_batch_prediction_job.js b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.delete_batch_prediction_job.js new file mode 100644 index 00000000000..80246f6cff7 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.delete_batch_prediction_job.js @@ -0,0 +1,64 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_JobService_DeleteBatchPredictionJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the BatchPredictionJob resource to be deleted. + * Format: + * `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callDeleteBatchPredictionJob() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteBatchPredictionJob(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteBatchPredictionJob(); + // [END aiplatform_v1_generated_JobService_DeleteBatchPredictionJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/job_service.delete_custom_job.js b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.delete_custom_job.js new file mode 100644 index 00000000000..c9cb4ca274c --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.delete_custom_job.js @@ -0,0 +1,64 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_JobService_DeleteCustomJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the CustomJob resource to be deleted. + * Format: + * `projects/{project}/locations/{location}/customJobs/{custom_job}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callDeleteCustomJob() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteCustomJob(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteCustomJob(); + // [END aiplatform_v1_generated_JobService_DeleteCustomJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/job_service.delete_data_labeling_job.js b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.delete_data_labeling_job.js new file mode 100644 index 00000000000..ec6c03d52d1 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.delete_data_labeling_job.js @@ -0,0 +1,64 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_JobService_DeleteDataLabelingJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the DataLabelingJob to be deleted. + * Format: + * `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callDeleteDataLabelingJob() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteDataLabelingJob(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteDataLabelingJob(); + // [END aiplatform_v1_generated_JobService_DeleteDataLabelingJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/job_service.delete_hyperparameter_tuning_job.js b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.delete_hyperparameter_tuning_job.js new file mode 100644 index 00000000000..c88ecec953b --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.delete_hyperparameter_tuning_job.js @@ -0,0 +1,64 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_JobService_DeleteHyperparameterTuningJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the HyperparameterTuningJob resource to be deleted. + * Format: + * `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callDeleteHyperparameterTuningJob() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteHyperparameterTuningJob(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteHyperparameterTuningJob(); + // [END aiplatform_v1_generated_JobService_DeleteHyperparameterTuningJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/job_service.delete_model_deployment_monitoring_job.js b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.delete_model_deployment_monitoring_job.js new file mode 100644 index 00000000000..1cb4c9ffbaf --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.delete_model_deployment_monitoring_job.js @@ -0,0 +1,64 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_JobService_DeleteModelDeploymentMonitoringJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the model monitoring job to delete. + * Format: + * `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callDeleteModelDeploymentMonitoringJob() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteModelDeploymentMonitoringJob(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteModelDeploymentMonitoringJob(); + // [END aiplatform_v1_generated_JobService_DeleteModelDeploymentMonitoringJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/job_service.get_batch_prediction_job.js b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.get_batch_prediction_job.js new file mode 100644 index 00000000000..97fcf89f839 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.get_batch_prediction_job.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_JobService_GetBatchPredictionJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the BatchPredictionJob resource. + * Format: + * `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callGetBatchPredictionJob() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getBatchPredictionJob(request); + console.log(response); + } + + callGetBatchPredictionJob(); + // [END aiplatform_v1_generated_JobService_GetBatchPredictionJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/job_service.get_custom_job.js b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.get_custom_job.js new file mode 100644 index 00000000000..433a6bcb16f --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.get_custom_job.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_JobService_GetCustomJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the CustomJob resource. + * Format: + * `projects/{project}/locations/{location}/customJobs/{custom_job}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callGetCustomJob() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getCustomJob(request); + console.log(response); + } + + callGetCustomJob(); + // [END aiplatform_v1_generated_JobService_GetCustomJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/job_service.get_data_labeling_job.js b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.get_data_labeling_job.js new file mode 100644 index 00000000000..18380348cde --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.get_data_labeling_job.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_JobService_GetDataLabelingJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the DataLabelingJob. + * Format: + * `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callGetDataLabelingJob() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getDataLabelingJob(request); + console.log(response); + } + + callGetDataLabelingJob(); + // [END aiplatform_v1_generated_JobService_GetDataLabelingJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/job_service.get_hyperparameter_tuning_job.js b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.get_hyperparameter_tuning_job.js new file mode 100644 index 00000000000..a4da58de2ba --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.get_hyperparameter_tuning_job.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_JobService_GetHyperparameterTuningJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the HyperparameterTuningJob resource. + * Format: + * `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callGetHyperparameterTuningJob() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getHyperparameterTuningJob(request); + console.log(response); + } + + callGetHyperparameterTuningJob(); + // [END aiplatform_v1_generated_JobService_GetHyperparameterTuningJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/job_service.get_model_deployment_monitoring_job.js b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.get_model_deployment_monitoring_job.js new file mode 100644 index 00000000000..36c631468b5 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.get_model_deployment_monitoring_job.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_JobService_GetModelDeploymentMonitoringJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the ModelDeploymentMonitoringJob. + * Format: + * `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callGetModelDeploymentMonitoringJob() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getModelDeploymentMonitoringJob(request); + console.log(response); + } + + callGetModelDeploymentMonitoringJob(); + // [END aiplatform_v1_generated_JobService_GetModelDeploymentMonitoringJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/job_service.list_batch_prediction_jobs.js b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.list_batch_prediction_jobs.js new file mode 100644 index 00000000000..d30d38b47ae --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.list_batch_prediction_jobs.js @@ -0,0 +1,101 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1_generated_JobService_ListBatchPredictionJobs_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to list the BatchPredictionJobs + * from. Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * The standard list filter. + * Supported fields: + * * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. + * * `model_display_name` supports `=`, `!=` comparisons. + * * `state` supports `=`, `!=` comparisons. + * * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. + * `create_time` must be in RFC 3339 format. + * * `labels` supports general map functions that is: + * `labels.key=value` - key:value equality + * `labels.key:* - key existence + * Some examples of using the filter are: + * * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` + * * `state!="JOB_STATE_FAILED" OR display_name="my_job"` + * * `NOT display_name="my_job"` + * * `create_time>"2021-05-18T00:00:00Z"` + * * `labels.keyA=valueA` + * * `labels.keyB:*` + */ + // const filter = 'abc123' + /** + * The standard list page size. + */ + // const pageSize = 1234 + /** + * The standard list page token. + * Typically obtained via + * ListBatchPredictionJobsResponse.next_page_token google.cloud.aiplatform.v1.ListBatchPredictionJobsResponse.next_page_token + * of the previous + * JobService.ListBatchPredictionJobs google.cloud.aiplatform.v1.JobService.ListBatchPredictionJobs + * call. + */ + // const pageToken = 'abc123' + /** + * Mask specifying which fields to read. + */ + // const readMask = {} + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callListBatchPredictionJobs() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listBatchPredictionJobsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListBatchPredictionJobs(); + // [END aiplatform_v1_generated_JobService_ListBatchPredictionJobs_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/job_service.list_custom_jobs.js b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.list_custom_jobs.js new file mode 100644 index 00000000000..ecca8280c06 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.list_custom_jobs.js @@ -0,0 +1,100 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1_generated_JobService_ListCustomJobs_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to list the CustomJobs from. + * Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * The standard list filter. + * Supported fields: + * * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. + * * `state` supports `=`, `!=` comparisons. + * * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. + * `create_time` must be in RFC 3339 format. + * * `labels` supports general map functions that is: + * `labels.key=value` - key:value equality + * `labels.key:* - key existence + * Some examples of using the filter are: + * * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` + * * `state!="JOB_STATE_FAILED" OR display_name="my_job"` + * * `NOT display_name="my_job"` + * * `create_time>"2021-05-18T00:00:00Z"` + * * `labels.keyA=valueA` + * * `labels.keyB:*` + */ + // const filter = 'abc123' + /** + * The standard list page size. + */ + // const pageSize = 1234 + /** + * The standard list page token. + * Typically obtained via + * ListCustomJobsResponse.next_page_token google.cloud.aiplatform.v1.ListCustomJobsResponse.next_page_token + * of the previous + * JobService.ListCustomJobs google.cloud.aiplatform.v1.JobService.ListCustomJobs + * call. + */ + // const pageToken = 'abc123' + /** + * Mask specifying which fields to read. + */ + // const readMask = {} + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callListCustomJobs() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listCustomJobsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListCustomJobs(); + // [END aiplatform_v1_generated_JobService_ListCustomJobs_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/job_service.list_data_labeling_jobs.js b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.list_data_labeling_jobs.js new file mode 100644 index 00000000000..0bb12aa4668 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.list_data_labeling_jobs.js @@ -0,0 +1,104 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1_generated_JobService_ListDataLabelingJobs_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The parent of the DataLabelingJob. + * Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * The standard list filter. + * Supported fields: + * * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. + * * `state` supports `=`, `!=` comparisons. + * * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. + * `create_time` must be in RFC 3339 format. + * * `labels` supports general map functions that is: + * `labels.key=value` - key:value equality + * `labels.key:* - key existence + * Some examples of using the filter are: + * * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` + * * `state!="JOB_STATE_FAILED" OR display_name="my_job"` + * * `NOT display_name="my_job"` + * * `create_time>"2021-05-18T00:00:00Z"` + * * `labels.keyA=valueA` + * * `labels.keyB:*` + */ + // const filter = 'abc123' + /** + * The standard list page size. + */ + // const pageSize = 1234 + /** + * The standard list page token. + */ + // const pageToken = 'abc123' + /** + * Mask specifying which fields to read. FieldMask represents a set of + * symbolic field paths. For example, the mask can be `paths: "name"`. The + * "name" here is a field in DataLabelingJob. + * If this field is not set, all fields of the DataLabelingJob are returned. + */ + // const readMask = {} + /** + * A comma-separated list of fields to order by, sorted in ascending order by + * default. + * Use `desc` after a field name for descending. + */ + // const orderBy = 'abc123' + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callListDataLabelingJobs() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listDataLabelingJobsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListDataLabelingJobs(); + // [END aiplatform_v1_generated_JobService_ListDataLabelingJobs_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/job_service.list_hyperparameter_tuning_jobs.js b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.list_hyperparameter_tuning_jobs.js new file mode 100644 index 00000000000..d733f3cc023 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.list_hyperparameter_tuning_jobs.js @@ -0,0 +1,101 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1_generated_JobService_ListHyperparameterTuningJobs_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to list the + * HyperparameterTuningJobs from. Format: + * `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * The standard list filter. + * Supported fields: + * * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. + * * `state` supports `=`, `!=` comparisons. + * * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. + * `create_time` must be in RFC 3339 format. + * * `labels` supports general map functions that is: + * `labels.key=value` - key:value equality + * `labels.key:* - key existence + * Some examples of using the filter are: + * * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` + * * `state!="JOB_STATE_FAILED" OR display_name="my_job"` + * * `NOT display_name="my_job"` + * * `create_time>"2021-05-18T00:00:00Z"` + * * `labels.keyA=valueA` + * * `labels.keyB:*` + */ + // const filter = 'abc123' + /** + * The standard list page size. + */ + // const pageSize = 1234 + /** + * The standard list page token. + * Typically obtained via + * ListHyperparameterTuningJobsResponse.next_page_token google.cloud.aiplatform.v1.ListHyperparameterTuningJobsResponse.next_page_token + * of the previous + * JobService.ListHyperparameterTuningJobs google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs + * call. + */ + // const pageToken = 'abc123' + /** + * Mask specifying which fields to read. + */ + // const readMask = {} + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callListHyperparameterTuningJobs() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listHyperparameterTuningJobsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListHyperparameterTuningJobs(); + // [END aiplatform_v1_generated_JobService_ListHyperparameterTuningJobs_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/job_service.list_model_deployment_monitoring_jobs.js b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.list_model_deployment_monitoring_jobs.js new file mode 100644 index 00000000000..51669890fb9 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.list_model_deployment_monitoring_jobs.js @@ -0,0 +1,95 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1_generated_JobService_ListModelDeploymentMonitoringJobs_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The parent of the ModelDeploymentMonitoringJob. + * Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * The standard list filter. + * Supported fields: + * * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. + * * `state` supports `=`, `!=` comparisons. + * * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. + * `create_time` must be in RFC 3339 format. + * * `labels` supports general map functions that is: + * `labels.key=value` - key:value equality + * `labels.key:* - key existence + * Some examples of using the filter are: + * * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` + * * `state!="JOB_STATE_FAILED" OR display_name="my_job"` + * * `NOT display_name="my_job"` + * * `create_time>"2021-05-18T00:00:00Z"` + * * `labels.keyA=valueA` + * * `labels.keyB:*` + */ + // const filter = 'abc123' + /** + * The standard list page size. + */ + // const pageSize = 1234 + /** + * The standard list page token. + */ + // const pageToken = 'abc123' + /** + * Mask specifying which fields to read + */ + // const readMask = {} + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callListModelDeploymentMonitoringJobs() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listModelDeploymentMonitoringJobsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListModelDeploymentMonitoringJobs(); + // [END aiplatform_v1_generated_JobService_ListModelDeploymentMonitoringJobs_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/job_service.pause_model_deployment_monitoring_job.js b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.pause_model_deployment_monitoring_job.js new file mode 100644 index 00000000000..e235b414cb8 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.pause_model_deployment_monitoring_job.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_JobService_PauseModelDeploymentMonitoringJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the ModelDeploymentMonitoringJob to pause. + * Format: + * `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callPauseModelDeploymentMonitoringJob() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.pauseModelDeploymentMonitoringJob(request); + console.log(response); + } + + callPauseModelDeploymentMonitoringJob(); + // [END aiplatform_v1_generated_JobService_PauseModelDeploymentMonitoringJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/job_service.resume_model_deployment_monitoring_job.js b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.resume_model_deployment_monitoring_job.js new file mode 100644 index 00000000000..451980c9868 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.resume_model_deployment_monitoring_job.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_JobService_ResumeModelDeploymentMonitoringJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the ModelDeploymentMonitoringJob to resume. + * Format: + * `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callResumeModelDeploymentMonitoringJob() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.resumeModelDeploymentMonitoringJob(request); + console.log(response); + } + + callResumeModelDeploymentMonitoringJob(); + // [END aiplatform_v1_generated_JobService_ResumeModelDeploymentMonitoringJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/job_service.search_model_deployment_monitoring_stats_anomalies.js b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.search_model_deployment_monitoring_stats_anomalies.js new file mode 100644 index 00000000000..66cd739cfa6 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.search_model_deployment_monitoring_stats_anomalies.js @@ -0,0 +1,103 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(modelDeploymentMonitoringJob, deployedModelId, objectives) { + // [START aiplatform_v1_generated_JobService_SearchModelDeploymentMonitoringStatsAnomalies_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. ModelDeploymentMonitoring Job resource name. + * Format: + * `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}` + */ + // const modelDeploymentMonitoringJob = 'abc123' + /** + * Required. The DeployedModel ID of the + * ModelDeploymentMonitoringObjectiveConfig.deployed_model_id. + */ + // const deployedModelId = 'abc123' + /** + * The feature display name. If specified, only return the stats belonging to + * this feature. Format: + * ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name google.cloud.aiplatform.v1.ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name, + * example: "user_destination". + */ + // const featureDisplayName = 'abc123' + /** + * Required. Objectives of the stats to retrieve. + */ + // const objectives = 1234 + /** + * The standard list page size. + */ + // const pageSize = 1234 + /** + * A page token received from a previous + * JobService.SearchModelDeploymentMonitoringStatsAnomalies google.cloud.aiplatform.v1.JobService.SearchModelDeploymentMonitoringStatsAnomalies + * call. + */ + // const pageToken = 'abc123' + /** + * The earliest timestamp of stats being generated. + * If not set, indicates fetching stats till the earliest possible one. + */ + // const startTime = {} + /** + * The latest timestamp of stats being generated. + * If not set, indicates feching stats till the latest possible one. + */ + // const endTime = {} + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callSearchModelDeploymentMonitoringStatsAnomalies() { + // Construct request + const request = { + modelDeploymentMonitoringJob, + deployedModelId, + objectives, + }; + + // Run request + const iterable = await aiplatformClient.searchModelDeploymentMonitoringStatsAnomaliesAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callSearchModelDeploymentMonitoringStatsAnomalies(); + // [END aiplatform_v1_generated_JobService_SearchModelDeploymentMonitoringStatsAnomalies_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/job_service.update_model_deployment_monitoring_job.js b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.update_model_deployment_monitoring_job.js new file mode 100644 index 00000000000..17fb96b1688 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/job_service.update_model_deployment_monitoring_job.js @@ -0,0 +1,91 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(modelDeploymentMonitoringJob, updateMask) { + // [START aiplatform_v1_generated_JobService_UpdateModelDeploymentMonitoringJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The model monitoring configuration which replaces the resource on + * the server. + */ + // const modelDeploymentMonitoringJob = {} + /** + * Required. The update mask is used to specify the fields to be overwritten + * in the ModelDeploymentMonitoringJob resource by the update. The fields + * specified in the update_mask are relative to the resource, not the full + * request. A field will be overwritten if it is in the mask. If the user does + * not provide a mask then only the non-empty fields present in the request + * will be overwritten. Set the update_mask to `*` to override all fields. For + * the objective config, the user can either provide the update mask for + * model_deployment_monitoring_objective_configs or any combination of its + * nested fields, such as: + * model_deployment_monitoring_objective_configs.objective_config.training_dataset. + * Updatable fields: + * * `display_name` + * * `model_deployment_monitoring_schedule_config` + * * `model_monitoring_alert_config` + * * `logging_sampling_strategy` + * * `labels` + * * `log_ttl` + * * `enable_monitoring_pipeline_logs` + * . and + * * `model_deployment_monitoring_objective_configs` + * . or + * * `model_deployment_monitoring_objective_configs.objective_config.training_dataset` + * * `model_deployment_monitoring_objective_configs.objective_config.training_prediction_skew_detection_config` + * * `model_deployment_monitoring_objective_configs.objective_config.prediction_drift_detection_config` + */ + // const updateMask = {} + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callUpdateModelDeploymentMonitoringJob() { + // Construct request + const request = { + modelDeploymentMonitoringJob, + updateMask, + }; + + // Run request + const [operation] = await aiplatformClient.updateModelDeploymentMonitoringJob(request); + const [response] = await operation.promise(); + console.log(response); + } + + callUpdateModelDeploymentMonitoringJob(); + // [END aiplatform_v1_generated_JobService_UpdateModelDeploymentMonitoringJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.add_context_artifacts_and_executions.js b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.add_context_artifacts_and_executions.js new file mode 100644 index 00000000000..8eed91b6b01 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.add_context_artifacts_and_executions.js @@ -0,0 +1,76 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(context) { + // [START aiplatform_v1_generated_MetadataService_AddContextArtifactsAndExecutions_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Context that the Artifacts and + * Executions belong to. Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}` + */ + // const context = 'abc123' + /** + * The resource names of the Artifacts to attribute to the Context. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` + */ + // const artifacts = 'abc123' + /** + * The resource names of the Executions to associate with the + * Context. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` + */ + // const executions = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callAddContextArtifactsAndExecutions() { + // Construct request + const request = { + context, + }; + + // Run request + const response = await aiplatformClient.addContextArtifactsAndExecutions(request); + console.log(response); + } + + callAddContextArtifactsAndExecutions(); + // [END aiplatform_v1_generated_MetadataService_AddContextArtifactsAndExecutions_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.add_context_children.js b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.add_context_children.js new file mode 100644 index 00000000000..591c72a7523 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.add_context_children.js @@ -0,0 +1,67 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(context) { + // [START aiplatform_v1_generated_MetadataService_AddContextChildren_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the parent Context. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}` + */ + // const context = 'abc123' + /** + * The resource names of the child Contexts. + */ + // const childContexts = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callAddContextChildren() { + // Construct request + const request = { + context, + }; + + // Run request + const response = await aiplatformClient.addContextChildren(request); + console.log(response); + } + + callAddContextChildren(); + // [END aiplatform_v1_generated_MetadataService_AddContextChildren_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.add_execution_events.js b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.add_execution_events.js new file mode 100644 index 00000000000..8d09f93968c --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.add_execution_events.js @@ -0,0 +1,68 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(execution) { + // [START aiplatform_v1_generated_MetadataService_AddExecutionEvents_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Execution that the Events connect + * Artifacts with. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` + */ + // const execution = 'abc123' + /** + * The Events to create and add. + */ + // const events = 1234 + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callAddExecutionEvents() { + // Construct request + const request = { + execution, + }; + + // Run request + const response = await aiplatformClient.addExecutionEvents(request); + console.log(response); + } + + callAddExecutionEvents(); + // [END aiplatform_v1_generated_MetadataService_AddExecutionEvents_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.create_artifact.js b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.create_artifact.js new file mode 100644 index 00000000000..1530ecf9308 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.create_artifact.js @@ -0,0 +1,79 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, artifact) { + // [START aiplatform_v1_generated_MetadataService_CreateArtifact_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the MetadataStore where the Artifact should + * be created. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}` + */ + // const parent = 'abc123' + /** + * Required. The Artifact to create. + */ + // const artifact = {} + /** + * The {artifact} portion of the resource name with the format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` + * If not provided, the Artifact's ID will be a UUID generated by the service. + * Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`. + * Must be unique across all Artifacts in the parent MetadataStore. (Otherwise + * the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the + * caller can't view the preexisting Artifact.) + */ + // const artifactId = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callCreateArtifact() { + // Construct request + const request = { + parent, + artifact, + }; + + // Run request + const response = await aiplatformClient.createArtifact(request); + console.log(response); + } + + callCreateArtifact(); + // [END aiplatform_v1_generated_MetadataService_CreateArtifact_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.create_context.js b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.create_context.js new file mode 100644 index 00000000000..f1f4c3d2c11 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.create_context.js @@ -0,0 +1,78 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, context) { + // [START aiplatform_v1_generated_MetadataService_CreateContext_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the MetadataStore where the Context should + * be created. Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}` + */ + // const parent = 'abc123' + /** + * Required. The Context to create. + */ + // const context = {} + /** + * The {context} portion of the resource name with the format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`. + * If not provided, the Context's ID will be a UUID generated by the service. + * Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`. + * Must be unique across all Contexts in the parent MetadataStore. (Otherwise + * the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the + * caller can't view the preexisting Context.) + */ + // const contextId = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callCreateContext() { + // Construct request + const request = { + parent, + context, + }; + + // Run request + const response = await aiplatformClient.createContext(request); + console.log(response); + } + + callCreateContext(); + // [END aiplatform_v1_generated_MetadataService_CreateContext_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.create_execution.js b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.create_execution.js new file mode 100644 index 00000000000..d285cabe2f5 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.create_execution.js @@ -0,0 +1,80 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, execution) { + // [START aiplatform_v1_generated_MetadataService_CreateExecution_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the MetadataStore where the Execution should + * be created. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}` + */ + // const parent = 'abc123' + /** + * Required. The Execution to create. + */ + // const execution = {} + /** + * The {execution} portion of the resource name with the format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` + * If not provided, the Execution's ID will be a UUID generated by the + * service. + * Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`. + * Must be unique across all Executions in the parent MetadataStore. + * (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED + * if the caller can't view the preexisting Execution.) + */ + // const executionId = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callCreateExecution() { + // Construct request + const request = { + parent, + execution, + }; + + // Run request + const response = await aiplatformClient.createExecution(request); + console.log(response); + } + + callCreateExecution(); + // [END aiplatform_v1_generated_MetadataService_CreateExecution_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.create_metadata_schema.js b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.create_metadata_schema.js new file mode 100644 index 00000000000..dd316e7bf51 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.create_metadata_schema.js @@ -0,0 +1,79 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, metadataSchema) { + // [START aiplatform_v1_generated_MetadataService_CreateMetadataSchema_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the MetadataStore where the MetadataSchema + * should be created. Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}` + */ + // const parent = 'abc123' + /** + * Required. The MetadataSchema to create. + */ + // const metadataSchema = {} + /** + * The {metadata_schema} portion of the resource name with the format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema}` + * If not provided, the MetadataStore's ID will be a UUID generated by the + * service. + * Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`. + * Must be unique across all MetadataSchemas in the parent Location. + * (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED + * if the caller can't view the preexisting MetadataSchema.) + */ + // const metadataSchemaId = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callCreateMetadataSchema() { + // Construct request + const request = { + parent, + metadataSchema, + }; + + // Run request + const response = await aiplatformClient.createMetadataSchema(request); + console.log(response); + } + + callCreateMetadataSchema(); + // [END aiplatform_v1_generated_MetadataService_CreateMetadataSchema_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.create_metadata_store.js b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.create_metadata_store.js new file mode 100644 index 00000000000..50ade504cb8 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.create_metadata_store.js @@ -0,0 +1,80 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, metadataStore) { + // [START aiplatform_v1_generated_MetadataService_CreateMetadataStore_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location where the MetadataStore should + * be created. + * Format: `projects/{project}/locations/{location}/` + */ + // const parent = 'abc123' + /** + * Required. The MetadataStore to create. + */ + // const metadataStore = {} + /** + * The {metadatastore} portion of the resource name with the format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}` + * If not provided, the MetadataStore's ID will be a UUID generated by the + * service. + * Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`. + * Must be unique across all MetadataStores in the parent Location. + * (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED + * if the caller can't view the preexisting MetadataStore.) + */ + // const metadataStoreId = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callCreateMetadataStore() { + // Construct request + const request = { + parent, + metadataStore, + }; + + // Run request + const [operation] = await aiplatformClient.createMetadataStore(request); + const [response] = await operation.promise(); + console.log(response); + } + + callCreateMetadataStore(); + // [END aiplatform_v1_generated_MetadataService_CreateMetadataStore_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.delete_artifact.js b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.delete_artifact.js new file mode 100644 index 00000000000..fbfefe82b19 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.delete_artifact.js @@ -0,0 +1,70 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_MetadataService_DeleteArtifact_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Artifact to delete. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` + */ + // const name = 'abc123' + /** + * Optional. The etag of the Artifact to delete. + * If this is provided, it must match the server's etag. Otherwise, the + * request will fail with a FAILED_PRECONDITION. + */ + // const etag = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callDeleteArtifact() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteArtifact(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteArtifact(); + // [END aiplatform_v1_generated_MetadataService_DeleteArtifact_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.delete_context.js b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.delete_context.js new file mode 100644 index 00000000000..115eec4272c --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.delete_context.js @@ -0,0 +1,75 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_MetadataService_DeleteContext_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Context to delete. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}` + */ + // const name = 'abc123' + /** + * The force deletion semantics is still undefined. + * Users should not use this field. + */ + // const force = true + /** + * Optional. The etag of the Context to delete. + * If this is provided, it must match the server's etag. Otherwise, the + * request will fail with a FAILED_PRECONDITION. + */ + // const etag = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callDeleteContext() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteContext(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteContext(); + // [END aiplatform_v1_generated_MetadataService_DeleteContext_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.delete_execution.js b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.delete_execution.js new file mode 100644 index 00000000000..6d2d2265b5d --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.delete_execution.js @@ -0,0 +1,70 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_MetadataService_DeleteExecution_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Execution to delete. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` + */ + // const name = 'abc123' + /** + * Optional. The etag of the Execution to delete. + * If this is provided, it must match the server's etag. Otherwise, the + * request will fail with a FAILED_PRECONDITION. + */ + // const etag = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callDeleteExecution() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteExecution(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteExecution(); + // [END aiplatform_v1_generated_MetadataService_DeleteExecution_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.delete_metadata_store.js b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.delete_metadata_store.js new file mode 100644 index 00000000000..38ac93cf65d --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.delete_metadata_store.js @@ -0,0 +1,64 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_MetadataService_DeleteMetadataStore_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the MetadataStore to delete. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callDeleteMetadataStore() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteMetadataStore(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteMetadataStore(); + // [END aiplatform_v1_generated_MetadataService_DeleteMetadataStore_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.get_artifact.js b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.get_artifact.js new file mode 100644 index 00000000000..aac9fb5a968 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.get_artifact.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_MetadataService_GetArtifact_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Artifact to retrieve. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callGetArtifact() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getArtifact(request); + console.log(response); + } + + callGetArtifact(); + // [END aiplatform_v1_generated_MetadataService_GetArtifact_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.get_context.js b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.get_context.js new file mode 100644 index 00000000000..9ec0f07acfb --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.get_context.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_MetadataService_GetContext_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Context to retrieve. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callGetContext() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getContext(request); + console.log(response); + } + + callGetContext(); + // [END aiplatform_v1_generated_MetadataService_GetContext_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.get_execution.js b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.get_execution.js new file mode 100644 index 00000000000..490e0ec5b15 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.get_execution.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_MetadataService_GetExecution_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Execution to retrieve. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callGetExecution() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getExecution(request); + console.log(response); + } + + callGetExecution(); + // [END aiplatform_v1_generated_MetadataService_GetExecution_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.get_metadata_schema.js b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.get_metadata_schema.js new file mode 100644 index 00000000000..deb97ea963d --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.get_metadata_schema.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_MetadataService_GetMetadataSchema_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the MetadataSchema to retrieve. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callGetMetadataSchema() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getMetadataSchema(request); + console.log(response); + } + + callGetMetadataSchema(); + // [END aiplatform_v1_generated_MetadataService_GetMetadataSchema_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.get_metadata_store.js b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.get_metadata_store.js new file mode 100644 index 00000000000..da805f948d4 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.get_metadata_store.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_MetadataService_GetMetadataStore_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the MetadataStore to retrieve. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callGetMetadataStore() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getMetadataStore(request); + console.log(response); + } + + callGetMetadataStore(); + // [END aiplatform_v1_generated_MetadataService_GetMetadataStore_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.list_artifacts.js b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.list_artifacts.js new file mode 100644 index 00000000000..9e6500337e7 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.list_artifacts.js @@ -0,0 +1,116 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1_generated_MetadataService_ListArtifacts_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The MetadataStore whose Artifacts should be listed. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}` + */ + // const parent = 'abc123' + /** + * The maximum number of Artifacts to return. The service may return fewer. + * Must be in range 1-1000, inclusive. Defaults to 100. + */ + // const pageSize = 1234 + /** + * A page token, received from a previous + * MetadataService.ListArtifacts google.cloud.aiplatform.v1.MetadataService.ListArtifacts + * call. Provide this to retrieve the subsequent page. + * When paginating, all other provided parameters must match the call that + * provided the page token. (Otherwise the request will fail with + * INVALID_ARGUMENT error.) + */ + // const pageToken = 'abc123' + /** + * Filter specifying the boolean condition for the Artifacts to satisfy in + * order to be part of the result set. + * The syntax to define filter query is based on https://google.aip.dev/160. + * The supported set of filters include the following: + * * **Attribute filtering**: + * For example: `display_name = "test"`. + * Supported fields include: `name`, `display_name`, `uri`, `state`, + * `schema_title`, `create_time`, and `update_time`. + * Time fields, such as `create_time` and `update_time`, require values + * specified in RFC-3339 format. + * For example: `create_time = "2020-11-19T11:30:00-04:00"` + * * **Metadata field**: + * To filter on metadata fields use traversal operation as follows: + * `metadata..`. + * For example: `metadata.field_1.number_value = 10.0` + * * **Context based filtering**: + * To filter Artifacts based on the contexts to which they belong, use the + * function operator with the full resource name + * `in_context()`. + * For example: + * `in_context("projects//locations//metadataStores//contexts/")` + * Each of the above supported filter types can be combined together using + * logical operators (`AND` & `OR`). Maximum nested expression depth allowed + * is 5. + * For example: `display_name = "test" AND metadata.field1.bool_value = true`. + */ + // const filter = 'abc123' + /** + * How the list of messages is ordered. Specify the values to order by and an + * ordering operation. The default sorting order is ascending. To specify + * descending order for a field, users append a " desc" suffix; for example: + * "foo desc, bar". + * Subfields are specified with a `.` character, such as foo.bar. + * see https://google.aip.dev/132#ordering for more details. + */ + // const orderBy = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callListArtifacts() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listArtifactsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListArtifacts(); + // [END aiplatform_v1_generated_MetadataService_ListArtifacts_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.list_contexts.js b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.list_contexts.js new file mode 100644 index 00000000000..a6299816118 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.list_contexts.js @@ -0,0 +1,119 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1_generated_MetadataService_ListContexts_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The MetadataStore whose Contexts should be listed. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}` + */ + // const parent = 'abc123' + /** + * The maximum number of Contexts to return. The service may return fewer. + * Must be in range 1-1000, inclusive. Defaults to 100. + */ + // const pageSize = 1234 + /** + * A page token, received from a previous + * MetadataService.ListContexts google.cloud.aiplatform.v1.MetadataService.ListContexts + * call. Provide this to retrieve the subsequent page. + * When paginating, all other provided parameters must match the call that + * provided the page token. (Otherwise the request will fail with + * INVALID_ARGUMENT error.) + */ + // const pageToken = 'abc123' + /** + * Filter specifying the boolean condition for the Contexts to satisfy in + * order to be part of the result set. + * The syntax to define filter query is based on https://google.aip.dev/160. + * Following are the supported set of filters: + * * **Attribute filtering**: + * For example: `display_name = "test"`. + * Supported fields include: `name`, `display_name`, `schema_title`, + * `create_time`, and `update_time`. + * Time fields, such as `create_time` and `update_time`, require values + * specified in RFC-3339 format. + * For example: `create_time = "2020-11-19T11:30:00-04:00"`. + * * **Metadata field**: + * To filter on metadata fields use traversal operation as follows: + * `metadata..`. + * For example: `metadata.field_1.number_value = 10.0`. + * * **Parent Child filtering**: + * To filter Contexts based on parent-child relationship use the HAS + * operator as follows: + * ``` + * parent_contexts: + * "projects//locations//metadataStores//contexts/" + * child_contexts: + * "projects//locations//metadataStores//contexts/" + * ``` + * Each of the above supported filters can be combined together using + * logical operators (`AND` & `OR`). Maximum nested expression depth allowed + * is 5. + * For example: `display_name = "test" AND metadata.field1.bool_value = true`. + */ + // const filter = 'abc123' + /** + * How the list of messages is ordered. Specify the values to order by and an + * ordering operation. The default sorting order is ascending. To specify + * descending order for a field, users append a " desc" suffix; for example: + * "foo desc, bar". + * Subfields are specified with a `.` character, such as foo.bar. + * see https://google.aip.dev/132#ordering for more details. + */ + // const orderBy = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callListContexts() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listContextsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListContexts(); + // [END aiplatform_v1_generated_MetadataService_ListContexts_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.list_executions.js b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.list_executions.js new file mode 100644 index 00000000000..e8f8140a154 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.list_executions.js @@ -0,0 +1,116 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1_generated_MetadataService_ListExecutions_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The MetadataStore whose Executions should be listed. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}` + */ + // const parent = 'abc123' + /** + * The maximum number of Executions to return. The service may return fewer. + * Must be in range 1-1000, inclusive. Defaults to 100. + */ + // const pageSize = 1234 + /** + * A page token, received from a previous + * MetadataService.ListExecutions google.cloud.aiplatform.v1.MetadataService.ListExecutions + * call. Provide this to retrieve the subsequent page. + * When paginating, all other provided parameters must match the call that + * provided the page token. (Otherwise the request will fail with an + * INVALID_ARGUMENT error.) + */ + // const pageToken = 'abc123' + /** + * Filter specifying the boolean condition for the Executions to satisfy in + * order to be part of the result set. + * The syntax to define filter query is based on https://google.aip.dev/160. + * Following are the supported set of filters: + * * **Attribute filtering**: + * For example: `display_name = "test"`. + * Supported fields include: `name`, `display_name`, `state`, + * `schema_title`, `create_time`, and `update_time`. + * Time fields, such as `create_time` and `update_time`, require values + * specified in RFC-3339 format. + * For example: `create_time = "2020-11-19T11:30:00-04:00"`. + * * **Metadata field**: + * To filter on metadata fields use traversal operation as follows: + * `metadata..` + * For example: `metadata.field_1.number_value = 10.0` + * * **Context based filtering**: + * To filter Executions based on the contexts to which they belong use + * the function operator with the full resource name: + * `in_context()`. + * For example: + * `in_context("projects//locations//metadataStores//contexts/")` + * Each of the above supported filters can be combined together using + * logical operators (`AND` & `OR`). Maximum nested expression depth allowed + * is 5. + * For example: `display_name = "test" AND metadata.field1.bool_value = true`. + */ + // const filter = 'abc123' + /** + * How the list of messages is ordered. Specify the values to order by and an + * ordering operation. The default sorting order is ascending. To specify + * descending order for a field, users append a " desc" suffix; for example: + * "foo desc, bar". + * Subfields are specified with a `.` character, such as foo.bar. + * see https://google.aip.dev/132#ordering for more details. + */ + // const orderBy = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callListExecutions() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listExecutionsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListExecutions(); + // [END aiplatform_v1_generated_MetadataService_ListExecutions_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.list_metadata_schemas.js b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.list_metadata_schemas.js new file mode 100644 index 00000000000..518d5c9fe0b --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.list_metadata_schemas.js @@ -0,0 +1,84 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1_generated_MetadataService_ListMetadataSchemas_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The MetadataStore whose MetadataSchemas should be listed. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}` + */ + // const parent = 'abc123' + /** + * The maximum number of MetadataSchemas to return. The service may return + * fewer. + * Must be in range 1-1000, inclusive. Defaults to 100. + */ + // const pageSize = 1234 + /** + * A page token, received from a previous + * MetadataService.ListMetadataSchemas google.cloud.aiplatform.v1.MetadataService.ListMetadataSchemas + * call. Provide this to retrieve the next page. + * When paginating, all other provided parameters must match the call that + * provided the page token. (Otherwise the request will fail with + * INVALID_ARGUMENT error.) + */ + // const pageToken = 'abc123' + /** + * A query to filter available MetadataSchemas for matching results. + */ + // const filter = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callListMetadataSchemas() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listMetadataSchemasAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListMetadataSchemas(); + // [END aiplatform_v1_generated_MetadataService_ListMetadataSchemas_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.list_metadata_stores.js b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.list_metadata_stores.js new file mode 100644 index 00000000000..af9b45a6c48 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.list_metadata_stores.js @@ -0,0 +1,80 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1_generated_MetadataService_ListMetadataStores_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The Location whose MetadataStores should be listed. + * Format: + * `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * The maximum number of Metadata Stores to return. The service may return + * fewer. + * Must be in range 1-1000, inclusive. Defaults to 100. + */ + // const pageSize = 1234 + /** + * A page token, received from a previous + * MetadataService.ListMetadataStores google.cloud.aiplatform.v1.MetadataService.ListMetadataStores + * call. Provide this to retrieve the subsequent page. + * When paginating, all other provided parameters must match the call that + * provided the page token. (Otherwise the request will fail with + * INVALID_ARGUMENT error.) + */ + // const pageToken = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callListMetadataStores() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listMetadataStoresAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListMetadataStores(); + // [END aiplatform_v1_generated_MetadataService_ListMetadataStores_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.purge_artifacts.js b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.purge_artifacts.js new file mode 100644 index 00000000000..2dc5db01e23 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.purge_artifacts.js @@ -0,0 +1,76 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, filter) { + // [START aiplatform_v1_generated_MetadataService_PurgeArtifacts_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The metadata store to purge Artifacts from. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}` + */ + // const parent = 'abc123' + /** + * Required. A required filter matching the Artifacts to be purged. + * E.g., `update_time <= 2020-11-19T11:30:00-04:00`. + */ + // const filter = 'abc123' + /** + * Optional. Flag to indicate to actually perform the purge. + * If `force` is set to false, the method will return a sample of + * Artifact names that would be deleted. + */ + // const force = true + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callPurgeArtifacts() { + // Construct request + const request = { + parent, + filter, + }; + + // Run request + const [operation] = await aiplatformClient.purgeArtifacts(request); + const [response] = await operation.promise(); + console.log(response); + } + + callPurgeArtifacts(); + // [END aiplatform_v1_generated_MetadataService_PurgeArtifacts_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.purge_contexts.js b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.purge_contexts.js new file mode 100644 index 00000000000..f05de4ee2ca --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.purge_contexts.js @@ -0,0 +1,76 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, filter) { + // [START aiplatform_v1_generated_MetadataService_PurgeContexts_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The metadata store to purge Contexts from. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}` + */ + // const parent = 'abc123' + /** + * Required. A required filter matching the Contexts to be purged. + * E.g., `update_time <= 2020-11-19T11:30:00-04:00`. + */ + // const filter = 'abc123' + /** + * Optional. Flag to indicate to actually perform the purge. + * If `force` is set to false, the method will return a sample of + * Context names that would be deleted. + */ + // const force = true + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callPurgeContexts() { + // Construct request + const request = { + parent, + filter, + }; + + // Run request + const [operation] = await aiplatformClient.purgeContexts(request); + const [response] = await operation.promise(); + console.log(response); + } + + callPurgeContexts(); + // [END aiplatform_v1_generated_MetadataService_PurgeContexts_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.purge_executions.js b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.purge_executions.js new file mode 100644 index 00000000000..2514d04d2c9 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.purge_executions.js @@ -0,0 +1,76 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, filter) { + // [START aiplatform_v1_generated_MetadataService_PurgeExecutions_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The metadata store to purge Executions from. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}` + */ + // const parent = 'abc123' + /** + * Required. A required filter matching the Executions to be purged. + * E.g., `update_time <= 2020-11-19T11:30:00-04:00`. + */ + // const filter = 'abc123' + /** + * Optional. Flag to indicate to actually perform the purge. + * If `force` is set to false, the method will return a sample of + * Execution names that would be deleted. + */ + // const force = true + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callPurgeExecutions() { + // Construct request + const request = { + parent, + filter, + }; + + // Run request + const [operation] = await aiplatformClient.purgeExecutions(request); + const [response] = await operation.promise(); + console.log(response); + } + + callPurgeExecutions(); + // [END aiplatform_v1_generated_MetadataService_PurgeExecutions_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.query_artifact_lineage_subgraph.js b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.query_artifact_lineage_subgraph.js new file mode 100644 index 00000000000..89e38030251 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.query_artifact_lineage_subgraph.js @@ -0,0 +1,96 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(artifact) { + // [START aiplatform_v1_generated_MetadataService_QueryArtifactLineageSubgraph_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Artifact whose Lineage needs to be + * retrieved as a LineageSubgraph. Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` + * The request may error with FAILED_PRECONDITION if the number of Artifacts, + * the number of Executions, or the number of Events that would be returned + * for the Context exceeds 1000. + */ + // const artifact = 'abc123' + /** + * Specifies the size of the lineage graph in terms of number of hops from the + * specified artifact. + * Negative Value: INVALID_ARGUMENT error is returned + * 0: Only input artifact is returned. + * No value: Transitive closure is performed to return the complete graph. + */ + // const maxHops = 1234 + /** + * Filter specifying the boolean condition for the Artifacts to satisfy in + * order to be part of the Lineage Subgraph. + * The syntax to define filter query is based on https://google.aip.dev/160. + * The supported set of filters include the following: + * * **Attribute filtering**: + * For example: `display_name = "test"` + * Supported fields include: `name`, `display_name`, `uri`, `state`, + * `schema_title`, `create_time`, and `update_time`. + * Time fields, such as `create_time` and `update_time`, require values + * specified in RFC-3339 format. + * For example: `create_time = "2020-11-19T11:30:00-04:00"` + * * **Metadata field**: + * To filter on metadata fields use traversal operation as follows: + * `metadata..`. + * For example: `metadata.field_1.number_value = 10.0` + * Each of the above supported filter types can be combined together using + * logical operators (`AND` & `OR`). Maximum nested expression depth allowed + * is 5. + * For example: `display_name = "test" AND metadata.field1.bool_value = true`. + */ + // const filter = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callQueryArtifactLineageSubgraph() { + // Construct request + const request = { + artifact, + }; + + // Run request + const response = await aiplatformClient.queryArtifactLineageSubgraph(request); + console.log(response); + } + + callQueryArtifactLineageSubgraph(); + // [END aiplatform_v1_generated_MetadataService_QueryArtifactLineageSubgraph_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.query_context_lineage_subgraph.js b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.query_context_lineage_subgraph.js new file mode 100644 index 00000000000..80cbc20e848 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.query_context_lineage_subgraph.js @@ -0,0 +1,67 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(context) { + // [START aiplatform_v1_generated_MetadataService_QueryContextLineageSubgraph_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Context whose Artifacts and Executions + * should be retrieved as a LineageSubgraph. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}` + * The request may error with FAILED_PRECONDITION if the number of Artifacts, + * the number of Executions, or the number of Events that would be returned + * for the Context exceeds 1000. + */ + // const context = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callQueryContextLineageSubgraph() { + // Construct request + const request = { + context, + }; + + // Run request + const response = await aiplatformClient.queryContextLineageSubgraph(request); + console.log(response); + } + + callQueryContextLineageSubgraph(); + // [END aiplatform_v1_generated_MetadataService_QueryContextLineageSubgraph_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.query_execution_inputs_and_outputs.js b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.query_execution_inputs_and_outputs.js new file mode 100644 index 00000000000..de1daf17e3f --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.query_execution_inputs_and_outputs.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(execution) { + // [START aiplatform_v1_generated_MetadataService_QueryExecutionInputsAndOutputs_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Execution whose input and output + * Artifacts should be retrieved as a LineageSubgraph. Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` + */ + // const execution = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callQueryExecutionInputsAndOutputs() { + // Construct request + const request = { + execution, + }; + + // Run request + const response = await aiplatformClient.queryExecutionInputsAndOutputs(request); + console.log(response); + } + + callQueryExecutionInputsAndOutputs(); + // [END aiplatform_v1_generated_MetadataService_QueryExecutionInputsAndOutputs_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.remove_context_children.js b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.remove_context_children.js new file mode 100644 index 00000000000..ada0b7bb5a1 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.remove_context_children.js @@ -0,0 +1,67 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(context) { + // [START aiplatform_v1_generated_MetadataService_RemoveContextChildren_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the parent Context. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}` + */ + // const context = 'abc123' + /** + * The resource names of the child Contexts. + */ + // const childContexts = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callRemoveContextChildren() { + // Construct request + const request = { + context, + }; + + // Run request + const response = await aiplatformClient.removeContextChildren(request); + console.log(response); + } + + callRemoveContextChildren(); + // [END aiplatform_v1_generated_MetadataService_RemoveContextChildren_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.update_artifact.js b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.update_artifact.js new file mode 100644 index 00000000000..4d282ef14c5 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.update_artifact.js @@ -0,0 +1,75 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(artifact) { + // [START aiplatform_v1_generated_MetadataService_UpdateArtifact_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The Artifact containing updates. + * The Artifact's Artifact.name google.cloud.aiplatform.v1.Artifact.name + * field is used to identify the Artifact to be updated. Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` + */ + // const artifact = {} + /** + * Optional. A FieldMask indicating which fields should be updated. + * Functionality of this field is not yet supported. + */ + // const updateMask = {} + /** + * If set to true, and the Artifact google.cloud.aiplatform.v1.Artifact is + * not found, a new Artifact google.cloud.aiplatform.v1.Artifact is + * created. + */ + // const allowMissing = true + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callUpdateArtifact() { + // Construct request + const request = { + artifact, + }; + + // Run request + const response = await aiplatformClient.updateArtifact(request); + console.log(response); + } + + callUpdateArtifact(); + // [END aiplatform_v1_generated_MetadataService_UpdateArtifact_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.update_context.js b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.update_context.js new file mode 100644 index 00000000000..6dfe2c6425b --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.update_context.js @@ -0,0 +1,74 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(context) { + // [START aiplatform_v1_generated_MetadataService_UpdateContext_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The Context containing updates. + * The Context's Context.name google.cloud.aiplatform.v1.Context.name field + * is used to identify the Context to be updated. Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}` + */ + // const context = {} + /** + * Optional. A FieldMask indicating which fields should be updated. + * Functionality of this field is not yet supported. + */ + // const updateMask = {} + /** + * If set to true, and the Context google.cloud.aiplatform.v1.Context is + * not found, a new Context google.cloud.aiplatform.v1.Context is created. + */ + // const allowMissing = true + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callUpdateContext() { + // Construct request + const request = { + context, + }; + + // Run request + const response = await aiplatformClient.updateContext(request); + console.log(response); + } + + callUpdateContext(); + // [END aiplatform_v1_generated_MetadataService_UpdateContext_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.update_execution.js b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.update_execution.js new file mode 100644 index 00000000000..05325031ef8 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/metadata_service.update_execution.js @@ -0,0 +1,75 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(execution) { + // [START aiplatform_v1_generated_MetadataService_UpdateExecution_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The Execution containing updates. + * The Execution's Execution.name google.cloud.aiplatform.v1.Execution.name + * field is used to identify the Execution to be updated. Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` + */ + // const execution = {} + /** + * Optional. A FieldMask indicating which fields should be updated. + * Functionality of this field is not yet supported. + */ + // const updateMask = {} + /** + * If set to true, and the Execution google.cloud.aiplatform.v1.Execution + * is not found, a new Execution google.cloud.aiplatform.v1.Execution is + * created. + */ + // const allowMissing = true + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callUpdateExecution() { + // Construct request + const request = { + execution, + }; + + // Run request + const response = await aiplatformClient.updateExecution(request); + console.log(response); + } + + callUpdateExecution(); + // [END aiplatform_v1_generated_MetadataService_UpdateExecution_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/migration_service.batch_migrate_resources.js b/packages/google-cloud-aiplatform/samples/generated/v1/migration_service.batch_migrate_resources.js new file mode 100644 index 00000000000..59335195c83 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/migration_service.batch_migrate_resources.js @@ -0,0 +1,70 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, migrateResourceRequests) { + // [START aiplatform_v1_generated_MigrationService_BatchMigrateResources_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The location of the migrated resource will live in. + * Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Required. The request messages specifying the resources to migrate. + * They must be in the same location as the destination. + * Up to 50 resources can be migrated in one batch. + */ + // const migrateResourceRequests = 1234 + + // Imports the Aiplatform library + const {MigrationServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new MigrationServiceClient(); + + async function callBatchMigrateResources() { + // Construct request + const request = { + parent, + migrateResourceRequests, + }; + + // Run request + const [operation] = await aiplatformClient.batchMigrateResources(request); + const [response] = await operation.promise(); + console.log(response); + } + + callBatchMigrateResources(); + // [END aiplatform_v1_generated_MigrationService_BatchMigrateResources_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/migration_service.search_migratable_resources.js b/packages/google-cloud-aiplatform/samples/generated/v1/migration_service.search_migratable_resources.js new file mode 100644 index 00000000000..2fd462f8169 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/migration_service.search_migratable_resources.js @@ -0,0 +1,89 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1_generated_MigrationService_SearchMigratableResources_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The location that the migratable resources should be searched + * from. It's the Vertex AI location that the resources can be migrated to, + * not the resources' original location. Format: + * `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * The standard page size. + * The default and maximum value is 100. + */ + // const pageSize = 1234 + /** + * The standard page token. + */ + // const pageToken = 'abc123' + /** + * A filter for your search. You can use the following types of filters: + * * Resource type filters. The following strings filter for a specific type + * of MigratableResource google.cloud.aiplatform.v1.MigratableResource: + * * `ml_engine_model_version:*` + * * `automl_model:*` + * * `automl_dataset:*` + * * `data_labeling_dataset:*` + * * "Migrated or not" filters. The following strings filter for resources + * that either have or have not already been migrated: + * * `last_migrate_time:*` filters for migrated resources. + * * `NOT last_migrate_time:*` filters for not yet migrated resources. + */ + // const filter = 'abc123' + + // Imports the Aiplatform library + const {MigrationServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new MigrationServiceClient(); + + async function callSearchMigratableResources() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.searchMigratableResourcesAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callSearchMigratableResources(); + // [END aiplatform_v1_generated_MigrationService_SearchMigratableResources_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/model_service.batch_import_model_evaluation_slices.js b/packages/google-cloud-aiplatform/samples/generated/v1/model_service.batch_import_model_evaluation_slices.js new file mode 100644 index 00000000000..443a660252f --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/model_service.batch_import_model_evaluation_slices.js @@ -0,0 +1,68 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, modelEvaluationSlices) { + // [START aiplatform_v1_generated_ModelService_BatchImportModelEvaluationSlices_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the parent ModelEvaluation resource. + * Format: + * `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}` + */ + // const parent = 'abc123' + /** + * Required. Model evaluation slice resource to be imported. + */ + // const modelEvaluationSlices = 1234 + + // Imports the Aiplatform library + const {ModelServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new ModelServiceClient(); + + async function callBatchImportModelEvaluationSlices() { + // Construct request + const request = { + parent, + modelEvaluationSlices, + }; + + // Run request + const response = await aiplatformClient.batchImportModelEvaluationSlices(request); + console.log(response); + } + + callBatchImportModelEvaluationSlices(); + // [END aiplatform_v1_generated_ModelService_BatchImportModelEvaluationSlices_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/model_service.delete_model.js b/packages/google-cloud-aiplatform/samples/generated/v1/model_service.delete_model.js new file mode 100644 index 00000000000..24b67593e34 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/model_service.delete_model.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_ModelService_DeleteModel_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Model resource to be deleted. + * Format: `projects/{project}/locations/{location}/models/{model}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {ModelServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new ModelServiceClient(); + + async function callDeleteModel() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteModel(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteModel(); + // [END aiplatform_v1_generated_ModelService_DeleteModel_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/model_service.delete_model_version.js b/packages/google-cloud-aiplatform/samples/generated/v1/model_service.delete_model_version.js new file mode 100644 index 00000000000..365abfbd5d1 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/model_service.delete_model_version.js @@ -0,0 +1,64 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_ModelService_DeleteModelVersion_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the model version to be deleted, with a version ID + * explicitly included. + * Example: `projects/{project}/locations/{location}/models/{model}@1234` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {ModelServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new ModelServiceClient(); + + async function callDeleteModelVersion() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteModelVersion(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteModelVersion(); + // [END aiplatform_v1_generated_ModelService_DeleteModelVersion_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/model_service.export_model.js b/packages/google-cloud-aiplatform/samples/generated/v1/model_service.export_model.js new file mode 100644 index 00000000000..353f9a1c825 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/model_service.export_model.js @@ -0,0 +1,69 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name, outputConfig) { + // [START aiplatform_v1_generated_ModelService_ExportModel_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Model to export. + * The resource name may contain version id or version alias to specify the + * version, if no version is specified, the default version will be exported. + */ + // const name = 'abc123' + /** + * Required. The desired output location and configuration. + */ + // const outputConfig = {} + + // Imports the Aiplatform library + const {ModelServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new ModelServiceClient(); + + async function callExportModel() { + // Construct request + const request = { + name, + outputConfig, + }; + + // Run request + const [operation] = await aiplatformClient.exportModel(request); + const [response] = await operation.promise(); + console.log(response); + } + + callExportModel(); + // [END aiplatform_v1_generated_ModelService_ExportModel_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/model_service.get_model.js b/packages/google-cloud-aiplatform/samples/generated/v1/model_service.get_model.js new file mode 100644 index 00000000000..c360e3936c8 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/model_service.get_model.js @@ -0,0 +1,71 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_ModelService_GetModel_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Model resource. + * Format: `projects/{project}/locations/{location}/models/{model}` + * In order to retrieve a specific version of the model, also provide + * the version ID or version alias. + * Example: `projects/{project}/locations/{location}/models/{model}@2` + * or + * `projects/{project}/locations/{location}/models/{model}@golden` + * If no version ID or alias is specified, the "default" version will be + * returned. The "default" version alias is created for the first version of + * the model, and can be moved to other versions later on. There will be + * exactly one default version. + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {ModelServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new ModelServiceClient(); + + async function callGetModel() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getModel(request); + console.log(response); + } + + callGetModel(); + // [END aiplatform_v1_generated_ModelService_GetModel_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/model_service.get_model_evaluation.js b/packages/google-cloud-aiplatform/samples/generated/v1/model_service.get_model_evaluation.js new file mode 100644 index 00000000000..bdebde74af2 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/model_service.get_model_evaluation.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_ModelService_GetModelEvaluation_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the ModelEvaluation resource. + * Format: + * `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {ModelServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new ModelServiceClient(); + + async function callGetModelEvaluation() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getModelEvaluation(request); + console.log(response); + } + + callGetModelEvaluation(); + // [END aiplatform_v1_generated_ModelService_GetModelEvaluation_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/model_service.get_model_evaluation_slice.js b/packages/google-cloud-aiplatform/samples/generated/v1/model_service.get_model_evaluation_slice.js new file mode 100644 index 00000000000..56a519010ae --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/model_service.get_model_evaluation_slice.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_ModelService_GetModelEvaluationSlice_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the ModelEvaluationSlice resource. + * Format: + * `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}/slices/{slice}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {ModelServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new ModelServiceClient(); + + async function callGetModelEvaluationSlice() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getModelEvaluationSlice(request); + console.log(response); + } + + callGetModelEvaluationSlice(); + // [END aiplatform_v1_generated_ModelService_GetModelEvaluationSlice_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/model_service.import_model_evaluation.js b/packages/google-cloud-aiplatform/samples/generated/v1/model_service.import_model_evaluation.js new file mode 100644 index 00000000000..5d5e33ab8ce --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/model_service.import_model_evaluation.js @@ -0,0 +1,67 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, modelEvaluation) { + // [START aiplatform_v1_generated_ModelService_ImportModelEvaluation_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the parent model resource. + * Format: `projects/{project}/locations/{location}/models/{model}` + */ + // const parent = 'abc123' + /** + * Required. Model evaluation resource to be imported. + */ + // const modelEvaluation = {} + + // Imports the Aiplatform library + const {ModelServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new ModelServiceClient(); + + async function callImportModelEvaluation() { + // Construct request + const request = { + parent, + modelEvaluation, + }; + + // Run request + const response = await aiplatformClient.importModelEvaluation(request); + console.log(response); + } + + callImportModelEvaluation(); + // [END aiplatform_v1_generated_ModelService_ImportModelEvaluation_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/model_service.list_model_evaluation_slices.js b/packages/google-cloud-aiplatform/samples/generated/v1/model_service.list_model_evaluation_slices.js new file mode 100644 index 00000000000..b991a4303e3 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/model_service.list_model_evaluation_slices.js @@ -0,0 +1,87 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1_generated_ModelService_ListModelEvaluationSlices_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the ModelEvaluation to list the + * ModelEvaluationSlices from. Format: + * `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}` + */ + // const parent = 'abc123' + /** + * The standard list filter. + * * `slice.dimension` - for =. + */ + // const filter = 'abc123' + /** + * The standard list page size. + */ + // const pageSize = 1234 + /** + * The standard list page token. + * Typically obtained via + * ListModelEvaluationSlicesResponse.next_page_token google.cloud.aiplatform.v1.ListModelEvaluationSlicesResponse.next_page_token + * of the previous + * ModelService.ListModelEvaluationSlices google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices + * call. + */ + // const pageToken = 'abc123' + /** + * Mask specifying which fields to read. + */ + // const readMask = {} + + // Imports the Aiplatform library + const {ModelServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new ModelServiceClient(); + + async function callListModelEvaluationSlices() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listModelEvaluationSlicesAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListModelEvaluationSlices(); + // [END aiplatform_v1_generated_ModelService_ListModelEvaluationSlices_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/model_service.list_model_evaluations.js b/packages/google-cloud-aiplatform/samples/generated/v1/model_service.list_model_evaluations.js new file mode 100644 index 00000000000..2facd92dd77 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/model_service.list_model_evaluations.js @@ -0,0 +1,85 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1_generated_ModelService_ListModelEvaluations_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Model to list the ModelEvaluations from. + * Format: `projects/{project}/locations/{location}/models/{model}` + */ + // const parent = 'abc123' + /** + * The standard list filter. + */ + // const filter = 'abc123' + /** + * The standard list page size. + */ + // const pageSize = 1234 + /** + * The standard list page token. + * Typically obtained via + * ListModelEvaluationsResponse.next_page_token google.cloud.aiplatform.v1.ListModelEvaluationsResponse.next_page_token + * of the previous + * ModelService.ListModelEvaluations google.cloud.aiplatform.v1.ModelService.ListModelEvaluations + * call. + */ + // const pageToken = 'abc123' + /** + * Mask specifying which fields to read. + */ + // const readMask = {} + + // Imports the Aiplatform library + const {ModelServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new ModelServiceClient(); + + async function callListModelEvaluations() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listModelEvaluationsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListModelEvaluations(); + // [END aiplatform_v1_generated_ModelService_ListModelEvaluations_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/model_service.list_model_versions.js b/packages/google-cloud-aiplatform/samples/generated/v1/model_service.list_model_versions.js new file mode 100644 index 00000000000..545e16c88bc --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/model_service.list_model_versions.js @@ -0,0 +1,98 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_ModelService_ListModelVersions_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the model to list versions for. + */ + // const name = 'abc123' + /** + * The standard list page size. + */ + // const pageSize = 1234 + /** + * The standard list page token. + * Typically obtained via + * ListModelVersionsResponse.next_page_token google.cloud.aiplatform.v1.ListModelVersionsResponse.next_page_token + * of the previous ModelService.ListModelversions call. + */ + // const pageToken = 'abc123' + /** + * An expression for filtering the results of the request. For field names + * both snake_case and camelCase are supported. + * * `labels` supports general map functions that is: + * * `labels.key=value` - key:value equality + * * `labels.key:* or labels:key - key existence + * * A key including a space must be quoted. `labels."a key"`. + * Some examples: + * * `labels.myKey="myValue"` + */ + // const filter = 'abc123' + /** + * Mask specifying which fields to read. + */ + // const readMask = {} + /** + * A comma-separated list of fields to order by, sorted in ascending order. + * Use "desc" after a field name for descending. + * Supported fields: + * * `create_time` + * * `update_time` + * Example: `update_time asc, create_time desc`. + */ + // const orderBy = 'abc123' + + // Imports the Aiplatform library + const {ModelServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new ModelServiceClient(); + + async function callListModelVersions() { + // Construct request + const request = { + name, + }; + + // Run request + const iterable = await aiplatformClient.listModelVersionsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListModelVersions(); + // [END aiplatform_v1_generated_ModelService_ListModelVersions_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/model_service.list_models.js b/packages/google-cloud-aiplatform/samples/generated/v1/model_service.list_models.js new file mode 100644 index 00000000000..b39b2a42836 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/model_service.list_models.js @@ -0,0 +1,108 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1_generated_ModelService_ListModels_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to list the Models from. + * Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * An expression for filtering the results of the request. For field names + * both snake_case and camelCase are supported. + * * `model` supports = and !=. `model` represents the Model ID, + * i.e. the last segment of the Model's resource + * name google.cloud.aiplatform.v1.Model.name. + * * `display_name` supports = and != + * * `labels` supports general map functions that is: + * * `labels.key=value` - key:value equality + * * `labels.key:* or labels:key - key existence + * * A key including a space must be quoted. `labels."a key"`. + * Some examples: + * * `model=1234` + * * `displayName="myDisplayName"` + * * `labels.myKey="myValue"` + */ + // const filter = 'abc123' + /** + * The standard list page size. + */ + // const pageSize = 1234 + /** + * The standard list page token. + * Typically obtained via + * ListModelsResponse.next_page_token google.cloud.aiplatform.v1.ListModelsResponse.next_page_token + * of the previous + * ModelService.ListModels google.cloud.aiplatform.v1.ModelService.ListModels + * call. + */ + // const pageToken = 'abc123' + /** + * Mask specifying which fields to read. + */ + // const readMask = {} + /** + * A comma-separated list of fields to order by, sorted in ascending order. + * Use "desc" after a field name for descending. + * Supported fields: + * * `display_name` + * * `create_time` + * * `update_time` + * Example: `display_name, create_time desc`. + */ + // const orderBy = 'abc123' + + // Imports the Aiplatform library + const {ModelServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new ModelServiceClient(); + + async function callListModels() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listModelsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListModels(); + // [END aiplatform_v1_generated_ModelService_ListModels_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/model_service.merge_version_aliases.js b/packages/google-cloud-aiplatform/samples/generated/v1/model_service.merge_version_aliases.js new file mode 100644 index 00000000000..726a497ea51 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/model_service.merge_version_aliases.js @@ -0,0 +1,78 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name, versionAliases) { + // [START aiplatform_v1_generated_ModelService_MergeVersionAliases_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the model version to merge aliases, with a version ID + * explicitly included. + * Example: `projects/{project}/locations/{location}/models/{model}@1234` + */ + // const name = 'abc123' + /** + * Required. The set of version aliases to merge. + * The alias should be at most 128 characters, and match + * `[a-z][a-zA-Z0-9-]{0,126}[a-z-0-9]`. + * Add the `-` prefix to an alias means removing that alias from the version. + * `-` is NOT counted in the 128 characters. Example: `-golden` means removing + * the `golden` alias from the version. + * There is NO ordering in aliases, which means + * 1) The aliases returned from GetModel API might not have the exactly same + * order from this MergeVersionAliases API. 2) Adding and deleting the same + * alias in the request is not recommended, and the 2 operations will be + * cancelled out. + */ + // const versionAliases = 'abc123' + + // Imports the Aiplatform library + const {ModelServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new ModelServiceClient(); + + async function callMergeVersionAliases() { + // Construct request + const request = { + name, + versionAliases, + }; + + // Run request + const response = await aiplatformClient.mergeVersionAliases(request); + console.log(response); + } + + callMergeVersionAliases(); + // [END aiplatform_v1_generated_ModelService_MergeVersionAliases_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/model_service.update_model.js b/packages/google-cloud-aiplatform/samples/generated/v1/model_service.update_model.js new file mode 100644 index 00000000000..d8635816b08 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/model_service.update_model.js @@ -0,0 +1,85 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(model, updateMask) { + // [START aiplatform_v1_generated_ModelService_UpdateModel_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The Model which replaces the resource on the server. + * When Model Versioning is enabled, the model.name will be used to determine + * whether to update the model or model version. + * 1. model.name with the @ value, e.g. models/123@1, refers to a version + * specific update. + * 2. model.name without the @ value, e.g. models/123, refers to a model + * update. + * 3. model.name with @-, e.g. models/123@-, refers to a model update. + * 4. Supported model fields: display_name, description; supported + * version-specific fields: version_description. Labels are supported in both + * scenarios. Both the model labels and the version labels are merged when a + * model is returned. When updating labels, if the request is for + * model-specific update, model label gets updated. Otherwise, version labels + * get updated. + * 5. A model name or model version name fields update mismatch will cause a + * precondition error. + * 6. One request cannot update both the model and the version fields. You + * must update them separately. + */ + // const model = {} + /** + * Required. The update mask applies to the resource. + * For the `FieldMask` definition, see + * google.protobuf.FieldMask google.protobuf.FieldMask. + */ + // const updateMask = {} + + // Imports the Aiplatform library + const {ModelServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new ModelServiceClient(); + + async function callUpdateModel() { + // Construct request + const request = { + model, + updateMask, + }; + + // Run request + const response = await aiplatformClient.updateModel(request); + console.log(response); + } + + callUpdateModel(); + // [END aiplatform_v1_generated_ModelService_UpdateModel_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/model_service.upload_model.js b/packages/google-cloud-aiplatform/samples/generated/v1/model_service.upload_model.js new file mode 100644 index 00000000000..056c43e41de --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/model_service.upload_model.js @@ -0,0 +1,90 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, model) { + // [START aiplatform_v1_generated_ModelService_UploadModel_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location into which to upload the Model. + * Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Optional. The resource name of the model into which to upload the version. + * Only specify this field when uploading a new version. + */ + // const parentModel = 'abc123' + /** + * Optional. The ID to use for the uploaded Model, which will become the final + * component of the model resource name. + * This value may be up to 63 characters, and valid characters are + * `[a-z0-9_-]`. The first character cannot be a number or hyphen. + */ + // const modelId = 'abc123' + /** + * Required. The Model to create. + */ + // const model = {} + /** + * Optional. The user-provided custom service account to use to do the model + * upload. If empty, Vertex AI Service + * Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) + * will be used. Users uploading the Model must have the + * `iam.serviceAccounts.actAs` permission on this service account. Also, this + * account must belong to the project specified in the `parent` field and have + * all necessary read permissions. + */ + // const serviceAccount = 'abc123' + + // Imports the Aiplatform library + const {ModelServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new ModelServiceClient(); + + async function callUploadModel() { + // Construct request + const request = { + parent, + model, + }; + + // Run request + const [operation] = await aiplatformClient.uploadModel(request); + const [response] = await operation.promise(); + console.log(response); + } + + callUploadModel(); + // [END aiplatform_v1_generated_ModelService_UploadModel_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/pipeline_service.cancel_pipeline_job.js b/packages/google-cloud-aiplatform/samples/generated/v1/pipeline_service.cancel_pipeline_job.js new file mode 100644 index 00000000000..befeb7d4d8f --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/pipeline_service.cancel_pipeline_job.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_PipelineService_CancelPipelineJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the PipelineJob to cancel. + * Format: + * `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {PipelineServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new PipelineServiceClient(); + + async function callCancelPipelineJob() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.cancelPipelineJob(request); + console.log(response); + } + + callCancelPipelineJob(); + // [END aiplatform_v1_generated_PipelineService_CancelPipelineJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/pipeline_service.cancel_training_pipeline.js b/packages/google-cloud-aiplatform/samples/generated/v1/pipeline_service.cancel_training_pipeline.js new file mode 100644 index 00000000000..5915c636238 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/pipeline_service.cancel_training_pipeline.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_PipelineService_CancelTrainingPipeline_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the TrainingPipeline to cancel. + * Format: + * `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {PipelineServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new PipelineServiceClient(); + + async function callCancelTrainingPipeline() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.cancelTrainingPipeline(request); + console.log(response); + } + + callCancelTrainingPipeline(); + // [END aiplatform_v1_generated_PipelineService_CancelTrainingPipeline_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/pipeline_service.create_pipeline_job.js b/packages/google-cloud-aiplatform/samples/generated/v1/pipeline_service.create_pipeline_job.js new file mode 100644 index 00000000000..1ccfb143e4b --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/pipeline_service.create_pipeline_job.js @@ -0,0 +1,75 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, pipelineJob) { + // [START aiplatform_v1_generated_PipelineService_CreatePipelineJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to create the PipelineJob in. + * Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Required. The PipelineJob to create. + */ + // const pipelineJob = {} + /** + * The ID to use for the PipelineJob, which will become the final component of + * the PipelineJob name. If not provided, an ID will be automatically + * generated. + * This value should be less than 128 characters, and valid characters + * are /[a-z][0-9]-/. + */ + // const pipelineJobId = 'abc123' + + // Imports the Aiplatform library + const {PipelineServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new PipelineServiceClient(); + + async function callCreatePipelineJob() { + // Construct request + const request = { + parent, + pipelineJob, + }; + + // Run request + const response = await aiplatformClient.createPipelineJob(request); + console.log(response); + } + + callCreatePipelineJob(); + // [END aiplatform_v1_generated_PipelineService_CreatePipelineJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/pipeline_service.create_training_pipeline.js b/packages/google-cloud-aiplatform/samples/generated/v1/pipeline_service.create_training_pipeline.js new file mode 100644 index 00000000000..4bb787b821a --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/pipeline_service.create_training_pipeline.js @@ -0,0 +1,67 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, trainingPipeline) { + // [START aiplatform_v1_generated_PipelineService_CreateTrainingPipeline_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to create the TrainingPipeline + * in. Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Required. The TrainingPipeline to create. + */ + // const trainingPipeline = {} + + // Imports the Aiplatform library + const {PipelineServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new PipelineServiceClient(); + + async function callCreateTrainingPipeline() { + // Construct request + const request = { + parent, + trainingPipeline, + }; + + // Run request + const response = await aiplatformClient.createTrainingPipeline(request); + console.log(response); + } + + callCreateTrainingPipeline(); + // [END aiplatform_v1_generated_PipelineService_CreateTrainingPipeline_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/pipeline_service.delete_pipeline_job.js b/packages/google-cloud-aiplatform/samples/generated/v1/pipeline_service.delete_pipeline_job.js new file mode 100644 index 00000000000..5c61fdbdc93 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/pipeline_service.delete_pipeline_job.js @@ -0,0 +1,64 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_PipelineService_DeletePipelineJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the PipelineJob resource to be deleted. + * Format: + * `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {PipelineServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new PipelineServiceClient(); + + async function callDeletePipelineJob() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deletePipelineJob(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeletePipelineJob(); + // [END aiplatform_v1_generated_PipelineService_DeletePipelineJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/pipeline_service.delete_training_pipeline.js b/packages/google-cloud-aiplatform/samples/generated/v1/pipeline_service.delete_training_pipeline.js new file mode 100644 index 00000000000..06c3412bb60 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/pipeline_service.delete_training_pipeline.js @@ -0,0 +1,64 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_PipelineService_DeleteTrainingPipeline_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the TrainingPipeline resource to be deleted. + * Format: + * `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {PipelineServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new PipelineServiceClient(); + + async function callDeleteTrainingPipeline() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteTrainingPipeline(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteTrainingPipeline(); + // [END aiplatform_v1_generated_PipelineService_DeleteTrainingPipeline_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/pipeline_service.get_pipeline_job.js b/packages/google-cloud-aiplatform/samples/generated/v1/pipeline_service.get_pipeline_job.js new file mode 100644 index 00000000000..5a9808ffba9 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/pipeline_service.get_pipeline_job.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_PipelineService_GetPipelineJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the PipelineJob resource. + * Format: + * `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {PipelineServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new PipelineServiceClient(); + + async function callGetPipelineJob() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getPipelineJob(request); + console.log(response); + } + + callGetPipelineJob(); + // [END aiplatform_v1_generated_PipelineService_GetPipelineJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/pipeline_service.get_training_pipeline.js b/packages/google-cloud-aiplatform/samples/generated/v1/pipeline_service.get_training_pipeline.js new file mode 100644 index 00000000000..63741b8e987 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/pipeline_service.get_training_pipeline.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_PipelineService_GetTrainingPipeline_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the TrainingPipeline resource. + * Format: + * `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {PipelineServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new PipelineServiceClient(); + + async function callGetTrainingPipeline() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getTrainingPipeline(request); + console.log(response); + } + + callGetTrainingPipeline(); + // [END aiplatform_v1_generated_PipelineService_GetTrainingPipeline_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/pipeline_service.list_pipeline_jobs.js b/packages/google-cloud-aiplatform/samples/generated/v1/pipeline_service.list_pipeline_jobs.js new file mode 100644 index 00000000000..57de8b4491d --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/pipeline_service.list_pipeline_jobs.js @@ -0,0 +1,128 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1_generated_PipelineService_ListPipelineJobs_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to list the PipelineJobs from. + * Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Lists the PipelineJobs that match the filter expression. The following + * fields are supported: + * * `pipeline_name`: Supports `=` and `!=` comparisons. + * * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. + * * `pipeline_job_user_id`: Supports `=`, `!=` comparisons, and `:` wildcard. + * for example, can check if pipeline's display_name contains *step* by + * doing display_name:\"*step*\" + * * `state`: Supports `=` and `!=` comparisons. + * * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. + * Values must be in RFC 3339 format. + * * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. + * Values must be in RFC 3339 format. + * * `end_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. + * Values must be in RFC 3339 format. + * * `labels`: Supports key-value equality and key presence. + * * `template_uri`: Supports `=`, `!=` comparisons, and `:` wildcard. + * * `template_metadata.version`: Supports `=`, `!=` comparisons, and `:` + * wildcard. + * Filter expressions can be combined together using logical operators + * (`AND` & `OR`). + * For example: `pipeline_name="test" AND create_time>"2020-05-18T13:30:00Z"`. + * The syntax to define filter expression is based on + * https://google.aip.dev/160. + * Examples: + * * `create_time>"2021-05-18T00:00:00Z" OR + * update_time>"2020-05-18T00:00:00Z"` PipelineJobs created or updated + * after 2020-05-18 00:00:00 UTC. + * * `labels.env = "prod"` + * PipelineJobs with label "env" set to "prod". + */ + // const filter = 'abc123' + /** + * The standard list page size. + */ + // const pageSize = 1234 + /** + * The standard list page token. + * Typically obtained via + * ListPipelineJobsResponse.next_page_token google.cloud.aiplatform.v1.ListPipelineJobsResponse.next_page_token + * of the previous + * PipelineService.ListPipelineJobs google.cloud.aiplatform.v1.PipelineService.ListPipelineJobs + * call. + */ + // const pageToken = 'abc123' + /** + * A comma-separated list of fields to order by. The default sort order is in + * ascending order. Use "desc" after a field name for descending. You can have + * multiple order_by fields provided e.g. "create_time desc, end_time", + * "end_time, start_time, update_time" For example, using "create_time desc, + * end_time" will order results by create time in descending order, and if + * there are multiple jobs having the same create time, order them by the end + * time in ascending order. if order_by is not specified, it will order by + * default order is create time in descending order. Supported fields: + * * `create_time` + * * `update_time` + * * `end_time` + * * `start_time` + */ + // const orderBy = 'abc123' + /** + * Mask specifying which fields to read. + */ + // const readMask = {} + + // Imports the Aiplatform library + const {PipelineServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new PipelineServiceClient(); + + async function callListPipelineJobs() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listPipelineJobsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListPipelineJobs(); + // [END aiplatform_v1_generated_PipelineService_ListPipelineJobs_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/pipeline_service.list_training_pipelines.js b/packages/google-cloud-aiplatform/samples/generated/v1/pipeline_service.list_training_pipelines.js new file mode 100644 index 00000000000..479252e820e --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/pipeline_service.list_training_pipelines.js @@ -0,0 +1,100 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1_generated_PipelineService_ListTrainingPipelines_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to list the TrainingPipelines + * from. Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * The standard list filter. + * Supported fields: + * * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. + * * `state` supports `=`, `!=` comparisons. + * * `training_task_definition` `=`, `!=` comparisons, and `:` wildcard. + * * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. + * `create_time` must be in RFC 3339 format. + * * `labels` supports general map functions that is: + * `labels.key=value` - key:value equality + * `labels.key:* - key existence + * Some examples of using the filter are: + * * `state="PIPELINE_STATE_SUCCEEDED" AND display_name:"my_pipeline_*"` + * * `state!="PIPELINE_STATE_FAILED" OR display_name="my_pipeline"` + * * `NOT display_name="my_pipeline"` + * * `create_time>"2021-05-18T00:00:00Z"` + * * `training_task_definition:"*automl_text_classification*"` + */ + // const filter = 'abc123' + /** + * The standard list page size. + */ + // const pageSize = 1234 + /** + * The standard list page token. + * Typically obtained via + * ListTrainingPipelinesResponse.next_page_token google.cloud.aiplatform.v1.ListTrainingPipelinesResponse.next_page_token + * of the previous + * PipelineService.ListTrainingPipelines google.cloud.aiplatform.v1.PipelineService.ListTrainingPipelines + * call. + */ + // const pageToken = 'abc123' + /** + * Mask specifying which fields to read. + */ + // const readMask = {} + + // Imports the Aiplatform library + const {PipelineServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new PipelineServiceClient(); + + async function callListTrainingPipelines() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listTrainingPipelinesAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListTrainingPipelines(); + // [END aiplatform_v1_generated_PipelineService_ListTrainingPipelines_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/prediction_service.explain.js b/packages/google-cloud-aiplatform/samples/generated/v1/prediction_service.explain.js new file mode 100644 index 00000000000..d295de04288 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/prediction_service.explain.js @@ -0,0 +1,101 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(endpoint, instances) { + // [START aiplatform_v1_generated_PredictionService_Explain_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Endpoint requested to serve the explanation. + * Format: + * `projects/{project}/locations/{location}/endpoints/{endpoint}` + */ + // const endpoint = 'abc123' + /** + * Required. The instances that are the input to the explanation call. + * A DeployedModel may have an upper limit on the number of instances it + * supports per request, and when it is exceeded the explanation call errors + * in case of AutoML Models, or, in case of customer created Models, the + * behaviour is as documented by that Model. + * The schema of any single instance may be specified via Endpoint's + * DeployedModels' Model's google.cloud.aiplatform.v1.DeployedModel.model + * PredictSchemata's google.cloud.aiplatform.v1.Model.predict_schemata + * instance_schema_uri google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri. + */ + // const instances = 1234 + /** + * The parameters that govern the prediction. The schema of the parameters may + * be specified via Endpoint's DeployedModels' Model's + * google.cloud.aiplatform.v1.DeployedModel.model + * PredictSchemata's google.cloud.aiplatform.v1.Model.predict_schemata + * parameters_schema_uri google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri. + */ + // const parameters = {} + /** + * If specified, overrides the + * explanation_spec google.cloud.aiplatform.v1.DeployedModel.explanation_spec + * of the DeployedModel. Can be used for explaining prediction results with + * different configurations, such as: + * - Explaining top-5 predictions results as opposed to top-1; + * - Increasing path count or step count of the attribution methods to reduce + * approximate errors; + * - Using different baselines for explaining the prediction results. + */ + // const explanationSpecOverride = {} + /** + * If specified, this ExplainRequest will be served by the chosen + * DeployedModel, overriding + * Endpoint.traffic_split google.cloud.aiplatform.v1.Endpoint.traffic_split. + */ + // const deployedModelId = 'abc123' + + // Imports the Aiplatform library + const {PredictionServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new PredictionServiceClient(); + + async function callExplain() { + // Construct request + const request = { + endpoint, + instances, + }; + + // Run request + const response = await aiplatformClient.explain(request); + console.log(response); + } + + callExplain(); + // [END aiplatform_v1_generated_PredictionService_Explain_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/prediction_service.predict.js b/packages/google-cloud-aiplatform/samples/generated/v1/prediction_service.predict.js new file mode 100644 index 00000000000..e3190b754e5 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/prediction_service.predict.js @@ -0,0 +1,84 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(endpoint, instances) { + // [START aiplatform_v1_generated_PredictionService_Predict_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Endpoint requested to serve the prediction. + * Format: + * `projects/{project}/locations/{location}/endpoints/{endpoint}` + */ + // const endpoint = 'abc123' + /** + * Required. The instances that are the input to the prediction call. + * A DeployedModel may have an upper limit on the number of instances it + * supports per request, and when it is exceeded the prediction call errors + * in case of AutoML Models, or, in case of customer created Models, the + * behaviour is as documented by that Model. + * The schema of any single instance may be specified via Endpoint's + * DeployedModels' Model's google.cloud.aiplatform.v1.DeployedModel.model + * PredictSchemata's google.cloud.aiplatform.v1.Model.predict_schemata + * instance_schema_uri google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri. + */ + // const instances = 1234 + /** + * The parameters that govern the prediction. The schema of the parameters may + * be specified via Endpoint's DeployedModels' Model's + * google.cloud.aiplatform.v1.DeployedModel.model + * PredictSchemata's google.cloud.aiplatform.v1.Model.predict_schemata + * parameters_schema_uri google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri. + */ + // const parameters = {} + + // Imports the Aiplatform library + const {PredictionServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new PredictionServiceClient(); + + async function callPredict() { + // Construct request + const request = { + endpoint, + instances, + }; + + // Run request + const response = await aiplatformClient.predict(request); + console.log(response); + } + + callPredict(); + // [END aiplatform_v1_generated_PredictionService_Predict_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/prediction_service.raw_predict.js b/packages/google-cloud-aiplatform/samples/generated/v1/prediction_service.raw_predict.js new file mode 100644 index 00000000000..c055ac5513a --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/prediction_service.raw_predict.js @@ -0,0 +1,79 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(endpoint) { + // [START aiplatform_v1_generated_PredictionService_RawPredict_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Endpoint requested to serve the prediction. + * Format: + * `projects/{project}/locations/{location}/endpoints/{endpoint}` + */ + // const endpoint = 'abc123' + /** + * The prediction input. Supports HTTP headers and arbitrary data payload. + * A DeployedModel google.cloud.aiplatform.v1.DeployedModel may have an + * upper limit on the number of instances it supports per request. When this + * limit it is exceeded for an AutoML model, the + * RawPredict google.cloud.aiplatform.v1.PredictionService.RawPredict + * method returns an error. When this limit is exceeded for a custom-trained + * model, the behavior varies depending on the model. + * You can specify the schema for each instance in the + * predict_schemata.instance_schema_uri google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri + * field when you create a Model google.cloud.aiplatform.v1.Model. This + * schema applies when you deploy the `Model` as a `DeployedModel` to an + * Endpoint google.cloud.aiplatform.v1.Endpoint and use the `RawPredict` + * method. + */ + // const httpBody = {} + + // Imports the Aiplatform library + const {PredictionServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new PredictionServiceClient(); + + async function callRawPredict() { + // Construct request + const request = { + endpoint, + }; + + // Run request + const response = await aiplatformClient.rawPredict(request); + console.log(response); + } + + callRawPredict(); + // [END aiplatform_v1_generated_PredictionService_RawPredict_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/snippet_metadata.google.cloud.aiplatform.v1.json b/packages/google-cloud-aiplatform/samples/generated/v1/snippet_metadata.google.cloud.aiplatform.v1.json new file mode 100644 index 00000000000..fb5980aa3d9 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/snippet_metadata.google.cloud.aiplatform.v1.json @@ -0,0 +1,9139 @@ +{ + "clientLibrary": { + "name": "nodejs-aiplatform", + "version": "2.3.0", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.aiplatform.v1", + "version": "v1" + } + ] + }, + "snippets": [ + { + "regionTag": "aiplatform_v1_generated_DatasetService_CreateDataset_async", + "title": "DatasetService createDataset Sample", + "origin": "API_DEFINITION", + "description": " Creates a Dataset.", + "canonical": true, + "file": "dataset_service.create_dataset.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateDataset", + "fullName": "google.cloud.aiplatform.v1.DatasetService.CreateDataset", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "dataset", + "type": ".google.cloud.aiplatform.v1.Dataset" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1.DatasetServiceClient" + }, + "method": { + "shortName": "CreateDataset", + "fullName": "google.cloud.aiplatform.v1.DatasetService.CreateDataset", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_DatasetService_GetDataset_async", + "title": "DatasetService getDataset Sample", + "origin": "API_DEFINITION", + "description": " Gets a Dataset.", + "canonical": true, + "file": "dataset_service.get_dataset.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 57, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetDataset", + "fullName": "google.cloud.aiplatform.v1.DatasetService.GetDataset", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Dataset", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1.DatasetServiceClient" + }, + "method": { + "shortName": "GetDataset", + "fullName": "google.cloud.aiplatform.v1.DatasetService.GetDataset", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_DatasetService_UpdateDataset_async", + "title": "DatasetService updateDataset Sample", + "origin": "API_DEFINITION", + "description": " Updates a Dataset.", + "canonical": true, + "file": "dataset_service.update_dataset.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateDataset", + "fullName": "google.cloud.aiplatform.v1.DatasetService.UpdateDataset", + "async": true, + "parameters": [ + { + "name": "dataset", + "type": ".google.cloud.aiplatform.v1.Dataset" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Dataset", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1.DatasetServiceClient" + }, + "method": { + "shortName": "UpdateDataset", + "fullName": "google.cloud.aiplatform.v1.DatasetService.UpdateDataset", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_DatasetService_ListDatasets_async", + "title": "DatasetService listDatasets Sample", + "origin": "API_DEFINITION", + "description": " Lists Datasets in a Location.", + "canonical": true, + "file": "dataset_service.list_datasets.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 91, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListDatasets", + "fullName": "google.cloud.aiplatform.v1.DatasetService.ListDatasets", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListDatasetsResponse", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1.DatasetServiceClient" + }, + "method": { + "shortName": "ListDatasets", + "fullName": "google.cloud.aiplatform.v1.DatasetService.ListDatasets", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_DatasetService_DeleteDataset_async", + "title": "DatasetService deleteDataset Sample", + "origin": "API_DEFINITION", + "description": " Deletes a Dataset.", + "canonical": true, + "file": "dataset_service.delete_dataset.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteDataset", + "fullName": "google.cloud.aiplatform.v1.DatasetService.DeleteDataset", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1.DatasetServiceClient" + }, + "method": { + "shortName": "DeleteDataset", + "fullName": "google.cloud.aiplatform.v1.DatasetService.DeleteDataset", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_DatasetService_ImportData_async", + "title": "DatasetService importData Sample", + "origin": "API_DEFINITION", + "description": " Imports data into a Dataset.", + "canonical": true, + "file": "dataset_service.import_data.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ImportData", + "fullName": "google.cloud.aiplatform.v1.DatasetService.ImportData", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "import_configs", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1.DatasetServiceClient" + }, + "method": { + "shortName": "ImportData", + "fullName": "google.cloud.aiplatform.v1.DatasetService.ImportData", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_DatasetService_ExportData_async", + "title": "DatasetService exportData Sample", + "origin": "API_DEFINITION", + "description": " Exports data from a Dataset.", + "canonical": true, + "file": "dataset_service.export_data.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ExportData", + "fullName": "google.cloud.aiplatform.v1.DatasetService.ExportData", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "export_config", + "type": ".google.cloud.aiplatform.v1.ExportDataConfig" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1.DatasetServiceClient" + }, + "method": { + "shortName": "ExportData", + "fullName": "google.cloud.aiplatform.v1.DatasetService.ExportData", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_DatasetService_ListDataItems_async", + "title": "DatasetService listDataItems Sample", + "origin": "API_DEFINITION", + "description": " Lists DataItems in a Dataset.", + "canonical": true, + "file": "dataset_service.list_data_items.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 78, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListDataItems", + "fullName": "google.cloud.aiplatform.v1.DatasetService.ListDataItems", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListDataItemsResponse", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1.DatasetServiceClient" + }, + "method": { + "shortName": "ListDataItems", + "fullName": "google.cloud.aiplatform.v1.DatasetService.ListDataItems", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_DatasetService_SearchDataItems_async", + "title": "DatasetService searchDataItems Sample", + "origin": "API_DEFINITION", + "description": " Searches DataItems in a Dataset.", + "canonical": true, + "file": "dataset_service.search_data_items.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 137, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SearchDataItems", + "fullName": "google.cloud.aiplatform.v1.DatasetService.SearchDataItems", + "async": true, + "parameters": [ + { + "name": "order_by_data_item", + "type": "TYPE_STRING" + }, + { + "name": "order_by_annotation", + "type": ".google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation" + }, + { + "name": "dataset", + "type": "TYPE_STRING" + }, + { + "name": "saved_query", + "type": "TYPE_STRING" + }, + { + "name": "data_labeling_job", + "type": "TYPE_STRING" + }, + { + "name": "data_item_filter", + "type": "TYPE_STRING" + }, + { + "name": "annotations_filter", + "type": "TYPE_STRING" + }, + { + "name": "annotation_filters", + "type": "TYPE_STRING[]" + }, + { + "name": "field_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "annotations_limit", + "type": "TYPE_INT32" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.SearchDataItemsResponse", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1.DatasetServiceClient" + }, + "method": { + "shortName": "SearchDataItems", + "fullName": "google.cloud.aiplatform.v1.DatasetService.SearchDataItems", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_DatasetService_ListSavedQueries_async", + "title": "DatasetService listSavedQueries Sample", + "origin": "API_DEFINITION", + "description": " Lists SavedQueries in a Dataset.", + "canonical": true, + "file": "dataset_service.list_saved_queries.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 78, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListSavedQueries", + "fullName": "google.cloud.aiplatform.v1.DatasetService.ListSavedQueries", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListSavedQueriesResponse", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1.DatasetServiceClient" + }, + "method": { + "shortName": "ListSavedQueries", + "fullName": "google.cloud.aiplatform.v1.DatasetService.ListSavedQueries", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_DatasetService_GetAnnotationSpec_async", + "title": "DatasetService getAnnotationSpec Sample", + "origin": "API_DEFINITION", + "description": " Gets an AnnotationSpec.", + "canonical": true, + "file": "dataset_service.get_annotation_spec.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetAnnotationSpec", + "fullName": "google.cloud.aiplatform.v1.DatasetService.GetAnnotationSpec", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.AnnotationSpec", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1.DatasetServiceClient" + }, + "method": { + "shortName": "GetAnnotationSpec", + "fullName": "google.cloud.aiplatform.v1.DatasetService.GetAnnotationSpec", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_DatasetService_ListAnnotations_async", + "title": "DatasetService listAnnotations Sample", + "origin": "API_DEFINITION", + "description": " Lists Annotations belongs to a dataitem", + "canonical": true, + "file": "dataset_service.list_annotations.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 78, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListAnnotations", + "fullName": "google.cloud.aiplatform.v1.DatasetService.ListAnnotations", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListAnnotationsResponse", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1.DatasetServiceClient" + }, + "method": { + "shortName": "ListAnnotations", + "fullName": "google.cloud.aiplatform.v1.DatasetService.ListAnnotations", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_EndpointService_CreateEndpoint_async", + "title": "DatasetService createEndpoint Sample", + "origin": "API_DEFINITION", + "description": " Creates an Endpoint.", + "canonical": true, + "file": "endpoint_service.create_endpoint.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateEndpoint", + "fullName": "google.cloud.aiplatform.v1.EndpointService.CreateEndpoint", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "endpoint", + "type": ".google.cloud.aiplatform.v1.Endpoint" + }, + { + "name": "endpoint_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "EndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1.EndpointServiceClient" + }, + "method": { + "shortName": "CreateEndpoint", + "fullName": "google.cloud.aiplatform.v1.EndpointService.CreateEndpoint", + "service": { + "shortName": "EndpointService", + "fullName": "google.cloud.aiplatform.v1.EndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_EndpointService_GetEndpoint_async", + "title": "DatasetService getEndpoint Sample", + "origin": "API_DEFINITION", + "description": " Gets an Endpoint.", + "canonical": true, + "file": "endpoint_service.get_endpoint.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetEndpoint", + "fullName": "google.cloud.aiplatform.v1.EndpointService.GetEndpoint", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Endpoint", + "client": { + "shortName": "EndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1.EndpointServiceClient" + }, + "method": { + "shortName": "GetEndpoint", + "fullName": "google.cloud.aiplatform.v1.EndpointService.GetEndpoint", + "service": { + "shortName": "EndpointService", + "fullName": "google.cloud.aiplatform.v1.EndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_EndpointService_ListEndpoints_async", + "title": "DatasetService listEndpoints Sample", + "origin": "API_DEFINITION", + "description": " Lists Endpoints in a Location.", + "canonical": true, + "file": "endpoint_service.list_endpoints.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 100, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListEndpoints", + "fullName": "google.cloud.aiplatform.v1.EndpointService.ListEndpoints", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListEndpointsResponse", + "client": { + "shortName": "EndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1.EndpointServiceClient" + }, + "method": { + "shortName": "ListEndpoints", + "fullName": "google.cloud.aiplatform.v1.EndpointService.ListEndpoints", + "service": { + "shortName": "EndpointService", + "fullName": "google.cloud.aiplatform.v1.EndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_EndpointService_UpdateEndpoint_async", + "title": "DatasetService updateEndpoint Sample", + "origin": "API_DEFINITION", + "description": " Updates an Endpoint.", + "canonical": true, + "file": "endpoint_service.update_endpoint.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateEndpoint", + "fullName": "google.cloud.aiplatform.v1.EndpointService.UpdateEndpoint", + "async": true, + "parameters": [ + { + "name": "endpoint", + "type": ".google.cloud.aiplatform.v1.Endpoint" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Endpoint", + "client": { + "shortName": "EndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1.EndpointServiceClient" + }, + "method": { + "shortName": "UpdateEndpoint", + "fullName": "google.cloud.aiplatform.v1.EndpointService.UpdateEndpoint", + "service": { + "shortName": "EndpointService", + "fullName": "google.cloud.aiplatform.v1.EndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_EndpointService_DeleteEndpoint_async", + "title": "DatasetService deleteEndpoint Sample", + "origin": "API_DEFINITION", + "description": " Deletes an Endpoint.", + "canonical": true, + "file": "endpoint_service.delete_endpoint.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteEndpoint", + "fullName": "google.cloud.aiplatform.v1.EndpointService.DeleteEndpoint", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "EndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1.EndpointServiceClient" + }, + "method": { + "shortName": "DeleteEndpoint", + "fullName": "google.cloud.aiplatform.v1.EndpointService.DeleteEndpoint", + "service": { + "shortName": "EndpointService", + "fullName": "google.cloud.aiplatform.v1.EndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_EndpointService_DeployModel_async", + "title": "DatasetService deployModel Sample", + "origin": "API_DEFINITION", + "description": " Deploys a Model into this Endpoint, creating a DeployedModel within it.", + "canonical": true, + "file": "endpoint_service.deploy_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeployModel", + "fullName": "google.cloud.aiplatform.v1.EndpointService.DeployModel", + "async": true, + "parameters": [ + { + "name": "endpoint", + "type": "TYPE_STRING" + }, + { + "name": "deployed_model", + "type": ".google.cloud.aiplatform.v1.DeployedModel" + }, + { + "name": "traffic_split", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "EndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1.EndpointServiceClient" + }, + "method": { + "shortName": "DeployModel", + "fullName": "google.cloud.aiplatform.v1.EndpointService.DeployModel", + "service": { + "shortName": "EndpointService", + "fullName": "google.cloud.aiplatform.v1.EndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_EndpointService_UndeployModel_async", + "title": "DatasetService undeployModel Sample", + "origin": "API_DEFINITION", + "description": " Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using.", + "canonical": true, + "file": "endpoint_service.undeploy_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UndeployModel", + "fullName": "google.cloud.aiplatform.v1.EndpointService.UndeployModel", + "async": true, + "parameters": [ + { + "name": "endpoint", + "type": "TYPE_STRING" + }, + { + "name": "deployed_model_id", + "type": "TYPE_STRING" + }, + { + "name": "traffic_split", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "EndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1.EndpointServiceClient" + }, + "method": { + "shortName": "UndeployModel", + "fullName": "google.cloud.aiplatform.v1.EndpointService.UndeployModel", + "service": { + "shortName": "EndpointService", + "fullName": "google.cloud.aiplatform.v1.EndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreOnlineServingService_ReadFeatureValues_async", + "title": "DatasetService readFeatureValues Sample", + "origin": "API_DEFINITION", + "description": " Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues.", + "canonical": true, + "file": "featurestore_online_serving_service.read_feature_values.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ReadFeatureValues", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreOnlineServingService.ReadFeatureValues", + "async": true, + "parameters": [ + { + "name": "entity_type", + "type": "TYPE_STRING" + }, + { + "name": "entity_id", + "type": "TYPE_STRING" + }, + { + "name": "feature_selector", + "type": ".google.cloud.aiplatform.v1.FeatureSelector" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ReadFeatureValuesResponse", + "client": { + "shortName": "FeaturestoreOnlineServingServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreOnlineServingServiceClient" + }, + "method": { + "shortName": "ReadFeatureValues", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreOnlineServingService.ReadFeatureValues", + "service": { + "shortName": "FeaturestoreOnlineServingService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreOnlineServingService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreOnlineServingService_StreamingReadFeatureValues_async", + "title": "DatasetService streamingReadFeatureValues Sample", + "origin": "API_DEFINITION", + "description": " Reads Feature values for multiple entities. Depending on their size, data for different entities may be broken up across multiple responses.", + "canonical": true, + "file": "featurestore_online_serving_service.streaming_read_feature_values.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 73, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "StreamingReadFeatureValues", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreOnlineServingService.StreamingReadFeatureValues", + "async": true, + "parameters": [ + { + "name": "entity_type", + "type": "TYPE_STRING" + }, + { + "name": "entity_ids", + "type": "TYPE_STRING[]" + }, + { + "name": "feature_selector", + "type": ".google.cloud.aiplatform.v1.FeatureSelector" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ReadFeatureValuesResponse", + "client": { + "shortName": "FeaturestoreOnlineServingServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreOnlineServingServiceClient" + }, + "method": { + "shortName": "StreamingReadFeatureValues", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreOnlineServingService.StreamingReadFeatureValues", + "service": { + "shortName": "FeaturestoreOnlineServingService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreOnlineServingService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreOnlineServingService_WriteFeatureValues_async", + "title": "DatasetService writeFeatureValues Sample", + "origin": "API_DEFINITION", + "description": " Writes Feature values of one or more entities of an EntityType. The Feature values are merged into existing entities if any. The Feature values to be written must have timestamp within the online storage retention.", + "canonical": true, + "file": "featurestore_online_serving_service.write_feature_values.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 64, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "WriteFeatureValues", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreOnlineServingService.WriteFeatureValues", + "async": true, + "parameters": [ + { + "name": "entity_type", + "type": "TYPE_STRING" + }, + { + "name": "payloads", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1.WriteFeatureValuesResponse", + "client": { + "shortName": "FeaturestoreOnlineServingServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreOnlineServingServiceClient" + }, + "method": { + "shortName": "WriteFeatureValues", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreOnlineServingService.WriteFeatureValues", + "service": { + "shortName": "FeaturestoreOnlineServingService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreOnlineServingService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreService_CreateFeaturestore_async", + "title": "DatasetService createFeaturestore Sample", + "origin": "API_DEFINITION", + "description": " Creates a new Featurestore in a given project and location.", + "canonical": true, + "file": "featurestore_service.create_featurestore.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 70, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateFeaturestore", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.CreateFeaturestore", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "featurestore", + "type": ".google.cloud.aiplatform.v1.Featurestore" + }, + { + "name": "featurestore_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "CreateFeaturestore", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.CreateFeaturestore", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreService_GetFeaturestore_async", + "title": "DatasetService getFeaturestore Sample", + "origin": "API_DEFINITION", + "description": " Gets details of a single Featurestore.", + "canonical": true, + "file": "featurestore_service.get_featurestore.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetFeaturestore", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.GetFeaturestore", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Featurestore", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "GetFeaturestore", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.GetFeaturestore", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreService_ListFeaturestores_async", + "title": "DatasetService listFeaturestores Sample", + "origin": "API_DEFINITION", + "description": " Lists Featurestores in a given project and location.", + "canonical": true, + "file": "featurestore_service.list_featurestores.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 105, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListFeaturestores", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListFeaturestoresResponse", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "ListFeaturestores", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreService_UpdateFeaturestore_async", + "title": "DatasetService updateFeaturestore Sample", + "origin": "API_DEFINITION", + "description": " Updates the parameters of a single Featurestore.", + "canonical": true, + "file": "featurestore_service.update_featurestore.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateFeaturestore", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.UpdateFeaturestore", + "async": true, + "parameters": [ + { + "name": "featurestore", + "type": ".google.cloud.aiplatform.v1.Featurestore" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "UpdateFeaturestore", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.UpdateFeaturestore", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreService_DeleteFeaturestore_async", + "title": "DatasetService deleteFeaturestore Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single Featurestore. The Featurestore must not contain any EntityTypes or `force` must be set to true for the request to succeed.", + "canonical": true, + "file": "featurestore_service.delete_featurestore.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteFeaturestore", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.DeleteFeaturestore", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "DeleteFeaturestore", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.DeleteFeaturestore", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreService_CreateEntityType_async", + "title": "DatasetService createEntityType Sample", + "origin": "API_DEFINITION", + "description": " Creates a new EntityType in a given Featurestore.", + "canonical": true, + "file": "featurestore_service.create_entity_type.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateEntityType", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.CreateEntityType", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "entity_type", + "type": ".google.cloud.aiplatform.v1.EntityType" + }, + { + "name": "entity_type_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "CreateEntityType", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.CreateEntityType", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreService_GetEntityType_async", + "title": "DatasetService getEntityType Sample", + "origin": "API_DEFINITION", + "description": " Gets details of a single EntityType.", + "canonical": true, + "file": "featurestore_service.get_entity_type.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetEntityType", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.GetEntityType", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.EntityType", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "GetEntityType", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.GetEntityType", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreService_ListEntityTypes_async", + "title": "DatasetService listEntityTypes Sample", + "origin": "API_DEFINITION", + "description": " Lists EntityTypes in a given Featurestore.", + "canonical": true, + "file": "featurestore_service.list_entity_types.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 104, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListEntityTypes", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListEntityTypesResponse", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "ListEntityTypes", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreService_UpdateEntityType_async", + "title": "DatasetService updateEntityType Sample", + "origin": "API_DEFINITION", + "description": " Updates the parameters of a single EntityType.", + "canonical": true, + "file": "featurestore_service.update_entity_type.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 76, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateEntityType", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.UpdateEntityType", + "async": true, + "parameters": [ + { + "name": "entity_type", + "type": ".google.cloud.aiplatform.v1.EntityType" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.EntityType", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "UpdateEntityType", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.UpdateEntityType", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreService_DeleteEntityType_async", + "title": "DatasetService deleteEntityType Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single EntityType. The EntityType must not have any Features or `force` must be set to true for the request to succeed.", + "canonical": true, + "file": "featurestore_service.delete_entity_type.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteEntityType", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.DeleteEntityType", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "DeleteEntityType", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.DeleteEntityType", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreService_CreateFeature_async", + "title": "DatasetService createFeature Sample", + "origin": "API_DEFINITION", + "description": " Creates a new Feature in a given EntityType.", + "canonical": true, + "file": "featurestore_service.create_feature.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 70, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateFeature", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.CreateFeature", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "feature", + "type": ".google.cloud.aiplatform.v1.Feature" + }, + { + "name": "feature_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "CreateFeature", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.CreateFeature", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreService_BatchCreateFeatures_async", + "title": "DatasetService batchCreateFeatures Sample", + "origin": "API_DEFINITION", + "description": " Creates a batch of Features in a given EntityType.", + "canonical": true, + "file": "featurestore_service.batch_create_features.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchCreateFeatures", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.BatchCreateFeatures", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "requests", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "BatchCreateFeatures", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.BatchCreateFeatures", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreService_GetFeature_async", + "title": "DatasetService getFeature Sample", + "origin": "API_DEFINITION", + "description": " Gets details of a single Feature.", + "canonical": true, + "file": "featurestore_service.get_feature.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetFeature", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.GetFeature", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Feature", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "GetFeature", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.GetFeature", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreService_ListFeatures_async", + "title": "DatasetService listFeatures Sample", + "origin": "API_DEFINITION", + "description": " Lists Features in a given EntityType.", + "canonical": true, + "file": "featurestore_service.list_features.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 116, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListFeatures", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "latest_stats_count", + "type": "TYPE_INT32" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListFeaturesResponse", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "ListFeatures", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreService_UpdateFeature_async", + "title": "DatasetService updateFeature Sample", + "origin": "API_DEFINITION", + "description": " Updates the parameters of a single Feature.", + "canonical": true, + "file": "featurestore_service.update_feature.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 70, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateFeature", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.UpdateFeature", + "async": true, + "parameters": [ + { + "name": "feature", + "type": ".google.cloud.aiplatform.v1.Feature" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Feature", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "UpdateFeature", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.UpdateFeature", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreService_DeleteFeature_async", + "title": "DatasetService deleteFeature Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single Feature.", + "canonical": true, + "file": "featurestore_service.delete_feature.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteFeature", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.DeleteFeature", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "DeleteFeature", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.DeleteFeature", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreService_ImportFeatureValues_async", + "title": "DatasetService importFeatureValues Sample", + "origin": "API_DEFINITION", + "description": " Imports Feature values into the Featurestore from a source storage. The progress of the import is tracked by the returned operation. The imported features are guaranteed to be visible to subsequent read operations after the operation is marked as successfully done. If an import operation fails, the Feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same import request again and wait till the new operation returned is marked as successfully done. There are also scenarios where the caller can cause inconsistency. - Source data for import contains multiple distinct Feature values for the same entity ID and timestamp. - Source is modified during an import. This includes adding, updating, or removing source data and/or metadata. Examples of updating metadata include but are not limited to changing storage location, storage class, or retention policy. - Online serving cluster is under-provisioned.", + "canonical": true, + "file": "featurestore_service.import_feature_values.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 106, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ImportFeatureValues", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.ImportFeatureValues", + "async": true, + "parameters": [ + { + "name": "avro_source", + "type": ".google.cloud.aiplatform.v1.AvroSource" + }, + { + "name": "bigquery_source", + "type": ".google.cloud.aiplatform.v1.BigQuerySource" + }, + { + "name": "csv_source", + "type": ".google.cloud.aiplatform.v1.CsvSource" + }, + { + "name": "feature_time_field", + "type": "TYPE_STRING" + }, + { + "name": "feature_time", + "type": ".google.protobuf.Timestamp" + }, + { + "name": "entity_type", + "type": "TYPE_STRING" + }, + { + "name": "entity_id_field", + "type": "TYPE_STRING" + }, + { + "name": "feature_specs", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "disable_online_serving", + "type": "TYPE_BOOL" + }, + { + "name": "worker_count", + "type": "TYPE_INT32" + }, + { + "name": "disable_ingestion_analysis", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "ImportFeatureValues", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.ImportFeatureValues", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreService_BatchReadFeatureValues_async", + "title": "DatasetService batchReadFeatureValues Sample", + "origin": "API_DEFINITION", + "description": " Batch reads Feature values from a Featurestore. This API enables batch reading Feature values, where each read instance in the batch may read Feature values of entities from one or more EntityTypes. Point-in-time correctness is guaranteed for Feature values of each read instance as of each instance's read timestamp.", + "canonical": true, + "file": "featurestore_service.batch_read_feature_values.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 109, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchReadFeatureValues", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.BatchReadFeatureValues", + "async": true, + "parameters": [ + { + "name": "csv_read_instances", + "type": ".google.cloud.aiplatform.v1.CsvSource" + }, + { + "name": "bigquery_read_instances", + "type": ".google.cloud.aiplatform.v1.BigQuerySource" + }, + { + "name": "featurestore", + "type": "TYPE_STRING" + }, + { + "name": "destination", + "type": ".google.cloud.aiplatform.v1.FeatureValueDestination" + }, + { + "name": "pass_through_fields", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "entity_type_specs", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "start_time", + "type": ".google.protobuf.Timestamp" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "BatchReadFeatureValues", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.BatchReadFeatureValues", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreService_ExportFeatureValues_async", + "title": "DatasetService exportFeatureValues Sample", + "origin": "API_DEFINITION", + "description": " Exports Feature values from all the entities of a target EntityType.", + "canonical": true, + "file": "featurestore_service.export_feature_values.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ExportFeatureValues", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.ExportFeatureValues", + "async": true, + "parameters": [ + { + "name": "snapshot_export", + "type": ".google.cloud.aiplatform.v1.ExportFeatureValuesRequest.SnapshotExport" + }, + { + "name": "full_export", + "type": ".google.cloud.aiplatform.v1.ExportFeatureValuesRequest.FullExport" + }, + { + "name": "entity_type", + "type": "TYPE_STRING" + }, + { + "name": "destination", + "type": ".google.cloud.aiplatform.v1.FeatureValueDestination" + }, + { + "name": "feature_selector", + "type": ".google.cloud.aiplatform.v1.FeatureSelector" + }, + { + "name": "settings", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "ExportFeatureValues", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.ExportFeatureValues", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_FeaturestoreService_SearchFeatures_async", + "title": "DatasetService searchFeatures Sample", + "origin": "API_DEFINITION", + "description": " Searches Features matching a query in a given project.", + "canonical": true, + "file": "featurestore_service.search_features.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 124, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SearchFeatures", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures", + "async": true, + "parameters": [ + { + "name": "location", + "type": "TYPE_STRING" + }, + { + "name": "query", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.SearchFeaturesResponse", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "SearchFeatures", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_IndexEndpointService_CreateIndexEndpoint_async", + "title": "DatasetService createIndexEndpoint Sample", + "origin": "API_DEFINITION", + "description": " Creates an IndexEndpoint.", + "canonical": true, + "file": "index_endpoint_service.create_index_endpoint.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateIndexEndpoint", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService.CreateIndexEndpoint", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "index_endpoint", + "type": ".google.cloud.aiplatform.v1.IndexEndpoint" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "IndexEndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointServiceClient" + }, + "method": { + "shortName": "CreateIndexEndpoint", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService.CreateIndexEndpoint", + "service": { + "shortName": "IndexEndpointService", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_IndexEndpointService_GetIndexEndpoint_async", + "title": "DatasetService getIndexEndpoint Sample", + "origin": "API_DEFINITION", + "description": " Gets an IndexEndpoint.", + "canonical": true, + "file": "index_endpoint_service.get_index_endpoint.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetIndexEndpoint", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService.GetIndexEndpoint", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.IndexEndpoint", + "client": { + "shortName": "IndexEndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointServiceClient" + }, + "method": { + "shortName": "GetIndexEndpoint", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService.GetIndexEndpoint", + "service": { + "shortName": "IndexEndpointService", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_IndexEndpointService_ListIndexEndpoints_async", + "title": "DatasetService listIndexEndpoints Sample", + "origin": "API_DEFINITION", + "description": " Lists IndexEndpoints in a Location.", + "canonical": true, + "file": "index_endpoint_service.list_index_endpoints.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 92, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListIndexEndpoints", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListIndexEndpointsResponse", + "client": { + "shortName": "IndexEndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointServiceClient" + }, + "method": { + "shortName": "ListIndexEndpoints", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints", + "service": { + "shortName": "IndexEndpointService", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_IndexEndpointService_UpdateIndexEndpoint_async", + "title": "DatasetService updateIndexEndpoint Sample", + "origin": "API_DEFINITION", + "description": " Updates an IndexEndpoint.", + "canonical": true, + "file": "index_endpoint_service.update_index_endpoint.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateIndexEndpoint", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService.UpdateIndexEndpoint", + "async": true, + "parameters": [ + { + "name": "index_endpoint", + "type": ".google.cloud.aiplatform.v1.IndexEndpoint" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.IndexEndpoint", + "client": { + "shortName": "IndexEndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointServiceClient" + }, + "method": { + "shortName": "UpdateIndexEndpoint", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService.UpdateIndexEndpoint", + "service": { + "shortName": "IndexEndpointService", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_IndexEndpointService_DeleteIndexEndpoint_async", + "title": "DatasetService deleteIndexEndpoint Sample", + "origin": "API_DEFINITION", + "description": " Deletes an IndexEndpoint.", + "canonical": true, + "file": "index_endpoint_service.delete_index_endpoint.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteIndexEndpoint", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService.DeleteIndexEndpoint", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "IndexEndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointServiceClient" + }, + "method": { + "shortName": "DeleteIndexEndpoint", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService.DeleteIndexEndpoint", + "service": { + "shortName": "IndexEndpointService", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_IndexEndpointService_DeployIndex_async", + "title": "DatasetService deployIndex Sample", + "origin": "API_DEFINITION", + "description": " Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. Only non-empty Indexes can be deployed.", + "canonical": true, + "file": "index_endpoint_service.deploy_index.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeployIndex", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService.DeployIndex", + "async": true, + "parameters": [ + { + "name": "index_endpoint", + "type": "TYPE_STRING" + }, + { + "name": "deployed_index", + "type": ".google.cloud.aiplatform.v1.DeployedIndex" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "IndexEndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointServiceClient" + }, + "method": { + "shortName": "DeployIndex", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService.DeployIndex", + "service": { + "shortName": "IndexEndpointService", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_IndexEndpointService_UndeployIndex_async", + "title": "DatasetService undeployIndex Sample", + "origin": "API_DEFINITION", + "description": " Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.", + "canonical": true, + "file": "index_endpoint_service.undeploy_index.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UndeployIndex", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService.UndeployIndex", + "async": true, + "parameters": [ + { + "name": "index_endpoint", + "type": "TYPE_STRING" + }, + { + "name": "deployed_index_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "IndexEndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointServiceClient" + }, + "method": { + "shortName": "UndeployIndex", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService.UndeployIndex", + "service": { + "shortName": "IndexEndpointService", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_IndexEndpointService_MutateDeployedIndex_async", + "title": "DatasetService mutateDeployedIndex Sample", + "origin": "API_DEFINITION", + "description": " Update an existing DeployedIndex under an IndexEndpoint.", + "canonical": true, + "file": "index_endpoint_service.mutate_deployed_index.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "MutateDeployedIndex", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService.MutateDeployedIndex", + "async": true, + "parameters": [ + { + "name": "index_endpoint", + "type": "TYPE_STRING" + }, + { + "name": "deployed_index", + "type": ".google.cloud.aiplatform.v1.DeployedIndex" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "IndexEndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointServiceClient" + }, + "method": { + "shortName": "MutateDeployedIndex", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService.MutateDeployedIndex", + "service": { + "shortName": "IndexEndpointService", + "fullName": "google.cloud.aiplatform.v1.IndexEndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_IndexService_CreateIndex_async", + "title": "DatasetService createIndex Sample", + "origin": "API_DEFINITION", + "description": " Creates an Index.", + "canonical": true, + "file": "index_service.create_index.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateIndex", + "fullName": "google.cloud.aiplatform.v1.IndexService.CreateIndex", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "index", + "type": ".google.cloud.aiplatform.v1.Index" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "IndexServiceClient", + "fullName": "google.cloud.aiplatform.v1.IndexServiceClient" + }, + "method": { + "shortName": "CreateIndex", + "fullName": "google.cloud.aiplatform.v1.IndexService.CreateIndex", + "service": { + "shortName": "IndexService", + "fullName": "google.cloud.aiplatform.v1.IndexService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_IndexService_GetIndex_async", + "title": "DatasetService getIndex Sample", + "origin": "API_DEFINITION", + "description": " Gets an Index.", + "canonical": true, + "file": "index_service.get_index.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetIndex", + "fullName": "google.cloud.aiplatform.v1.IndexService.GetIndex", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Index", + "client": { + "shortName": "IndexServiceClient", + "fullName": "google.cloud.aiplatform.v1.IndexServiceClient" + }, + "method": { + "shortName": "GetIndex", + "fullName": "google.cloud.aiplatform.v1.IndexService.GetIndex", + "service": { + "shortName": "IndexService", + "fullName": "google.cloud.aiplatform.v1.IndexService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_IndexService_ListIndexes_async", + "title": "DatasetService listIndexes Sample", + "origin": "API_DEFINITION", + "description": " Lists Indexes in a Location.", + "canonical": true, + "file": "index_service.list_indexes.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 77, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListIndexes", + "fullName": "google.cloud.aiplatform.v1.IndexService.ListIndexes", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListIndexesResponse", + "client": { + "shortName": "IndexServiceClient", + "fullName": "google.cloud.aiplatform.v1.IndexServiceClient" + }, + "method": { + "shortName": "ListIndexes", + "fullName": "google.cloud.aiplatform.v1.IndexService.ListIndexes", + "service": { + "shortName": "IndexService", + "fullName": "google.cloud.aiplatform.v1.IndexService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_IndexService_UpdateIndex_async", + "title": "DatasetService updateIndex Sample", + "origin": "API_DEFINITION", + "description": " Updates an Index.", + "canonical": true, + "file": "index_service.update_index.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateIndex", + "fullName": "google.cloud.aiplatform.v1.IndexService.UpdateIndex", + "async": true, + "parameters": [ + { + "name": "index", + "type": ".google.cloud.aiplatform.v1.Index" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "IndexServiceClient", + "fullName": "google.cloud.aiplatform.v1.IndexServiceClient" + }, + "method": { + "shortName": "UpdateIndex", + "fullName": "google.cloud.aiplatform.v1.IndexService.UpdateIndex", + "service": { + "shortName": "IndexService", + "fullName": "google.cloud.aiplatform.v1.IndexService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_IndexService_DeleteIndex_async", + "title": "DatasetService deleteIndex Sample", + "origin": "API_DEFINITION", + "description": " Deletes an Index. An Index can only be deleted when all its [DeployedIndexes][google.cloud.aiplatform.v1.Index.deployed_indexes] had been undeployed.", + "canonical": true, + "file": "index_service.delete_index.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteIndex", + "fullName": "google.cloud.aiplatform.v1.IndexService.DeleteIndex", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "IndexServiceClient", + "fullName": "google.cloud.aiplatform.v1.IndexServiceClient" + }, + "method": { + "shortName": "DeleteIndex", + "fullName": "google.cloud.aiplatform.v1.IndexService.DeleteIndex", + "service": { + "shortName": "IndexService", + "fullName": "google.cloud.aiplatform.v1.IndexService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_IndexService_UpsertDatapoints_async", + "title": "DatasetService upsertDatapoints Sample", + "origin": "API_DEFINITION", + "description": " Add/update Datapoints into an Index.", + "canonical": true, + "file": "index_service.upsert_datapoints.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpsertDatapoints", + "fullName": "google.cloud.aiplatform.v1.IndexService.UpsertDatapoints", + "async": true, + "parameters": [ + { + "name": "index", + "type": "TYPE_STRING" + }, + { + "name": "datapoints", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1.UpsertDatapointsResponse", + "client": { + "shortName": "IndexServiceClient", + "fullName": "google.cloud.aiplatform.v1.IndexServiceClient" + }, + "method": { + "shortName": "UpsertDatapoints", + "fullName": "google.cloud.aiplatform.v1.IndexService.UpsertDatapoints", + "service": { + "shortName": "IndexService", + "fullName": "google.cloud.aiplatform.v1.IndexService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_IndexService_RemoveDatapoints_async", + "title": "DatasetService removeDatapoints Sample", + "origin": "API_DEFINITION", + "description": " Remove Datapoints from an Index.", + "canonical": true, + "file": "index_service.remove_datapoints.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RemoveDatapoints", + "fullName": "google.cloud.aiplatform.v1.IndexService.RemoveDatapoints", + "async": true, + "parameters": [ + { + "name": "index", + "type": "TYPE_STRING" + }, + { + "name": "datapoint_ids", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1.RemoveDatapointsResponse", + "client": { + "shortName": "IndexServiceClient", + "fullName": "google.cloud.aiplatform.v1.IndexServiceClient" + }, + "method": { + "shortName": "RemoveDatapoints", + "fullName": "google.cloud.aiplatform.v1.IndexService.RemoveDatapoints", + "service": { + "shortName": "IndexService", + "fullName": "google.cloud.aiplatform.v1.IndexService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_CreateCustomJob_async", + "title": "DatasetService createCustomJob Sample", + "origin": "API_DEFINITION", + "description": " Creates a CustomJob. A created CustomJob right away will be attempted to be run.", + "canonical": true, + "file": "job_service.create_custom_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateCustomJob", + "fullName": "google.cloud.aiplatform.v1.JobService.CreateCustomJob", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "custom_job", + "type": ".google.cloud.aiplatform.v1.CustomJob" + } + ], + "resultType": ".google.cloud.aiplatform.v1.CustomJob", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "CreateCustomJob", + "fullName": "google.cloud.aiplatform.v1.JobService.CreateCustomJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_GetCustomJob_async", + "title": "DatasetService getCustomJob Sample", + "origin": "API_DEFINITION", + "description": " Gets a CustomJob.", + "canonical": true, + "file": "job_service.get_custom_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetCustomJob", + "fullName": "google.cloud.aiplatform.v1.JobService.GetCustomJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.CustomJob", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "GetCustomJob", + "fullName": "google.cloud.aiplatform.v1.JobService.GetCustomJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_ListCustomJobs_async", + "title": "DatasetService listCustomJobs Sample", + "origin": "API_DEFINITION", + "description": " Lists CustomJobs in a Location.", + "canonical": true, + "file": "job_service.list_custom_jobs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 92, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListCustomJobs", + "fullName": "google.cloud.aiplatform.v1.JobService.ListCustomJobs", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListCustomJobsResponse", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "ListCustomJobs", + "fullName": "google.cloud.aiplatform.v1.JobService.ListCustomJobs", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_DeleteCustomJob_async", + "title": "DatasetService deleteCustomJob Sample", + "origin": "API_DEFINITION", + "description": " Deletes a CustomJob.", + "canonical": true, + "file": "job_service.delete_custom_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteCustomJob", + "fullName": "google.cloud.aiplatform.v1.JobService.DeleteCustomJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "DeleteCustomJob", + "fullName": "google.cloud.aiplatform.v1.JobService.DeleteCustomJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_CancelCustomJob_async", + "title": "DatasetService cancelCustomJob Sample", + "origin": "API_DEFINITION", + "description": " Cancels a CustomJob. Starts asynchronous cancellation on the CustomJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use [JobService.GetCustomJob][google.cloud.aiplatform.v1.JobService.GetCustomJob] or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the CustomJob is not deleted; instead it becomes a job with a [CustomJob.error][google.cloud.aiplatform.v1.CustomJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [CustomJob.state][google.cloud.aiplatform.v1.CustomJob.state] is set to `CANCELLED`.", + "canonical": true, + "file": "job_service.cancel_custom_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CancelCustomJob", + "fullName": "google.cloud.aiplatform.v1.JobService.CancelCustomJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "CancelCustomJob", + "fullName": "google.cloud.aiplatform.v1.JobService.CancelCustomJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_CreateDataLabelingJob_async", + "title": "DatasetService createDataLabelingJob Sample", + "origin": "API_DEFINITION", + "description": " Creates a DataLabelingJob.", + "canonical": true, + "file": "job_service.create_data_labeling_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateDataLabelingJob", + "fullName": "google.cloud.aiplatform.v1.JobService.CreateDataLabelingJob", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "data_labeling_job", + "type": ".google.cloud.aiplatform.v1.DataLabelingJob" + } + ], + "resultType": ".google.cloud.aiplatform.v1.DataLabelingJob", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "CreateDataLabelingJob", + "fullName": "google.cloud.aiplatform.v1.JobService.CreateDataLabelingJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_GetDataLabelingJob_async", + "title": "DatasetService getDataLabelingJob Sample", + "origin": "API_DEFINITION", + "description": " Gets a DataLabelingJob.", + "canonical": true, + "file": "job_service.get_data_labeling_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetDataLabelingJob", + "fullName": "google.cloud.aiplatform.v1.JobService.GetDataLabelingJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.DataLabelingJob", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "GetDataLabelingJob", + "fullName": "google.cloud.aiplatform.v1.JobService.GetDataLabelingJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_ListDataLabelingJobs_async", + "title": "DatasetService listDataLabelingJobs Sample", + "origin": "API_DEFINITION", + "description": " Lists DataLabelingJobs in a Location.", + "canonical": true, + "file": "job_service.list_data_labeling_jobs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 96, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListDataLabelingJobs", + "fullName": "google.cloud.aiplatform.v1.JobService.ListDataLabelingJobs", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListDataLabelingJobsResponse", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "ListDataLabelingJobs", + "fullName": "google.cloud.aiplatform.v1.JobService.ListDataLabelingJobs", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_DeleteDataLabelingJob_async", + "title": "DatasetService deleteDataLabelingJob Sample", + "origin": "API_DEFINITION", + "description": " Deletes a DataLabelingJob.", + "canonical": true, + "file": "job_service.delete_data_labeling_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteDataLabelingJob", + "fullName": "google.cloud.aiplatform.v1.JobService.DeleteDataLabelingJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "DeleteDataLabelingJob", + "fullName": "google.cloud.aiplatform.v1.JobService.DeleteDataLabelingJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_CancelDataLabelingJob_async", + "title": "DatasetService cancelDataLabelingJob Sample", + "origin": "API_DEFINITION", + "description": " Cancels a DataLabelingJob. Success of cancellation is not guaranteed.", + "canonical": true, + "file": "job_service.cancel_data_labeling_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CancelDataLabelingJob", + "fullName": "google.cloud.aiplatform.v1.JobService.CancelDataLabelingJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "CancelDataLabelingJob", + "fullName": "google.cloud.aiplatform.v1.JobService.CancelDataLabelingJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_CreateHyperparameterTuningJob_async", + "title": "DatasetService createHyperparameterTuningJob Sample", + "origin": "API_DEFINITION", + "description": " Creates a HyperparameterTuningJob", + "canonical": true, + "file": "job_service.create_hyperparameter_tuning_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateHyperparameterTuningJob", + "fullName": "google.cloud.aiplatform.v1.JobService.CreateHyperparameterTuningJob", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "hyperparameter_tuning_job", + "type": ".google.cloud.aiplatform.v1.HyperparameterTuningJob" + } + ], + "resultType": ".google.cloud.aiplatform.v1.HyperparameterTuningJob", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "CreateHyperparameterTuningJob", + "fullName": "google.cloud.aiplatform.v1.JobService.CreateHyperparameterTuningJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_GetHyperparameterTuningJob_async", + "title": "DatasetService getHyperparameterTuningJob Sample", + "origin": "API_DEFINITION", + "description": " Gets a HyperparameterTuningJob", + "canonical": true, + "file": "job_service.get_hyperparameter_tuning_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetHyperparameterTuningJob", + "fullName": "google.cloud.aiplatform.v1.JobService.GetHyperparameterTuningJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.HyperparameterTuningJob", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "GetHyperparameterTuningJob", + "fullName": "google.cloud.aiplatform.v1.JobService.GetHyperparameterTuningJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_ListHyperparameterTuningJobs_async", + "title": "DatasetService listHyperparameterTuningJobs Sample", + "origin": "API_DEFINITION", + "description": " Lists HyperparameterTuningJobs in a Location.", + "canonical": true, + "file": "job_service.list_hyperparameter_tuning_jobs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 93, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListHyperparameterTuningJobs", + "fullName": "google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListHyperparameterTuningJobsResponse", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "ListHyperparameterTuningJobs", + "fullName": "google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_DeleteHyperparameterTuningJob_async", + "title": "DatasetService deleteHyperparameterTuningJob Sample", + "origin": "API_DEFINITION", + "description": " Deletes a HyperparameterTuningJob.", + "canonical": true, + "file": "job_service.delete_hyperparameter_tuning_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteHyperparameterTuningJob", + "fullName": "google.cloud.aiplatform.v1.JobService.DeleteHyperparameterTuningJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "DeleteHyperparameterTuningJob", + "fullName": "google.cloud.aiplatform.v1.JobService.DeleteHyperparameterTuningJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_CancelHyperparameterTuningJob_async", + "title": "DatasetService cancelHyperparameterTuningJob Sample", + "origin": "API_DEFINITION", + "description": " Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on the HyperparameterTuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use [JobService.GetHyperparameterTuningJob][google.cloud.aiplatform.v1.JobService.GetHyperparameterTuningJob] or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the HyperparameterTuningJob is not deleted; instead it becomes a job with a [HyperparameterTuningJob.error][google.cloud.aiplatform.v1.HyperparameterTuningJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [HyperparameterTuningJob.state][google.cloud.aiplatform.v1.HyperparameterTuningJob.state] is set to `CANCELLED`.", + "canonical": true, + "file": "job_service.cancel_hyperparameter_tuning_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CancelHyperparameterTuningJob", + "fullName": "google.cloud.aiplatform.v1.JobService.CancelHyperparameterTuningJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "CancelHyperparameterTuningJob", + "fullName": "google.cloud.aiplatform.v1.JobService.CancelHyperparameterTuningJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_CreateBatchPredictionJob_async", + "title": "DatasetService createBatchPredictionJob Sample", + "origin": "API_DEFINITION", + "description": " Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.", + "canonical": true, + "file": "job_service.create_batch_prediction_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateBatchPredictionJob", + "fullName": "google.cloud.aiplatform.v1.JobService.CreateBatchPredictionJob", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "batch_prediction_job", + "type": ".google.cloud.aiplatform.v1.BatchPredictionJob" + } + ], + "resultType": ".google.cloud.aiplatform.v1.BatchPredictionJob", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "CreateBatchPredictionJob", + "fullName": "google.cloud.aiplatform.v1.JobService.CreateBatchPredictionJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_GetBatchPredictionJob_async", + "title": "DatasetService getBatchPredictionJob Sample", + "origin": "API_DEFINITION", + "description": " Gets a BatchPredictionJob", + "canonical": true, + "file": "job_service.get_batch_prediction_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetBatchPredictionJob", + "fullName": "google.cloud.aiplatform.v1.JobService.GetBatchPredictionJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.BatchPredictionJob", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "GetBatchPredictionJob", + "fullName": "google.cloud.aiplatform.v1.JobService.GetBatchPredictionJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_ListBatchPredictionJobs_async", + "title": "DatasetService listBatchPredictionJobs Sample", + "origin": "API_DEFINITION", + "description": " Lists BatchPredictionJobs in a Location.", + "canonical": true, + "file": "job_service.list_batch_prediction_jobs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 93, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListBatchPredictionJobs", + "fullName": "google.cloud.aiplatform.v1.JobService.ListBatchPredictionJobs", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListBatchPredictionJobsResponse", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "ListBatchPredictionJobs", + "fullName": "google.cloud.aiplatform.v1.JobService.ListBatchPredictionJobs", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_DeleteBatchPredictionJob_async", + "title": "DatasetService deleteBatchPredictionJob Sample", + "origin": "API_DEFINITION", + "description": " Deletes a BatchPredictionJob. Can only be called on jobs that already finished.", + "canonical": true, + "file": "job_service.delete_batch_prediction_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteBatchPredictionJob", + "fullName": "google.cloud.aiplatform.v1.JobService.DeleteBatchPredictionJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "DeleteBatchPredictionJob", + "fullName": "google.cloud.aiplatform.v1.JobService.DeleteBatchPredictionJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_CancelBatchPredictionJob_async", + "title": "DatasetService cancelBatchPredictionJob Sample", + "origin": "API_DEFINITION", + "description": " Cancels a BatchPredictionJob. Starts asynchronous cancellation on the BatchPredictionJob. The server makes the best effort to cancel the job, but success is not guaranteed. Clients can use [JobService.GetBatchPredictionJob][google.cloud.aiplatform.v1.JobService.GetBatchPredictionJob] or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob is not deleted;instead its [BatchPredictionJob.state][google.cloud.aiplatform.v1.BatchPredictionJob.state] is set to `CANCELLED`. Any files already outputted by the job are not deleted.", + "canonical": true, + "file": "job_service.cancel_batch_prediction_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CancelBatchPredictionJob", + "fullName": "google.cloud.aiplatform.v1.JobService.CancelBatchPredictionJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "CancelBatchPredictionJob", + "fullName": "google.cloud.aiplatform.v1.JobService.CancelBatchPredictionJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_CreateModelDeploymentMonitoringJob_async", + "title": "DatasetService createModelDeploymentMonitoringJob Sample", + "origin": "API_DEFINITION", + "description": " Creates a ModelDeploymentMonitoringJob. It will run periodically on a configured interval.", + "canonical": true, + "file": "job_service.create_model_deployment_monitoring_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1.JobService.CreateModelDeploymentMonitoringJob", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "model_deployment_monitoring_job", + "type": ".google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "CreateModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1.JobService.CreateModelDeploymentMonitoringJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_SearchModelDeploymentMonitoringStatsAnomalies_async", + "title": "DatasetService searchModelDeploymentMonitoringStatsAnomalies Sample", + "origin": "API_DEFINITION", + "description": " Searches Model Monitoring Statistics generated within a given time window.", + "canonical": true, + "file": "job_service.search_model_deployment_monitoring_stats_anomalies.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 95, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SearchModelDeploymentMonitoringStatsAnomalies", + "fullName": "google.cloud.aiplatform.v1.JobService.SearchModelDeploymentMonitoringStatsAnomalies", + "async": true, + "parameters": [ + { + "name": "model_deployment_monitoring_job", + "type": "TYPE_STRING" + }, + { + "name": "deployed_model_id", + "type": "TYPE_STRING" + }, + { + "name": "feature_display_name", + "type": "TYPE_STRING" + }, + { + "name": "objectives", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "start_time", + "type": ".google.protobuf.Timestamp" + }, + { + "name": "end_time", + "type": ".google.protobuf.Timestamp" + } + ], + "resultType": ".google.cloud.aiplatform.v1.SearchModelDeploymentMonitoringStatsAnomaliesResponse", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "SearchModelDeploymentMonitoringStatsAnomalies", + "fullName": "google.cloud.aiplatform.v1.JobService.SearchModelDeploymentMonitoringStatsAnomalies", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_GetModelDeploymentMonitoringJob_async", + "title": "DatasetService getModelDeploymentMonitoringJob Sample", + "origin": "API_DEFINITION", + "description": " Gets a ModelDeploymentMonitoringJob.", + "canonical": true, + "file": "job_service.get_model_deployment_monitoring_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1.JobService.GetModelDeploymentMonitoringJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "GetModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1.JobService.GetModelDeploymentMonitoringJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_ListModelDeploymentMonitoringJobs_async", + "title": "DatasetService listModelDeploymentMonitoringJobs Sample", + "origin": "API_DEFINITION", + "description": " Lists ModelDeploymentMonitoringJobs in a Location.", + "canonical": true, + "file": "job_service.list_model_deployment_monitoring_jobs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 87, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListModelDeploymentMonitoringJobs", + "fullName": "google.cloud.aiplatform.v1.JobService.ListModelDeploymentMonitoringJobs", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListModelDeploymentMonitoringJobsResponse", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "ListModelDeploymentMonitoringJobs", + "fullName": "google.cloud.aiplatform.v1.JobService.ListModelDeploymentMonitoringJobs", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_UpdateModelDeploymentMonitoringJob_async", + "title": "DatasetService updateModelDeploymentMonitoringJob Sample", + "origin": "API_DEFINITION", + "description": " Updates a ModelDeploymentMonitoringJob.", + "canonical": true, + "file": "job_service.update_model_deployment_monitoring_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 83, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1.JobService.UpdateModelDeploymentMonitoringJob", + "async": true, + "parameters": [ + { + "name": "model_deployment_monitoring_job", + "type": ".google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "UpdateModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1.JobService.UpdateModelDeploymentMonitoringJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_DeleteModelDeploymentMonitoringJob_async", + "title": "DatasetService deleteModelDeploymentMonitoringJob Sample", + "origin": "API_DEFINITION", + "description": " Deletes a ModelDeploymentMonitoringJob.", + "canonical": true, + "file": "job_service.delete_model_deployment_monitoring_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1.JobService.DeleteModelDeploymentMonitoringJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "DeleteModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1.JobService.DeleteModelDeploymentMonitoringJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_PauseModelDeploymentMonitoringJob_async", + "title": "DatasetService pauseModelDeploymentMonitoringJob Sample", + "origin": "API_DEFINITION", + "description": " Pauses a ModelDeploymentMonitoringJob. If the job is running, the server makes a best effort to cancel the job. Will mark [ModelDeploymentMonitoringJob.state][google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob.state] to 'PAUSED'.", + "canonical": true, + "file": "job_service.pause_model_deployment_monitoring_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "PauseModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1.JobService.PauseModelDeploymentMonitoringJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "PauseModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1.JobService.PauseModelDeploymentMonitoringJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_JobService_ResumeModelDeploymentMonitoringJob_async", + "title": "DatasetService resumeModelDeploymentMonitoringJob Sample", + "origin": "API_DEFINITION", + "description": " Resumes a paused ModelDeploymentMonitoringJob. It will start to run from next scheduled time. A deleted ModelDeploymentMonitoringJob can't be resumed.", + "canonical": true, + "file": "job_service.resume_model_deployment_monitoring_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ResumeModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1.JobService.ResumeModelDeploymentMonitoringJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1.JobServiceClient" + }, + "method": { + "shortName": "ResumeModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1.JobService.ResumeModelDeploymentMonitoringJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_CreateMetadataStore_async", + "title": "DatasetService createMetadataStore Sample", + "origin": "API_DEFINITION", + "description": " Initializes a MetadataStore, including allocation of resources.", + "canonical": true, + "file": "metadata_service.create_metadata_store.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateMetadataStore", + "fullName": "google.cloud.aiplatform.v1.MetadataService.CreateMetadataStore", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "metadata_store", + "type": ".google.cloud.aiplatform.v1.MetadataStore" + }, + { + "name": "metadata_store_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "CreateMetadataStore", + "fullName": "google.cloud.aiplatform.v1.MetadataService.CreateMetadataStore", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_GetMetadataStore_async", + "title": "DatasetService getMetadataStore Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a specific MetadataStore.", + "canonical": true, + "file": "metadata_service.get_metadata_store.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetMetadataStore", + "fullName": "google.cloud.aiplatform.v1.MetadataService.GetMetadataStore", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.MetadataStore", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "GetMetadataStore", + "fullName": "google.cloud.aiplatform.v1.MetadataService.GetMetadataStore", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_ListMetadataStores_async", + "title": "DatasetService listMetadataStores Sample", + "origin": "API_DEFINITION", + "description": " Lists MetadataStores for a Location.", + "canonical": true, + "file": "metadata_service.list_metadata_stores.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListMetadataStores", + "fullName": "google.cloud.aiplatform.v1.MetadataService.ListMetadataStores", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListMetadataStoresResponse", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "ListMetadataStores", + "fullName": "google.cloud.aiplatform.v1.MetadataService.ListMetadataStores", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_DeleteMetadataStore_async", + "title": "DatasetService deleteMetadataStore Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts).", + "canonical": true, + "file": "metadata_service.delete_metadata_store.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteMetadataStore", + "fullName": "google.cloud.aiplatform.v1.MetadataService.DeleteMetadataStore", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "DeleteMetadataStore", + "fullName": "google.cloud.aiplatform.v1.MetadataService.DeleteMetadataStore", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_CreateArtifact_async", + "title": "DatasetService createArtifact Sample", + "origin": "API_DEFINITION", + "description": " Creates an Artifact associated with a MetadataStore.", + "canonical": true, + "file": "metadata_service.create_artifact.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateArtifact", + "fullName": "google.cloud.aiplatform.v1.MetadataService.CreateArtifact", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "artifact", + "type": ".google.cloud.aiplatform.v1.Artifact" + }, + { + "name": "artifact_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Artifact", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "CreateArtifact", + "fullName": "google.cloud.aiplatform.v1.MetadataService.CreateArtifact", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_GetArtifact_async", + "title": "DatasetService getArtifact Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a specific Artifact.", + "canonical": true, + "file": "metadata_service.get_artifact.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetArtifact", + "fullName": "google.cloud.aiplatform.v1.MetadataService.GetArtifact", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Artifact", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "GetArtifact", + "fullName": "google.cloud.aiplatform.v1.MetadataService.GetArtifact", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_ListArtifacts_async", + "title": "DatasetService listArtifacts Sample", + "origin": "API_DEFINITION", + "description": " Lists Artifacts in the MetadataStore.", + "canonical": true, + "file": "metadata_service.list_artifacts.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 108, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListArtifacts", + "fullName": "google.cloud.aiplatform.v1.MetadataService.ListArtifacts", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListArtifactsResponse", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "ListArtifacts", + "fullName": "google.cloud.aiplatform.v1.MetadataService.ListArtifacts", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_UpdateArtifact_async", + "title": "DatasetService updateArtifact Sample", + "origin": "API_DEFINITION", + "description": " Updates a stored Artifact.", + "canonical": true, + "file": "metadata_service.update_artifact.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateArtifact", + "fullName": "google.cloud.aiplatform.v1.MetadataService.UpdateArtifact", + "async": true, + "parameters": [ + { + "name": "artifact", + "type": ".google.cloud.aiplatform.v1.Artifact" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "allow_missing", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Artifact", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "UpdateArtifact", + "fullName": "google.cloud.aiplatform.v1.MetadataService.UpdateArtifact", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_DeleteArtifact_async", + "title": "DatasetService deleteArtifact Sample", + "origin": "API_DEFINITION", + "description": " Deletes an Artifact.", + "canonical": true, + "file": "metadata_service.delete_artifact.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteArtifact", + "fullName": "google.cloud.aiplatform.v1.MetadataService.DeleteArtifact", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "etag", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "DeleteArtifact", + "fullName": "google.cloud.aiplatform.v1.MetadataService.DeleteArtifact", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_PurgeArtifacts_async", + "title": "DatasetService purgeArtifacts Sample", + "origin": "API_DEFINITION", + "description": " Purges Artifacts.", + "canonical": true, + "file": "metadata_service.purge_artifacts.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "PurgeArtifacts", + "fullName": "google.cloud.aiplatform.v1.MetadataService.PurgeArtifacts", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "PurgeArtifacts", + "fullName": "google.cloud.aiplatform.v1.MetadataService.PurgeArtifacts", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_CreateContext_async", + "title": "DatasetService createContext Sample", + "origin": "API_DEFINITION", + "description": " Creates a Context associated with a MetadataStore.", + "canonical": true, + "file": "metadata_service.create_context.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 70, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateContext", + "fullName": "google.cloud.aiplatform.v1.MetadataService.CreateContext", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "context", + "type": ".google.cloud.aiplatform.v1.Context" + }, + { + "name": "context_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Context", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "CreateContext", + "fullName": "google.cloud.aiplatform.v1.MetadataService.CreateContext", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_GetContext_async", + "title": "DatasetService getContext Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a specific Context.", + "canonical": true, + "file": "metadata_service.get_context.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetContext", + "fullName": "google.cloud.aiplatform.v1.MetadataService.GetContext", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Context", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "GetContext", + "fullName": "google.cloud.aiplatform.v1.MetadataService.GetContext", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_ListContexts_async", + "title": "DatasetService listContexts Sample", + "origin": "API_DEFINITION", + "description": " Lists Contexts on the MetadataStore.", + "canonical": true, + "file": "metadata_service.list_contexts.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 111, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListContexts", + "fullName": "google.cloud.aiplatform.v1.MetadataService.ListContexts", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListContextsResponse", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "ListContexts", + "fullName": "google.cloud.aiplatform.v1.MetadataService.ListContexts", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_UpdateContext_async", + "title": "DatasetService updateContext Sample", + "origin": "API_DEFINITION", + "description": " Updates a stored Context.", + "canonical": true, + "file": "metadata_service.update_context.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateContext", + "fullName": "google.cloud.aiplatform.v1.MetadataService.UpdateContext", + "async": true, + "parameters": [ + { + "name": "context", + "type": ".google.cloud.aiplatform.v1.Context" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "allow_missing", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Context", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "UpdateContext", + "fullName": "google.cloud.aiplatform.v1.MetadataService.UpdateContext", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_DeleteContext_async", + "title": "DatasetService deleteContext Sample", + "origin": "API_DEFINITION", + "description": " Deletes a stored Context.", + "canonical": true, + "file": "metadata_service.delete_context.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteContext", + "fullName": "google.cloud.aiplatform.v1.MetadataService.DeleteContext", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" + }, + { + "name": "etag", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "DeleteContext", + "fullName": "google.cloud.aiplatform.v1.MetadataService.DeleteContext", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_PurgeContexts_async", + "title": "DatasetService purgeContexts Sample", + "origin": "API_DEFINITION", + "description": " Purges Contexts.", + "canonical": true, + "file": "metadata_service.purge_contexts.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "PurgeContexts", + "fullName": "google.cloud.aiplatform.v1.MetadataService.PurgeContexts", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "PurgeContexts", + "fullName": "google.cloud.aiplatform.v1.MetadataService.PurgeContexts", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_AddContextArtifactsAndExecutions_async", + "title": "DatasetService addContextArtifactsAndExecutions Sample", + "origin": "API_DEFINITION", + "description": " Adds a set of Artifacts and Executions to a Context. If any of the Artifacts or Executions have already been added to a Context, they are simply skipped.", + "canonical": true, + "file": "metadata_service.add_context_artifacts_and_executions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AddContextArtifactsAndExecutions", + "fullName": "google.cloud.aiplatform.v1.MetadataService.AddContextArtifactsAndExecutions", + "async": true, + "parameters": [ + { + "name": "context", + "type": "TYPE_STRING" + }, + { + "name": "artifacts", + "type": "TYPE_STRING[]" + }, + { + "name": "executions", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1.AddContextArtifactsAndExecutionsResponse", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "AddContextArtifactsAndExecutions", + "fullName": "google.cloud.aiplatform.v1.MetadataService.AddContextArtifactsAndExecutions", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_AddContextChildren_async", + "title": "DatasetService addContextChildren Sample", + "origin": "API_DEFINITION", + "description": " Adds a set of Contexts as children to a parent Context. If any of the child Contexts have already been added to the parent Context, they are simply skipped. If this call would create a cycle or cause any Context to have more than 10 parents, the request will fail with an INVALID_ARGUMENT error.", + "canonical": true, + "file": "metadata_service.add_context_children.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AddContextChildren", + "fullName": "google.cloud.aiplatform.v1.MetadataService.AddContextChildren", + "async": true, + "parameters": [ + { + "name": "context", + "type": "TYPE_STRING" + }, + { + "name": "child_contexts", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1.AddContextChildrenResponse", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "AddContextChildren", + "fullName": "google.cloud.aiplatform.v1.MetadataService.AddContextChildren", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_RemoveContextChildren_async", + "title": "DatasetService removeContextChildren Sample", + "origin": "API_DEFINITION", + "description": " Remove a set of children contexts from a parent Context. If any of the child Contexts were NOT added to the parent Context, they are simply skipped.", + "canonical": true, + "file": "metadata_service.remove_context_children.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RemoveContextChildren", + "fullName": "google.cloud.aiplatform.v1.MetadataService.RemoveContextChildren", + "async": true, + "parameters": [ + { + "name": "context", + "type": "TYPE_STRING" + }, + { + "name": "child_contexts", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1.RemoveContextChildrenResponse", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "RemoveContextChildren", + "fullName": "google.cloud.aiplatform.v1.MetadataService.RemoveContextChildren", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_QueryContextLineageSubgraph_async", + "title": "DatasetService queryContextLineageSubgraph Sample", + "origin": "API_DEFINITION", + "description": " Retrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph.", + "canonical": true, + "file": "metadata_service.query_context_lineage_subgraph.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "QueryContextLineageSubgraph", + "fullName": "google.cloud.aiplatform.v1.MetadataService.QueryContextLineageSubgraph", + "async": true, + "parameters": [ + { + "name": "context", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.LineageSubgraph", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "QueryContextLineageSubgraph", + "fullName": "google.cloud.aiplatform.v1.MetadataService.QueryContextLineageSubgraph", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_CreateExecution_async", + "title": "DatasetService createExecution Sample", + "origin": "API_DEFINITION", + "description": " Creates an Execution associated with a MetadataStore.", + "canonical": true, + "file": "metadata_service.create_execution.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateExecution", + "fullName": "google.cloud.aiplatform.v1.MetadataService.CreateExecution", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "execution", + "type": ".google.cloud.aiplatform.v1.Execution" + }, + { + "name": "execution_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Execution", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "CreateExecution", + "fullName": "google.cloud.aiplatform.v1.MetadataService.CreateExecution", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_GetExecution_async", + "title": "DatasetService getExecution Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a specific Execution.", + "canonical": true, + "file": "metadata_service.get_execution.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetExecution", + "fullName": "google.cloud.aiplatform.v1.MetadataService.GetExecution", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Execution", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "GetExecution", + "fullName": "google.cloud.aiplatform.v1.MetadataService.GetExecution", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_ListExecutions_async", + "title": "DatasetService listExecutions Sample", + "origin": "API_DEFINITION", + "description": " Lists Executions in the MetadataStore.", + "canonical": true, + "file": "metadata_service.list_executions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 108, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListExecutions", + "fullName": "google.cloud.aiplatform.v1.MetadataService.ListExecutions", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListExecutionsResponse", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "ListExecutions", + "fullName": "google.cloud.aiplatform.v1.MetadataService.ListExecutions", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_UpdateExecution_async", + "title": "DatasetService updateExecution Sample", + "origin": "API_DEFINITION", + "description": " Updates a stored Execution.", + "canonical": true, + "file": "metadata_service.update_execution.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateExecution", + "fullName": "google.cloud.aiplatform.v1.MetadataService.UpdateExecution", + "async": true, + "parameters": [ + { + "name": "execution", + "type": ".google.cloud.aiplatform.v1.Execution" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "allow_missing", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Execution", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "UpdateExecution", + "fullName": "google.cloud.aiplatform.v1.MetadataService.UpdateExecution", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_DeleteExecution_async", + "title": "DatasetService deleteExecution Sample", + "origin": "API_DEFINITION", + "description": " Deletes an Execution.", + "canonical": true, + "file": "metadata_service.delete_execution.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteExecution", + "fullName": "google.cloud.aiplatform.v1.MetadataService.DeleteExecution", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "etag", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "DeleteExecution", + "fullName": "google.cloud.aiplatform.v1.MetadataService.DeleteExecution", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_PurgeExecutions_async", + "title": "DatasetService purgeExecutions Sample", + "origin": "API_DEFINITION", + "description": " Purges Executions.", + "canonical": true, + "file": "metadata_service.purge_executions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "PurgeExecutions", + "fullName": "google.cloud.aiplatform.v1.MetadataService.PurgeExecutions", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "PurgeExecutions", + "fullName": "google.cloud.aiplatform.v1.MetadataService.PurgeExecutions", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_AddExecutionEvents_async", + "title": "DatasetService addExecutionEvents Sample", + "origin": "API_DEFINITION", + "description": " Adds Events to the specified Execution. An Event indicates whether an Artifact was used as an input or output for an Execution. If an Event already exists between the Execution and the Artifact, the Event is skipped.", + "canonical": true, + "file": "metadata_service.add_execution_events.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AddExecutionEvents", + "fullName": "google.cloud.aiplatform.v1.MetadataService.AddExecutionEvents", + "async": true, + "parameters": [ + { + "name": "execution", + "type": "TYPE_STRING" + }, + { + "name": "events", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1.AddExecutionEventsResponse", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "AddExecutionEvents", + "fullName": "google.cloud.aiplatform.v1.MetadataService.AddExecutionEvents", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_QueryExecutionInputsAndOutputs_async", + "title": "DatasetService queryExecutionInputsAndOutputs Sample", + "origin": "API_DEFINITION", + "description": " Obtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events.", + "canonical": true, + "file": "metadata_service.query_execution_inputs_and_outputs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "QueryExecutionInputsAndOutputs", + "fullName": "google.cloud.aiplatform.v1.MetadataService.QueryExecutionInputsAndOutputs", + "async": true, + "parameters": [ + { + "name": "execution", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.LineageSubgraph", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "QueryExecutionInputsAndOutputs", + "fullName": "google.cloud.aiplatform.v1.MetadataService.QueryExecutionInputsAndOutputs", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_CreateMetadataSchema_async", + "title": "DatasetService createMetadataSchema Sample", + "origin": "API_DEFINITION", + "description": " Creates a MetadataSchema.", + "canonical": true, + "file": "metadata_service.create_metadata_schema.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateMetadataSchema", + "fullName": "google.cloud.aiplatform.v1.MetadataService.CreateMetadataSchema", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "metadata_schema", + "type": ".google.cloud.aiplatform.v1.MetadataSchema" + }, + { + "name": "metadata_schema_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.MetadataSchema", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "CreateMetadataSchema", + "fullName": "google.cloud.aiplatform.v1.MetadataService.CreateMetadataSchema", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_GetMetadataSchema_async", + "title": "DatasetService getMetadataSchema Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a specific MetadataSchema.", + "canonical": true, + "file": "metadata_service.get_metadata_schema.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetMetadataSchema", + "fullName": "google.cloud.aiplatform.v1.MetadataService.GetMetadataSchema", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.MetadataSchema", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "GetMetadataSchema", + "fullName": "google.cloud.aiplatform.v1.MetadataService.GetMetadataSchema", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_ListMetadataSchemas_async", + "title": "DatasetService listMetadataSchemas Sample", + "origin": "API_DEFINITION", + "description": " Lists MetadataSchemas.", + "canonical": true, + "file": "metadata_service.list_metadata_schemas.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 76, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListMetadataSchemas", + "fullName": "google.cloud.aiplatform.v1.MetadataService.ListMetadataSchemas", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListMetadataSchemasResponse", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "ListMetadataSchemas", + "fullName": "google.cloud.aiplatform.v1.MetadataService.ListMetadataSchemas", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MetadataService_QueryArtifactLineageSubgraph_async", + "title": "DatasetService queryArtifactLineageSubgraph Sample", + "origin": "API_DEFINITION", + "description": " Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph.", + "canonical": true, + "file": "metadata_service.query_artifact_lineage_subgraph.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 88, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "QueryArtifactLineageSubgraph", + "fullName": "google.cloud.aiplatform.v1.MetadataService.QueryArtifactLineageSubgraph", + "async": true, + "parameters": [ + { + "name": "artifact", + "type": "TYPE_STRING" + }, + { + "name": "max_hops", + "type": "TYPE_INT32" + }, + { + "name": "filter", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.LineageSubgraph", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1.MetadataServiceClient" + }, + "method": { + "shortName": "QueryArtifactLineageSubgraph", + "fullName": "google.cloud.aiplatform.v1.MetadataService.QueryArtifactLineageSubgraph", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MigrationService_SearchMigratableResources_async", + "title": "DatasetService searchMigratableResources Sample", + "origin": "API_DEFINITION", + "description": " Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com that can be migrated to Vertex AI's given location.", + "canonical": true, + "file": "migration_service.search_migratable_resources.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 81, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SearchMigratableResources", + "fullName": "google.cloud.aiplatform.v1.MigrationService.SearchMigratableResources", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.SearchMigratableResourcesResponse", + "client": { + "shortName": "MigrationServiceClient", + "fullName": "google.cloud.aiplatform.v1.MigrationServiceClient" + }, + "method": { + "shortName": "SearchMigratableResources", + "fullName": "google.cloud.aiplatform.v1.MigrationService.SearchMigratableResources", + "service": { + "shortName": "MigrationService", + "fullName": "google.cloud.aiplatform.v1.MigrationService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_MigrationService_BatchMigrateResources_async", + "title": "DatasetService batchMigrateResources Sample", + "origin": "API_DEFINITION", + "description": " Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI.", + "canonical": true, + "file": "migration_service.batch_migrate_resources.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchMigrateResources", + "fullName": "google.cloud.aiplatform.v1.MigrationService.BatchMigrateResources", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "migrate_resource_requests", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "MigrationServiceClient", + "fullName": "google.cloud.aiplatform.v1.MigrationServiceClient" + }, + "method": { + "shortName": "BatchMigrateResources", + "fullName": "google.cloud.aiplatform.v1.MigrationService.BatchMigrateResources", + "service": { + "shortName": "MigrationService", + "fullName": "google.cloud.aiplatform.v1.MigrationService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ModelService_UploadModel_async", + "title": "DatasetService uploadModel Sample", + "origin": "API_DEFINITION", + "description": " Uploads a Model artifact into Vertex AI.", + "canonical": true, + "file": "model_service.upload_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 82, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UploadModel", + "fullName": "google.cloud.aiplatform.v1.ModelService.UploadModel", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "parent_model", + "type": "TYPE_STRING" + }, + { + "name": "model_id", + "type": "TYPE_STRING" + }, + { + "name": "model", + "type": ".google.cloud.aiplatform.v1.Model" + }, + { + "name": "service_account", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1.ModelServiceClient" + }, + "method": { + "shortName": "UploadModel", + "fullName": "google.cloud.aiplatform.v1.ModelService.UploadModel", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ModelService_GetModel_async", + "title": "DatasetService getModel Sample", + "origin": "API_DEFINITION", + "description": " Gets a Model.", + "canonical": true, + "file": "model_service.get_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetModel", + "fullName": "google.cloud.aiplatform.v1.ModelService.GetModel", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Model", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1.ModelServiceClient" + }, + "method": { + "shortName": "GetModel", + "fullName": "google.cloud.aiplatform.v1.ModelService.GetModel", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ModelService_ListModels_async", + "title": "DatasetService listModels Sample", + "origin": "API_DEFINITION", + "description": " Lists Models in a Location.", + "canonical": true, + "file": "model_service.list_models.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 100, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListModels", + "fullName": "google.cloud.aiplatform.v1.ModelService.ListModels", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListModelsResponse", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1.ModelServiceClient" + }, + "method": { + "shortName": "ListModels", + "fullName": "google.cloud.aiplatform.v1.ModelService.ListModels", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ModelService_ListModelVersions_async", + "title": "DatasetService listModelVersions Sample", + "origin": "API_DEFINITION", + "description": " Lists versions of the specified model.", + "canonical": true, + "file": "model_service.list_model_versions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 90, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListModelVersions", + "fullName": "google.cloud.aiplatform.v1.ModelService.ListModelVersions", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListModelVersionsResponse", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1.ModelServiceClient" + }, + "method": { + "shortName": "ListModelVersions", + "fullName": "google.cloud.aiplatform.v1.ModelService.ListModelVersions", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ModelService_UpdateModel_async", + "title": "DatasetService updateModel Sample", + "origin": "API_DEFINITION", + "description": " Updates a Model.", + "canonical": true, + "file": "model_service.update_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 77, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateModel", + "fullName": "google.cloud.aiplatform.v1.ModelService.UpdateModel", + "async": true, + "parameters": [ + { + "name": "model", + "type": ".google.cloud.aiplatform.v1.Model" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Model", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1.ModelServiceClient" + }, + "method": { + "shortName": "UpdateModel", + "fullName": "google.cloud.aiplatform.v1.ModelService.UpdateModel", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ModelService_DeleteModel_async", + "title": "DatasetService deleteModel Sample", + "origin": "API_DEFINITION", + "description": " Deletes a Model. A model cannot be deleted if any [Endpoint][google.cloud.aiplatform.v1.Endpoint] resource has a [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] based on the model in its [deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models] field.", + "canonical": true, + "file": "model_service.delete_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteModel", + "fullName": "google.cloud.aiplatform.v1.ModelService.DeleteModel", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1.ModelServiceClient" + }, + "method": { + "shortName": "DeleteModel", + "fullName": "google.cloud.aiplatform.v1.ModelService.DeleteModel", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ModelService_DeleteModelVersion_async", + "title": "DatasetService deleteModelVersion Sample", + "origin": "API_DEFINITION", + "description": " Deletes a Model version. Model version can only be deleted if there are no [DeployedModels][] created from it. Deleting the only version in the Model is not allowed. Use [DeleteModel][google.cloud.aiplatform.v1.ModelService.DeleteModel] for deleting the Model instead.", + "canonical": true, + "file": "model_service.delete_model_version.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteModelVersion", + "fullName": "google.cloud.aiplatform.v1.ModelService.DeleteModelVersion", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1.ModelServiceClient" + }, + "method": { + "shortName": "DeleteModelVersion", + "fullName": "google.cloud.aiplatform.v1.ModelService.DeleteModelVersion", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ModelService_MergeVersionAliases_async", + "title": "DatasetService mergeVersionAliases Sample", + "origin": "API_DEFINITION", + "description": " Merges a set of aliases for a Model version.", + "canonical": true, + "file": "model_service.merge_version_aliases.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 70, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "MergeVersionAliases", + "fullName": "google.cloud.aiplatform.v1.ModelService.MergeVersionAliases", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "version_aliases", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Model", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1.ModelServiceClient" + }, + "method": { + "shortName": "MergeVersionAliases", + "fullName": "google.cloud.aiplatform.v1.ModelService.MergeVersionAliases", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ModelService_ExportModel_async", + "title": "DatasetService exportModel Sample", + "origin": "API_DEFINITION", + "description": " Exports a trained, exportable Model to a location specified by the user. A Model is considered to be exportable if it has at least one [supported export format][google.cloud.aiplatform.v1.Model.supported_export_formats].", + "canonical": true, + "file": "model_service.export_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ExportModel", + "fullName": "google.cloud.aiplatform.v1.ModelService.ExportModel", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "output_config", + "type": ".google.cloud.aiplatform.v1.ExportModelRequest.OutputConfig" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1.ModelServiceClient" + }, + "method": { + "shortName": "ExportModel", + "fullName": "google.cloud.aiplatform.v1.ModelService.ExportModel", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ModelService_ImportModelEvaluation_async", + "title": "DatasetService importModelEvaluation Sample", + "origin": "API_DEFINITION", + "description": " Imports an externally generated ModelEvaluation.", + "canonical": true, + "file": "model_service.import_model_evaluation.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ImportModelEvaluation", + "fullName": "google.cloud.aiplatform.v1.ModelService.ImportModelEvaluation", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "model_evaluation", + "type": ".google.cloud.aiplatform.v1.ModelEvaluation" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ModelEvaluation", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1.ModelServiceClient" + }, + "method": { + "shortName": "ImportModelEvaluation", + "fullName": "google.cloud.aiplatform.v1.ModelService.ImportModelEvaluation", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ModelService_BatchImportModelEvaluationSlices_async", + "title": "DatasetService batchImportModelEvaluationSlices Sample", + "origin": "API_DEFINITION", + "description": " Imports a list of externally generated ModelEvaluationSlice.", + "canonical": true, + "file": "model_service.batch_import_model_evaluation_slices.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchImportModelEvaluationSlices", + "fullName": "google.cloud.aiplatform.v1.ModelService.BatchImportModelEvaluationSlices", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "model_evaluation_slices", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1.BatchImportModelEvaluationSlicesResponse", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1.ModelServiceClient" + }, + "method": { + "shortName": "BatchImportModelEvaluationSlices", + "fullName": "google.cloud.aiplatform.v1.ModelService.BatchImportModelEvaluationSlices", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ModelService_GetModelEvaluation_async", + "title": "DatasetService getModelEvaluation Sample", + "origin": "API_DEFINITION", + "description": " Gets a ModelEvaluation.", + "canonical": true, + "file": "model_service.get_model_evaluation.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetModelEvaluation", + "fullName": "google.cloud.aiplatform.v1.ModelService.GetModelEvaluation", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ModelEvaluation", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1.ModelServiceClient" + }, + "method": { + "shortName": "GetModelEvaluation", + "fullName": "google.cloud.aiplatform.v1.ModelService.GetModelEvaluation", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ModelService_ListModelEvaluations_async", + "title": "DatasetService listModelEvaluations Sample", + "origin": "API_DEFINITION", + "description": " Lists ModelEvaluations in a Model.", + "canonical": true, + "file": "model_service.list_model_evaluations.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 77, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListModelEvaluations", + "fullName": "google.cloud.aiplatform.v1.ModelService.ListModelEvaluations", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListModelEvaluationsResponse", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1.ModelServiceClient" + }, + "method": { + "shortName": "ListModelEvaluations", + "fullName": "google.cloud.aiplatform.v1.ModelService.ListModelEvaluations", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ModelService_GetModelEvaluationSlice_async", + "title": "DatasetService getModelEvaluationSlice Sample", + "origin": "API_DEFINITION", + "description": " Gets a ModelEvaluationSlice.", + "canonical": true, + "file": "model_service.get_model_evaluation_slice.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetModelEvaluationSlice", + "fullName": "google.cloud.aiplatform.v1.ModelService.GetModelEvaluationSlice", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ModelEvaluationSlice", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1.ModelServiceClient" + }, + "method": { + "shortName": "GetModelEvaluationSlice", + "fullName": "google.cloud.aiplatform.v1.ModelService.GetModelEvaluationSlice", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_ModelService_ListModelEvaluationSlices_async", + "title": "DatasetService listModelEvaluationSlices Sample", + "origin": "API_DEFINITION", + "description": " Lists ModelEvaluationSlices in a ModelEvaluation.", + "canonical": true, + "file": "model_service.list_model_evaluation_slices.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListModelEvaluationSlices", + "fullName": "google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListModelEvaluationSlicesResponse", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1.ModelServiceClient" + }, + "method": { + "shortName": "ListModelEvaluationSlices", + "fullName": "google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_PipelineService_CreateTrainingPipeline_async", + "title": "DatasetService createTrainingPipeline Sample", + "origin": "API_DEFINITION", + "description": " Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.", + "canonical": true, + "file": "pipeline_service.create_training_pipeline.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateTrainingPipeline", + "fullName": "google.cloud.aiplatform.v1.PipelineService.CreateTrainingPipeline", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "training_pipeline", + "type": ".google.cloud.aiplatform.v1.TrainingPipeline" + } + ], + "resultType": ".google.cloud.aiplatform.v1.TrainingPipeline", + "client": { + "shortName": "PipelineServiceClient", + "fullName": "google.cloud.aiplatform.v1.PipelineServiceClient" + }, + "method": { + "shortName": "CreateTrainingPipeline", + "fullName": "google.cloud.aiplatform.v1.PipelineService.CreateTrainingPipeline", + "service": { + "shortName": "PipelineService", + "fullName": "google.cloud.aiplatform.v1.PipelineService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_PipelineService_GetTrainingPipeline_async", + "title": "DatasetService getTrainingPipeline Sample", + "origin": "API_DEFINITION", + "description": " Gets a TrainingPipeline.", + "canonical": true, + "file": "pipeline_service.get_training_pipeline.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetTrainingPipeline", + "fullName": "google.cloud.aiplatform.v1.PipelineService.GetTrainingPipeline", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.TrainingPipeline", + "client": { + "shortName": "PipelineServiceClient", + "fullName": "google.cloud.aiplatform.v1.PipelineServiceClient" + }, + "method": { + "shortName": "GetTrainingPipeline", + "fullName": "google.cloud.aiplatform.v1.PipelineService.GetTrainingPipeline", + "service": { + "shortName": "PipelineService", + "fullName": "google.cloud.aiplatform.v1.PipelineService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_PipelineService_ListTrainingPipelines_async", + "title": "DatasetService listTrainingPipelines Sample", + "origin": "API_DEFINITION", + "description": " Lists TrainingPipelines in a Location.", + "canonical": true, + "file": "pipeline_service.list_training_pipelines.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 92, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListTrainingPipelines", + "fullName": "google.cloud.aiplatform.v1.PipelineService.ListTrainingPipelines", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListTrainingPipelinesResponse", + "client": { + "shortName": "PipelineServiceClient", + "fullName": "google.cloud.aiplatform.v1.PipelineServiceClient" + }, + "method": { + "shortName": "ListTrainingPipelines", + "fullName": "google.cloud.aiplatform.v1.PipelineService.ListTrainingPipelines", + "service": { + "shortName": "PipelineService", + "fullName": "google.cloud.aiplatform.v1.PipelineService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_PipelineService_DeleteTrainingPipeline_async", + "title": "DatasetService deleteTrainingPipeline Sample", + "origin": "API_DEFINITION", + "description": " Deletes a TrainingPipeline.", + "canonical": true, + "file": "pipeline_service.delete_training_pipeline.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteTrainingPipeline", + "fullName": "google.cloud.aiplatform.v1.PipelineService.DeleteTrainingPipeline", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "PipelineServiceClient", + "fullName": "google.cloud.aiplatform.v1.PipelineServiceClient" + }, + "method": { + "shortName": "DeleteTrainingPipeline", + "fullName": "google.cloud.aiplatform.v1.PipelineService.DeleteTrainingPipeline", + "service": { + "shortName": "PipelineService", + "fullName": "google.cloud.aiplatform.v1.PipelineService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_PipelineService_CancelTrainingPipeline_async", + "title": "DatasetService cancelTrainingPipeline Sample", + "origin": "API_DEFINITION", + "description": " Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use [PipelineService.GetTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.GetTrainingPipeline] or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead it becomes a pipeline with a [TrainingPipeline.error][google.cloud.aiplatform.v1.TrainingPipeline.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [TrainingPipeline.state][google.cloud.aiplatform.v1.TrainingPipeline.state] is set to `CANCELLED`.", + "canonical": true, + "file": "pipeline_service.cancel_training_pipeline.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CancelTrainingPipeline", + "fullName": "google.cloud.aiplatform.v1.PipelineService.CancelTrainingPipeline", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "PipelineServiceClient", + "fullName": "google.cloud.aiplatform.v1.PipelineServiceClient" + }, + "method": { + "shortName": "CancelTrainingPipeline", + "fullName": "google.cloud.aiplatform.v1.PipelineService.CancelTrainingPipeline", + "service": { + "shortName": "PipelineService", + "fullName": "google.cloud.aiplatform.v1.PipelineService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_PipelineService_CreatePipelineJob_async", + "title": "DatasetService createPipelineJob Sample", + "origin": "API_DEFINITION", + "description": " Creates a PipelineJob. A PipelineJob will run immediately when created.", + "canonical": true, + "file": "pipeline_service.create_pipeline_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreatePipelineJob", + "fullName": "google.cloud.aiplatform.v1.PipelineService.CreatePipelineJob", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "pipeline_job", + "type": ".google.cloud.aiplatform.v1.PipelineJob" + }, + { + "name": "pipeline_job_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.PipelineJob", + "client": { + "shortName": "PipelineServiceClient", + "fullName": "google.cloud.aiplatform.v1.PipelineServiceClient" + }, + "method": { + "shortName": "CreatePipelineJob", + "fullName": "google.cloud.aiplatform.v1.PipelineService.CreatePipelineJob", + "service": { + "shortName": "PipelineService", + "fullName": "google.cloud.aiplatform.v1.PipelineService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_PipelineService_GetPipelineJob_async", + "title": "DatasetService getPipelineJob Sample", + "origin": "API_DEFINITION", + "description": " Gets a PipelineJob.", + "canonical": true, + "file": "pipeline_service.get_pipeline_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetPipelineJob", + "fullName": "google.cloud.aiplatform.v1.PipelineService.GetPipelineJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.PipelineJob", + "client": { + "shortName": "PipelineServiceClient", + "fullName": "google.cloud.aiplatform.v1.PipelineServiceClient" + }, + "method": { + "shortName": "GetPipelineJob", + "fullName": "google.cloud.aiplatform.v1.PipelineService.GetPipelineJob", + "service": { + "shortName": "PipelineService", + "fullName": "google.cloud.aiplatform.v1.PipelineService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_PipelineService_ListPipelineJobs_async", + "title": "DatasetService listPipelineJobs Sample", + "origin": "API_DEFINITION", + "description": " Lists PipelineJobs in a Location.", + "canonical": true, + "file": "pipeline_service.list_pipeline_jobs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 120, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListPipelineJobs", + "fullName": "google.cloud.aiplatform.v1.PipelineService.ListPipelineJobs", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListPipelineJobsResponse", + "client": { + "shortName": "PipelineServiceClient", + "fullName": "google.cloud.aiplatform.v1.PipelineServiceClient" + }, + "method": { + "shortName": "ListPipelineJobs", + "fullName": "google.cloud.aiplatform.v1.PipelineService.ListPipelineJobs", + "service": { + "shortName": "PipelineService", + "fullName": "google.cloud.aiplatform.v1.PipelineService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_PipelineService_DeletePipelineJob_async", + "title": "DatasetService deletePipelineJob Sample", + "origin": "API_DEFINITION", + "description": " Deletes a PipelineJob.", + "canonical": true, + "file": "pipeline_service.delete_pipeline_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeletePipelineJob", + "fullName": "google.cloud.aiplatform.v1.PipelineService.DeletePipelineJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "PipelineServiceClient", + "fullName": "google.cloud.aiplatform.v1.PipelineServiceClient" + }, + "method": { + "shortName": "DeletePipelineJob", + "fullName": "google.cloud.aiplatform.v1.PipelineService.DeletePipelineJob", + "service": { + "shortName": "PipelineService", + "fullName": "google.cloud.aiplatform.v1.PipelineService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_PipelineService_CancelPipelineJob_async", + "title": "DatasetService cancelPipelineJob Sample", + "origin": "API_DEFINITION", + "description": " Cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use [PipelineService.GetPipelineJob][google.cloud.aiplatform.v1.PipelineService.GetPipelineJob] or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the PipelineJob is not deleted; instead it becomes a pipeline with a [PipelineJob.error][google.cloud.aiplatform.v1.PipelineJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [PipelineJob.state][google.cloud.aiplatform.v1.PipelineJob.state] is set to `CANCELLED`.", + "canonical": true, + "file": "pipeline_service.cancel_pipeline_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CancelPipelineJob", + "fullName": "google.cloud.aiplatform.v1.PipelineService.CancelPipelineJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "PipelineServiceClient", + "fullName": "google.cloud.aiplatform.v1.PipelineServiceClient" + }, + "method": { + "shortName": "CancelPipelineJob", + "fullName": "google.cloud.aiplatform.v1.PipelineService.CancelPipelineJob", + "service": { + "shortName": "PipelineService", + "fullName": "google.cloud.aiplatform.v1.PipelineService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_PredictionService_Predict_async", + "title": "DatasetService predict Sample", + "origin": "API_DEFINITION", + "description": " Perform an online prediction.", + "canonical": true, + "file": "prediction_service.predict.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 76, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Predict", + "fullName": "google.cloud.aiplatform.v1.PredictionService.Predict", + "async": true, + "parameters": [ + { + "name": "endpoint", + "type": "TYPE_STRING" + }, + { + "name": "instances", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "parameters", + "type": ".google.protobuf.Value" + } + ], + "resultType": ".google.cloud.aiplatform.v1.PredictResponse", + "client": { + "shortName": "PredictionServiceClient", + "fullName": "google.cloud.aiplatform.v1.PredictionServiceClient" + }, + "method": { + "shortName": "Predict", + "fullName": "google.cloud.aiplatform.v1.PredictionService.Predict", + "service": { + "shortName": "PredictionService", + "fullName": "google.cloud.aiplatform.v1.PredictionService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_PredictionService_RawPredict_async", + "title": "DatasetService rawPredict Sample", + "origin": "API_DEFINITION", + "description": " Perform an online prediction with an arbitrary HTTP payload. The response includes the following HTTP headers: * `X-Vertex-AI-Endpoint-Id`: ID of the [Endpoint][google.cloud.aiplatform.v1.Endpoint] that served this prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] that served this prediction.", + "canonical": true, + "file": "prediction_service.raw_predict.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RawPredict", + "fullName": "google.cloud.aiplatform.v1.PredictionService.RawPredict", + "async": true, + "parameters": [ + { + "name": "endpoint", + "type": "TYPE_STRING" + }, + { + "name": "http_body", + "type": ".google.api.HttpBody" + } + ], + "resultType": ".google.api.HttpBody", + "client": { + "shortName": "PredictionServiceClient", + "fullName": "google.cloud.aiplatform.v1.PredictionServiceClient" + }, + "method": { + "shortName": "RawPredict", + "fullName": "google.cloud.aiplatform.v1.PredictionService.RawPredict", + "service": { + "shortName": "PredictionService", + "fullName": "google.cloud.aiplatform.v1.PredictionService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_PredictionService_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": 93, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Explain", + "fullName": "google.cloud.aiplatform.v1.PredictionService.Explain", + "async": true, + "parameters": [ + { + "name": "endpoint", + "type": "TYPE_STRING" + }, + { + "name": "instances", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "parameters", + "type": ".google.protobuf.Value" + }, + { + "name": "explanation_spec_override", + "type": ".google.cloud.aiplatform.v1.ExplanationSpecOverride" + }, + { + "name": "deployed_model_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ExplainResponse", + "client": { + "shortName": "PredictionServiceClient", + "fullName": "google.cloud.aiplatform.v1.PredictionServiceClient" + }, + "method": { + "shortName": "Explain", + "fullName": "google.cloud.aiplatform.v1.PredictionService.Explain", + "service": { + "shortName": "PredictionService", + "fullName": "google.cloud.aiplatform.v1.PredictionService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_SpecialistPoolService_CreateSpecialistPool_async", + "title": "DatasetService createSpecialistPool Sample", + "origin": "API_DEFINITION", + "description": " Creates a SpecialistPool.", + "canonical": true, + "file": "specialist_pool_service.create_specialist_pool.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateSpecialistPool", + "fullName": "google.cloud.aiplatform.v1.SpecialistPoolService.CreateSpecialistPool", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "specialist_pool", + "type": ".google.cloud.aiplatform.v1.SpecialistPool" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "SpecialistPoolServiceClient", + "fullName": "google.cloud.aiplatform.v1.SpecialistPoolServiceClient" + }, + "method": { + "shortName": "CreateSpecialistPool", + "fullName": "google.cloud.aiplatform.v1.SpecialistPoolService.CreateSpecialistPool", + "service": { + "shortName": "SpecialistPoolService", + "fullName": "google.cloud.aiplatform.v1.SpecialistPoolService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_SpecialistPoolService_GetSpecialistPool_async", + "title": "DatasetService getSpecialistPool Sample", + "origin": "API_DEFINITION", + "description": " Gets a SpecialistPool.", + "canonical": true, + "file": "specialist_pool_service.get_specialist_pool.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetSpecialistPool", + "fullName": "google.cloud.aiplatform.v1.SpecialistPoolService.GetSpecialistPool", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.SpecialistPool", + "client": { + "shortName": "SpecialistPoolServiceClient", + "fullName": "google.cloud.aiplatform.v1.SpecialistPoolServiceClient" + }, + "method": { + "shortName": "GetSpecialistPool", + "fullName": "google.cloud.aiplatform.v1.SpecialistPoolService.GetSpecialistPool", + "service": { + "shortName": "SpecialistPoolService", + "fullName": "google.cloud.aiplatform.v1.SpecialistPoolService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_SpecialistPoolService_ListSpecialistPools_async", + "title": "DatasetService listSpecialistPools Sample", + "origin": "API_DEFINITION", + "description": " Lists SpecialistPools in a Location.", + "canonical": true, + "file": "specialist_pool_service.list_specialist_pools.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 73, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListSpecialistPools", + "fullName": "google.cloud.aiplatform.v1.SpecialistPoolService.ListSpecialistPools", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListSpecialistPoolsResponse", + "client": { + "shortName": "SpecialistPoolServiceClient", + "fullName": "google.cloud.aiplatform.v1.SpecialistPoolServiceClient" + }, + "method": { + "shortName": "ListSpecialistPools", + "fullName": "google.cloud.aiplatform.v1.SpecialistPoolService.ListSpecialistPools", + "service": { + "shortName": "SpecialistPoolService", + "fullName": "google.cloud.aiplatform.v1.SpecialistPoolService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_SpecialistPoolService_DeleteSpecialistPool_async", + "title": "DatasetService deleteSpecialistPool Sample", + "origin": "API_DEFINITION", + "description": " Deletes a SpecialistPool as well as all Specialists in the pool.", + "canonical": true, + "file": "specialist_pool_service.delete_specialist_pool.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteSpecialistPool", + "fullName": "google.cloud.aiplatform.v1.SpecialistPoolService.DeleteSpecialistPool", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "SpecialistPoolServiceClient", + "fullName": "google.cloud.aiplatform.v1.SpecialistPoolServiceClient" + }, + "method": { + "shortName": "DeleteSpecialistPool", + "fullName": "google.cloud.aiplatform.v1.SpecialistPoolService.DeleteSpecialistPool", + "service": { + "shortName": "SpecialistPoolService", + "fullName": "google.cloud.aiplatform.v1.SpecialistPoolService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_SpecialistPoolService_UpdateSpecialistPool_async", + "title": "DatasetService updateSpecialistPool Sample", + "origin": "API_DEFINITION", + "description": " Updates a SpecialistPool.", + "canonical": true, + "file": "specialist_pool_service.update_specialist_pool.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateSpecialistPool", + "fullName": "google.cloud.aiplatform.v1.SpecialistPoolService.UpdateSpecialistPool", + "async": true, + "parameters": [ + { + "name": "specialist_pool", + "type": ".google.cloud.aiplatform.v1.SpecialistPool" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "SpecialistPoolServiceClient", + "fullName": "google.cloud.aiplatform.v1.SpecialistPoolServiceClient" + }, + "method": { + "shortName": "UpdateSpecialistPool", + "fullName": "google.cloud.aiplatform.v1.SpecialistPoolService.UpdateSpecialistPool", + "service": { + "shortName": "SpecialistPoolService", + "fullName": "google.cloud.aiplatform.v1.SpecialistPoolService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_CreateTensorboard_async", + "title": "DatasetService createTensorboard Sample", + "origin": "API_DEFINITION", + "description": " Creates a Tensorboard.", + "canonical": true, + "file": "tensorboard_service.create_tensorboard.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateTensorboard", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.CreateTensorboard", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "tensorboard", + "type": ".google.cloud.aiplatform.v1.Tensorboard" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "CreateTensorboard", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.CreateTensorboard", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_GetTensorboard_async", + "title": "DatasetService getTensorboard Sample", + "origin": "API_DEFINITION", + "description": " Gets a Tensorboard.", + "canonical": true, + "file": "tensorboard_service.get_tensorboard.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetTensorboard", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.GetTensorboard", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Tensorboard", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "GetTensorboard", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.GetTensorboard", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_ReadTensorboardUsage_async", + "title": "DatasetService readTensorboardUsage Sample", + "origin": "API_DEFINITION", + "description": " Returns a list of monthly active users for a given TensorBoard instance.", + "canonical": true, + "file": "tensorboard_service.read_tensorboard_usage.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ReadTensorboardUsage", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardUsage", + "async": true, + "parameters": [ + { + "name": "tensorboard", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ReadTensorboardUsageResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "ReadTensorboardUsage", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardUsage", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_UpdateTensorboard_async", + "title": "DatasetService updateTensorboard Sample", + "origin": "API_DEFINITION", + "description": " Updates a Tensorboard.", + "canonical": true, + "file": "tensorboard_service.update_tensorboard.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateTensorboard", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.UpdateTensorboard", + "async": true, + "parameters": [ + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "tensorboard", + "type": ".google.cloud.aiplatform.v1.Tensorboard" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "UpdateTensorboard", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.UpdateTensorboard", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_ListTensorboards_async", + "title": "DatasetService listTensorboards Sample", + "origin": "API_DEFINITION", + "description": " Lists Tensorboards in a Location.", + "canonical": true, + "file": "tensorboard_service.list_tensorboards.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 85, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListTensorboards", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.ListTensorboards", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListTensorboardsResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "ListTensorboards", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.ListTensorboards", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_DeleteTensorboard_async", + "title": "DatasetService deleteTensorboard Sample", + "origin": "API_DEFINITION", + "description": " Deletes a Tensorboard.", + "canonical": true, + "file": "tensorboard_service.delete_tensorboard.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteTensorboard", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.DeleteTensorboard", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "DeleteTensorboard", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.DeleteTensorboard", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_CreateTensorboardExperiment_async", + "title": "DatasetService createTensorboardExperiment Sample", + "origin": "API_DEFINITION", + "description": " Creates a TensorboardExperiment.", + "canonical": true, + "file": "tensorboard_service.create_tensorboard_experiment.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateTensorboardExperiment", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.CreateTensorboardExperiment", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "tensorboard_experiment", + "type": ".google.cloud.aiplatform.v1.TensorboardExperiment" + }, + { + "name": "tensorboard_experiment_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.TensorboardExperiment", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "CreateTensorboardExperiment", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.CreateTensorboardExperiment", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_GetTensorboardExperiment_async", + "title": "DatasetService getTensorboardExperiment Sample", + "origin": "API_DEFINITION", + "description": " Gets a TensorboardExperiment.", + "canonical": true, + "file": "tensorboard_service.get_tensorboard_experiment.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetTensorboardExperiment", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.GetTensorboardExperiment", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.TensorboardExperiment", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "GetTensorboardExperiment", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.GetTensorboardExperiment", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_UpdateTensorboardExperiment_async", + "title": "DatasetService updateTensorboardExperiment Sample", + "origin": "API_DEFINITION", + "description": " Updates a TensorboardExperiment.", + "canonical": true, + "file": "tensorboard_service.update_tensorboard_experiment.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateTensorboardExperiment", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.UpdateTensorboardExperiment", + "async": true, + "parameters": [ + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "tensorboard_experiment", + "type": ".google.cloud.aiplatform.v1.TensorboardExperiment" + } + ], + "resultType": ".google.cloud.aiplatform.v1.TensorboardExperiment", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "UpdateTensorboardExperiment", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.UpdateTensorboardExperiment", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_ListTensorboardExperiments_async", + "title": "DatasetService listTensorboardExperiments Sample", + "origin": "API_DEFINITION", + "description": " Lists TensorboardExperiments in a Location.", + "canonical": true, + "file": "tensorboard_service.list_tensorboard_experiments.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 85, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListTensorboardExperiments", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListTensorboardExperimentsResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "ListTensorboardExperiments", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_DeleteTensorboardExperiment_async", + "title": "DatasetService deleteTensorboardExperiment Sample", + "origin": "API_DEFINITION", + "description": " Deletes a TensorboardExperiment.", + "canonical": true, + "file": "tensorboard_service.delete_tensorboard_experiment.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteTensorboardExperiment", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.DeleteTensorboardExperiment", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "DeleteTensorboardExperiment", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.DeleteTensorboardExperiment", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_CreateTensorboardRun_async", + "title": "DatasetService createTensorboardRun Sample", + "origin": "API_DEFINITION", + "description": " Creates a TensorboardRun.", + "canonical": true, + "file": "tensorboard_service.create_tensorboard_run.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateTensorboardRun", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.CreateTensorboardRun", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "tensorboard_run", + "type": ".google.cloud.aiplatform.v1.TensorboardRun" + }, + { + "name": "tensorboard_run_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.TensorboardRun", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "CreateTensorboardRun", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.CreateTensorboardRun", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_BatchCreateTensorboardRuns_async", + "title": "DatasetService batchCreateTensorboardRuns Sample", + "origin": "API_DEFINITION", + "description": " Batch create TensorboardRuns.", + "canonical": true, + "file": "tensorboard_service.batch_create_tensorboard_runs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchCreateTensorboardRuns", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.BatchCreateTensorboardRuns", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "requests", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1.BatchCreateTensorboardRunsResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "BatchCreateTensorboardRuns", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.BatchCreateTensorboardRuns", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_GetTensorboardRun_async", + "title": "DatasetService getTensorboardRun Sample", + "origin": "API_DEFINITION", + "description": " Gets a TensorboardRun.", + "canonical": true, + "file": "tensorboard_service.get_tensorboard_run.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetTensorboardRun", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.GetTensorboardRun", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.TensorboardRun", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "GetTensorboardRun", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.GetTensorboardRun", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_UpdateTensorboardRun_async", + "title": "DatasetService updateTensorboardRun Sample", + "origin": "API_DEFINITION", + "description": " Updates a TensorboardRun.", + "canonical": true, + "file": "tensorboard_service.update_tensorboard_run.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateTensorboardRun", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.UpdateTensorboardRun", + "async": true, + "parameters": [ + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "tensorboard_run", + "type": ".google.cloud.aiplatform.v1.TensorboardRun" + } + ], + "resultType": ".google.cloud.aiplatform.v1.TensorboardRun", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "UpdateTensorboardRun", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.UpdateTensorboardRun", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_ListTensorboardRuns_async", + "title": "DatasetService listTensorboardRuns Sample", + "origin": "API_DEFINITION", + "description": " Lists TensorboardRuns in a Location.", + "canonical": true, + "file": "tensorboard_service.list_tensorboard_runs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 85, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListTensorboardRuns", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListTensorboardRunsResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "ListTensorboardRuns", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_DeleteTensorboardRun_async", + "title": "DatasetService deleteTensorboardRun Sample", + "origin": "API_DEFINITION", + "description": " Deletes a TensorboardRun.", + "canonical": true, + "file": "tensorboard_service.delete_tensorboard_run.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteTensorboardRun", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.DeleteTensorboardRun", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "DeleteTensorboardRun", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.DeleteTensorboardRun", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_BatchCreateTensorboardTimeSeries_async", + "title": "DatasetService batchCreateTensorboardTimeSeries Sample", + "origin": "API_DEFINITION", + "description": " Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.", + "canonical": true, + "file": "tensorboard_service.batch_create_tensorboard_time_series.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchCreateTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.BatchCreateTensorboardTimeSeries", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "requests", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1.BatchCreateTensorboardTimeSeriesResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "BatchCreateTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.BatchCreateTensorboardTimeSeries", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_CreateTensorboardTimeSeries_async", + "title": "DatasetService createTensorboardTimeSeries Sample", + "origin": "API_DEFINITION", + "description": " Creates a TensorboardTimeSeries.", + "canonical": true, + "file": "tensorboard_service.create_tensorboard_time_series.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.CreateTensorboardTimeSeries", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "tensorboard_time_series_id", + "type": "TYPE_STRING" + }, + { + "name": "tensorboard_time_series", + "type": ".google.cloud.aiplatform.v1.TensorboardTimeSeries" + } + ], + "resultType": ".google.cloud.aiplatform.v1.TensorboardTimeSeries", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "CreateTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.CreateTensorboardTimeSeries", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_GetTensorboardTimeSeries_async", + "title": "DatasetService getTensorboardTimeSeries Sample", + "origin": "API_DEFINITION", + "description": " Gets a TensorboardTimeSeries.", + "canonical": true, + "file": "tensorboard_service.get_tensorboard_time_series.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.GetTensorboardTimeSeries", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.TensorboardTimeSeries", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "GetTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.GetTensorboardTimeSeries", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_UpdateTensorboardTimeSeries_async", + "title": "DatasetService updateTensorboardTimeSeries Sample", + "origin": "API_DEFINITION", + "description": " Updates a TensorboardTimeSeries.", + "canonical": true, + "file": "tensorboard_service.update_tensorboard_time_series.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.UpdateTensorboardTimeSeries", + "async": true, + "parameters": [ + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "tensorboard_time_series", + "type": ".google.cloud.aiplatform.v1.TensorboardTimeSeries" + } + ], + "resultType": ".google.cloud.aiplatform.v1.TensorboardTimeSeries", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "UpdateTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.UpdateTensorboardTimeSeries", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_ListTensorboardTimeSeries_async", + "title": "DatasetService listTensorboardTimeSeries Sample", + "origin": "API_DEFINITION", + "description": " Lists TensorboardTimeSeries in a Location.", + "canonical": true, + "file": "tensorboard_service.list_tensorboard_time_series.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 85, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListTensorboardTimeSeriesResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "ListTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_DeleteTensorboardTimeSeries_async", + "title": "DatasetService deleteTensorboardTimeSeries Sample", + "origin": "API_DEFINITION", + "description": " Deletes a TensorboardTimeSeries.", + "canonical": true, + "file": "tensorboard_service.delete_tensorboard_time_series.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.DeleteTensorboardTimeSeries", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "DeleteTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.DeleteTensorboardTimeSeries", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_BatchReadTensorboardTimeSeriesData_async", + "title": "DatasetService batchReadTensorboardTimeSeriesData Sample", + "origin": "API_DEFINITION", + "description": " Reads multiple TensorboardTimeSeries' data. The data point number limit is 1000 for scalars, 100 for tensors and blob references. If the number of data points stored is less than the limit, all data is returned. Otherwise, the number limit of data points is randomly selected from this time series and returned.", + "canonical": true, + "file": "tensorboard_service.batch_read_tensorboard_time_series_data.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchReadTensorboardTimeSeriesData", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.BatchReadTensorboardTimeSeriesData", + "async": true, + "parameters": [ + { + "name": "tensorboard", + "type": "TYPE_STRING" + }, + { + "name": "time_series", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1.BatchReadTensorboardTimeSeriesDataResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "BatchReadTensorboardTimeSeriesData", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.BatchReadTensorboardTimeSeriesData", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_ReadTensorboardTimeSeriesData_async", + "title": "DatasetService readTensorboardTimeSeriesData Sample", + "origin": "API_DEFINITION", + "description": " Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k.", + "canonical": true, + "file": "tensorboard_service.read_tensorboard_time_series_data.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ReadTensorboardTimeSeriesData", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardTimeSeriesData", + "async": true, + "parameters": [ + { + "name": "tensorboard_time_series", + "type": "TYPE_STRING" + }, + { + "name": "max_data_points", + "type": "TYPE_INT32" + }, + { + "name": "filter", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ReadTensorboardTimeSeriesDataResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "ReadTensorboardTimeSeriesData", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardTimeSeriesData", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_ReadTensorboardBlobData_async", + "title": "DatasetService readTensorboardBlobData Sample", + "origin": "API_DEFINITION", + "description": " Gets bytes of TensorboardBlobs. This is to allow reading blob data stored in consumer project's Cloud Storage bucket without users having to obtain Cloud Storage access permission.", + "canonical": true, + "file": "tensorboard_service.read_tensorboard_blob_data.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ReadTensorboardBlobData", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardBlobData", + "async": true, + "parameters": [ + { + "name": "time_series", + "type": "TYPE_STRING" + }, + { + "name": "blob_ids", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ReadTensorboardBlobDataResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "ReadTensorboardBlobData", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.ReadTensorboardBlobData", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_WriteTensorboardExperimentData_async", + "title": "DatasetService writeTensorboardExperimentData Sample", + "origin": "API_DEFINITION", + "description": " Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's. If any data fail to be ingested, an error is returned.", + "canonical": true, + "file": "tensorboard_service.write_tensorboard_experiment_data.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "WriteTensorboardExperimentData", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.WriteTensorboardExperimentData", + "async": true, + "parameters": [ + { + "name": "tensorboard_experiment", + "type": "TYPE_STRING" + }, + { + "name": "write_run_data_requests", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1.WriteTensorboardExperimentDataResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "WriteTensorboardExperimentData", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.WriteTensorboardExperimentData", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_WriteTensorboardRunData_async", + "title": "DatasetService writeTensorboardRunData Sample", + "origin": "API_DEFINITION", + "description": " Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun. If any data fail to be ingested, an error is returned.", + "canonical": true, + "file": "tensorboard_service.write_tensorboard_run_data.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 64, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "WriteTensorboardRunData", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.WriteTensorboardRunData", + "async": true, + "parameters": [ + { + "name": "tensorboard_run", + "type": "TYPE_STRING" + }, + { + "name": "time_series_data", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1.WriteTensorboardRunDataResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "WriteTensorboardRunData", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.WriteTensorboardRunData", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_TensorboardService_ExportTensorboardTimeSeriesData_async", + "title": "DatasetService exportTensorboardTimeSeriesData Sample", + "origin": "API_DEFINITION", + "description": " Exports a TensorboardTimeSeries' data. Data is returned in paginated responses.", + "canonical": true, + "file": "tensorboard_service.export_tensorboard_time_series_data.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 82, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ExportTensorboardTimeSeriesData", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.ExportTensorboardTimeSeriesData", + "async": true, + "parameters": [ + { + "name": "tensorboard_time_series", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ExportTensorboardTimeSeriesDataResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1.TensorboardServiceClient" + }, + "method": { + "shortName": "ExportTensorboardTimeSeriesData", + "fullName": "google.cloud.aiplatform.v1.TensorboardService.ExportTensorboardTimeSeriesData", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_VizierService_CreateStudy_async", + "title": "DatasetService createStudy Sample", + "origin": "API_DEFINITION", + "description": " Creates a Study. A resource name will be generated after creation of the Study.", + "canonical": true, + "file": "vizier_service.create_study.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateStudy", + "fullName": "google.cloud.aiplatform.v1.VizierService.CreateStudy", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "study", + "type": ".google.cloud.aiplatform.v1.Study" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Study", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1.VizierServiceClient" + }, + "method": { + "shortName": "CreateStudy", + "fullName": "google.cloud.aiplatform.v1.VizierService.CreateStudy", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_VizierService_GetStudy_async", + "title": "DatasetService getStudy Sample", + "origin": "API_DEFINITION", + "description": " Gets a Study by name.", + "canonical": true, + "file": "vizier_service.get_study.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetStudy", + "fullName": "google.cloud.aiplatform.v1.VizierService.GetStudy", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Study", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1.VizierServiceClient" + }, + "method": { + "shortName": "GetStudy", + "fullName": "google.cloud.aiplatform.v1.VizierService.GetStudy", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_VizierService_ListStudies_async", + "title": "DatasetService listStudies Sample", + "origin": "API_DEFINITION", + "description": " Lists all the studies in a region for an associated project.", + "canonical": true, + "file": "vizier_service.list_studies.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListStudies", + "fullName": "google.cloud.aiplatform.v1.VizierService.ListStudies", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListStudiesResponse", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1.VizierServiceClient" + }, + "method": { + "shortName": "ListStudies", + "fullName": "google.cloud.aiplatform.v1.VizierService.ListStudies", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_VizierService_DeleteStudy_async", + "title": "DatasetService deleteStudy Sample", + "origin": "API_DEFINITION", + "description": " Deletes a Study.", + "canonical": true, + "file": "vizier_service.delete_study.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteStudy", + "fullName": "google.cloud.aiplatform.v1.VizierService.DeleteStudy", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1.VizierServiceClient" + }, + "method": { + "shortName": "DeleteStudy", + "fullName": "google.cloud.aiplatform.v1.VizierService.DeleteStudy", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_VizierService_LookupStudy_async", + "title": "DatasetService lookupStudy Sample", + "origin": "API_DEFINITION", + "description": " Looks a study up using the user-defined display_name field instead of the fully qualified resource name.", + "canonical": true, + "file": "vizier_service.lookup_study.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "LookupStudy", + "fullName": "google.cloud.aiplatform.v1.VizierService.LookupStudy", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "display_name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Study", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1.VizierServiceClient" + }, + "method": { + "shortName": "LookupStudy", + "fullName": "google.cloud.aiplatform.v1.VizierService.LookupStudy", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_VizierService_SuggestTrials_async", + "title": "DatasetService suggestTrials Sample", + "origin": "API_DEFINITION", + "description": " Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier. Returns a long-running operation associated with the generation of Trial suggestions. When this long-running operation succeeds, it will contain a [SuggestTrialsResponse][google.cloud.ml.v1.SuggestTrialsResponse].", + "canonical": true, + "file": "vizier_service.suggest_trials.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SuggestTrials", + "fullName": "google.cloud.aiplatform.v1.VizierService.SuggestTrials", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "suggestion_count", + "type": "TYPE_INT32" + }, + { + "name": "client_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1.VizierServiceClient" + }, + "method": { + "shortName": "SuggestTrials", + "fullName": "google.cloud.aiplatform.v1.VizierService.SuggestTrials", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_VizierService_CreateTrial_async", + "title": "DatasetService createTrial Sample", + "origin": "API_DEFINITION", + "description": " Adds a user provided Trial to a Study.", + "canonical": true, + "file": "vizier_service.create_trial.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateTrial", + "fullName": "google.cloud.aiplatform.v1.VizierService.CreateTrial", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "trial", + "type": ".google.cloud.aiplatform.v1.Trial" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Trial", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1.VizierServiceClient" + }, + "method": { + "shortName": "CreateTrial", + "fullName": "google.cloud.aiplatform.v1.VizierService.CreateTrial", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_VizierService_GetTrial_async", + "title": "DatasetService getTrial Sample", + "origin": "API_DEFINITION", + "description": " Gets a Trial.", + "canonical": true, + "file": "vizier_service.get_trial.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetTrial", + "fullName": "google.cloud.aiplatform.v1.VizierService.GetTrial", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Trial", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1.VizierServiceClient" + }, + "method": { + "shortName": "GetTrial", + "fullName": "google.cloud.aiplatform.v1.VizierService.GetTrial", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_VizierService_ListTrials_async", + "title": "DatasetService listTrials Sample", + "origin": "API_DEFINITION", + "description": " Lists the Trials associated with a Study.", + "canonical": true, + "file": "vizier_service.list_trials.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListTrials", + "fullName": "google.cloud.aiplatform.v1.VizierService.ListTrials", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListTrialsResponse", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1.VizierServiceClient" + }, + "method": { + "shortName": "ListTrials", + "fullName": "google.cloud.aiplatform.v1.VizierService.ListTrials", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_VizierService_AddTrialMeasurement_async", + "title": "DatasetService addTrialMeasurement Sample", + "origin": "API_DEFINITION", + "description": " Adds a measurement of the objective metrics to a Trial. This measurement is assumed to have been taken before the Trial is complete.", + "canonical": true, + "file": "vizier_service.add_trial_measurement.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AddTrialMeasurement", + "fullName": "google.cloud.aiplatform.v1.VizierService.AddTrialMeasurement", + "async": true, + "parameters": [ + { + "name": "trial_name", + "type": "TYPE_STRING" + }, + { + "name": "measurement", + "type": ".google.cloud.aiplatform.v1.Measurement" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Trial", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1.VizierServiceClient" + }, + "method": { + "shortName": "AddTrialMeasurement", + "fullName": "google.cloud.aiplatform.v1.VizierService.AddTrialMeasurement", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_VizierService_CompleteTrial_async", + "title": "DatasetService completeTrial Sample", + "origin": "API_DEFINITION", + "description": " Marks a Trial as complete.", + "canonical": true, + "file": "vizier_service.complete_trial.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CompleteTrial", + "fullName": "google.cloud.aiplatform.v1.VizierService.CompleteTrial", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "final_measurement", + "type": ".google.cloud.aiplatform.v1.Measurement" + }, + { + "name": "trial_infeasible", + "type": "TYPE_BOOL" + }, + { + "name": "infeasible_reason", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Trial", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1.VizierServiceClient" + }, + "method": { + "shortName": "CompleteTrial", + "fullName": "google.cloud.aiplatform.v1.VizierService.CompleteTrial", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_VizierService_DeleteTrial_async", + "title": "DatasetService deleteTrial Sample", + "origin": "API_DEFINITION", + "description": " Deletes a Trial.", + "canonical": true, + "file": "vizier_service.delete_trial.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteTrial", + "fullName": "google.cloud.aiplatform.v1.VizierService.DeleteTrial", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1.VizierServiceClient" + }, + "method": { + "shortName": "DeleteTrial", + "fullName": "google.cloud.aiplatform.v1.VizierService.DeleteTrial", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_VizierService_CheckTrialEarlyStoppingState_async", + "title": "DatasetService checkTrialEarlyStoppingState Sample", + "origin": "API_DEFINITION", + "description": " Checks whether a Trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a [CheckTrialEarlyStoppingStateResponse][google.cloud.ml.v1.CheckTrialEarlyStoppingStateResponse].", + "canonical": true, + "file": "vizier_service.check_trial_early_stopping_state.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CheckTrialEarlyStoppingState", + "fullName": "google.cloud.aiplatform.v1.VizierService.CheckTrialEarlyStoppingState", + "async": true, + "parameters": [ + { + "name": "trial_name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1.VizierServiceClient" + }, + "method": { + "shortName": "CheckTrialEarlyStoppingState", + "fullName": "google.cloud.aiplatform.v1.VizierService.CheckTrialEarlyStoppingState", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_VizierService_StopTrial_async", + "title": "DatasetService stopTrial Sample", + "origin": "API_DEFINITION", + "description": " Stops a Trial.", + "canonical": true, + "file": "vizier_service.stop_trial.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "StopTrial", + "fullName": "google.cloud.aiplatform.v1.VizierService.StopTrial", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.Trial", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1.VizierServiceClient" + }, + "method": { + "shortName": "StopTrial", + "fullName": "google.cloud.aiplatform.v1.VizierService.StopTrial", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1_generated_VizierService_ListOptimalTrials_async", + "title": "DatasetService listOptimalTrials Sample", + "origin": "API_DEFINITION", + "description": " Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency", + "canonical": true, + "file": "vizier_service.list_optimal_trials.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListOptimalTrials", + "fullName": "google.cloud.aiplatform.v1.VizierService.ListOptimalTrials", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1.ListOptimalTrialsResponse", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1.VizierServiceClient" + }, + "method": { + "shortName": "ListOptimalTrials", + "fullName": "google.cloud.aiplatform.v1.VizierService.ListOptimalTrials", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1.VizierService" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/specialist_pool_service.create_specialist_pool.js b/packages/google-cloud-aiplatform/samples/generated/v1/specialist_pool_service.create_specialist_pool.js new file mode 100644 index 00000000000..f63b4500943 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/specialist_pool_service.create_specialist_pool.js @@ -0,0 +1,68 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, specialistPool) { + // [START aiplatform_v1_generated_SpecialistPoolService_CreateSpecialistPool_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The parent Project name for the new SpecialistPool. + * The form is `projects/{project}/locations/{location}`. + */ + // const parent = 'abc123' + /** + * Required. The SpecialistPool to create. + */ + // const specialistPool = {} + + // Imports the Aiplatform library + const {SpecialistPoolServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new SpecialistPoolServiceClient(); + + async function callCreateSpecialistPool() { + // Construct request + const request = { + parent, + specialistPool, + }; + + // Run request + const [operation] = await aiplatformClient.createSpecialistPool(request); + const [response] = await operation.promise(); + console.log(response); + } + + callCreateSpecialistPool(); + // [END aiplatform_v1_generated_SpecialistPoolService_CreateSpecialistPool_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/specialist_pool_service.delete_specialist_pool.js b/packages/google-cloud-aiplatform/samples/generated/v1/specialist_pool_service.delete_specialist_pool.js new file mode 100644 index 00000000000..2fa734876cf --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/specialist_pool_service.delete_specialist_pool.js @@ -0,0 +1,69 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_SpecialistPoolService_DeleteSpecialistPool_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the SpecialistPool to delete. Format: + * `projects/{project}/locations/{location}/specialistPools/{specialist_pool}` + */ + // const name = 'abc123' + /** + * If set to true, any specialist managers in this SpecialistPool will also be + * deleted. (Otherwise, the request will only work if the SpecialistPool has + * no specialist managers.) + */ + // const force = true + + // Imports the Aiplatform library + const {SpecialistPoolServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new SpecialistPoolServiceClient(); + + async function callDeleteSpecialistPool() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteSpecialistPool(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteSpecialistPool(); + // [END aiplatform_v1_generated_SpecialistPoolService_DeleteSpecialistPool_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/specialist_pool_service.get_specialist_pool.js b/packages/google-cloud-aiplatform/samples/generated/v1/specialist_pool_service.get_specialist_pool.js new file mode 100644 index 00000000000..33afba03110 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/specialist_pool_service.get_specialist_pool.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_SpecialistPoolService_GetSpecialistPool_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the SpecialistPool resource. + * The form is + * `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`. + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {SpecialistPoolServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new SpecialistPoolServiceClient(); + + async function callGetSpecialistPool() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getSpecialistPool(request); + console.log(response); + } + + callGetSpecialistPool(); + // [END aiplatform_v1_generated_SpecialistPoolService_GetSpecialistPool_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/specialist_pool_service.list_specialist_pools.js b/packages/google-cloud-aiplatform/samples/generated/v1/specialist_pool_service.list_specialist_pools.js new file mode 100644 index 00000000000..a63d143c833 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/specialist_pool_service.list_specialist_pools.js @@ -0,0 +1,81 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1_generated_SpecialistPoolService_ListSpecialistPools_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the SpecialistPool's parent resource. + * Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * The standard list page size. + */ + // const pageSize = 1234 + /** + * The standard list page token. + * Typically obtained by + * ListSpecialistPoolsResponse.next_page_token google.cloud.aiplatform.v1.ListSpecialistPoolsResponse.next_page_token + * of the previous + * SpecialistPoolService.ListSpecialistPools google.cloud.aiplatform.v1.SpecialistPoolService.ListSpecialistPools + * call. Return first page if empty. + */ + // const pageToken = 'abc123' + /** + * Mask specifying which fields to read. FieldMask represents a set of + */ + // const readMask = {} + + // Imports the Aiplatform library + const {SpecialistPoolServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new SpecialistPoolServiceClient(); + + async function callListSpecialistPools() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listSpecialistPoolsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListSpecialistPools(); + // [END aiplatform_v1_generated_SpecialistPoolService_ListSpecialistPools_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/specialist_pool_service.update_specialist_pool.js b/packages/google-cloud-aiplatform/samples/generated/v1/specialist_pool_service.update_specialist_pool.js new file mode 100644 index 00000000000..00edfdf7fa6 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/specialist_pool_service.update_specialist_pool.js @@ -0,0 +1,67 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(specialistPool, updateMask) { + // [START aiplatform_v1_generated_SpecialistPoolService_UpdateSpecialistPool_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The SpecialistPool which replaces the resource on the server. + */ + // const specialistPool = {} + /** + * Required. The update mask applies to the resource. + */ + // const updateMask = {} + + // Imports the Aiplatform library + const {SpecialistPoolServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new SpecialistPoolServiceClient(); + + async function callUpdateSpecialistPool() { + // Construct request + const request = { + specialistPool, + updateMask, + }; + + // Run request + const [operation] = await aiplatformClient.updateSpecialistPool(request); + const [response] = await operation.promise(); + console.log(response); + } + + callUpdateSpecialistPool(); + // [END aiplatform_v1_generated_SpecialistPoolService_UpdateSpecialistPool_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.batch_create_tensorboard_runs.js b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.batch_create_tensorboard_runs.js new file mode 100644 index 00000000000..8c44669ef54 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.batch_create_tensorboard_runs.js @@ -0,0 +1,71 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, requests) { + // [START aiplatform_v1_generated_TensorboardService_BatchCreateTensorboardRuns_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the TensorboardExperiment to create the + * TensorboardRuns in. Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` + * The parent field in the CreateTensorboardRunRequest messages must match + * this field. + */ + // const parent = 'abc123' + /** + * Required. The request message specifying the TensorboardRuns to create. + * A maximum of 1000 TensorboardRuns can be created in a batch. + */ + // const requests = 1234 + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callBatchCreateTensorboardRuns() { + // Construct request + const request = { + parent, + requests, + }; + + // Run request + const response = await aiplatformClient.batchCreateTensorboardRuns(request); + console.log(response); + } + + callBatchCreateTensorboardRuns(); + // [END aiplatform_v1_generated_TensorboardService_BatchCreateTensorboardRuns_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.batch_create_tensorboard_time_series.js b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.batch_create_tensorboard_time_series.js new file mode 100644 index 00000000000..b92437e832b --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.batch_create_tensorboard_time_series.js @@ -0,0 +1,73 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, requests) { + // [START aiplatform_v1_generated_TensorboardService_BatchCreateTensorboardTimeSeries_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the TensorboardExperiment to create the + * TensorboardTimeSeries in. + * Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` + * The TensorboardRuns referenced by the parent fields in the + * CreateTensorboardTimeSeriesRequest messages must be sub resources of this + * TensorboardExperiment. + */ + // const parent = 'abc123' + /** + * Required. The request message specifying the TensorboardTimeSeries to + * create. A maximum of 1000 TensorboardTimeSeries can be created in a batch. + */ + // const requests = 1234 + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callBatchCreateTensorboardTimeSeries() { + // Construct request + const request = { + parent, + requests, + }; + + // Run request + const response = await aiplatformClient.batchCreateTensorboardTimeSeries(request); + console.log(response); + } + + callBatchCreateTensorboardTimeSeries(); + // [END aiplatform_v1_generated_TensorboardService_BatchCreateTensorboardTimeSeries_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.batch_read_tensorboard_time_series_data.js b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.batch_read_tensorboard_time_series_data.js new file mode 100644 index 00000000000..75415d97322 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.batch_read_tensorboard_time_series_data.js @@ -0,0 +1,73 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(tensorboard, timeSeries) { + // [START aiplatform_v1_generated_TensorboardService_BatchReadTensorboardTimeSeriesData_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Tensorboard containing + * TensorboardTimeSeries to read data from. Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}`. + * The TensorboardTimeSeries referenced by + * time_series google.cloud.aiplatform.v1.BatchReadTensorboardTimeSeriesDataRequest.time_series + * must be sub resources of this Tensorboard. + */ + // const tensorboard = 'abc123' + /** + * Required. The resource names of the TensorboardTimeSeries to read data + * from. Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}` + */ + // const timeSeries = 'abc123' + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callBatchReadTensorboardTimeSeriesData() { + // Construct request + const request = { + tensorboard, + timeSeries, + }; + + // Run request + const response = await aiplatformClient.batchReadTensorboardTimeSeriesData(request); + console.log(response); + } + + callBatchReadTensorboardTimeSeriesData(); + // [END aiplatform_v1_generated_TensorboardService_BatchReadTensorboardTimeSeriesData_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.create_tensorboard.js b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.create_tensorboard.js new file mode 100644 index 00000000000..32091ed5cea --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.create_tensorboard.js @@ -0,0 +1,68 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, tensorboard) { + // [START aiplatform_v1_generated_TensorboardService_CreateTensorboard_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to create the Tensorboard in. + * Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Required. The Tensorboard to create. + */ + // const tensorboard = {} + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callCreateTensorboard() { + // Construct request + const request = { + parent, + tensorboard, + }; + + // Run request + const [operation] = await aiplatformClient.createTensorboard(request); + const [response] = await operation.promise(); + console.log(response); + } + + callCreateTensorboard(); + // [END aiplatform_v1_generated_TensorboardService_CreateTensorboard_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.create_tensorboard_experiment.js b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.create_tensorboard_experiment.js new file mode 100644 index 00000000000..63f0cab15f3 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.create_tensorboard_experiment.js @@ -0,0 +1,75 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, tensorboardExperimentId) { + // [START aiplatform_v1_generated_TensorboardService_CreateTensorboardExperiment_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Tensorboard to create the + * TensorboardExperiment in. Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}` + */ + // const parent = 'abc123' + /** + * The TensorboardExperiment to create. + */ + // const tensorboardExperiment = {} + /** + * Required. The ID to use for the Tensorboard experiment, which becomes the + * final component of the Tensorboard experiment's resource name. + * This value should be 1-128 characters, and valid characters + * are /[a-z][0-9]-/. + */ + // const tensorboardExperimentId = 'abc123' + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callCreateTensorboardExperiment() { + // Construct request + const request = { + parent, + tensorboardExperimentId, + }; + + // Run request + const response = await aiplatformClient.createTensorboardExperiment(request); + console.log(response); + } + + callCreateTensorboardExperiment(); + // [END aiplatform_v1_generated_TensorboardService_CreateTensorboardExperiment_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.create_tensorboard_run.js b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.create_tensorboard_run.js new file mode 100644 index 00000000000..365f0fe084b --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.create_tensorboard_run.js @@ -0,0 +1,76 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, tensorboardRun, tensorboardRunId) { + // [START aiplatform_v1_generated_TensorboardService_CreateTensorboardRun_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the TensorboardExperiment to create the + * TensorboardRun in. Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` + */ + // const parent = 'abc123' + /** + * Required. The TensorboardRun to create. + */ + // const tensorboardRun = {} + /** + * Required. The ID to use for the Tensorboard run, which becomes the final + * component of the Tensorboard run's resource name. + * This value should be 1-128 characters, and valid characters + * are /[a-z][0-9]-/. + */ + // const tensorboardRunId = 'abc123' + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callCreateTensorboardRun() { + // Construct request + const request = { + parent, + tensorboardRun, + tensorboardRunId, + }; + + // Run request + const response = await aiplatformClient.createTensorboardRun(request); + console.log(response); + } + + callCreateTensorboardRun(); + // [END aiplatform_v1_generated_TensorboardService_CreateTensorboardRun_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.create_tensorboard_time_series.js b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.create_tensorboard_time_series.js new file mode 100644 index 00000000000..f5fc764f141 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.create_tensorboard_time_series.js @@ -0,0 +1,76 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, tensorboardTimeSeries) { + // [START aiplatform_v1_generated_TensorboardService_CreateTensorboardTimeSeries_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the TensorboardRun to create the + * TensorboardTimeSeries in. + * Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` + */ + // const parent = 'abc123' + /** + * Optional. The user specified unique ID to use for the + * TensorboardTimeSeries, which becomes the final component of the + * TensorboardTimeSeries's resource name. This value should match + * "[a-z0-9][a-z0-9-]{0, 127}" + */ + // const tensorboardTimeSeriesId = 'abc123' + /** + * Required. The TensorboardTimeSeries to create. + */ + // const tensorboardTimeSeries = {} + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callCreateTensorboardTimeSeries() { + // Construct request + const request = { + parent, + tensorboardTimeSeries, + }; + + // Run request + const response = await aiplatformClient.createTensorboardTimeSeries(request); + console.log(response); + } + + callCreateTensorboardTimeSeries(); + // [END aiplatform_v1_generated_TensorboardService_CreateTensorboardTimeSeries_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.delete_tensorboard.js b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.delete_tensorboard.js new file mode 100644 index 00000000000..49f4d94e99f --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.delete_tensorboard.js @@ -0,0 +1,64 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_TensorboardService_DeleteTensorboard_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Tensorboard to be deleted. + * Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callDeleteTensorboard() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteTensorboard(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteTensorboard(); + // [END aiplatform_v1_generated_TensorboardService_DeleteTensorboard_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.delete_tensorboard_experiment.js b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.delete_tensorboard_experiment.js new file mode 100644 index 00000000000..4c47a0c1c50 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.delete_tensorboard_experiment.js @@ -0,0 +1,64 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_TensorboardService_DeleteTensorboardExperiment_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the TensorboardExperiment to be deleted. + * Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callDeleteTensorboardExperiment() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteTensorboardExperiment(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteTensorboardExperiment(); + // [END aiplatform_v1_generated_TensorboardService_DeleteTensorboardExperiment_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.delete_tensorboard_run.js b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.delete_tensorboard_run.js new file mode 100644 index 00000000000..4ca23e2a7b6 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.delete_tensorboard_run.js @@ -0,0 +1,64 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_TensorboardService_DeleteTensorboardRun_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the TensorboardRun to be deleted. + * Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callDeleteTensorboardRun() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteTensorboardRun(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteTensorboardRun(); + // [END aiplatform_v1_generated_TensorboardService_DeleteTensorboardRun_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.delete_tensorboard_time_series.js b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.delete_tensorboard_time_series.js new file mode 100644 index 00000000000..7dd37f48cea --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.delete_tensorboard_time_series.js @@ -0,0 +1,64 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_TensorboardService_DeleteTensorboardTimeSeries_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the TensorboardTimeSeries to be deleted. + * Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callDeleteTensorboardTimeSeries() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteTensorboardTimeSeries(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteTensorboardTimeSeries(); + // [END aiplatform_v1_generated_TensorboardService_DeleteTensorboardTimeSeries_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.export_tensorboard_time_series_data.js b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.export_tensorboard_time_series_data.js new file mode 100644 index 00000000000..aecf725f5b4 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.export_tensorboard_time_series_data.js @@ -0,0 +1,90 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(tensorboardTimeSeries) { + // [START aiplatform_v1_generated_TensorboardService_ExportTensorboardTimeSeriesData_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the TensorboardTimeSeries to export data + * from. Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}` + */ + // const tensorboardTimeSeries = 'abc123' + /** + * Exports the TensorboardTimeSeries' data that match the filter expression. + */ + // const filter = 'abc123' + /** + * The maximum number of data points to return per page. + * The default page_size is 1000. Values must be between 1 and 10000. + * Values above 10000 are coerced to 10000. + */ + // const pageSize = 1234 + /** + * A page token, received from a previous + * TensorboardService.ExportTensorboardTimeSeries call. + * Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to + * TensorboardService.ExportTensorboardTimeSeries must + * match the call that provided the page token. + */ + // const pageToken = 'abc123' + /** + * Field to use to sort the TensorboardTimeSeries' data. + * By default, TensorboardTimeSeries' data is returned in a pseudo random + * order. + */ + // const orderBy = 'abc123' + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callExportTensorboardTimeSeriesData() { + // Construct request + const request = { + tensorboardTimeSeries, + }; + + // Run request + const iterable = await aiplatformClient.exportTensorboardTimeSeriesDataAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callExportTensorboardTimeSeriesData(); + // [END aiplatform_v1_generated_TensorboardService_ExportTensorboardTimeSeriesData_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.get_tensorboard.js b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.get_tensorboard.js new file mode 100644 index 00000000000..3bdd167692f --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.get_tensorboard.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_TensorboardService_GetTensorboard_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Tensorboard resource. + * Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callGetTensorboard() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getTensorboard(request); + console.log(response); + } + + callGetTensorboard(); + // [END aiplatform_v1_generated_TensorboardService_GetTensorboard_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.get_tensorboard_experiment.js b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.get_tensorboard_experiment.js new file mode 100644 index 00000000000..d9fa5b860ee --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.get_tensorboard_experiment.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_TensorboardService_GetTensorboardExperiment_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the TensorboardExperiment resource. + * Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callGetTensorboardExperiment() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getTensorboardExperiment(request); + console.log(response); + } + + callGetTensorboardExperiment(); + // [END aiplatform_v1_generated_TensorboardService_GetTensorboardExperiment_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.get_tensorboard_run.js b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.get_tensorboard_run.js new file mode 100644 index 00000000000..83c7224c549 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.get_tensorboard_run.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_TensorboardService_GetTensorboardRun_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the TensorboardRun resource. + * Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callGetTensorboardRun() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getTensorboardRun(request); + console.log(response); + } + + callGetTensorboardRun(); + // [END aiplatform_v1_generated_TensorboardService_GetTensorboardRun_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.get_tensorboard_time_series.js b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.get_tensorboard_time_series.js new file mode 100644 index 00000000000..c218086e6b3 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.get_tensorboard_time_series.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_TensorboardService_GetTensorboardTimeSeries_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the TensorboardTimeSeries resource. + * Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callGetTensorboardTimeSeries() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getTensorboardTimeSeries(request); + console.log(response); + } + + callGetTensorboardTimeSeries(); + // [END aiplatform_v1_generated_TensorboardService_GetTensorboardTimeSeries_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.list_tensorboard_experiments.js b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.list_tensorboard_experiments.js new file mode 100644 index 00000000000..05f82b1d94b --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.list_tensorboard_experiments.js @@ -0,0 +1,93 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1_generated_TensorboardService_ListTensorboardExperiments_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Tensorboard to list + * TensorboardExperiments. Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}` + */ + // const parent = 'abc123' + /** + * Lists the TensorboardExperiments that match the filter expression. + */ + // const filter = 'abc123' + /** + * The maximum number of TensorboardExperiments to return. The service may + * return fewer than this value. If unspecified, at most 50 + * TensorboardExperiments are returned. The maximum value is 1000; values + * above 1000 are coerced to 1000. + */ + // const pageSize = 1234 + /** + * A page token, received from a previous + * TensorboardService.ListTensorboardExperiments google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments + * call. Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to + * TensorboardService.ListTensorboardExperiments google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments + * must match the call that provided the page token. + */ + // const pageToken = 'abc123' + /** + * Field to use to sort the list. + */ + // const orderBy = 'abc123' + /** + * Mask specifying which fields to read. + */ + // const readMask = {} + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callListTensorboardExperiments() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listTensorboardExperimentsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListTensorboardExperiments(); + // [END aiplatform_v1_generated_TensorboardService_ListTensorboardExperiments_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.list_tensorboard_runs.js b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.list_tensorboard_runs.js new file mode 100644 index 00000000000..edc603dd8bf --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.list_tensorboard_runs.js @@ -0,0 +1,93 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1_generated_TensorboardService_ListTensorboardRuns_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the TensorboardExperiment to list + * TensorboardRuns. Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` + */ + // const parent = 'abc123' + /** + * Lists the TensorboardRuns that match the filter expression. + */ + // const filter = 'abc123' + /** + * The maximum number of TensorboardRuns to return. The service may return + * fewer than this value. If unspecified, at most 50 TensorboardRuns are + * returned. The maximum value is 1000; values above 1000 are coerced to + * 1000. + */ + // const pageSize = 1234 + /** + * A page token, received from a previous + * TensorboardService.ListTensorboardRuns google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns + * call. Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to + * TensorboardService.ListTensorboardRuns google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns + * must match the call that provided the page token. + */ + // const pageToken = 'abc123' + /** + * Field to use to sort the list. + */ + // const orderBy = 'abc123' + /** + * Mask specifying which fields to read. + */ + // const readMask = {} + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callListTensorboardRuns() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listTensorboardRunsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListTensorboardRuns(); + // [END aiplatform_v1_generated_TensorboardService_ListTensorboardRuns_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.list_tensorboard_time_series.js b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.list_tensorboard_time_series.js new file mode 100644 index 00000000000..98e788079b8 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.list_tensorboard_time_series.js @@ -0,0 +1,93 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1_generated_TensorboardService_ListTensorboardTimeSeries_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the TensorboardRun to list + * TensorboardTimeSeries. Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` + */ + // const parent = 'abc123' + /** + * Lists the TensorboardTimeSeries that match the filter expression. + */ + // const filter = 'abc123' + /** + * The maximum number of TensorboardTimeSeries to return. The service may + * return fewer than this value. If unspecified, at most 50 + * TensorboardTimeSeries are returned. The maximum value is 1000; values + * above 1000 are coerced to 1000. + */ + // const pageSize = 1234 + /** + * A page token, received from a previous + * TensorboardService.ListTensorboardTimeSeries google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries + * call. Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to + * TensorboardService.ListTensorboardTimeSeries google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries + * must match the call that provided the page token. + */ + // const pageToken = 'abc123' + /** + * Field to use to sort the list. + */ + // const orderBy = 'abc123' + /** + * Mask specifying which fields to read. + */ + // const readMask = {} + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callListTensorboardTimeSeries() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listTensorboardTimeSeriesAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListTensorboardTimeSeries(); + // [END aiplatform_v1_generated_TensorboardService_ListTensorboardTimeSeries_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.list_tensorboards.js b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.list_tensorboards.js new file mode 100644 index 00000000000..44253df65fc --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.list_tensorboards.js @@ -0,0 +1,93 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1_generated_TensorboardService_ListTensorboards_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to list Tensorboards. + * Format: + * `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Lists the Tensorboards that match the filter expression. + */ + // const filter = 'abc123' + /** + * The maximum number of Tensorboards to return. The service may return + * fewer than this value. If unspecified, at most 100 Tensorboards are + * returned. The maximum value is 100; values above 100 are coerced to + * 100. + */ + // const pageSize = 1234 + /** + * A page token, received from a previous + * TensorboardService.ListTensorboards google.cloud.aiplatform.v1.TensorboardService.ListTensorboards + * call. Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to + * TensorboardService.ListTensorboards google.cloud.aiplatform.v1.TensorboardService.ListTensorboards + * must match the call that provided the page token. + */ + // const pageToken = 'abc123' + /** + * Field to use to sort the list. + */ + // const orderBy = 'abc123' + /** + * Mask specifying which fields to read. + */ + // const readMask = {} + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callListTensorboards() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listTensorboardsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListTensorboards(); + // [END aiplatform_v1_generated_TensorboardService_ListTensorboards_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.read_tensorboard_blob_data.js b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.read_tensorboard_blob_data.js new file mode 100644 index 00000000000..d58f753d47b --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.read_tensorboard_blob_data.js @@ -0,0 +1,69 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(timeSeries) { + // [START aiplatform_v1_generated_TensorboardService_ReadTensorboardBlobData_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the TensorboardTimeSeries to list Blobs. + * Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}` + */ + // const timeSeries = 'abc123' + /** + * IDs of the blobs to read. + */ + // const blobIds = 'abc123' + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callReadTensorboardBlobData() { + // Construct request + const request = { + timeSeries, + }; + + // Run request + const stream = await aiplatformClient.readTensorboardBlobData(request); + stream.on('data', (response) => { console.log(response) }); + stream.on('error', (err) => { throw(err) }); + stream.on('end', () => { /* API call completed */ }); + } + + callReadTensorboardBlobData(); + // [END aiplatform_v1_generated_TensorboardService_ReadTensorboardBlobData_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.read_tensorboard_time_series_data.js b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.read_tensorboard_time_series_data.js new file mode 100644 index 00000000000..ba20e915776 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.read_tensorboard_time_series_data.js @@ -0,0 +1,73 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(tensorboardTimeSeries) { + // [START aiplatform_v1_generated_TensorboardService_ReadTensorboardTimeSeriesData_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the TensorboardTimeSeries to read data from. + * Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}` + */ + // const tensorboardTimeSeries = 'abc123' + /** + * The maximum number of TensorboardTimeSeries' data to return. + * This value should be a positive integer. + * This value can be set to -1 to return all data. + */ + // const maxDataPoints = 1234 + /** + * Reads the TensorboardTimeSeries' data that match the filter expression. + */ + // const filter = 'abc123' + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callReadTensorboardTimeSeriesData() { + // Construct request + const request = { + tensorboardTimeSeries, + }; + + // Run request + const response = await aiplatformClient.readTensorboardTimeSeriesData(request); + console.log(response); + } + + callReadTensorboardTimeSeriesData(); + // [END aiplatform_v1_generated_TensorboardService_ReadTensorboardTimeSeriesData_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.read_tensorboard_usage.js b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.read_tensorboard_usage.js new file mode 100644 index 00000000000..1d014178fe6 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.read_tensorboard_usage.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(tensorboard) { + // [START aiplatform_v1_generated_TensorboardService_ReadTensorboardUsage_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Tensorboard resource. + * Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}` + */ + // const tensorboard = 'abc123' + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callReadTensorboardUsage() { + // Construct request + const request = { + tensorboard, + }; + + // Run request + const response = await aiplatformClient.readTensorboardUsage(request); + console.log(response); + } + + callReadTensorboardUsage(); + // [END aiplatform_v1_generated_TensorboardService_ReadTensorboardUsage_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.update_tensorboard.js b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.update_tensorboard.js new file mode 100644 index 00000000000..9cf43c58203 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.update_tensorboard.js @@ -0,0 +1,74 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(updateMask, tensorboard) { + // [START aiplatform_v1_generated_TensorboardService_UpdateTensorboard_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. Field mask is used to specify the fields to be overwritten in the + * Tensorboard resource by the update. + * The fields specified in the update_mask are relative to the resource, not + * the full request. A field is overwritten if it's in the mask. If the + * user does not provide a mask then all fields are overwritten if new + * values are specified. + */ + // const updateMask = {} + /** + * Required. The Tensorboard's `name` field is used to identify the + * Tensorboard to be updated. Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}` + */ + // const tensorboard = {} + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callUpdateTensorboard() { + // Construct request + const request = { + updateMask, + tensorboard, + }; + + // Run request + const [operation] = await aiplatformClient.updateTensorboard(request); + const [response] = await operation.promise(); + console.log(response); + } + + callUpdateTensorboard(); + // [END aiplatform_v1_generated_TensorboardService_UpdateTensorboard_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.update_tensorboard_experiment.js b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.update_tensorboard_experiment.js new file mode 100644 index 00000000000..08b45fdcef9 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.update_tensorboard_experiment.js @@ -0,0 +1,73 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(updateMask, tensorboardExperiment) { + // [START aiplatform_v1_generated_TensorboardService_UpdateTensorboardExperiment_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. Field mask is used to specify the fields to be overwritten in the + * TensorboardExperiment resource by the update. + * The fields specified in the update_mask are relative to the resource, not + * the full request. A field is overwritten if it's in the mask. If the + * user does not provide a mask then all fields are overwritten if new + * values are specified. + */ + // const updateMask = {} + /** + * Required. The TensorboardExperiment's `name` field is used to identify the + * TensorboardExperiment to be updated. Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` + */ + // const tensorboardExperiment = {} + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callUpdateTensorboardExperiment() { + // Construct request + const request = { + updateMask, + tensorboardExperiment, + }; + + // Run request + const response = await aiplatformClient.updateTensorboardExperiment(request); + console.log(response); + } + + callUpdateTensorboardExperiment(); + // [END aiplatform_v1_generated_TensorboardService_UpdateTensorboardExperiment_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.update_tensorboard_run.js b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.update_tensorboard_run.js new file mode 100644 index 00000000000..e68a5729d5b --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.update_tensorboard_run.js @@ -0,0 +1,73 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(updateMask, tensorboardRun) { + // [START aiplatform_v1_generated_TensorboardService_UpdateTensorboardRun_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. Field mask is used to specify the fields to be overwritten in the + * TensorboardRun resource by the update. + * The fields specified in the update_mask are relative to the resource, not + * the full request. A field is overwritten if it's in the mask. If the + * user does not provide a mask then all fields are overwritten if new + * values are specified. + */ + // const updateMask = {} + /** + * Required. The TensorboardRun's `name` field is used to identify the + * TensorboardRun to be updated. Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` + */ + // const tensorboardRun = {} + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callUpdateTensorboardRun() { + // Construct request + const request = { + updateMask, + tensorboardRun, + }; + + // Run request + const response = await aiplatformClient.updateTensorboardRun(request); + console.log(response); + } + + callUpdateTensorboardRun(); + // [END aiplatform_v1_generated_TensorboardService_UpdateTensorboardRun_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.update_tensorboard_time_series.js b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.update_tensorboard_time_series.js new file mode 100644 index 00000000000..94ca376bd86 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.update_tensorboard_time_series.js @@ -0,0 +1,74 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(updateMask, tensorboardTimeSeries) { + // [START aiplatform_v1_generated_TensorboardService_UpdateTensorboardTimeSeries_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. Field mask is used to specify the fields to be overwritten in the + * TensorboardTimeSeries resource by the update. + * The fields specified in the update_mask are relative to the resource, not + * the full request. A field is overwritten if it's in the mask. If the + * user does not provide a mask then all fields are overwritten if new + * values are specified. + */ + // const updateMask = {} + /** + * Required. The TensorboardTimeSeries' `name` field is used to identify the + * TensorboardTimeSeries to be updated. + * Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}` + */ + // const tensorboardTimeSeries = {} + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callUpdateTensorboardTimeSeries() { + // Construct request + const request = { + updateMask, + tensorboardTimeSeries, + }; + + // Run request + const response = await aiplatformClient.updateTensorboardTimeSeries(request); + console.log(response); + } + + callUpdateTensorboardTimeSeries(); + // [END aiplatform_v1_generated_TensorboardService_UpdateTensorboardTimeSeries_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.write_tensorboard_experiment_data.js b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.write_tensorboard_experiment_data.js new file mode 100644 index 00000000000..aac2a01b842 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.write_tensorboard_experiment_data.js @@ -0,0 +1,68 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(tensorboardExperiment, writeRunDataRequests) { + // [START aiplatform_v1_generated_TensorboardService_WriteTensorboardExperimentData_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the TensorboardExperiment to write data to. + * Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` + */ + // const tensorboardExperiment = 'abc123' + /** + * Required. Requests containing per-run TensorboardTimeSeries data to write. + */ + // const writeRunDataRequests = 1234 + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callWriteTensorboardExperimentData() { + // Construct request + const request = { + tensorboardExperiment, + writeRunDataRequests, + }; + + // Run request + const response = await aiplatformClient.writeTensorboardExperimentData(request); + console.log(response); + } + + callWriteTensorboardExperimentData(); + // [END aiplatform_v1_generated_TensorboardService_WriteTensorboardExperimentData_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.write_tensorboard_run_data.js b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.write_tensorboard_run_data.js new file mode 100644 index 00000000000..92214418c3d --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/tensorboard_service.write_tensorboard_run_data.js @@ -0,0 +1,72 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(tensorboardRun, timeSeriesData) { + // [START aiplatform_v1_generated_TensorboardService_WriteTensorboardRunData_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the TensorboardRun to write data to. + * Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` + */ + // const tensorboardRun = 'abc123' + /** + * Required. The TensorboardTimeSeries data to write. + * Values with in a time series are indexed by their step value. + * Repeated writes to the same step will overwrite the existing value for that + * step. + * The upper limit of data points per write request is 5000. + */ + // const timeSeriesData = 1234 + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callWriteTensorboardRunData() { + // Construct request + const request = { + tensorboardRun, + timeSeriesData, + }; + + // Run request + const response = await aiplatformClient.writeTensorboardRunData(request); + console.log(response); + } + + callWriteTensorboardRunData(); + // [END aiplatform_v1_generated_TensorboardService_WriteTensorboardRunData_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/vizier_service.add_trial_measurement.js b/packages/google-cloud-aiplatform/samples/generated/v1/vizier_service.add_trial_measurement.js new file mode 100644 index 00000000000..88ebdb7357e --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/vizier_service.add_trial_measurement.js @@ -0,0 +1,68 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(trialName, measurement) { + // [START aiplatform_v1_generated_VizierService_AddTrialMeasurement_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the trial to add measurement. + * Format: + * `projects/{project}/locations/{location}/studies/{study}/trials/{trial}` + */ + // const trialName = 'abc123' + /** + * Required. The measurement to be added to a Trial. + */ + // const measurement = {} + + // Imports the Aiplatform library + const {VizierServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new VizierServiceClient(); + + async function callAddTrialMeasurement() { + // Construct request + const request = { + trialName, + measurement, + }; + + // Run request + const response = await aiplatformClient.addTrialMeasurement(request); + console.log(response); + } + + callAddTrialMeasurement(); + // [END aiplatform_v1_generated_VizierService_AddTrialMeasurement_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/vizier_service.check_trial_early_stopping_state.js b/packages/google-cloud-aiplatform/samples/generated/v1/vizier_service.check_trial_early_stopping_state.js new file mode 100644 index 00000000000..578db2f1ef5 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/vizier_service.check_trial_early_stopping_state.js @@ -0,0 +1,64 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(trialName) { + // [START aiplatform_v1_generated_VizierService_CheckTrialEarlyStoppingState_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The Trial's name. + * Format: + * `projects/{project}/locations/{location}/studies/{study}/trials/{trial}` + */ + // const trialName = 'abc123' + + // Imports the Aiplatform library + const {VizierServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new VizierServiceClient(); + + async function callCheckTrialEarlyStoppingState() { + // Construct request + const request = { + trialName, + }; + + // Run request + const [operation] = await aiplatformClient.checkTrialEarlyStoppingState(request); + const [response] = await operation.promise(); + console.log(response); + } + + callCheckTrialEarlyStoppingState(); + // [END aiplatform_v1_generated_VizierService_CheckTrialEarlyStoppingState_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/vizier_service.complete_trial.js b/packages/google-cloud-aiplatform/samples/generated/v1/vizier_service.complete_trial.js new file mode 100644 index 00000000000..2ac80f7cdcc --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/vizier_service.complete_trial.js @@ -0,0 +1,79 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_VizierService_CompleteTrial_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The Trial's name. + * Format: + * `projects/{project}/locations/{location}/studies/{study}/trials/{trial}` + */ + // const name = 'abc123' + /** + * Optional. If provided, it will be used as the completed Trial's + * final_measurement; Otherwise, the service will auto-select a + * previously reported measurement as the final-measurement + */ + // const finalMeasurement = {} + /** + * Optional. True if the Trial cannot be run with the given Parameter, and + * final_measurement will be ignored. + */ + // const trialInfeasible = true + /** + * Optional. A human readable reason why the trial was infeasible. This should + * only be provided if `trial_infeasible` is true. + */ + // const infeasibleReason = 'abc123' + + // Imports the Aiplatform library + const {VizierServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new VizierServiceClient(); + + async function callCompleteTrial() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.completeTrial(request); + console.log(response); + } + + callCompleteTrial(); + // [END aiplatform_v1_generated_VizierService_CompleteTrial_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/vizier_service.create_study.js b/packages/google-cloud-aiplatform/samples/generated/v1/vizier_service.create_study.js new file mode 100644 index 00000000000..2efd25a7746 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/vizier_service.create_study.js @@ -0,0 +1,67 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, study) { + // [START aiplatform_v1_generated_VizierService_CreateStudy_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to create the CustomJob in. + * Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Required. The Study configuration used to create the Study. + */ + // const study = {} + + // Imports the Aiplatform library + const {VizierServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new VizierServiceClient(); + + async function callCreateStudy() { + // Construct request + const request = { + parent, + study, + }; + + // Run request + const response = await aiplatformClient.createStudy(request); + console.log(response); + } + + callCreateStudy(); + // [END aiplatform_v1_generated_VizierService_CreateStudy_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/vizier_service.create_trial.js b/packages/google-cloud-aiplatform/samples/generated/v1/vizier_service.create_trial.js new file mode 100644 index 00000000000..e03325b422d --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/vizier_service.create_trial.js @@ -0,0 +1,67 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, trial) { + // [START aiplatform_v1_generated_VizierService_CreateTrial_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Study to create the Trial in. + * Format: `projects/{project}/locations/{location}/studies/{study}` + */ + // const parent = 'abc123' + /** + * Required. The Trial to create. + */ + // const trial = {} + + // Imports the Aiplatform library + const {VizierServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new VizierServiceClient(); + + async function callCreateTrial() { + // Construct request + const request = { + parent, + trial, + }; + + // Run request + const response = await aiplatformClient.createTrial(request); + console.log(response); + } + + callCreateTrial(); + // [END aiplatform_v1_generated_VizierService_CreateTrial_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/vizier_service.delete_study.js b/packages/google-cloud-aiplatform/samples/generated/v1/vizier_service.delete_study.js new file mode 100644 index 00000000000..e261fd40e1d --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/vizier_service.delete_study.js @@ -0,0 +1,62 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_VizierService_DeleteStudy_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Study resource to be deleted. + * Format: `projects/{project}/locations/{location}/studies/{study}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {VizierServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new VizierServiceClient(); + + async function callDeleteStudy() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.deleteStudy(request); + console.log(response); + } + + callDeleteStudy(); + // [END aiplatform_v1_generated_VizierService_DeleteStudy_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/vizier_service.delete_trial.js b/packages/google-cloud-aiplatform/samples/generated/v1/vizier_service.delete_trial.js new file mode 100644 index 00000000000..a83c1501de6 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/vizier_service.delete_trial.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_VizierService_DeleteTrial_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The Trial's name. + * Format: + * `projects/{project}/locations/{location}/studies/{study}/trials/{trial}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {VizierServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new VizierServiceClient(); + + async function callDeleteTrial() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.deleteTrial(request); + console.log(response); + } + + callDeleteTrial(); + // [END aiplatform_v1_generated_VizierService_DeleteTrial_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/vizier_service.get_study.js b/packages/google-cloud-aiplatform/samples/generated/v1/vizier_service.get_study.js new file mode 100644 index 00000000000..489885b1d30 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/vizier_service.get_study.js @@ -0,0 +1,62 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_VizierService_GetStudy_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Study resource. + * Format: `projects/{project}/locations/{location}/studies/{study}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {VizierServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new VizierServiceClient(); + + async function callGetStudy() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getStudy(request); + console.log(response); + } + + callGetStudy(); + // [END aiplatform_v1_generated_VizierService_GetStudy_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/vizier_service.get_trial.js b/packages/google-cloud-aiplatform/samples/generated/v1/vizier_service.get_trial.js new file mode 100644 index 00000000000..6cd46e27b34 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/vizier_service.get_trial.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_VizierService_GetTrial_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Trial resource. + * Format: + * `projects/{project}/locations/{location}/studies/{study}/trials/{trial}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {VizierServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new VizierServiceClient(); + + async function callGetTrial() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getTrial(request); + console.log(response); + } + + callGetTrial(); + // [END aiplatform_v1_generated_VizierService_GetTrial_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/vizier_service.list_optimal_trials.js b/packages/google-cloud-aiplatform/samples/generated/v1/vizier_service.list_optimal_trials.js new file mode 100644 index 00000000000..a0bf7cea424 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/vizier_service.list_optimal_trials.js @@ -0,0 +1,61 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1_generated_VizierService_ListOptimalTrials_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Study that the optimal Trial belongs to. + */ + // const parent = 'abc123' + + // Imports the Aiplatform library + const {VizierServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new VizierServiceClient(); + + async function callListOptimalTrials() { + // Construct request + const request = { + parent, + }; + + // Run request + const response = await aiplatformClient.listOptimalTrials(request); + console.log(response); + } + + callListOptimalTrials(); + // [END aiplatform_v1_generated_VizierService_ListOptimalTrials_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/vizier_service.list_studies.js b/packages/google-cloud-aiplatform/samples/generated/v1/vizier_service.list_studies.js new file mode 100644 index 00000000000..6e1c8e9c2ea --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/vizier_service.list_studies.js @@ -0,0 +1,74 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1_generated_VizierService_ListStudies_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to list the Study from. + * Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Optional. A page token to request the next page of results. + * If unspecified, there are no subsequent pages. + */ + // const pageToken = 'abc123' + /** + * Optional. The maximum number of studies to return per "page" of results. + * If unspecified, service will pick an appropriate default. + */ + // const pageSize = 1234 + + // Imports the Aiplatform library + const {VizierServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new VizierServiceClient(); + + async function callListStudies() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listStudiesAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListStudies(); + // [END aiplatform_v1_generated_VizierService_ListStudies_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/vizier_service.list_trials.js b/packages/google-cloud-aiplatform/samples/generated/v1/vizier_service.list_trials.js new file mode 100644 index 00000000000..38351a0dc97 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/vizier_service.list_trials.js @@ -0,0 +1,74 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1_generated_VizierService_ListTrials_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Study to list the Trial from. + * Format: `projects/{project}/locations/{location}/studies/{study}` + */ + // const parent = 'abc123' + /** + * Optional. A page token to request the next page of results. + * If unspecified, there are no subsequent pages. + */ + // const pageToken = 'abc123' + /** + * Optional. The number of Trials to retrieve per "page" of results. + * If unspecified, the service will pick an appropriate default. + */ + // const pageSize = 1234 + + // Imports the Aiplatform library + const {VizierServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new VizierServiceClient(); + + async function callListTrials() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listTrialsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListTrials(); + // [END aiplatform_v1_generated_VizierService_ListTrials_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/vizier_service.lookup_study.js b/packages/google-cloud-aiplatform/samples/generated/v1/vizier_service.lookup_study.js new file mode 100644 index 00000000000..18e224d7edf --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/vizier_service.lookup_study.js @@ -0,0 +1,67 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, displayName) { + // [START aiplatform_v1_generated_VizierService_LookupStudy_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to get the Study from. + * Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Required. The user-defined display name of the Study + */ + // const displayName = 'abc123' + + // Imports the Aiplatform library + const {VizierServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new VizierServiceClient(); + + async function callLookupStudy() { + // Construct request + const request = { + parent, + displayName, + }; + + // Run request + const response = await aiplatformClient.lookupStudy(request); + console.log(response); + } + + callLookupStudy(); + // [END aiplatform_v1_generated_VizierService_LookupStudy_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/vizier_service.stop_trial.js b/packages/google-cloud-aiplatform/samples/generated/v1/vizier_service.stop_trial.js new file mode 100644 index 00000000000..ec8baec5144 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/vizier_service.stop_trial.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1_generated_VizierService_StopTrial_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The Trial's name. + * Format: + * `projects/{project}/locations/{location}/studies/{study}/trials/{trial}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {VizierServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new VizierServiceClient(); + + async function callStopTrial() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.stopTrial(request); + console.log(response); + } + + callStopTrial(); + // [END aiplatform_v1_generated_VizierService_StopTrial_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1/vizier_service.suggest_trials.js b/packages/google-cloud-aiplatform/samples/generated/v1/vizier_service.suggest_trials.js new file mode 100644 index 00000000000..20472f0a1d4 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1/vizier_service.suggest_trials.js @@ -0,0 +1,76 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, suggestionCount, clientId) { + // [START aiplatform_v1_generated_VizierService_SuggestTrials_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The project and location that the Study belongs to. + * Format: `projects/{project}/locations/{location}/studies/{study}` + */ + // const parent = 'abc123' + /** + * Required. The number of suggestions requested. It must be positive. + */ + // const suggestionCount = 1234 + /** + * Required. The identifier of the client that is requesting the suggestion. + * If multiple SuggestTrialsRequests have the same `client_id`, + * the service will return the identical suggested Trial if the Trial is + * pending, and provide a new Trial if the last suggested Trial was completed. + */ + // const clientId = 'abc123' + + // Imports the Aiplatform library + const {VizierServiceClient} = require('@google-cloud/aiplatform').v1; + + // Instantiates a client + const aiplatformClient = new VizierServiceClient(); + + async function callSuggestTrials() { + // Construct request + const request = { + parent, + suggestionCount, + clientId, + }; + + // Run request + const [operation] = await aiplatformClient.suggestTrials(request); + const [response] = await operation.promise(); + console.log(response); + } + + callSuggestTrials(); + // [END aiplatform_v1_generated_VizierService_SuggestTrials_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/dataset_service.create_dataset.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/dataset_service.create_dataset.js new file mode 100644 index 00000000000..00375fedb35 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/dataset_service.create_dataset.js @@ -0,0 +1,68 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, dataset) { + // [START aiplatform_v1beta1_generated_DatasetService_CreateDataset_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to create the Dataset in. + * Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Required. The Dataset to create. + */ + // const dataset = {} + + // Imports the Aiplatform library + const {DatasetServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new DatasetServiceClient(); + + async function callCreateDataset() { + // Construct request + const request = { + parent, + dataset, + }; + + // Run request + const [operation] = await aiplatformClient.createDataset(request); + const [response] = await operation.promise(); + console.log(response); + } + + callCreateDataset(); + // [END aiplatform_v1beta1_generated_DatasetService_CreateDataset_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/dataset_service.delete_dataset.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/dataset_service.delete_dataset.js new file mode 100644 index 00000000000..4c297665be5 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/dataset_service.delete_dataset.js @@ -0,0 +1,64 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_DatasetService_DeleteDataset_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Dataset to delete. + * Format: + * `projects/{project}/locations/{location}/datasets/{dataset}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {DatasetServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new DatasetServiceClient(); + + async function callDeleteDataset() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteDataset(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteDataset(); + // [END aiplatform_v1beta1_generated_DatasetService_DeleteDataset_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/dataset_service.export_data.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/dataset_service.export_data.js new file mode 100644 index 00000000000..b864620be84 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/dataset_service.export_data.js @@ -0,0 +1,69 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name, exportConfig) { + // [START aiplatform_v1beta1_generated_DatasetService_ExportData_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Dataset resource. + * Format: + * `projects/{project}/locations/{location}/datasets/{dataset}` + */ + // const name = 'abc123' + /** + * Required. The desired output location. + */ + // const exportConfig = {} + + // Imports the Aiplatform library + const {DatasetServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new DatasetServiceClient(); + + async function callExportData() { + // Construct request + const request = { + name, + exportConfig, + }; + + // Run request + const [operation] = await aiplatformClient.exportData(request); + const [response] = await operation.promise(); + console.log(response); + } + + callExportData(); + // [END aiplatform_v1beta1_generated_DatasetService_ExportData_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/dataset_service.get_annotation_spec.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/dataset_service.get_annotation_spec.js new file mode 100644 index 00000000000..98e440e7fe9 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/dataset_service.get_annotation_spec.js @@ -0,0 +1,67 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_DatasetService_GetAnnotationSpec_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the AnnotationSpec resource. + * Format: + * `projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}` + */ + // const name = 'abc123' + /** + * Mask specifying which fields to read. + */ + // const readMask = {} + + // Imports the Aiplatform library + const {DatasetServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new DatasetServiceClient(); + + async function callGetAnnotationSpec() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getAnnotationSpec(request); + console.log(response); + } + + callGetAnnotationSpec(); + // [END aiplatform_v1beta1_generated_DatasetService_GetAnnotationSpec_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/dataset_service.get_dataset.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/dataset_service.get_dataset.js new file mode 100644 index 00000000000..88428a8283c --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/dataset_service.get_dataset.js @@ -0,0 +1,65 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_DatasetService_GetDataset_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Dataset resource. + */ + // const name = 'abc123' + /** + * Mask specifying which fields to read. + */ + // const readMask = {} + + // Imports the Aiplatform library + const {DatasetServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new DatasetServiceClient(); + + async function callGetDataset() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getDataset(request); + console.log(response); + } + + callGetDataset(); + // [END aiplatform_v1beta1_generated_DatasetService_GetDataset_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/dataset_service.import_data.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/dataset_service.import_data.js new file mode 100644 index 00000000000..dfa6395c1ec --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/dataset_service.import_data.js @@ -0,0 +1,70 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name, importConfigs) { + // [START aiplatform_v1beta1_generated_DatasetService_ImportData_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Dataset resource. + * Format: + * `projects/{project}/locations/{location}/datasets/{dataset}` + */ + // const name = 'abc123' + /** + * Required. The desired input locations. The contents of all input locations + * will be imported in one batch. + */ + // const importConfigs = 1234 + + // Imports the Aiplatform library + const {DatasetServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new DatasetServiceClient(); + + async function callImportData() { + // Construct request + const request = { + name, + importConfigs, + }; + + // Run request + const [operation] = await aiplatformClient.importData(request); + const [response] = await operation.promise(); + console.log(response); + } + + callImportData(); + // [END aiplatform_v1beta1_generated_DatasetService_ImportData_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/dataset_service.list_annotations.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/dataset_service.list_annotations.js new file mode 100644 index 00000000000..3e22c18a0e8 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/dataset_service.list_annotations.js @@ -0,0 +1,86 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1beta1_generated_DatasetService_ListAnnotations_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the DataItem to list Annotations from. + * Format: + * `projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}` + */ + // const parent = 'abc123' + /** + * The standard list filter. + */ + // const filter = 'abc123' + /** + * The standard list page size. + */ + // const pageSize = 1234 + /** + * The standard list page token. + */ + // const pageToken = 'abc123' + /** + * Mask specifying which fields to read. + */ + // const readMask = {} + /** + * A comma-separated list of fields to order by, sorted in ascending order. + * Use "desc" after a field name for descending. + */ + // const orderBy = 'abc123' + + // Imports the Aiplatform library + const {DatasetServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new DatasetServiceClient(); + + async function callListAnnotations() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listAnnotationsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListAnnotations(); + // [END aiplatform_v1beta1_generated_DatasetService_ListAnnotations_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/dataset_service.list_data_items.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/dataset_service.list_data_items.js new file mode 100644 index 00000000000..53af1c6df30 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/dataset_service.list_data_items.js @@ -0,0 +1,86 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1beta1_generated_DatasetService_ListDataItems_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Dataset to list DataItems from. + * Format: + * `projects/{project}/locations/{location}/datasets/{dataset}` + */ + // const parent = 'abc123' + /** + * The standard list filter. + */ + // const filter = 'abc123' + /** + * The standard list page size. + */ + // const pageSize = 1234 + /** + * The standard list page token. + */ + // const pageToken = 'abc123' + /** + * Mask specifying which fields to read. + */ + // const readMask = {} + /** + * A comma-separated list of fields to order by, sorted in ascending order. + * Use "desc" after a field name for descending. + */ + // const orderBy = 'abc123' + + // Imports the Aiplatform library + const {DatasetServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new DatasetServiceClient(); + + async function callListDataItems() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listDataItemsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListDataItems(); + // [END aiplatform_v1beta1_generated_DatasetService_ListDataItems_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/dataset_service.list_datasets.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/dataset_service.list_datasets.js new file mode 100644 index 00000000000..430e3683f9b --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/dataset_service.list_datasets.js @@ -0,0 +1,99 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1beta1_generated_DatasetService_ListDatasets_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Dataset's parent resource. + * Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * An expression for filtering the results of the request. For field names + * both snake_case and camelCase are supported. + * * `display_name`: supports = and != + * * `metadata_schema_uri`: supports = and != + * * `labels` supports general map functions that is: + * * `labels.key=value` - key:value equality + * * `labels.key:* or labels:key - key existence + * * A key including a space must be quoted. `labels."a key"`. + * Some examples: + * * `displayName="myDisplayName"` + * * `labels.myKey="myValue"` + */ + // const filter = 'abc123' + /** + * The standard list page size. + */ + // const pageSize = 1234 + /** + * The standard list page token. + */ + // const pageToken = 'abc123' + /** + * Mask specifying which fields to read. + */ + // const readMask = {} + /** + * A comma-separated list of fields to order by, sorted in ascending order. + * Use "desc" after a field name for descending. + * Supported fields: + * * `display_name` + * * `create_time` + * * `update_time` + */ + // const orderBy = 'abc123' + + // Imports the Aiplatform library + const {DatasetServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new DatasetServiceClient(); + + async function callListDatasets() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listDatasetsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListDatasets(); + // [END aiplatform_v1beta1_generated_DatasetService_ListDatasets_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/dataset_service.list_saved_queries.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/dataset_service.list_saved_queries.js new file mode 100644 index 00000000000..1b6f90fb550 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/dataset_service.list_saved_queries.js @@ -0,0 +1,86 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1beta1_generated_DatasetService_ListSavedQueries_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Dataset to list SavedQueries from. + * Format: + * `projects/{project}/locations/{location}/datasets/{dataset}` + */ + // const parent = 'abc123' + /** + * The standard list filter. + */ + // const filter = 'abc123' + /** + * The standard list page size. + */ + // const pageSize = 1234 + /** + * The standard list page token. + */ + // const pageToken = 'abc123' + /** + * Mask specifying which fields to read. + */ + // const readMask = {} + /** + * A comma-separated list of fields to order by, sorted in ascending order. + * Use "desc" after a field name for descending. + */ + // const orderBy = 'abc123' + + // Imports the Aiplatform library + const {DatasetServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new DatasetServiceClient(); + + async function callListSavedQueries() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listSavedQueriesAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListSavedQueries(); + // [END aiplatform_v1beta1_generated_DatasetService_ListSavedQueries_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/dataset_service.search_data_items.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/dataset_service.search_data_items.js new file mode 100644 index 00000000000..bddd43f6697 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/dataset_service.search_data_items.js @@ -0,0 +1,145 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(dataset) { + // [START aiplatform_v1beta1_generated_DatasetService_SearchDataItems_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * A comma-separated list of data item fields to order by, sorted in + * ascending order. Use "desc" after a field name for descending. + */ + // const orderByDataItem = 'abc123' + /** + * Expression that allows ranking results based on annotation's property. + */ + // const orderByAnnotation = {} + /** + * Required. The resource name of the Dataset from which to search DataItems. + * Format: + * `projects/{project}/locations/{location}/datasets/{dataset}` + */ + // const dataset = 'abc123' + /** + * The resource name of a SavedQuery(annotation set in UI). + * Format: + * `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}` + * All of the search will be done in the context of this SavedQuery. + */ + // const savedQuery = 'abc123' + /** + * The resource name of a DataLabelingJob. + * Format: + * `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` + * If this field is set, all of the search will be done in the context of + * this DataLabelingJob. + */ + // const dataLabelingJob = 'abc123' + /** + * An expression for filtering the DataItem that will be returned. + * * `data_item_id` - for = or !=. + * * `labeled` - for = or !=. + * * `has_annotation(ANNOTATION_SPEC_ID)` - true only for DataItem that + * have at least one annotation with annotation_spec_id = + * `ANNOTATION_SPEC_ID` in the context of SavedQuery or DataLabelingJob. + * For example: + * * `data_item=1` + * * `has_annotation(5)` + */ + // const dataItemFilter = 'abc123' + /** + * An expression for filtering the Annotations that will be returned per + * DataItem. + * * `annotation_spec_id` - for = or !=. + */ + // const annotationsFilter = 'abc123' + /** + * An expression that specifies what Annotations will be returned per + * DataItem. Annotations satisfied either of the conditions will be returned. + * * `annotation_spec_id` - for = or !=. + * Must specify `saved_query_id=` - saved query id that annotations should + * belong to. + */ + // const annotationFilters = 'abc123' + /** + * Mask specifying which fields of + * DataItemView google.cloud.aiplatform.v1beta1.DataItemView to read. + */ + // const fieldMask = {} + /** + * If set, only up to this many of Annotations will be returned per + * DataItemView. The maximum value is 1000. If not set, the maximum value will + * be used. + */ + // const annotationsLimit = 1234 + /** + * Requested page size. Server may return fewer results than requested. + * Default and maximum page size is 100. + */ + // const pageSize = 1234 + /** + * A comma-separated list of fields to order by, sorted in ascending order. + * Use "desc" after a field name for descending. + */ + // const orderBy = 'abc123' + /** + * A token identifying a page of results for the server to return + * Typically obtained via + * SearchDataItemsResponse.next_page_token google.cloud.aiplatform.v1beta1.SearchDataItemsResponse.next_page_token + * of the previous + * DatasetService.SearchDataItems google.cloud.aiplatform.v1beta1.DatasetService.SearchDataItems + * call. + */ + // const pageToken = 'abc123' + + // Imports the Aiplatform library + const {DatasetServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new DatasetServiceClient(); + + async function callSearchDataItems() { + // Construct request + const request = { + dataset, + }; + + // Run request + const iterable = await aiplatformClient.searchDataItemsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callSearchDataItems(); + // [END aiplatform_v1beta1_generated_DatasetService_SearchDataItems_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/dataset_service.update_dataset.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/dataset_service.update_dataset.js new file mode 100644 index 00000000000..fe3144a62ae --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/dataset_service.update_dataset.js @@ -0,0 +1,71 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(dataset, updateMask) { + // [START aiplatform_v1beta1_generated_DatasetService_UpdateDataset_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The Dataset which replaces the resource on the server. + */ + // const dataset = {} + /** + * Required. The update mask applies to the resource. + * For the `FieldMask` definition, see + * google.protobuf.FieldMask google.protobuf.FieldMask. Updatable fields: + * * `display_name` + * * `description` + * * `labels` + */ + // const updateMask = {} + + // Imports the Aiplatform library + const {DatasetServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new DatasetServiceClient(); + + async function callUpdateDataset() { + // Construct request + const request = { + dataset, + updateMask, + }; + + // Run request + const response = await aiplatformClient.updateDataset(request); + console.log(response); + } + + callUpdateDataset(); + // [END aiplatform_v1beta1_generated_DatasetService_UpdateDataset_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/deployment_resource_pool_service.create_deployment_resource_pool.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/deployment_resource_pool_service.create_deployment_resource_pool.js new file mode 100644 index 00000000000..1951cec132d --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/deployment_resource_pool_service.create_deployment_resource_pool.js @@ -0,0 +1,77 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, deploymentResourcePool, deploymentResourcePoolId) { + // [START aiplatform_v1beta1_generated_DeploymentResourcePoolService_CreateDeploymentResourcePool_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The parent location resource where this DeploymentResourcePool + * will be created. Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Required. The DeploymentResourcePool to create. + */ + // const deploymentResourcePool = {} + /** + * Required. The ID to use for the DeploymentResourcePool, which + * will become the final component of the DeploymentResourcePool's resource + * name. + * The maximum length is 63 characters, and valid characters + * are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`. + */ + // const deploymentResourcePoolId = 'abc123' + + // Imports the Aiplatform library + const {DeploymentResourcePoolServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new DeploymentResourcePoolServiceClient(); + + async function callCreateDeploymentResourcePool() { + // Construct request + const request = { + parent, + deploymentResourcePool, + deploymentResourcePoolId, + }; + + // Run request + const [operation] = await aiplatformClient.createDeploymentResourcePool(request); + const [response] = await operation.promise(); + console.log(response); + } + + callCreateDeploymentResourcePool(); + // [END aiplatform_v1beta1_generated_DeploymentResourcePoolService_CreateDeploymentResourcePool_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/deployment_resource_pool_service.delete_deployment_resource_pool.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/deployment_resource_pool_service.delete_deployment_resource_pool.js new file mode 100644 index 00000000000..5106da36922 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/deployment_resource_pool_service.delete_deployment_resource_pool.js @@ -0,0 +1,64 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_DeploymentResourcePoolService_DeleteDeploymentResourcePool_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the DeploymentResourcePool to delete. + * Format: + * `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {DeploymentResourcePoolServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new DeploymentResourcePoolServiceClient(); + + async function callDeleteDeploymentResourcePool() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteDeploymentResourcePool(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteDeploymentResourcePool(); + // [END aiplatform_v1beta1_generated_DeploymentResourcePoolService_DeleteDeploymentResourcePool_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/deployment_resource_pool_service.get_deployment_resource_pool.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/deployment_resource_pool_service.get_deployment_resource_pool.js new file mode 100644 index 00000000000..3049ba40365 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/deployment_resource_pool_service.get_deployment_resource_pool.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_DeploymentResourcePoolService_GetDeploymentResourcePool_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the DeploymentResourcePool to retrieve. + * Format: + * `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {DeploymentResourcePoolServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new DeploymentResourcePoolServiceClient(); + + async function callGetDeploymentResourcePool() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getDeploymentResourcePool(request); + console.log(response); + } + + callGetDeploymentResourcePool(); + // [END aiplatform_v1beta1_generated_DeploymentResourcePoolService_GetDeploymentResourcePool_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/deployment_resource_pool_service.list_deployment_resource_pools.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/deployment_resource_pool_service.list_deployment_resource_pools.js new file mode 100644 index 00000000000..2502c261f91 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/deployment_resource_pool_service.list_deployment_resource_pools.js @@ -0,0 +1,77 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1beta1_generated_DeploymentResourcePoolService_ListDeploymentResourcePools_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The parent Location which owns this collection of + * DeploymentResourcePools. Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * The maximum number of DeploymentResourcePools to return. The service may + * return fewer than this value. + */ + // const pageSize = 1234 + /** + * A page token, received from a previous `ListDeploymentResourcePools` call. + * Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to + * `ListDeploymentResourcePools` must match the call that provided the page + * token. + */ + // const pageToken = 'abc123' + + // Imports the Aiplatform library + const {DeploymentResourcePoolServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new DeploymentResourcePoolServiceClient(); + + async function callListDeploymentResourcePools() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listDeploymentResourcePoolsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListDeploymentResourcePools(); + // [END aiplatform_v1beta1_generated_DeploymentResourcePoolService_ListDeploymentResourcePools_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/deployment_resource_pool_service.query_deployed_models.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/deployment_resource_pool_service.query_deployed_models.js new file mode 100644 index 00000000000..a7b91953673 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/deployment_resource_pool_service.query_deployed_models.js @@ -0,0 +1,78 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(deploymentResourcePool) { + // [START aiplatform_v1beta1_generated_DeploymentResourcePoolService_QueryDeployedModels_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the target DeploymentResourcePool to query. + * Format: + * `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` + */ + // const deploymentResourcePool = 'abc123' + /** + * The maximum number of DeployedModels to return. The service may return + * fewer than this value. + */ + // const pageSize = 1234 + /** + * A page token, received from a previous `QueryDeployedModels` call. + * Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to + * `QueryDeployedModels` must match the call that provided the page + * token. + */ + // const pageToken = 'abc123' + + // Imports the Aiplatform library + const {DeploymentResourcePoolServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new DeploymentResourcePoolServiceClient(); + + async function callQueryDeployedModels() { + // Construct request + const request = { + deploymentResourcePool, + }; + + // Run request + const iterable = await aiplatformClient.queryDeployedModelsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callQueryDeployedModels(); + // [END aiplatform_v1beta1_generated_DeploymentResourcePoolService_QueryDeployedModels_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/endpoint_service.create_endpoint.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/endpoint_service.create_endpoint.js new file mode 100644 index 00000000000..7de8718e69a --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/endpoint_service.create_endpoint.js @@ -0,0 +1,79 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, endpoint, endpointId) { + // [START aiplatform_v1beta1_generated_EndpointService_CreateEndpoint_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to create the Endpoint in. + * Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Required. The Endpoint to create. + */ + // const endpoint = {} + /** + * Immutable. The ID to use for endpoint, which will become the final + * component of the endpoint resource name. + * If not provided, Vertex AI will generate a value for this ID. + * This value should be 1-10 characters, and valid characters are /[0-9]/. + * When using HTTP/JSON, this field is populated based on a query string + * argument, such as `?endpoint_id=12345`. This is the fallback for fields + * that are not included in either the URI or the body. + */ + // const endpointId = 'abc123' + + // Imports the Aiplatform library + const {EndpointServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new EndpointServiceClient(); + + async function callCreateEndpoint() { + // Construct request + const request = { + parent, + endpoint, + endpointId, + }; + + // Run request + const [operation] = await aiplatformClient.createEndpoint(request); + const [response] = await operation.promise(); + console.log(response); + } + + callCreateEndpoint(); + // [END aiplatform_v1beta1_generated_EndpointService_CreateEndpoint_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/endpoint_service.delete_endpoint.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/endpoint_service.delete_endpoint.js new file mode 100644 index 00000000000..86ffbe31815 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/endpoint_service.delete_endpoint.js @@ -0,0 +1,64 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_EndpointService_DeleteEndpoint_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Endpoint resource to be deleted. + * Format: + * `projects/{project}/locations/{location}/endpoints/{endpoint}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {EndpointServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new EndpointServiceClient(); + + async function callDeleteEndpoint() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteEndpoint(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteEndpoint(); + // [END aiplatform_v1beta1_generated_EndpointService_DeleteEndpoint_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/endpoint_service.deploy_model.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/endpoint_service.deploy_model.js new file mode 100644 index 00000000000..ba2ce26e8c5 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/endpoint_service.deploy_model.js @@ -0,0 +1,87 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(endpoint, deployedModel) { + // [START aiplatform_v1beta1_generated_EndpointService_DeployModel_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Endpoint resource into which to deploy a Model. + * Format: + * `projects/{project}/locations/{location}/endpoints/{endpoint}` + */ + // const endpoint = 'abc123' + /** + * Required. The DeployedModel to be created within the Endpoint. Note that + * Endpoint.traffic_split google.cloud.aiplatform.v1beta1.Endpoint.traffic_split + * must be updated for the DeployedModel to start receiving traffic, either as + * part of this call, or via + * EndpointService.UpdateEndpoint google.cloud.aiplatform.v1beta1.EndpointService.UpdateEndpoint. + */ + // const deployedModel = {} + /** + * A map from a DeployedModel's ID to the percentage of this Endpoint's + * traffic that should be forwarded to that DeployedModel. + * If this field is non-empty, then the Endpoint's + * traffic_split google.cloud.aiplatform.v1beta1.Endpoint.traffic_split + * will be overwritten with it. To refer to the ID of the just being deployed + * Model, a "0" should be used, and the actual ID of the new DeployedModel + * will be filled in its place by this method. The traffic percentage values + * must add up to 100. + * If this field is empty, then the Endpoint's + * traffic_split google.cloud.aiplatform.v1beta1.Endpoint.traffic_split is + * not updated. + */ + // const trafficSplit = 1234 + + // Imports the Aiplatform library + const {EndpointServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new EndpointServiceClient(); + + async function callDeployModel() { + // Construct request + const request = { + endpoint, + deployedModel, + }; + + // Run request + const [operation] = await aiplatformClient.deployModel(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeployModel(); + // [END aiplatform_v1beta1_generated_EndpointService_DeployModel_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/endpoint_service.get_endpoint.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/endpoint_service.get_endpoint.js new file mode 100644 index 00000000000..1451caba252 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/endpoint_service.get_endpoint.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_EndpointService_GetEndpoint_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Endpoint resource. + * Format: + * `projects/{project}/locations/{location}/endpoints/{endpoint}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {EndpointServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new EndpointServiceClient(); + + async function callGetEndpoint() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getEndpoint(request); + console.log(response); + } + + callGetEndpoint(); + // [END aiplatform_v1beta1_generated_EndpointService_GetEndpoint_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/endpoint_service.list_endpoints.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/endpoint_service.list_endpoints.js new file mode 100644 index 00000000000..6fd677962bd --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/endpoint_service.list_endpoints.js @@ -0,0 +1,98 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1beta1_generated_EndpointService_ListEndpoints_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location from which to list the + * Endpoints. Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Optional. An expression for filtering the results of the request. For field + * names both snake_case and camelCase are supported. + * * `endpoint` supports = and !=. `endpoint` represents the Endpoint ID, + * i.e. the last segment of the Endpoint's resource + * name google.cloud.aiplatform.v1beta1.Endpoint.name. + * * `display_name` supports = and, != + * * `labels` supports general map functions that is: + * * `labels.key=value` - key:value equality + * * `labels.key:* or labels:key - key existence + * * A key including a space must be quoted. `labels."a key"`. + * Some examples: + * * `endpoint=1` + * * `displayName="myDisplayName"` + * * `labels.myKey="myValue"` + */ + // const filter = 'abc123' + /** + * Optional. The standard list page size. + */ + // const pageSize = 1234 + /** + * Optional. The standard list page token. + * Typically obtained via + * ListEndpointsResponse.next_page_token google.cloud.aiplatform.v1beta1.ListEndpointsResponse.next_page_token + * of the previous + * EndpointService.ListEndpoints google.cloud.aiplatform.v1beta1.EndpointService.ListEndpoints + * call. + */ + // const pageToken = 'abc123' + /** + * Optional. Mask specifying which fields to read. + */ + // const readMask = {} + + // Imports the Aiplatform library + const {EndpointServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new EndpointServiceClient(); + + async function callListEndpoints() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listEndpointsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListEndpoints(); + // [END aiplatform_v1beta1_generated_EndpointService_ListEndpoints_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/endpoint_service.undeploy_model.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/endpoint_service.undeploy_model.js new file mode 100644 index 00000000000..72313423887 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/endpoint_service.undeploy_model.js @@ -0,0 +1,79 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(endpoint, deployedModelId) { + // [START aiplatform_v1beta1_generated_EndpointService_UndeployModel_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Endpoint resource from which to undeploy a Model. + * Format: + * `projects/{project}/locations/{location}/endpoints/{endpoint}` + */ + // const endpoint = 'abc123' + /** + * Required. The ID of the DeployedModel to be undeployed from the Endpoint. + */ + // const deployedModelId = 'abc123' + /** + * If this field is provided, then the Endpoint's + * traffic_split google.cloud.aiplatform.v1beta1.Endpoint.traffic_split + * will be overwritten with it. If last DeployedModel is being undeployed from + * the Endpoint, the Endpoint.traffic_split will always end up empty when + * this call returns. A DeployedModel will be successfully undeployed only if + * it doesn't have any traffic assigned to it when this method executes, or if + * this field unassigns any traffic to it. + */ + // const trafficSplit = 1234 + + // Imports the Aiplatform library + const {EndpointServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new EndpointServiceClient(); + + async function callUndeployModel() { + // Construct request + const request = { + endpoint, + deployedModelId, + }; + + // Run request + const [operation] = await aiplatformClient.undeployModel(request); + const [response] = await operation.promise(); + console.log(response); + } + + callUndeployModel(); + // [END aiplatform_v1beta1_generated_EndpointService_UndeployModel_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/endpoint_service.update_endpoint.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/endpoint_service.update_endpoint.js new file mode 100644 index 00000000000..1d92d9959f0 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/endpoint_service.update_endpoint.js @@ -0,0 +1,67 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(endpoint, updateMask) { + // [START aiplatform_v1beta1_generated_EndpointService_UpdateEndpoint_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The Endpoint which replaces the resource on the server. + */ + // const endpoint = {} + /** + * Required. The update mask applies to the resource. See + * google.protobuf.FieldMask google.protobuf.FieldMask. + */ + // const updateMask = {} + + // Imports the Aiplatform library + const {EndpointServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new EndpointServiceClient(); + + async function callUpdateEndpoint() { + // Construct request + const request = { + endpoint, + updateMask, + }; + + // Run request + const response = await aiplatformClient.updateEndpoint(request); + console.log(response); + } + + callUpdateEndpoint(); + // [END aiplatform_v1beta1_generated_EndpointService_UpdateEndpoint_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_online_serving_service.read_feature_values.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_online_serving_service.read_feature_values.js new file mode 100644 index 00000000000..645ff207423 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_online_serving_service.read_feature_values.js @@ -0,0 +1,77 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(entityType, entityId, featureSelector) { + // [START aiplatform_v1beta1_generated_FeaturestoreOnlineServingService_ReadFeatureValues_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the EntityType for the entity being read. + * Value format: + * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`. + * For example, for a machine learning model predicting user clicks on a + * website, an EntityType ID could be `user`. + */ + // const entityType = 'abc123' + /** + * Required. ID for a specific entity. For example, + * for a machine learning model predicting user clicks on a website, an entity + * ID could be `user_123`. + */ + // const entityId = 'abc123' + /** + * Required. Selector choosing Features of the target EntityType. + */ + // const featureSelector = {} + + // Imports the Aiplatform library + const {FeaturestoreOnlineServingServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreOnlineServingServiceClient(); + + async function callReadFeatureValues() { + // Construct request + const request = { + entityType, + entityId, + featureSelector, + }; + + // Run request + const response = await aiplatformClient.readFeatureValues(request); + console.log(response); + } + + callReadFeatureValues(); + // [END aiplatform_v1beta1_generated_FeaturestoreOnlineServingService_ReadFeatureValues_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_online_serving_service.streaming_read_feature_values.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_online_serving_service.streaming_read_feature_values.js new file mode 100644 index 00000000000..1def4fc792b --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_online_serving_service.streaming_read_feature_values.js @@ -0,0 +1,81 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(entityType, entityIds, featureSelector) { + // [START aiplatform_v1beta1_generated_FeaturestoreOnlineServingService_StreamingReadFeatureValues_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the entities' type. + * Value format: + * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`. + * For example, + * for a machine learning model predicting user clicks on a website, an + * EntityType ID could be `user`. + */ + // const entityType = 'abc123' + /** + * Required. IDs of entities to read Feature values of. The maximum number of + * IDs is 100. For example, for a machine learning model predicting user + * clicks on a website, an entity ID could be `user_123`. + */ + // const entityIds = 'abc123' + /** + * Required. Selector choosing Features of the target EntityType. Feature IDs + * will be deduplicated. + */ + // const featureSelector = {} + + // Imports the Aiplatform library + const {FeaturestoreOnlineServingServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreOnlineServingServiceClient(); + + async function callStreamingReadFeatureValues() { + // Construct request + const request = { + entityType, + entityIds, + featureSelector, + }; + + // Run request + const stream = await aiplatformClient.streamingReadFeatureValues(request); + stream.on('data', (response) => { console.log(response) }); + stream.on('error', (err) => { throw(err) }); + stream.on('end', () => { /* API call completed */ }); + } + + callStreamingReadFeatureValues(); + // [END aiplatform_v1beta1_generated_FeaturestoreOnlineServingService_StreamingReadFeatureValues_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_online_serving_service.write_feature_values.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_online_serving_service.write_feature_values.js new file mode 100644 index 00000000000..e2719975b5e --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_online_serving_service.write_feature_values.js @@ -0,0 +1,72 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(entityType, payloads) { + // [START aiplatform_v1beta1_generated_FeaturestoreOnlineServingService_WriteFeatureValues_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the EntityType for the entities being + * written. Value format: + * `projects/{project}/locations/{location}/featurestores/ + * {featurestore}/entityTypes/{entityType}`. For example, + * for a machine learning model predicting user clicks on a website, an + * EntityType ID could be `user`. + */ + // const entityType = 'abc123' + /** + * Required. The entities to be written. Up to 100,000 feature values can be + * written across all `payloads`. + */ + // const payloads = 1234 + + // Imports the Aiplatform library + const {FeaturestoreOnlineServingServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreOnlineServingServiceClient(); + + async function callWriteFeatureValues() { + // Construct request + const request = { + entityType, + payloads, + }; + + // Run request + const response = await aiplatformClient.writeFeatureValues(request); + console.log(response); + } + + callWriteFeatureValues(); + // [END aiplatform_v1beta1_generated_FeaturestoreOnlineServingService_WriteFeatureValues_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.batch_create_features.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.batch_create_features.js new file mode 100644 index 00000000000..796e5b5bfd1 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.batch_create_features.js @@ -0,0 +1,73 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, requests) { + // [START aiplatform_v1beta1_generated_FeaturestoreService_BatchCreateFeatures_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the EntityType to create the batch of + * Features under. Format: + * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` + */ + // const parent = 'abc123' + /** + * Required. The request message specifying the Features to create. All + * Features must be created under the same parent EntityType. The `parent` + * field in each child request message can be omitted. If `parent` is set in a + * child request, then the value must match the `parent` value in this request + * message. + */ + // const requests = 1234 + + // Imports the Aiplatform library + const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreServiceClient(); + + async function callBatchCreateFeatures() { + // Construct request + const request = { + parent, + requests, + }; + + // Run request + const [operation] = await aiplatformClient.batchCreateFeatures(request); + const [response] = await operation.promise(); + console.log(response); + } + + callBatchCreateFeatures(); + // [END aiplatform_v1beta1_generated_FeaturestoreService_BatchCreateFeatures_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.batch_read_feature_values.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.batch_read_feature_values.js new file mode 100644 index 00000000000..85437895db6 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.batch_read_feature_values.js @@ -0,0 +1,117 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(featurestore, destination, entityTypeSpecs) { + // [START aiplatform_v1beta1_generated_FeaturestoreService_BatchReadFeatureValues_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Each read instance consists of exactly one read timestamp and one or more + * entity IDs identifying entities of the corresponding EntityTypes whose + * Features are requested. + * Each output instance contains Feature values of requested entities + * concatenated together as of the read time. + * An example read instance may be `foo_entity_id, bar_entity_id, + * 2020-01-01T10:00:00.123Z`. + * An example output instance may be `foo_entity_id, bar_entity_id, + * 2020-01-01T10:00:00.123Z, foo_entity_feature1_value, + * bar_entity_feature2_value`. + * Timestamp in each read instance must be millisecond-aligned. + * `csv_read_instances` are read instances stored in a plain-text CSV file. + * The header should be: + * ENTITY_TYPE_ID1, ENTITY_TYPE_ID2, ..., timestamp + * The columns can be in any order. + * Values in the timestamp column must use the RFC 3339 format, e.g. + * `2012-07-30T10:43:17.123Z`. + */ + // const csvReadInstances = {} + /** + * Similar to csv_read_instances, but from BigQuery source. + */ + // const bigqueryReadInstances = {} + /** + * Required. The resource name of the Featurestore from which to query Feature + * values. Format: + * `projects/{project}/locations/{location}/featurestores/{featurestore}` + */ + // const featurestore = 'abc123' + /** + * Required. Specifies output location and format. + */ + // const destination = {} + /** + * When not empty, the specified fields in the *_read_instances source will be + * joined as-is in the output, in addition to those fields from the + * Featurestore Entity. + * For BigQuery source, the type of the pass-through values will be + * automatically inferred. For CSV source, the pass-through values will be + * passed as opaque bytes. + */ + // const passThroughFields = 1234 + /** + * Required. Specifies EntityType grouping Features to read values of and + * settings. Each EntityType referenced in + * BatchReadFeatureValuesRequest.entity_type_specs must have a column + * specifying entity IDs in the EntityType in + * BatchReadFeatureValuesRequest.request . + */ + // const entityTypeSpecs = 1234 + /** + * Optional. Excludes Feature values with feature generation timestamp before + * this timestamp. If not set, retrieve oldest values kept in Feature Store. + * Timestamp, if present, must not have higher than millisecond precision. + */ + // const startTime = {} + + // Imports the Aiplatform library + const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreServiceClient(); + + async function callBatchReadFeatureValues() { + // Construct request + const request = { + featurestore, + destination, + entityTypeSpecs, + }; + + // Run request + const [operation] = await aiplatformClient.batchReadFeatureValues(request); + const [response] = await operation.promise(); + console.log(response); + } + + callBatchReadFeatureValues(); + // [END aiplatform_v1beta1_generated_FeaturestoreService_BatchReadFeatureValues_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.create_entity_type.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.create_entity_type.js new file mode 100644 index 00000000000..df10b0bce9f --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.create_entity_type.js @@ -0,0 +1,77 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, entityTypeId) { + // [START aiplatform_v1beta1_generated_FeaturestoreService_CreateEntityType_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Featurestore to create EntityTypes. + * Format: + * `projects/{project}/locations/{location}/featurestores/{featurestore}` + */ + // const parent = 'abc123' + /** + * The EntityType to create. + */ + // const entityType = {} + /** + * Required. The ID to use for the EntityType, which will become the final + * component of the EntityType's resource name. + * This value may be up to 60 characters, and valid characters are + * `[a-z0-9_]`. The first character cannot be a number. + * The value must be unique within a featurestore. + */ + // const entityTypeId = 'abc123' + + // Imports the Aiplatform library + const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreServiceClient(); + + async function callCreateEntityType() { + // Construct request + const request = { + parent, + entityTypeId, + }; + + // Run request + const [operation] = await aiplatformClient.createEntityType(request); + const [response] = await operation.promise(); + console.log(response); + } + + callCreateEntityType(); + // [END aiplatform_v1beta1_generated_FeaturestoreService_CreateEntityType_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.create_feature.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.create_feature.js new file mode 100644 index 00000000000..7ba2e4fc587 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.create_feature.js @@ -0,0 +1,78 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, feature, featureId) { + // [START aiplatform_v1beta1_generated_FeaturestoreService_CreateFeature_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the EntityType to create a Feature. + * Format: + * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` + */ + // const parent = 'abc123' + /** + * Required. The Feature to create. + */ + // const feature = {} + /** + * Required. The ID to use for the Feature, which will become the final + * component of the Feature's resource name. + * This value may be up to 128 characters, and valid characters are + * `[a-z0-9_]`. The first character cannot be a number. + * The value must be unique within an EntityType. + */ + // const featureId = 'abc123' + + // Imports the Aiplatform library + const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreServiceClient(); + + async function callCreateFeature() { + // Construct request + const request = { + parent, + feature, + featureId, + }; + + // Run request + const [operation] = await aiplatformClient.createFeature(request); + const [response] = await operation.promise(); + console.log(response); + } + + callCreateFeature(); + // [END aiplatform_v1beta1_generated_FeaturestoreService_CreateFeature_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.create_featurestore.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.create_featurestore.js new file mode 100644 index 00000000000..4e22f904b18 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.create_featurestore.js @@ -0,0 +1,78 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, featurestore, featurestoreId) { + // [START aiplatform_v1beta1_generated_FeaturestoreService_CreateFeaturestore_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to create Featurestores. + * Format: + * `projects/{project}/locations/{location}'` + */ + // const parent = 'abc123' + /** + * Required. The Featurestore to create. + */ + // const featurestore = {} + /** + * Required. The ID to use for this Featurestore, which will become the final + * component of the Featurestore's resource name. + * This value may be up to 60 characters, and valid characters are + * `[a-z0-9_]`. The first character cannot be a number. + * The value must be unique within the project and location. + */ + // const featurestoreId = 'abc123' + + // Imports the Aiplatform library + const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreServiceClient(); + + async function callCreateFeaturestore() { + // Construct request + const request = { + parent, + featurestore, + featurestoreId, + }; + + // Run request + const [operation] = await aiplatformClient.createFeaturestore(request); + const [response] = await operation.promise(); + console.log(response); + } + + callCreateFeaturestore(); + // [END aiplatform_v1beta1_generated_FeaturestoreService_CreateFeaturestore_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.delete_entity_type.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.delete_entity_type.js new file mode 100644 index 00000000000..571c5db4956 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.delete_entity_type.js @@ -0,0 +1,69 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_FeaturestoreService_DeleteEntityType_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the EntityType to be deleted. + * Format: + * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` + */ + // const name = 'abc123' + /** + * If set to true, any Features for this EntityType will also be deleted. + * (Otherwise, the request will only work if the EntityType has no Features.) + */ + // const force = true + + // Imports the Aiplatform library + const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreServiceClient(); + + async function callDeleteEntityType() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteEntityType(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteEntityType(); + // [END aiplatform_v1beta1_generated_FeaturestoreService_DeleteEntityType_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.delete_feature.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.delete_feature.js new file mode 100644 index 00000000000..8d267469df5 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.delete_feature.js @@ -0,0 +1,64 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_FeaturestoreService_DeleteFeature_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Features to be deleted. + * Format: + * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreServiceClient(); + + async function callDeleteFeature() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteFeature(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteFeature(); + // [END aiplatform_v1beta1_generated_FeaturestoreService_DeleteFeature_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.delete_feature_values.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.delete_feature_values.js new file mode 100644 index 00000000000..2d0ff7c8f90 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.delete_feature_values.js @@ -0,0 +1,73 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(entityType) { + // [START aiplatform_v1beta1_generated_FeaturestoreService_DeleteFeatureValues_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Select feature values to be deleted by specifying entities. + */ + // const selectEntity = {} + /** + * Select feature values to be deleted by specifying time range and + * features. + */ + // const selectTimeRangeAndFeature = {} + /** + * Required. The resource name of the EntityType grouping the Features for + * which values are being deleted from. Format: + * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}` + */ + // const entityType = 'abc123' + + // Imports the Aiplatform library + const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreServiceClient(); + + async function callDeleteFeatureValues() { + // Construct request + const request = { + entityType, + }; + + // Run request + const [operation] = await aiplatformClient.deleteFeatureValues(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteFeatureValues(); + // [END aiplatform_v1beta1_generated_FeaturestoreService_DeleteFeatureValues_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.delete_featurestore.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.delete_featurestore.js new file mode 100644 index 00000000000..bc7385ec828 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.delete_featurestore.js @@ -0,0 +1,70 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_FeaturestoreService_DeleteFeaturestore_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Featurestore to be deleted. + * Format: + * `projects/{project}/locations/{location}/featurestores/{featurestore}` + */ + // const name = 'abc123' + /** + * If set to true, any EntityTypes and Features for this Featurestore will + * also be deleted. (Otherwise, the request will only work if the Featurestore + * has no EntityTypes.) + */ + // const force = true + + // Imports the Aiplatform library + const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreServiceClient(); + + async function callDeleteFeaturestore() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteFeaturestore(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteFeaturestore(); + // [END aiplatform_v1beta1_generated_FeaturestoreService_DeleteFeaturestore_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.export_feature_values.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.export_feature_values.js new file mode 100644 index 00000000000..d57684e53ab --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.export_feature_values.js @@ -0,0 +1,88 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(entityType, destination, featureSelector) { + // [START aiplatform_v1beta1_generated_FeaturestoreService_ExportFeatureValues_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Exports the latest Feature values of all entities of the EntityType + * within a time range. + */ + // const snapshotExport = {} + /** + * Exports all historical values of all entities of the EntityType within a + * time range + */ + // const fullExport = {} + /** + * Required. The resource name of the EntityType from which to export Feature + * values. Format: + * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` + */ + // const entityType = 'abc123' + /** + * Required. Specifies destination location and format. + */ + // const destination = {} + /** + * Required. Selects Features to export values of. + */ + // const featureSelector = {} + /** + * Per-Feature export settings. + */ + // const settings = 1234 + + // Imports the Aiplatform library + const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreServiceClient(); + + async function callExportFeatureValues() { + // Construct request + const request = { + entityType, + destination, + featureSelector, + }; + + // Run request + const [operation] = await aiplatformClient.exportFeatureValues(request); + const [response] = await operation.promise(); + console.log(response); + } + + callExportFeatureValues(); + // [END aiplatform_v1beta1_generated_FeaturestoreService_ExportFeatureValues_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.get_entity_type.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.get_entity_type.js new file mode 100644 index 00000000000..8c9126a6ae4 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.get_entity_type.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_FeaturestoreService_GetEntityType_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the EntityType resource. + * Format: + * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreServiceClient(); + + async function callGetEntityType() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getEntityType(request); + console.log(response); + } + + callGetEntityType(); + // [END aiplatform_v1beta1_generated_FeaturestoreService_GetEntityType_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.get_feature.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.get_feature.js new file mode 100644 index 00000000000..11d24d9b577 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.get_feature.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_FeaturestoreService_GetFeature_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Feature resource. + * Format: + * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreServiceClient(); + + async function callGetFeature() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getFeature(request); + console.log(response); + } + + callGetFeature(); + // [END aiplatform_v1beta1_generated_FeaturestoreService_GetFeature_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.get_featurestore.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.get_featurestore.js new file mode 100644 index 00000000000..5c13f974eff --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.get_featurestore.js @@ -0,0 +1,61 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_FeaturestoreService_GetFeaturestore_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Featurestore resource. + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreServiceClient(); + + async function callGetFeaturestore() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getFeaturestore(request); + console.log(response); + } + + callGetFeaturestore(); + // [END aiplatform_v1beta1_generated_FeaturestoreService_GetFeaturestore_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.import_feature_values.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.import_feature_values.js new file mode 100644 index 00000000000..28d16cb58fc --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.import_feature_values.js @@ -0,0 +1,114 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(entityType, featureSpecs) { + // [START aiplatform_v1beta1_generated_FeaturestoreService_ImportFeatureValues_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + */ + // const avroSource = {} + /** + */ + // const bigquerySource = {} + /** + */ + // const csvSource = {} + /** + * Source column that holds the Feature timestamp for all Feature + * values in each entity. + */ + // const featureTimeField = 'abc123' + /** + * Single Feature timestamp for all entities being imported. The + * timestamp must not have higher than millisecond precision. + */ + // const featureTime = {} + /** + * Required. The resource name of the EntityType grouping the Features for + * which values are being imported. Format: + * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}` + */ + // const entityType = 'abc123' + /** + * Source column that holds entity IDs. If not provided, entity IDs are + * extracted from the column named `entity_id`. + */ + // const entityIdField = 'abc123' + /** + * Required. Specifications defining which Feature values to import from the + * entity. The request fails if no feature_specs are provided, and having + * multiple feature_specs for one Feature is not allowed. + */ + // const featureSpecs = 1234 + /** + * If set, data will not be imported for online serving. This + * is typically used for backfilling, where Feature generation timestamps are + * not in the timestamp range needed for online serving. + */ + // const disableOnlineServing = true + /** + * Specifies the number of workers that are used to write data to the + * Featurestore. Consider the online serving capacity that you require to + * achieve the desired import throughput without interfering with online + * serving. The value must be positive, and less than or equal to 100. + * If not set, defaults to using 1 worker. The low count ensures minimal + * impact on online serving performance. + */ + // const workerCount = 1234 + /** + * If true, API doesn't start ingestion analysis pipeline. + */ + // const disableIngestionAnalysis = true + + // Imports the Aiplatform library + const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreServiceClient(); + + async function callImportFeatureValues() { + // Construct request + const request = { + entityType, + featureSpecs, + }; + + // Run request + const [operation] = await aiplatformClient.importFeatureValues(request); + const [response] = await operation.promise(); + console.log(response); + } + + callImportFeatureValues(); + // [END aiplatform_v1beta1_generated_FeaturestoreService_ImportFeatureValues_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.list_entity_types.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.list_entity_types.js new file mode 100644 index 00000000000..1cfc6960b33 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.list_entity_types.js @@ -0,0 +1,112 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1beta1_generated_FeaturestoreService_ListEntityTypes_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Featurestore to list EntityTypes. + * Format: + * `projects/{project}/locations/{location}/featurestores/{featurestore}` + */ + // const parent = 'abc123' + /** + * Lists the EntityTypes that match the filter expression. The following + * filters are supported: + * * `create_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. + * Values must be in RFC 3339 format. + * * `update_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. + * Values must be in RFC 3339 format. + * * `labels`: Supports key-value equality as well as key presence. + * Examples: + * * `create_time > \"2020-01-31T15:30:00.000000Z\" OR + * update_time > \"2020-01-31T15:30:00.000000Z\"` --> EntityTypes created + * or updated after 2020-01-31T15:30:00.000000Z. + * * `labels.active = yes AND labels.env = prod` --> EntityTypes having both + * (active: yes) and (env: prod) labels. + * * `labels.env: *` --> Any EntityType which has a label with 'env' as the + * key. + */ + // const filter = 'abc123' + /** + * The maximum number of EntityTypes to return. The service may return fewer + * than this value. If unspecified, at most 1000 EntityTypes will be returned. + * The maximum value is 1000; any value greater than 1000 will be coerced to + * 1000. + */ + // const pageSize = 1234 + /** + * A page token, received from a previous + * FeaturestoreService.ListEntityTypes google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes + * call. Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to + * FeaturestoreService.ListEntityTypes google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes + * must match the call that provided the page token. + */ + // const pageToken = 'abc123' + /** + * A comma-separated list of fields to order by, sorted in ascending order. + * Use "desc" after a field name for descending. + * Supported fields: + * * `entity_type_id` + * * `create_time` + * * `update_time` + */ + // const orderBy = 'abc123' + /** + * Mask specifying which fields to read. + */ + // const readMask = {} + + // Imports the Aiplatform library + const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreServiceClient(); + + async function callListEntityTypes() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listEntityTypesAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListEntityTypes(); + // [END aiplatform_v1beta1_generated_FeaturestoreService_ListEntityTypes_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.list_features.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.list_features.js new file mode 100644 index 00000000000..1c3cec9260c --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.list_features.js @@ -0,0 +1,124 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1beta1_generated_FeaturestoreService_ListFeatures_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to list Features. + * Format: + * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` + */ + // const parent = 'abc123' + /** + * Lists the Features that match the filter expression. The following + * filters are supported: + * * `value_type`: Supports = and != comparisons. + * * `create_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must + * be in RFC 3339 format. + * * `update_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must + * be in RFC 3339 format. + * * `labels`: Supports key-value equality as well as key presence. + * Examples: + * * `value_type = DOUBLE` --> Features whose type is DOUBLE. + * * `create_time > \"2020-01-31T15:30:00.000000Z\" OR + * update_time > \"2020-01-31T15:30:00.000000Z\"` --> EntityTypes created + * or updated after 2020-01-31T15:30:00.000000Z. + * * `labels.active = yes AND labels.env = prod` --> Features having both + * (active: yes) and (env: prod) labels. + * * `labels.env: *` --> Any Feature which has a label with 'env' as the + * key. + */ + // const filter = 'abc123' + /** + * The maximum number of Features to return. The service may return fewer + * than this value. If unspecified, at most 1000 Features will be returned. + * The maximum value is 1000; any value greater than 1000 will be coerced to + * 1000. + */ + // const pageSize = 1234 + /** + * A page token, received from a previous + * FeaturestoreService.ListFeatures google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures + * call. Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to + * FeaturestoreService.ListFeatures google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures + * must match the call that provided the page token. + */ + // const pageToken = 'abc123' + /** + * A comma-separated list of fields to order by, sorted in ascending order. + * Use "desc" after a field name for descending. + * Supported fields: + * * `feature_id` + * * `value_type` + * * `create_time` + * * `update_time` + */ + // const orderBy = 'abc123' + /** + * Mask specifying which fields to read. + */ + // const readMask = {} + /** + * If set, return the most recent + * ListFeaturesRequest.latest_stats_count google.cloud.aiplatform.v1beta1.ListFeaturesRequest.latest_stats_count + * of stats for each Feature in response. Valid value is 0, 10. If number of + * stats exists < + * ListFeaturesRequest.latest_stats_count google.cloud.aiplatform.v1beta1.ListFeaturesRequest.latest_stats_count, + * return all existing stats. + */ + // const latestStatsCount = 1234 + + // Imports the Aiplatform library + const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreServiceClient(); + + async function callListFeatures() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listFeaturesAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListFeatures(); + // [END aiplatform_v1beta1_generated_FeaturestoreService_ListFeatures_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.list_featurestores.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.list_featurestores.js new file mode 100644 index 00000000000..79a0e97a0c4 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.list_featurestores.js @@ -0,0 +1,113 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1beta1_generated_FeaturestoreService_ListFeaturestores_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to list Featurestores. + * Format: + * `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Lists the featurestores that match the filter expression. The following + * fields are supported: + * * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. + * Values must be + * in RFC 3339 format. + * * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. + * Values must be + * in RFC 3339 format. + * * `online_serving_config.fixed_node_count`: Supports `=`, `!=`, `<`, `>`, + * `<=`, and `>=` comparisons. + * * `labels`: Supports key-value equality and key presence. + * Examples: + * * `create_time > "2020-01-01" OR update_time > "2020-01-01"` + * Featurestores created or updated after 2020-01-01. + * * `labels.env = "prod"` + * Featurestores with label "env" set to "prod". + */ + // const filter = 'abc123' + /** + * The maximum number of Featurestores to return. The service may return fewer + * than this value. If unspecified, at most 100 Featurestores will be + * returned. The maximum value is 100; any value greater than 100 will be + * coerced to 100. + */ + // const pageSize = 1234 + /** + * A page token, received from a previous + * FeaturestoreService.ListFeaturestores google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeaturestores + * call. Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to + * FeaturestoreService.ListFeaturestores google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeaturestores + * must match the call that provided the page token. + */ + // const pageToken = 'abc123' + /** + * A comma-separated list of fields to order by, sorted in ascending order. + * Use "desc" after a field name for descending. + * Supported Fields: + * * `create_time` + * * `update_time` + * * `online_serving_config.fixed_node_count` + */ + // const orderBy = 'abc123' + /** + * Mask specifying which fields to read. + */ + // const readMask = {} + + // Imports the Aiplatform library + const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreServiceClient(); + + async function callListFeaturestores() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listFeaturestoresAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListFeaturestores(); + // [END aiplatform_v1beta1_generated_FeaturestoreService_ListFeaturestores_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.search_features.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.search_features.js new file mode 100644 index 00000000000..510c69fbbf2 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.search_features.js @@ -0,0 +1,132 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(location) { + // [START aiplatform_v1beta1_generated_FeaturestoreService_SearchFeatures_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to search Features. + * Format: + * `projects/{project}/locations/{location}` + */ + // const location = 'abc123' + /** + * Query string that is a conjunction of field-restricted queries and/or + * field-restricted filters. Field-restricted queries and filters can be + * combined using `AND` to form a conjunction. + * A field query is in the form FIELD:QUERY. This implicitly checks if QUERY + * exists as a substring within Feature's FIELD. The QUERY + * and the FIELD are converted to a sequence of words (i.e. tokens) for + * comparison. This is done by: + * * Removing leading/trailing whitespace and tokenizing the search value. + * Characters that are not one of alphanumeric `[a-zA-Z0-9]`, underscore + * `_`, or asterisk `*` are treated as delimiters for tokens. `*` is treated + * as a wildcard that matches characters within a token. + * * Ignoring case. + * * Prepending an asterisk to the first and appending an asterisk to the + * last token in QUERY. + * A QUERY must be either a singular token or a phrase. A phrase is one or + * multiple words enclosed in double quotation marks ("). With phrases, the + * order of the words is important. Words in the phrase must be matching in + * order and consecutively. + * Supported FIELDs for field-restricted queries: + * * `feature_id` + * * `description` + * * `entity_type_id` + * Examples: + * * `feature_id: foo` --> Matches a Feature with ID containing the substring + * `foo` (eg. `foo`, `foofeature`, `barfoo`). + * * `feature_id: foo*feature` --> Matches a Feature with ID containing the + * substring `foo*feature` (eg. `foobarfeature`). + * * `feature_id: foo AND description: bar` --> Matches a Feature with ID + * containing the substring `foo` and description containing the substring + * `bar`. + * Besides field queries, the following exact-match filters are + * supported. The exact-match filters do not support wildcards. Unlike + * field-restricted queries, exact-match filters are case-sensitive. + * * `feature_id`: Supports = comparisons. + * * `description`: Supports = comparisons. Multi-token filters should be + * enclosed in quotes. + * * `entity_type_id`: Supports = comparisons. + * * `value_type`: Supports = and != comparisons. + * * `labels`: Supports key-value equality as well as key presence. + * * `featurestore_id`: Supports = comparisons. + * Examples: + * * `description = "foo bar"` --> Any Feature with description exactly equal + * to `foo bar` + * * `value_type = DOUBLE` --> Features whose type is DOUBLE. + * * `labels.active = yes AND labels.env = prod` --> Features having both + * (active: yes) and (env: prod) labels. + * * `labels.env: *` --> Any Feature which has a label with `env` as the + * key. + */ + // const query = 'abc123' + /** + * The maximum number of Features to return. The service may return fewer + * than this value. If unspecified, at most 100 Features will be returned. + * The maximum value is 100; any value greater than 100 will be coerced to + * 100. + */ + // const pageSize = 1234 + /** + * A page token, received from a previous + * FeaturestoreService.SearchFeatures google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures + * call. Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to + * FeaturestoreService.SearchFeatures google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures, + * except `page_size`, must match the call that provided the page token. + */ + // const pageToken = 'abc123' + + // Imports the Aiplatform library + const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreServiceClient(); + + async function callSearchFeatures() { + // Construct request + const request = { + location, + }; + + // Run request + const iterable = await aiplatformClient.searchFeaturesAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callSearchFeatures(); + // [END aiplatform_v1beta1_generated_FeaturestoreService_SearchFeatures_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.update_entity_type.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.update_entity_type.js new file mode 100644 index 00000000000..c44781a7d36 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.update_entity_type.js @@ -0,0 +1,84 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(entityType) { + // [START aiplatform_v1beta1_generated_FeaturestoreService_UpdateEntityType_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The EntityType's `name` field is used to identify the EntityType + * to be updated. Format: + * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` + */ + // const entityType = {} + /** + * Field mask is used to specify the fields to be overwritten in the + * EntityType resource by the update. + * The fields specified in the update_mask are relative to the resource, not + * the full request. A field will be overwritten if it is in the mask. If the + * user does not provide a mask then only the non-empty fields present in the + * request will be overwritten. Set the update_mask to `*` to override all + * fields. + * Updatable fields: + * * `description` + * * `labels` + * * `monitoring_config.snapshot_analysis.disabled` + * * `monitoring_config.snapshot_analysis.monitoring_interval_days` + * * `monitoring_config.snapshot_analysis.staleness_days` + * * `monitoring_config.import_features_analysis.state` + * * `monitoring_config.import_features_analysis.anomaly_detection_baseline` + * * `monitoring_config.numerical_threshold_config.value` + * * `monitoring_config.categorical_threshold_config.value` + * * `offline_storage_ttl_days` (available in Preview) + */ + // const updateMask = {} + + // Imports the Aiplatform library + const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreServiceClient(); + + async function callUpdateEntityType() { + // Construct request + const request = { + entityType, + }; + + // Run request + const response = await aiplatformClient.updateEntityType(request); + console.log(response); + } + + callUpdateEntityType(); + // [END aiplatform_v1beta1_generated_FeaturestoreService_UpdateEntityType_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.update_feature.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.update_feature.js new file mode 100644 index 00000000000..6b6d22f60b1 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.update_feature.js @@ -0,0 +1,78 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(feature) { + // [START aiplatform_v1beta1_generated_FeaturestoreService_UpdateFeature_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The Feature's `name` field is used to identify the Feature to be + * updated. + * Format: + * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` + */ + // const feature = {} + /** + * Field mask is used to specify the fields to be overwritten in the + * Features resource by the update. + * The fields specified in the update_mask are relative to the resource, not + * the full request. A field will be overwritten if it is in the mask. If the + * user does not provide a mask then only the non-empty fields present in the + * request will be overwritten. Set the update_mask to `*` to override all + * fields. + * Updatable fields: + * * `description` + * * `labels` + * * `disable_monitoring` + */ + // const updateMask = {} + + // Imports the Aiplatform library + const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreServiceClient(); + + async function callUpdateFeature() { + // Construct request + const request = { + feature, + }; + + // Run request + const response = await aiplatformClient.updateFeature(request); + console.log(response); + } + + callUpdateFeature(); + // [END aiplatform_v1beta1_generated_FeaturestoreService_UpdateFeature_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.update_featurestore.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.update_featurestore.js new file mode 100644 index 00000000000..00871b21570 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/featurestore_service.update_featurestore.js @@ -0,0 +1,79 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(featurestore) { + // [START aiplatform_v1beta1_generated_FeaturestoreService_UpdateFeaturestore_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The Featurestore's `name` field is used to identify the + * Featurestore to be updated. Format: + * `projects/{project}/locations/{location}/featurestores/{featurestore}` + */ + // const featurestore = {} + /** + * Field mask is used to specify the fields to be overwritten in the + * Featurestore resource by the update. + * The fields specified in the update_mask are relative to the resource, not + * the full request. A field will be overwritten if it is in the mask. If the + * user does not provide a mask then only the non-empty fields present in the + * request will be overwritten. Set the update_mask to `*` to override all + * fields. + * Updatable fields: + * * `labels` + * * `online_serving_config.fixed_node_count` + * * `online_serving_config.scaling` + * * `online_storage_ttl_days` (available in Preview) + */ + // const updateMask = {} + + // Imports the Aiplatform library + const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new FeaturestoreServiceClient(); + + async function callUpdateFeaturestore() { + // Construct request + const request = { + featurestore, + }; + + // Run request + const [operation] = await aiplatformClient.updateFeaturestore(request); + const [response] = await operation.promise(); + console.log(response); + } + + callUpdateFeaturestore(); + // [END aiplatform_v1beta1_generated_FeaturestoreService_UpdateFeaturestore_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_endpoint_service.create_index_endpoint.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_endpoint_service.create_index_endpoint.js new file mode 100644 index 00000000000..20023d6c680 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_endpoint_service.create_index_endpoint.js @@ -0,0 +1,68 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, indexEndpoint) { + // [START aiplatform_v1beta1_generated_IndexEndpointService_CreateIndexEndpoint_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to create the IndexEndpoint in. + * Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Required. The IndexEndpoint to create. + */ + // const indexEndpoint = {} + + // Imports the Aiplatform library + const {IndexEndpointServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new IndexEndpointServiceClient(); + + async function callCreateIndexEndpoint() { + // Construct request + const request = { + parent, + indexEndpoint, + }; + + // Run request + const [operation] = await aiplatformClient.createIndexEndpoint(request); + const [response] = await operation.promise(); + console.log(response); + } + + callCreateIndexEndpoint(); + // [END aiplatform_v1beta1_generated_IndexEndpointService_CreateIndexEndpoint_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_endpoint_service.delete_index_endpoint.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_endpoint_service.delete_index_endpoint.js new file mode 100644 index 00000000000..ef714671639 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_endpoint_service.delete_index_endpoint.js @@ -0,0 +1,64 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_IndexEndpointService_DeleteIndexEndpoint_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the IndexEndpoint resource to be deleted. + * Format: + * `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {IndexEndpointServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new IndexEndpointServiceClient(); + + async function callDeleteIndexEndpoint() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteIndexEndpoint(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteIndexEndpoint(); + // [END aiplatform_v1beta1_generated_IndexEndpointService_DeleteIndexEndpoint_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_endpoint_service.deploy_index.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_endpoint_service.deploy_index.js new file mode 100644 index 00000000000..5cfbe17cf15 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_endpoint_service.deploy_index.js @@ -0,0 +1,69 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(indexEndpoint, deployedIndex) { + // [START aiplatform_v1beta1_generated_IndexEndpointService_DeployIndex_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the IndexEndpoint resource into which to deploy an + * Index. Format: + * `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}` + */ + // const indexEndpoint = 'abc123' + /** + * Required. The DeployedIndex to be created within the IndexEndpoint. + */ + // const deployedIndex = {} + + // Imports the Aiplatform library + const {IndexEndpointServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new IndexEndpointServiceClient(); + + async function callDeployIndex() { + // Construct request + const request = { + indexEndpoint, + deployedIndex, + }; + + // Run request + const [operation] = await aiplatformClient.deployIndex(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeployIndex(); + // [END aiplatform_v1beta1_generated_IndexEndpointService_DeployIndex_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_endpoint_service.get_index_endpoint.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_endpoint_service.get_index_endpoint.js new file mode 100644 index 00000000000..253b5e141ff --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_endpoint_service.get_index_endpoint.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_IndexEndpointService_GetIndexEndpoint_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the IndexEndpoint resource. + * Format: + * `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {IndexEndpointServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new IndexEndpointServiceClient(); + + async function callGetIndexEndpoint() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getIndexEndpoint(request); + console.log(response); + } + + callGetIndexEndpoint(); + // [END aiplatform_v1beta1_generated_IndexEndpointService_GetIndexEndpoint_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_endpoint_service.list_index_endpoints.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_endpoint_service.list_index_endpoints.js new file mode 100644 index 00000000000..98ffac9f9d7 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_endpoint_service.list_index_endpoints.js @@ -0,0 +1,100 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1beta1_generated_IndexEndpointService_ListIndexEndpoints_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location from which to list the + * IndexEndpoints. Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Optional. An expression for filtering the results of the request. For field + * names both snake_case and camelCase are supported. + * * `index_endpoint` supports = and !=. `index_endpoint` represents the + * IndexEndpoint ID, ie. the last segment of the IndexEndpoint's + * resourcename google.cloud.aiplatform.v1beta1.IndexEndpoint.name. + * * `display_name` supports =, != and regex() + * (uses re2 (https://github.com/google/re2/wiki/Syntax) syntax) + * * `labels` supports general map functions that is: + * `labels.key=value` - key:value equality + * `labels.key:* or labels:key - key existence + * A key including a space must be quoted. `labels."a key"`. + * Some examples: + * * `index_endpoint="1"` + * * `display_name="myDisplayName"` + * * `regex(display_name, "^A") -> The display name starts with an A. + * * `labels.myKey="myValue"` + */ + // const filter = 'abc123' + /** + * Optional. The standard list page size. + */ + // const pageSize = 1234 + /** + * Optional. The standard list page token. + * Typically obtained via + * ListIndexEndpointsResponse.next_page_token google.cloud.aiplatform.v1beta1.ListIndexEndpointsResponse.next_page_token + * of the previous + * IndexEndpointService.ListIndexEndpoints google.cloud.aiplatform.v1beta1.IndexEndpointService.ListIndexEndpoints + * call. + */ + // const pageToken = 'abc123' + /** + * Optional. Mask specifying which fields to read. + */ + // const readMask = {} + + // Imports the Aiplatform library + const {IndexEndpointServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new IndexEndpointServiceClient(); + + async function callListIndexEndpoints() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listIndexEndpointsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListIndexEndpoints(); + // [END aiplatform_v1beta1_generated_IndexEndpointService_ListIndexEndpoints_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_endpoint_service.mutate_deployed_index.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_endpoint_service.mutate_deployed_index.js new file mode 100644 index 00000000000..0cd8d6f249d --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_endpoint_service.mutate_deployed_index.js @@ -0,0 +1,71 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(indexEndpoint, deployedIndex) { + // [START aiplatform_v1beta1_generated_IndexEndpointService_MutateDeployedIndex_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the IndexEndpoint resource into which to deploy an + * Index. Format: + * `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}` + */ + // const indexEndpoint = 'abc123' + /** + * Required. The DeployedIndex to be updated within the IndexEndpoint. + * Currently, the updatable fields are DeployedIndex automatic_resources + * and DeployedIndex dedicated_resources + */ + // const deployedIndex = {} + + // Imports the Aiplatform library + const {IndexEndpointServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new IndexEndpointServiceClient(); + + async function callMutateDeployedIndex() { + // Construct request + const request = { + indexEndpoint, + deployedIndex, + }; + + // Run request + const [operation] = await aiplatformClient.mutateDeployedIndex(request); + const [response] = await operation.promise(); + console.log(response); + } + + callMutateDeployedIndex(); + // [END aiplatform_v1beta1_generated_IndexEndpointService_MutateDeployedIndex_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_endpoint_service.undeploy_index.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_endpoint_service.undeploy_index.js new file mode 100644 index 00000000000..122445276ae --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_endpoint_service.undeploy_index.js @@ -0,0 +1,70 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(indexEndpoint, deployedIndexId) { + // [START aiplatform_v1beta1_generated_IndexEndpointService_UndeployIndex_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the IndexEndpoint resource from which to undeploy an + * Index. Format: + * `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}` + */ + // const indexEndpoint = 'abc123' + /** + * Required. The ID of the DeployedIndex to be undeployed from the + * IndexEndpoint. + */ + // const deployedIndexId = 'abc123' + + // Imports the Aiplatform library + const {IndexEndpointServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new IndexEndpointServiceClient(); + + async function callUndeployIndex() { + // Construct request + const request = { + indexEndpoint, + deployedIndexId, + }; + + // Run request + const [operation] = await aiplatformClient.undeployIndex(request); + const [response] = await operation.promise(); + console.log(response); + } + + callUndeployIndex(); + // [END aiplatform_v1beta1_generated_IndexEndpointService_UndeployIndex_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_endpoint_service.update_index_endpoint.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_endpoint_service.update_index_endpoint.js new file mode 100644 index 00000000000..7b8239ccb38 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_endpoint_service.update_index_endpoint.js @@ -0,0 +1,67 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(indexEndpoint, updateMask) { + // [START aiplatform_v1beta1_generated_IndexEndpointService_UpdateIndexEndpoint_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The IndexEndpoint which replaces the resource on the server. + */ + // const indexEndpoint = {} + /** + * Required. The update mask applies to the resource. See + * google.protobuf.FieldMask google.protobuf.FieldMask. + */ + // const updateMask = {} + + // Imports the Aiplatform library + const {IndexEndpointServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new IndexEndpointServiceClient(); + + async function callUpdateIndexEndpoint() { + // Construct request + const request = { + indexEndpoint, + updateMask, + }; + + // Run request + const response = await aiplatformClient.updateIndexEndpoint(request); + console.log(response); + } + + callUpdateIndexEndpoint(); + // [END aiplatform_v1beta1_generated_IndexEndpointService_UpdateIndexEndpoint_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_service.create_index.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_service.create_index.js new file mode 100644 index 00000000000..0fe1ddb1022 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_service.create_index.js @@ -0,0 +1,68 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, index) { + // [START aiplatform_v1beta1_generated_IndexService_CreateIndex_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to create the Index in. + * Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Required. The Index to create. + */ + // const index = {} + + // Imports the Aiplatform library + const {IndexServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new IndexServiceClient(); + + async function callCreateIndex() { + // Construct request + const request = { + parent, + index, + }; + + // Run request + const [operation] = await aiplatformClient.createIndex(request); + const [response] = await operation.promise(); + console.log(response); + } + + callCreateIndex(); + // [END aiplatform_v1beta1_generated_IndexService_CreateIndex_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_service.delete_index.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_service.delete_index.js new file mode 100644 index 00000000000..4721cb4cd02 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_service.delete_index.js @@ -0,0 +1,64 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_IndexService_DeleteIndex_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Index resource to be deleted. + * Format: + * `projects/{project}/locations/{location}/indexes/{index}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {IndexServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new IndexServiceClient(); + + async function callDeleteIndex() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteIndex(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteIndex(); + // [END aiplatform_v1beta1_generated_IndexService_DeleteIndex_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_service.get_index.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_service.get_index.js new file mode 100644 index 00000000000..7f7a392057a --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_service.get_index.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_IndexService_GetIndex_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Index resource. + * Format: + * `projects/{project}/locations/{location}/indexes/{index}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {IndexServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new IndexServiceClient(); + + async function callGetIndex() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getIndex(request); + console.log(response); + } + + callGetIndex(); + // [END aiplatform_v1beta1_generated_IndexService_GetIndex_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_service.list_indexes.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_service.list_indexes.js new file mode 100644 index 00000000000..5d5d67a1f83 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_service.list_indexes.js @@ -0,0 +1,85 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1beta1_generated_IndexService_ListIndexes_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location from which to list the Indexes. + * Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * The standard list filter. + */ + // const filter = 'abc123' + /** + * The standard list page size. + */ + // const pageSize = 1234 + /** + * The standard list page token. + * Typically obtained via + * ListIndexesResponse.next_page_token google.cloud.aiplatform.v1beta1.ListIndexesResponse.next_page_token + * of the previous + * IndexService.ListIndexes google.cloud.aiplatform.v1beta1.IndexService.ListIndexes + * call. + */ + // const pageToken = 'abc123' + /** + * Mask specifying which fields to read. + */ + // const readMask = {} + + // Imports the Aiplatform library + const {IndexServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new IndexServiceClient(); + + async function callListIndexes() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listIndexesAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListIndexes(); + // [END aiplatform_v1beta1_generated_IndexService_ListIndexes_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_service.remove_datapoints.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_service.remove_datapoints.js new file mode 100644 index 00000000000..25bdf8eeaa8 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_service.remove_datapoints.js @@ -0,0 +1,67 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(index) { + // [START aiplatform_v1beta1_generated_IndexService_RemoveDatapoints_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Index resource to be updated. + * Format: + * `projects/{project}/locations/{location}/indexes/{index}` + */ + // const index = 'abc123' + /** + * A list of datapoint ids to be deleted. + */ + // const datapointIds = 'abc123' + + // Imports the Aiplatform library + const {IndexServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new IndexServiceClient(); + + async function callRemoveDatapoints() { + // Construct request + const request = { + index, + }; + + // Run request + const response = await aiplatformClient.removeDatapoints(request); + console.log(response); + } + + callRemoveDatapoints(); + // [END aiplatform_v1beta1_generated_IndexService_RemoveDatapoints_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_service.update_index.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_service.update_index.js new file mode 100644 index 00000000000..2c32aa7f2f8 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_service.update_index.js @@ -0,0 +1,68 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(index) { + // [START aiplatform_v1beta1_generated_IndexService_UpdateIndex_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The Index which updates the resource on the server. + */ + // const index = {} + /** + * The update mask applies to the resource. + * For the `FieldMask` definition, see + * google.protobuf.FieldMask google.protobuf.FieldMask. + */ + // const updateMask = {} + + // Imports the Aiplatform library + const {IndexServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new IndexServiceClient(); + + async function callUpdateIndex() { + // Construct request + const request = { + index, + }; + + // Run request + const [operation] = await aiplatformClient.updateIndex(request); + const [response] = await operation.promise(); + console.log(response); + } + + callUpdateIndex(); + // [END aiplatform_v1beta1_generated_IndexService_UpdateIndex_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_service.upsert_datapoints.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_service.upsert_datapoints.js new file mode 100644 index 00000000000..0fd92c020bd --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/index_service.upsert_datapoints.js @@ -0,0 +1,67 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(index) { + // [START aiplatform_v1beta1_generated_IndexService_UpsertDatapoints_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Index resource to be updated. + * Format: + * `projects/{project}/locations/{location}/indexes/{index}` + */ + // const index = 'abc123' + /** + * A list of datapoints to be created/updated. + */ + // const datapoints = 1234 + + // Imports the Aiplatform library + const {IndexServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new IndexServiceClient(); + + async function callUpsertDatapoints() { + // Construct request + const request = { + index, + }; + + // Run request + const response = await aiplatformClient.upsertDatapoints(request); + console.log(response); + } + + callUpsertDatapoints(); + // [END aiplatform_v1beta1_generated_IndexService_UpsertDatapoints_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.cancel_batch_prediction_job.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.cancel_batch_prediction_job.js new file mode 100644 index 00000000000..2bdb9a16070 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.cancel_batch_prediction_job.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_JobService_CancelBatchPredictionJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the BatchPredictionJob to cancel. + * Format: + * `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callCancelBatchPredictionJob() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.cancelBatchPredictionJob(request); + console.log(response); + } + + callCancelBatchPredictionJob(); + // [END aiplatform_v1beta1_generated_JobService_CancelBatchPredictionJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.cancel_custom_job.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.cancel_custom_job.js new file mode 100644 index 00000000000..9618a3f5eac --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.cancel_custom_job.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_JobService_CancelCustomJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the CustomJob to cancel. + * Format: + * `projects/{project}/locations/{location}/customJobs/{custom_job}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callCancelCustomJob() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.cancelCustomJob(request); + console.log(response); + } + + callCancelCustomJob(); + // [END aiplatform_v1beta1_generated_JobService_CancelCustomJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.cancel_data_labeling_job.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.cancel_data_labeling_job.js new file mode 100644 index 00000000000..ff3a320319d --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.cancel_data_labeling_job.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_JobService_CancelDataLabelingJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the DataLabelingJob. + * Format: + * `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callCancelDataLabelingJob() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.cancelDataLabelingJob(request); + console.log(response); + } + + callCancelDataLabelingJob(); + // [END aiplatform_v1beta1_generated_JobService_CancelDataLabelingJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.cancel_hyperparameter_tuning_job.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.cancel_hyperparameter_tuning_job.js new file mode 100644 index 00000000000..40457e03c47 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.cancel_hyperparameter_tuning_job.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_JobService_CancelHyperparameterTuningJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the HyperparameterTuningJob to cancel. + * Format: + * `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callCancelHyperparameterTuningJob() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.cancelHyperparameterTuningJob(request); + console.log(response); + } + + callCancelHyperparameterTuningJob(); + // [END aiplatform_v1beta1_generated_JobService_CancelHyperparameterTuningJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.create_batch_prediction_job.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.create_batch_prediction_job.js new file mode 100644 index 00000000000..b83fa1360d9 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.create_batch_prediction_job.js @@ -0,0 +1,67 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, batchPredictionJob) { + // [START aiplatform_v1beta1_generated_JobService_CreateBatchPredictionJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to create the + * BatchPredictionJob in. Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Required. The BatchPredictionJob to create. + */ + // const batchPredictionJob = {} + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callCreateBatchPredictionJob() { + // Construct request + const request = { + parent, + batchPredictionJob, + }; + + // Run request + const response = await aiplatformClient.createBatchPredictionJob(request); + console.log(response); + } + + callCreateBatchPredictionJob(); + // [END aiplatform_v1beta1_generated_JobService_CreateBatchPredictionJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.create_custom_job.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.create_custom_job.js new file mode 100644 index 00000000000..2a132ebf63f --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.create_custom_job.js @@ -0,0 +1,67 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, customJob) { + // [START aiplatform_v1beta1_generated_JobService_CreateCustomJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to create the CustomJob in. + * Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Required. The CustomJob to create. + */ + // const customJob = {} + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callCreateCustomJob() { + // Construct request + const request = { + parent, + customJob, + }; + + // Run request + const response = await aiplatformClient.createCustomJob(request); + console.log(response); + } + + callCreateCustomJob(); + // [END aiplatform_v1beta1_generated_JobService_CreateCustomJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.create_data_labeling_job.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.create_data_labeling_job.js new file mode 100644 index 00000000000..8798493872e --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.create_data_labeling_job.js @@ -0,0 +1,67 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, dataLabelingJob) { + // [START aiplatform_v1beta1_generated_JobService_CreateDataLabelingJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The parent of the DataLabelingJob. + * Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Required. The DataLabelingJob to create. + */ + // const dataLabelingJob = {} + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callCreateDataLabelingJob() { + // Construct request + const request = { + parent, + dataLabelingJob, + }; + + // Run request + const response = await aiplatformClient.createDataLabelingJob(request); + console.log(response); + } + + callCreateDataLabelingJob(); + // [END aiplatform_v1beta1_generated_JobService_CreateDataLabelingJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.create_hyperparameter_tuning_job.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.create_hyperparameter_tuning_job.js new file mode 100644 index 00000000000..ce08c5cdf1e --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.create_hyperparameter_tuning_job.js @@ -0,0 +1,68 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, hyperparameterTuningJob) { + // [START aiplatform_v1beta1_generated_JobService_CreateHyperparameterTuningJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to create the + * HyperparameterTuningJob in. Format: + * `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Required. The HyperparameterTuningJob to create. + */ + // const hyperparameterTuningJob = {} + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callCreateHyperparameterTuningJob() { + // Construct request + const request = { + parent, + hyperparameterTuningJob, + }; + + // Run request + const response = await aiplatformClient.createHyperparameterTuningJob(request); + console.log(response); + } + + callCreateHyperparameterTuningJob(); + // [END aiplatform_v1beta1_generated_JobService_CreateHyperparameterTuningJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.create_model_deployment_monitoring_job.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.create_model_deployment_monitoring_job.js new file mode 100644 index 00000000000..5e45279b04a --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.create_model_deployment_monitoring_job.js @@ -0,0 +1,67 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, modelDeploymentMonitoringJob) { + // [START aiplatform_v1beta1_generated_JobService_CreateModelDeploymentMonitoringJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The parent of the ModelDeploymentMonitoringJob. + * Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Required. The ModelDeploymentMonitoringJob to create + */ + // const modelDeploymentMonitoringJob = {} + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callCreateModelDeploymentMonitoringJob() { + // Construct request + const request = { + parent, + modelDeploymentMonitoringJob, + }; + + // Run request + const response = await aiplatformClient.createModelDeploymentMonitoringJob(request); + console.log(response); + } + + callCreateModelDeploymentMonitoringJob(); + // [END aiplatform_v1beta1_generated_JobService_CreateModelDeploymentMonitoringJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.delete_batch_prediction_job.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.delete_batch_prediction_job.js new file mode 100644 index 00000000000..244a14cd222 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.delete_batch_prediction_job.js @@ -0,0 +1,64 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_JobService_DeleteBatchPredictionJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the BatchPredictionJob resource to be deleted. + * Format: + * `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callDeleteBatchPredictionJob() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteBatchPredictionJob(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteBatchPredictionJob(); + // [END aiplatform_v1beta1_generated_JobService_DeleteBatchPredictionJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.delete_custom_job.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.delete_custom_job.js new file mode 100644 index 00000000000..378f3d1465b --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.delete_custom_job.js @@ -0,0 +1,64 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_JobService_DeleteCustomJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the CustomJob resource to be deleted. + * Format: + * `projects/{project}/locations/{location}/customJobs/{custom_job}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callDeleteCustomJob() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteCustomJob(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteCustomJob(); + // [END aiplatform_v1beta1_generated_JobService_DeleteCustomJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.delete_data_labeling_job.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.delete_data_labeling_job.js new file mode 100644 index 00000000000..e3af9ee1ca7 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.delete_data_labeling_job.js @@ -0,0 +1,64 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_JobService_DeleteDataLabelingJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the DataLabelingJob to be deleted. + * Format: + * `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callDeleteDataLabelingJob() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteDataLabelingJob(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteDataLabelingJob(); + // [END aiplatform_v1beta1_generated_JobService_DeleteDataLabelingJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.delete_hyperparameter_tuning_job.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.delete_hyperparameter_tuning_job.js new file mode 100644 index 00000000000..52a18b059e8 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.delete_hyperparameter_tuning_job.js @@ -0,0 +1,64 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_JobService_DeleteHyperparameterTuningJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the HyperparameterTuningJob resource to be deleted. + * Format: + * `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callDeleteHyperparameterTuningJob() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteHyperparameterTuningJob(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteHyperparameterTuningJob(); + // [END aiplatform_v1beta1_generated_JobService_DeleteHyperparameterTuningJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.delete_model_deployment_monitoring_job.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.delete_model_deployment_monitoring_job.js new file mode 100644 index 00000000000..3d0b41131d5 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.delete_model_deployment_monitoring_job.js @@ -0,0 +1,64 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_JobService_DeleteModelDeploymentMonitoringJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the model monitoring job to delete. + * Format: + * `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callDeleteModelDeploymentMonitoringJob() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteModelDeploymentMonitoringJob(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteModelDeploymentMonitoringJob(); + // [END aiplatform_v1beta1_generated_JobService_DeleteModelDeploymentMonitoringJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.get_batch_prediction_job.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.get_batch_prediction_job.js new file mode 100644 index 00000000000..7015d8a6759 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.get_batch_prediction_job.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_JobService_GetBatchPredictionJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the BatchPredictionJob resource. + * Format: + * `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callGetBatchPredictionJob() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getBatchPredictionJob(request); + console.log(response); + } + + callGetBatchPredictionJob(); + // [END aiplatform_v1beta1_generated_JobService_GetBatchPredictionJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.get_custom_job.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.get_custom_job.js new file mode 100644 index 00000000000..fda2b9346a6 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.get_custom_job.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_JobService_GetCustomJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the CustomJob resource. + * Format: + * `projects/{project}/locations/{location}/customJobs/{custom_job}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callGetCustomJob() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getCustomJob(request); + console.log(response); + } + + callGetCustomJob(); + // [END aiplatform_v1beta1_generated_JobService_GetCustomJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.get_data_labeling_job.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.get_data_labeling_job.js new file mode 100644 index 00000000000..c6f21b62e1c --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.get_data_labeling_job.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_JobService_GetDataLabelingJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the DataLabelingJob. + * Format: + * `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callGetDataLabelingJob() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getDataLabelingJob(request); + console.log(response); + } + + callGetDataLabelingJob(); + // [END aiplatform_v1beta1_generated_JobService_GetDataLabelingJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.get_hyperparameter_tuning_job.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.get_hyperparameter_tuning_job.js new file mode 100644 index 00000000000..1dc82428c44 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.get_hyperparameter_tuning_job.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_JobService_GetHyperparameterTuningJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the HyperparameterTuningJob resource. + * Format: + * `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callGetHyperparameterTuningJob() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getHyperparameterTuningJob(request); + console.log(response); + } + + callGetHyperparameterTuningJob(); + // [END aiplatform_v1beta1_generated_JobService_GetHyperparameterTuningJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.get_model_deployment_monitoring_job.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.get_model_deployment_monitoring_job.js new file mode 100644 index 00000000000..519eab4d6cd --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.get_model_deployment_monitoring_job.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_JobService_GetModelDeploymentMonitoringJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the ModelDeploymentMonitoringJob. + * Format: + * `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callGetModelDeploymentMonitoringJob() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getModelDeploymentMonitoringJob(request); + console.log(response); + } + + callGetModelDeploymentMonitoringJob(); + // [END aiplatform_v1beta1_generated_JobService_GetModelDeploymentMonitoringJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.list_batch_prediction_jobs.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.list_batch_prediction_jobs.js new file mode 100644 index 00000000000..21e0f3b4a74 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.list_batch_prediction_jobs.js @@ -0,0 +1,101 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1beta1_generated_JobService_ListBatchPredictionJobs_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to list the BatchPredictionJobs + * from. Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * The standard list filter. + * Supported fields: + * * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. + * * `model_display_name` supports `=`, `!=` comparisons. + * * `state` supports `=`, `!=` comparisons. + * * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. + * `create_time` must be in RFC 3339 format. + * * `labels` supports general map functions that is: + * `labels.key=value` - key:value equality + * `labels.key:* - key existence + * Some examples of using the filter are: + * * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` + * * `state!="JOB_STATE_FAILED" OR display_name="my_job"` + * * `NOT display_name="my_job"` + * * `create_time>"2021-05-18T00:00:00Z"` + * * `labels.keyA=valueA` + * * `labels.keyB:*` + */ + // const filter = 'abc123' + /** + * The standard list page size. + */ + // const pageSize = 1234 + /** + * The standard list page token. + * Typically obtained via + * ListBatchPredictionJobsResponse.next_page_token google.cloud.aiplatform.v1beta1.ListBatchPredictionJobsResponse.next_page_token + * of the previous + * JobService.ListBatchPredictionJobs google.cloud.aiplatform.v1beta1.JobService.ListBatchPredictionJobs + * call. + */ + // const pageToken = 'abc123' + /** + * Mask specifying which fields to read. + */ + // const readMask = {} + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callListBatchPredictionJobs() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listBatchPredictionJobsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListBatchPredictionJobs(); + // [END aiplatform_v1beta1_generated_JobService_ListBatchPredictionJobs_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.list_custom_jobs.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.list_custom_jobs.js new file mode 100644 index 00000000000..a5e5007e8e5 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.list_custom_jobs.js @@ -0,0 +1,100 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1beta1_generated_JobService_ListCustomJobs_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to list the CustomJobs from. + * Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * The standard list filter. + * Supported fields: + * * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. + * * `state` supports `=`, `!=` comparisons. + * * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. + * `create_time` must be in RFC 3339 format. + * * `labels` supports general map functions that is: + * `labels.key=value` - key:value equality + * `labels.key:* - key existence + * Some examples of using the filter are: + * * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` + * * `state!="JOB_STATE_FAILED" OR display_name="my_job"` + * * `NOT display_name="my_job"` + * * `create_time>"2021-05-18T00:00:00Z"` + * * `labels.keyA=valueA` + * * `labels.keyB:*` + */ + // const filter = 'abc123' + /** + * The standard list page size. + */ + // const pageSize = 1234 + /** + * The standard list page token. + * Typically obtained via + * ListCustomJobsResponse.next_page_token google.cloud.aiplatform.v1beta1.ListCustomJobsResponse.next_page_token + * of the previous + * JobService.ListCustomJobs google.cloud.aiplatform.v1beta1.JobService.ListCustomJobs + * call. + */ + // const pageToken = 'abc123' + /** + * Mask specifying which fields to read. + */ + // const readMask = {} + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callListCustomJobs() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listCustomJobsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListCustomJobs(); + // [END aiplatform_v1beta1_generated_JobService_ListCustomJobs_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.list_data_labeling_jobs.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.list_data_labeling_jobs.js new file mode 100644 index 00000000000..85d44dfd0b2 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.list_data_labeling_jobs.js @@ -0,0 +1,104 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1beta1_generated_JobService_ListDataLabelingJobs_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The parent of the DataLabelingJob. + * Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * The standard list filter. + * Supported fields: + * * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. + * * `state` supports `=`, `!=` comparisons. + * * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. + * `create_time` must be in RFC 3339 format. + * * `labels` supports general map functions that is: + * `labels.key=value` - key:value equality + * `labels.key:* - key existence + * Some examples of using the filter are: + * * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` + * * `state!="JOB_STATE_FAILED" OR display_name="my_job"` + * * `NOT display_name="my_job"` + * * `create_time>"2021-05-18T00:00:00Z"` + * * `labels.keyA=valueA` + * * `labels.keyB:*` + */ + // const filter = 'abc123' + /** + * The standard list page size. + */ + // const pageSize = 1234 + /** + * The standard list page token. + */ + // const pageToken = 'abc123' + /** + * Mask specifying which fields to read. FieldMask represents a set of + * symbolic field paths. For example, the mask can be `paths: "name"`. The + * "name" here is a field in DataLabelingJob. + * If this field is not set, all fields of the DataLabelingJob are returned. + */ + // const readMask = {} + /** + * A comma-separated list of fields to order by, sorted in ascending order by + * default. + * Use `desc` after a field name for descending. + */ + // const orderBy = 'abc123' + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callListDataLabelingJobs() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listDataLabelingJobsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListDataLabelingJobs(); + // [END aiplatform_v1beta1_generated_JobService_ListDataLabelingJobs_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.list_hyperparameter_tuning_jobs.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.list_hyperparameter_tuning_jobs.js new file mode 100644 index 00000000000..c5946a20d90 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.list_hyperparameter_tuning_jobs.js @@ -0,0 +1,101 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1beta1_generated_JobService_ListHyperparameterTuningJobs_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to list the + * HyperparameterTuningJobs from. Format: + * `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * The standard list filter. + * Supported fields: + * * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. + * * `state` supports `=`, `!=` comparisons. + * * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. + * `create_time` must be in RFC 3339 format. + * * `labels` supports general map functions that is: + * `labels.key=value` - key:value equality + * `labels.key:* - key existence + * Some examples of using the filter are: + * * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` + * * `state!="JOB_STATE_FAILED" OR display_name="my_job"` + * * `NOT display_name="my_job"` + * * `create_time>"2021-05-18T00:00:00Z"` + * * `labels.keyA=valueA` + * * `labels.keyB:*` + */ + // const filter = 'abc123' + /** + * The standard list page size. + */ + // const pageSize = 1234 + /** + * The standard list page token. + * Typically obtained via + * ListHyperparameterTuningJobsResponse.next_page_token google.cloud.aiplatform.v1beta1.ListHyperparameterTuningJobsResponse.next_page_token + * of the previous + * JobService.ListHyperparameterTuningJobs google.cloud.aiplatform.v1beta1.JobService.ListHyperparameterTuningJobs + * call. + */ + // const pageToken = 'abc123' + /** + * Mask specifying which fields to read. + */ + // const readMask = {} + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callListHyperparameterTuningJobs() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listHyperparameterTuningJobsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListHyperparameterTuningJobs(); + // [END aiplatform_v1beta1_generated_JobService_ListHyperparameterTuningJobs_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.list_model_deployment_monitoring_jobs.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.list_model_deployment_monitoring_jobs.js new file mode 100644 index 00000000000..9810f7734a5 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.list_model_deployment_monitoring_jobs.js @@ -0,0 +1,95 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1beta1_generated_JobService_ListModelDeploymentMonitoringJobs_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The parent of the ModelDeploymentMonitoringJob. + * Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * The standard list filter. + * Supported fields: + * * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. + * * `state` supports `=`, `!=` comparisons. + * * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. + * `create_time` must be in RFC 3339 format. + * * `labels` supports general map functions that is: + * `labels.key=value` - key:value equality + * `labels.key:* - key existence + * Some examples of using the filter are: + * * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` + * * `state!="JOB_STATE_FAILED" OR display_name="my_job"` + * * `NOT display_name="my_job"` + * * `create_time>"2021-05-18T00:00:00Z"` + * * `labels.keyA=valueA` + * * `labels.keyB:*` + */ + // const filter = 'abc123' + /** + * The standard list page size. + */ + // const pageSize = 1234 + /** + * The standard list page token. + */ + // const pageToken = 'abc123' + /** + * Mask specifying which fields to read + */ + // const readMask = {} + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callListModelDeploymentMonitoringJobs() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listModelDeploymentMonitoringJobsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListModelDeploymentMonitoringJobs(); + // [END aiplatform_v1beta1_generated_JobService_ListModelDeploymentMonitoringJobs_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.pause_model_deployment_monitoring_job.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.pause_model_deployment_monitoring_job.js new file mode 100644 index 00000000000..96e39e59a47 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.pause_model_deployment_monitoring_job.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_JobService_PauseModelDeploymentMonitoringJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the ModelDeploymentMonitoringJob to pause. + * Format: + * `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callPauseModelDeploymentMonitoringJob() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.pauseModelDeploymentMonitoringJob(request); + console.log(response); + } + + callPauseModelDeploymentMonitoringJob(); + // [END aiplatform_v1beta1_generated_JobService_PauseModelDeploymentMonitoringJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.resume_model_deployment_monitoring_job.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.resume_model_deployment_monitoring_job.js new file mode 100644 index 00000000000..cd60f35dabc --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.resume_model_deployment_monitoring_job.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_JobService_ResumeModelDeploymentMonitoringJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the ModelDeploymentMonitoringJob to resume. + * Format: + * `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callResumeModelDeploymentMonitoringJob() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.resumeModelDeploymentMonitoringJob(request); + console.log(response); + } + + callResumeModelDeploymentMonitoringJob(); + // [END aiplatform_v1beta1_generated_JobService_ResumeModelDeploymentMonitoringJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.search_model_deployment_monitoring_stats_anomalies.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.search_model_deployment_monitoring_stats_anomalies.js new file mode 100644 index 00000000000..b50912a9af3 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.search_model_deployment_monitoring_stats_anomalies.js @@ -0,0 +1,103 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(modelDeploymentMonitoringJob, deployedModelId, objectives) { + // [START aiplatform_v1beta1_generated_JobService_SearchModelDeploymentMonitoringStatsAnomalies_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. ModelDeploymentMonitoring Job resource name. + * Format: + * `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}` + */ + // const modelDeploymentMonitoringJob = 'abc123' + /** + * Required. The DeployedModel ID of the + * ModelDeploymentMonitoringObjectiveConfig.deployed_model_id. + */ + // const deployedModelId = 'abc123' + /** + * The feature display name. If specified, only return the stats belonging to + * this feature. Format: + * ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name google.cloud.aiplatform.v1beta1.ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name, + * example: "user_destination". + */ + // const featureDisplayName = 'abc123' + /** + * Required. Objectives of the stats to retrieve. + */ + // const objectives = 1234 + /** + * The standard list page size. + */ + // const pageSize = 1234 + /** + * A page token received from a previous + * JobService.SearchModelDeploymentMonitoringStatsAnomalies google.cloud.aiplatform.v1beta1.JobService.SearchModelDeploymentMonitoringStatsAnomalies + * call. + */ + // const pageToken = 'abc123' + /** + * The earliest timestamp of stats being generated. + * If not set, indicates fetching stats till the earliest possible one. + */ + // const startTime = {} + /** + * The latest timestamp of stats being generated. + * If not set, indicates feching stats till the latest possible one. + */ + // const endTime = {} + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callSearchModelDeploymentMonitoringStatsAnomalies() { + // Construct request + const request = { + modelDeploymentMonitoringJob, + deployedModelId, + objectives, + }; + + // Run request + const iterable = await aiplatformClient.searchModelDeploymentMonitoringStatsAnomaliesAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callSearchModelDeploymentMonitoringStatsAnomalies(); + // [END aiplatform_v1beta1_generated_JobService_SearchModelDeploymentMonitoringStatsAnomalies_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.update_model_deployment_monitoring_job.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.update_model_deployment_monitoring_job.js new file mode 100644 index 00000000000..45afcfb153d --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/job_service.update_model_deployment_monitoring_job.js @@ -0,0 +1,91 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(modelDeploymentMonitoringJob, updateMask) { + // [START aiplatform_v1beta1_generated_JobService_UpdateModelDeploymentMonitoringJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The model monitoring configuration which replaces the resource on + * the server. + */ + // const modelDeploymentMonitoringJob = {} + /** + * Required. The update mask is used to specify the fields to be overwritten + * in the ModelDeploymentMonitoringJob resource by the update. The fields + * specified in the update_mask are relative to the resource, not the full + * request. A field will be overwritten if it is in the mask. If the user does + * not provide a mask then only the non-empty fields present in the request + * will be overwritten. Set the update_mask to `*` to override all fields. For + * the objective config, the user can either provide the update mask for + * model_deployment_monitoring_objective_configs or any combination of its + * nested fields, such as: + * model_deployment_monitoring_objective_configs.objective_config.training_dataset. + * Updatable fields: + * * `display_name` + * * `model_deployment_monitoring_schedule_config` + * * `model_monitoring_alert_config` + * * `logging_sampling_strategy` + * * `labels` + * * `log_ttl` + * * `enable_monitoring_pipeline_logs` + * . and + * * `model_deployment_monitoring_objective_configs` + * . or + * * `model_deployment_monitoring_objective_configs.objective_config.training_dataset` + * * `model_deployment_monitoring_objective_configs.objective_config.training_prediction_skew_detection_config` + * * `model_deployment_monitoring_objective_configs.objective_config.prediction_drift_detection_config` + */ + // const updateMask = {} + + // Imports the Aiplatform library + const {JobServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new JobServiceClient(); + + async function callUpdateModelDeploymentMonitoringJob() { + // Construct request + const request = { + modelDeploymentMonitoringJob, + updateMask, + }; + + // Run request + const [operation] = await aiplatformClient.updateModelDeploymentMonitoringJob(request); + const [response] = await operation.promise(); + console.log(response); + } + + callUpdateModelDeploymentMonitoringJob(); + // [END aiplatform_v1beta1_generated_JobService_UpdateModelDeploymentMonitoringJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.add_context_artifacts_and_executions.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.add_context_artifacts_and_executions.js new file mode 100644 index 00000000000..ed7d9cc0acf --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.add_context_artifacts_and_executions.js @@ -0,0 +1,76 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(context) { + // [START aiplatform_v1beta1_generated_MetadataService_AddContextArtifactsAndExecutions_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Context that the Artifacts and + * Executions belong to. Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}` + */ + // const context = 'abc123' + /** + * The resource names of the Artifacts to attribute to the Context. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` + */ + // const artifacts = 'abc123' + /** + * The resource names of the Executions to associate with the + * Context. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` + */ + // const executions = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callAddContextArtifactsAndExecutions() { + // Construct request + const request = { + context, + }; + + // Run request + const response = await aiplatformClient.addContextArtifactsAndExecutions(request); + console.log(response); + } + + callAddContextArtifactsAndExecutions(); + // [END aiplatform_v1beta1_generated_MetadataService_AddContextArtifactsAndExecutions_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.add_context_children.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.add_context_children.js new file mode 100644 index 00000000000..01baae68bfb --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.add_context_children.js @@ -0,0 +1,67 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(context) { + // [START aiplatform_v1beta1_generated_MetadataService_AddContextChildren_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the parent Context. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}` + */ + // const context = 'abc123' + /** + * The resource names of the child Contexts. + */ + // const childContexts = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callAddContextChildren() { + // Construct request + const request = { + context, + }; + + // Run request + const response = await aiplatformClient.addContextChildren(request); + console.log(response); + } + + callAddContextChildren(); + // [END aiplatform_v1beta1_generated_MetadataService_AddContextChildren_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.add_execution_events.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.add_execution_events.js new file mode 100644 index 00000000000..d0d5f16e1f2 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.add_execution_events.js @@ -0,0 +1,68 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(execution) { + // [START aiplatform_v1beta1_generated_MetadataService_AddExecutionEvents_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Execution that the Events connect + * Artifacts with. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` + */ + // const execution = 'abc123' + /** + * The Events to create and add. + */ + // const events = 1234 + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callAddExecutionEvents() { + // Construct request + const request = { + execution, + }; + + // Run request + const response = await aiplatformClient.addExecutionEvents(request); + console.log(response); + } + + callAddExecutionEvents(); + // [END aiplatform_v1beta1_generated_MetadataService_AddExecutionEvents_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.create_artifact.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.create_artifact.js new file mode 100644 index 00000000000..635716dded4 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.create_artifact.js @@ -0,0 +1,79 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, artifact) { + // [START aiplatform_v1beta1_generated_MetadataService_CreateArtifact_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the MetadataStore where the Artifact should + * be created. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}` + */ + // const parent = 'abc123' + /** + * Required. The Artifact to create. + */ + // const artifact = {} + /** + * The {artifact} portion of the resource name with the format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` + * If not provided, the Artifact's ID will be a UUID generated by the service. + * Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`. + * Must be unique across all Artifacts in the parent MetadataStore. (Otherwise + * the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the + * caller can't view the preexisting Artifact.) + */ + // const artifactId = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callCreateArtifact() { + // Construct request + const request = { + parent, + artifact, + }; + + // Run request + const response = await aiplatformClient.createArtifact(request); + console.log(response); + } + + callCreateArtifact(); + // [END aiplatform_v1beta1_generated_MetadataService_CreateArtifact_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.create_context.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.create_context.js new file mode 100644 index 00000000000..a3beea36f07 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.create_context.js @@ -0,0 +1,78 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, context) { + // [START aiplatform_v1beta1_generated_MetadataService_CreateContext_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the MetadataStore where the Context should + * be created. Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}` + */ + // const parent = 'abc123' + /** + * Required. The Context to create. + */ + // const context = {} + /** + * The {context} portion of the resource name with the format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`. + * If not provided, the Context's ID will be a UUID generated by the service. + * Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`. + * Must be unique across all Contexts in the parent MetadataStore. (Otherwise + * the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the + * caller can't view the preexisting Context.) + */ + // const contextId = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callCreateContext() { + // Construct request + const request = { + parent, + context, + }; + + // Run request + const response = await aiplatformClient.createContext(request); + console.log(response); + } + + callCreateContext(); + // [END aiplatform_v1beta1_generated_MetadataService_CreateContext_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.create_execution.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.create_execution.js new file mode 100644 index 00000000000..90dbc23106d --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.create_execution.js @@ -0,0 +1,80 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, execution) { + // [START aiplatform_v1beta1_generated_MetadataService_CreateExecution_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the MetadataStore where the Execution should + * be created. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}` + */ + // const parent = 'abc123' + /** + * Required. The Execution to create. + */ + // const execution = {} + /** + * The {execution} portion of the resource name with the format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` + * If not provided, the Execution's ID will be a UUID generated by the + * service. + * Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`. + * Must be unique across all Executions in the parent MetadataStore. + * (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED + * if the caller can't view the preexisting Execution.) + */ + // const executionId = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callCreateExecution() { + // Construct request + const request = { + parent, + execution, + }; + + // Run request + const response = await aiplatformClient.createExecution(request); + console.log(response); + } + + callCreateExecution(); + // [END aiplatform_v1beta1_generated_MetadataService_CreateExecution_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.create_metadata_schema.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.create_metadata_schema.js new file mode 100644 index 00000000000..ff4187c180a --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.create_metadata_schema.js @@ -0,0 +1,79 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, metadataSchema) { + // [START aiplatform_v1beta1_generated_MetadataService_CreateMetadataSchema_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the MetadataStore where the MetadataSchema + * should be created. Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}` + */ + // const parent = 'abc123' + /** + * Required. The MetadataSchema to create. + */ + // const metadataSchema = {} + /** + * The {metadata_schema} portion of the resource name with the format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema}` + * If not provided, the MetadataStore's ID will be a UUID generated by the + * service. + * Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`. + * Must be unique across all MetadataSchemas in the parent Location. + * (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED + * if the caller can't view the preexisting MetadataSchema.) + */ + // const metadataSchemaId = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callCreateMetadataSchema() { + // Construct request + const request = { + parent, + metadataSchema, + }; + + // Run request + const response = await aiplatformClient.createMetadataSchema(request); + console.log(response); + } + + callCreateMetadataSchema(); + // [END aiplatform_v1beta1_generated_MetadataService_CreateMetadataSchema_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.create_metadata_store.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.create_metadata_store.js new file mode 100644 index 00000000000..b56fc82a48c --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.create_metadata_store.js @@ -0,0 +1,80 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, metadataStore) { + // [START aiplatform_v1beta1_generated_MetadataService_CreateMetadataStore_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location where the MetadataStore should + * be created. + * Format: `projects/{project}/locations/{location}/` + */ + // const parent = 'abc123' + /** + * Required. The MetadataStore to create. + */ + // const metadataStore = {} + /** + * The {metadatastore} portion of the resource name with the format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}` + * If not provided, the MetadataStore's ID will be a UUID generated by the + * service. + * Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`. + * Must be unique across all MetadataStores in the parent Location. + * (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED + * if the caller can't view the preexisting MetadataStore.) + */ + // const metadataStoreId = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callCreateMetadataStore() { + // Construct request + const request = { + parent, + metadataStore, + }; + + // Run request + const [operation] = await aiplatformClient.createMetadataStore(request); + const [response] = await operation.promise(); + console.log(response); + } + + callCreateMetadataStore(); + // [END aiplatform_v1beta1_generated_MetadataService_CreateMetadataStore_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.delete_artifact.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.delete_artifact.js new file mode 100644 index 00000000000..70a58a25400 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.delete_artifact.js @@ -0,0 +1,70 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_MetadataService_DeleteArtifact_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Artifact to delete. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` + */ + // const name = 'abc123' + /** + * Optional. The etag of the Artifact to delete. + * If this is provided, it must match the server's etag. Otherwise, the + * request will fail with a FAILED_PRECONDITION. + */ + // const etag = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callDeleteArtifact() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteArtifact(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteArtifact(); + // [END aiplatform_v1beta1_generated_MetadataService_DeleteArtifact_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.delete_context.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.delete_context.js new file mode 100644 index 00000000000..16d27af3a40 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.delete_context.js @@ -0,0 +1,75 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_MetadataService_DeleteContext_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Context to delete. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}` + */ + // const name = 'abc123' + /** + * The force deletion semantics is still undefined. + * Users should not use this field. + */ + // const force = true + /** + * Optional. The etag of the Context to delete. + * If this is provided, it must match the server's etag. Otherwise, the + * request will fail with a FAILED_PRECONDITION. + */ + // const etag = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callDeleteContext() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteContext(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteContext(); + // [END aiplatform_v1beta1_generated_MetadataService_DeleteContext_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.delete_execution.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.delete_execution.js new file mode 100644 index 00000000000..fc79e96c18f --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.delete_execution.js @@ -0,0 +1,70 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_MetadataService_DeleteExecution_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Execution to delete. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` + */ + // const name = 'abc123' + /** + * Optional. The etag of the Execution to delete. + * If this is provided, it must match the server's etag. Otherwise, the + * request will fail with a FAILED_PRECONDITION. + */ + // const etag = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callDeleteExecution() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteExecution(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteExecution(); + // [END aiplatform_v1beta1_generated_MetadataService_DeleteExecution_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.delete_metadata_store.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.delete_metadata_store.js new file mode 100644 index 00000000000..c53db97c288 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.delete_metadata_store.js @@ -0,0 +1,64 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_MetadataService_DeleteMetadataStore_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the MetadataStore to delete. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callDeleteMetadataStore() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteMetadataStore(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteMetadataStore(); + // [END aiplatform_v1beta1_generated_MetadataService_DeleteMetadataStore_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.get_artifact.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.get_artifact.js new file mode 100644 index 00000000000..4c0dc5e6612 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.get_artifact.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_MetadataService_GetArtifact_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Artifact to retrieve. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callGetArtifact() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getArtifact(request); + console.log(response); + } + + callGetArtifact(); + // [END aiplatform_v1beta1_generated_MetadataService_GetArtifact_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.get_context.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.get_context.js new file mode 100644 index 00000000000..eee910ef168 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.get_context.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_MetadataService_GetContext_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Context to retrieve. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callGetContext() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getContext(request); + console.log(response); + } + + callGetContext(); + // [END aiplatform_v1beta1_generated_MetadataService_GetContext_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.get_execution.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.get_execution.js new file mode 100644 index 00000000000..c9ba72459f7 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.get_execution.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_MetadataService_GetExecution_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Execution to retrieve. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callGetExecution() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getExecution(request); + console.log(response); + } + + callGetExecution(); + // [END aiplatform_v1beta1_generated_MetadataService_GetExecution_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.get_metadata_schema.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.get_metadata_schema.js new file mode 100644 index 00000000000..2880c4ca0c9 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.get_metadata_schema.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_MetadataService_GetMetadataSchema_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the MetadataSchema to retrieve. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callGetMetadataSchema() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getMetadataSchema(request); + console.log(response); + } + + callGetMetadataSchema(); + // [END aiplatform_v1beta1_generated_MetadataService_GetMetadataSchema_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.get_metadata_store.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.get_metadata_store.js new file mode 100644 index 00000000000..11c377739f7 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.get_metadata_store.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_MetadataService_GetMetadataStore_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the MetadataStore to retrieve. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callGetMetadataStore() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getMetadataStore(request); + console.log(response); + } + + callGetMetadataStore(); + // [END aiplatform_v1beta1_generated_MetadataService_GetMetadataStore_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.list_artifacts.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.list_artifacts.js new file mode 100644 index 00000000000..b8990f64912 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.list_artifacts.js @@ -0,0 +1,116 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1beta1_generated_MetadataService_ListArtifacts_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The MetadataStore whose Artifacts should be listed. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}` + */ + // const parent = 'abc123' + /** + * The maximum number of Artifacts to return. The service may return fewer. + * Must be in range 1-1000, inclusive. Defaults to 100. + */ + // const pageSize = 1234 + /** + * A page token, received from a previous + * MetadataService.ListArtifacts google.cloud.aiplatform.v1beta1.MetadataService.ListArtifacts + * call. Provide this to retrieve the subsequent page. + * When paginating, all other provided parameters must match the call that + * provided the page token. (Otherwise the request will fail with + * INVALID_ARGUMENT error.) + */ + // const pageToken = 'abc123' + /** + * Filter specifying the boolean condition for the Artifacts to satisfy in + * order to be part of the result set. + * The syntax to define filter query is based on https://google.aip.dev/160. + * The supported set of filters include the following: + * * **Attribute filtering**: + * For example: `display_name = "test"`. + * Supported fields include: `name`, `display_name`, `uri`, `state`, + * `schema_title`, `create_time`, and `update_time`. + * Time fields, such as `create_time` and `update_time`, require values + * specified in RFC-3339 format. + * For example: `create_time = "2020-11-19T11:30:00-04:00"` + * * **Metadata field**: + * To filter on metadata fields use traversal operation as follows: + * `metadata..`. + * For example: `metadata.field_1.number_value = 10.0` + * * **Context based filtering**: + * To filter Artifacts based on the contexts to which they belong, use the + * function operator with the full resource name + * `in_context()`. + * For example: + * `in_context("projects//locations//metadataStores//contexts/")` + * Each of the above supported filter types can be combined together using + * logical operators (`AND` & `OR`). Maximum nested expression depth allowed + * is 5. + * For example: `display_name = "test" AND metadata.field1.bool_value = true`. + */ + // const filter = 'abc123' + /** + * How the list of messages is ordered. Specify the values to order by and an + * ordering operation. The default sorting order is ascending. To specify + * descending order for a field, users append a " desc" suffix; for example: + * "foo desc, bar". + * Subfields are specified with a `.` character, such as foo.bar. + * see https://google.aip.dev/132#ordering for more details. + */ + // const orderBy = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callListArtifacts() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listArtifactsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListArtifacts(); + // [END aiplatform_v1beta1_generated_MetadataService_ListArtifacts_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.list_contexts.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.list_contexts.js new file mode 100644 index 00000000000..44926134171 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.list_contexts.js @@ -0,0 +1,119 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1beta1_generated_MetadataService_ListContexts_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The MetadataStore whose Contexts should be listed. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}` + */ + // const parent = 'abc123' + /** + * The maximum number of Contexts to return. The service may return fewer. + * Must be in range 1-1000, inclusive. Defaults to 100. + */ + // const pageSize = 1234 + /** + * A page token, received from a previous + * MetadataService.ListContexts google.cloud.aiplatform.v1beta1.MetadataService.ListContexts + * call. Provide this to retrieve the subsequent page. + * When paginating, all other provided parameters must match the call that + * provided the page token. (Otherwise the request will fail with + * INVALID_ARGUMENT error.) + */ + // const pageToken = 'abc123' + /** + * Filter specifying the boolean condition for the Contexts to satisfy in + * order to be part of the result set. + * The syntax to define filter query is based on https://google.aip.dev/160. + * Following are the supported set of filters: + * * **Attribute filtering**: + * For example: `display_name = "test"`. + * Supported fields include: `name`, `display_name`, `schema_title`, + * `create_time`, and `update_time`. + * Time fields, such as `create_time` and `update_time`, require values + * specified in RFC-3339 format. + * For example: `create_time = "2020-11-19T11:30:00-04:00"`. + * * **Metadata field**: + * To filter on metadata fields use traversal operation as follows: + * `metadata..`. + * For example: `metadata.field_1.number_value = 10.0`. + * * **Parent Child filtering**: + * To filter Contexts based on parent-child relationship use the HAS + * operator as follows: + * ``` + * parent_contexts: + * "projects//locations//metadataStores//contexts/" + * child_contexts: + * "projects//locations//metadataStores//contexts/" + * ``` + * Each of the above supported filters can be combined together using + * logical operators (`AND` & `OR`). Maximum nested expression depth allowed + * is 5. + * For example: `display_name = "test" AND metadata.field1.bool_value = true`. + */ + // const filter = 'abc123' + /** + * How the list of messages is ordered. Specify the values to order by and an + * ordering operation. The default sorting order is ascending. To specify + * descending order for a field, users append a " desc" suffix; for example: + * "foo desc, bar". + * Subfields are specified with a `.` character, such as foo.bar. + * see https://google.aip.dev/132#ordering for more details. + */ + // const orderBy = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callListContexts() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listContextsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListContexts(); + // [END aiplatform_v1beta1_generated_MetadataService_ListContexts_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.list_executions.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.list_executions.js new file mode 100644 index 00000000000..a49794b0dfb --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.list_executions.js @@ -0,0 +1,116 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1beta1_generated_MetadataService_ListExecutions_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The MetadataStore whose Executions should be listed. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}` + */ + // const parent = 'abc123' + /** + * The maximum number of Executions to return. The service may return fewer. + * Must be in range 1-1000, inclusive. Defaults to 100. + */ + // const pageSize = 1234 + /** + * A page token, received from a previous + * MetadataService.ListExecutions google.cloud.aiplatform.v1beta1.MetadataService.ListExecutions + * call. Provide this to retrieve the subsequent page. + * When paginating, all other provided parameters must match the call that + * provided the page token. (Otherwise the request will fail with an + * INVALID_ARGUMENT error.) + */ + // const pageToken = 'abc123' + /** + * Filter specifying the boolean condition for the Executions to satisfy in + * order to be part of the result set. + * The syntax to define filter query is based on https://google.aip.dev/160. + * Following are the supported set of filters: + * * **Attribute filtering**: + * For example: `display_name = "test"`. + * Supported fields include: `name`, `display_name`, `state`, + * `schema_title`, `create_time`, and `update_time`. + * Time fields, such as `create_time` and `update_time`, require values + * specified in RFC-3339 format. + * For example: `create_time = "2020-11-19T11:30:00-04:00"`. + * * **Metadata field**: + * To filter on metadata fields use traversal operation as follows: + * `metadata..` + * For example: `metadata.field_1.number_value = 10.0` + * * **Context based filtering**: + * To filter Executions based on the contexts to which they belong use + * the function operator with the full resource name: + * `in_context()`. + * For example: + * `in_context("projects//locations//metadataStores//contexts/")` + * Each of the above supported filters can be combined together using + * logical operators (`AND` & `OR`). Maximum nested expression depth allowed + * is 5. + * For example: `display_name = "test" AND metadata.field1.bool_value = true`. + */ + // const filter = 'abc123' + /** + * How the list of messages is ordered. Specify the values to order by and an + * ordering operation. The default sorting order is ascending. To specify + * descending order for a field, users append a " desc" suffix; for example: + * "foo desc, bar". + * Subfields are specified with a `.` character, such as foo.bar. + * see https://google.aip.dev/132#ordering for more details. + */ + // const orderBy = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callListExecutions() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listExecutionsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListExecutions(); + // [END aiplatform_v1beta1_generated_MetadataService_ListExecutions_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.list_metadata_schemas.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.list_metadata_schemas.js new file mode 100644 index 00000000000..a98685f88f0 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.list_metadata_schemas.js @@ -0,0 +1,84 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1beta1_generated_MetadataService_ListMetadataSchemas_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The MetadataStore whose MetadataSchemas should be listed. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}` + */ + // const parent = 'abc123' + /** + * The maximum number of MetadataSchemas to return. The service may return + * fewer. + * Must be in range 1-1000, inclusive. Defaults to 100. + */ + // const pageSize = 1234 + /** + * A page token, received from a previous + * MetadataService.ListMetadataSchemas google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataSchemas + * call. Provide this to retrieve the next page. + * When paginating, all other provided parameters must match the call that + * provided the page token. (Otherwise the request will fail with + * INVALID_ARGUMENT error.) + */ + // const pageToken = 'abc123' + /** + * A query to filter available MetadataSchemas for matching results. + */ + // const filter = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callListMetadataSchemas() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listMetadataSchemasAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListMetadataSchemas(); + // [END aiplatform_v1beta1_generated_MetadataService_ListMetadataSchemas_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.list_metadata_stores.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.list_metadata_stores.js new file mode 100644 index 00000000000..c298486e5ce --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.list_metadata_stores.js @@ -0,0 +1,80 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1beta1_generated_MetadataService_ListMetadataStores_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The Location whose MetadataStores should be listed. + * Format: + * `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * The maximum number of Metadata Stores to return. The service may return + * fewer. + * Must be in range 1-1000, inclusive. Defaults to 100. + */ + // const pageSize = 1234 + /** + * A page token, received from a previous + * MetadataService.ListMetadataStores google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataStores + * call. Provide this to retrieve the subsequent page. + * When paginating, all other provided parameters must match the call that + * provided the page token. (Otherwise the request will fail with + * INVALID_ARGUMENT error.) + */ + // const pageToken = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callListMetadataStores() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listMetadataStoresAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListMetadataStores(); + // [END aiplatform_v1beta1_generated_MetadataService_ListMetadataStores_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.purge_artifacts.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.purge_artifacts.js new file mode 100644 index 00000000000..e7bbcf4d157 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.purge_artifacts.js @@ -0,0 +1,76 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, filter) { + // [START aiplatform_v1beta1_generated_MetadataService_PurgeArtifacts_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The metadata store to purge Artifacts from. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}` + */ + // const parent = 'abc123' + /** + * Required. A required filter matching the Artifacts to be purged. + * E.g., `update_time <= 2020-11-19T11:30:00-04:00`. + */ + // const filter = 'abc123' + /** + * Optional. Flag to indicate to actually perform the purge. + * If `force` is set to false, the method will return a sample of + * Artifact names that would be deleted. + */ + // const force = true + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callPurgeArtifacts() { + // Construct request + const request = { + parent, + filter, + }; + + // Run request + const [operation] = await aiplatformClient.purgeArtifacts(request); + const [response] = await operation.promise(); + console.log(response); + } + + callPurgeArtifacts(); + // [END aiplatform_v1beta1_generated_MetadataService_PurgeArtifacts_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.purge_contexts.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.purge_contexts.js new file mode 100644 index 00000000000..efa50f1ae30 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.purge_contexts.js @@ -0,0 +1,76 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, filter) { + // [START aiplatform_v1beta1_generated_MetadataService_PurgeContexts_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The metadata store to purge Contexts from. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}` + */ + // const parent = 'abc123' + /** + * Required. A required filter matching the Contexts to be purged. + * E.g., `update_time <= 2020-11-19T11:30:00-04:00`. + */ + // const filter = 'abc123' + /** + * Optional. Flag to indicate to actually perform the purge. + * If `force` is set to false, the method will return a sample of + * Context names that would be deleted. + */ + // const force = true + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callPurgeContexts() { + // Construct request + const request = { + parent, + filter, + }; + + // Run request + const [operation] = await aiplatformClient.purgeContexts(request); + const [response] = await operation.promise(); + console.log(response); + } + + callPurgeContexts(); + // [END aiplatform_v1beta1_generated_MetadataService_PurgeContexts_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.purge_executions.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.purge_executions.js new file mode 100644 index 00000000000..2c13a3825ef --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.purge_executions.js @@ -0,0 +1,76 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, filter) { + // [START aiplatform_v1beta1_generated_MetadataService_PurgeExecutions_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The metadata store to purge Executions from. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}` + */ + // const parent = 'abc123' + /** + * Required. A required filter matching the Executions to be purged. + * E.g., `update_time <= 2020-11-19T11:30:00-04:00`. + */ + // const filter = 'abc123' + /** + * Optional. Flag to indicate to actually perform the purge. + * If `force` is set to false, the method will return a sample of + * Execution names that would be deleted. + */ + // const force = true + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callPurgeExecutions() { + // Construct request + const request = { + parent, + filter, + }; + + // Run request + const [operation] = await aiplatformClient.purgeExecutions(request); + const [response] = await operation.promise(); + console.log(response); + } + + callPurgeExecutions(); + // [END aiplatform_v1beta1_generated_MetadataService_PurgeExecutions_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.query_artifact_lineage_subgraph.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.query_artifact_lineage_subgraph.js new file mode 100644 index 00000000000..da387bee1eb --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.query_artifact_lineage_subgraph.js @@ -0,0 +1,96 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(artifact) { + // [START aiplatform_v1beta1_generated_MetadataService_QueryArtifactLineageSubgraph_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Artifact whose Lineage needs to be + * retrieved as a LineageSubgraph. Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` + * The request may error with FAILED_PRECONDITION if the number of Artifacts, + * the number of Executions, or the number of Events that would be returned + * for the Context exceeds 1000. + */ + // const artifact = 'abc123' + /** + * Specifies the size of the lineage graph in terms of number of hops from the + * specified artifact. + * Negative Value: INVALID_ARGUMENT error is returned + * 0: Only input artifact is returned. + * No value: Transitive closure is performed to return the complete graph. + */ + // const maxHops = 1234 + /** + * Filter specifying the boolean condition for the Artifacts to satisfy in + * order to be part of the Lineage Subgraph. + * The syntax to define filter query is based on https://google.aip.dev/160. + * The supported set of filters include the following: + * * **Attribute filtering**: + * For example: `display_name = "test"` + * Supported fields include: `name`, `display_name`, `uri`, `state`, + * `schema_title`, `create_time`, and `update_time`. + * Time fields, such as `create_time` and `update_time`, require values + * specified in RFC-3339 format. + * For example: `create_time = "2020-11-19T11:30:00-04:00"` + * * **Metadata field**: + * To filter on metadata fields use traversal operation as follows: + * `metadata..`. + * For example: `metadata.field_1.number_value = 10.0` + * Each of the above supported filter types can be combined together using + * logical operators (`AND` & `OR`). Maximum nested expression depth allowed + * is 5. + * For example: `display_name = "test" AND metadata.field1.bool_value = true`. + */ + // const filter = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callQueryArtifactLineageSubgraph() { + // Construct request + const request = { + artifact, + }; + + // Run request + const response = await aiplatformClient.queryArtifactLineageSubgraph(request); + console.log(response); + } + + callQueryArtifactLineageSubgraph(); + // [END aiplatform_v1beta1_generated_MetadataService_QueryArtifactLineageSubgraph_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.query_context_lineage_subgraph.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.query_context_lineage_subgraph.js new file mode 100644 index 00000000000..ba22d861341 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.query_context_lineage_subgraph.js @@ -0,0 +1,67 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(context) { + // [START aiplatform_v1beta1_generated_MetadataService_QueryContextLineageSubgraph_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Context whose Artifacts and Executions + * should be retrieved as a LineageSubgraph. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}` + * The request may error with FAILED_PRECONDITION if the number of Artifacts, + * the number of Executions, or the number of Events that would be returned + * for the Context exceeds 1000. + */ + // const context = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callQueryContextLineageSubgraph() { + // Construct request + const request = { + context, + }; + + // Run request + const response = await aiplatformClient.queryContextLineageSubgraph(request); + console.log(response); + } + + callQueryContextLineageSubgraph(); + // [END aiplatform_v1beta1_generated_MetadataService_QueryContextLineageSubgraph_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.query_execution_inputs_and_outputs.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.query_execution_inputs_and_outputs.js new file mode 100644 index 00000000000..cd675ec1b00 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.query_execution_inputs_and_outputs.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(execution) { + // [START aiplatform_v1beta1_generated_MetadataService_QueryExecutionInputsAndOutputs_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Execution whose input and output + * Artifacts should be retrieved as a LineageSubgraph. Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` + */ + // const execution = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callQueryExecutionInputsAndOutputs() { + // Construct request + const request = { + execution, + }; + + // Run request + const response = await aiplatformClient.queryExecutionInputsAndOutputs(request); + console.log(response); + } + + callQueryExecutionInputsAndOutputs(); + // [END aiplatform_v1beta1_generated_MetadataService_QueryExecutionInputsAndOutputs_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.remove_context_children.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.remove_context_children.js new file mode 100644 index 00000000000..5d40daec1c8 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.remove_context_children.js @@ -0,0 +1,67 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(context) { + // [START aiplatform_v1beta1_generated_MetadataService_RemoveContextChildren_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the parent Context. + * Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}` + */ + // const context = 'abc123' + /** + * The resource names of the child Contexts. + */ + // const childContexts = 'abc123' + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callRemoveContextChildren() { + // Construct request + const request = { + context, + }; + + // Run request + const response = await aiplatformClient.removeContextChildren(request); + console.log(response); + } + + callRemoveContextChildren(); + // [END aiplatform_v1beta1_generated_MetadataService_RemoveContextChildren_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.update_artifact.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.update_artifact.js new file mode 100644 index 00000000000..75b56aa92da --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.update_artifact.js @@ -0,0 +1,76 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(artifact) { + // [START aiplatform_v1beta1_generated_MetadataService_UpdateArtifact_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The Artifact containing updates. + * The Artifact's + * Artifact.name google.cloud.aiplatform.v1beta1.Artifact.name field is + * used to identify the Artifact to be updated. Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` + */ + // const artifact = {} + /** + * Optional. A FieldMask indicating which fields should be updated. + * Functionality of this field is not yet supported. + */ + // const updateMask = {} + /** + * If set to true, and the + * Artifact google.cloud.aiplatform.v1beta1.Artifact is not found, a new + * Artifact google.cloud.aiplatform.v1beta1.Artifact is created. + */ + // const allowMissing = true + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callUpdateArtifact() { + // Construct request + const request = { + artifact, + }; + + // Run request + const response = await aiplatformClient.updateArtifact(request); + console.log(response); + } + + callUpdateArtifact(); + // [END aiplatform_v1beta1_generated_MetadataService_UpdateArtifact_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.update_context.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.update_context.js new file mode 100644 index 00000000000..0157db78168 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.update_context.js @@ -0,0 +1,75 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(context) { + // [START aiplatform_v1beta1_generated_MetadataService_UpdateContext_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The Context containing updates. + * The Context's Context.name google.cloud.aiplatform.v1beta1.Context.name + * field is used to identify the Context to be updated. Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}` + */ + // const context = {} + /** + * Optional. A FieldMask indicating which fields should be updated. + * Functionality of this field is not yet supported. + */ + // const updateMask = {} + /** + * If set to true, and the Context google.cloud.aiplatform.v1beta1.Context + * is not found, a new Context google.cloud.aiplatform.v1beta1.Context is + * created. + */ + // const allowMissing = true + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callUpdateContext() { + // Construct request + const request = { + context, + }; + + // Run request + const response = await aiplatformClient.updateContext(request); + console.log(response); + } + + callUpdateContext(); + // [END aiplatform_v1beta1_generated_MetadataService_UpdateContext_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.update_execution.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.update_execution.js new file mode 100644 index 00000000000..d5b6004efd7 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/metadata_service.update_execution.js @@ -0,0 +1,76 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(execution) { + // [START aiplatform_v1beta1_generated_MetadataService_UpdateExecution_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The Execution containing updates. + * The Execution's + * Execution.name google.cloud.aiplatform.v1beta1.Execution.name field is + * used to identify the Execution to be updated. Format: + * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` + */ + // const execution = {} + /** + * Optional. A FieldMask indicating which fields should be updated. + * Functionality of this field is not yet supported. + */ + // const updateMask = {} + /** + * If set to true, and the + * Execution google.cloud.aiplatform.v1beta1.Execution is not found, a new + * Execution google.cloud.aiplatform.v1beta1.Execution is created. + */ + // const allowMissing = true + + // Imports the Aiplatform library + const {MetadataServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new MetadataServiceClient(); + + async function callUpdateExecution() { + // Construct request + const request = { + execution, + }; + + // Run request + const response = await aiplatformClient.updateExecution(request); + console.log(response); + } + + callUpdateExecution(); + // [END aiplatform_v1beta1_generated_MetadataService_UpdateExecution_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/migration_service.batch_migrate_resources.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/migration_service.batch_migrate_resources.js new file mode 100644 index 00000000000..6a1ad98af2b --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/migration_service.batch_migrate_resources.js @@ -0,0 +1,70 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, migrateResourceRequests) { + // [START aiplatform_v1beta1_generated_MigrationService_BatchMigrateResources_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The location of the migrated resource will live in. + * Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Required. The request messages specifying the resources to migrate. + * They must be in the same location as the destination. + * Up to 50 resources can be migrated in one batch. + */ + // const migrateResourceRequests = 1234 + + // Imports the Aiplatform library + const {MigrationServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new MigrationServiceClient(); + + async function callBatchMigrateResources() { + // Construct request + const request = { + parent, + migrateResourceRequests, + }; + + // Run request + const [operation] = await aiplatformClient.batchMigrateResources(request); + const [response] = await operation.promise(); + console.log(response); + } + + callBatchMigrateResources(); + // [END aiplatform_v1beta1_generated_MigrationService_BatchMigrateResources_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/migration_service.search_migratable_resources.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/migration_service.search_migratable_resources.js new file mode 100644 index 00000000000..5e0242fbecc --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/migration_service.search_migratable_resources.js @@ -0,0 +1,90 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1beta1_generated_MigrationService_SearchMigratableResources_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The location that the migratable resources should be searched + * from. It's the Vertex AI location that the resources can be migrated to, + * not the resources' original location. Format: + * `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * The standard page size. + * The default and maximum value is 100. + */ + // const pageSize = 1234 + /** + * The standard page token. + */ + // const pageToken = 'abc123' + /** + * A filter for your search. You can use the following types of filters: + * * Resource type filters. The following strings filter for a specific type + * of + * MigratableResource google.cloud.aiplatform.v1beta1.MigratableResource: + * * `ml_engine_model_version:*` + * * `automl_model:*` + * * `automl_dataset:*` + * * `data_labeling_dataset:*` + * * "Migrated or not" filters. The following strings filter for resources + * that either have or have not already been migrated: + * * `last_migrate_time:*` filters for migrated resources. + * * `NOT last_migrate_time:*` filters for not yet migrated resources. + */ + // const filter = 'abc123' + + // Imports the Aiplatform library + const {MigrationServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new MigrationServiceClient(); + + async function callSearchMigratableResources() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.searchMigratableResourcesAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callSearchMigratableResources(); + // [END aiplatform_v1beta1_generated_MigrationService_SearchMigratableResources_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.batch_import_model_evaluation_slices.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.batch_import_model_evaluation_slices.js new file mode 100644 index 00000000000..265072a76ca --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.batch_import_model_evaluation_slices.js @@ -0,0 +1,68 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, modelEvaluationSlices) { + // [START aiplatform_v1beta1_generated_ModelService_BatchImportModelEvaluationSlices_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the parent ModelEvaluation resource. + * Format: + * `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}` + */ + // const parent = 'abc123' + /** + * Required. Model evaluation slice resource to be imported. + */ + // const modelEvaluationSlices = 1234 + + // Imports the Aiplatform library + const {ModelServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new ModelServiceClient(); + + async function callBatchImportModelEvaluationSlices() { + // Construct request + const request = { + parent, + modelEvaluationSlices, + }; + + // Run request + const response = await aiplatformClient.batchImportModelEvaluationSlices(request); + console.log(response); + } + + callBatchImportModelEvaluationSlices(); + // [END aiplatform_v1beta1_generated_ModelService_BatchImportModelEvaluationSlices_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.delete_model.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.delete_model.js new file mode 100644 index 00000000000..64d36b72a0d --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.delete_model.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_ModelService_DeleteModel_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Model resource to be deleted. + * Format: `projects/{project}/locations/{location}/models/{model}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {ModelServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new ModelServiceClient(); + + async function callDeleteModel() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteModel(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteModel(); + // [END aiplatform_v1beta1_generated_ModelService_DeleteModel_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.delete_model_version.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.delete_model_version.js new file mode 100644 index 00000000000..66303721b9b --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.delete_model_version.js @@ -0,0 +1,64 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_ModelService_DeleteModelVersion_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the model version to be deleted, with a version ID + * explicitly included. + * Example: `projects/{project}/locations/{location}/models/{model}@1234` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {ModelServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new ModelServiceClient(); + + async function callDeleteModelVersion() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteModelVersion(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteModelVersion(); + // [END aiplatform_v1beta1_generated_ModelService_DeleteModelVersion_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.export_model.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.export_model.js new file mode 100644 index 00000000000..1866969efe0 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.export_model.js @@ -0,0 +1,69 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name, outputConfig) { + // [START aiplatform_v1beta1_generated_ModelService_ExportModel_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Model to export. + * The resource name may contain version id or version alias to specify the + * version, if no version is specified, the default version will be exported. + */ + // const name = 'abc123' + /** + * Required. The desired output location and configuration. + */ + // const outputConfig = {} + + // Imports the Aiplatform library + const {ModelServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new ModelServiceClient(); + + async function callExportModel() { + // Construct request + const request = { + name, + outputConfig, + }; + + // Run request + const [operation] = await aiplatformClient.exportModel(request); + const [response] = await operation.promise(); + console.log(response); + } + + callExportModel(); + // [END aiplatform_v1beta1_generated_ModelService_ExportModel_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.get_model.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.get_model.js new file mode 100644 index 00000000000..6fe883afcf3 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.get_model.js @@ -0,0 +1,71 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_ModelService_GetModel_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Model resource. + * Format: `projects/{project}/locations/{location}/models/{model}` + * In order to retrieve a specific version of the model, also provide + * the version ID or version alias. + * Example: `projects/{project}/locations/{location}/models/{model}@2` + * or + * `projects/{project}/locations/{location}/models/{model}@golden` + * If no version ID or alias is specified, the "default" version will be + * returned. The "default" version alias is created for the first version of + * the model, and can be moved to other versions later on. There will be + * exactly one default version. + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {ModelServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new ModelServiceClient(); + + async function callGetModel() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getModel(request); + console.log(response); + } + + callGetModel(); + // [END aiplatform_v1beta1_generated_ModelService_GetModel_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.get_model_evaluation.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.get_model_evaluation.js new file mode 100644 index 00000000000..bf4b27857f8 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.get_model_evaluation.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_ModelService_GetModelEvaluation_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the ModelEvaluation resource. + * Format: + * `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {ModelServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new ModelServiceClient(); + + async function callGetModelEvaluation() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getModelEvaluation(request); + console.log(response); + } + + callGetModelEvaluation(); + // [END aiplatform_v1beta1_generated_ModelService_GetModelEvaluation_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.get_model_evaluation_slice.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.get_model_evaluation_slice.js new file mode 100644 index 00000000000..4265e329f1f --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.get_model_evaluation_slice.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_ModelService_GetModelEvaluationSlice_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the ModelEvaluationSlice resource. + * Format: + * `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}/slices/{slice}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {ModelServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new ModelServiceClient(); + + async function callGetModelEvaluationSlice() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getModelEvaluationSlice(request); + console.log(response); + } + + callGetModelEvaluationSlice(); + // [END aiplatform_v1beta1_generated_ModelService_GetModelEvaluationSlice_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.import_model_evaluation.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.import_model_evaluation.js new file mode 100644 index 00000000000..932f20b1bbc --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.import_model_evaluation.js @@ -0,0 +1,67 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, modelEvaluation) { + // [START aiplatform_v1beta1_generated_ModelService_ImportModelEvaluation_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the parent model resource. + * Format: `projects/{project}/locations/{location}/models/{model}` + */ + // const parent = 'abc123' + /** + * Required. Model evaluation resource to be imported. + */ + // const modelEvaluation = {} + + // Imports the Aiplatform library + const {ModelServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new ModelServiceClient(); + + async function callImportModelEvaluation() { + // Construct request + const request = { + parent, + modelEvaluation, + }; + + // Run request + const response = await aiplatformClient.importModelEvaluation(request); + console.log(response); + } + + callImportModelEvaluation(); + // [END aiplatform_v1beta1_generated_ModelService_ImportModelEvaluation_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.list_model_evaluation_slices.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.list_model_evaluation_slices.js new file mode 100644 index 00000000000..dc7fc51b7c9 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.list_model_evaluation_slices.js @@ -0,0 +1,87 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1beta1_generated_ModelService_ListModelEvaluationSlices_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the ModelEvaluation to list the + * ModelEvaluationSlices from. Format: + * `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}` + */ + // const parent = 'abc123' + /** + * The standard list filter. + * * `slice.dimension` - for =. + */ + // const filter = 'abc123' + /** + * The standard list page size. + */ + // const pageSize = 1234 + /** + * The standard list page token. + * Typically obtained via + * ListModelEvaluationSlicesResponse.next_page_token google.cloud.aiplatform.v1beta1.ListModelEvaluationSlicesResponse.next_page_token + * of the previous + * ModelService.ListModelEvaluationSlices google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluationSlices + * call. + */ + // const pageToken = 'abc123' + /** + * Mask specifying which fields to read. + */ + // const readMask = {} + + // Imports the Aiplatform library + const {ModelServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new ModelServiceClient(); + + async function callListModelEvaluationSlices() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listModelEvaluationSlicesAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListModelEvaluationSlices(); + // [END aiplatform_v1beta1_generated_ModelService_ListModelEvaluationSlices_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.list_model_evaluations.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.list_model_evaluations.js new file mode 100644 index 00000000000..8e1dfd04b27 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.list_model_evaluations.js @@ -0,0 +1,85 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1beta1_generated_ModelService_ListModelEvaluations_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Model to list the ModelEvaluations from. + * Format: `projects/{project}/locations/{location}/models/{model}` + */ + // const parent = 'abc123' + /** + * The standard list filter. + */ + // const filter = 'abc123' + /** + * The standard list page size. + */ + // const pageSize = 1234 + /** + * The standard list page token. + * Typically obtained via + * ListModelEvaluationsResponse.next_page_token google.cloud.aiplatform.v1beta1.ListModelEvaluationsResponse.next_page_token + * of the previous + * ModelService.ListModelEvaluations google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluations + * call. + */ + // const pageToken = 'abc123' + /** + * Mask specifying which fields to read. + */ + // const readMask = {} + + // Imports the Aiplatform library + const {ModelServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new ModelServiceClient(); + + async function callListModelEvaluations() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listModelEvaluationsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListModelEvaluations(); + // [END aiplatform_v1beta1_generated_ModelService_ListModelEvaluations_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.list_model_versions.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.list_model_versions.js new file mode 100644 index 00000000000..c39d7342c70 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.list_model_versions.js @@ -0,0 +1,98 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_ModelService_ListModelVersions_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the model to list versions for. + */ + // const name = 'abc123' + /** + * The standard list page size. + */ + // const pageSize = 1234 + /** + * The standard list page token. + * Typically obtained via + * ListModelVersionsResponse.next_page_token google.cloud.aiplatform.v1beta1.ListModelVersionsResponse.next_page_token + * of the previous ModelService.ListModelversions call. + */ + // const pageToken = 'abc123' + /** + * An expression for filtering the results of the request. For field names + * both snake_case and camelCase are supported. + * * `labels` supports general map functions that is: + * * `labels.key=value` - key:value equality + * * `labels.key:* or labels:key - key existence + * * A key including a space must be quoted. `labels."a key"`. + * Some examples: + * * `labels.myKey="myValue"` + */ + // const filter = 'abc123' + /** + * Mask specifying which fields to read. + */ + // const readMask = {} + /** + * A comma-separated list of fields to order by, sorted in ascending order. + * Use "desc" after a field name for descending. + * Supported fields: + * * `create_time` + * * `update_time` + * Example: `update_time asc, create_time desc`. + */ + // const orderBy = 'abc123' + + // Imports the Aiplatform library + const {ModelServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new ModelServiceClient(); + + async function callListModelVersions() { + // Construct request + const request = { + name, + }; + + // Run request + const iterable = await aiplatformClient.listModelVersionsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListModelVersions(); + // [END aiplatform_v1beta1_generated_ModelService_ListModelVersions_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.list_models.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.list_models.js new file mode 100644 index 00000000000..926fc1f199c --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.list_models.js @@ -0,0 +1,98 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1beta1_generated_ModelService_ListModels_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to list the Models from. + * Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * An expression for filtering the results of the request. For field names + * both snake_case and camelCase are supported. + * * `model` supports = and !=. `model` represents the Model ID, + * i.e. the last segment of the Model's resource + * name google.cloud.aiplatform.v1beta1.Model.name. + * * `display_name` supports = and != + * * `labels` supports general map functions that is: + * * `labels.key=value` - key:value equality + * * `labels.key:* or labels:key - key existence + * * A key including a space must be quoted. `labels."a key"`. + * Some examples: + * * `model=1234` + * * `displayName="myDisplayName"` + * * `labels.myKey="myValue"` + */ + // const filter = 'abc123' + /** + * The standard list page size. + */ + // const pageSize = 1234 + /** + * The standard list page token. + * Typically obtained via + * ListModelsResponse.next_page_token google.cloud.aiplatform.v1beta1.ListModelsResponse.next_page_token + * of the previous + * ModelService.ListModels google.cloud.aiplatform.v1beta1.ModelService.ListModels + * call. + */ + // const pageToken = 'abc123' + /** + * Mask specifying which fields to read. + */ + // const readMask = {} + + // Imports the Aiplatform library + const {ModelServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new ModelServiceClient(); + + async function callListModels() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listModelsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListModels(); + // [END aiplatform_v1beta1_generated_ModelService_ListModels_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.merge_version_aliases.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.merge_version_aliases.js new file mode 100644 index 00000000000..eca91b71fa9 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.merge_version_aliases.js @@ -0,0 +1,78 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name, versionAliases) { + // [START aiplatform_v1beta1_generated_ModelService_MergeVersionAliases_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the model version to merge aliases, with a version ID + * explicitly included. + * Example: `projects/{project}/locations/{location}/models/{model}@1234` + */ + // const name = 'abc123' + /** + * Required. The set of version aliases to merge. + * The alias should be at most 128 characters, and match + * `[a-z][a-zA-Z0-9-]{0,126}[a-z-0-9]`. + * Add the `-` prefix to an alias means removing that alias from the version. + * `-` is NOT counted in the 128 characters. Example: `-golden` means removing + * the `golden` alias from the version. + * There is NO ordering in aliases, which means + * 1) The aliases returned from GetModel API might not have the exactly same + * order from this MergeVersionAliases API. 2) Adding and deleting the same + * alias in the request is not recommended, and the 2 operations will be + * cancelled out. + */ + // const versionAliases = 'abc123' + + // Imports the Aiplatform library + const {ModelServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new ModelServiceClient(); + + async function callMergeVersionAliases() { + // Construct request + const request = { + name, + versionAliases, + }; + + // Run request + const response = await aiplatformClient.mergeVersionAliases(request); + console.log(response); + } + + callMergeVersionAliases(); + // [END aiplatform_v1beta1_generated_ModelService_MergeVersionAliases_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.update_explanation_dataset.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.update_explanation_dataset.js new file mode 100644 index 00000000000..34b9d7ccb52 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.update_explanation_dataset.js @@ -0,0 +1,67 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(model) { + // [START aiplatform_v1beta1_generated_ModelService_UpdateExplanationDataset_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Model to update. + * Format: `projects/{project}/locations/{location}/models/{model}` + */ + // const model = 'abc123' + /** + * The example config containing the location of the dataset. + */ + // const examples = {} + + // Imports the Aiplatform library + const {ModelServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new ModelServiceClient(); + + async function callUpdateExplanationDataset() { + // Construct request + const request = { + model, + }; + + // Run request + const [operation] = await aiplatformClient.updateExplanationDataset(request); + const [response] = await operation.promise(); + console.log(response); + } + + callUpdateExplanationDataset(); + // [END aiplatform_v1beta1_generated_ModelService_UpdateExplanationDataset_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.update_model.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.update_model.js new file mode 100644 index 00000000000..d039df66a2f --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.update_model.js @@ -0,0 +1,85 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(model, updateMask) { + // [START aiplatform_v1beta1_generated_ModelService_UpdateModel_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The Model which replaces the resource on the server. + * When Model Versioning is enabled, the model.name will be used to determine + * whether to update the model or model version. + * 1. model.name with the @ value, e.g. models/123@1, refers to a version + * specific update. + * 2. model.name without the @ value, e.g. models/123, refers to a model + * update. + * 3. model.name with @-, e.g. models/123@-, refers to a model update. + * 4. Supported model fields: display_name, description; supported + * version-specific fields: version_description. Labels are supported in both + * scenarios. Both the model labels and the version labels are merged when a + * model is returned. When updating labels, if the request is for + * model-specific update, model label gets updated. Otherwise, version labels + * get updated. + * 5. A model name or model version name fields update mismatch will cause a + * precondition error. + * 6. One request cannot update both the model and the version fields. You + * must update them separately. + */ + // const model = {} + /** + * Required. The update mask applies to the resource. + * For the `FieldMask` definition, see + * google.protobuf.FieldMask google.protobuf.FieldMask. + */ + // const updateMask = {} + + // Imports the Aiplatform library + const {ModelServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new ModelServiceClient(); + + async function callUpdateModel() { + // Construct request + const request = { + model, + updateMask, + }; + + // Run request + const response = await aiplatformClient.updateModel(request); + console.log(response); + } + + callUpdateModel(); + // [END aiplatform_v1beta1_generated_ModelService_UpdateModel_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.upload_model.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.upload_model.js new file mode 100644 index 00000000000..91494158295 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/model_service.upload_model.js @@ -0,0 +1,90 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, model) { + // [START aiplatform_v1beta1_generated_ModelService_UploadModel_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location into which to upload the Model. + * Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Optional. The resource name of the model into which to upload the version. + * Only specify this field when uploading a new version. + */ + // const parentModel = 'abc123' + /** + * Optional. The ID to use for the uploaded Model, which will become the final + * component of the model resource name. + * This value may be up to 63 characters, and valid characters are + * `[a-z0-9_-]`. The first character cannot be a number or hyphen. + */ + // const modelId = 'abc123' + /** + * Required. The Model to create. + */ + // const model = {} + /** + * Optional. The user-provided custom service account to use to do the model + * upload. If empty, Vertex AI Service + * Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) + * will be used. Users uploading the Model must have the + * `iam.serviceAccounts.actAs` permission on this service account. Also, this + * account must belong to the project specified in the `parent` field and have + * all necessary read permissions. + */ + // const serviceAccount = 'abc123' + + // Imports the Aiplatform library + const {ModelServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new ModelServiceClient(); + + async function callUploadModel() { + // Construct request + const request = { + parent, + model, + }; + + // Run request + const [operation] = await aiplatformClient.uploadModel(request); + const [response] = await operation.promise(); + console.log(response); + } + + callUploadModel(); + // [END aiplatform_v1beta1_generated_ModelService_UploadModel_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/pipeline_service.cancel_pipeline_job.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/pipeline_service.cancel_pipeline_job.js new file mode 100644 index 00000000000..984272a02bd --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/pipeline_service.cancel_pipeline_job.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_PipelineService_CancelPipelineJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the PipelineJob to cancel. + * Format: + * `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {PipelineServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new PipelineServiceClient(); + + async function callCancelPipelineJob() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.cancelPipelineJob(request); + console.log(response); + } + + callCancelPipelineJob(); + // [END aiplatform_v1beta1_generated_PipelineService_CancelPipelineJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/pipeline_service.cancel_training_pipeline.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/pipeline_service.cancel_training_pipeline.js new file mode 100644 index 00000000000..3952df0394f --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/pipeline_service.cancel_training_pipeline.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_PipelineService_CancelTrainingPipeline_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the TrainingPipeline to cancel. + * Format: + * `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {PipelineServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new PipelineServiceClient(); + + async function callCancelTrainingPipeline() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.cancelTrainingPipeline(request); + console.log(response); + } + + callCancelTrainingPipeline(); + // [END aiplatform_v1beta1_generated_PipelineService_CancelTrainingPipeline_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/pipeline_service.create_pipeline_job.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/pipeline_service.create_pipeline_job.js new file mode 100644 index 00000000000..7fa640b5dd8 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/pipeline_service.create_pipeline_job.js @@ -0,0 +1,75 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, pipelineJob) { + // [START aiplatform_v1beta1_generated_PipelineService_CreatePipelineJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to create the PipelineJob in. + * Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Required. The PipelineJob to create. + */ + // const pipelineJob = {} + /** + * The ID to use for the PipelineJob, which will become the final component of + * the PipelineJob name. If not provided, an ID will be automatically + * generated. + * This value should be less than 128 characters, and valid characters + * are /[a-z][0-9]-/. + */ + // const pipelineJobId = 'abc123' + + // Imports the Aiplatform library + const {PipelineServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new PipelineServiceClient(); + + async function callCreatePipelineJob() { + // Construct request + const request = { + parent, + pipelineJob, + }; + + // Run request + const response = await aiplatformClient.createPipelineJob(request); + console.log(response); + } + + callCreatePipelineJob(); + // [END aiplatform_v1beta1_generated_PipelineService_CreatePipelineJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/pipeline_service.create_training_pipeline.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/pipeline_service.create_training_pipeline.js new file mode 100644 index 00000000000..abca375edda --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/pipeline_service.create_training_pipeline.js @@ -0,0 +1,67 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, trainingPipeline) { + // [START aiplatform_v1beta1_generated_PipelineService_CreateTrainingPipeline_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to create the TrainingPipeline + * in. Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Required. The TrainingPipeline to create. + */ + // const trainingPipeline = {} + + // Imports the Aiplatform library + const {PipelineServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new PipelineServiceClient(); + + async function callCreateTrainingPipeline() { + // Construct request + const request = { + parent, + trainingPipeline, + }; + + // Run request + const response = await aiplatformClient.createTrainingPipeline(request); + console.log(response); + } + + callCreateTrainingPipeline(); + // [END aiplatform_v1beta1_generated_PipelineService_CreateTrainingPipeline_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/pipeline_service.delete_pipeline_job.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/pipeline_service.delete_pipeline_job.js new file mode 100644 index 00000000000..c35026feb54 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/pipeline_service.delete_pipeline_job.js @@ -0,0 +1,64 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_PipelineService_DeletePipelineJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the PipelineJob resource to be deleted. + * Format: + * `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {PipelineServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new PipelineServiceClient(); + + async function callDeletePipelineJob() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deletePipelineJob(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeletePipelineJob(); + // [END aiplatform_v1beta1_generated_PipelineService_DeletePipelineJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/pipeline_service.delete_training_pipeline.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/pipeline_service.delete_training_pipeline.js new file mode 100644 index 00000000000..c939ec91fc9 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/pipeline_service.delete_training_pipeline.js @@ -0,0 +1,64 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_PipelineService_DeleteTrainingPipeline_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the TrainingPipeline resource to be deleted. + * Format: + * `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {PipelineServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new PipelineServiceClient(); + + async function callDeleteTrainingPipeline() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteTrainingPipeline(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteTrainingPipeline(); + // [END aiplatform_v1beta1_generated_PipelineService_DeleteTrainingPipeline_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/pipeline_service.get_pipeline_job.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/pipeline_service.get_pipeline_job.js new file mode 100644 index 00000000000..810106c0a9d --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/pipeline_service.get_pipeline_job.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_PipelineService_GetPipelineJob_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the PipelineJob resource. + * Format: + * `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {PipelineServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new PipelineServiceClient(); + + async function callGetPipelineJob() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getPipelineJob(request); + console.log(response); + } + + callGetPipelineJob(); + // [END aiplatform_v1beta1_generated_PipelineService_GetPipelineJob_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/pipeline_service.get_training_pipeline.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/pipeline_service.get_training_pipeline.js new file mode 100644 index 00000000000..63ec2c3257f --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/pipeline_service.get_training_pipeline.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_PipelineService_GetTrainingPipeline_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the TrainingPipeline resource. + * Format: + * `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {PipelineServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new PipelineServiceClient(); + + async function callGetTrainingPipeline() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getTrainingPipeline(request); + console.log(response); + } + + callGetTrainingPipeline(); + // [END aiplatform_v1beta1_generated_PipelineService_GetTrainingPipeline_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/pipeline_service.list_pipeline_jobs.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/pipeline_service.list_pipeline_jobs.js new file mode 100644 index 00000000000..603b699d1f6 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/pipeline_service.list_pipeline_jobs.js @@ -0,0 +1,128 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1beta1_generated_PipelineService_ListPipelineJobs_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to list the PipelineJobs from. + * Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Lists the PipelineJobs that match the filter expression. The following + * fields are supported: + * * `pipeline_name`: Supports `=` and `!=` comparisons. + * * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. + * * `pipeline_job_user_id`: Supports `=`, `!=` comparisons, and `:` wildcard. + * for example, can check if pipeline's display_name contains *step* by + * doing display_name:\"*step*\" + * * `state`: Supports `=` and `!=` comparisons. + * * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. + * Values must be in RFC 3339 format. + * * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. + * Values must be in RFC 3339 format. + * * `end_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. + * Values must be in RFC 3339 format. + * * `labels`: Supports key-value equality and key presence. + * * `template_uri`: Supports `=`, `!=` comparisons, and `:` wildcard. + * * `template_metadata.version`: Supports `=`, `!=` comparisons, and `:` + * wildcard. + * Filter expressions can be combined together using logical operators + * (`AND` & `OR`). + * For example: `pipeline_name="test" AND create_time>"2020-05-18T13:30:00Z"`. + * The syntax to define filter expression is based on + * https://google.aip.dev/160. + * Examples: + * * `create_time>"2021-05-18T00:00:00Z" OR + * update_time>"2020-05-18T00:00:00Z"` PipelineJobs created or updated + * after 2020-05-18 00:00:00 UTC. + * * `labels.env = "prod"` + * PipelineJobs with label "env" set to "prod". + */ + // const filter = 'abc123' + /** + * The standard list page size. + */ + // const pageSize = 1234 + /** + * The standard list page token. + * Typically obtained via + * ListPipelineJobsResponse.next_page_token google.cloud.aiplatform.v1beta1.ListPipelineJobsResponse.next_page_token + * of the previous + * PipelineService.ListPipelineJobs google.cloud.aiplatform.v1beta1.PipelineService.ListPipelineJobs + * call. + */ + // const pageToken = 'abc123' + /** + * A comma-separated list of fields to order by. The default sort order is in + * ascending order. Use "desc" after a field name for descending. You can have + * multiple order_by fields provided e.g. "create_time desc, end_time", + * "end_time, start_time, update_time" For example, using "create_time desc, + * end_time" will order results by create time in descending order, and if + * there are multiple jobs having the same create time, order them by the end + * time in ascending order. if order_by is not specified, it will order by + * default order is create time in descending order. Supported fields: + * * `create_time` + * * `update_time` + * * `end_time` + * * `start_time` + */ + // const orderBy = 'abc123' + /** + * Mask specifying which fields to read. + */ + // const readMask = {} + + // Imports the Aiplatform library + const {PipelineServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new PipelineServiceClient(); + + async function callListPipelineJobs() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listPipelineJobsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListPipelineJobs(); + // [END aiplatform_v1beta1_generated_PipelineService_ListPipelineJobs_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/pipeline_service.list_training_pipelines.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/pipeline_service.list_training_pipelines.js new file mode 100644 index 00000000000..f89c18fbd96 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/pipeline_service.list_training_pipelines.js @@ -0,0 +1,100 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1beta1_generated_PipelineService_ListTrainingPipelines_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to list the TrainingPipelines + * from. Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * The standard list filter. + * Supported fields: + * * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. + * * `state` supports `=`, `!=` comparisons. + * * `training_task_definition` `=`, `!=` comparisons, and `:` wildcard. + * * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. + * `create_time` must be in RFC 3339 format. + * * `labels` supports general map functions that is: + * `labels.key=value` - key:value equality + * `labels.key:* - key existence + * Some examples of using the filter are: + * * `state="PIPELINE_STATE_SUCCEEDED" AND display_name:"my_pipeline_*"` + * * `state!="PIPELINE_STATE_FAILED" OR display_name="my_pipeline"` + * * `NOT display_name="my_pipeline"` + * * `create_time>"2021-05-18T00:00:00Z"` + * * `training_task_definition:"*automl_text_classification*"` + */ + // const filter = 'abc123' + /** + * The standard list page size. + */ + // const pageSize = 1234 + /** + * The standard list page token. + * Typically obtained via + * ListTrainingPipelinesResponse.next_page_token google.cloud.aiplatform.v1beta1.ListTrainingPipelinesResponse.next_page_token + * of the previous + * PipelineService.ListTrainingPipelines google.cloud.aiplatform.v1beta1.PipelineService.ListTrainingPipelines + * call. + */ + // const pageToken = 'abc123' + /** + * Mask specifying which fields to read. + */ + // const readMask = {} + + // Imports the Aiplatform library + const {PipelineServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new PipelineServiceClient(); + + async function callListTrainingPipelines() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listTrainingPipelinesAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListTrainingPipelines(); + // [END aiplatform_v1beta1_generated_PipelineService_ListTrainingPipelines_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/prediction_service.explain.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/prediction_service.explain.js new file mode 100644 index 00000000000..5e8de6cbfe4 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/prediction_service.explain.js @@ -0,0 +1,102 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(endpoint, instances) { + // [START aiplatform_v1beta1_generated_PredictionService_Explain_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Endpoint requested to serve the explanation. + * Format: + * `projects/{project}/locations/{location}/endpoints/{endpoint}` + */ + // const endpoint = 'abc123' + /** + * Required. The instances that are the input to the explanation call. + * A DeployedModel may have an upper limit on the number of instances it + * supports per request, and when it is exceeded the explanation call errors + * in case of AutoML Models, or, in case of customer created Models, the + * behaviour is as documented by that Model. + * The schema of any single instance may be specified via Endpoint's + * DeployedModels' + * Model's google.cloud.aiplatform.v1beta1.DeployedModel.model + * PredictSchemata's google.cloud.aiplatform.v1beta1.Model.predict_schemata + * instance_schema_uri google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri. + */ + // const instances = 1234 + /** + * The parameters that govern the prediction. The schema of the parameters may + * be specified via Endpoint's DeployedModels' Model's + * google.cloud.aiplatform.v1beta1.DeployedModel.model + * PredictSchemata's google.cloud.aiplatform.v1beta1.Model.predict_schemata + * parameters_schema_uri google.cloud.aiplatform.v1beta1.PredictSchemata.parameters_schema_uri. + */ + // const parameters = {} + /** + * If specified, overrides the + * explanation_spec google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec + * of the DeployedModel. Can be used for explaining prediction results with + * different configurations, such as: + * - Explaining top-5 predictions results as opposed to top-1; + * - Increasing path count or step count of the attribution methods to reduce + * approximate errors; + * - Using different baselines for explaining the prediction results. + */ + // const explanationSpecOverride = {} + /** + * If specified, this ExplainRequest will be served by the chosen + * DeployedModel, overriding + * Endpoint.traffic_split google.cloud.aiplatform.v1beta1.Endpoint.traffic_split. + */ + // const deployedModelId = 'abc123' + + // Imports the Aiplatform library + const {PredictionServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new PredictionServiceClient(); + + async function callExplain() { + // Construct request + const request = { + endpoint, + instances, + }; + + // Run request + const response = await aiplatformClient.explain(request); + console.log(response); + } + + callExplain(); + // [END aiplatform_v1beta1_generated_PredictionService_Explain_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/prediction_service.predict.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/prediction_service.predict.js new file mode 100644 index 00000000000..9c9e4ccf04a --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/prediction_service.predict.js @@ -0,0 +1,85 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(endpoint, instances) { + // [START aiplatform_v1beta1_generated_PredictionService_Predict_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Endpoint requested to serve the prediction. + * Format: + * `projects/{project}/locations/{location}/endpoints/{endpoint}` + */ + // const endpoint = 'abc123' + /** + * Required. The instances that are the input to the prediction call. + * A DeployedModel may have an upper limit on the number of instances it + * supports per request, and when it is exceeded the prediction call errors + * in case of AutoML Models, or, in case of customer created Models, the + * behaviour is as documented by that Model. + * The schema of any single instance may be specified via Endpoint's + * DeployedModels' + * Model's google.cloud.aiplatform.v1beta1.DeployedModel.model + * PredictSchemata's google.cloud.aiplatform.v1beta1.Model.predict_schemata + * instance_schema_uri google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri. + */ + // const instances = 1234 + /** + * The parameters that govern the prediction. The schema of the parameters may + * be specified via Endpoint's DeployedModels' Model's + * google.cloud.aiplatform.v1beta1.DeployedModel.model + * PredictSchemata's google.cloud.aiplatform.v1beta1.Model.predict_schemata + * parameters_schema_uri google.cloud.aiplatform.v1beta1.PredictSchemata.parameters_schema_uri. + */ + // const parameters = {} + + // Imports the Aiplatform library + const {PredictionServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new PredictionServiceClient(); + + async function callPredict() { + // Construct request + const request = { + endpoint, + instances, + }; + + // Run request + const response = await aiplatformClient.predict(request); + console.log(response); + } + + callPredict(); + // [END aiplatform_v1beta1_generated_PredictionService_Predict_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/prediction_service.raw_predict.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/prediction_service.raw_predict.js new file mode 100644 index 00000000000..129ec904742 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/prediction_service.raw_predict.js @@ -0,0 +1,79 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(endpoint) { + // [START aiplatform_v1beta1_generated_PredictionService_RawPredict_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Endpoint requested to serve the prediction. + * Format: + * `projects/{project}/locations/{location}/endpoints/{endpoint}` + */ + // const endpoint = 'abc123' + /** + * The prediction input. Supports HTTP headers and arbitrary data payload. + * A DeployedModel google.cloud.aiplatform.v1beta1.DeployedModel may have + * an upper limit on the number of instances it supports per request. When + * this limit it is exceeded for an AutoML model, the + * RawPredict google.cloud.aiplatform.v1beta1.PredictionService.RawPredict + * method returns an error. When this limit is exceeded for a custom-trained + * model, the behavior varies depending on the model. + * You can specify the schema for each instance in the + * predict_schemata.instance_schema_uri google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri + * field when you create a Model google.cloud.aiplatform.v1beta1.Model. + * This schema applies when you deploy the `Model` as a `DeployedModel` to an + * Endpoint google.cloud.aiplatform.v1beta1.Endpoint and use the + * `RawPredict` method. + */ + // const httpBody = {} + + // Imports the Aiplatform library + const {PredictionServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new PredictionServiceClient(); + + async function callRawPredict() { + // Construct request + const request = { + endpoint, + }; + + // Run request + const response = await aiplatformClient.rawPredict(request); + console.log(response); + } + + callRawPredict(); + // [END aiplatform_v1beta1_generated_PredictionService_RawPredict_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/snippet_metadata.google.cloud.aiplatform.v1beta1.json b/packages/google-cloud-aiplatform/samples/generated/v1beta1/snippet_metadata.google.cloud.aiplatform.v1beta1.json new file mode 100644 index 00000000000..ccef4a0bf83 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/snippet_metadata.google.cloud.aiplatform.v1beta1.json @@ -0,0 +1,9447 @@ +{ + "clientLibrary": { + "name": "nodejs-aiplatform", + "version": "2.3.0", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.aiplatform.v1beta1", + "version": "v1beta1" + } + ] + }, + "snippets": [ + { + "regionTag": "aiplatform_v1beta1_generated_DatasetService_CreateDataset_async", + "title": "DatasetService createDataset Sample", + "origin": "API_DEFINITION", + "description": " Creates a Dataset.", + "canonical": true, + "file": "dataset_service.create_dataset.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateDataset", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.CreateDataset", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "dataset", + "type": ".google.cloud.aiplatform.v1beta1.Dataset" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetServiceClient" + }, + "method": { + "shortName": "CreateDataset", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.CreateDataset", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_DatasetService_GetDataset_async", + "title": "DatasetService getDataset Sample", + "origin": "API_DEFINITION", + "description": " Gets a Dataset.", + "canonical": true, + "file": "dataset_service.get_dataset.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 57, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetDataset", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.GetDataset", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Dataset", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetServiceClient" + }, + "method": { + "shortName": "GetDataset", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.GetDataset", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_DatasetService_UpdateDataset_async", + "title": "DatasetService updateDataset Sample", + "origin": "API_DEFINITION", + "description": " Updates a Dataset.", + "canonical": true, + "file": "dataset_service.update_dataset.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateDataset", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.UpdateDataset", + "async": true, + "parameters": [ + { + "name": "dataset", + "type": ".google.cloud.aiplatform.v1beta1.Dataset" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Dataset", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetServiceClient" + }, + "method": { + "shortName": "UpdateDataset", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.UpdateDataset", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_DatasetService_ListDatasets_async", + "title": "DatasetService listDatasets Sample", + "origin": "API_DEFINITION", + "description": " Lists Datasets in a Location.", + "canonical": true, + "file": "dataset_service.list_datasets.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 91, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListDatasets", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.ListDatasets", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListDatasetsResponse", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetServiceClient" + }, + "method": { + "shortName": "ListDatasets", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.ListDatasets", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_DatasetService_DeleteDataset_async", + "title": "DatasetService deleteDataset Sample", + "origin": "API_DEFINITION", + "description": " Deletes a Dataset.", + "canonical": true, + "file": "dataset_service.delete_dataset.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteDataset", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.DeleteDataset", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetServiceClient" + }, + "method": { + "shortName": "DeleteDataset", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.DeleteDataset", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_DatasetService_ImportData_async", + "title": "DatasetService importData Sample", + "origin": "API_DEFINITION", + "description": " Imports data into a Dataset.", + "canonical": true, + "file": "dataset_service.import_data.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ImportData", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.ImportData", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "import_configs", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetServiceClient" + }, + "method": { + "shortName": "ImportData", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.ImportData", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_DatasetService_ExportData_async", + "title": "DatasetService exportData Sample", + "origin": "API_DEFINITION", + "description": " Exports data from a Dataset.", + "canonical": true, + "file": "dataset_service.export_data.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ExportData", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.ExportData", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "export_config", + "type": ".google.cloud.aiplatform.v1beta1.ExportDataConfig" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetServiceClient" + }, + "method": { + "shortName": "ExportData", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.ExportData", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_DatasetService_ListDataItems_async", + "title": "DatasetService listDataItems Sample", + "origin": "API_DEFINITION", + "description": " Lists DataItems in a Dataset.", + "canonical": true, + "file": "dataset_service.list_data_items.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 78, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListDataItems", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.ListDataItems", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListDataItemsResponse", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetServiceClient" + }, + "method": { + "shortName": "ListDataItems", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.ListDataItems", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_DatasetService_SearchDataItems_async", + "title": "DatasetService searchDataItems Sample", + "origin": "API_DEFINITION", + "description": " Searches DataItems in a Dataset.", + "canonical": true, + "file": "dataset_service.search_data_items.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 137, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SearchDataItems", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.SearchDataItems", + "async": true, + "parameters": [ + { + "name": "order_by_data_item", + "type": "TYPE_STRING" + }, + { + "name": "order_by_annotation", + "type": ".google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation" + }, + { + "name": "dataset", + "type": "TYPE_STRING" + }, + { + "name": "saved_query", + "type": "TYPE_STRING" + }, + { + "name": "data_labeling_job", + "type": "TYPE_STRING" + }, + { + "name": "data_item_filter", + "type": "TYPE_STRING" + }, + { + "name": "annotations_filter", + "type": "TYPE_STRING" + }, + { + "name": "annotation_filters", + "type": "TYPE_STRING[]" + }, + { + "name": "field_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "annotations_limit", + "type": "TYPE_INT32" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.SearchDataItemsResponse", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetServiceClient" + }, + "method": { + "shortName": "SearchDataItems", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.SearchDataItems", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_DatasetService_ListSavedQueries_async", + "title": "DatasetService listSavedQueries Sample", + "origin": "API_DEFINITION", + "description": " Lists SavedQueries in a Dataset.", + "canonical": true, + "file": "dataset_service.list_saved_queries.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 78, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListSavedQueries", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.ListSavedQueries", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListSavedQueriesResponse", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetServiceClient" + }, + "method": { + "shortName": "ListSavedQueries", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.ListSavedQueries", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_DatasetService_GetAnnotationSpec_async", + "title": "DatasetService getAnnotationSpec Sample", + "origin": "API_DEFINITION", + "description": " Gets an AnnotationSpec.", + "canonical": true, + "file": "dataset_service.get_annotation_spec.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetAnnotationSpec", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.GetAnnotationSpec", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.AnnotationSpec", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetServiceClient" + }, + "method": { + "shortName": "GetAnnotationSpec", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.GetAnnotationSpec", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_DatasetService_ListAnnotations_async", + "title": "DatasetService listAnnotations Sample", + "origin": "API_DEFINITION", + "description": " Lists Annotations belongs to a dataitem", + "canonical": true, + "file": "dataset_service.list_annotations.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 78, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListAnnotations", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.ListAnnotations", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListAnnotationsResponse", + "client": { + "shortName": "DatasetServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetServiceClient" + }, + "method": { + "shortName": "ListAnnotations", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService.ListAnnotations", + "service": { + "shortName": "DatasetService", + "fullName": "google.cloud.aiplatform.v1beta1.DatasetService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_DeploymentResourcePoolService_CreateDeploymentResourcePool_async", + "title": "DatasetService createDeploymentResourcePool Sample", + "origin": "API_DEFINITION", + "description": " Create a DeploymentResourcePool.", + "canonical": true, + "file": "deployment_resource_pool_service.create_deployment_resource_pool.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateDeploymentResourcePool", + "fullName": "google.cloud.aiplatform.v1beta1.DeploymentResourcePoolService.CreateDeploymentResourcePool", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "deployment_resource_pool", + "type": ".google.cloud.aiplatform.v1beta1.DeploymentResourcePool" + }, + { + "name": "deployment_resource_pool_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DeploymentResourcePoolServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.DeploymentResourcePoolServiceClient" + }, + "method": { + "shortName": "CreateDeploymentResourcePool", + "fullName": "google.cloud.aiplatform.v1beta1.DeploymentResourcePoolService.CreateDeploymentResourcePool", + "service": { + "shortName": "DeploymentResourcePoolService", + "fullName": "google.cloud.aiplatform.v1beta1.DeploymentResourcePoolService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_DeploymentResourcePoolService_GetDeploymentResourcePool_async", + "title": "DatasetService getDeploymentResourcePool Sample", + "origin": "API_DEFINITION", + "description": " Get a DeploymentResourcePool.", + "canonical": true, + "file": "deployment_resource_pool_service.get_deployment_resource_pool.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetDeploymentResourcePool", + "fullName": "google.cloud.aiplatform.v1beta1.DeploymentResourcePoolService.GetDeploymentResourcePool", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.DeploymentResourcePool", + "client": { + "shortName": "DeploymentResourcePoolServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.DeploymentResourcePoolServiceClient" + }, + "method": { + "shortName": "GetDeploymentResourcePool", + "fullName": "google.cloud.aiplatform.v1beta1.DeploymentResourcePoolService.GetDeploymentResourcePool", + "service": { + "shortName": "DeploymentResourcePoolService", + "fullName": "google.cloud.aiplatform.v1beta1.DeploymentResourcePoolService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_DeploymentResourcePoolService_ListDeploymentResourcePools_async", + "title": "DatasetService listDeploymentResourcePools Sample", + "origin": "API_DEFINITION", + "description": " List DeploymentResourcePools in a location.", + "canonical": true, + "file": "deployment_resource_pool_service.list_deployment_resource_pools.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListDeploymentResourcePools", + "fullName": "google.cloud.aiplatform.v1beta1.DeploymentResourcePoolService.ListDeploymentResourcePools", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListDeploymentResourcePoolsResponse", + "client": { + "shortName": "DeploymentResourcePoolServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.DeploymentResourcePoolServiceClient" + }, + "method": { + "shortName": "ListDeploymentResourcePools", + "fullName": "google.cloud.aiplatform.v1beta1.DeploymentResourcePoolService.ListDeploymentResourcePools", + "service": { + "shortName": "DeploymentResourcePoolService", + "fullName": "google.cloud.aiplatform.v1beta1.DeploymentResourcePoolService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_DeploymentResourcePoolService_DeleteDeploymentResourcePool_async", + "title": "DatasetService deleteDeploymentResourcePool Sample", + "origin": "API_DEFINITION", + "description": " Delete a DeploymentResourcePool.", + "canonical": true, + "file": "deployment_resource_pool_service.delete_deployment_resource_pool.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteDeploymentResourcePool", + "fullName": "google.cloud.aiplatform.v1beta1.DeploymentResourcePoolService.DeleteDeploymentResourcePool", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DeploymentResourcePoolServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.DeploymentResourcePoolServiceClient" + }, + "method": { + "shortName": "DeleteDeploymentResourcePool", + "fullName": "google.cloud.aiplatform.v1beta1.DeploymentResourcePoolService.DeleteDeploymentResourcePool", + "service": { + "shortName": "DeploymentResourcePoolService", + "fullName": "google.cloud.aiplatform.v1beta1.DeploymentResourcePoolService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_DeploymentResourcePoolService_QueryDeployedModels_async", + "title": "DatasetService queryDeployedModels Sample", + "origin": "API_DEFINITION", + "description": " List DeployedModels that have been deployed on this DeploymentResourcePool.", + "canonical": true, + "file": "deployment_resource_pool_service.query_deployed_models.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 70, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "QueryDeployedModels", + "fullName": "google.cloud.aiplatform.v1beta1.DeploymentResourcePoolService.QueryDeployedModels", + "async": true, + "parameters": [ + { + "name": "deployment_resource_pool", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.QueryDeployedModelsResponse", + "client": { + "shortName": "DeploymentResourcePoolServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.DeploymentResourcePoolServiceClient" + }, + "method": { + "shortName": "QueryDeployedModels", + "fullName": "google.cloud.aiplatform.v1beta1.DeploymentResourcePoolService.QueryDeployedModels", + "service": { + "shortName": "DeploymentResourcePoolService", + "fullName": "google.cloud.aiplatform.v1beta1.DeploymentResourcePoolService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_EndpointService_CreateEndpoint_async", + "title": "DatasetService createEndpoint Sample", + "origin": "API_DEFINITION", + "description": " Creates an Endpoint.", + "canonical": true, + "file": "endpoint_service.create_endpoint.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateEndpoint", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointService.CreateEndpoint", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "endpoint", + "type": ".google.cloud.aiplatform.v1beta1.Endpoint" + }, + { + "name": "endpoint_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "EndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointServiceClient" + }, + "method": { + "shortName": "CreateEndpoint", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointService.CreateEndpoint", + "service": { + "shortName": "EndpointService", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_EndpointService_GetEndpoint_async", + "title": "DatasetService getEndpoint Sample", + "origin": "API_DEFINITION", + "description": " Gets an Endpoint.", + "canonical": true, + "file": "endpoint_service.get_endpoint.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetEndpoint", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointService.GetEndpoint", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Endpoint", + "client": { + "shortName": "EndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointServiceClient" + }, + "method": { + "shortName": "GetEndpoint", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointService.GetEndpoint", + "service": { + "shortName": "EndpointService", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_EndpointService_ListEndpoints_async", + "title": "DatasetService listEndpoints Sample", + "origin": "API_DEFINITION", + "description": " Lists Endpoints in a Location.", + "canonical": true, + "file": "endpoint_service.list_endpoints.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 90, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListEndpoints", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointService.ListEndpoints", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListEndpointsResponse", + "client": { + "shortName": "EndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointServiceClient" + }, + "method": { + "shortName": "ListEndpoints", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointService.ListEndpoints", + "service": { + "shortName": "EndpointService", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_EndpointService_UpdateEndpoint_async", + "title": "DatasetService updateEndpoint Sample", + "origin": "API_DEFINITION", + "description": " Updates an Endpoint.", + "canonical": true, + "file": "endpoint_service.update_endpoint.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateEndpoint", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointService.UpdateEndpoint", + "async": true, + "parameters": [ + { + "name": "endpoint", + "type": ".google.cloud.aiplatform.v1beta1.Endpoint" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Endpoint", + "client": { + "shortName": "EndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointServiceClient" + }, + "method": { + "shortName": "UpdateEndpoint", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointService.UpdateEndpoint", + "service": { + "shortName": "EndpointService", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_EndpointService_DeleteEndpoint_async", + "title": "DatasetService deleteEndpoint Sample", + "origin": "API_DEFINITION", + "description": " Deletes an Endpoint.", + "canonical": true, + "file": "endpoint_service.delete_endpoint.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteEndpoint", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointService.DeleteEndpoint", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "EndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointServiceClient" + }, + "method": { + "shortName": "DeleteEndpoint", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointService.DeleteEndpoint", + "service": { + "shortName": "EndpointService", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_EndpointService_DeployModel_async", + "title": "DatasetService deployModel Sample", + "origin": "API_DEFINITION", + "description": " Deploys a Model into this Endpoint, creating a DeployedModel within it.", + "canonical": true, + "file": "endpoint_service.deploy_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeployModel", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointService.DeployModel", + "async": true, + "parameters": [ + { + "name": "endpoint", + "type": "TYPE_STRING" + }, + { + "name": "deployed_model", + "type": ".google.cloud.aiplatform.v1beta1.DeployedModel" + }, + { + "name": "traffic_split", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "EndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointServiceClient" + }, + "method": { + "shortName": "DeployModel", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointService.DeployModel", + "service": { + "shortName": "EndpointService", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_EndpointService_UndeployModel_async", + "title": "DatasetService undeployModel Sample", + "origin": "API_DEFINITION", + "description": " Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using.", + "canonical": true, + "file": "endpoint_service.undeploy_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UndeployModel", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointService.UndeployModel", + "async": true, + "parameters": [ + { + "name": "endpoint", + "type": "TYPE_STRING" + }, + { + "name": "deployed_model_id", + "type": "TYPE_STRING" + }, + { + "name": "traffic_split", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "EndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointServiceClient" + }, + "method": { + "shortName": "UndeployModel", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointService.UndeployModel", + "service": { + "shortName": "EndpointService", + "fullName": "google.cloud.aiplatform.v1beta1.EndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreOnlineServingService_ReadFeatureValues_async", + "title": "DatasetService readFeatureValues Sample", + "origin": "API_DEFINITION", + "description": " Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues.", + "canonical": true, + "file": "featurestore_online_serving_service.read_feature_values.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ReadFeatureValues", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreOnlineServingService.ReadFeatureValues", + "async": true, + "parameters": [ + { + "name": "entity_type", + "type": "TYPE_STRING" + }, + { + "name": "entity_id", + "type": "TYPE_STRING" + }, + { + "name": "feature_selector", + "type": ".google.cloud.aiplatform.v1beta1.FeatureSelector" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ReadFeatureValuesResponse", + "client": { + "shortName": "FeaturestoreOnlineServingServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreOnlineServingServiceClient" + }, + "method": { + "shortName": "ReadFeatureValues", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreOnlineServingService.ReadFeatureValues", + "service": { + "shortName": "FeaturestoreOnlineServingService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreOnlineServingService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreOnlineServingService_StreamingReadFeatureValues_async", + "title": "DatasetService streamingReadFeatureValues Sample", + "origin": "API_DEFINITION", + "description": " Reads Feature values for multiple entities. Depending on their size, data for different entities may be broken up across multiple responses.", + "canonical": true, + "file": "featurestore_online_serving_service.streaming_read_feature_values.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 73, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "StreamingReadFeatureValues", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreOnlineServingService.StreamingReadFeatureValues", + "async": true, + "parameters": [ + { + "name": "entity_type", + "type": "TYPE_STRING" + }, + { + "name": "entity_ids", + "type": "TYPE_STRING[]" + }, + { + "name": "feature_selector", + "type": ".google.cloud.aiplatform.v1beta1.FeatureSelector" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ReadFeatureValuesResponse", + "client": { + "shortName": "FeaturestoreOnlineServingServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreOnlineServingServiceClient" + }, + "method": { + "shortName": "StreamingReadFeatureValues", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreOnlineServingService.StreamingReadFeatureValues", + "service": { + "shortName": "FeaturestoreOnlineServingService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreOnlineServingService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreOnlineServingService_WriteFeatureValues_async", + "title": "DatasetService writeFeatureValues Sample", + "origin": "API_DEFINITION", + "description": " Writes Feature values of one or more entities of an EntityType. The Feature values are merged into existing entities if any. The Feature values to be written must have timestamp within the online storage retention.", + "canonical": true, + "file": "featurestore_online_serving_service.write_feature_values.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 64, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "WriteFeatureValues", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreOnlineServingService.WriteFeatureValues", + "async": true, + "parameters": [ + { + "name": "entity_type", + "type": "TYPE_STRING" + }, + { + "name": "payloads", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.WriteFeatureValuesResponse", + "client": { + "shortName": "FeaturestoreOnlineServingServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreOnlineServingServiceClient" + }, + "method": { + "shortName": "WriteFeatureValues", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreOnlineServingService.WriteFeatureValues", + "service": { + "shortName": "FeaturestoreOnlineServingService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreOnlineServingService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreService_CreateFeaturestore_async", + "title": "DatasetService createFeaturestore Sample", + "origin": "API_DEFINITION", + "description": " Creates a new Featurestore in a given project and location.", + "canonical": true, + "file": "featurestore_service.create_featurestore.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 70, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateFeaturestore", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.CreateFeaturestore", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "featurestore", + "type": ".google.cloud.aiplatform.v1beta1.Featurestore" + }, + { + "name": "featurestore_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "CreateFeaturestore", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.CreateFeaturestore", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreService_GetFeaturestore_async", + "title": "DatasetService getFeaturestore Sample", + "origin": "API_DEFINITION", + "description": " Gets details of a single Featurestore.", + "canonical": true, + "file": "featurestore_service.get_featurestore.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetFeaturestore", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.GetFeaturestore", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Featurestore", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "GetFeaturestore", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.GetFeaturestore", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreService_ListFeaturestores_async", + "title": "DatasetService listFeaturestores Sample", + "origin": "API_DEFINITION", + "description": " Lists Featurestores in a given project and location.", + "canonical": true, + "file": "featurestore_service.list_featurestores.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 105, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListFeaturestores", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeaturestores", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListFeaturestoresResponse", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "ListFeaturestores", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeaturestores", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreService_UpdateFeaturestore_async", + "title": "DatasetService updateFeaturestore Sample", + "origin": "API_DEFINITION", + "description": " Updates the parameters of a single Featurestore.", + "canonical": true, + "file": "featurestore_service.update_featurestore.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateFeaturestore", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.UpdateFeaturestore", + "async": true, + "parameters": [ + { + "name": "featurestore", + "type": ".google.cloud.aiplatform.v1beta1.Featurestore" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "UpdateFeaturestore", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.UpdateFeaturestore", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreService_DeleteFeaturestore_async", + "title": "DatasetService deleteFeaturestore Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single Featurestore. The Featurestore must not contain any EntityTypes or `force` must be set to true for the request to succeed.", + "canonical": true, + "file": "featurestore_service.delete_featurestore.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteFeaturestore", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.DeleteFeaturestore", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "DeleteFeaturestore", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.DeleteFeaturestore", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreService_CreateEntityType_async", + "title": "DatasetService createEntityType Sample", + "origin": "API_DEFINITION", + "description": " Creates a new EntityType in a given Featurestore.", + "canonical": true, + "file": "featurestore_service.create_entity_type.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateEntityType", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.CreateEntityType", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "entity_type", + "type": ".google.cloud.aiplatform.v1beta1.EntityType" + }, + { + "name": "entity_type_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "CreateEntityType", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.CreateEntityType", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreService_GetEntityType_async", + "title": "DatasetService getEntityType Sample", + "origin": "API_DEFINITION", + "description": " Gets details of a single EntityType.", + "canonical": true, + "file": "featurestore_service.get_entity_type.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetEntityType", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.GetEntityType", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.EntityType", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "GetEntityType", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.GetEntityType", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreService_ListEntityTypes_async", + "title": "DatasetService listEntityTypes Sample", + "origin": "API_DEFINITION", + "description": " Lists EntityTypes in a given Featurestore.", + "canonical": true, + "file": "featurestore_service.list_entity_types.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 104, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListEntityTypes", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListEntityTypesResponse", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "ListEntityTypes", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreService_UpdateEntityType_async", + "title": "DatasetService updateEntityType Sample", + "origin": "API_DEFINITION", + "description": " Updates the parameters of a single EntityType.", + "canonical": true, + "file": "featurestore_service.update_entity_type.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 76, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateEntityType", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.UpdateEntityType", + "async": true, + "parameters": [ + { + "name": "entity_type", + "type": ".google.cloud.aiplatform.v1beta1.EntityType" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.EntityType", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "UpdateEntityType", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.UpdateEntityType", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreService_DeleteEntityType_async", + "title": "DatasetService deleteEntityType Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single EntityType. The EntityType must not have any Features or `force` must be set to true for the request to succeed.", + "canonical": true, + "file": "featurestore_service.delete_entity_type.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteEntityType", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.DeleteEntityType", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "DeleteEntityType", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.DeleteEntityType", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreService_CreateFeature_async", + "title": "DatasetService createFeature Sample", + "origin": "API_DEFINITION", + "description": " Creates a new Feature in a given EntityType.", + "canonical": true, + "file": "featurestore_service.create_feature.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 70, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateFeature", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.CreateFeature", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "feature", + "type": ".google.cloud.aiplatform.v1beta1.Feature" + }, + { + "name": "feature_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "CreateFeature", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.CreateFeature", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreService_BatchCreateFeatures_async", + "title": "DatasetService batchCreateFeatures Sample", + "origin": "API_DEFINITION", + "description": " Creates a batch of Features in a given EntityType.", + "canonical": true, + "file": "featurestore_service.batch_create_features.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchCreateFeatures", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.BatchCreateFeatures", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "requests", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "BatchCreateFeatures", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.BatchCreateFeatures", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreService_GetFeature_async", + "title": "DatasetService getFeature Sample", + "origin": "API_DEFINITION", + "description": " Gets details of a single Feature.", + "canonical": true, + "file": "featurestore_service.get_feature.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetFeature", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.GetFeature", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Feature", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "GetFeature", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.GetFeature", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreService_ListFeatures_async", + "title": "DatasetService listFeatures Sample", + "origin": "API_DEFINITION", + "description": " Lists Features in a given EntityType.", + "canonical": true, + "file": "featurestore_service.list_features.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 116, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListFeatures", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "latest_stats_count", + "type": "TYPE_INT32" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListFeaturesResponse", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "ListFeatures", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreService_UpdateFeature_async", + "title": "DatasetService updateFeature Sample", + "origin": "API_DEFINITION", + "description": " Updates the parameters of a single Feature.", + "canonical": true, + "file": "featurestore_service.update_feature.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 70, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateFeature", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.UpdateFeature", + "async": true, + "parameters": [ + { + "name": "feature", + "type": ".google.cloud.aiplatform.v1beta1.Feature" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Feature", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "UpdateFeature", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.UpdateFeature", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreService_DeleteFeature_async", + "title": "DatasetService deleteFeature Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single Feature.", + "canonical": true, + "file": "featurestore_service.delete_feature.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteFeature", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.DeleteFeature", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "DeleteFeature", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.DeleteFeature", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreService_ImportFeatureValues_async", + "title": "DatasetService importFeatureValues Sample", + "origin": "API_DEFINITION", + "description": " Imports Feature values into the Featurestore from a source storage. The progress of the import is tracked by the returned operation. The imported features are guaranteed to be visible to subsequent read operations after the operation is marked as successfully done. If an import operation fails, the Feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same import request again and wait till the new operation returned is marked as successfully done. There are also scenarios where the caller can cause inconsistency. - Source data for import contains multiple distinct Feature values for the same entity ID and timestamp. - Source is modified during an import. This includes adding, updating, or removing source data and/or metadata. Examples of updating metadata include but are not limited to changing storage location, storage class, or retention policy. - Online serving cluster is under-provisioned.", + "canonical": true, + "file": "featurestore_service.import_feature_values.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 106, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ImportFeatureValues", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.ImportFeatureValues", + "async": true, + "parameters": [ + { + "name": "avro_source", + "type": ".google.cloud.aiplatform.v1beta1.AvroSource" + }, + { + "name": "bigquery_source", + "type": ".google.cloud.aiplatform.v1beta1.BigQuerySource" + }, + { + "name": "csv_source", + "type": ".google.cloud.aiplatform.v1beta1.CsvSource" + }, + { + "name": "feature_time_field", + "type": "TYPE_STRING" + }, + { + "name": "feature_time", + "type": ".google.protobuf.Timestamp" + }, + { + "name": "entity_type", + "type": "TYPE_STRING" + }, + { + "name": "entity_id_field", + "type": "TYPE_STRING" + }, + { + "name": "feature_specs", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "disable_online_serving", + "type": "TYPE_BOOL" + }, + { + "name": "worker_count", + "type": "TYPE_INT32" + }, + { + "name": "disable_ingestion_analysis", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "ImportFeatureValues", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.ImportFeatureValues", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreService_BatchReadFeatureValues_async", + "title": "DatasetService batchReadFeatureValues Sample", + "origin": "API_DEFINITION", + "description": " Batch reads Feature values from a Featurestore. This API enables batch reading Feature values, where each read instance in the batch may read Feature values of entities from one or more EntityTypes. Point-in-time correctness is guaranteed for Feature values of each read instance as of each instance's read timestamp.", + "canonical": true, + "file": "featurestore_service.batch_read_feature_values.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 109, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchReadFeatureValues", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.BatchReadFeatureValues", + "async": true, + "parameters": [ + { + "name": "csv_read_instances", + "type": ".google.cloud.aiplatform.v1beta1.CsvSource" + }, + { + "name": "bigquery_read_instances", + "type": ".google.cloud.aiplatform.v1beta1.BigQuerySource" + }, + { + "name": "featurestore", + "type": "TYPE_STRING" + }, + { + "name": "destination", + "type": ".google.cloud.aiplatform.v1beta1.FeatureValueDestination" + }, + { + "name": "pass_through_fields", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "entity_type_specs", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "start_time", + "type": ".google.protobuf.Timestamp" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "BatchReadFeatureValues", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.BatchReadFeatureValues", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreService_ExportFeatureValues_async", + "title": "DatasetService exportFeatureValues Sample", + "origin": "API_DEFINITION", + "description": " Exports Feature values from all the entities of a target EntityType.", + "canonical": true, + "file": "featurestore_service.export_feature_values.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ExportFeatureValues", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.ExportFeatureValues", + "async": true, + "parameters": [ + { + "name": "snapshot_export", + "type": ".google.cloud.aiplatform.v1beta1.ExportFeatureValuesRequest.SnapshotExport" + }, + { + "name": "full_export", + "type": ".google.cloud.aiplatform.v1beta1.ExportFeatureValuesRequest.FullExport" + }, + { + "name": "entity_type", + "type": "TYPE_STRING" + }, + { + "name": "destination", + "type": ".google.cloud.aiplatform.v1beta1.FeatureValueDestination" + }, + { + "name": "feature_selector", + "type": ".google.cloud.aiplatform.v1beta1.FeatureSelector" + }, + { + "name": "settings", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "ExportFeatureValues", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.ExportFeatureValues", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreService_DeleteFeatureValues_async", + "title": "DatasetService deleteFeatureValues Sample", + "origin": "API_DEFINITION", + "description": " Delete Feature values from Featurestore. The progress of the deletion is tracked by the returned operation. The deleted feature values are guaranteed to be invisible to subsequent read operations after the operation is marked as successfully done. If a delete feature values operation fails, the feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same delete request again and wait till the new operation returned is marked as successfully done.", + "canonical": true, + "file": "featurestore_service.delete_feature_values.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteFeatureValues", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.DeleteFeatureValues", + "async": true, + "parameters": [ + { + "name": "select_entity", + "type": ".google.cloud.aiplatform.v1beta1.DeleteFeatureValuesRequest.SelectEntity" + }, + { + "name": "select_time_range_and_feature", + "type": ".google.cloud.aiplatform.v1beta1.DeleteFeatureValuesRequest.SelectTimeRangeAndFeature" + }, + { + "name": "entity_type", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "DeleteFeatureValues", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.DeleteFeatureValues", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_FeaturestoreService_SearchFeatures_async", + "title": "DatasetService searchFeatures Sample", + "origin": "API_DEFINITION", + "description": " Searches Features matching a query in a given project.", + "canonical": true, + "file": "featurestore_service.search_features.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 124, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SearchFeatures", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures", + "async": true, + "parameters": [ + { + "name": "location", + "type": "TYPE_STRING" + }, + { + "name": "query", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.SearchFeaturesResponse", + "client": { + "shortName": "FeaturestoreServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreServiceClient" + }, + "method": { + "shortName": "SearchFeatures", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures", + "service": { + "shortName": "FeaturestoreService", + "fullName": "google.cloud.aiplatform.v1beta1.FeaturestoreService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_IndexEndpointService_CreateIndexEndpoint_async", + "title": "DatasetService createIndexEndpoint Sample", + "origin": "API_DEFINITION", + "description": " Creates an IndexEndpoint.", + "canonical": true, + "file": "index_endpoint_service.create_index_endpoint.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateIndexEndpoint", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService.CreateIndexEndpoint", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "index_endpoint", + "type": ".google.cloud.aiplatform.v1beta1.IndexEndpoint" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "IndexEndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointServiceClient" + }, + "method": { + "shortName": "CreateIndexEndpoint", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService.CreateIndexEndpoint", + "service": { + "shortName": "IndexEndpointService", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_IndexEndpointService_GetIndexEndpoint_async", + "title": "DatasetService getIndexEndpoint Sample", + "origin": "API_DEFINITION", + "description": " Gets an IndexEndpoint.", + "canonical": true, + "file": "index_endpoint_service.get_index_endpoint.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetIndexEndpoint", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService.GetIndexEndpoint", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.IndexEndpoint", + "client": { + "shortName": "IndexEndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointServiceClient" + }, + "method": { + "shortName": "GetIndexEndpoint", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService.GetIndexEndpoint", + "service": { + "shortName": "IndexEndpointService", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_IndexEndpointService_ListIndexEndpoints_async", + "title": "DatasetService listIndexEndpoints Sample", + "origin": "API_DEFINITION", + "description": " Lists IndexEndpoints in a Location.", + "canonical": true, + "file": "index_endpoint_service.list_index_endpoints.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 92, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListIndexEndpoints", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService.ListIndexEndpoints", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListIndexEndpointsResponse", + "client": { + "shortName": "IndexEndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointServiceClient" + }, + "method": { + "shortName": "ListIndexEndpoints", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService.ListIndexEndpoints", + "service": { + "shortName": "IndexEndpointService", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_IndexEndpointService_UpdateIndexEndpoint_async", + "title": "DatasetService updateIndexEndpoint Sample", + "origin": "API_DEFINITION", + "description": " Updates an IndexEndpoint.", + "canonical": true, + "file": "index_endpoint_service.update_index_endpoint.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateIndexEndpoint", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService.UpdateIndexEndpoint", + "async": true, + "parameters": [ + { + "name": "index_endpoint", + "type": ".google.cloud.aiplatform.v1beta1.IndexEndpoint" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.IndexEndpoint", + "client": { + "shortName": "IndexEndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointServiceClient" + }, + "method": { + "shortName": "UpdateIndexEndpoint", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService.UpdateIndexEndpoint", + "service": { + "shortName": "IndexEndpointService", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_IndexEndpointService_DeleteIndexEndpoint_async", + "title": "DatasetService deleteIndexEndpoint Sample", + "origin": "API_DEFINITION", + "description": " Deletes an IndexEndpoint.", + "canonical": true, + "file": "index_endpoint_service.delete_index_endpoint.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteIndexEndpoint", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService.DeleteIndexEndpoint", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "IndexEndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointServiceClient" + }, + "method": { + "shortName": "DeleteIndexEndpoint", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService.DeleteIndexEndpoint", + "service": { + "shortName": "IndexEndpointService", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_IndexEndpointService_DeployIndex_async", + "title": "DatasetService deployIndex Sample", + "origin": "API_DEFINITION", + "description": " Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. Only non-empty Indexes can be deployed.", + "canonical": true, + "file": "index_endpoint_service.deploy_index.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeployIndex", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService.DeployIndex", + "async": true, + "parameters": [ + { + "name": "index_endpoint", + "type": "TYPE_STRING" + }, + { + "name": "deployed_index", + "type": ".google.cloud.aiplatform.v1beta1.DeployedIndex" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "IndexEndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointServiceClient" + }, + "method": { + "shortName": "DeployIndex", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService.DeployIndex", + "service": { + "shortName": "IndexEndpointService", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_IndexEndpointService_UndeployIndex_async", + "title": "DatasetService undeployIndex Sample", + "origin": "API_DEFINITION", + "description": " Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.", + "canonical": true, + "file": "index_endpoint_service.undeploy_index.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UndeployIndex", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService.UndeployIndex", + "async": true, + "parameters": [ + { + "name": "index_endpoint", + "type": "TYPE_STRING" + }, + { + "name": "deployed_index_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "IndexEndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointServiceClient" + }, + "method": { + "shortName": "UndeployIndex", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService.UndeployIndex", + "service": { + "shortName": "IndexEndpointService", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_IndexEndpointService_MutateDeployedIndex_async", + "title": "DatasetService mutateDeployedIndex Sample", + "origin": "API_DEFINITION", + "description": " Update an existing DeployedIndex under an IndexEndpoint.", + "canonical": true, + "file": "index_endpoint_service.mutate_deployed_index.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "MutateDeployedIndex", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService.MutateDeployedIndex", + "async": true, + "parameters": [ + { + "name": "index_endpoint", + "type": "TYPE_STRING" + }, + { + "name": "deployed_index", + "type": ".google.cloud.aiplatform.v1beta1.DeployedIndex" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "IndexEndpointServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointServiceClient" + }, + "method": { + "shortName": "MutateDeployedIndex", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService.MutateDeployedIndex", + "service": { + "shortName": "IndexEndpointService", + "fullName": "google.cloud.aiplatform.v1beta1.IndexEndpointService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_IndexService_CreateIndex_async", + "title": "DatasetService createIndex Sample", + "origin": "API_DEFINITION", + "description": " Creates an Index.", + "canonical": true, + "file": "index_service.create_index.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateIndex", + "fullName": "google.cloud.aiplatform.v1beta1.IndexService.CreateIndex", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "index", + "type": ".google.cloud.aiplatform.v1beta1.Index" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "IndexServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.IndexServiceClient" + }, + "method": { + "shortName": "CreateIndex", + "fullName": "google.cloud.aiplatform.v1beta1.IndexService.CreateIndex", + "service": { + "shortName": "IndexService", + "fullName": "google.cloud.aiplatform.v1beta1.IndexService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_IndexService_GetIndex_async", + "title": "DatasetService getIndex Sample", + "origin": "API_DEFINITION", + "description": " Gets an Index.", + "canonical": true, + "file": "index_service.get_index.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetIndex", + "fullName": "google.cloud.aiplatform.v1beta1.IndexService.GetIndex", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Index", + "client": { + "shortName": "IndexServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.IndexServiceClient" + }, + "method": { + "shortName": "GetIndex", + "fullName": "google.cloud.aiplatform.v1beta1.IndexService.GetIndex", + "service": { + "shortName": "IndexService", + "fullName": "google.cloud.aiplatform.v1beta1.IndexService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_IndexService_ListIndexes_async", + "title": "DatasetService listIndexes Sample", + "origin": "API_DEFINITION", + "description": " Lists Indexes in a Location.", + "canonical": true, + "file": "index_service.list_indexes.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 77, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListIndexes", + "fullName": "google.cloud.aiplatform.v1beta1.IndexService.ListIndexes", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListIndexesResponse", + "client": { + "shortName": "IndexServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.IndexServiceClient" + }, + "method": { + "shortName": "ListIndexes", + "fullName": "google.cloud.aiplatform.v1beta1.IndexService.ListIndexes", + "service": { + "shortName": "IndexService", + "fullName": "google.cloud.aiplatform.v1beta1.IndexService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_IndexService_UpdateIndex_async", + "title": "DatasetService updateIndex Sample", + "origin": "API_DEFINITION", + "description": " Updates an Index.", + "canonical": true, + "file": "index_service.update_index.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateIndex", + "fullName": "google.cloud.aiplatform.v1beta1.IndexService.UpdateIndex", + "async": true, + "parameters": [ + { + "name": "index", + "type": ".google.cloud.aiplatform.v1beta1.Index" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "IndexServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.IndexServiceClient" + }, + "method": { + "shortName": "UpdateIndex", + "fullName": "google.cloud.aiplatform.v1beta1.IndexService.UpdateIndex", + "service": { + "shortName": "IndexService", + "fullName": "google.cloud.aiplatform.v1beta1.IndexService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_IndexService_DeleteIndex_async", + "title": "DatasetService deleteIndex Sample", + "origin": "API_DEFINITION", + "description": " Deletes an Index. An Index can only be deleted when all its [DeployedIndexes][google.cloud.aiplatform.v1beta1.Index.deployed_indexes] had been undeployed.", + "canonical": true, + "file": "index_service.delete_index.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteIndex", + "fullName": "google.cloud.aiplatform.v1beta1.IndexService.DeleteIndex", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "IndexServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.IndexServiceClient" + }, + "method": { + "shortName": "DeleteIndex", + "fullName": "google.cloud.aiplatform.v1beta1.IndexService.DeleteIndex", + "service": { + "shortName": "IndexService", + "fullName": "google.cloud.aiplatform.v1beta1.IndexService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_IndexService_UpsertDatapoints_async", + "title": "DatasetService upsertDatapoints Sample", + "origin": "API_DEFINITION", + "description": " Add/update Datapoints into an Index.", + "canonical": true, + "file": "index_service.upsert_datapoints.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpsertDatapoints", + "fullName": "google.cloud.aiplatform.v1beta1.IndexService.UpsertDatapoints", + "async": true, + "parameters": [ + { + "name": "index", + "type": "TYPE_STRING" + }, + { + "name": "datapoints", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.UpsertDatapointsResponse", + "client": { + "shortName": "IndexServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.IndexServiceClient" + }, + "method": { + "shortName": "UpsertDatapoints", + "fullName": "google.cloud.aiplatform.v1beta1.IndexService.UpsertDatapoints", + "service": { + "shortName": "IndexService", + "fullName": "google.cloud.aiplatform.v1beta1.IndexService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_IndexService_RemoveDatapoints_async", + "title": "DatasetService removeDatapoints Sample", + "origin": "API_DEFINITION", + "description": " Remove Datapoints from an Index.", + "canonical": true, + "file": "index_service.remove_datapoints.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RemoveDatapoints", + "fullName": "google.cloud.aiplatform.v1beta1.IndexService.RemoveDatapoints", + "async": true, + "parameters": [ + { + "name": "index", + "type": "TYPE_STRING" + }, + { + "name": "datapoint_ids", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.RemoveDatapointsResponse", + "client": { + "shortName": "IndexServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.IndexServiceClient" + }, + "method": { + "shortName": "RemoveDatapoints", + "fullName": "google.cloud.aiplatform.v1beta1.IndexService.RemoveDatapoints", + "service": { + "shortName": "IndexService", + "fullName": "google.cloud.aiplatform.v1beta1.IndexService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_CreateCustomJob_async", + "title": "DatasetService createCustomJob Sample", + "origin": "API_DEFINITION", + "description": " Creates a CustomJob. A created CustomJob right away will be attempted to be run.", + "canonical": true, + "file": "job_service.create_custom_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateCustomJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.CreateCustomJob", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "custom_job", + "type": ".google.cloud.aiplatform.v1beta1.CustomJob" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.CustomJob", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "CreateCustomJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.CreateCustomJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_GetCustomJob_async", + "title": "DatasetService getCustomJob Sample", + "origin": "API_DEFINITION", + "description": " Gets a CustomJob.", + "canonical": true, + "file": "job_service.get_custom_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetCustomJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.GetCustomJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.CustomJob", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "GetCustomJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.GetCustomJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_ListCustomJobs_async", + "title": "DatasetService listCustomJobs Sample", + "origin": "API_DEFINITION", + "description": " Lists CustomJobs in a Location.", + "canonical": true, + "file": "job_service.list_custom_jobs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 92, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListCustomJobs", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.ListCustomJobs", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListCustomJobsResponse", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "ListCustomJobs", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.ListCustomJobs", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_DeleteCustomJob_async", + "title": "DatasetService deleteCustomJob Sample", + "origin": "API_DEFINITION", + "description": " Deletes a CustomJob.", + "canonical": true, + "file": "job_service.delete_custom_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteCustomJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.DeleteCustomJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "DeleteCustomJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.DeleteCustomJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_CancelCustomJob_async", + "title": "DatasetService cancelCustomJob Sample", + "origin": "API_DEFINITION", + "description": " Cancels a CustomJob. Starts asynchronous cancellation on the CustomJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use [JobService.GetCustomJob][google.cloud.aiplatform.v1beta1.JobService.GetCustomJob] or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the CustomJob is not deleted; instead it becomes a job with a [CustomJob.error][google.cloud.aiplatform.v1beta1.CustomJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [CustomJob.state][google.cloud.aiplatform.v1beta1.CustomJob.state] is set to `CANCELLED`.", + "canonical": true, + "file": "job_service.cancel_custom_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CancelCustomJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.CancelCustomJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "CancelCustomJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.CancelCustomJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_CreateDataLabelingJob_async", + "title": "DatasetService createDataLabelingJob Sample", + "origin": "API_DEFINITION", + "description": " Creates a DataLabelingJob.", + "canonical": true, + "file": "job_service.create_data_labeling_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateDataLabelingJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.CreateDataLabelingJob", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "data_labeling_job", + "type": ".google.cloud.aiplatform.v1beta1.DataLabelingJob" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.DataLabelingJob", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "CreateDataLabelingJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.CreateDataLabelingJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_GetDataLabelingJob_async", + "title": "DatasetService getDataLabelingJob Sample", + "origin": "API_DEFINITION", + "description": " Gets a DataLabelingJob.", + "canonical": true, + "file": "job_service.get_data_labeling_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetDataLabelingJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.GetDataLabelingJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.DataLabelingJob", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "GetDataLabelingJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.GetDataLabelingJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_ListDataLabelingJobs_async", + "title": "DatasetService listDataLabelingJobs Sample", + "origin": "API_DEFINITION", + "description": " Lists DataLabelingJobs in a Location.", + "canonical": true, + "file": "job_service.list_data_labeling_jobs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 96, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListDataLabelingJobs", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.ListDataLabelingJobs", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListDataLabelingJobsResponse", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "ListDataLabelingJobs", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.ListDataLabelingJobs", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_DeleteDataLabelingJob_async", + "title": "DatasetService deleteDataLabelingJob Sample", + "origin": "API_DEFINITION", + "description": " Deletes a DataLabelingJob.", + "canonical": true, + "file": "job_service.delete_data_labeling_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteDataLabelingJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.DeleteDataLabelingJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "DeleteDataLabelingJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.DeleteDataLabelingJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_CancelDataLabelingJob_async", + "title": "DatasetService cancelDataLabelingJob Sample", + "origin": "API_DEFINITION", + "description": " Cancels a DataLabelingJob. Success of cancellation is not guaranteed.", + "canonical": true, + "file": "job_service.cancel_data_labeling_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CancelDataLabelingJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.CancelDataLabelingJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "CancelDataLabelingJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.CancelDataLabelingJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_CreateHyperparameterTuningJob_async", + "title": "DatasetService createHyperparameterTuningJob Sample", + "origin": "API_DEFINITION", + "description": " Creates a HyperparameterTuningJob", + "canonical": true, + "file": "job_service.create_hyperparameter_tuning_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateHyperparameterTuningJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.CreateHyperparameterTuningJob", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "hyperparameter_tuning_job", + "type": ".google.cloud.aiplatform.v1beta1.HyperparameterTuningJob" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.HyperparameterTuningJob", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "CreateHyperparameterTuningJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.CreateHyperparameterTuningJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_GetHyperparameterTuningJob_async", + "title": "DatasetService getHyperparameterTuningJob Sample", + "origin": "API_DEFINITION", + "description": " Gets a HyperparameterTuningJob", + "canonical": true, + "file": "job_service.get_hyperparameter_tuning_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetHyperparameterTuningJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.GetHyperparameterTuningJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.HyperparameterTuningJob", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "GetHyperparameterTuningJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.GetHyperparameterTuningJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_ListHyperparameterTuningJobs_async", + "title": "DatasetService listHyperparameterTuningJobs Sample", + "origin": "API_DEFINITION", + "description": " Lists HyperparameterTuningJobs in a Location.", + "canonical": true, + "file": "job_service.list_hyperparameter_tuning_jobs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 93, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListHyperparameterTuningJobs", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.ListHyperparameterTuningJobs", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListHyperparameterTuningJobsResponse", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "ListHyperparameterTuningJobs", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.ListHyperparameterTuningJobs", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_DeleteHyperparameterTuningJob_async", + "title": "DatasetService deleteHyperparameterTuningJob Sample", + "origin": "API_DEFINITION", + "description": " Deletes a HyperparameterTuningJob.", + "canonical": true, + "file": "job_service.delete_hyperparameter_tuning_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteHyperparameterTuningJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.DeleteHyperparameterTuningJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "DeleteHyperparameterTuningJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.DeleteHyperparameterTuningJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_CancelHyperparameterTuningJob_async", + "title": "DatasetService cancelHyperparameterTuningJob Sample", + "origin": "API_DEFINITION", + "description": " Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on the HyperparameterTuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use [JobService.GetHyperparameterTuningJob][google.cloud.aiplatform.v1beta1.JobService.GetHyperparameterTuningJob] or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the HyperparameterTuningJob is not deleted; instead it becomes a job with a [HyperparameterTuningJob.error][google.cloud.aiplatform.v1beta1.HyperparameterTuningJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [HyperparameterTuningJob.state][google.cloud.aiplatform.v1beta1.HyperparameterTuningJob.state] is set to `CANCELLED`.", + "canonical": true, + "file": "job_service.cancel_hyperparameter_tuning_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CancelHyperparameterTuningJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.CancelHyperparameterTuningJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "CancelHyperparameterTuningJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.CancelHyperparameterTuningJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_CreateBatchPredictionJob_async", + "title": "DatasetService createBatchPredictionJob Sample", + "origin": "API_DEFINITION", + "description": " Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.", + "canonical": true, + "file": "job_service.create_batch_prediction_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateBatchPredictionJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.CreateBatchPredictionJob", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "batch_prediction_job", + "type": ".google.cloud.aiplatform.v1beta1.BatchPredictionJob" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.BatchPredictionJob", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "CreateBatchPredictionJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.CreateBatchPredictionJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_GetBatchPredictionJob_async", + "title": "DatasetService getBatchPredictionJob Sample", + "origin": "API_DEFINITION", + "description": " Gets a BatchPredictionJob", + "canonical": true, + "file": "job_service.get_batch_prediction_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetBatchPredictionJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.GetBatchPredictionJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.BatchPredictionJob", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "GetBatchPredictionJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.GetBatchPredictionJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_ListBatchPredictionJobs_async", + "title": "DatasetService listBatchPredictionJobs Sample", + "origin": "API_DEFINITION", + "description": " Lists BatchPredictionJobs in a Location.", + "canonical": true, + "file": "job_service.list_batch_prediction_jobs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 93, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListBatchPredictionJobs", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.ListBatchPredictionJobs", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListBatchPredictionJobsResponse", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "ListBatchPredictionJobs", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.ListBatchPredictionJobs", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_DeleteBatchPredictionJob_async", + "title": "DatasetService deleteBatchPredictionJob Sample", + "origin": "API_DEFINITION", + "description": " Deletes a BatchPredictionJob. Can only be called on jobs that already finished.", + "canonical": true, + "file": "job_service.delete_batch_prediction_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteBatchPredictionJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.DeleteBatchPredictionJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "DeleteBatchPredictionJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.DeleteBatchPredictionJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_CancelBatchPredictionJob_async", + "title": "DatasetService cancelBatchPredictionJob Sample", + "origin": "API_DEFINITION", + "description": " Cancels a BatchPredictionJob. Starts asynchronous cancellation on the BatchPredictionJob. The server makes the best effort to cancel the job, but success is not guaranteed. Clients can use [JobService.GetBatchPredictionJob][google.cloud.aiplatform.v1beta1.JobService.GetBatchPredictionJob] or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob is not deleted;instead its [BatchPredictionJob.state][google.cloud.aiplatform.v1beta1.BatchPredictionJob.state] is set to `CANCELLED`. Any files already outputted by the job are not deleted.", + "canonical": true, + "file": "job_service.cancel_batch_prediction_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CancelBatchPredictionJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.CancelBatchPredictionJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "CancelBatchPredictionJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.CancelBatchPredictionJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_CreateModelDeploymentMonitoringJob_async", + "title": "DatasetService createModelDeploymentMonitoringJob Sample", + "origin": "API_DEFINITION", + "description": " Creates a ModelDeploymentMonitoringJob. It will run periodically on a configured interval.", + "canonical": true, + "file": "job_service.create_model_deployment_monitoring_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.CreateModelDeploymentMonitoringJob", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "model_deployment_monitoring_job", + "type": ".google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "CreateModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.CreateModelDeploymentMonitoringJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_SearchModelDeploymentMonitoringStatsAnomalies_async", + "title": "DatasetService searchModelDeploymentMonitoringStatsAnomalies Sample", + "origin": "API_DEFINITION", + "description": " Searches Model Monitoring Statistics generated within a given time window.", + "canonical": true, + "file": "job_service.search_model_deployment_monitoring_stats_anomalies.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 95, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SearchModelDeploymentMonitoringStatsAnomalies", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.SearchModelDeploymentMonitoringStatsAnomalies", + "async": true, + "parameters": [ + { + "name": "model_deployment_monitoring_job", + "type": "TYPE_STRING" + }, + { + "name": "deployed_model_id", + "type": "TYPE_STRING" + }, + { + "name": "feature_display_name", + "type": "TYPE_STRING" + }, + { + "name": "objectives", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "start_time", + "type": ".google.protobuf.Timestamp" + }, + { + "name": "end_time", + "type": ".google.protobuf.Timestamp" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.SearchModelDeploymentMonitoringStatsAnomaliesResponse", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "SearchModelDeploymentMonitoringStatsAnomalies", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.SearchModelDeploymentMonitoringStatsAnomalies", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_GetModelDeploymentMonitoringJob_async", + "title": "DatasetService getModelDeploymentMonitoringJob Sample", + "origin": "API_DEFINITION", + "description": " Gets a ModelDeploymentMonitoringJob.", + "canonical": true, + "file": "job_service.get_model_deployment_monitoring_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.GetModelDeploymentMonitoringJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "GetModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.GetModelDeploymentMonitoringJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_ListModelDeploymentMonitoringJobs_async", + "title": "DatasetService listModelDeploymentMonitoringJobs Sample", + "origin": "API_DEFINITION", + "description": " Lists ModelDeploymentMonitoringJobs in a Location.", + "canonical": true, + "file": "job_service.list_model_deployment_monitoring_jobs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 87, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListModelDeploymentMonitoringJobs", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.ListModelDeploymentMonitoringJobs", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListModelDeploymentMonitoringJobsResponse", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "ListModelDeploymentMonitoringJobs", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.ListModelDeploymentMonitoringJobs", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_UpdateModelDeploymentMonitoringJob_async", + "title": "DatasetService updateModelDeploymentMonitoringJob Sample", + "origin": "API_DEFINITION", + "description": " Updates a ModelDeploymentMonitoringJob.", + "canonical": true, + "file": "job_service.update_model_deployment_monitoring_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 83, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.UpdateModelDeploymentMonitoringJob", + "async": true, + "parameters": [ + { + "name": "model_deployment_monitoring_job", + "type": ".google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "UpdateModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.UpdateModelDeploymentMonitoringJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_DeleteModelDeploymentMonitoringJob_async", + "title": "DatasetService deleteModelDeploymentMonitoringJob Sample", + "origin": "API_DEFINITION", + "description": " Deletes a ModelDeploymentMonitoringJob.", + "canonical": true, + "file": "job_service.delete_model_deployment_monitoring_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.DeleteModelDeploymentMonitoringJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "DeleteModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.DeleteModelDeploymentMonitoringJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_PauseModelDeploymentMonitoringJob_async", + "title": "DatasetService pauseModelDeploymentMonitoringJob Sample", + "origin": "API_DEFINITION", + "description": " Pauses a ModelDeploymentMonitoringJob. If the job is running, the server makes a best effort to cancel the job. Will mark [ModelDeploymentMonitoringJob.state][google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob.state] to 'PAUSED'.", + "canonical": true, + "file": "job_service.pause_model_deployment_monitoring_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "PauseModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.PauseModelDeploymentMonitoringJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "PauseModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.PauseModelDeploymentMonitoringJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_JobService_ResumeModelDeploymentMonitoringJob_async", + "title": "DatasetService resumeModelDeploymentMonitoringJob Sample", + "origin": "API_DEFINITION", + "description": " Resumes a paused ModelDeploymentMonitoringJob. It will start to run from next scheduled time. A deleted ModelDeploymentMonitoringJob can't be resumed.", + "canonical": true, + "file": "job_service.resume_model_deployment_monitoring_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ResumeModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.ResumeModelDeploymentMonitoringJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "JobServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.JobServiceClient" + }, + "method": { + "shortName": "ResumeModelDeploymentMonitoringJob", + "fullName": "google.cloud.aiplatform.v1beta1.JobService.ResumeModelDeploymentMonitoringJob", + "service": { + "shortName": "JobService", + "fullName": "google.cloud.aiplatform.v1beta1.JobService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_CreateMetadataStore_async", + "title": "DatasetService createMetadataStore Sample", + "origin": "API_DEFINITION", + "description": " Initializes a MetadataStore, including allocation of resources.", + "canonical": true, + "file": "metadata_service.create_metadata_store.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateMetadataStore", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.CreateMetadataStore", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "metadata_store", + "type": ".google.cloud.aiplatform.v1beta1.MetadataStore" + }, + { + "name": "metadata_store_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "CreateMetadataStore", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.CreateMetadataStore", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_GetMetadataStore_async", + "title": "DatasetService getMetadataStore Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a specific MetadataStore.", + "canonical": true, + "file": "metadata_service.get_metadata_store.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetMetadataStore", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.GetMetadataStore", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.MetadataStore", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "GetMetadataStore", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.GetMetadataStore", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_ListMetadataStores_async", + "title": "DatasetService listMetadataStores Sample", + "origin": "API_DEFINITION", + "description": " Lists MetadataStores for a Location.", + "canonical": true, + "file": "metadata_service.list_metadata_stores.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListMetadataStores", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataStores", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListMetadataStoresResponse", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "ListMetadataStores", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataStores", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_DeleteMetadataStore_async", + "title": "DatasetService deleteMetadataStore Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts).", + "canonical": true, + "file": "metadata_service.delete_metadata_store.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteMetadataStore", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.DeleteMetadataStore", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "DeleteMetadataStore", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.DeleteMetadataStore", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_CreateArtifact_async", + "title": "DatasetService createArtifact Sample", + "origin": "API_DEFINITION", + "description": " Creates an Artifact associated with a MetadataStore.", + "canonical": true, + "file": "metadata_service.create_artifact.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateArtifact", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.CreateArtifact", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "artifact", + "type": ".google.cloud.aiplatform.v1beta1.Artifact" + }, + { + "name": "artifact_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Artifact", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "CreateArtifact", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.CreateArtifact", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_GetArtifact_async", + "title": "DatasetService getArtifact Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a specific Artifact.", + "canonical": true, + "file": "metadata_service.get_artifact.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetArtifact", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.GetArtifact", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Artifact", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "GetArtifact", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.GetArtifact", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_ListArtifacts_async", + "title": "DatasetService listArtifacts Sample", + "origin": "API_DEFINITION", + "description": " Lists Artifacts in the MetadataStore.", + "canonical": true, + "file": "metadata_service.list_artifacts.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 108, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListArtifacts", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.ListArtifacts", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListArtifactsResponse", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "ListArtifacts", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.ListArtifacts", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_UpdateArtifact_async", + "title": "DatasetService updateArtifact Sample", + "origin": "API_DEFINITION", + "description": " Updates a stored Artifact.", + "canonical": true, + "file": "metadata_service.update_artifact.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateArtifact", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.UpdateArtifact", + "async": true, + "parameters": [ + { + "name": "artifact", + "type": ".google.cloud.aiplatform.v1beta1.Artifact" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "allow_missing", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Artifact", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "UpdateArtifact", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.UpdateArtifact", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_DeleteArtifact_async", + "title": "DatasetService deleteArtifact Sample", + "origin": "API_DEFINITION", + "description": " Deletes an Artifact.", + "canonical": true, + "file": "metadata_service.delete_artifact.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteArtifact", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.DeleteArtifact", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "etag", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "DeleteArtifact", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.DeleteArtifact", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_PurgeArtifacts_async", + "title": "DatasetService purgeArtifacts Sample", + "origin": "API_DEFINITION", + "description": " Purges Artifacts.", + "canonical": true, + "file": "metadata_service.purge_artifacts.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "PurgeArtifacts", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.PurgeArtifacts", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "PurgeArtifacts", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.PurgeArtifacts", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_CreateContext_async", + "title": "DatasetService createContext Sample", + "origin": "API_DEFINITION", + "description": " Creates a Context associated with a MetadataStore.", + "canonical": true, + "file": "metadata_service.create_context.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 70, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateContext", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.CreateContext", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "context", + "type": ".google.cloud.aiplatform.v1beta1.Context" + }, + { + "name": "context_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Context", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "CreateContext", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.CreateContext", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_GetContext_async", + "title": "DatasetService getContext Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a specific Context.", + "canonical": true, + "file": "metadata_service.get_context.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetContext", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.GetContext", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Context", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "GetContext", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.GetContext", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_ListContexts_async", + "title": "DatasetService listContexts Sample", + "origin": "API_DEFINITION", + "description": " Lists Contexts on the MetadataStore.", + "canonical": true, + "file": "metadata_service.list_contexts.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 111, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListContexts", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.ListContexts", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListContextsResponse", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "ListContexts", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.ListContexts", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_UpdateContext_async", + "title": "DatasetService updateContext Sample", + "origin": "API_DEFINITION", + "description": " Updates a stored Context.", + "canonical": true, + "file": "metadata_service.update_context.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateContext", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.UpdateContext", + "async": true, + "parameters": [ + { + "name": "context", + "type": ".google.cloud.aiplatform.v1beta1.Context" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "allow_missing", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Context", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "UpdateContext", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.UpdateContext", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_DeleteContext_async", + "title": "DatasetService deleteContext Sample", + "origin": "API_DEFINITION", + "description": " Deletes a stored Context.", + "canonical": true, + "file": "metadata_service.delete_context.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteContext", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.DeleteContext", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" + }, + { + "name": "etag", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "DeleteContext", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.DeleteContext", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_PurgeContexts_async", + "title": "DatasetService purgeContexts Sample", + "origin": "API_DEFINITION", + "description": " Purges Contexts.", + "canonical": true, + "file": "metadata_service.purge_contexts.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "PurgeContexts", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.PurgeContexts", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "PurgeContexts", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.PurgeContexts", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_AddContextArtifactsAndExecutions_async", + "title": "DatasetService addContextArtifactsAndExecutions Sample", + "origin": "API_DEFINITION", + "description": " Adds a set of Artifacts and Executions to a Context. If any of the Artifacts or Executions have already been added to a Context, they are simply skipped.", + "canonical": true, + "file": "metadata_service.add_context_artifacts_and_executions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AddContextArtifactsAndExecutions", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.AddContextArtifactsAndExecutions", + "async": true, + "parameters": [ + { + "name": "context", + "type": "TYPE_STRING" + }, + { + "name": "artifacts", + "type": "TYPE_STRING[]" + }, + { + "name": "executions", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.AddContextArtifactsAndExecutionsResponse", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "AddContextArtifactsAndExecutions", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.AddContextArtifactsAndExecutions", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_AddContextChildren_async", + "title": "DatasetService addContextChildren Sample", + "origin": "API_DEFINITION", + "description": " Adds a set of Contexts as children to a parent Context. If any of the child Contexts have already been added to the parent Context, they are simply skipped. If this call would create a cycle or cause any Context to have more than 10 parents, the request will fail with an INVALID_ARGUMENT error.", + "canonical": true, + "file": "metadata_service.add_context_children.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AddContextChildren", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.AddContextChildren", + "async": true, + "parameters": [ + { + "name": "context", + "type": "TYPE_STRING" + }, + { + "name": "child_contexts", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.AddContextChildrenResponse", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "AddContextChildren", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.AddContextChildren", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_RemoveContextChildren_async", + "title": "DatasetService removeContextChildren Sample", + "origin": "API_DEFINITION", + "description": " Remove a set of children contexts from a parent Context. If any of the child Contexts were NOT added to the parent Context, they are simply skipped.", + "canonical": true, + "file": "metadata_service.remove_context_children.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RemoveContextChildren", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.RemoveContextChildren", + "async": true, + "parameters": [ + { + "name": "context", + "type": "TYPE_STRING" + }, + { + "name": "child_contexts", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.RemoveContextChildrenResponse", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "RemoveContextChildren", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.RemoveContextChildren", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_QueryContextLineageSubgraph_async", + "title": "DatasetService queryContextLineageSubgraph Sample", + "origin": "API_DEFINITION", + "description": " Retrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph.", + "canonical": true, + "file": "metadata_service.query_context_lineage_subgraph.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "QueryContextLineageSubgraph", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.QueryContextLineageSubgraph", + "async": true, + "parameters": [ + { + "name": "context", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.LineageSubgraph", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "QueryContextLineageSubgraph", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.QueryContextLineageSubgraph", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_CreateExecution_async", + "title": "DatasetService createExecution Sample", + "origin": "API_DEFINITION", + "description": " Creates an Execution associated with a MetadataStore.", + "canonical": true, + "file": "metadata_service.create_execution.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateExecution", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.CreateExecution", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "execution", + "type": ".google.cloud.aiplatform.v1beta1.Execution" + }, + { + "name": "execution_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Execution", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "CreateExecution", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.CreateExecution", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_GetExecution_async", + "title": "DatasetService getExecution Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a specific Execution.", + "canonical": true, + "file": "metadata_service.get_execution.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetExecution", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.GetExecution", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Execution", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "GetExecution", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.GetExecution", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_ListExecutions_async", + "title": "DatasetService listExecutions Sample", + "origin": "API_DEFINITION", + "description": " Lists Executions in the MetadataStore.", + "canonical": true, + "file": "metadata_service.list_executions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 108, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListExecutions", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.ListExecutions", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListExecutionsResponse", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "ListExecutions", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.ListExecutions", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_UpdateExecution_async", + "title": "DatasetService updateExecution Sample", + "origin": "API_DEFINITION", + "description": " Updates a stored Execution.", + "canonical": true, + "file": "metadata_service.update_execution.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateExecution", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.UpdateExecution", + "async": true, + "parameters": [ + { + "name": "execution", + "type": ".google.cloud.aiplatform.v1beta1.Execution" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "allow_missing", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Execution", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "UpdateExecution", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.UpdateExecution", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_DeleteExecution_async", + "title": "DatasetService deleteExecution Sample", + "origin": "API_DEFINITION", + "description": " Deletes an Execution.", + "canonical": true, + "file": "metadata_service.delete_execution.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteExecution", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.DeleteExecution", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "etag", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "DeleteExecution", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.DeleteExecution", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_PurgeExecutions_async", + "title": "DatasetService purgeExecutions Sample", + "origin": "API_DEFINITION", + "description": " Purges Executions.", + "canonical": true, + "file": "metadata_service.purge_executions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "PurgeExecutions", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.PurgeExecutions", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "PurgeExecutions", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.PurgeExecutions", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_AddExecutionEvents_async", + "title": "DatasetService addExecutionEvents Sample", + "origin": "API_DEFINITION", + "description": " Adds Events to the specified Execution. An Event indicates whether an Artifact was used as an input or output for an Execution. If an Event already exists between the Execution and the Artifact, the Event is skipped.", + "canonical": true, + "file": "metadata_service.add_execution_events.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AddExecutionEvents", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.AddExecutionEvents", + "async": true, + "parameters": [ + { + "name": "execution", + "type": "TYPE_STRING" + }, + { + "name": "events", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.AddExecutionEventsResponse", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "AddExecutionEvents", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.AddExecutionEvents", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_QueryExecutionInputsAndOutputs_async", + "title": "DatasetService queryExecutionInputsAndOutputs Sample", + "origin": "API_DEFINITION", + "description": " Obtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events.", + "canonical": true, + "file": "metadata_service.query_execution_inputs_and_outputs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "QueryExecutionInputsAndOutputs", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.QueryExecutionInputsAndOutputs", + "async": true, + "parameters": [ + { + "name": "execution", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.LineageSubgraph", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "QueryExecutionInputsAndOutputs", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.QueryExecutionInputsAndOutputs", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_CreateMetadataSchema_async", + "title": "DatasetService createMetadataSchema Sample", + "origin": "API_DEFINITION", + "description": " Creates a MetadataSchema.", + "canonical": true, + "file": "metadata_service.create_metadata_schema.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateMetadataSchema", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.CreateMetadataSchema", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "metadata_schema", + "type": ".google.cloud.aiplatform.v1beta1.MetadataSchema" + }, + { + "name": "metadata_schema_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.MetadataSchema", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "CreateMetadataSchema", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.CreateMetadataSchema", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_GetMetadataSchema_async", + "title": "DatasetService getMetadataSchema Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a specific MetadataSchema.", + "canonical": true, + "file": "metadata_service.get_metadata_schema.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetMetadataSchema", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.GetMetadataSchema", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.MetadataSchema", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "GetMetadataSchema", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.GetMetadataSchema", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_ListMetadataSchemas_async", + "title": "DatasetService listMetadataSchemas Sample", + "origin": "API_DEFINITION", + "description": " Lists MetadataSchemas.", + "canonical": true, + "file": "metadata_service.list_metadata_schemas.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 76, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListMetadataSchemas", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataSchemas", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListMetadataSchemasResponse", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "ListMetadataSchemas", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataSchemas", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MetadataService_QueryArtifactLineageSubgraph_async", + "title": "DatasetService queryArtifactLineageSubgraph Sample", + "origin": "API_DEFINITION", + "description": " Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph.", + "canonical": true, + "file": "metadata_service.query_artifact_lineage_subgraph.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 88, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "QueryArtifactLineageSubgraph", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.QueryArtifactLineageSubgraph", + "async": true, + "parameters": [ + { + "name": "artifact", + "type": "TYPE_STRING" + }, + { + "name": "max_hops", + "type": "TYPE_INT32" + }, + { + "name": "filter", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.LineageSubgraph", + "client": { + "shortName": "MetadataServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataServiceClient" + }, + "method": { + "shortName": "QueryArtifactLineageSubgraph", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService.QueryArtifactLineageSubgraph", + "service": { + "shortName": "MetadataService", + "fullName": "google.cloud.aiplatform.v1beta1.MetadataService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MigrationService_SearchMigratableResources_async", + "title": "DatasetService searchMigratableResources Sample", + "origin": "API_DEFINITION", + "description": " Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com that can be migrated to Vertex AI's given location.", + "canonical": true, + "file": "migration_service.search_migratable_resources.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 82, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SearchMigratableResources", + "fullName": "google.cloud.aiplatform.v1beta1.MigrationService.SearchMigratableResources", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.SearchMigratableResourcesResponse", + "client": { + "shortName": "MigrationServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MigrationServiceClient" + }, + "method": { + "shortName": "SearchMigratableResources", + "fullName": "google.cloud.aiplatform.v1beta1.MigrationService.SearchMigratableResources", + "service": { + "shortName": "MigrationService", + "fullName": "google.cloud.aiplatform.v1beta1.MigrationService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_MigrationService_BatchMigrateResources_async", + "title": "DatasetService batchMigrateResources Sample", + "origin": "API_DEFINITION", + "description": " Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI.", + "canonical": true, + "file": "migration_service.batch_migrate_resources.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchMigrateResources", + "fullName": "google.cloud.aiplatform.v1beta1.MigrationService.BatchMigrateResources", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "migrate_resource_requests", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "MigrationServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.MigrationServiceClient" + }, + "method": { + "shortName": "BatchMigrateResources", + "fullName": "google.cloud.aiplatform.v1beta1.MigrationService.BatchMigrateResources", + "service": { + "shortName": "MigrationService", + "fullName": "google.cloud.aiplatform.v1beta1.MigrationService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_ModelService_UploadModel_async", + "title": "DatasetService uploadModel Sample", + "origin": "API_DEFINITION", + "description": " Uploads a Model artifact into Vertex AI.", + "canonical": true, + "file": "model_service.upload_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 82, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UploadModel", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.UploadModel", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "parent_model", + "type": "TYPE_STRING" + }, + { + "name": "model_id", + "type": "TYPE_STRING" + }, + { + "name": "model", + "type": ".google.cloud.aiplatform.v1beta1.Model" + }, + { + "name": "service_account", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.ModelServiceClient" + }, + "method": { + "shortName": "UploadModel", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.UploadModel", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_ModelService_GetModel_async", + "title": "DatasetService getModel Sample", + "origin": "API_DEFINITION", + "description": " Gets a Model.", + "canonical": true, + "file": "model_service.get_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetModel", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.GetModel", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Model", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.ModelServiceClient" + }, + "method": { + "shortName": "GetModel", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.GetModel", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_ModelService_ListModels_async", + "title": "DatasetService listModels Sample", + "origin": "API_DEFINITION", + "description": " Lists Models in a Location.", + "canonical": true, + "file": "model_service.list_models.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 90, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListModels", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.ListModels", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListModelsResponse", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.ModelServiceClient" + }, + "method": { + "shortName": "ListModels", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.ListModels", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_ModelService_ListModelVersions_async", + "title": "DatasetService listModelVersions Sample", + "origin": "API_DEFINITION", + "description": " Lists versions of the specified model.", + "canonical": true, + "file": "model_service.list_model_versions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 90, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListModelVersions", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.ListModelVersions", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListModelVersionsResponse", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.ModelServiceClient" + }, + "method": { + "shortName": "ListModelVersions", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.ListModelVersions", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_ModelService_UpdateModel_async", + "title": "DatasetService updateModel Sample", + "origin": "API_DEFINITION", + "description": " Updates a Model.", + "canonical": true, + "file": "model_service.update_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 77, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateModel", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.UpdateModel", + "async": true, + "parameters": [ + { + "name": "model", + "type": ".google.cloud.aiplatform.v1beta1.Model" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Model", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.ModelServiceClient" + }, + "method": { + "shortName": "UpdateModel", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.UpdateModel", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_ModelService_UpdateExplanationDataset_async", + "title": "DatasetService updateExplanationDataset Sample", + "origin": "API_DEFINITION", + "description": " Incrementally update the dataset used for an examples model.", + "canonical": true, + "file": "model_service.update_explanation_dataset.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateExplanationDataset", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.UpdateExplanationDataset", + "async": true, + "parameters": [ + { + "name": "model", + "type": "TYPE_STRING" + }, + { + "name": "examples", + "type": ".google.cloud.aiplatform.v1beta1.Examples" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.ModelServiceClient" + }, + "method": { + "shortName": "UpdateExplanationDataset", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.UpdateExplanationDataset", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_ModelService_DeleteModel_async", + "title": "DatasetService deleteModel Sample", + "origin": "API_DEFINITION", + "description": " Deletes a Model. A model cannot be deleted if any [Endpoint][google.cloud.aiplatform.v1beta1.Endpoint] resource has a [DeployedModel][google.cloud.aiplatform.v1beta1.DeployedModel] based on the model in its [deployed_models][google.cloud.aiplatform.v1beta1.Endpoint.deployed_models] field.", + "canonical": true, + "file": "model_service.delete_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteModel", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.DeleteModel", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.ModelServiceClient" + }, + "method": { + "shortName": "DeleteModel", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.DeleteModel", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_ModelService_DeleteModelVersion_async", + "title": "DatasetService deleteModelVersion Sample", + "origin": "API_DEFINITION", + "description": " Deletes a Model version. Model version can only be deleted if there are no [DeployedModels][] created from it. Deleting the only version in the Model is not allowed. Use [DeleteModel][google.cloud.aiplatform.v1beta1.ModelService.DeleteModel] for deleting the Model instead.", + "canonical": true, + "file": "model_service.delete_model_version.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteModelVersion", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.DeleteModelVersion", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.ModelServiceClient" + }, + "method": { + "shortName": "DeleteModelVersion", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.DeleteModelVersion", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_ModelService_MergeVersionAliases_async", + "title": "DatasetService mergeVersionAliases Sample", + "origin": "API_DEFINITION", + "description": " Merges a set of aliases for a Model version.", + "canonical": true, + "file": "model_service.merge_version_aliases.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 70, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "MergeVersionAliases", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.MergeVersionAliases", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "version_aliases", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Model", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.ModelServiceClient" + }, + "method": { + "shortName": "MergeVersionAliases", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.MergeVersionAliases", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_ModelService_ExportModel_async", + "title": "DatasetService exportModel Sample", + "origin": "API_DEFINITION", + "description": " Exports a trained, exportable Model to a location specified by the user. A Model is considered to be exportable if it has at least one [supported export format][google.cloud.aiplatform.v1beta1.Model.supported_export_formats].", + "canonical": true, + "file": "model_service.export_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ExportModel", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.ExportModel", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "output_config", + "type": ".google.cloud.aiplatform.v1beta1.ExportModelRequest.OutputConfig" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.ModelServiceClient" + }, + "method": { + "shortName": "ExportModel", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.ExportModel", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_ModelService_ImportModelEvaluation_async", + "title": "DatasetService importModelEvaluation Sample", + "origin": "API_DEFINITION", + "description": " Imports an externally generated ModelEvaluation.", + "canonical": true, + "file": "model_service.import_model_evaluation.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ImportModelEvaluation", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.ImportModelEvaluation", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "model_evaluation", + "type": ".google.cloud.aiplatform.v1beta1.ModelEvaluation" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ModelEvaluation", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.ModelServiceClient" + }, + "method": { + "shortName": "ImportModelEvaluation", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.ImportModelEvaluation", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_ModelService_BatchImportModelEvaluationSlices_async", + "title": "DatasetService batchImportModelEvaluationSlices Sample", + "origin": "API_DEFINITION", + "description": " Imports a list of externally generated ModelEvaluationSlice.", + "canonical": true, + "file": "model_service.batch_import_model_evaluation_slices.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchImportModelEvaluationSlices", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.BatchImportModelEvaluationSlices", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "model_evaluation_slices", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.BatchImportModelEvaluationSlicesResponse", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.ModelServiceClient" + }, + "method": { + "shortName": "BatchImportModelEvaluationSlices", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.BatchImportModelEvaluationSlices", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_ModelService_GetModelEvaluation_async", + "title": "DatasetService getModelEvaluation Sample", + "origin": "API_DEFINITION", + "description": " Gets a ModelEvaluation.", + "canonical": true, + "file": "model_service.get_model_evaluation.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetModelEvaluation", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.GetModelEvaluation", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ModelEvaluation", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.ModelServiceClient" + }, + "method": { + "shortName": "GetModelEvaluation", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.GetModelEvaluation", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_ModelService_ListModelEvaluations_async", + "title": "DatasetService listModelEvaluations Sample", + "origin": "API_DEFINITION", + "description": " Lists ModelEvaluations in a Model.", + "canonical": true, + "file": "model_service.list_model_evaluations.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 77, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListModelEvaluations", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluations", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListModelEvaluationsResponse", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.ModelServiceClient" + }, + "method": { + "shortName": "ListModelEvaluations", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluations", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_ModelService_GetModelEvaluationSlice_async", + "title": "DatasetService getModelEvaluationSlice Sample", + "origin": "API_DEFINITION", + "description": " Gets a ModelEvaluationSlice.", + "canonical": true, + "file": "model_service.get_model_evaluation_slice.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetModelEvaluationSlice", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.GetModelEvaluationSlice", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ModelEvaluationSlice", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.ModelServiceClient" + }, + "method": { + "shortName": "GetModelEvaluationSlice", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.GetModelEvaluationSlice", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_ModelService_ListModelEvaluationSlices_async", + "title": "DatasetService listModelEvaluationSlices Sample", + "origin": "API_DEFINITION", + "description": " Lists ModelEvaluationSlices in a ModelEvaluation.", + "canonical": true, + "file": "model_service.list_model_evaluation_slices.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListModelEvaluationSlices", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluationSlices", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListModelEvaluationSlicesResponse", + "client": { + "shortName": "ModelServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.ModelServiceClient" + }, + "method": { + "shortName": "ListModelEvaluationSlices", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluationSlices", + "service": { + "shortName": "ModelService", + "fullName": "google.cloud.aiplatform.v1beta1.ModelService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_PipelineService_CreateTrainingPipeline_async", + "title": "DatasetService createTrainingPipeline Sample", + "origin": "API_DEFINITION", + "description": " Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.", + "canonical": true, + "file": "pipeline_service.create_training_pipeline.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateTrainingPipeline", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService.CreateTrainingPipeline", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "training_pipeline", + "type": ".google.cloud.aiplatform.v1beta1.TrainingPipeline" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.TrainingPipeline", + "client": { + "shortName": "PipelineServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineServiceClient" + }, + "method": { + "shortName": "CreateTrainingPipeline", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService.CreateTrainingPipeline", + "service": { + "shortName": "PipelineService", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_PipelineService_GetTrainingPipeline_async", + "title": "DatasetService getTrainingPipeline Sample", + "origin": "API_DEFINITION", + "description": " Gets a TrainingPipeline.", + "canonical": true, + "file": "pipeline_service.get_training_pipeline.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetTrainingPipeline", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService.GetTrainingPipeline", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.TrainingPipeline", + "client": { + "shortName": "PipelineServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineServiceClient" + }, + "method": { + "shortName": "GetTrainingPipeline", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService.GetTrainingPipeline", + "service": { + "shortName": "PipelineService", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_PipelineService_ListTrainingPipelines_async", + "title": "DatasetService listTrainingPipelines Sample", + "origin": "API_DEFINITION", + "description": " Lists TrainingPipelines in a Location.", + "canonical": true, + "file": "pipeline_service.list_training_pipelines.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 92, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListTrainingPipelines", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService.ListTrainingPipelines", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListTrainingPipelinesResponse", + "client": { + "shortName": "PipelineServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineServiceClient" + }, + "method": { + "shortName": "ListTrainingPipelines", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService.ListTrainingPipelines", + "service": { + "shortName": "PipelineService", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_PipelineService_DeleteTrainingPipeline_async", + "title": "DatasetService deleteTrainingPipeline Sample", + "origin": "API_DEFINITION", + "description": " Deletes a TrainingPipeline.", + "canonical": true, + "file": "pipeline_service.delete_training_pipeline.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteTrainingPipeline", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService.DeleteTrainingPipeline", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "PipelineServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineServiceClient" + }, + "method": { + "shortName": "DeleteTrainingPipeline", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService.DeleteTrainingPipeline", + "service": { + "shortName": "PipelineService", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_PipelineService_CancelTrainingPipeline_async", + "title": "DatasetService cancelTrainingPipeline Sample", + "origin": "API_DEFINITION", + "description": " Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use [PipelineService.GetTrainingPipeline][google.cloud.aiplatform.v1beta1.PipelineService.GetTrainingPipeline] or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead it becomes a pipeline with a [TrainingPipeline.error][google.cloud.aiplatform.v1beta1.TrainingPipeline.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [TrainingPipeline.state][google.cloud.aiplatform.v1beta1.TrainingPipeline.state] is set to `CANCELLED`.", + "canonical": true, + "file": "pipeline_service.cancel_training_pipeline.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CancelTrainingPipeline", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService.CancelTrainingPipeline", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "PipelineServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineServiceClient" + }, + "method": { + "shortName": "CancelTrainingPipeline", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService.CancelTrainingPipeline", + "service": { + "shortName": "PipelineService", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_PipelineService_CreatePipelineJob_async", + "title": "DatasetService createPipelineJob Sample", + "origin": "API_DEFINITION", + "description": " Creates a PipelineJob. A PipelineJob will run immediately when created.", + "canonical": true, + "file": "pipeline_service.create_pipeline_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreatePipelineJob", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService.CreatePipelineJob", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "pipeline_job", + "type": ".google.cloud.aiplatform.v1beta1.PipelineJob" + }, + { + "name": "pipeline_job_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.PipelineJob", + "client": { + "shortName": "PipelineServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineServiceClient" + }, + "method": { + "shortName": "CreatePipelineJob", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService.CreatePipelineJob", + "service": { + "shortName": "PipelineService", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_PipelineService_GetPipelineJob_async", + "title": "DatasetService getPipelineJob Sample", + "origin": "API_DEFINITION", + "description": " Gets a PipelineJob.", + "canonical": true, + "file": "pipeline_service.get_pipeline_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetPipelineJob", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService.GetPipelineJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.PipelineJob", + "client": { + "shortName": "PipelineServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineServiceClient" + }, + "method": { + "shortName": "GetPipelineJob", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService.GetPipelineJob", + "service": { + "shortName": "PipelineService", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_PipelineService_ListPipelineJobs_async", + "title": "DatasetService listPipelineJobs Sample", + "origin": "API_DEFINITION", + "description": " Lists PipelineJobs in a Location.", + "canonical": true, + "file": "pipeline_service.list_pipeline_jobs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 120, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListPipelineJobs", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService.ListPipelineJobs", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListPipelineJobsResponse", + "client": { + "shortName": "PipelineServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineServiceClient" + }, + "method": { + "shortName": "ListPipelineJobs", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService.ListPipelineJobs", + "service": { + "shortName": "PipelineService", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_PipelineService_DeletePipelineJob_async", + "title": "DatasetService deletePipelineJob Sample", + "origin": "API_DEFINITION", + "description": " Deletes a PipelineJob.", + "canonical": true, + "file": "pipeline_service.delete_pipeline_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeletePipelineJob", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService.DeletePipelineJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "PipelineServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineServiceClient" + }, + "method": { + "shortName": "DeletePipelineJob", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService.DeletePipelineJob", + "service": { + "shortName": "PipelineService", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_PipelineService_CancelPipelineJob_async", + "title": "DatasetService cancelPipelineJob Sample", + "origin": "API_DEFINITION", + "description": " Cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use [PipelineService.GetPipelineJob][google.cloud.aiplatform.v1beta1.PipelineService.GetPipelineJob] or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the PipelineJob is not deleted; instead it becomes a pipeline with a [PipelineJob.error][google.cloud.aiplatform.v1beta1.PipelineJob.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and [PipelineJob.state][google.cloud.aiplatform.v1beta1.PipelineJob.state] is set to `CANCELLED`.", + "canonical": true, + "file": "pipeline_service.cancel_pipeline_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CancelPipelineJob", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService.CancelPipelineJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "PipelineServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineServiceClient" + }, + "method": { + "shortName": "CancelPipelineJob", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService.CancelPipelineJob", + "service": { + "shortName": "PipelineService", + "fullName": "google.cloud.aiplatform.v1beta1.PipelineService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_PredictionService_Predict_async", + "title": "DatasetService predict Sample", + "origin": "API_DEFINITION", + "description": " Perform an online prediction.", + "canonical": true, + "file": "prediction_service.predict.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 77, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Predict", + "fullName": "google.cloud.aiplatform.v1beta1.PredictionService.Predict", + "async": true, + "parameters": [ + { + "name": "endpoint", + "type": "TYPE_STRING" + }, + { + "name": "instances", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "parameters", + "type": ".google.protobuf.Value" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.PredictResponse", + "client": { + "shortName": "PredictionServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.PredictionServiceClient" + }, + "method": { + "shortName": "Predict", + "fullName": "google.cloud.aiplatform.v1beta1.PredictionService.Predict", + "service": { + "shortName": "PredictionService", + "fullName": "google.cloud.aiplatform.v1beta1.PredictionService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_PredictionService_RawPredict_async", + "title": "DatasetService rawPredict Sample", + "origin": "API_DEFINITION", + "description": " Perform an online prediction with an arbitrary HTTP payload. The response includes the following HTTP headers: * `X-Vertex-AI-Endpoint-Id`: ID of the [Endpoint][google.cloud.aiplatform.v1beta1.Endpoint] that served this prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's [DeployedModel][google.cloud.aiplatform.v1beta1.DeployedModel] that served this prediction.", + "canonical": true, + "file": "prediction_service.raw_predict.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RawPredict", + "fullName": "google.cloud.aiplatform.v1beta1.PredictionService.RawPredict", + "async": true, + "parameters": [ + { + "name": "endpoint", + "type": "TYPE_STRING" + }, + { + "name": "http_body", + "type": ".google.api.HttpBody" + } + ], + "resultType": ".google.api.HttpBody", + "client": { + "shortName": "PredictionServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.PredictionServiceClient" + }, + "method": { + "shortName": "RawPredict", + "fullName": "google.cloud.aiplatform.v1beta1.PredictionService.RawPredict", + "service": { + "shortName": "PredictionService", + "fullName": "google.cloud.aiplatform.v1beta1.PredictionService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_PredictionService_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": 94, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Explain", + "fullName": "google.cloud.aiplatform.v1beta1.PredictionService.Explain", + "async": true, + "parameters": [ + { + "name": "endpoint", + "type": "TYPE_STRING" + }, + { + "name": "instances", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "parameters", + "type": ".google.protobuf.Value" + }, + { + "name": "explanation_spec_override", + "type": ".google.cloud.aiplatform.v1beta1.ExplanationSpecOverride" + }, + { + "name": "deployed_model_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ExplainResponse", + "client": { + "shortName": "PredictionServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.PredictionServiceClient" + }, + "method": { + "shortName": "Explain", + "fullName": "google.cloud.aiplatform.v1beta1.PredictionService.Explain", + "service": { + "shortName": "PredictionService", + "fullName": "google.cloud.aiplatform.v1beta1.PredictionService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_SpecialistPoolService_CreateSpecialistPool_async", + "title": "DatasetService createSpecialistPool Sample", + "origin": "API_DEFINITION", + "description": " Creates a SpecialistPool.", + "canonical": true, + "file": "specialist_pool_service.create_specialist_pool.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateSpecialistPool", + "fullName": "google.cloud.aiplatform.v1beta1.SpecialistPoolService.CreateSpecialistPool", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "specialist_pool", + "type": ".google.cloud.aiplatform.v1beta1.SpecialistPool" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "SpecialistPoolServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.SpecialistPoolServiceClient" + }, + "method": { + "shortName": "CreateSpecialistPool", + "fullName": "google.cloud.aiplatform.v1beta1.SpecialistPoolService.CreateSpecialistPool", + "service": { + "shortName": "SpecialistPoolService", + "fullName": "google.cloud.aiplatform.v1beta1.SpecialistPoolService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_SpecialistPoolService_GetSpecialistPool_async", + "title": "DatasetService getSpecialistPool Sample", + "origin": "API_DEFINITION", + "description": " Gets a SpecialistPool.", + "canonical": true, + "file": "specialist_pool_service.get_specialist_pool.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetSpecialistPool", + "fullName": "google.cloud.aiplatform.v1beta1.SpecialistPoolService.GetSpecialistPool", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.SpecialistPool", + "client": { + "shortName": "SpecialistPoolServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.SpecialistPoolServiceClient" + }, + "method": { + "shortName": "GetSpecialistPool", + "fullName": "google.cloud.aiplatform.v1beta1.SpecialistPoolService.GetSpecialistPool", + "service": { + "shortName": "SpecialistPoolService", + "fullName": "google.cloud.aiplatform.v1beta1.SpecialistPoolService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_SpecialistPoolService_ListSpecialistPools_async", + "title": "DatasetService listSpecialistPools Sample", + "origin": "API_DEFINITION", + "description": " Lists SpecialistPools in a Location.", + "canonical": true, + "file": "specialist_pool_service.list_specialist_pools.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 73, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListSpecialistPools", + "fullName": "google.cloud.aiplatform.v1beta1.SpecialistPoolService.ListSpecialistPools", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListSpecialistPoolsResponse", + "client": { + "shortName": "SpecialistPoolServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.SpecialistPoolServiceClient" + }, + "method": { + "shortName": "ListSpecialistPools", + "fullName": "google.cloud.aiplatform.v1beta1.SpecialistPoolService.ListSpecialistPools", + "service": { + "shortName": "SpecialistPoolService", + "fullName": "google.cloud.aiplatform.v1beta1.SpecialistPoolService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_SpecialistPoolService_DeleteSpecialistPool_async", + "title": "DatasetService deleteSpecialistPool Sample", + "origin": "API_DEFINITION", + "description": " Deletes a SpecialistPool as well as all Specialists in the pool.", + "canonical": true, + "file": "specialist_pool_service.delete_specialist_pool.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteSpecialistPool", + "fullName": "google.cloud.aiplatform.v1beta1.SpecialistPoolService.DeleteSpecialistPool", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "SpecialistPoolServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.SpecialistPoolServiceClient" + }, + "method": { + "shortName": "DeleteSpecialistPool", + "fullName": "google.cloud.aiplatform.v1beta1.SpecialistPoolService.DeleteSpecialistPool", + "service": { + "shortName": "SpecialistPoolService", + "fullName": "google.cloud.aiplatform.v1beta1.SpecialistPoolService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_SpecialistPoolService_UpdateSpecialistPool_async", + "title": "DatasetService updateSpecialistPool Sample", + "origin": "API_DEFINITION", + "description": " Updates a SpecialistPool.", + "canonical": true, + "file": "specialist_pool_service.update_specialist_pool.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateSpecialistPool", + "fullName": "google.cloud.aiplatform.v1beta1.SpecialistPoolService.UpdateSpecialistPool", + "async": true, + "parameters": [ + { + "name": "specialist_pool", + "type": ".google.cloud.aiplatform.v1beta1.SpecialistPool" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "SpecialistPoolServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.SpecialistPoolServiceClient" + }, + "method": { + "shortName": "UpdateSpecialistPool", + "fullName": "google.cloud.aiplatform.v1beta1.SpecialistPoolService.UpdateSpecialistPool", + "service": { + "shortName": "SpecialistPoolService", + "fullName": "google.cloud.aiplatform.v1beta1.SpecialistPoolService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_CreateTensorboard_async", + "title": "DatasetService createTensorboard Sample", + "origin": "API_DEFINITION", + "description": " Creates a Tensorboard.", + "canonical": true, + "file": "tensorboard_service.create_tensorboard.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateTensorboard", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.CreateTensorboard", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "tensorboard", + "type": ".google.cloud.aiplatform.v1beta1.Tensorboard" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "CreateTensorboard", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.CreateTensorboard", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_GetTensorboard_async", + "title": "DatasetService getTensorboard Sample", + "origin": "API_DEFINITION", + "description": " Gets a Tensorboard.", + "canonical": true, + "file": "tensorboard_service.get_tensorboard.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetTensorboard", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.GetTensorboard", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Tensorboard", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "GetTensorboard", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.GetTensorboard", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_ReadTensorboardUsage_async", + "title": "DatasetService readTensorboardUsage Sample", + "origin": "API_DEFINITION", + "description": " Returns a list of monthly active users for a given TensorBoard instance.", + "canonical": true, + "file": "tensorboard_service.read_tensorboard_usage.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ReadTensorboardUsage", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ReadTensorboardUsage", + "async": true, + "parameters": [ + { + "name": "tensorboard", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "ReadTensorboardUsage", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ReadTensorboardUsage", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_UpdateTensorboard_async", + "title": "DatasetService updateTensorboard Sample", + "origin": "API_DEFINITION", + "description": " Updates a Tensorboard.", + "canonical": true, + "file": "tensorboard_service.update_tensorboard.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateTensorboard", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.UpdateTensorboard", + "async": true, + "parameters": [ + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "tensorboard", + "type": ".google.cloud.aiplatform.v1beta1.Tensorboard" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "UpdateTensorboard", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.UpdateTensorboard", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_ListTensorboards_async", + "title": "DatasetService listTensorboards Sample", + "origin": "API_DEFINITION", + "description": " Lists Tensorboards in a Location.", + "canonical": true, + "file": "tensorboard_service.list_tensorboards.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 85, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListTensorboards", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListTensorboardsResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "ListTensorboards", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_DeleteTensorboard_async", + "title": "DatasetService deleteTensorboard Sample", + "origin": "API_DEFINITION", + "description": " Deletes a Tensorboard.", + "canonical": true, + "file": "tensorboard_service.delete_tensorboard.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteTensorboard", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.DeleteTensorboard", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "DeleteTensorboard", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.DeleteTensorboard", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_CreateTensorboardExperiment_async", + "title": "DatasetService createTensorboardExperiment Sample", + "origin": "API_DEFINITION", + "description": " Creates a TensorboardExperiment.", + "canonical": true, + "file": "tensorboard_service.create_tensorboard_experiment.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateTensorboardExperiment", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.CreateTensorboardExperiment", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "tensorboard_experiment", + "type": ".google.cloud.aiplatform.v1beta1.TensorboardExperiment" + }, + { + "name": "tensorboard_experiment_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.TensorboardExperiment", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "CreateTensorboardExperiment", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.CreateTensorboardExperiment", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_GetTensorboardExperiment_async", + "title": "DatasetService getTensorboardExperiment Sample", + "origin": "API_DEFINITION", + "description": " Gets a TensorboardExperiment.", + "canonical": true, + "file": "tensorboard_service.get_tensorboard_experiment.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetTensorboardExperiment", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.GetTensorboardExperiment", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.TensorboardExperiment", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "GetTensorboardExperiment", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.GetTensorboardExperiment", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_UpdateTensorboardExperiment_async", + "title": "DatasetService updateTensorboardExperiment Sample", + "origin": "API_DEFINITION", + "description": " Updates a TensorboardExperiment.", + "canonical": true, + "file": "tensorboard_service.update_tensorboard_experiment.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateTensorboardExperiment", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.UpdateTensorboardExperiment", + "async": true, + "parameters": [ + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "tensorboard_experiment", + "type": ".google.cloud.aiplatform.v1beta1.TensorboardExperiment" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.TensorboardExperiment", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "UpdateTensorboardExperiment", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.UpdateTensorboardExperiment", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_ListTensorboardExperiments_async", + "title": "DatasetService listTensorboardExperiments Sample", + "origin": "API_DEFINITION", + "description": " Lists TensorboardExperiments in a Location.", + "canonical": true, + "file": "tensorboard_service.list_tensorboard_experiments.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 85, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListTensorboardExperiments", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListTensorboardExperimentsResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "ListTensorboardExperiments", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_DeleteTensorboardExperiment_async", + "title": "DatasetService deleteTensorboardExperiment Sample", + "origin": "API_DEFINITION", + "description": " Deletes a TensorboardExperiment.", + "canonical": true, + "file": "tensorboard_service.delete_tensorboard_experiment.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteTensorboardExperiment", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.DeleteTensorboardExperiment", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "DeleteTensorboardExperiment", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.DeleteTensorboardExperiment", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_CreateTensorboardRun_async", + "title": "DatasetService createTensorboardRun Sample", + "origin": "API_DEFINITION", + "description": " Creates a TensorboardRun.", + "canonical": true, + "file": "tensorboard_service.create_tensorboard_run.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateTensorboardRun", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.CreateTensorboardRun", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "tensorboard_run", + "type": ".google.cloud.aiplatform.v1beta1.TensorboardRun" + }, + { + "name": "tensorboard_run_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.TensorboardRun", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "CreateTensorboardRun", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.CreateTensorboardRun", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_BatchCreateTensorboardRuns_async", + "title": "DatasetService batchCreateTensorboardRuns Sample", + "origin": "API_DEFINITION", + "description": " Batch create TensorboardRuns.", + "canonical": true, + "file": "tensorboard_service.batch_create_tensorboard_runs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchCreateTensorboardRuns", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.BatchCreateTensorboardRuns", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "requests", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.BatchCreateTensorboardRunsResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "BatchCreateTensorboardRuns", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.BatchCreateTensorboardRuns", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_GetTensorboardRun_async", + "title": "DatasetService getTensorboardRun Sample", + "origin": "API_DEFINITION", + "description": " Gets a TensorboardRun.", + "canonical": true, + "file": "tensorboard_service.get_tensorboard_run.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetTensorboardRun", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.GetTensorboardRun", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.TensorboardRun", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "GetTensorboardRun", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.GetTensorboardRun", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_UpdateTensorboardRun_async", + "title": "DatasetService updateTensorboardRun Sample", + "origin": "API_DEFINITION", + "description": " Updates a TensorboardRun.", + "canonical": true, + "file": "tensorboard_service.update_tensorboard_run.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateTensorboardRun", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.UpdateTensorboardRun", + "async": true, + "parameters": [ + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "tensorboard_run", + "type": ".google.cloud.aiplatform.v1beta1.TensorboardRun" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.TensorboardRun", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "UpdateTensorboardRun", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.UpdateTensorboardRun", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_ListTensorboardRuns_async", + "title": "DatasetService listTensorboardRuns Sample", + "origin": "API_DEFINITION", + "description": " Lists TensorboardRuns in a Location.", + "canonical": true, + "file": "tensorboard_service.list_tensorboard_runs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 85, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListTensorboardRuns", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListTensorboardRunsResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "ListTensorboardRuns", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_DeleteTensorboardRun_async", + "title": "DatasetService deleteTensorboardRun Sample", + "origin": "API_DEFINITION", + "description": " Deletes a TensorboardRun.", + "canonical": true, + "file": "tensorboard_service.delete_tensorboard_run.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteTensorboardRun", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.DeleteTensorboardRun", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "DeleteTensorboardRun", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.DeleteTensorboardRun", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_BatchCreateTensorboardTimeSeries_async", + "title": "DatasetService batchCreateTensorboardTimeSeries Sample", + "origin": "API_DEFINITION", + "description": " Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.", + "canonical": true, + "file": "tensorboard_service.batch_create_tensorboard_time_series.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchCreateTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.BatchCreateTensorboardTimeSeries", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "requests", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.BatchCreateTensorboardTimeSeriesResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "BatchCreateTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.BatchCreateTensorboardTimeSeries", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_CreateTensorboardTimeSeries_async", + "title": "DatasetService createTensorboardTimeSeries Sample", + "origin": "API_DEFINITION", + "description": " Creates a TensorboardTimeSeries.", + "canonical": true, + "file": "tensorboard_service.create_tensorboard_time_series.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.CreateTensorboardTimeSeries", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "tensorboard_time_series_id", + "type": "TYPE_STRING" + }, + { + "name": "tensorboard_time_series", + "type": ".google.cloud.aiplatform.v1beta1.TensorboardTimeSeries" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.TensorboardTimeSeries", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "CreateTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.CreateTensorboardTimeSeries", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_GetTensorboardTimeSeries_async", + "title": "DatasetService getTensorboardTimeSeries Sample", + "origin": "API_DEFINITION", + "description": " Gets a TensorboardTimeSeries.", + "canonical": true, + "file": "tensorboard_service.get_tensorboard_time_series.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.GetTensorboardTimeSeries", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.TensorboardTimeSeries", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "GetTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.GetTensorboardTimeSeries", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_UpdateTensorboardTimeSeries_async", + "title": "DatasetService updateTensorboardTimeSeries Sample", + "origin": "API_DEFINITION", + "description": " Updates a TensorboardTimeSeries.", + "canonical": true, + "file": "tensorboard_service.update_tensorboard_time_series.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.UpdateTensorboardTimeSeries", + "async": true, + "parameters": [ + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "tensorboard_time_series", + "type": ".google.cloud.aiplatform.v1beta1.TensorboardTimeSeries" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.TensorboardTimeSeries", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "UpdateTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.UpdateTensorboardTimeSeries", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_ListTensorboardTimeSeries_async", + "title": "DatasetService listTensorboardTimeSeries Sample", + "origin": "API_DEFINITION", + "description": " Lists TensorboardTimeSeries in a Location.", + "canonical": true, + "file": "tensorboard_service.list_tensorboard_time_series.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 85, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListTensorboardTimeSeriesResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "ListTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_DeleteTensorboardTimeSeries_async", + "title": "DatasetService deleteTensorboardTimeSeries Sample", + "origin": "API_DEFINITION", + "description": " Deletes a TensorboardTimeSeries.", + "canonical": true, + "file": "tensorboard_service.delete_tensorboard_time_series.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.DeleteTensorboardTimeSeries", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "DeleteTensorboardTimeSeries", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.DeleteTensorboardTimeSeries", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_BatchReadTensorboardTimeSeriesData_async", + "title": "DatasetService batchReadTensorboardTimeSeriesData Sample", + "origin": "API_DEFINITION", + "description": " Reads multiple TensorboardTimeSeries' data. The data point number limit is 1000 for scalars, 100 for tensors and blob references. If the number of data points stored is less than the limit, all data is returned. Otherwise, the number limit of data points is randomly selected from this time series and returned.", + "canonical": true, + "file": "tensorboard_service.batch_read_tensorboard_time_series_data.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchReadTensorboardTimeSeriesData", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.BatchReadTensorboardTimeSeriesData", + "async": true, + "parameters": [ + { + "name": "tensorboard", + "type": "TYPE_STRING" + }, + { + "name": "time_series", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.BatchReadTensorboardTimeSeriesDataResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "BatchReadTensorboardTimeSeriesData", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.BatchReadTensorboardTimeSeriesData", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_ReadTensorboardTimeSeriesData_async", + "title": "DatasetService readTensorboardTimeSeriesData Sample", + "origin": "API_DEFINITION", + "description": " Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k.", + "canonical": true, + "file": "tensorboard_service.read_tensorboard_time_series_data.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ReadTensorboardTimeSeriesData", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ReadTensorboardTimeSeriesData", + "async": true, + "parameters": [ + { + "name": "tensorboard_time_series", + "type": "TYPE_STRING" + }, + { + "name": "max_data_points", + "type": "TYPE_INT32" + }, + { + "name": "filter", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ReadTensorboardTimeSeriesDataResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "ReadTensorboardTimeSeriesData", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ReadTensorboardTimeSeriesData", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_ReadTensorboardBlobData_async", + "title": "DatasetService readTensorboardBlobData Sample", + "origin": "API_DEFINITION", + "description": " Gets bytes of TensorboardBlobs. This is to allow reading blob data stored in consumer project's Cloud Storage bucket without users having to obtain Cloud Storage access permission.", + "canonical": true, + "file": "tensorboard_service.read_tensorboard_blob_data.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ReadTensorboardBlobData", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ReadTensorboardBlobData", + "async": true, + "parameters": [ + { + "name": "time_series", + "type": "TYPE_STRING" + }, + { + "name": "blob_ids", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ReadTensorboardBlobDataResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "ReadTensorboardBlobData", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ReadTensorboardBlobData", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_WriteTensorboardExperimentData_async", + "title": "DatasetService writeTensorboardExperimentData Sample", + "origin": "API_DEFINITION", + "description": " Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's. If any data fail to be ingested, an error is returned.", + "canonical": true, + "file": "tensorboard_service.write_tensorboard_experiment_data.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "WriteTensorboardExperimentData", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.WriteTensorboardExperimentData", + "async": true, + "parameters": [ + { + "name": "tensorboard_experiment", + "type": "TYPE_STRING" + }, + { + "name": "write_run_data_requests", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.WriteTensorboardExperimentDataResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "WriteTensorboardExperimentData", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.WriteTensorboardExperimentData", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_WriteTensorboardRunData_async", + "title": "DatasetService writeTensorboardRunData Sample", + "origin": "API_DEFINITION", + "description": " Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun. If any data fail to be ingested, an error is returned.", + "canonical": true, + "file": "tensorboard_service.write_tensorboard_run_data.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 64, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "WriteTensorboardRunData", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.WriteTensorboardRunData", + "async": true, + "parameters": [ + { + "name": "tensorboard_run", + "type": "TYPE_STRING" + }, + { + "name": "time_series_data", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.WriteTensorboardRunDataResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "WriteTensorboardRunData", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.WriteTensorboardRunData", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_TensorboardService_ExportTensorboardTimeSeriesData_async", + "title": "DatasetService exportTensorboardTimeSeriesData Sample", + "origin": "API_DEFINITION", + "description": " Exports a TensorboardTimeSeries' data. Data is returned in paginated responses.", + "canonical": true, + "file": "tensorboard_service.export_tensorboard_time_series_data.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 82, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ExportTensorboardTimeSeriesData", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ExportTensorboardTimeSeriesData", + "async": true, + "parameters": [ + { + "name": "tensorboard_time_series", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ExportTensorboardTimeSeriesDataResponse", + "client": { + "shortName": "TensorboardServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardServiceClient" + }, + "method": { + "shortName": "ExportTensorboardTimeSeriesData", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService.ExportTensorboardTimeSeriesData", + "service": { + "shortName": "TensorboardService", + "fullName": "google.cloud.aiplatform.v1beta1.TensorboardService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_VizierService_CreateStudy_async", + "title": "DatasetService createStudy Sample", + "origin": "API_DEFINITION", + "description": " Creates a Study. A resource name will be generated after creation of the Study.", + "canonical": true, + "file": "vizier_service.create_study.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateStudy", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.CreateStudy", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "study", + "type": ".google.cloud.aiplatform.v1beta1.Study" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Study", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.VizierServiceClient" + }, + "method": { + "shortName": "CreateStudy", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.CreateStudy", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_VizierService_GetStudy_async", + "title": "DatasetService getStudy Sample", + "origin": "API_DEFINITION", + "description": " Gets a Study by name.", + "canonical": true, + "file": "vizier_service.get_study.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetStudy", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.GetStudy", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Study", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.VizierServiceClient" + }, + "method": { + "shortName": "GetStudy", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.GetStudy", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_VizierService_ListStudies_async", + "title": "DatasetService listStudies Sample", + "origin": "API_DEFINITION", + "description": " Lists all the studies in a region for an associated project.", + "canonical": true, + "file": "vizier_service.list_studies.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListStudies", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.ListStudies", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListStudiesResponse", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.VizierServiceClient" + }, + "method": { + "shortName": "ListStudies", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.ListStudies", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_VizierService_DeleteStudy_async", + "title": "DatasetService deleteStudy Sample", + "origin": "API_DEFINITION", + "description": " Deletes a Study.", + "canonical": true, + "file": "vizier_service.delete_study.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteStudy", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.DeleteStudy", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.VizierServiceClient" + }, + "method": { + "shortName": "DeleteStudy", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.DeleteStudy", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_VizierService_LookupStudy_async", + "title": "DatasetService lookupStudy Sample", + "origin": "API_DEFINITION", + "description": " Looks a study up using the user-defined display_name field instead of the fully qualified resource name.", + "canonical": true, + "file": "vizier_service.lookup_study.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "LookupStudy", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.LookupStudy", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "display_name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Study", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.VizierServiceClient" + }, + "method": { + "shortName": "LookupStudy", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.LookupStudy", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_VizierService_SuggestTrials_async", + "title": "DatasetService suggestTrials Sample", + "origin": "API_DEFINITION", + "description": " Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier. Returns a long-running operation associated with the generation of Trial suggestions. When this long-running operation succeeds, it will contain a [SuggestTrialsResponse][google.cloud.ml.v1.SuggestTrialsResponse].", + "canonical": true, + "file": "vizier_service.suggest_trials.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SuggestTrials", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.SuggestTrials", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "suggestion_count", + "type": "TYPE_INT32" + }, + { + "name": "client_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.VizierServiceClient" + }, + "method": { + "shortName": "SuggestTrials", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.SuggestTrials", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_VizierService_CreateTrial_async", + "title": "DatasetService createTrial Sample", + "origin": "API_DEFINITION", + "description": " Adds a user provided Trial to a Study.", + "canonical": true, + "file": "vizier_service.create_trial.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateTrial", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.CreateTrial", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "trial", + "type": ".google.cloud.aiplatform.v1beta1.Trial" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Trial", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.VizierServiceClient" + }, + "method": { + "shortName": "CreateTrial", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.CreateTrial", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_VizierService_GetTrial_async", + "title": "DatasetService getTrial Sample", + "origin": "API_DEFINITION", + "description": " Gets a Trial.", + "canonical": true, + "file": "vizier_service.get_trial.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetTrial", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.GetTrial", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Trial", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.VizierServiceClient" + }, + "method": { + "shortName": "GetTrial", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.GetTrial", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_VizierService_ListTrials_async", + "title": "DatasetService listTrials Sample", + "origin": "API_DEFINITION", + "description": " Lists the Trials associated with a Study.", + "canonical": true, + "file": "vizier_service.list_trials.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListTrials", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.ListTrials", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListTrialsResponse", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.VizierServiceClient" + }, + "method": { + "shortName": "ListTrials", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.ListTrials", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_VizierService_AddTrialMeasurement_async", + "title": "DatasetService addTrialMeasurement Sample", + "origin": "API_DEFINITION", + "description": " Adds a measurement of the objective metrics to a Trial. This measurement is assumed to have been taken before the Trial is complete.", + "canonical": true, + "file": "vizier_service.add_trial_measurement.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AddTrialMeasurement", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.AddTrialMeasurement", + "async": true, + "parameters": [ + { + "name": "trial_name", + "type": "TYPE_STRING" + }, + { + "name": "measurement", + "type": ".google.cloud.aiplatform.v1beta1.Measurement" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Trial", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.VizierServiceClient" + }, + "method": { + "shortName": "AddTrialMeasurement", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.AddTrialMeasurement", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_VizierService_CompleteTrial_async", + "title": "DatasetService completeTrial Sample", + "origin": "API_DEFINITION", + "description": " Marks a Trial as complete.", + "canonical": true, + "file": "vizier_service.complete_trial.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CompleteTrial", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.CompleteTrial", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "final_measurement", + "type": ".google.cloud.aiplatform.v1beta1.Measurement" + }, + { + "name": "trial_infeasible", + "type": "TYPE_BOOL" + }, + { + "name": "infeasible_reason", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Trial", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.VizierServiceClient" + }, + "method": { + "shortName": "CompleteTrial", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.CompleteTrial", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_VizierService_DeleteTrial_async", + "title": "DatasetService deleteTrial Sample", + "origin": "API_DEFINITION", + "description": " Deletes a Trial.", + "canonical": true, + "file": "vizier_service.delete_trial.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteTrial", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.DeleteTrial", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.VizierServiceClient" + }, + "method": { + "shortName": "DeleteTrial", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.DeleteTrial", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_VizierService_CheckTrialEarlyStoppingState_async", + "title": "DatasetService checkTrialEarlyStoppingState Sample", + "origin": "API_DEFINITION", + "description": " Checks whether a Trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a [CheckTrialEarlyStoppingStateResponse][google.cloud.ml.v1.CheckTrialEarlyStoppingStateResponse].", + "canonical": true, + "file": "vizier_service.check_trial_early_stopping_state.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CheckTrialEarlyStoppingState", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.CheckTrialEarlyStoppingState", + "async": true, + "parameters": [ + { + "name": "trial_name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.VizierServiceClient" + }, + "method": { + "shortName": "CheckTrialEarlyStoppingState", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.CheckTrialEarlyStoppingState", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_VizierService_StopTrial_async", + "title": "DatasetService stopTrial Sample", + "origin": "API_DEFINITION", + "description": " Stops a Trial.", + "canonical": true, + "file": "vizier_service.stop_trial.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "StopTrial", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.StopTrial", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.Trial", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.VizierServiceClient" + }, + "method": { + "shortName": "StopTrial", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.StopTrial", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService" + } + } + } + }, + { + "regionTag": "aiplatform_v1beta1_generated_VizierService_ListOptimalTrials_async", + "title": "DatasetService listOptimalTrials Sample", + "origin": "API_DEFINITION", + "description": " Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency", + "canonical": true, + "file": "vizier_service.list_optimal_trials.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListOptimalTrials", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.ListOptimalTrials", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.aiplatform.v1beta1.ListOptimalTrialsResponse", + "client": { + "shortName": "VizierServiceClient", + "fullName": "google.cloud.aiplatform.v1beta1.VizierServiceClient" + }, + "method": { + "shortName": "ListOptimalTrials", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService.ListOptimalTrials", + "service": { + "shortName": "VizierService", + "fullName": "google.cloud.aiplatform.v1beta1.VizierService" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/specialist_pool_service.create_specialist_pool.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/specialist_pool_service.create_specialist_pool.js new file mode 100644 index 00000000000..25351bf9527 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/specialist_pool_service.create_specialist_pool.js @@ -0,0 +1,68 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, specialistPool) { + // [START aiplatform_v1beta1_generated_SpecialistPoolService_CreateSpecialistPool_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The parent Project name for the new SpecialistPool. + * The form is `projects/{project}/locations/{location}`. + */ + // const parent = 'abc123' + /** + * Required. The SpecialistPool to create. + */ + // const specialistPool = {} + + // Imports the Aiplatform library + const {SpecialistPoolServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new SpecialistPoolServiceClient(); + + async function callCreateSpecialistPool() { + // Construct request + const request = { + parent, + specialistPool, + }; + + // Run request + const [operation] = await aiplatformClient.createSpecialistPool(request); + const [response] = await operation.promise(); + console.log(response); + } + + callCreateSpecialistPool(); + // [END aiplatform_v1beta1_generated_SpecialistPoolService_CreateSpecialistPool_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/specialist_pool_service.delete_specialist_pool.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/specialist_pool_service.delete_specialist_pool.js new file mode 100644 index 00000000000..280b971425f --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/specialist_pool_service.delete_specialist_pool.js @@ -0,0 +1,69 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_SpecialistPoolService_DeleteSpecialistPool_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the SpecialistPool to delete. Format: + * `projects/{project}/locations/{location}/specialistPools/{specialist_pool}` + */ + // const name = 'abc123' + /** + * If set to true, any specialist managers in this SpecialistPool will also be + * deleted. (Otherwise, the request will only work if the SpecialistPool has + * no specialist managers.) + */ + // const force = true + + // Imports the Aiplatform library + const {SpecialistPoolServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new SpecialistPoolServiceClient(); + + async function callDeleteSpecialistPool() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteSpecialistPool(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteSpecialistPool(); + // [END aiplatform_v1beta1_generated_SpecialistPoolService_DeleteSpecialistPool_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/specialist_pool_service.get_specialist_pool.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/specialist_pool_service.get_specialist_pool.js new file mode 100644 index 00000000000..211fa2165ca --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/specialist_pool_service.get_specialist_pool.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_SpecialistPoolService_GetSpecialistPool_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the SpecialistPool resource. + * The form is + * `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`. + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {SpecialistPoolServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new SpecialistPoolServiceClient(); + + async function callGetSpecialistPool() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getSpecialistPool(request); + console.log(response); + } + + callGetSpecialistPool(); + // [END aiplatform_v1beta1_generated_SpecialistPoolService_GetSpecialistPool_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/specialist_pool_service.list_specialist_pools.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/specialist_pool_service.list_specialist_pools.js new file mode 100644 index 00000000000..832a3a64fcd --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/specialist_pool_service.list_specialist_pools.js @@ -0,0 +1,81 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1beta1_generated_SpecialistPoolService_ListSpecialistPools_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the SpecialistPool's parent resource. + * Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * The standard list page size. + */ + // const pageSize = 1234 + /** + * The standard list page token. + * Typically obtained by + * ListSpecialistPoolsResponse.next_page_token google.cloud.aiplatform.v1beta1.ListSpecialistPoolsResponse.next_page_token + * of the previous + * SpecialistPoolService.ListSpecialistPools google.cloud.aiplatform.v1beta1.SpecialistPoolService.ListSpecialistPools + * call. Return first page if empty. + */ + // const pageToken = 'abc123' + /** + * Mask specifying which fields to read. FieldMask represents a set of + */ + // const readMask = {} + + // Imports the Aiplatform library + const {SpecialistPoolServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new SpecialistPoolServiceClient(); + + async function callListSpecialistPools() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listSpecialistPoolsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListSpecialistPools(); + // [END aiplatform_v1beta1_generated_SpecialistPoolService_ListSpecialistPools_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/specialist_pool_service.update_specialist_pool.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/specialist_pool_service.update_specialist_pool.js new file mode 100644 index 00000000000..ec73155ce8a --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/specialist_pool_service.update_specialist_pool.js @@ -0,0 +1,67 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(specialistPool, updateMask) { + // [START aiplatform_v1beta1_generated_SpecialistPoolService_UpdateSpecialistPool_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The SpecialistPool which replaces the resource on the server. + */ + // const specialistPool = {} + /** + * Required. The update mask applies to the resource. + */ + // const updateMask = {} + + // Imports the Aiplatform library + const {SpecialistPoolServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new SpecialistPoolServiceClient(); + + async function callUpdateSpecialistPool() { + // Construct request + const request = { + specialistPool, + updateMask, + }; + + // Run request + const [operation] = await aiplatformClient.updateSpecialistPool(request); + const [response] = await operation.promise(); + console.log(response); + } + + callUpdateSpecialistPool(); + // [END aiplatform_v1beta1_generated_SpecialistPoolService_UpdateSpecialistPool_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.batch_create_tensorboard_runs.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.batch_create_tensorboard_runs.js new file mode 100644 index 00000000000..822e4dc1852 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.batch_create_tensorboard_runs.js @@ -0,0 +1,71 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, requests) { + // [START aiplatform_v1beta1_generated_TensorboardService_BatchCreateTensorboardRuns_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the TensorboardExperiment to create the + * TensorboardRuns in. Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` + * The parent field in the CreateTensorboardRunRequest messages must match + * this field. + */ + // const parent = 'abc123' + /** + * Required. The request message specifying the TensorboardRuns to create. + * A maximum of 1000 TensorboardRuns can be created in a batch. + */ + // const requests = 1234 + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callBatchCreateTensorboardRuns() { + // Construct request + const request = { + parent, + requests, + }; + + // Run request + const response = await aiplatformClient.batchCreateTensorboardRuns(request); + console.log(response); + } + + callBatchCreateTensorboardRuns(); + // [END aiplatform_v1beta1_generated_TensorboardService_BatchCreateTensorboardRuns_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.batch_create_tensorboard_time_series.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.batch_create_tensorboard_time_series.js new file mode 100644 index 00000000000..5fee512fad8 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.batch_create_tensorboard_time_series.js @@ -0,0 +1,73 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, requests) { + // [START aiplatform_v1beta1_generated_TensorboardService_BatchCreateTensorboardTimeSeries_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the TensorboardExperiment to create the + * TensorboardTimeSeries in. + * Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` + * The TensorboardRuns referenced by the parent fields in the + * CreateTensorboardTimeSeriesRequest messages must be sub resources of this + * TensorboardExperiment. + */ + // const parent = 'abc123' + /** + * Required. The request message specifying the TensorboardTimeSeries to + * create. A maximum of 1000 TensorboardTimeSeries can be created in a batch. + */ + // const requests = 1234 + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callBatchCreateTensorboardTimeSeries() { + // Construct request + const request = { + parent, + requests, + }; + + // Run request + const response = await aiplatformClient.batchCreateTensorboardTimeSeries(request); + console.log(response); + } + + callBatchCreateTensorboardTimeSeries(); + // [END aiplatform_v1beta1_generated_TensorboardService_BatchCreateTensorboardTimeSeries_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.batch_read_tensorboard_time_series_data.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.batch_read_tensorboard_time_series_data.js new file mode 100644 index 00000000000..8de21477d13 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.batch_read_tensorboard_time_series_data.js @@ -0,0 +1,73 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(tensorboard, timeSeries) { + // [START aiplatform_v1beta1_generated_TensorboardService_BatchReadTensorboardTimeSeriesData_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Tensorboard containing + * TensorboardTimeSeries to read data from. Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}`. + * The TensorboardTimeSeries referenced by + * time_series google.cloud.aiplatform.v1beta1.BatchReadTensorboardTimeSeriesDataRequest.time_series + * must be sub resources of this Tensorboard. + */ + // const tensorboard = 'abc123' + /** + * Required. The resource names of the TensorboardTimeSeries to read data + * from. Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}` + */ + // const timeSeries = 'abc123' + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callBatchReadTensorboardTimeSeriesData() { + // Construct request + const request = { + tensorboard, + timeSeries, + }; + + // Run request + const response = await aiplatformClient.batchReadTensorboardTimeSeriesData(request); + console.log(response); + } + + callBatchReadTensorboardTimeSeriesData(); + // [END aiplatform_v1beta1_generated_TensorboardService_BatchReadTensorboardTimeSeriesData_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.create_tensorboard.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.create_tensorboard.js new file mode 100644 index 00000000000..ff079b258c9 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.create_tensorboard.js @@ -0,0 +1,68 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, tensorboard) { + // [START aiplatform_v1beta1_generated_TensorboardService_CreateTensorboard_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to create the Tensorboard in. + * Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Required. The Tensorboard to create. + */ + // const tensorboard = {} + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callCreateTensorboard() { + // Construct request + const request = { + parent, + tensorboard, + }; + + // Run request + const [operation] = await aiplatformClient.createTensorboard(request); + const [response] = await operation.promise(); + console.log(response); + } + + callCreateTensorboard(); + // [END aiplatform_v1beta1_generated_TensorboardService_CreateTensorboard_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.create_tensorboard_experiment.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.create_tensorboard_experiment.js new file mode 100644 index 00000000000..5960b9a6de0 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.create_tensorboard_experiment.js @@ -0,0 +1,75 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, tensorboardExperimentId) { + // [START aiplatform_v1beta1_generated_TensorboardService_CreateTensorboardExperiment_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Tensorboard to create the + * TensorboardExperiment in. Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}` + */ + // const parent = 'abc123' + /** + * The TensorboardExperiment to create. + */ + // const tensorboardExperiment = {} + /** + * Required. The ID to use for the Tensorboard experiment, which becomes the + * final component of the Tensorboard experiment's resource name. + * This value should be 1-128 characters, and valid characters + * are /[a-z][0-9]-/. + */ + // const tensorboardExperimentId = 'abc123' + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callCreateTensorboardExperiment() { + // Construct request + const request = { + parent, + tensorboardExperimentId, + }; + + // Run request + const response = await aiplatformClient.createTensorboardExperiment(request); + console.log(response); + } + + callCreateTensorboardExperiment(); + // [END aiplatform_v1beta1_generated_TensorboardService_CreateTensorboardExperiment_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.create_tensorboard_run.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.create_tensorboard_run.js new file mode 100644 index 00000000000..06004c87322 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.create_tensorboard_run.js @@ -0,0 +1,76 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, tensorboardRun, tensorboardRunId) { + // [START aiplatform_v1beta1_generated_TensorboardService_CreateTensorboardRun_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the TensorboardExperiment to create the + * TensorboardRun in. Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` + */ + // const parent = 'abc123' + /** + * Required. The TensorboardRun to create. + */ + // const tensorboardRun = {} + /** + * Required. The ID to use for the Tensorboard run, which becomes the final + * component of the Tensorboard run's resource name. + * This value should be 1-128 characters, and valid characters + * are /[a-z][0-9]-/. + */ + // const tensorboardRunId = 'abc123' + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callCreateTensorboardRun() { + // Construct request + const request = { + parent, + tensorboardRun, + tensorboardRunId, + }; + + // Run request + const response = await aiplatformClient.createTensorboardRun(request); + console.log(response); + } + + callCreateTensorboardRun(); + // [END aiplatform_v1beta1_generated_TensorboardService_CreateTensorboardRun_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.create_tensorboard_time_series.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.create_tensorboard_time_series.js new file mode 100644 index 00000000000..11c25cdf845 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.create_tensorboard_time_series.js @@ -0,0 +1,76 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, tensorboardTimeSeries) { + // [START aiplatform_v1beta1_generated_TensorboardService_CreateTensorboardTimeSeries_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the TensorboardRun to create the + * TensorboardTimeSeries in. + * Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` + */ + // const parent = 'abc123' + /** + * Optional. The user specified unique ID to use for the + * TensorboardTimeSeries, which becomes the final component of the + * TensorboardTimeSeries's resource name. This value should match + * "[a-z0-9][a-z0-9-]{0, 127}" + */ + // const tensorboardTimeSeriesId = 'abc123' + /** + * Required. The TensorboardTimeSeries to create. + */ + // const tensorboardTimeSeries = {} + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callCreateTensorboardTimeSeries() { + // Construct request + const request = { + parent, + tensorboardTimeSeries, + }; + + // Run request + const response = await aiplatformClient.createTensorboardTimeSeries(request); + console.log(response); + } + + callCreateTensorboardTimeSeries(); + // [END aiplatform_v1beta1_generated_TensorboardService_CreateTensorboardTimeSeries_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.delete_tensorboard.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.delete_tensorboard.js new file mode 100644 index 00000000000..83ae85e4550 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.delete_tensorboard.js @@ -0,0 +1,64 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_TensorboardService_DeleteTensorboard_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Tensorboard to be deleted. + * Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callDeleteTensorboard() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteTensorboard(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteTensorboard(); + // [END aiplatform_v1beta1_generated_TensorboardService_DeleteTensorboard_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.delete_tensorboard_experiment.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.delete_tensorboard_experiment.js new file mode 100644 index 00000000000..a7c7f3b482c --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.delete_tensorboard_experiment.js @@ -0,0 +1,64 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_TensorboardService_DeleteTensorboardExperiment_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the TensorboardExperiment to be deleted. + * Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callDeleteTensorboardExperiment() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteTensorboardExperiment(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteTensorboardExperiment(); + // [END aiplatform_v1beta1_generated_TensorboardService_DeleteTensorboardExperiment_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.delete_tensorboard_run.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.delete_tensorboard_run.js new file mode 100644 index 00000000000..b51abc57ab2 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.delete_tensorboard_run.js @@ -0,0 +1,64 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_TensorboardService_DeleteTensorboardRun_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the TensorboardRun to be deleted. + * Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callDeleteTensorboardRun() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteTensorboardRun(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteTensorboardRun(); + // [END aiplatform_v1beta1_generated_TensorboardService_DeleteTensorboardRun_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.delete_tensorboard_time_series.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.delete_tensorboard_time_series.js new file mode 100644 index 00000000000..514858c200d --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.delete_tensorboard_time_series.js @@ -0,0 +1,64 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_TensorboardService_DeleteTensorboardTimeSeries_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the TensorboardTimeSeries to be deleted. + * Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callDeleteTensorboardTimeSeries() { + // Construct request + const request = { + name, + }; + + // Run request + const [operation] = await aiplatformClient.deleteTensorboardTimeSeries(request); + const [response] = await operation.promise(); + console.log(response); + } + + callDeleteTensorboardTimeSeries(); + // [END aiplatform_v1beta1_generated_TensorboardService_DeleteTensorboardTimeSeries_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.export_tensorboard_time_series_data.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.export_tensorboard_time_series_data.js new file mode 100644 index 00000000000..2b0d787398c --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.export_tensorboard_time_series_data.js @@ -0,0 +1,90 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(tensorboardTimeSeries) { + // [START aiplatform_v1beta1_generated_TensorboardService_ExportTensorboardTimeSeriesData_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the TensorboardTimeSeries to export data + * from. Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}` + */ + // const tensorboardTimeSeries = 'abc123' + /** + * Exports the TensorboardTimeSeries' data that match the filter expression. + */ + // const filter = 'abc123' + /** + * The maximum number of data points to return per page. + * The default page_size is 1000. Values must be between 1 and 10000. + * Values above 10000 are coerced to 10000. + */ + // const pageSize = 1234 + /** + * A page token, received from a previous + * TensorboardService.ExportTensorboardTimeSeries call. + * Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to + * TensorboardService.ExportTensorboardTimeSeries must + * match the call that provided the page token. + */ + // const pageToken = 'abc123' + /** + * Field to use to sort the TensorboardTimeSeries' data. + * By default, TensorboardTimeSeries' data is returned in a pseudo random + * order. + */ + // const orderBy = 'abc123' + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callExportTensorboardTimeSeriesData() { + // Construct request + const request = { + tensorboardTimeSeries, + }; + + // Run request + const iterable = await aiplatformClient.exportTensorboardTimeSeriesDataAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callExportTensorboardTimeSeriesData(); + // [END aiplatform_v1beta1_generated_TensorboardService_ExportTensorboardTimeSeriesData_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.get_tensorboard.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.get_tensorboard.js new file mode 100644 index 00000000000..94d9bec7990 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.get_tensorboard.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_TensorboardService_GetTensorboard_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Tensorboard resource. + * Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callGetTensorboard() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getTensorboard(request); + console.log(response); + } + + callGetTensorboard(); + // [END aiplatform_v1beta1_generated_TensorboardService_GetTensorboard_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.get_tensorboard_experiment.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.get_tensorboard_experiment.js new file mode 100644 index 00000000000..454cfcbd110 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.get_tensorboard_experiment.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_TensorboardService_GetTensorboardExperiment_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the TensorboardExperiment resource. + * Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callGetTensorboardExperiment() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getTensorboardExperiment(request); + console.log(response); + } + + callGetTensorboardExperiment(); + // [END aiplatform_v1beta1_generated_TensorboardService_GetTensorboardExperiment_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.get_tensorboard_run.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.get_tensorboard_run.js new file mode 100644 index 00000000000..3cf7e82a930 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.get_tensorboard_run.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_TensorboardService_GetTensorboardRun_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the TensorboardRun resource. + * Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callGetTensorboardRun() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getTensorboardRun(request); + console.log(response); + } + + callGetTensorboardRun(); + // [END aiplatform_v1beta1_generated_TensorboardService_GetTensorboardRun_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.get_tensorboard_time_series.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.get_tensorboard_time_series.js new file mode 100644 index 00000000000..ca37ebe4eae --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.get_tensorboard_time_series.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_TensorboardService_GetTensorboardTimeSeries_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the TensorboardTimeSeries resource. + * Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callGetTensorboardTimeSeries() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getTensorboardTimeSeries(request); + console.log(response); + } + + callGetTensorboardTimeSeries(); + // [END aiplatform_v1beta1_generated_TensorboardService_GetTensorboardTimeSeries_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.list_tensorboard_experiments.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.list_tensorboard_experiments.js new file mode 100644 index 00000000000..26b425a2edf --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.list_tensorboard_experiments.js @@ -0,0 +1,93 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1beta1_generated_TensorboardService_ListTensorboardExperiments_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Tensorboard to list + * TensorboardExperiments. Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}` + */ + // const parent = 'abc123' + /** + * Lists the TensorboardExperiments that match the filter expression. + */ + // const filter = 'abc123' + /** + * The maximum number of TensorboardExperiments to return. The service may + * return fewer than this value. If unspecified, at most 50 + * TensorboardExperiments are returned. The maximum value is 1000; values + * above 1000 are coerced to 1000. + */ + // const pageSize = 1234 + /** + * A page token, received from a previous + * TensorboardService.ListTensorboardExperiments google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments + * call. Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to + * TensorboardService.ListTensorboardExperiments google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments + * must match the call that provided the page token. + */ + // const pageToken = 'abc123' + /** + * Field to use to sort the list. + */ + // const orderBy = 'abc123' + /** + * Mask specifying which fields to read. + */ + // const readMask = {} + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callListTensorboardExperiments() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listTensorboardExperimentsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListTensorboardExperiments(); + // [END aiplatform_v1beta1_generated_TensorboardService_ListTensorboardExperiments_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.list_tensorboard_runs.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.list_tensorboard_runs.js new file mode 100644 index 00000000000..eba6bb01453 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.list_tensorboard_runs.js @@ -0,0 +1,93 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1beta1_generated_TensorboardService_ListTensorboardRuns_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the TensorboardExperiment to list + * TensorboardRuns. Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` + */ + // const parent = 'abc123' + /** + * Lists the TensorboardRuns that match the filter expression. + */ + // const filter = 'abc123' + /** + * The maximum number of TensorboardRuns to return. The service may return + * fewer than this value. If unspecified, at most 50 TensorboardRuns are + * returned. The maximum value is 1000; values above 1000 are coerced to + * 1000. + */ + // const pageSize = 1234 + /** + * A page token, received from a previous + * TensorboardService.ListTensorboardRuns google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns + * call. Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to + * TensorboardService.ListTensorboardRuns google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns + * must match the call that provided the page token. + */ + // const pageToken = 'abc123' + /** + * Field to use to sort the list. + */ + // const orderBy = 'abc123' + /** + * Mask specifying which fields to read. + */ + // const readMask = {} + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callListTensorboardRuns() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listTensorboardRunsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListTensorboardRuns(); + // [END aiplatform_v1beta1_generated_TensorboardService_ListTensorboardRuns_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.list_tensorboard_time_series.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.list_tensorboard_time_series.js new file mode 100644 index 00000000000..f2379b11c4c --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.list_tensorboard_time_series.js @@ -0,0 +1,93 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1beta1_generated_TensorboardService_ListTensorboardTimeSeries_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the TensorboardRun to list + * TensorboardTimeSeries. Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` + */ + // const parent = 'abc123' + /** + * Lists the TensorboardTimeSeries that match the filter expression. + */ + // const filter = 'abc123' + /** + * The maximum number of TensorboardTimeSeries to return. The service may + * return fewer than this value. If unspecified, at most 50 + * TensorboardTimeSeries are returned. The maximum value is 1000; values + * above 1000 are coerced to 1000. + */ + // const pageSize = 1234 + /** + * A page token, received from a previous + * TensorboardService.ListTensorboardTimeSeries google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries + * call. Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to + * TensorboardService.ListTensorboardTimeSeries google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries + * must match the call that provided the page token. + */ + // const pageToken = 'abc123' + /** + * Field to use to sort the list. + */ + // const orderBy = 'abc123' + /** + * Mask specifying which fields to read. + */ + // const readMask = {} + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callListTensorboardTimeSeries() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listTensorboardTimeSeriesAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListTensorboardTimeSeries(); + // [END aiplatform_v1beta1_generated_TensorboardService_ListTensorboardTimeSeries_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.list_tensorboards.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.list_tensorboards.js new file mode 100644 index 00000000000..582b0738826 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.list_tensorboards.js @@ -0,0 +1,93 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1beta1_generated_TensorboardService_ListTensorboards_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to list Tensorboards. + * Format: + * `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Lists the Tensorboards that match the filter expression. + */ + // const filter = 'abc123' + /** + * The maximum number of Tensorboards to return. The service may return + * fewer than this value. If unspecified, at most 100 Tensorboards are + * returned. The maximum value is 100; values above 100 are coerced to + * 100. + */ + // const pageSize = 1234 + /** + * A page token, received from a previous + * TensorboardService.ListTensorboards google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards + * call. Provide this to retrieve the subsequent page. + * When paginating, all other parameters provided to + * TensorboardService.ListTensorboards google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards + * must match the call that provided the page token. + */ + // const pageToken = 'abc123' + /** + * Field to use to sort the list. + */ + // const orderBy = 'abc123' + /** + * Mask specifying which fields to read. + */ + // const readMask = {} + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callListTensorboards() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listTensorboardsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListTensorboards(); + // [END aiplatform_v1beta1_generated_TensorboardService_ListTensorboards_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.read_tensorboard_blob_data.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.read_tensorboard_blob_data.js new file mode 100644 index 00000000000..50eadd1b375 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.read_tensorboard_blob_data.js @@ -0,0 +1,69 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(timeSeries) { + // [START aiplatform_v1beta1_generated_TensorboardService_ReadTensorboardBlobData_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the TensorboardTimeSeries to list Blobs. + * Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}` + */ + // const timeSeries = 'abc123' + /** + * IDs of the blobs to read. + */ + // const blobIds = 'abc123' + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callReadTensorboardBlobData() { + // Construct request + const request = { + timeSeries, + }; + + // Run request + const stream = await aiplatformClient.readTensorboardBlobData(request); + stream.on('data', (response) => { console.log(response) }); + stream.on('error', (err) => { throw(err) }); + stream.on('end', () => { /* API call completed */ }); + } + + callReadTensorboardBlobData(); + // [END aiplatform_v1beta1_generated_TensorboardService_ReadTensorboardBlobData_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.read_tensorboard_time_series_data.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.read_tensorboard_time_series_data.js new file mode 100644 index 00000000000..526855b318a --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.read_tensorboard_time_series_data.js @@ -0,0 +1,73 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(tensorboardTimeSeries) { + // [START aiplatform_v1beta1_generated_TensorboardService_ReadTensorboardTimeSeriesData_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the TensorboardTimeSeries to read data from. + * Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}` + */ + // const tensorboardTimeSeries = 'abc123' + /** + * The maximum number of TensorboardTimeSeries' data to return. + * This value should be a positive integer. + * This value can be set to -1 to return all data. + */ + // const maxDataPoints = 1234 + /** + * Reads the TensorboardTimeSeries' data that match the filter expression. + */ + // const filter = 'abc123' + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callReadTensorboardTimeSeriesData() { + // Construct request + const request = { + tensorboardTimeSeries, + }; + + // Run request + const response = await aiplatformClient.readTensorboardTimeSeriesData(request); + console.log(response); + } + + callReadTensorboardTimeSeriesData(); + // [END aiplatform_v1beta1_generated_TensorboardService_ReadTensorboardTimeSeriesData_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.read_tensorboard_usage.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.read_tensorboard_usage.js new file mode 100644 index 00000000000..e29e8091be1 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.read_tensorboard_usage.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(tensorboard) { + // [START aiplatform_v1beta1_generated_TensorboardService_ReadTensorboardUsage_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Tensorboard resource. + * Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}` + */ + // const tensorboard = 'abc123' + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callReadTensorboardUsage() { + // Construct request + const request = { + tensorboard, + }; + + // Run request + const response = await aiplatformClient.readTensorboardUsage(request); + console.log(response); + } + + callReadTensorboardUsage(); + // [END aiplatform_v1beta1_generated_TensorboardService_ReadTensorboardUsage_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.update_tensorboard.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.update_tensorboard.js new file mode 100644 index 00000000000..0e960eedb1e --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.update_tensorboard.js @@ -0,0 +1,74 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(updateMask, tensorboard) { + // [START aiplatform_v1beta1_generated_TensorboardService_UpdateTensorboard_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. Field mask is used to specify the fields to be overwritten in the + * Tensorboard resource by the update. + * The fields specified in the update_mask are relative to the resource, not + * the full request. A field is overwritten if it's in the mask. If the + * user does not provide a mask then all fields are overwritten if new + * values are specified. + */ + // const updateMask = {} + /** + * Required. The Tensorboard's `name` field is used to identify the + * Tensorboard to be updated. Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}` + */ + // const tensorboard = {} + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callUpdateTensorboard() { + // Construct request + const request = { + updateMask, + tensorboard, + }; + + // Run request + const [operation] = await aiplatformClient.updateTensorboard(request); + const [response] = await operation.promise(); + console.log(response); + } + + callUpdateTensorboard(); + // [END aiplatform_v1beta1_generated_TensorboardService_UpdateTensorboard_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.update_tensorboard_experiment.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.update_tensorboard_experiment.js new file mode 100644 index 00000000000..1affa43cb61 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.update_tensorboard_experiment.js @@ -0,0 +1,73 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(updateMask, tensorboardExperiment) { + // [START aiplatform_v1beta1_generated_TensorboardService_UpdateTensorboardExperiment_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. Field mask is used to specify the fields to be overwritten in the + * TensorboardExperiment resource by the update. + * The fields specified in the update_mask are relative to the resource, not + * the full request. A field is overwritten if it's in the mask. If the + * user does not provide a mask then all fields are overwritten if new + * values are specified. + */ + // const updateMask = {} + /** + * Required. The TensorboardExperiment's `name` field is used to identify the + * TensorboardExperiment to be updated. Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` + */ + // const tensorboardExperiment = {} + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callUpdateTensorboardExperiment() { + // Construct request + const request = { + updateMask, + tensorboardExperiment, + }; + + // Run request + const response = await aiplatformClient.updateTensorboardExperiment(request); + console.log(response); + } + + callUpdateTensorboardExperiment(); + // [END aiplatform_v1beta1_generated_TensorboardService_UpdateTensorboardExperiment_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.update_tensorboard_run.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.update_tensorboard_run.js new file mode 100644 index 00000000000..ddfe9eee9a8 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.update_tensorboard_run.js @@ -0,0 +1,73 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(updateMask, tensorboardRun) { + // [START aiplatform_v1beta1_generated_TensorboardService_UpdateTensorboardRun_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. Field mask is used to specify the fields to be overwritten in the + * TensorboardRun resource by the update. + * The fields specified in the update_mask are relative to the resource, not + * the full request. A field is overwritten if it's in the mask. If the + * user does not provide a mask then all fields are overwritten if new + * values are specified. + */ + // const updateMask = {} + /** + * Required. The TensorboardRun's `name` field is used to identify the + * TensorboardRun to be updated. Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` + */ + // const tensorboardRun = {} + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callUpdateTensorboardRun() { + // Construct request + const request = { + updateMask, + tensorboardRun, + }; + + // Run request + const response = await aiplatformClient.updateTensorboardRun(request); + console.log(response); + } + + callUpdateTensorboardRun(); + // [END aiplatform_v1beta1_generated_TensorboardService_UpdateTensorboardRun_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.update_tensorboard_time_series.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.update_tensorboard_time_series.js new file mode 100644 index 00000000000..8258fc64450 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.update_tensorboard_time_series.js @@ -0,0 +1,74 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(updateMask, tensorboardTimeSeries) { + // [START aiplatform_v1beta1_generated_TensorboardService_UpdateTensorboardTimeSeries_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. Field mask is used to specify the fields to be overwritten in the + * TensorboardTimeSeries resource by the update. + * The fields specified in the update_mask are relative to the resource, not + * the full request. A field is overwritten if it's in the mask. If the + * user does not provide a mask then all fields are overwritten if new + * values are specified. + */ + // const updateMask = {} + /** + * Required. The TensorboardTimeSeries' `name` field is used to identify the + * TensorboardTimeSeries to be updated. + * Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}` + */ + // const tensorboardTimeSeries = {} + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callUpdateTensorboardTimeSeries() { + // Construct request + const request = { + updateMask, + tensorboardTimeSeries, + }; + + // Run request + const response = await aiplatformClient.updateTensorboardTimeSeries(request); + console.log(response); + } + + callUpdateTensorboardTimeSeries(); + // [END aiplatform_v1beta1_generated_TensorboardService_UpdateTensorboardTimeSeries_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.write_tensorboard_experiment_data.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.write_tensorboard_experiment_data.js new file mode 100644 index 00000000000..fad54d33dd4 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.write_tensorboard_experiment_data.js @@ -0,0 +1,68 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(tensorboardExperiment, writeRunDataRequests) { + // [START aiplatform_v1beta1_generated_TensorboardService_WriteTensorboardExperimentData_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the TensorboardExperiment to write data to. + * Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` + */ + // const tensorboardExperiment = 'abc123' + /** + * Required. Requests containing per-run TensorboardTimeSeries data to write. + */ + // const writeRunDataRequests = 1234 + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callWriteTensorboardExperimentData() { + // Construct request + const request = { + tensorboardExperiment, + writeRunDataRequests, + }; + + // Run request + const response = await aiplatformClient.writeTensorboardExperimentData(request); + console.log(response); + } + + callWriteTensorboardExperimentData(); + // [END aiplatform_v1beta1_generated_TensorboardService_WriteTensorboardExperimentData_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.write_tensorboard_run_data.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.write_tensorboard_run_data.js new file mode 100644 index 00000000000..bc09d512805 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/tensorboard_service.write_tensorboard_run_data.js @@ -0,0 +1,72 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(tensorboardRun, timeSeriesData) { + // [START aiplatform_v1beta1_generated_TensorboardService_WriteTensorboardRunData_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the TensorboardRun to write data to. + * Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` + */ + // const tensorboardRun = 'abc123' + /** + * Required. The TensorboardTimeSeries data to write. + * Values with in a time series are indexed by their step value. + * Repeated writes to the same step will overwrite the existing value for that + * step. + * The upper limit of data points per write request is 5000. + */ + // const timeSeriesData = 1234 + + // Imports the Aiplatform library + const {TensorboardServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new TensorboardServiceClient(); + + async function callWriteTensorboardRunData() { + // Construct request + const request = { + tensorboardRun, + timeSeriesData, + }; + + // Run request + const response = await aiplatformClient.writeTensorboardRunData(request); + console.log(response); + } + + callWriteTensorboardRunData(); + // [END aiplatform_v1beta1_generated_TensorboardService_WriteTensorboardRunData_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/vizier_service.add_trial_measurement.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/vizier_service.add_trial_measurement.js new file mode 100644 index 00000000000..e78a7cfd101 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/vizier_service.add_trial_measurement.js @@ -0,0 +1,68 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(trialName, measurement) { + // [START aiplatform_v1beta1_generated_VizierService_AddTrialMeasurement_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the trial to add measurement. + * Format: + * `projects/{project}/locations/{location}/studies/{study}/trials/{trial}` + */ + // const trialName = 'abc123' + /** + * Required. The measurement to be added to a Trial. + */ + // const measurement = {} + + // Imports the Aiplatform library + const {VizierServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new VizierServiceClient(); + + async function callAddTrialMeasurement() { + // Construct request + const request = { + trialName, + measurement, + }; + + // Run request + const response = await aiplatformClient.addTrialMeasurement(request); + console.log(response); + } + + callAddTrialMeasurement(); + // [END aiplatform_v1beta1_generated_VizierService_AddTrialMeasurement_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/vizier_service.check_trial_early_stopping_state.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/vizier_service.check_trial_early_stopping_state.js new file mode 100644 index 00000000000..5e94bab1fa1 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/vizier_service.check_trial_early_stopping_state.js @@ -0,0 +1,64 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(trialName) { + // [START aiplatform_v1beta1_generated_VizierService_CheckTrialEarlyStoppingState_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The Trial's name. + * Format: + * `projects/{project}/locations/{location}/studies/{study}/trials/{trial}` + */ + // const trialName = 'abc123' + + // Imports the Aiplatform library + const {VizierServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new VizierServiceClient(); + + async function callCheckTrialEarlyStoppingState() { + // Construct request + const request = { + trialName, + }; + + // Run request + const [operation] = await aiplatformClient.checkTrialEarlyStoppingState(request); + const [response] = await operation.promise(); + console.log(response); + } + + callCheckTrialEarlyStoppingState(); + // [END aiplatform_v1beta1_generated_VizierService_CheckTrialEarlyStoppingState_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/vizier_service.complete_trial.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/vizier_service.complete_trial.js new file mode 100644 index 00000000000..6c723d46c58 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/vizier_service.complete_trial.js @@ -0,0 +1,79 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_VizierService_CompleteTrial_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The Trial's name. + * Format: + * `projects/{project}/locations/{location}/studies/{study}/trials/{trial}` + */ + // const name = 'abc123' + /** + * Optional. If provided, it will be used as the completed Trial's + * final_measurement; Otherwise, the service will auto-select a + * previously reported measurement as the final-measurement + */ + // const finalMeasurement = {} + /** + * Optional. True if the Trial cannot be run with the given Parameter, and + * final_measurement will be ignored. + */ + // const trialInfeasible = true + /** + * Optional. A human readable reason why the trial was infeasible. This should + * only be provided if `trial_infeasible` is true. + */ + // const infeasibleReason = 'abc123' + + // Imports the Aiplatform library + const {VizierServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new VizierServiceClient(); + + async function callCompleteTrial() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.completeTrial(request); + console.log(response); + } + + callCompleteTrial(); + // [END aiplatform_v1beta1_generated_VizierService_CompleteTrial_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/vizier_service.create_study.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/vizier_service.create_study.js new file mode 100644 index 00000000000..4d525d17689 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/vizier_service.create_study.js @@ -0,0 +1,67 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, study) { + // [START aiplatform_v1beta1_generated_VizierService_CreateStudy_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to create the CustomJob in. + * Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Required. The Study configuration used to create the Study. + */ + // const study = {} + + // Imports the Aiplatform library + const {VizierServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new VizierServiceClient(); + + async function callCreateStudy() { + // Construct request + const request = { + parent, + study, + }; + + // Run request + const response = await aiplatformClient.createStudy(request); + console.log(response); + } + + callCreateStudy(); + // [END aiplatform_v1beta1_generated_VizierService_CreateStudy_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/vizier_service.create_trial.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/vizier_service.create_trial.js new file mode 100644 index 00000000000..780449ae839 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/vizier_service.create_trial.js @@ -0,0 +1,67 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, trial) { + // [START aiplatform_v1beta1_generated_VizierService_CreateTrial_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Study to create the Trial in. + * Format: `projects/{project}/locations/{location}/studies/{study}` + */ + // const parent = 'abc123' + /** + * Required. The Trial to create. + */ + // const trial = {} + + // Imports the Aiplatform library + const {VizierServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new VizierServiceClient(); + + async function callCreateTrial() { + // Construct request + const request = { + parent, + trial, + }; + + // Run request + const response = await aiplatformClient.createTrial(request); + console.log(response); + } + + callCreateTrial(); + // [END aiplatform_v1beta1_generated_VizierService_CreateTrial_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/vizier_service.delete_study.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/vizier_service.delete_study.js new file mode 100644 index 00000000000..14f67c8add1 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/vizier_service.delete_study.js @@ -0,0 +1,62 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_VizierService_DeleteStudy_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Study resource to be deleted. + * Format: `projects/{project}/locations/{location}/studies/{study}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {VizierServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new VizierServiceClient(); + + async function callDeleteStudy() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.deleteStudy(request); + console.log(response); + } + + callDeleteStudy(); + // [END aiplatform_v1beta1_generated_VizierService_DeleteStudy_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/vizier_service.delete_trial.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/vizier_service.delete_trial.js new file mode 100644 index 00000000000..3f22d0865d0 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/vizier_service.delete_trial.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_VizierService_DeleteTrial_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The Trial's name. + * Format: + * `projects/{project}/locations/{location}/studies/{study}/trials/{trial}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {VizierServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new VizierServiceClient(); + + async function callDeleteTrial() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.deleteTrial(request); + console.log(response); + } + + callDeleteTrial(); + // [END aiplatform_v1beta1_generated_VizierService_DeleteTrial_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/vizier_service.get_study.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/vizier_service.get_study.js new file mode 100644 index 00000000000..7396398c089 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/vizier_service.get_study.js @@ -0,0 +1,62 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_VizierService_GetStudy_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Study resource. + * Format: `projects/{project}/locations/{location}/studies/{study}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {VizierServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new VizierServiceClient(); + + async function callGetStudy() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getStudy(request); + console.log(response); + } + + callGetStudy(); + // [END aiplatform_v1beta1_generated_VizierService_GetStudy_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/vizier_service.get_trial.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/vizier_service.get_trial.js new file mode 100644 index 00000000000..9adb442e543 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/vizier_service.get_trial.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_VizierService_GetTrial_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Trial resource. + * Format: + * `projects/{project}/locations/{location}/studies/{study}/trials/{trial}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {VizierServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new VizierServiceClient(); + + async function callGetTrial() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.getTrial(request); + console.log(response); + } + + callGetTrial(); + // [END aiplatform_v1beta1_generated_VizierService_GetTrial_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/vizier_service.list_optimal_trials.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/vizier_service.list_optimal_trials.js new file mode 100644 index 00000000000..c5815e4ee39 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/vizier_service.list_optimal_trials.js @@ -0,0 +1,61 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1beta1_generated_VizierService_ListOptimalTrials_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The name of the Study that the optimal Trial belongs to. + */ + // const parent = 'abc123' + + // Imports the Aiplatform library + const {VizierServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new VizierServiceClient(); + + async function callListOptimalTrials() { + // Construct request + const request = { + parent, + }; + + // Run request + const response = await aiplatformClient.listOptimalTrials(request); + console.log(response); + } + + callListOptimalTrials(); + // [END aiplatform_v1beta1_generated_VizierService_ListOptimalTrials_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/vizier_service.list_studies.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/vizier_service.list_studies.js new file mode 100644 index 00000000000..f5c74fc08f1 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/vizier_service.list_studies.js @@ -0,0 +1,74 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1beta1_generated_VizierService_ListStudies_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to list the Study from. + * Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Optional. A page token to request the next page of results. + * If unspecified, there are no subsequent pages. + */ + // const pageToken = 'abc123' + /** + * Optional. The maximum number of studies to return per "page" of results. + * If unspecified, service will pick an appropriate default. + */ + // const pageSize = 1234 + + // Imports the Aiplatform library + const {VizierServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new VizierServiceClient(); + + async function callListStudies() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listStudiesAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListStudies(); + // [END aiplatform_v1beta1_generated_VizierService_ListStudies_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/vizier_service.list_trials.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/vizier_service.list_trials.js new file mode 100644 index 00000000000..67e6aead3c3 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/vizier_service.list_trials.js @@ -0,0 +1,74 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent) { + // [START aiplatform_v1beta1_generated_VizierService_ListTrials_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Study to list the Trial from. + * Format: `projects/{project}/locations/{location}/studies/{study}` + */ + // const parent = 'abc123' + /** + * Optional. A page token to request the next page of results. + * If unspecified, there are no subsequent pages. + */ + // const pageToken = 'abc123' + /** + * Optional. The number of Trials to retrieve per "page" of results. + * If unspecified, the service will pick an appropriate default. + */ + // const pageSize = 1234 + + // Imports the Aiplatform library + const {VizierServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new VizierServiceClient(); + + async function callListTrials() { + // Construct request + const request = { + parent, + }; + + // Run request + const iterable = await aiplatformClient.listTrialsAsync(request); + for await (const response of iterable) { + console.log(response); + } + } + + callListTrials(); + // [END aiplatform_v1beta1_generated_VizierService_ListTrials_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/vizier_service.lookup_study.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/vizier_service.lookup_study.js new file mode 100644 index 00000000000..bb4cb045fc7 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/vizier_service.lookup_study.js @@ -0,0 +1,67 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, displayName) { + // [START aiplatform_v1beta1_generated_VizierService_LookupStudy_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The resource name of the Location to get the Study from. + * Format: `projects/{project}/locations/{location}` + */ + // const parent = 'abc123' + /** + * Required. The user-defined display name of the Study + */ + // const displayName = 'abc123' + + // Imports the Aiplatform library + const {VizierServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new VizierServiceClient(); + + async function callLookupStudy() { + // Construct request + const request = { + parent, + displayName, + }; + + // Run request + const response = await aiplatformClient.lookupStudy(request); + console.log(response); + } + + callLookupStudy(); + // [END aiplatform_v1beta1_generated_VizierService_LookupStudy_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/vizier_service.stop_trial.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/vizier_service.stop_trial.js new file mode 100644 index 00000000000..b7c892eca9a --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/vizier_service.stop_trial.js @@ -0,0 +1,63 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(name) { + // [START aiplatform_v1beta1_generated_VizierService_StopTrial_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The Trial's name. + * Format: + * `projects/{project}/locations/{location}/studies/{study}/trials/{trial}` + */ + // const name = 'abc123' + + // Imports the Aiplatform library + const {VizierServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new VizierServiceClient(); + + async function callStopTrial() { + // Construct request + const request = { + name, + }; + + // Run request + const response = await aiplatformClient.stopTrial(request); + console.log(response); + } + + callStopTrial(); + // [END aiplatform_v1beta1_generated_VizierService_StopTrial_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/generated/v1beta1/vizier_service.suggest_trials.js b/packages/google-cloud-aiplatform/samples/generated/v1beta1/vizier_service.suggest_trials.js new file mode 100644 index 00000000000..308d06c8a01 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/generated/v1beta1/vizier_service.suggest_trials.js @@ -0,0 +1,76 @@ +// Copyright 2023 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + + + +'use strict'; + +function main(parent, suggestionCount, clientId) { + // [START aiplatform_v1beta1_generated_VizierService_SuggestTrials_async] + /** + * This snippet has been automatically generated and should be regarded as a code template only. + * It will require modifications to work. + * It may require correct/in-range values for request initialization. + * TODO(developer): Uncomment these variables before running the sample. + */ + /** + * Required. The project and location that the Study belongs to. + * Format: `projects/{project}/locations/{location}/studies/{study}` + */ + // const parent = 'abc123' + /** + * Required. The number of suggestions requested. It must be positive. + */ + // const suggestionCount = 1234 + /** + * Required. The identifier of the client that is requesting the suggestion. + * If multiple SuggestTrialsRequests have the same `client_id`, + * the service will return the identical suggested Trial if the Trial is + * pending, and provide a new Trial if the last suggested Trial was completed. + */ + // const clientId = 'abc123' + + // Imports the Aiplatform library + const {VizierServiceClient} = require('@google-cloud/aiplatform').v1beta1; + + // Instantiates a client + const aiplatformClient = new VizierServiceClient(); + + async function callSuggestTrials() { + // Construct request + const request = { + parent, + suggestionCount, + clientId, + }; + + // Run request + const [operation] = await aiplatformClient.suggestTrials(request); + const [response] = await operation.promise(); + console.log(response); + } + + callSuggestTrials(); + // [END aiplatform_v1beta1_generated_VizierService_SuggestTrials_async] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/package.json b/packages/google-cloud-aiplatform/samples/package.json new file mode 100644 index 00000000000..d9ea9f217a0 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/package.json @@ -0,0 +1,23 @@ +{ + "name": "nodejs-aiplatform-samples", + "private": true, + "license": "Apache-2.0", + "author": "Google LLC", + "engines": { + "node": ">=12.0.0" + }, + "files": [ + "*.js" + ], + "scripts": { + "test": "mocha --timeout 1200000 test/*.js" + }, + "dependencies": { + "@google-cloud/aiplatform": "^2.3.0" + }, + "devDependencies": { + "chai": "^4.2.0", + "mocha": "^8.0.0", + "uuid": "^9.0.0" + } + } \ No newline at end of file diff --git a/packages/google-cloud-aiplatform/samples/quickstart.js b/packages/google-cloud-aiplatform/samples/quickstart.js new file mode 100644 index 00000000000..01e425910c9 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/quickstart.js @@ -0,0 +1,62 @@ +/** + * Copyright 2020, Google, LLC. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +'use strict'; + +async function main(projectId, location = 'us-central1') { + // [START aiplatform_list_endpoints_sample] + /** + * TODO(developer): Uncomment these variables before running the sample. + */ + // const projectId = 'YOUR_PROJECT_ID'; + // const location = 'YOUR_PROJECT_LOCATION'; + + const {EndpointServiceClient} = require('@google-cloud/aiplatform'); + + // Specifies the location of the api endpoint + const clientOptions = { + apiEndpoint: 'us-central1-aiplatform.googleapis.com', + }; + const client = new EndpointServiceClient(clientOptions); + + async function listEndpoints() { + // Configure the parent resource + const parent = `projects/${projectId}/locations/${location}`; + const request = { + parent, + }; + + // Get and print out a list of all the endpoints for this resource + const [result] = await client.listEndpoints(request); + for (const endpoint of result) { + console.log(`\nEndpoint name: ${endpoint.name}`); + console.log(`Display name: ${endpoint.displayName}`); + if (endpoint.deployedModels[0]) { + console.log( + `First deployed model: ${endpoint.deployedModels[0].model}` + ); + } + } + } + listEndpoints(); + // [END aiplatform_list_endpoints_sample] +} + +process.on('unhandledRejection', err => { + console.error(err.message); + process.exitCode = 1; +}); + +main(...process.argv.slice(2)); diff --git a/packages/google-cloud-aiplatform/samples/test/quickstart.test.js b/packages/google-cloud-aiplatform/samples/test/quickstart.test.js new file mode 100644 index 00000000000..2f29afa74b1 --- /dev/null +++ b/packages/google-cloud-aiplatform/samples/test/quickstart.test.js @@ -0,0 +1,45 @@ +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// ** This file is automatically generated by gapic-generator-typescript. ** +// ** https://github.com/googleapis/gapic-generator-typescript ** +// ** All changes to this file may be overwritten. ** + +'use strict'; + +const path = require('path'); +const cp = require('child_process'); +const {before, describe, it} = require('mocha'); +// eslint-disable-next-line node/no-missing-require +const {EndpointServiceClient} = require('@google-cloud/aiplatform'); +// eslint-disable-next-line no-unused-vars, node/no-missing-require +const {assert} = require('chai'); + +const execSync = cmd => cp.execSync(cmd, {encoding: 'utf-8'}); + +const cwd = path.join(__dirname, '..'); + +const client = new EndpointServiceClient(); + +describe('Quickstart', () => { + let projectId; + + before(async () => { + projectId = await client.getProjectId(); + }); + + it('should run quickstart', async () => { + const stdout = execSync(`node ./quickstart.js ${projectId}`, {cwd}); + assert.ok(stdout !== null); + }); +}); diff --git a/packages/google-cloud-aiplatform/src/v1/dataset_service_client.ts b/packages/google-cloud-aiplatform/src/v1/dataset_service_client.ts index 35f9703b0b5..cea58dfc27d 100644 --- a/packages/google-cloud-aiplatform/src/v1/dataset_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1/dataset_service_client.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -310,6 +310,11 @@ export class DatasetServiceClient { 'nextPageToken', 'dataItems' ), + searchDataItems: new this._gaxModule.PageDescriptor( + 'pageToken', + 'nextPageToken', + 'dataItemViews' + ), listSavedQueries: new this._gaxModule.PageDescriptor( 'pageToken', 'nextPageToken', @@ -345,8 +350,14 @@ export class DatasetServiceClient { }, { selector: 'google.iam.v1.IAMPolicy.GetIamPolicy', - post: '/ui/{resource=projects/*/locations/*/featurestores/*}:getIamPolicy', + post: '/v1/{resource=projects/*/locations/*/featurestores/*}:getIamPolicy', additional_bindings: [ + { + post: '/v1/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:getIamPolicy', + }, + { + post: '/ui/{resource=projects/*/locations/*/featurestores/*}:getIamPolicy', + }, { post: '/ui/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:getIamPolicy', }, @@ -354,9 +365,17 @@ export class DatasetServiceClient { }, { selector: 'google.iam.v1.IAMPolicy.SetIamPolicy', - post: '/ui/{resource=projects/*/locations/*/featurestores/*}:setIamPolicy', + post: '/v1/{resource=projects/*/locations/*/featurestores/*}:setIamPolicy', body: '*', additional_bindings: [ + { + post: '/v1/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:setIamPolicy', + body: '*', + }, + { + post: '/ui/{resource=projects/*/locations/*/featurestores/*}:setIamPolicy', + body: '*', + }, { post: '/ui/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:setIamPolicy', body: '*', @@ -365,8 +384,14 @@ export class DatasetServiceClient { }, { selector: 'google.iam.v1.IAMPolicy.TestIamPermissions', - post: '/ui/{resource=projects/*/locations/*/featurestores/*}:testIamPermissions', + post: '/v1/{resource=projects/*/locations/*/featurestores/*}:testIamPermissions', additional_bindings: [ + { + post: '/v1/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:testIamPermissions', + }, + { + post: '/ui/{resource=projects/*/locations/*/featurestores/*}:testIamPermissions', + }, { post: '/ui/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:testIamPermissions', }, @@ -1381,6 +1406,7 @@ export class DatasetServiceClient { 'importData', 'exportData', 'listDataItems', + 'searchDataItems', 'listSavedQueries', 'getAnnotationSpec', 'listAnnotations', @@ -1566,8 +1592,8 @@ export class DatasetServiceClient { * Required. The Dataset which replaces the resource on the server. * @param {google.protobuf.FieldMask} request.updateMask * Required. The update mask applies to the resource. - * For the `FieldMask` definition, see {@link google.protobuf.FieldMask|google.protobuf.FieldMask}. - * Updatable fields: + * For the `FieldMask` definition, see + * {@link google.protobuf.FieldMask|google.protobuf.FieldMask}. Updatable fields: * * * `display_name` * * `description` @@ -2043,8 +2069,8 @@ export class DatasetServiceClient { * Format: * `projects/{project}/locations/{location}/datasets/{dataset}` * @param {number[]} request.importConfigs - * Required. The desired input locations. The contents of all input locations will be - * imported in one batch. + * Required. The desired input locations. The contents of all input locations + * will be imported in one batch. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -2801,6 +2827,366 @@ export class DatasetServiceClient { callSettings ) as AsyncIterable; } + /** + * Searches DataItems in a Dataset. + * + * @param {Object} request + * The request object that will be sent. + * @param {string} request.orderByDataItem + * A comma-separated list of data item fields to order by, sorted in + * ascending order. Use "desc" after a field name for descending. + * @param {google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation} request.orderByAnnotation + * Expression that allows ranking results based on annotation's property. + * @param {string} request.dataset + * Required. The resource name of the Dataset from which to search DataItems. + * Format: + * `projects/{project}/locations/{location}/datasets/{dataset}` + * @param {string} request.savedQuery + * The resource name of a SavedQuery(annotation set in UI). + * Format: + * `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}` + * All of the search will be done in the context of this SavedQuery. + * @param {string} request.dataLabelingJob + * The resource name of a DataLabelingJob. + * Format: + * `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` + * If this field is set, all of the search will be done in the context of + * this DataLabelingJob. + * @param {string} request.dataItemFilter + * An expression for filtering the DataItem that will be returned. + * + * * `data_item_id` - for = or !=. + * * `labeled` - for = or !=. + * * `has_annotation(ANNOTATION_SPEC_ID)` - true only for DataItem that + * have at least one annotation with annotation_spec_id = + * `ANNOTATION_SPEC_ID` in the context of SavedQuery or DataLabelingJob. + * + * For example: + * + * * `data_item=1` + * * `has_annotation(5)` + * @param {string} request.annotationsFilter + * An expression for filtering the Annotations that will be returned per + * DataItem. + * * `annotation_spec_id` - for = or !=. + * @param {string[]} request.annotationFilters + * An expression that specifies what Annotations will be returned per + * DataItem. Annotations satisfied either of the conditions will be returned. + * * `annotation_spec_id` - for = or !=. + * Must specify `saved_query_id=` - saved query id that annotations should + * belong to. + * @param {google.protobuf.FieldMask} request.fieldMask + * Mask specifying which fields of + * {@link google.cloud.aiplatform.v1.DataItemView|DataItemView} to read. + * @param {number} request.annotationsLimit + * If set, only up to this many of Annotations will be returned per + * DataItemView. The maximum value is 1000. If not set, the maximum value will + * be used. + * @param {number} request.pageSize + * Requested page size. Server may return fewer results than requested. + * Default and maximum page size is 100. + * @param {string} request.orderBy + * A comma-separated list of fields to order by, sorted in ascending order. + * Use "desc" after a field name for descending. + * @param {string} request.pageToken + * A token identifying a page of results for the server to return + * Typically obtained via + * {@link google.cloud.aiplatform.v1.SearchDataItemsResponse.next_page_token|SearchDataItemsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1.DatasetService.SearchDataItems|DatasetService.SearchDataItems} + * call. + * @param {object} [options] + * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. + * @returns {Promise} - The promise which resolves to an array. + * The first element of the array is Array of [DataItemView]{@link google.cloud.aiplatform.v1.DataItemView}. + * The client library will perform auto-pagination by default: it will call the API as many + * times as needed and will merge results from all the pages into this array. + * Note that it can affect your quota. + * We recommend using `searchDataItemsAsync()` + * method described below for async iteration which you can stop as needed. + * Please see the + * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * for more details and examples. + */ + searchDataItems( + request?: protos.google.cloud.aiplatform.v1.ISearchDataItemsRequest, + options?: CallOptions + ): Promise< + [ + protos.google.cloud.aiplatform.v1.IDataItemView[], + protos.google.cloud.aiplatform.v1.ISearchDataItemsRequest | null, + protos.google.cloud.aiplatform.v1.ISearchDataItemsResponse + ] + >; + searchDataItems( + request: protos.google.cloud.aiplatform.v1.ISearchDataItemsRequest, + options: CallOptions, + callback: PaginationCallback< + protos.google.cloud.aiplatform.v1.ISearchDataItemsRequest, + | protos.google.cloud.aiplatform.v1.ISearchDataItemsResponse + | null + | undefined, + protos.google.cloud.aiplatform.v1.IDataItemView + > + ): void; + searchDataItems( + request: protos.google.cloud.aiplatform.v1.ISearchDataItemsRequest, + callback: PaginationCallback< + protos.google.cloud.aiplatform.v1.ISearchDataItemsRequest, + | protos.google.cloud.aiplatform.v1.ISearchDataItemsResponse + | null + | undefined, + protos.google.cloud.aiplatform.v1.IDataItemView + > + ): void; + searchDataItems( + request?: protos.google.cloud.aiplatform.v1.ISearchDataItemsRequest, + optionsOrCallback?: + | CallOptions + | PaginationCallback< + protos.google.cloud.aiplatform.v1.ISearchDataItemsRequest, + | protos.google.cloud.aiplatform.v1.ISearchDataItemsResponse + | null + | undefined, + protos.google.cloud.aiplatform.v1.IDataItemView + >, + callback?: PaginationCallback< + protos.google.cloud.aiplatform.v1.ISearchDataItemsRequest, + | protos.google.cloud.aiplatform.v1.ISearchDataItemsResponse + | null + | undefined, + protos.google.cloud.aiplatform.v1.IDataItemView + > + ): Promise< + [ + protos.google.cloud.aiplatform.v1.IDataItemView[], + protos.google.cloud.aiplatform.v1.ISearchDataItemsRequest | null, + protos.google.cloud.aiplatform.v1.ISearchDataItemsResponse + ] + > | void { + request = request || {}; + let options: CallOptions; + if (typeof optionsOrCallback === 'function' && callback === undefined) { + callback = optionsOrCallback; + options = {}; + } else { + options = optionsOrCallback as CallOptions; + } + options = options || {}; + options.otherArgs = options.otherArgs || {}; + options.otherArgs.headers = options.otherArgs.headers || {}; + options.otherArgs.headers['x-goog-request-params'] = + this._gaxModule.routingHeader.fromParams({ + dataset: request.dataset ?? '', + }); + this.initialize(); + return this.innerApiCalls.searchDataItems(request, options, callback); + } + + /** + * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object. + * @param {Object} request + * The request object that will be sent. + * @param {string} request.orderByDataItem + * A comma-separated list of data item fields to order by, sorted in + * ascending order. Use "desc" after a field name for descending. + * @param {google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation} request.orderByAnnotation + * Expression that allows ranking results based on annotation's property. + * @param {string} request.dataset + * Required. The resource name of the Dataset from which to search DataItems. + * Format: + * `projects/{project}/locations/{location}/datasets/{dataset}` + * @param {string} request.savedQuery + * The resource name of a SavedQuery(annotation set in UI). + * Format: + * `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}` + * All of the search will be done in the context of this SavedQuery. + * @param {string} request.dataLabelingJob + * The resource name of a DataLabelingJob. + * Format: + * `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` + * If this field is set, all of the search will be done in the context of + * this DataLabelingJob. + * @param {string} request.dataItemFilter + * An expression for filtering the DataItem that will be returned. + * + * * `data_item_id` - for = or !=. + * * `labeled` - for = or !=. + * * `has_annotation(ANNOTATION_SPEC_ID)` - true only for DataItem that + * have at least one annotation with annotation_spec_id = + * `ANNOTATION_SPEC_ID` in the context of SavedQuery or DataLabelingJob. + * + * For example: + * + * * `data_item=1` + * * `has_annotation(5)` + * @param {string} request.annotationsFilter + * An expression for filtering the Annotations that will be returned per + * DataItem. + * * `annotation_spec_id` - for = or !=. + * @param {string[]} request.annotationFilters + * An expression that specifies what Annotations will be returned per + * DataItem. Annotations satisfied either of the conditions will be returned. + * * `annotation_spec_id` - for = or !=. + * Must specify `saved_query_id=` - saved query id that annotations should + * belong to. + * @param {google.protobuf.FieldMask} request.fieldMask + * Mask specifying which fields of + * {@link google.cloud.aiplatform.v1.DataItemView|DataItemView} to read. + * @param {number} request.annotationsLimit + * If set, only up to this many of Annotations will be returned per + * DataItemView. The maximum value is 1000. If not set, the maximum value will + * be used. + * @param {number} request.pageSize + * Requested page size. Server may return fewer results than requested. + * Default and maximum page size is 100. + * @param {string} request.orderBy + * A comma-separated list of fields to order by, sorted in ascending order. + * Use "desc" after a field name for descending. + * @param {string} request.pageToken + * A token identifying a page of results for the server to return + * Typically obtained via + * {@link google.cloud.aiplatform.v1.SearchDataItemsResponse.next_page_token|SearchDataItemsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1.DatasetService.SearchDataItems|DatasetService.SearchDataItems} + * call. + * @param {object} [options] + * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. + * @returns {Stream} + * An object stream which emits an object representing [DataItemView]{@link google.cloud.aiplatform.v1.DataItemView} on 'data' event. + * The client library will perform auto-pagination by default: it will call the API as many + * times as needed. Note that it can affect your quota. + * We recommend using `searchDataItemsAsync()` + * method described below for async iteration which you can stop as needed. + * Please see the + * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * for more details and examples. + */ + searchDataItemsStream( + request?: protos.google.cloud.aiplatform.v1.ISearchDataItemsRequest, + options?: CallOptions + ): Transform { + request = request || {}; + options = options || {}; + options.otherArgs = options.otherArgs || {}; + options.otherArgs.headers = options.otherArgs.headers || {}; + options.otherArgs.headers['x-goog-request-params'] = + this._gaxModule.routingHeader.fromParams({ + dataset: request.dataset ?? '', + }); + const defaultCallSettings = this._defaults['searchDataItems']; + const callSettings = defaultCallSettings.merge(options); + this.initialize(); + return this.descriptors.page.searchDataItems.createStream( + this.innerApiCalls.searchDataItems as GaxCall, + request, + callSettings + ); + } + + /** + * Equivalent to `searchDataItems`, but returns an iterable object. + * + * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand. + * @param {Object} request + * The request object that will be sent. + * @param {string} request.orderByDataItem + * A comma-separated list of data item fields to order by, sorted in + * ascending order. Use "desc" after a field name for descending. + * @param {google.cloud.aiplatform.v1.SearchDataItemsRequest.OrderByAnnotation} request.orderByAnnotation + * Expression that allows ranking results based on annotation's property. + * @param {string} request.dataset + * Required. The resource name of the Dataset from which to search DataItems. + * Format: + * `projects/{project}/locations/{location}/datasets/{dataset}` + * @param {string} request.savedQuery + * The resource name of a SavedQuery(annotation set in UI). + * Format: + * `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}` + * All of the search will be done in the context of this SavedQuery. + * @param {string} request.dataLabelingJob + * The resource name of a DataLabelingJob. + * Format: + * `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` + * If this field is set, all of the search will be done in the context of + * this DataLabelingJob. + * @param {string} request.dataItemFilter + * An expression for filtering the DataItem that will be returned. + * + * * `data_item_id` - for = or !=. + * * `labeled` - for = or !=. + * * `has_annotation(ANNOTATION_SPEC_ID)` - true only for DataItem that + * have at least one annotation with annotation_spec_id = + * `ANNOTATION_SPEC_ID` in the context of SavedQuery or DataLabelingJob. + * + * For example: + * + * * `data_item=1` + * * `has_annotation(5)` + * @param {string} request.annotationsFilter + * An expression for filtering the Annotations that will be returned per + * DataItem. + * * `annotation_spec_id` - for = or !=. + * @param {string[]} request.annotationFilters + * An expression that specifies what Annotations will be returned per + * DataItem. Annotations satisfied either of the conditions will be returned. + * * `annotation_spec_id` - for = or !=. + * Must specify `saved_query_id=` - saved query id that annotations should + * belong to. + * @param {google.protobuf.FieldMask} request.fieldMask + * Mask specifying which fields of + * {@link google.cloud.aiplatform.v1.DataItemView|DataItemView} to read. + * @param {number} request.annotationsLimit + * If set, only up to this many of Annotations will be returned per + * DataItemView. The maximum value is 1000. If not set, the maximum value will + * be used. + * @param {number} request.pageSize + * Requested page size. Server may return fewer results than requested. + * Default and maximum page size is 100. + * @param {string} request.orderBy + * A comma-separated list of fields to order by, sorted in ascending order. + * Use "desc" after a field name for descending. + * @param {string} request.pageToken + * A token identifying a page of results for the server to return + * Typically obtained via + * {@link google.cloud.aiplatform.v1.SearchDataItemsResponse.next_page_token|SearchDataItemsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1.DatasetService.SearchDataItems|DatasetService.SearchDataItems} + * call. + * @param {object} [options] + * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. + * @returns {Object} + * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * When you iterate the returned iterable, each element will be an object representing + * [DataItemView]{@link google.cloud.aiplatform.v1.DataItemView}. The API will be called under the hood as needed, once per the page, + * so you can stop the iteration when you don't need more results. + * Please see the + * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * for more details and examples. + * @example include:samples/generated/v1/dataset_service.search_data_items.js + * region_tag:aiplatform_v1_generated_DatasetService_SearchDataItems_async + */ + searchDataItemsAsync( + request?: protos.google.cloud.aiplatform.v1.ISearchDataItemsRequest, + options?: CallOptions + ): AsyncIterable { + request = request || {}; + options = options || {}; + options.otherArgs = options.otherArgs || {}; + options.otherArgs.headers = options.otherArgs.headers || {}; + options.otherArgs.headers['x-goog-request-params'] = + this._gaxModule.routingHeader.fromParams({ + dataset: request.dataset ?? '', + }); + const defaultCallSettings = this._defaults['searchDataItems']; + const callSettings = defaultCallSettings.merge(options); + this.initialize(); + return this.descriptors.page.searchDataItems.asyncIterate( + this.innerApiCalls['searchDataItems'] as GaxCall, + request as {}, + callSettings + ) as AsyncIterable; + } /** * Lists SavedQueries in a Dataset. * diff --git a/packages/google-cloud-aiplatform/src/v1/dataset_service_client_config.json b/packages/google-cloud-aiplatform/src/v1/dataset_service_client_config.json index 69bc6d22d0c..ac943c50a3e 100644 --- a/packages/google-cloud-aiplatform/src/v1/dataset_service_client_config.json +++ b/packages/google-cloud-aiplatform/src/v1/dataset_service_client_config.json @@ -52,6 +52,10 @@ "retry_codes_name": "non_idempotent", "retry_params_name": "default" }, + "SearchDataItems": { + "retry_codes_name": "non_idempotent", + "retry_params_name": "default" + }, "ListSavedQueries": { "retry_codes_name": "non_idempotent", "retry_params_name": "default" diff --git a/packages/google-cloud-aiplatform/src/v1/endpoint_service_client.ts b/packages/google-cloud-aiplatform/src/v1/endpoint_service_client.ts index 29f22efe81a..3b0e57e8178 100644 --- a/packages/google-cloud-aiplatform/src/v1/endpoint_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1/endpoint_service_client.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -329,8 +329,14 @@ export class EndpointServiceClient { }, { selector: 'google.iam.v1.IAMPolicy.GetIamPolicy', - post: '/ui/{resource=projects/*/locations/*/featurestores/*}:getIamPolicy', + post: '/v1/{resource=projects/*/locations/*/featurestores/*}:getIamPolicy', additional_bindings: [ + { + post: '/v1/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:getIamPolicy', + }, + { + post: '/ui/{resource=projects/*/locations/*/featurestores/*}:getIamPolicy', + }, { post: '/ui/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:getIamPolicy', }, @@ -338,9 +344,17 @@ export class EndpointServiceClient { }, { selector: 'google.iam.v1.IAMPolicy.SetIamPolicy', - post: '/ui/{resource=projects/*/locations/*/featurestores/*}:setIamPolicy', + post: '/v1/{resource=projects/*/locations/*/featurestores/*}:setIamPolicy', body: '*', additional_bindings: [ + { + post: '/v1/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:setIamPolicy', + body: '*', + }, + { + post: '/ui/{resource=projects/*/locations/*/featurestores/*}:setIamPolicy', + body: '*', + }, { post: '/ui/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:setIamPolicy', body: '*', @@ -349,8 +363,14 @@ export class EndpointServiceClient { }, { selector: 'google.iam.v1.IAMPolicy.TestIamPermissions', - post: '/ui/{resource=projects/*/locations/*/featurestores/*}:testIamPermissions', + post: '/v1/{resource=projects/*/locations/*/featurestores/*}:testIamPermissions', additional_bindings: [ + { + post: '/v1/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:testIamPermissions', + }, + { + post: '/ui/{resource=projects/*/locations/*/featurestores/*}:testIamPermissions', + }, { post: '/ui/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:testIamPermissions', }, @@ -1545,7 +1565,8 @@ export class EndpointServiceClient { * @param {google.cloud.aiplatform.v1.Endpoint} request.endpoint * Required. The Endpoint which replaces the resource on the server. * @param {google.protobuf.FieldMask} request.updateMask - * Required. The update mask applies to the resource. See {@link google.protobuf.FieldMask|google.protobuf.FieldMask}. + * Required. The update mask applies to the resource. See + * {@link google.protobuf.FieldMask|google.protobuf.FieldMask}. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -1932,21 +1953,24 @@ export class EndpointServiceClient { * `projects/{project}/locations/{location}/endpoints/{endpoint}` * @param {google.cloud.aiplatform.v1.DeployedModel} request.deployedModel * Required. The DeployedModel to be created within the Endpoint. Note that - * {@link google.cloud.aiplatform.v1.Endpoint.traffic_split|Endpoint.traffic_split} must be updated for the DeployedModel to start - * receiving traffic, either as part of this call, or via + * {@link google.cloud.aiplatform.v1.Endpoint.traffic_split|Endpoint.traffic_split} + * must be updated for the DeployedModel to start receiving traffic, either as + * part of this call, or via * {@link google.cloud.aiplatform.v1.EndpointService.UpdateEndpoint|EndpointService.UpdateEndpoint}. * @param {number[]} request.trafficSplit * A map from a DeployedModel's ID to the percentage of this Endpoint's * traffic that should be forwarded to that DeployedModel. * * If this field is non-empty, then the Endpoint's - * {@link google.cloud.aiplatform.v1.Endpoint.traffic_split|traffic_split} will be overwritten with it. - * To refer to the ID of the just being deployed Model, a "0" should be used, - * and the actual ID of the new DeployedModel will be filled in its place by - * this method. The traffic percentage values must add up to 100. + * {@link google.cloud.aiplatform.v1.Endpoint.traffic_split|traffic_split} will be + * overwritten with it. To refer to the ID of the just being deployed Model, a + * "0" should be used, and the actual ID of the new DeployedModel will be + * filled in its place by this method. The traffic percentage values must add + * up to 100. * * If this field is empty, then the Endpoint's - * {@link google.cloud.aiplatform.v1.Endpoint.traffic_split|traffic_split} is not updated. + * {@link google.cloud.aiplatform.v1.Endpoint.traffic_split|traffic_split} is not + * updated. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -2092,12 +2116,12 @@ export class EndpointServiceClient { * Required. The ID of the DeployedModel to be undeployed from the Endpoint. * @param {number[]} request.trafficSplit * If this field is provided, then the Endpoint's - * {@link google.cloud.aiplatform.v1.Endpoint.traffic_split|traffic_split} will be overwritten with it. If - * last DeployedModel is being undeployed from the Endpoint, the - * [Endpoint.traffic_split] will always end up empty when this call returns. - * A DeployedModel will be successfully undeployed only if it doesn't have - * any traffic assigned to it when this method executes, or if this field - * unassigns any traffic to it. + * {@link google.cloud.aiplatform.v1.Endpoint.traffic_split|traffic_split} will be + * overwritten with it. If last DeployedModel is being undeployed from the + * Endpoint, the [Endpoint.traffic_split] will always end up empty when this + * call returns. A DeployedModel will be successfully undeployed only if it + * doesn't have any traffic assigned to it when this method executes, or if + * this field unassigns any traffic to it. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -2235,14 +2259,15 @@ export class EndpointServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the Location from which to list the Endpoints. - * Format: `projects/{project}/locations/{location}` + * Required. The resource name of the Location from which to list the + * Endpoints. Format: `projects/{project}/locations/{location}` * @param {string} [request.filter] - * Optional. An expression for filtering the results of the request. For field names - * both snake_case and camelCase are supported. + * Optional. An expression for filtering the results of the request. For field + * names both snake_case and camelCase are supported. * * * `endpoint` supports = and !=. `endpoint` represents the Endpoint ID, - * i.e. the last segment of the Endpoint's {@link google.cloud.aiplatform.v1.Endpoint.name|resource name}. + * i.e. the last segment of the Endpoint's [resource + * name][google.cloud.aiplatform.v1.Endpoint.name]. * * `display_name` supports = and, != * * `labels` supports general map functions that is: * * `labels.key=value` - key:value equality @@ -2258,8 +2283,10 @@ export class EndpointServiceClient { * @param {string} [request.pageToken] * Optional. The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListEndpointsResponse.next_page_token|ListEndpointsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1.EndpointService.ListEndpoints|EndpointService.ListEndpoints} call. + * {@link google.cloud.aiplatform.v1.ListEndpointsResponse.next_page_token|ListEndpointsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1.EndpointService.ListEndpoints|EndpointService.ListEndpoints} + * call. * @param {google.protobuf.FieldMask} [request.readMask] * Optional. Mask specifying which fields to read. * @param {string} request.orderBy @@ -2364,14 +2391,15 @@ export class EndpointServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the Location from which to list the Endpoints. - * Format: `projects/{project}/locations/{location}` + * Required. The resource name of the Location from which to list the + * Endpoints. Format: `projects/{project}/locations/{location}` * @param {string} [request.filter] - * Optional. An expression for filtering the results of the request. For field names - * both snake_case and camelCase are supported. + * Optional. An expression for filtering the results of the request. For field + * names both snake_case and camelCase are supported. * * * `endpoint` supports = and !=. `endpoint` represents the Endpoint ID, - * i.e. the last segment of the Endpoint's {@link google.cloud.aiplatform.v1.Endpoint.name|resource name}. + * i.e. the last segment of the Endpoint's [resource + * name][google.cloud.aiplatform.v1.Endpoint.name]. * * `display_name` supports = and, != * * `labels` supports general map functions that is: * * `labels.key=value` - key:value equality @@ -2387,8 +2415,10 @@ export class EndpointServiceClient { * @param {string} [request.pageToken] * Optional. The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListEndpointsResponse.next_page_token|ListEndpointsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1.EndpointService.ListEndpoints|EndpointService.ListEndpoints} call. + * {@link google.cloud.aiplatform.v1.ListEndpointsResponse.next_page_token|ListEndpointsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1.EndpointService.ListEndpoints|EndpointService.ListEndpoints} + * call. * @param {google.protobuf.FieldMask} [request.readMask] * Optional. Mask specifying which fields to read. * @param {string} request.orderBy @@ -2441,14 +2471,15 @@ export class EndpointServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the Location from which to list the Endpoints. - * Format: `projects/{project}/locations/{location}` + * Required. The resource name of the Location from which to list the + * Endpoints. Format: `projects/{project}/locations/{location}` * @param {string} [request.filter] - * Optional. An expression for filtering the results of the request. For field names - * both snake_case and camelCase are supported. + * Optional. An expression for filtering the results of the request. For field + * names both snake_case and camelCase are supported. * * * `endpoint` supports = and !=. `endpoint` represents the Endpoint ID, - * i.e. the last segment of the Endpoint's {@link google.cloud.aiplatform.v1.Endpoint.name|resource name}. + * i.e. the last segment of the Endpoint's [resource + * name][google.cloud.aiplatform.v1.Endpoint.name]. * * `display_name` supports = and, != * * `labels` supports general map functions that is: * * `labels.key=value` - key:value equality @@ -2464,8 +2495,10 @@ export class EndpointServiceClient { * @param {string} [request.pageToken] * Optional. The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListEndpointsResponse.next_page_token|ListEndpointsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1.EndpointService.ListEndpoints|EndpointService.ListEndpoints} call. + * {@link google.cloud.aiplatform.v1.ListEndpointsResponse.next_page_token|ListEndpointsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1.EndpointService.ListEndpoints|EndpointService.ListEndpoints} + * call. * @param {google.protobuf.FieldMask} [request.readMask] * Optional. Mask specifying which fields to read. * @param {string} request.orderBy diff --git a/packages/google-cloud-aiplatform/src/v1/featurestore_online_serving_service_client.ts b/packages/google-cloud-aiplatform/src/v1/featurestore_online_serving_service_client.ts index 708819156ae..1aafccd6e4f 100644 --- a/packages/google-cloud-aiplatform/src/v1/featurestore_online_serving_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1/featurestore_online_serving_service_client.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -350,6 +350,7 @@ export class FeaturestoreOnlineServingServiceClient { const featurestoreOnlineServingServiceStubMethods = [ 'readFeatureValues', 'streamingReadFeatureValues', + 'writeFeatureValues', ]; for (const methodName of featurestoreOnlineServingServiceStubMethods) { const callPromise = this.featurestoreOnlineServingServiceStub.then( @@ -548,6 +549,109 @@ export class FeaturestoreOnlineServingServiceClient { this.initialize(); return this.innerApiCalls.readFeatureValues(request, options, callback); } + /** + * Writes Feature values of one or more entities of an EntityType. + * + * The Feature values are merged into existing entities if any. The Feature + * values to be written must have timestamp within the online storage + * retention. + * + * @param {Object} request + * The request object that will be sent. + * @param {string} request.entityType + * Required. The resource name of the EntityType for the entities being + * written. Value format: + * `projects/{project}/locations/{location}/featurestores/ + * {featurestore}/entityTypes/{entityType}`. For example, + * for a machine learning model predicting user clicks on a website, an + * EntityType ID could be `user`. + * @param {number[]} request.payloads + * Required. The entities to be written. Up to 100,000 feature values can be + * written across all `payloads`. + * @param {object} [options] + * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. + * @returns {Promise} - The promise which resolves to an array. + * The first element of the array is an object representing [WriteFeatureValuesResponse]{@link google.cloud.aiplatform.v1.WriteFeatureValuesResponse}. + * Please see the + * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * for more details and examples. + * @example include:samples/generated/v1/featurestore_online_serving_service.write_feature_values.js + * region_tag:aiplatform_v1_generated_FeaturestoreOnlineServingService_WriteFeatureValues_async + */ + writeFeatureValues( + request?: protos.google.cloud.aiplatform.v1.IWriteFeatureValuesRequest, + options?: CallOptions + ): Promise< + [ + protos.google.cloud.aiplatform.v1.IWriteFeatureValuesResponse, + protos.google.cloud.aiplatform.v1.IWriteFeatureValuesRequest | undefined, + {} | undefined + ] + >; + writeFeatureValues( + request: protos.google.cloud.aiplatform.v1.IWriteFeatureValuesRequest, + options: CallOptions, + callback: Callback< + protos.google.cloud.aiplatform.v1.IWriteFeatureValuesResponse, + | protos.google.cloud.aiplatform.v1.IWriteFeatureValuesRequest + | null + | undefined, + {} | null | undefined + > + ): void; + writeFeatureValues( + request: protos.google.cloud.aiplatform.v1.IWriteFeatureValuesRequest, + callback: Callback< + protos.google.cloud.aiplatform.v1.IWriteFeatureValuesResponse, + | protos.google.cloud.aiplatform.v1.IWriteFeatureValuesRequest + | null + | undefined, + {} | null | undefined + > + ): void; + writeFeatureValues( + request?: protos.google.cloud.aiplatform.v1.IWriteFeatureValuesRequest, + optionsOrCallback?: + | CallOptions + | Callback< + protos.google.cloud.aiplatform.v1.IWriteFeatureValuesResponse, + | protos.google.cloud.aiplatform.v1.IWriteFeatureValuesRequest + | null + | undefined, + {} | null | undefined + >, + callback?: Callback< + protos.google.cloud.aiplatform.v1.IWriteFeatureValuesResponse, + | protos.google.cloud.aiplatform.v1.IWriteFeatureValuesRequest + | null + | undefined, + {} | null | undefined + > + ): Promise< + [ + protos.google.cloud.aiplatform.v1.IWriteFeatureValuesResponse, + protos.google.cloud.aiplatform.v1.IWriteFeatureValuesRequest | undefined, + {} | undefined + ] + > | void { + request = request || {}; + let options: CallOptions; + if (typeof optionsOrCallback === 'function' && callback === undefined) { + callback = optionsOrCallback; + options = {}; + } else { + options = optionsOrCallback as CallOptions; + } + options = options || {}; + options.otherArgs = options.otherArgs || {}; + options.otherArgs.headers = options.otherArgs.headers || {}; + options.otherArgs.headers['x-goog-request-params'] = + this._gaxModule.routingHeader.fromParams({ + entity_type: request.entityType ?? '', + }); + this.initialize(); + return this.innerApiCalls.writeFeatureValues(request, options, callback); + } /** * Reads Feature values for multiple entities. Depending on their size, data @@ -564,12 +668,12 @@ export class FeaturestoreOnlineServingServiceClient { * for a machine learning model predicting user clicks on a website, an * EntityType ID could be `user`. * @param {string[]} request.entityIds - * Required. IDs of entities to read Feature values of. The maximum number of IDs is - * 100. For example, for a machine learning model predicting user clicks on a - * website, an entity ID could be `user_123`. + * Required. IDs of entities to read Feature values of. The maximum number of + * IDs is 100. For example, for a machine learning model predicting user + * clicks on a website, an entity ID could be `user_123`. * @param {google.cloud.aiplatform.v1.FeatureSelector} request.featureSelector - * Required. Selector choosing Features of the target EntityType. Feature IDs will be - * deduplicated. + * Required. Selector choosing Features of the target EntityType. Feature IDs + * will be deduplicated. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} diff --git a/packages/google-cloud-aiplatform/src/v1/featurestore_online_serving_service_client_config.json b/packages/google-cloud-aiplatform/src/v1/featurestore_online_serving_service_client_config.json index c60b62927ce..ca3c186f53d 100644 --- a/packages/google-cloud-aiplatform/src/v1/featurestore_online_serving_service_client_config.json +++ b/packages/google-cloud-aiplatform/src/v1/featurestore_online_serving_service_client_config.json @@ -27,6 +27,10 @@ "StreamingReadFeatureValues": { "retry_codes_name": "non_idempotent", "retry_params_name": "default" + }, + "WriteFeatureValues": { + "retry_codes_name": "non_idempotent", + "retry_params_name": "default" } } } diff --git a/packages/google-cloud-aiplatform/src/v1/featurestore_service_client.ts b/packages/google-cloud-aiplatform/src/v1/featurestore_service_client.ts index 27a467172d0..c81949c74f1 100644 --- a/packages/google-cloud-aiplatform/src/v1/featurestore_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1/featurestore_service_client.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -347,8 +347,14 @@ export class FeaturestoreServiceClient { }, { selector: 'google.iam.v1.IAMPolicy.GetIamPolicy', - post: '/ui/{resource=projects/*/locations/*/featurestores/*}:getIamPolicy', + post: '/v1/{resource=projects/*/locations/*/featurestores/*}:getIamPolicy', additional_bindings: [ + { + post: '/v1/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:getIamPolicy', + }, + { + post: '/ui/{resource=projects/*/locations/*/featurestores/*}:getIamPolicy', + }, { post: '/ui/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:getIamPolicy', }, @@ -356,9 +362,17 @@ export class FeaturestoreServiceClient { }, { selector: 'google.iam.v1.IAMPolicy.SetIamPolicy', - post: '/ui/{resource=projects/*/locations/*/featurestores/*}:setIamPolicy', + post: '/v1/{resource=projects/*/locations/*/featurestores/*}:setIamPolicy', body: '*', additional_bindings: [ + { + post: '/v1/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:setIamPolicy', + body: '*', + }, + { + post: '/ui/{resource=projects/*/locations/*/featurestores/*}:setIamPolicy', + body: '*', + }, { post: '/ui/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:setIamPolicy', body: '*', @@ -367,8 +381,14 @@ export class FeaturestoreServiceClient { }, { selector: 'google.iam.v1.IAMPolicy.TestIamPermissions', - post: '/ui/{resource=projects/*/locations/*/featurestores/*}:testIamPermissions', + post: '/v1/{resource=projects/*/locations/*/featurestores/*}:testIamPermissions', additional_bindings: [ + { + post: '/v1/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:testIamPermissions', + }, + { + post: '/ui/{resource=projects/*/locations/*/featurestores/*}:testIamPermissions', + }, { post: '/ui/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:testIamPermissions', }, @@ -1752,9 +1772,8 @@ export class FeaturestoreServiceClient { * @param {Object} request * The request object that will be sent. * @param {google.cloud.aiplatform.v1.EntityType} request.entityType - * Required. The EntityType's `name` field is used to identify the EntityType to be - * updated. - * Format: + * Required. The EntityType's `name` field is used to identify the EntityType + * to be updated. Format: * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` * @param {google.protobuf.FieldMask} request.updateMask * Field mask is used to specify the fields to be overwritten in the @@ -1776,6 +1795,7 @@ export class FeaturestoreServiceClient { * * `monitoring_config.import_features_analysis.anomaly_detection_baseline` * * `monitoring_config.numerical_threshold_config.value` * * `monitoring_config.categorical_threshold_config.value` + * * `offline_storage_ttl_days` (available in Preview) * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -2068,8 +2088,8 @@ export class FeaturestoreServiceClient { * @param {google.cloud.aiplatform.v1.Featurestore} request.featurestore * Required. The Featurestore to create. * @param {string} request.featurestoreId - * Required. The ID to use for this Featurestore, which will become the final component - * of the Featurestore's resource name. + * Required. The ID to use for this Featurestore, which will become the final + * component of the Featurestore's resource name. * * This value may be up to 60 characters, and valid characters are * `[a-z0-9_]`. The first character cannot be a number. @@ -2212,9 +2232,8 @@ export class FeaturestoreServiceClient { * @param {Object} request * The request object that will be sent. * @param {google.cloud.aiplatform.v1.Featurestore} request.featurestore - * Required. The Featurestore's `name` field is used to identify the Featurestore to be - * updated. - * Format: + * Required. The Featurestore's `name` field is used to identify the + * Featurestore to be updated. Format: * `projects/{project}/locations/{location}/featurestores/{featurestore}` * @param {google.protobuf.FieldMask} request.updateMask * Field mask is used to specify the fields to be overwritten in the @@ -2230,6 +2249,7 @@ export class FeaturestoreServiceClient { * * `labels` * * `online_serving_config.fixed_node_count` * * `online_serving_config.scaling` + * * `online_storage_ttl_days` (available in Preview) * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -2518,8 +2538,8 @@ export class FeaturestoreServiceClient { * @param {google.cloud.aiplatform.v1.EntityType} request.entityType * The EntityType to create. * @param {string} request.entityTypeId - * Required. The ID to use for the EntityType, which will become the final component of - * the EntityType's resource name. + * Required. The ID to use for the EntityType, which will become the final + * component of the EntityType's resource name. * * This value may be up to 60 characters, and valid characters are * `[a-z0-9_]`. The first character cannot be a number. @@ -2812,10 +2832,10 @@ export class FeaturestoreServiceClient { * @param {google.cloud.aiplatform.v1.Feature} request.feature * Required. The Feature to create. * @param {string} request.featureId - * Required. The ID to use for the Feature, which will become the final component of - * the Feature's resource name. + * Required. The ID to use for the Feature, which will become the final + * component of the Feature's resource name. * - * This value may be up to 60 characters, and valid characters are + * This value may be up to 128 characters, and valid characters are * `[a-z0-9_]`. The first character cannot be a number. * * The value must be unique within an EntityType. @@ -2956,14 +2976,15 @@ export class FeaturestoreServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the EntityType to create the batch of Features under. - * Format: + * Required. The resource name of the EntityType to create the batch of + * Features under. Format: * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` * @param {number[]} request.requests - * Required. The request message specifying the Features to create. All Features must be - * created under the same parent EntityType. The `parent` field in each child - * request message can be omitted. If `parent` is set in a child request, then - * the value must match the `parent` value in this request message. + * Required. The request message specifying the Features to create. All + * Features must be created under the same parent EntityType. The `parent` + * field in each child request message can be omitted. If `parent` is set in a + * child request, then the value must match the `parent` value in this request + * message. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -3269,16 +3290,16 @@ export class FeaturestoreServiceClient { * Single Feature timestamp for all entities being imported. The * timestamp must not have higher than millisecond precision. * @param {string} request.entityType - * Required. The resource name of the EntityType grouping the Features for which values - * are being imported. Format: + * Required. The resource name of the EntityType grouping the Features for + * which values are being imported. Format: * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}` * @param {string} request.entityIdField * Source column that holds entity IDs. If not provided, entity IDs are * extracted from the column named `entity_id`. * @param {number[]} request.featureSpecs - * Required. Specifications defining which Feature values to import from the entity. The - * request fails if no feature_specs are provided, and having multiple - * feature_specs for one Feature is not allowed. + * Required. Specifications defining which Feature values to import from the + * entity. The request fails if no feature_specs are provided, and having + * multiple feature_specs for one Feature is not allowed. * @param {boolean} request.disableOnlineServing * If set, data will not be imported for online serving. This * is typically used for backfilling, where Feature generation timestamps are @@ -3461,8 +3482,8 @@ export class FeaturestoreServiceClient { * @param {google.cloud.aiplatform.v1.BigQuerySource} request.bigqueryReadInstances * Similar to csv_read_instances, but from BigQuery source. * @param {string} request.featurestore - * Required. The resource name of the Featurestore from which to query Feature values. - * Format: + * Required. The resource name of the Featurestore from which to query Feature + * values. Format: * `projects/{project}/locations/{location}/featurestores/{featurestore}` * @param {google.cloud.aiplatform.v1.FeatureValueDestination} request.destination * Required. Specifies output location and format. @@ -3475,11 +3496,15 @@ export class FeaturestoreServiceClient { * automatically inferred. For CSV source, the pass-through values will be * passed as opaque bytes. * @param {number[]} request.entityTypeSpecs - * Required. Specifies EntityType grouping Features to read values of and settings. - * Each EntityType referenced in + * Required. Specifies EntityType grouping Features to read values of and + * settings. Each EntityType referenced in * [BatchReadFeatureValuesRequest.entity_type_specs] must have a column * specifying entity IDs in the EntityType in * {@link |BatchReadFeatureValuesRequest.request} . + * @param {google.protobuf.Timestamp} [request.startTime] + * Optional. Excludes Feature values with feature generation timestamp before + * this timestamp. If not set, retrieve oldest values kept in Feature Store. + * Timestamp, if present, must not have higher than millisecond precision. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -3627,8 +3652,8 @@ export class FeaturestoreServiceClient { * Exports all historical values of all entities of the EntityType within a * time range * @param {string} request.entityType - * Required. The resource name of the EntityType from which to export Feature values. - * Format: + * Required. The resource name of the EntityType from which to export Feature + * values. Format: * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` * @param {google.cloud.aiplatform.v1.FeatureValueDestination} request.destination * Required. Specifies destination location and format. @@ -3803,12 +3828,12 @@ export class FeaturestoreServiceClient { * coerced to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} + * must match the call that provided the page token. * @param {string} request.orderBy * A comma-separated list of fields to order by, sorted in ascending order. * Use "desc" after a field name for descending. @@ -3942,12 +3967,12 @@ export class FeaturestoreServiceClient { * coerced to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} + * must match the call that provided the page token. * @param {string} request.orderBy * A comma-separated list of fields to order by, sorted in ascending order. * Use "desc" after a field name for descending. @@ -4029,12 +4054,12 @@ export class FeaturestoreServiceClient { * coerced to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} + * must match the call that provided the page token. * @param {string} request.orderBy * A comma-separated list of fields to order by, sorted in ascending order. * Use "desc" after a field name for descending. @@ -4114,12 +4139,12 @@ export class FeaturestoreServiceClient { * 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} + * must match the call that provided the page token. * @param {string} request.orderBy * A comma-separated list of fields to order by, sorted in ascending order. * Use "desc" after a field name for descending. @@ -4253,12 +4278,12 @@ export class FeaturestoreServiceClient { * 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} + * must match the call that provided the page token. * @param {string} request.orderBy * A comma-separated list of fields to order by, sorted in ascending order. * Use "desc" after a field name for descending. @@ -4340,12 +4365,12 @@ export class FeaturestoreServiceClient { * 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} + * must match the call that provided the page token. * @param {string} request.orderBy * A comma-separated list of fields to order by, sorted in ascending order. * Use "desc" after a field name for descending. @@ -4428,12 +4453,12 @@ export class FeaturestoreServiceClient { * 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} + * must match the call that provided the page token. * @param {string} request.orderBy * A comma-separated list of fields to order by, sorted in ascending order. * Use "desc" after a field name for descending. @@ -4446,10 +4471,12 @@ export class FeaturestoreServiceClient { * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {number} request.latestStatsCount - * If set, return the most recent {@link google.cloud.aiplatform.v1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count} + * If set, return the most recent + * {@link google.cloud.aiplatform.v1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count} * of stats for each Feature in response. Valid value is [0, 10]. If number of - * stats exists < {@link google.cloud.aiplatform.v1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count}, return all - * existing stats. + * stats exists < + * {@link google.cloud.aiplatform.v1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count}, + * return all existing stats. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -4574,12 +4601,12 @@ export class FeaturestoreServiceClient { * 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} + * must match the call that provided the page token. * @param {string} request.orderBy * A comma-separated list of fields to order by, sorted in ascending order. * Use "desc" after a field name for descending. @@ -4592,10 +4619,12 @@ export class FeaturestoreServiceClient { * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {number} request.latestStatsCount - * If set, return the most recent {@link google.cloud.aiplatform.v1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count} + * If set, return the most recent + * {@link google.cloud.aiplatform.v1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count} * of stats for each Feature in response. Valid value is [0, 10]. If number of - * stats exists < {@link google.cloud.aiplatform.v1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count}, return all - * existing stats. + * stats exists < + * {@link google.cloud.aiplatform.v1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count}, + * return all existing stats. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} @@ -4668,12 +4697,12 @@ export class FeaturestoreServiceClient { * 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} + * must match the call that provided the page token. * @param {string} request.orderBy * A comma-separated list of fields to order by, sorted in ascending order. * Use "desc" after a field name for descending. @@ -4686,10 +4715,12 @@ export class FeaturestoreServiceClient { * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {number} request.latestStatsCount - * If set, return the most recent {@link google.cloud.aiplatform.v1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count} + * If set, return the most recent + * {@link google.cloud.aiplatform.v1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count} * of stats for each Feature in response. Valid value is [0, 10]. If number of - * stats exists < {@link google.cloud.aiplatform.v1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count}, return all - * existing stats. + * stats exists < + * {@link google.cloud.aiplatform.v1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count}, + * return all existing stats. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} @@ -4800,12 +4831,12 @@ export class FeaturestoreServiceClient { * 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures}, except `page_size`, must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures}, + * except `page_size`, must match the call that provided the page token. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -4969,12 +5000,12 @@ export class FeaturestoreServiceClient { * 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures}, except `page_size`, must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures}, + * except `page_size`, must match the call that provided the page token. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} @@ -5086,12 +5117,12 @@ export class FeaturestoreServiceClient { * 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures}, except `page_size`, must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures}, + * except `page_size`, must match the call that provided the page token. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} diff --git a/packages/google-cloud-aiplatform/src/v1/gapic_metadata.json b/packages/google-cloud-aiplatform/src/v1/gapic_metadata.json index 02521d36d28..6797724fbe1 100644 --- a/packages/google-cloud-aiplatform/src/v1/gapic_metadata.json +++ b/packages/google-cloud-aiplatform/src/v1/gapic_metadata.json @@ -59,6 +59,13 @@ "listDataItemsAsync" ] }, + "SearchDataItems": { + "methods": [ + "searchDataItems", + "searchDataItemsStream", + "searchDataItemsAsync" + ] + }, "ListSavedQueries": { "methods": [ "listSavedQueries", @@ -127,6 +134,13 @@ "listDataItemsAsync" ] }, + "SearchDataItems": { + "methods": [ + "searchDataItems", + "searchDataItemsStream", + "searchDataItemsAsync" + ] + }, "ListSavedQueries": { "methods": [ "listSavedQueries", @@ -243,6 +257,11 @@ "readFeatureValues" ] }, + "WriteFeatureValues": { + "methods": [ + "writeFeatureValues" + ] + }, "StreamingReadFeatureValues": { "methods": [ "streamingReadFeatureValues" @@ -257,6 +276,11 @@ "methods": [ "readFeatureValues" ] + }, + "WriteFeatureValues": { + "methods": [ + "writeFeatureValues" + ] } } } @@ -1812,6 +1836,11 @@ "getTensorboard" ] }, + "ReadTensorboardUsage": { + "methods": [ + "readTensorboardUsage" + ] + }, "CreateTensorboardExperiment": { "methods": [ "createTensorboardExperiment" @@ -1967,6 +1996,11 @@ "getTensorboard" ] }, + "ReadTensorboardUsage": { + "methods": [ + "readTensorboardUsage" + ] + }, "CreateTensorboardExperiment": { "methods": [ "createTensorboardExperiment" diff --git a/packages/google-cloud-aiplatform/src/v1/index.ts b/packages/google-cloud-aiplatform/src/v1/index.ts index e88d60a96d4..46e5062e243 100644 --- a/packages/google-cloud-aiplatform/src/v1/index.ts +++ b/packages/google-cloud-aiplatform/src/v1/index.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/packages/google-cloud-aiplatform/src/v1/index_endpoint_service_client.ts b/packages/google-cloud-aiplatform/src/v1/index_endpoint_service_client.ts index 5121cabe640..bf60beb7684 100644 --- a/packages/google-cloud-aiplatform/src/v1/index_endpoint_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1/index_endpoint_service_client.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -329,8 +329,14 @@ export class IndexEndpointServiceClient { }, { selector: 'google.iam.v1.IAMPolicy.GetIamPolicy', - post: '/ui/{resource=projects/*/locations/*/featurestores/*}:getIamPolicy', + post: '/v1/{resource=projects/*/locations/*/featurestores/*}:getIamPolicy', additional_bindings: [ + { + post: '/v1/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:getIamPolicy', + }, + { + post: '/ui/{resource=projects/*/locations/*/featurestores/*}:getIamPolicy', + }, { post: '/ui/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:getIamPolicy', }, @@ -338,9 +344,17 @@ export class IndexEndpointServiceClient { }, { selector: 'google.iam.v1.IAMPolicy.SetIamPolicy', - post: '/ui/{resource=projects/*/locations/*/featurestores/*}:setIamPolicy', + post: '/v1/{resource=projects/*/locations/*/featurestores/*}:setIamPolicy', body: '*', additional_bindings: [ + { + post: '/v1/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:setIamPolicy', + body: '*', + }, + { + post: '/ui/{resource=projects/*/locations/*/featurestores/*}:setIamPolicy', + body: '*', + }, { post: '/ui/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:setIamPolicy', body: '*', @@ -349,8 +363,14 @@ export class IndexEndpointServiceClient { }, { selector: 'google.iam.v1.IAMPolicy.TestIamPermissions', - post: '/ui/{resource=projects/*/locations/*/featurestores/*}:testIamPermissions', + post: '/v1/{resource=projects/*/locations/*/featurestores/*}:testIamPermissions', additional_bindings: [ + { + post: '/v1/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:testIamPermissions', + }, + { + post: '/ui/{resource=projects/*/locations/*/featurestores/*}:testIamPermissions', + }, { post: '/ui/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:testIamPermissions', }, @@ -1563,7 +1583,8 @@ export class IndexEndpointServiceClient { * @param {google.cloud.aiplatform.v1.IndexEndpoint} request.indexEndpoint * Required. The IndexEndpoint which replaces the resource on the server. * @param {google.protobuf.FieldMask} request.updateMask - * Required. The update mask applies to the resource. See {@link google.protobuf.FieldMask|google.protobuf.FieldMask}. + * Required. The update mask applies to the resource. See + * {@link google.protobuf.FieldMask|google.protobuf.FieldMask}. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -1938,8 +1959,8 @@ export class IndexEndpointServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.indexEndpoint - * Required. The name of the IndexEndpoint resource into which to deploy an Index. - * Format: + * Required. The name of the IndexEndpoint resource into which to deploy an + * Index. Format: * `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}` * @param {google.cloud.aiplatform.v1.DeployedIndex} request.deployedIndex * Required. The DeployedIndex to be created within the IndexEndpoint. @@ -2081,11 +2102,12 @@ export class IndexEndpointServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.indexEndpoint - * Required. The name of the IndexEndpoint resource from which to undeploy an Index. - * Format: + * Required. The name of the IndexEndpoint resource from which to undeploy an + * Index. Format: * `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}` * @param {string} request.deployedIndexId - * Required. The ID of the DeployedIndex to be undeployed from the IndexEndpoint. + * Required. The ID of the DeployedIndex to be undeployed from the + * IndexEndpoint. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -2223,8 +2245,8 @@ export class IndexEndpointServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.indexEndpoint - * Required. The name of the IndexEndpoint resource into which to deploy an Index. - * Format: + * Required. The name of the IndexEndpoint resource into which to deploy an + * Index. Format: * `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}` * @param {google.cloud.aiplatform.v1.DeployedIndex} request.deployedIndex * Required. The DeployedIndex to be updated within the IndexEndpoint. @@ -2367,11 +2389,11 @@ export class IndexEndpointServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the Location from which to list the IndexEndpoints. - * Format: `projects/{project}/locations/{location}` + * Required. The resource name of the Location from which to list the + * IndexEndpoints. Format: `projects/{project}/locations/{location}` * @param {string} [request.filter] - * Optional. An expression for filtering the results of the request. For field names - * both snake_case and camelCase are supported. + * Optional. An expression for filtering the results of the request. For field + * names both snake_case and camelCase are supported. * * * `index_endpoint` supports = and !=. `index_endpoint` represents the * IndexEndpoint ID, ie. the last segment of the IndexEndpoint's @@ -2393,8 +2415,10 @@ export class IndexEndpointServiceClient { * @param {string} [request.pageToken] * Optional. The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListIndexEndpointsResponse.next_page_token|ListIndexEndpointsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints|IndexEndpointService.ListIndexEndpoints} call. + * {@link google.cloud.aiplatform.v1.ListIndexEndpointsResponse.next_page_token|ListIndexEndpointsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints|IndexEndpointService.ListIndexEndpoints} + * call. * @param {google.protobuf.FieldMask} [request.readMask] * Optional. Mask specifying which fields to read. * @param {object} [options] @@ -2490,11 +2514,11 @@ export class IndexEndpointServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the Location from which to list the IndexEndpoints. - * Format: `projects/{project}/locations/{location}` + * Required. The resource name of the Location from which to list the + * IndexEndpoints. Format: `projects/{project}/locations/{location}` * @param {string} [request.filter] - * Optional. An expression for filtering the results of the request. For field names - * both snake_case and camelCase are supported. + * Optional. An expression for filtering the results of the request. For field + * names both snake_case and camelCase are supported. * * * `index_endpoint` supports = and !=. `index_endpoint` represents the * IndexEndpoint ID, ie. the last segment of the IndexEndpoint's @@ -2516,8 +2540,10 @@ export class IndexEndpointServiceClient { * @param {string} [request.pageToken] * Optional. The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListIndexEndpointsResponse.next_page_token|ListIndexEndpointsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints|IndexEndpointService.ListIndexEndpoints} call. + * {@link google.cloud.aiplatform.v1.ListIndexEndpointsResponse.next_page_token|ListIndexEndpointsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints|IndexEndpointService.ListIndexEndpoints} + * call. * @param {google.protobuf.FieldMask} [request.readMask] * Optional. Mask specifying which fields to read. * @param {object} [options] @@ -2561,11 +2587,11 @@ export class IndexEndpointServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the Location from which to list the IndexEndpoints. - * Format: `projects/{project}/locations/{location}` + * Required. The resource name of the Location from which to list the + * IndexEndpoints. Format: `projects/{project}/locations/{location}` * @param {string} [request.filter] - * Optional. An expression for filtering the results of the request. For field names - * both snake_case and camelCase are supported. + * Optional. An expression for filtering the results of the request. For field + * names both snake_case and camelCase are supported. * * * `index_endpoint` supports = and !=. `index_endpoint` represents the * IndexEndpoint ID, ie. the last segment of the IndexEndpoint's @@ -2587,8 +2613,10 @@ export class IndexEndpointServiceClient { * @param {string} [request.pageToken] * Optional. The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListIndexEndpointsResponse.next_page_token|ListIndexEndpointsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints|IndexEndpointService.ListIndexEndpoints} call. + * {@link google.cloud.aiplatform.v1.ListIndexEndpointsResponse.next_page_token|ListIndexEndpointsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints|IndexEndpointService.ListIndexEndpoints} + * call. * @param {google.protobuf.FieldMask} [request.readMask] * Optional. Mask specifying which fields to read. * @param {object} [options] diff --git a/packages/google-cloud-aiplatform/src/v1/index_service_client.ts b/packages/google-cloud-aiplatform/src/v1/index_service_client.ts index bb947da36dc..e3f05248335 100644 --- a/packages/google-cloud-aiplatform/src/v1/index_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1/index_service_client.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -329,8 +329,14 @@ export class IndexServiceClient { }, { selector: 'google.iam.v1.IAMPolicy.GetIamPolicy', - post: '/ui/{resource=projects/*/locations/*/featurestores/*}:getIamPolicy', + post: '/v1/{resource=projects/*/locations/*/featurestores/*}:getIamPolicy', additional_bindings: [ + { + post: '/v1/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:getIamPolicy', + }, + { + post: '/ui/{resource=projects/*/locations/*/featurestores/*}:getIamPolicy', + }, { post: '/ui/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:getIamPolicy', }, @@ -338,9 +344,17 @@ export class IndexServiceClient { }, { selector: 'google.iam.v1.IAMPolicy.SetIamPolicy', - post: '/ui/{resource=projects/*/locations/*/featurestores/*}:setIamPolicy', + post: '/v1/{resource=projects/*/locations/*/featurestores/*}:setIamPolicy', body: '*', additional_bindings: [ + { + post: '/v1/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:setIamPolicy', + body: '*', + }, + { + post: '/ui/{resource=projects/*/locations/*/featurestores/*}:setIamPolicy', + body: '*', + }, { post: '/ui/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:setIamPolicy', body: '*', @@ -349,8 +363,14 @@ export class IndexServiceClient { }, { selector: 'google.iam.v1.IAMPolicy.TestIamPermissions', - post: '/ui/{resource=projects/*/locations/*/featurestores/*}:testIamPermissions', + post: '/v1/{resource=projects/*/locations/*/featurestores/*}:testIamPermissions', additional_bindings: [ + { + post: '/v1/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:testIamPermissions', + }, + { + post: '/ui/{resource=projects/*/locations/*/featurestores/*}:testIamPermissions', + }, { post: '/ui/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:testIamPermissions', }, @@ -1865,7 +1885,8 @@ export class IndexServiceClient { * Required. The Index which updates the resource on the server. * @param {google.protobuf.FieldMask} request.updateMask * The update mask applies to the resource. - * For the `FieldMask` definition, see {@link google.protobuf.FieldMask|google.protobuf.FieldMask}. + * For the `FieldMask` definition, see + * {@link google.protobuf.FieldMask|google.protobuf.FieldMask}. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -2000,7 +2021,8 @@ export class IndexServiceClient { /** * Deletes an Index. * An Index can only be deleted when all its - * {@link google.cloud.aiplatform.v1.Index.deployed_indexes|DeployedIndexes} had been undeployed. + * {@link google.cloud.aiplatform.v1.Index.deployed_indexes|DeployedIndexes} had + * been undeployed. * * @param {Object} request * The request object that will be sent. @@ -2154,8 +2176,10 @@ export class IndexServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListIndexesResponse.next_page_token|ListIndexesResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1.IndexService.ListIndexes|IndexService.ListIndexes} call. + * {@link google.cloud.aiplatform.v1.ListIndexesResponse.next_page_token|ListIndexesResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1.IndexService.ListIndexes|IndexService.ListIndexes} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] @@ -2254,8 +2278,10 @@ export class IndexServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListIndexesResponse.next_page_token|ListIndexesResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1.IndexService.ListIndexes|IndexService.ListIndexes} call. + * {@link google.cloud.aiplatform.v1.ListIndexesResponse.next_page_token|ListIndexesResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1.IndexService.ListIndexes|IndexService.ListIndexes} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] @@ -2308,8 +2334,10 @@ export class IndexServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListIndexesResponse.next_page_token|ListIndexesResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1.IndexService.ListIndexes|IndexService.ListIndexes} call. + * {@link google.cloud.aiplatform.v1.ListIndexesResponse.next_page_token|ListIndexesResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1.IndexService.ListIndexes|IndexService.ListIndexes} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] diff --git a/packages/google-cloud-aiplatform/src/v1/job_service_client.ts b/packages/google-cloud-aiplatform/src/v1/job_service_client.ts index 9e926589b9f..99dc8ba806c 100644 --- a/packages/google-cloud-aiplatform/src/v1/job_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1/job_service_client.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -355,8 +355,14 @@ export class JobServiceClient { }, { selector: 'google.iam.v1.IAMPolicy.GetIamPolicy', - post: '/ui/{resource=projects/*/locations/*/featurestores/*}:getIamPolicy', + post: '/v1/{resource=projects/*/locations/*/featurestores/*}:getIamPolicy', additional_bindings: [ + { + post: '/v1/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:getIamPolicy', + }, + { + post: '/ui/{resource=projects/*/locations/*/featurestores/*}:getIamPolicy', + }, { post: '/ui/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:getIamPolicy', }, @@ -364,9 +370,17 @@ export class JobServiceClient { }, { selector: 'google.iam.v1.IAMPolicy.SetIamPolicy', - post: '/ui/{resource=projects/*/locations/*/featurestores/*}:setIamPolicy', + post: '/v1/{resource=projects/*/locations/*/featurestores/*}:setIamPolicy', body: '*', additional_bindings: [ + { + post: '/v1/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:setIamPolicy', + body: '*', + }, + { + post: '/ui/{resource=projects/*/locations/*/featurestores/*}:setIamPolicy', + body: '*', + }, { post: '/ui/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:setIamPolicy', body: '*', @@ -375,8 +389,14 @@ export class JobServiceClient { }, { selector: 'google.iam.v1.IAMPolicy.TestIamPermissions', - post: '/ui/{resource=projects/*/locations/*/featurestores/*}:testIamPermissions', + post: '/v1/{resource=projects/*/locations/*/featurestores/*}:testIamPermissions', additional_bindings: [ + { + post: '/v1/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:testIamPermissions', + }, + { + post: '/ui/{resource=projects/*/locations/*/featurestores/*}:testIamPermissions', + }, { post: '/ui/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:testIamPermissions', }, @@ -1725,12 +1745,15 @@ export class JobServiceClient { * 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 {@link google.cloud.aiplatform.v1.JobService.GetCustomJob|JobService.GetCustomJob} or - * other methods to check whether the cancellation succeeded or whether the + * guaranteed. Clients can use + * {@link google.cloud.aiplatform.v1.JobService.GetCustomJob|JobService.GetCustomJob} + * or other methods to check whether the cancellation succeeded or whether the * job completed despite cancellation. On successful cancellation, * the CustomJob is not deleted; instead it becomes a job with - * a {@link google.cloud.aiplatform.v1.CustomJob.error|CustomJob.error} value with a {@link google.rpc.Status.code|google.rpc.Status.code} of 1, - * corresponding to `Code.CANCELLED`, and {@link google.cloud.aiplatform.v1.CustomJob.state|CustomJob.state} is set to + * a {@link google.cloud.aiplatform.v1.CustomJob.error|CustomJob.error} value with + * a {@link google.rpc.Status.code|google.rpc.Status.code} of 1, corresponding to + * `Code.CANCELLED`, and + * {@link google.cloud.aiplatform.v1.CustomJob.state|CustomJob.state} is set to * `CANCELLED`. * * @param {Object} request @@ -2121,8 +2144,9 @@ export class JobServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the Location to create the HyperparameterTuningJob in. - * Format: `projects/{project}/locations/{location}` + * Required. The resource name of the Location to create the + * HyperparameterTuningJob in. Format: + * `projects/{project}/locations/{location}` * @param {google.cloud.aiplatform.v1.HyperparameterTuningJob} request.hyperparameterTuningJob * Required. The HyperparameterTuningJob to create. * @param {object} [options] @@ -2326,13 +2350,17 @@ export class JobServiceClient { * 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 {@link google.cloud.aiplatform.v1.JobService.GetHyperparameterTuningJob|JobService.GetHyperparameterTuningJob} or - * other methods to check whether the cancellation succeeded or whether the + * guaranteed. Clients can use + * {@link google.cloud.aiplatform.v1.JobService.GetHyperparameterTuningJob|JobService.GetHyperparameterTuningJob} + * or other methods to check whether the cancellation succeeded or whether the * job completed despite cancellation. On successful cancellation, * the HyperparameterTuningJob is not deleted; instead it becomes a job with - * a {@link google.cloud.aiplatform.v1.HyperparameterTuningJob.error|HyperparameterTuningJob.error} value with a {@link google.rpc.Status.code|google.rpc.Status.code} - * of 1, corresponding to `Code.CANCELLED`, and - * {@link google.cloud.aiplatform.v1.HyperparameterTuningJob.state|HyperparameterTuningJob.state} is set to `CANCELLED`. + * a + * {@link google.cloud.aiplatform.v1.HyperparameterTuningJob.error|HyperparameterTuningJob.error} + * value with a {@link google.rpc.Status.code|google.rpc.Status.code} of 1, + * corresponding to `Code.CANCELLED`, and + * {@link google.cloud.aiplatform.v1.HyperparameterTuningJob.state|HyperparameterTuningJob.state} + * is set to `CANCELLED`. * * @param {Object} request * The request object that will be sent. @@ -2441,8 +2469,8 @@ export class JobServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the Location to create the BatchPredictionJob in. - * Format: `projects/{project}/locations/{location}` + * Required. The resource name of the Location to create the + * BatchPredictionJob in. Format: `projects/{project}/locations/{location}` * @param {google.cloud.aiplatform.v1.BatchPredictionJob} request.batchPredictionJob * Required. The BatchPredictionJob to create. * @param {object} [options] @@ -2643,12 +2671,14 @@ export class JobServiceClient { * * Starts asynchronous cancellation on the BatchPredictionJob. The server * makes the best effort to cancel the job, but success is not - * guaranteed. Clients can use {@link google.cloud.aiplatform.v1.JobService.GetBatchPredictionJob|JobService.GetBatchPredictionJob} or - * other methods to check whether the cancellation succeeded or whether the + * guaranteed. Clients can use + * {@link google.cloud.aiplatform.v1.JobService.GetBatchPredictionJob|JobService.GetBatchPredictionJob} + * or other methods to check whether the cancellation succeeded or whether the * job completed despite cancellation. On a successful cancellation, * the BatchPredictionJob is not deleted;instead its - * {@link google.cloud.aiplatform.v1.BatchPredictionJob.state|BatchPredictionJob.state} is set to `CANCELLED`. Any files already - * outputted by the job are not deleted. + * {@link google.cloud.aiplatform.v1.BatchPredictionJob.state|BatchPredictionJob.state} + * is set to `CANCELLED`. Any files already outputted by the job are not + * deleted. * * @param {Object} request * The request object that will be sent. @@ -2961,7 +2991,8 @@ export class JobServiceClient { /** * Pauses a ModelDeploymentMonitoringJob. If the job is running, the server * makes a best effort to cancel the job. Will mark - * {@link google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob.state|ModelDeploymentMonitoringJob.state} to 'PAUSED'. + * {@link google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob.state|ModelDeploymentMonitoringJob.state} + * to 'PAUSED'. * * @param {Object} request * The request object that will be sent. @@ -3744,17 +3775,16 @@ export class JobServiceClient { * @param {Object} request * The request object that will be sent. * @param {google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob} request.modelDeploymentMonitoringJob - * Required. The model monitoring configuration which replaces the resource on the - * server. + * Required. The model monitoring configuration which replaces the resource on + * the server. * @param {google.protobuf.FieldMask} request.updateMask - * Required. The update mask is used to specify the fields to be overwritten in the - * ModelDeploymentMonitoringJob resource by the update. - * The fields specified in the update_mask are relative to the resource, not - * the full request. A field will be overwritten if it is in the mask. If the - * user does not provide a mask then only the non-empty fields present in the - * request will be overwritten. Set the update_mask to `*` to override all - * fields. - * For the objective config, the user can either provide the update mask for + * Required. The update mask is used to specify the fields to be overwritten + * in the ModelDeploymentMonitoringJob resource by the update. The fields + * specified in the update_mask are relative to the resource, not the full + * request. A field will be overwritten if it is in the mask. If the user does + * not provide a mask then only the non-empty fields present in the request + * will be overwritten. Set the update_mask to `*` to override all fields. For + * the objective config, the user can either provide the update mask for * model_deployment_monitoring_objective_configs or any combination of its * nested fields, such as: * model_deployment_monitoring_objective_configs.objective_config.training_dataset. @@ -4088,8 +4118,10 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListCustomJobsResponse.next_page_token|ListCustomJobsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1.JobService.ListCustomJobs|JobService.ListCustomJobs} call. + * {@link google.cloud.aiplatform.v1.ListCustomJobsResponse.next_page_token|ListCustomJobsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1.JobService.ListCustomJobs|JobService.ListCustomJobs} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] @@ -4213,8 +4245,10 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListCustomJobsResponse.next_page_token|ListCustomJobsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1.JobService.ListCustomJobs|JobService.ListCustomJobs} call. + * {@link google.cloud.aiplatform.v1.ListCustomJobsResponse.next_page_token|ListCustomJobsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1.JobService.ListCustomJobs|JobService.ListCustomJobs} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] @@ -4286,8 +4320,10 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListCustomJobsResponse.next_page_token|ListCustomJobsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1.JobService.ListCustomJobs|JobService.ListCustomJobs} call. + * {@link google.cloud.aiplatform.v1.ListCustomJobsResponse.next_page_token|ListCustomJobsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1.JobService.ListCustomJobs|JobService.ListCustomJobs} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] @@ -4612,8 +4648,9 @@ export class JobServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the Location to list the HyperparameterTuningJobs - * from. Format: `projects/{project}/locations/{location}` + * Required. The resource name of the Location to list the + * HyperparameterTuningJobs from. Format: + * `projects/{project}/locations/{location}` * @param {string} request.filter * The standard list filter. * @@ -4640,8 +4677,10 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListHyperparameterTuningJobsResponse.next_page_token|ListHyperparameterTuningJobsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs|JobService.ListHyperparameterTuningJobs} call. + * {@link google.cloud.aiplatform.v1.ListHyperparameterTuningJobsResponse.next_page_token|ListHyperparameterTuningJobsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs|JobService.ListHyperparameterTuningJobs} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] @@ -4741,8 +4780,9 @@ export class JobServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the Location to list the HyperparameterTuningJobs - * from. Format: `projects/{project}/locations/{location}` + * Required. The resource name of the Location to list the + * HyperparameterTuningJobs from. Format: + * `projects/{project}/locations/{location}` * @param {string} request.filter * The standard list filter. * @@ -4769,8 +4809,10 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListHyperparameterTuningJobsResponse.next_page_token|ListHyperparameterTuningJobsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs|JobService.ListHyperparameterTuningJobs} call. + * {@link google.cloud.aiplatform.v1.ListHyperparameterTuningJobsResponse.next_page_token|ListHyperparameterTuningJobsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs|JobService.ListHyperparameterTuningJobs} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] @@ -4814,8 +4856,9 @@ export class JobServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the Location to list the HyperparameterTuningJobs - * from. Format: `projects/{project}/locations/{location}` + * Required. The resource name of the Location to list the + * HyperparameterTuningJobs from. Format: + * `projects/{project}/locations/{location}` * @param {string} request.filter * The standard list filter. * @@ -4842,8 +4885,10 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListHyperparameterTuningJobsResponse.next_page_token|ListHyperparameterTuningJobsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs|JobService.ListHyperparameterTuningJobs} call. + * {@link google.cloud.aiplatform.v1.ListHyperparameterTuningJobsResponse.next_page_token|ListHyperparameterTuningJobsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs|JobService.ListHyperparameterTuningJobs} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] @@ -4915,8 +4960,10 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListBatchPredictionJobsResponse.next_page_token|ListBatchPredictionJobsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1.JobService.ListBatchPredictionJobs|JobService.ListBatchPredictionJobs} call. + * {@link google.cloud.aiplatform.v1.ListBatchPredictionJobsResponse.next_page_token|ListBatchPredictionJobsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1.JobService.ListBatchPredictionJobs|JobService.ListBatchPredictionJobs} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] @@ -5045,8 +5092,10 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListBatchPredictionJobsResponse.next_page_token|ListBatchPredictionJobsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1.JobService.ListBatchPredictionJobs|JobService.ListBatchPredictionJobs} call. + * {@link google.cloud.aiplatform.v1.ListBatchPredictionJobsResponse.next_page_token|ListBatchPredictionJobsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1.JobService.ListBatchPredictionJobs|JobService.ListBatchPredictionJobs} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] @@ -5119,8 +5168,10 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListBatchPredictionJobsResponse.next_page_token|ListBatchPredictionJobsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1.JobService.ListBatchPredictionJobs|JobService.ListBatchPredictionJobs} call. + * {@link google.cloud.aiplatform.v1.ListBatchPredictionJobsResponse.next_page_token|ListBatchPredictionJobsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1.JobService.ListBatchPredictionJobs|JobService.ListBatchPredictionJobs} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] diff --git a/packages/google-cloud-aiplatform/src/v1/metadata_service_client.ts b/packages/google-cloud-aiplatform/src/v1/metadata_service_client.ts index ae73eb3b1a9..7835902f5c7 100644 --- a/packages/google-cloud-aiplatform/src/v1/metadata_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1/metadata_service_client.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -352,8 +352,14 @@ export class MetadataServiceClient { }, { selector: 'google.iam.v1.IAMPolicy.GetIamPolicy', - post: '/ui/{resource=projects/*/locations/*/featurestores/*}:getIamPolicy', + post: '/v1/{resource=projects/*/locations/*/featurestores/*}:getIamPolicy', additional_bindings: [ + { + post: '/v1/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:getIamPolicy', + }, + { + post: '/ui/{resource=projects/*/locations/*/featurestores/*}:getIamPolicy', + }, { post: '/ui/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:getIamPolicy', }, @@ -361,9 +367,17 @@ export class MetadataServiceClient { }, { selector: 'google.iam.v1.IAMPolicy.SetIamPolicy', - post: '/ui/{resource=projects/*/locations/*/featurestores/*}:setIamPolicy', + post: '/v1/{resource=projects/*/locations/*/featurestores/*}:setIamPolicy', body: '*', additional_bindings: [ + { + post: '/v1/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:setIamPolicy', + body: '*', + }, + { + post: '/ui/{resource=projects/*/locations/*/featurestores/*}:setIamPolicy', + body: '*', + }, { post: '/ui/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:setIamPolicy', body: '*', @@ -372,8 +386,14 @@ export class MetadataServiceClient { }, { selector: 'google.iam.v1.IAMPolicy.TestIamPermissions', - post: '/ui/{resource=projects/*/locations/*/featurestores/*}:testIamPermissions', + post: '/v1/{resource=projects/*/locations/*/featurestores/*}:testIamPermissions', additional_bindings: [ + { + post: '/v1/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:testIamPermissions', + }, + { + post: '/ui/{resource=projects/*/locations/*/featurestores/*}:testIamPermissions', + }, { post: '/ui/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:testIamPermissions', }, @@ -1833,15 +1853,15 @@ export class MetadataServiceClient { * The request object that will be sent. * @param {google.cloud.aiplatform.v1.Artifact} request.artifact * Required. The Artifact containing updates. - * The Artifact's {@link google.cloud.aiplatform.v1.Artifact.name|Artifact.name} field is used to identify the Artifact to - * be updated. - * Format: + * The Artifact's {@link google.cloud.aiplatform.v1.Artifact.name|Artifact.name} + * field is used to identify the Artifact to be updated. Format: * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` * @param {google.protobuf.FieldMask} [request.updateMask] * Optional. A FieldMask indicating which fields should be updated. * Functionality of this field is not yet supported. * @param {boolean} request.allowMissing - * If set to true, and the {@link google.cloud.aiplatform.v1.Artifact|Artifact} is not found, a new {@link google.cloud.aiplatform.v1.Artifact|Artifact} is + * If set to true, and the {@link google.cloud.aiplatform.v1.Artifact|Artifact} is + * not found, a new {@link google.cloud.aiplatform.v1.Artifact|Artifact} is * created. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. @@ -1933,9 +1953,8 @@ export class MetadataServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the MetadataStore where the Context should be - * created. - * Format: + * Required. The resource name of the MetadataStore where the Context should + * be created. Format: * `projects/{project}/locations/{location}/metadataStores/{metadatastore}` * @param {google.cloud.aiplatform.v1.Context} request.context * Required. The Context to create. @@ -2125,16 +2144,15 @@ export class MetadataServiceClient { * The request object that will be sent. * @param {google.cloud.aiplatform.v1.Context} request.context * Required. The Context containing updates. - * The Context's {@link google.cloud.aiplatform.v1.Context.name|Context.name} field is used to identify the Context to be - * updated. - * Format: + * The Context's {@link google.cloud.aiplatform.v1.Context.name|Context.name} field + * is used to identify the Context to be updated. Format: * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}` * @param {google.protobuf.FieldMask} [request.updateMask] * Optional. A FieldMask indicating which fields should be updated. * Functionality of this field is not yet supported. * @param {boolean} request.allowMissing - * If set to true, and the {@link google.cloud.aiplatform.v1.Context|Context} is not found, a new {@link google.cloud.aiplatform.v1.Context|Context} is - * created. + * If set to true, and the {@link google.cloud.aiplatform.v1.Context|Context} is + * not found, a new {@link google.cloud.aiplatform.v1.Context|Context} is created. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -2227,9 +2245,8 @@ export class MetadataServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.context - * Required. The resource name of the Context that the Artifacts and Executions - * belong to. - * Format: + * Required. The resource name of the Context that the Artifacts and + * Executions belong to. Format: * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}` * @param {string[]} request.artifacts * The resource names of the Artifacts to attribute to the Context. @@ -2848,16 +2865,16 @@ export class MetadataServiceClient { * The request object that will be sent. * @param {google.cloud.aiplatform.v1.Execution} request.execution * Required. The Execution containing updates. - * The Execution's {@link google.cloud.aiplatform.v1.Execution.name|Execution.name} field is used to identify the Execution - * to be updated. - * Format: + * The Execution's {@link google.cloud.aiplatform.v1.Execution.name|Execution.name} + * field is used to identify the Execution to be updated. Format: * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` * @param {google.protobuf.FieldMask} [request.updateMask] * Optional. A FieldMask indicating which fields should be updated. * Functionality of this field is not yet supported. * @param {boolean} request.allowMissing - * If set to true, and the {@link google.cloud.aiplatform.v1.Execution|Execution} is not found, a new {@link google.cloud.aiplatform.v1.Execution|Execution} - * is created. + * If set to true, and the {@link google.cloud.aiplatform.v1.Execution|Execution} + * is not found, a new {@link google.cloud.aiplatform.v1.Execution|Execution} is + * created. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -3049,9 +3066,8 @@ export class MetadataServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.execution - * Required. The resource name of the Execution whose input and output Artifacts should - * be retrieved as a LineageSubgraph. - * Format: + * Required. The resource name of the Execution whose input and output + * Artifacts should be retrieved as a LineageSubgraph. Format: * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. @@ -3153,9 +3169,8 @@ export class MetadataServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the MetadataStore where the MetadataSchema should - * be created. - * Format: + * Required. The resource name of the MetadataStore where the MetadataSchema + * should be created. Format: * `projects/{project}/locations/{location}/metadataStores/{metadatastore}` * @param {google.cloud.aiplatform.v1.MetadataSchema} request.metadataSchema * Required. The MetadataSchema to create. @@ -3358,9 +3373,8 @@ export class MetadataServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.artifact - * Required. The resource name of the Artifact whose Lineage needs to be retrieved as a - * LineageSubgraph. - * Format: + * Required. The resource name of the Artifact whose Lineage needs to be + * retrieved as a LineageSubgraph. Format: * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` * * The request may error with FAILED_PRECONDITION if the number of Artifacts, @@ -3391,7 +3405,8 @@ export class MetadataServiceClient { * For example: `metadata.field_1.number_value = 10.0` * * Each of the above supported filter types can be combined together using - * logical operators (`AND` & `OR`). + * logical operators (`AND` & `OR`). Maximum nested expression depth allowed + * is 5. * * For example: `display_name = "test" AND metadata.field1.bool_value = true`. * @param {object} [options] @@ -4674,8 +4689,8 @@ export class MetadataServiceClient { * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.MetadataService.ListMetadataStores|MetadataService.ListMetadataStores} call. Provide this to retrieve the - * subsequent page. + * {@link google.cloud.aiplatform.v1.MetadataService.ListMetadataStores|MetadataService.ListMetadataStores} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that * provided the page token. (Otherwise the request will fail with @@ -4782,8 +4797,8 @@ export class MetadataServiceClient { * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.MetadataService.ListMetadataStores|MetadataService.ListMetadataStores} call. Provide this to retrieve the - * subsequent page. + * {@link google.cloud.aiplatform.v1.MetadataService.ListMetadataStores|MetadataService.ListMetadataStores} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that * provided the page token. (Otherwise the request will fail with @@ -4838,8 +4853,8 @@ export class MetadataServiceClient { * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.MetadataService.ListMetadataStores|MetadataService.ListMetadataStores} call. Provide this to retrieve the - * subsequent page. + * {@link google.cloud.aiplatform.v1.MetadataService.ListMetadataStores|MetadataService.ListMetadataStores} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that * provided the page token. (Otherwise the request will fail with @@ -4891,7 +4906,8 @@ export class MetadataServiceClient { * The maximum number of Artifacts to return. The service may return fewer. * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken - * A page token, received from a previous {@link google.cloud.aiplatform.v1.MetadataService.ListArtifacts|MetadataService.ListArtifacts} + * A page token, received from a previous + * {@link google.cloud.aiplatform.v1.MetadataService.ListArtifacts|MetadataService.ListArtifacts} * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that @@ -4922,7 +4938,8 @@ export class MetadataServiceClient { * `in_context("projects//locations//metadataStores//contexts/")` * * Each of the above supported filter types can be combined together using - * logical operators (`AND` & `OR`). + * logical operators (`AND` & `OR`). Maximum nested expression depth allowed + * is 5. * * For example: `display_name = "test" AND metadata.field1.bool_value = true`. * @param {string} request.orderBy @@ -5032,7 +5049,8 @@ export class MetadataServiceClient { * The maximum number of Artifacts to return. The service may return fewer. * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken - * A page token, received from a previous {@link google.cloud.aiplatform.v1.MetadataService.ListArtifacts|MetadataService.ListArtifacts} + * A page token, received from a previous + * {@link google.cloud.aiplatform.v1.MetadataService.ListArtifacts|MetadataService.ListArtifacts} * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that @@ -5063,7 +5081,8 @@ export class MetadataServiceClient { * `in_context("projects//locations//metadataStores//contexts/")` * * Each of the above supported filter types can be combined together using - * logical operators (`AND` & `OR`). + * logical operators (`AND` & `OR`). Maximum nested expression depth allowed + * is 5. * * For example: `display_name = "test" AND metadata.field1.bool_value = true`. * @param {string} request.orderBy @@ -5121,7 +5140,8 @@ export class MetadataServiceClient { * The maximum number of Artifacts to return. The service may return fewer. * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken - * A page token, received from a previous {@link google.cloud.aiplatform.v1.MetadataService.ListArtifacts|MetadataService.ListArtifacts} + * A page token, received from a previous + * {@link google.cloud.aiplatform.v1.MetadataService.ListArtifacts|MetadataService.ListArtifacts} * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that @@ -5152,7 +5172,8 @@ export class MetadataServiceClient { * `in_context("projects//locations//metadataStores//contexts/")` * * Each of the above supported filter types can be combined together using - * logical operators (`AND` & `OR`). + * logical operators (`AND` & `OR`). Maximum nested expression depth allowed + * is 5. * * For example: `display_name = "test" AND metadata.field1.bool_value = true`. * @param {string} request.orderBy @@ -5209,7 +5230,8 @@ export class MetadataServiceClient { * The maximum number of Contexts to return. The service may return fewer. * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken - * A page token, received from a previous {@link google.cloud.aiplatform.v1.MetadataService.ListContexts|MetadataService.ListContexts} + * A page token, received from a previous + * {@link google.cloud.aiplatform.v1.MetadataService.ListContexts|MetadataService.ListContexts} * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that @@ -5244,7 +5266,8 @@ export class MetadataServiceClient { * ``` * * Each of the above supported filters can be combined together using - * logical operators (`AND` & `OR`). + * logical operators (`AND` & `OR`). Maximum nested expression depth allowed + * is 5. * * For example: `display_name = "test" AND metadata.field1.bool_value = true`. * @param {string} request.orderBy @@ -5354,7 +5377,8 @@ export class MetadataServiceClient { * The maximum number of Contexts to return. The service may return fewer. * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken - * A page token, received from a previous {@link google.cloud.aiplatform.v1.MetadataService.ListContexts|MetadataService.ListContexts} + * A page token, received from a previous + * {@link google.cloud.aiplatform.v1.MetadataService.ListContexts|MetadataService.ListContexts} * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that @@ -5389,7 +5413,8 @@ export class MetadataServiceClient { * ``` * * Each of the above supported filters can be combined together using - * logical operators (`AND` & `OR`). + * logical operators (`AND` & `OR`). Maximum nested expression depth allowed + * is 5. * * For example: `display_name = "test" AND metadata.field1.bool_value = true`. * @param {string} request.orderBy @@ -5447,7 +5472,8 @@ export class MetadataServiceClient { * The maximum number of Contexts to return. The service may return fewer. * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken - * A page token, received from a previous {@link google.cloud.aiplatform.v1.MetadataService.ListContexts|MetadataService.ListContexts} + * A page token, received from a previous + * {@link google.cloud.aiplatform.v1.MetadataService.ListContexts|MetadataService.ListContexts} * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that @@ -5482,7 +5508,8 @@ export class MetadataServiceClient { * ``` * * Each of the above supported filters can be combined together using - * logical operators (`AND` & `OR`). + * logical operators (`AND` & `OR`). Maximum nested expression depth allowed + * is 5. * * For example: `display_name = "test" AND metadata.field1.bool_value = true`. * @param {string} request.orderBy @@ -5539,7 +5566,8 @@ export class MetadataServiceClient { * The maximum number of Executions to return. The service may return fewer. * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken - * A page token, received from a previous {@link google.cloud.aiplatform.v1.MetadataService.ListExecutions|MetadataService.ListExecutions} + * A page token, received from a previous + * {@link google.cloud.aiplatform.v1.MetadataService.ListExecutions|MetadataService.ListExecutions} * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that @@ -5570,7 +5598,9 @@ export class MetadataServiceClient { * `in_context("projects//locations//metadataStores//contexts/")` * * Each of the above supported filters can be combined together using - * logical operators (`AND` & `OR`). + * logical operators (`AND` & `OR`). Maximum nested expression depth allowed + * is 5. + * * For example: `display_name = "test" AND metadata.field1.bool_value = true`. * @param {string} request.orderBy * How the list of messages is ordered. Specify the values to order by and an @@ -5679,7 +5709,8 @@ export class MetadataServiceClient { * The maximum number of Executions to return. The service may return fewer. * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken - * A page token, received from a previous {@link google.cloud.aiplatform.v1.MetadataService.ListExecutions|MetadataService.ListExecutions} + * A page token, received from a previous + * {@link google.cloud.aiplatform.v1.MetadataService.ListExecutions|MetadataService.ListExecutions} * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that @@ -5710,7 +5741,9 @@ export class MetadataServiceClient { * `in_context("projects//locations//metadataStores//contexts/")` * * Each of the above supported filters can be combined together using - * logical operators (`AND` & `OR`). + * logical operators (`AND` & `OR`). Maximum nested expression depth allowed + * is 5. + * * For example: `display_name = "test" AND metadata.field1.bool_value = true`. * @param {string} request.orderBy * How the list of messages is ordered. Specify the values to order by and an @@ -5767,7 +5800,8 @@ export class MetadataServiceClient { * The maximum number of Executions to return. The service may return fewer. * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken - * A page token, received from a previous {@link google.cloud.aiplatform.v1.MetadataService.ListExecutions|MetadataService.ListExecutions} + * A page token, received from a previous + * {@link google.cloud.aiplatform.v1.MetadataService.ListExecutions|MetadataService.ListExecutions} * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that @@ -5798,7 +5832,9 @@ export class MetadataServiceClient { * `in_context("projects//locations//metadataStores//contexts/")` * * Each of the above supported filters can be combined together using - * logical operators (`AND` & `OR`). + * logical operators (`AND` & `OR`). Maximum nested expression depth allowed + * is 5. + * * For example: `display_name = "test" AND metadata.field1.bool_value = true`. * @param {string} request.orderBy * How the list of messages is ordered. Specify the values to order by and an @@ -5856,8 +5892,8 @@ export class MetadataServiceClient { * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.MetadataService.ListMetadataSchemas|MetadataService.ListMetadataSchemas} call. Provide this to retrieve the - * next page. + * {@link google.cloud.aiplatform.v1.MetadataService.ListMetadataSchemas|MetadataService.ListMetadataSchemas} + * call. Provide this to retrieve the next page. * * When paginating, all other provided parameters must match the call that * provided the page token. (Otherwise the request will fail with @@ -5966,8 +6002,8 @@ export class MetadataServiceClient { * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.MetadataService.ListMetadataSchemas|MetadataService.ListMetadataSchemas} call. Provide this to retrieve the - * next page. + * {@link google.cloud.aiplatform.v1.MetadataService.ListMetadataSchemas|MetadataService.ListMetadataSchemas} + * call. Provide this to retrieve the next page. * * When paginating, all other provided parameters must match the call that * provided the page token. (Otherwise the request will fail with @@ -6024,8 +6060,8 @@ export class MetadataServiceClient { * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.MetadataService.ListMetadataSchemas|MetadataService.ListMetadataSchemas} call. Provide this to retrieve the - * next page. + * {@link google.cloud.aiplatform.v1.MetadataService.ListMetadataSchemas|MetadataService.ListMetadataSchemas} + * call. Provide this to retrieve the next page. * * When paginating, all other provided parameters must match the call that * provided the page token. (Otherwise the request will fail with diff --git a/packages/google-cloud-aiplatform/src/v1/migration_service_client.ts b/packages/google-cloud-aiplatform/src/v1/migration_service_client.ts index bba68cc1432..b37f8f2dbdb 100644 --- a/packages/google-cloud-aiplatform/src/v1/migration_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1/migration_service_client.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -330,8 +330,14 @@ export class MigrationServiceClient { }, { selector: 'google.iam.v1.IAMPolicy.GetIamPolicy', - post: '/ui/{resource=projects/*/locations/*/featurestores/*}:getIamPolicy', + post: '/v1/{resource=projects/*/locations/*/featurestores/*}:getIamPolicy', additional_bindings: [ + { + post: '/v1/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:getIamPolicy', + }, + { + post: '/ui/{resource=projects/*/locations/*/featurestores/*}:getIamPolicy', + }, { post: '/ui/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:getIamPolicy', }, @@ -339,9 +345,17 @@ export class MigrationServiceClient { }, { selector: 'google.iam.v1.IAMPolicy.SetIamPolicy', - post: '/ui/{resource=projects/*/locations/*/featurestores/*}:setIamPolicy', + post: '/v1/{resource=projects/*/locations/*/featurestores/*}:setIamPolicy', body: '*', additional_bindings: [ + { + post: '/v1/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:setIamPolicy', + body: '*', + }, + { + post: '/ui/{resource=projects/*/locations/*/featurestores/*}:setIamPolicy', + body: '*', + }, { post: '/ui/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:setIamPolicy', body: '*', @@ -350,8 +364,14 @@ export class MigrationServiceClient { }, { selector: 'google.iam.v1.IAMPolicy.TestIamPermissions', - post: '/ui/{resource=projects/*/locations/*/featurestores/*}:testIamPermissions', + post: '/v1/{resource=projects/*/locations/*/featurestores/*}:testIamPermissions', additional_bindings: [ + { + post: '/v1/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:testIamPermissions', + }, + { + post: '/ui/{resource=projects/*/locations/*/featurestores/*}:testIamPermissions', + }, { post: '/ui/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:testIamPermissions', }, @@ -1568,10 +1588,9 @@ export class MigrationServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The location that the migratable resources should be searched from. - * It's the Vertex AI location that the resources can be migrated to, not - * the resources' original location. - * Format: + * Required. The location that the migratable resources should be searched + * from. It's the Vertex AI location that the resources can be migrated to, + * not the resources' original location. Format: * `projects/{project}/locations/{location}` * @param {number} request.pageSize * The standard page size. @@ -1688,10 +1707,9 @@ export class MigrationServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The location that the migratable resources should be searched from. - * It's the Vertex AI location that the resources can be migrated to, not - * the resources' original location. - * Format: + * Required. The location that the migratable resources should be searched + * from. It's the Vertex AI location that the resources can be migrated to, + * not the resources' original location. Format: * `projects/{project}/locations/{location}` * @param {number} request.pageSize * The standard page size. @@ -1752,10 +1770,9 @@ export class MigrationServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The location that the migratable resources should be searched from. - * It's the Vertex AI location that the resources can be migrated to, not - * the resources' original location. - * Format: + * Required. The location that the migratable resources should be searched + * from. It's the Vertex AI location that the resources can be migrated to, + * not the resources' original location. Format: * `projects/{project}/locations/{location}` * @param {number} request.pageSize * The standard page size. diff --git a/packages/google-cloud-aiplatform/src/v1/model_service_client.ts b/packages/google-cloud-aiplatform/src/v1/model_service_client.ts index dbe7797d7ec..6dc04c5d9a3 100644 --- a/packages/google-cloud-aiplatform/src/v1/model_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1/model_service_client.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -344,8 +344,14 @@ export class ModelServiceClient { }, { selector: 'google.iam.v1.IAMPolicy.GetIamPolicy', - post: '/ui/{resource=projects/*/locations/*/featurestores/*}:getIamPolicy', + post: '/v1/{resource=projects/*/locations/*/featurestores/*}:getIamPolicy', additional_bindings: [ + { + post: '/v1/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:getIamPolicy', + }, + { + post: '/ui/{resource=projects/*/locations/*/featurestores/*}:getIamPolicy', + }, { post: '/ui/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:getIamPolicy', }, @@ -353,9 +359,17 @@ export class ModelServiceClient { }, { selector: 'google.iam.v1.IAMPolicy.SetIamPolicy', - post: '/ui/{resource=projects/*/locations/*/featurestores/*}:setIamPolicy', + post: '/v1/{resource=projects/*/locations/*/featurestores/*}:setIamPolicy', body: '*', additional_bindings: [ + { + post: '/v1/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:setIamPolicy', + body: '*', + }, + { + post: '/ui/{resource=projects/*/locations/*/featurestores/*}:setIamPolicy', + body: '*', + }, { post: '/ui/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:setIamPolicy', body: '*', @@ -364,8 +378,14 @@ export class ModelServiceClient { }, { selector: 'google.iam.v1.IAMPolicy.TestIamPermissions', - post: '/ui/{resource=projects/*/locations/*/featurestores/*}:testIamPermissions', + post: '/v1/{resource=projects/*/locations/*/featurestores/*}:testIamPermissions', additional_bindings: [ + { + post: '/v1/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:testIamPermissions', + }, + { + post: '/ui/{resource=projects/*/locations/*/featurestores/*}:testIamPermissions', + }, { post: '/ui/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:testIamPermissions', }, @@ -1593,7 +1613,8 @@ export class ModelServiceClient { * must update them separately. * @param {google.protobuf.FieldMask} request.updateMask * Required. The update mask applies to the resource. - * For the `FieldMask` definition, see {@link google.protobuf.FieldMask|google.protobuf.FieldMask}. + * For the `FieldMask` definition, see + * {@link google.protobuf.FieldMask|google.protobuf.FieldMask}. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -2190,8 +2211,8 @@ export class ModelServiceClient { * Required. The resource name of the Location into which to upload the Model. * Format: `projects/{project}/locations/{location}` * @param {string} [request.parentModel] - * Optional. The resource name of the model into which to upload the version. Only - * specify this field when uploading a new version. + * Optional. The resource name of the model into which to upload the version. + * Only specify this field when uploading a new version. * @param {string} [request.modelId] * Optional. The ID to use for the uploaded Model, which will become the final * component of the model resource name. @@ -2200,6 +2221,14 @@ export class ModelServiceClient { * `[a-z0-9_-]`. The first character cannot be a number or hyphen. * @param {google.cloud.aiplatform.v1.Model} request.model * Required. The Model to create. + * @param {string} [request.serviceAccount] + * Optional. The user-provided custom service account to use to do the model + * upload. If empty, [Vertex AI Service + * Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) + * will be used. Users uploading the Model must have the + * `iam.serviceAccounts.actAs` permission on this service account. Also, this + * account must belong to the project specified in the `parent` field and have + * all necessary read permissions. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -2334,9 +2363,12 @@ export class ModelServiceClient { /** * Deletes a Model. * - * A model cannot be deleted if any {@link google.cloud.aiplatform.v1.Endpoint|Endpoint} resource has a - * {@link google.cloud.aiplatform.v1.DeployedModel|DeployedModel} based on the model in its - * {@link google.cloud.aiplatform.v1.Endpoint.deployed_models|deployed_models} field. + * A model cannot be deleted if any + * {@link google.cloud.aiplatform.v1.Endpoint|Endpoint} resource has a + * {@link google.cloud.aiplatform.v1.DeployedModel|DeployedModel} based on the + * model in its + * {@link google.cloud.aiplatform.v1.Endpoint.deployed_models|deployed_models} + * field. * * @param {Object} request * The request object that will be sent. @@ -2479,13 +2511,14 @@ export class ModelServiceClient { * * Model version can only be deleted if there are no {@link |DeployedModels} * created from it. Deleting the only version in the Model is not allowed. Use - * {@link google.cloud.aiplatform.v1.ModelService.DeleteModel|DeleteModel} for deleting the Model instead. + * {@link google.cloud.aiplatform.v1.ModelService.DeleteModel|DeleteModel} for + * deleting the Model instead. * * @param {Object} request * The request object that will be sent. * @param {string} request.name - * Required. The name of the model version to be deleted, with a version ID explicitly - * included. + * Required. The name of the model version to be deleted, with a version ID + * explicitly included. * * Example: `projects/{project}/locations/{location}/models/{model}@1234` * @param {object} [options] @@ -2622,7 +2655,8 @@ export class ModelServiceClient { /** * 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 - * {@link google.cloud.aiplatform.v1.Model.supported_export_formats|supported export format}. + * [supported export + * format][google.cloud.aiplatform.v1.Model.supported_export_formats]. * * @param {Object} request * The request object that will be sent. @@ -2776,7 +2810,8 @@ export class ModelServiceClient { * both snake_case and camelCase are supported. * * * `model` supports = and !=. `model` represents the Model ID, - * i.e. the last segment of the Model's {@link google.cloud.aiplatform.v1.Model.name|resource name}. + * i.e. the last segment of the Model's [resource + * name][google.cloud.aiplatform.v1.Model.name]. * * `display_name` supports = and != * * `labels` supports general map functions that is: * * `labels.key=value` - key:value equality @@ -2793,8 +2828,10 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListModelsResponse.next_page_token|ListModelsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1.ModelService.ListModels|ModelService.ListModels} call. + * {@link google.cloud.aiplatform.v1.ListModelsResponse.next_page_token|ListModelsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1.ModelService.ListModels|ModelService.ListModels} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {string} request.orderBy @@ -2901,7 +2938,8 @@ export class ModelServiceClient { * both snake_case and camelCase are supported. * * * `model` supports = and !=. `model` represents the Model ID, - * i.e. the last segment of the Model's {@link google.cloud.aiplatform.v1.Model.name|resource name}. + * i.e. the last segment of the Model's [resource + * name][google.cloud.aiplatform.v1.Model.name]. * * `display_name` supports = and != * * `labels` supports general map functions that is: * * `labels.key=value` - key:value equality @@ -2918,8 +2956,10 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListModelsResponse.next_page_token|ListModelsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1.ModelService.ListModels|ModelService.ListModels} call. + * {@link google.cloud.aiplatform.v1.ListModelsResponse.next_page_token|ListModelsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1.ModelService.ListModels|ModelService.ListModels} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {string} request.orderBy @@ -2980,7 +3020,8 @@ export class ModelServiceClient { * both snake_case and camelCase are supported. * * * `model` supports = and !=. `model` represents the Model ID, - * i.e. the last segment of the Model's {@link google.cloud.aiplatform.v1.Model.name|resource name}. + * i.e. the last segment of the Model's [resource + * name][google.cloud.aiplatform.v1.Model.name]. * * `display_name` supports = and != * * `labels` supports general map functions that is: * * `labels.key=value` - key:value equality @@ -2997,8 +3038,10 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListModelsResponse.next_page_token|ListModelsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1.ModelService.ListModels|ModelService.ListModels} call. + * {@link google.cloud.aiplatform.v1.ListModelsResponse.next_page_token|ListModelsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1.ModelService.ListModels|ModelService.ListModels} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {string} request.orderBy @@ -3057,8 +3100,8 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListModelVersionsResponse.next_page_token|ListModelVersionsResponse.next_page_token} of the previous - * {@link |ModelService.ListModelversions} call. + * {@link google.cloud.aiplatform.v1.ListModelVersionsResponse.next_page_token|ListModelVersionsResponse.next_page_token} + * of the previous {@link |ModelService.ListModelversions} call. * @param {string} request.filter * An expression for filtering the results of the request. For field names * both snake_case and camelCase are supported. @@ -3073,6 +3116,15 @@ export class ModelServiceClient { * * `labels.myKey="myValue"` * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. + * @param {string} request.orderBy + * A comma-separated list of fields to order by, sorted in ascending order. + * Use "desc" after a field name for descending. + * Supported fields: + * + * * `create_time` + * * `update_time` + * + * Example: `update_time asc, create_time desc`. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -3172,8 +3224,8 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListModelVersionsResponse.next_page_token|ListModelVersionsResponse.next_page_token} of the previous - * {@link |ModelService.ListModelversions} call. + * {@link google.cloud.aiplatform.v1.ListModelVersionsResponse.next_page_token|ListModelVersionsResponse.next_page_token} + * of the previous {@link |ModelService.ListModelversions} call. * @param {string} request.filter * An expression for filtering the results of the request. For field names * both snake_case and camelCase are supported. @@ -3188,6 +3240,15 @@ export class ModelServiceClient { * * `labels.myKey="myValue"` * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. + * @param {string} request.orderBy + * A comma-separated list of fields to order by, sorted in ascending order. + * Use "desc" after a field name for descending. + * Supported fields: + * + * * `create_time` + * * `update_time` + * + * Example: `update_time asc, create_time desc`. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} @@ -3235,8 +3296,8 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListModelVersionsResponse.next_page_token|ListModelVersionsResponse.next_page_token} of the previous - * {@link |ModelService.ListModelversions} call. + * {@link google.cloud.aiplatform.v1.ListModelVersionsResponse.next_page_token|ListModelVersionsResponse.next_page_token} + * of the previous {@link |ModelService.ListModelversions} call. * @param {string} request.filter * An expression for filtering the results of the request. For field names * both snake_case and camelCase are supported. @@ -3251,6 +3312,15 @@ export class ModelServiceClient { * * `labels.myKey="myValue"` * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. + * @param {string} request.orderBy + * A comma-separated list of fields to order by, sorted in ascending order. + * Use "desc" after a field name for descending. + * Supported fields: + * + * * `create_time` + * * `update_time` + * + * Example: `update_time asc, create_time desc`. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} @@ -3300,8 +3370,10 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListModelEvaluationsResponse.next_page_token|ListModelEvaluationsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1.ModelService.ListModelEvaluations|ModelService.ListModelEvaluations} call. + * {@link google.cloud.aiplatform.v1.ListModelEvaluationsResponse.next_page_token|ListModelEvaluationsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1.ModelService.ListModelEvaluations|ModelService.ListModelEvaluations} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] @@ -3406,8 +3478,10 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListModelEvaluationsResponse.next_page_token|ListModelEvaluationsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1.ModelService.ListModelEvaluations|ModelService.ListModelEvaluations} call. + * {@link google.cloud.aiplatform.v1.ListModelEvaluationsResponse.next_page_token|ListModelEvaluationsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1.ModelService.ListModelEvaluations|ModelService.ListModelEvaluations} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] @@ -3460,8 +3534,10 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListModelEvaluationsResponse.next_page_token|ListModelEvaluationsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1.ModelService.ListModelEvaluations|ModelService.ListModelEvaluations} call. + * {@link google.cloud.aiplatform.v1.ListModelEvaluationsResponse.next_page_token|ListModelEvaluationsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1.ModelService.ListModelEvaluations|ModelService.ListModelEvaluations} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] @@ -3504,8 +3580,8 @@ export class ModelServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the ModelEvaluation to list the ModelEvaluationSlices - * from. Format: + * Required. The resource name of the ModelEvaluation to list the + * ModelEvaluationSlices from. Format: * `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}` * @param {string} request.filter * The standard list filter. @@ -3516,8 +3592,10 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListModelEvaluationSlicesResponse.next_page_token|ListModelEvaluationSlicesResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices|ModelService.ListModelEvaluationSlices} call. + * {@link google.cloud.aiplatform.v1.ListModelEvaluationSlicesResponse.next_page_token|ListModelEvaluationSlicesResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices|ModelService.ListModelEvaluationSlices} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] @@ -3617,8 +3695,8 @@ export class ModelServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the ModelEvaluation to list the ModelEvaluationSlices - * from. Format: + * Required. The resource name of the ModelEvaluation to list the + * ModelEvaluationSlices from. Format: * `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}` * @param {string} request.filter * The standard list filter. @@ -3629,8 +3707,10 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListModelEvaluationSlicesResponse.next_page_token|ListModelEvaluationSlicesResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices|ModelService.ListModelEvaluationSlices} call. + * {@link google.cloud.aiplatform.v1.ListModelEvaluationSlicesResponse.next_page_token|ListModelEvaluationSlicesResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices|ModelService.ListModelEvaluationSlices} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] @@ -3674,8 +3754,8 @@ export class ModelServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the ModelEvaluation to list the ModelEvaluationSlices - * from. Format: + * Required. The resource name of the ModelEvaluation to list the + * ModelEvaluationSlices from. Format: * `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}` * @param {string} request.filter * The standard list filter. @@ -3686,8 +3766,10 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListModelEvaluationSlicesResponse.next_page_token|ListModelEvaluationSlicesResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices|ModelService.ListModelEvaluationSlices} call. + * {@link google.cloud.aiplatform.v1.ListModelEvaluationSlicesResponse.next_page_token|ListModelEvaluationSlicesResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices|ModelService.ListModelEvaluationSlices} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] diff --git a/packages/google-cloud-aiplatform/src/v1/pipeline_service_client.ts b/packages/google-cloud-aiplatform/src/v1/pipeline_service_client.ts index 21696d0553b..4ba198c3aab 100644 --- a/packages/google-cloud-aiplatform/src/v1/pipeline_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1/pipeline_service_client.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -336,8 +336,14 @@ export class PipelineServiceClient { }, { selector: 'google.iam.v1.IAMPolicy.GetIamPolicy', - post: '/ui/{resource=projects/*/locations/*/featurestores/*}:getIamPolicy', + post: '/v1/{resource=projects/*/locations/*/featurestores/*}:getIamPolicy', additional_bindings: [ + { + post: '/v1/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:getIamPolicy', + }, + { + post: '/ui/{resource=projects/*/locations/*/featurestores/*}:getIamPolicy', + }, { post: '/ui/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:getIamPolicy', }, @@ -345,9 +351,17 @@ export class PipelineServiceClient { }, { selector: 'google.iam.v1.IAMPolicy.SetIamPolicy', - post: '/ui/{resource=projects/*/locations/*/featurestores/*}:setIamPolicy', + post: '/v1/{resource=projects/*/locations/*/featurestores/*}:setIamPolicy', body: '*', additional_bindings: [ + { + post: '/v1/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:setIamPolicy', + body: '*', + }, + { + post: '/ui/{resource=projects/*/locations/*/featurestores/*}:setIamPolicy', + body: '*', + }, { post: '/ui/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:setIamPolicy', body: '*', @@ -356,8 +370,14 @@ export class PipelineServiceClient { }, { selector: 'google.iam.v1.IAMPolicy.TestIamPermissions', - post: '/ui/{resource=projects/*/locations/*/featurestores/*}:testIamPermissions', + post: '/v1/{resource=projects/*/locations/*/featurestores/*}:testIamPermissions', additional_bindings: [ + { + post: '/v1/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:testIamPermissions', + }, + { + post: '/ui/{resource=projects/*/locations/*/featurestores/*}:testIamPermissions', + }, { post: '/ui/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:testIamPermissions', }, @@ -1449,8 +1469,8 @@ export class PipelineServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the Location to create the TrainingPipeline in. - * Format: `projects/{project}/locations/{location}` + * Required. The resource name of the Location to create the TrainingPipeline + * in. Format: `projects/{project}/locations/{location}` * @param {google.cloud.aiplatform.v1.TrainingPipeline} request.trainingPipeline * Required. The TrainingPipeline to create. * @param {object} [options] @@ -1644,13 +1664,17 @@ export class PipelineServiceClient { * 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 {@link google.cloud.aiplatform.v1.PipelineService.GetTrainingPipeline|PipelineService.GetTrainingPipeline} or - * other methods to check whether the cancellation succeeded or whether the + * guaranteed. Clients can use + * {@link google.cloud.aiplatform.v1.PipelineService.GetTrainingPipeline|PipelineService.GetTrainingPipeline} + * or other methods to check whether the cancellation succeeded or whether the * pipeline completed despite cancellation. On successful cancellation, * the TrainingPipeline is not deleted; instead it becomes a pipeline with - * a {@link google.cloud.aiplatform.v1.TrainingPipeline.error|TrainingPipeline.error} value with a {@link google.rpc.Status.code|google.rpc.Status.code} of 1, - * corresponding to `Code.CANCELLED`, and {@link google.cloud.aiplatform.v1.TrainingPipeline.state|TrainingPipeline.state} is set to - * `CANCELLED`. + * a + * {@link google.cloud.aiplatform.v1.TrainingPipeline.error|TrainingPipeline.error} + * value with a {@link google.rpc.Status.code|google.rpc.Status.code} of 1, + * corresponding to `Code.CANCELLED`, and + * {@link google.cloud.aiplatform.v1.TrainingPipeline.state|TrainingPipeline.state} + * is set to `CANCELLED`. * * @param {Object} request * The request object that will be sent. @@ -1950,12 +1974,15 @@ export class PipelineServiceClient { * 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 {@link google.cloud.aiplatform.v1.PipelineService.GetPipelineJob|PipelineService.GetPipelineJob} or - * other methods to check whether the cancellation succeeded or whether the + * guaranteed. Clients can use + * {@link google.cloud.aiplatform.v1.PipelineService.GetPipelineJob|PipelineService.GetPipelineJob} + * or other methods to check whether the cancellation succeeded or whether the * pipeline completed despite cancellation. On successful cancellation, * the PipelineJob is not deleted; instead it becomes a pipeline with - * a {@link google.cloud.aiplatform.v1.PipelineJob.error|PipelineJob.error} value with a {@link google.rpc.Status.code|google.rpc.Status.code} of 1, - * corresponding to `Code.CANCELLED`, and {@link google.cloud.aiplatform.v1.PipelineJob.state|PipelineJob.state} is set to + * a {@link google.cloud.aiplatform.v1.PipelineJob.error|PipelineJob.error} value + * with a {@link google.rpc.Status.code|google.rpc.Status.code} of 1, corresponding + * to `Code.CANCELLED`, and + * {@link google.cloud.aiplatform.v1.PipelineJob.state|PipelineJob.state} is set to * `CANCELLED`. * * @param {Object} request @@ -2339,8 +2366,8 @@ export class PipelineServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the Location to list the TrainingPipelines from. - * Format: `projects/{project}/locations/{location}` + * Required. The resource name of the Location to list the TrainingPipelines + * from. Format: `projects/{project}/locations/{location}` * @param {string} request.filter * The standard list filter. * @@ -2367,8 +2394,10 @@ export class PipelineServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListTrainingPipelinesResponse.next_page_token|ListTrainingPipelinesResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1.PipelineService.ListTrainingPipelines|PipelineService.ListTrainingPipelines} call. + * {@link google.cloud.aiplatform.v1.ListTrainingPipelinesResponse.next_page_token|ListTrainingPipelinesResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1.PipelineService.ListTrainingPipelines|PipelineService.ListTrainingPipelines} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] @@ -2464,8 +2493,8 @@ export class PipelineServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the Location to list the TrainingPipelines from. - * Format: `projects/{project}/locations/{location}` + * Required. The resource name of the Location to list the TrainingPipelines + * from. Format: `projects/{project}/locations/{location}` * @param {string} request.filter * The standard list filter. * @@ -2492,8 +2521,10 @@ export class PipelineServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListTrainingPipelinesResponse.next_page_token|ListTrainingPipelinesResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1.PipelineService.ListTrainingPipelines|PipelineService.ListTrainingPipelines} call. + * {@link google.cloud.aiplatform.v1.ListTrainingPipelinesResponse.next_page_token|ListTrainingPipelinesResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1.PipelineService.ListTrainingPipelines|PipelineService.ListTrainingPipelines} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] @@ -2537,8 +2568,8 @@ export class PipelineServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the Location to list the TrainingPipelines from. - * Format: `projects/{project}/locations/{location}` + * Required. The resource name of the Location to list the TrainingPipelines + * from. Format: `projects/{project}/locations/{location}` * @param {string} request.filter * The standard list filter. * @@ -2565,8 +2596,10 @@ export class PipelineServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListTrainingPipelinesResponse.next_page_token|ListTrainingPipelinesResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1.PipelineService.ListTrainingPipelines|PipelineService.ListTrainingPipelines} call. + * {@link google.cloud.aiplatform.v1.ListTrainingPipelinesResponse.next_page_token|ListTrainingPipelinesResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1.PipelineService.ListTrainingPipelines|PipelineService.ListTrainingPipelines} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] @@ -2651,8 +2684,10 @@ export class PipelineServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListPipelineJobsResponse.next_page_token|ListPipelineJobsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1.PipelineService.ListPipelineJobs|PipelineService.ListPipelineJobs} call. + * {@link google.cloud.aiplatform.v1.ListPipelineJobsResponse.next_page_token|ListPipelineJobsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1.PipelineService.ListPipelineJobs|PipelineService.ListPipelineJobs} + * call. * @param {string} request.orderBy * A comma-separated list of fields to order by. The default sort order is in * ascending order. Use "desc" after a field name for descending. You can have @@ -2804,8 +2839,10 @@ export class PipelineServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListPipelineJobsResponse.next_page_token|ListPipelineJobsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1.PipelineService.ListPipelineJobs|PipelineService.ListPipelineJobs} call. + * {@link google.cloud.aiplatform.v1.ListPipelineJobsResponse.next_page_token|ListPipelineJobsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1.PipelineService.ListPipelineJobs|PipelineService.ListPipelineJobs} + * call. * @param {string} request.orderBy * A comma-separated list of fields to order by. The default sort order is in * ascending order. Use "desc" after a field name for descending. You can have @@ -2905,8 +2942,10 @@ export class PipelineServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1.ListPipelineJobsResponse.next_page_token|ListPipelineJobsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1.PipelineService.ListPipelineJobs|PipelineService.ListPipelineJobs} call. + * {@link google.cloud.aiplatform.v1.ListPipelineJobsResponse.next_page_token|ListPipelineJobsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1.PipelineService.ListPipelineJobs|PipelineService.ListPipelineJobs} + * call. * @param {string} request.orderBy * A comma-separated list of fields to order by. The default sort order is in * ascending order. Use "desc" after a field name for descending. You can have diff --git a/packages/google-cloud-aiplatform/src/v1/prediction_service_client.ts b/packages/google-cloud-aiplatform/src/v1/prediction_service_client.ts index c6eca98e620..f19f38cc582 100644 --- a/packages/google-cloud-aiplatform/src/v1/prediction_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1/prediction_service_client.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -440,7 +440,8 @@ export class PredictionServiceClient { * {@link google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri|instance_schema_uri}. * @param {google.protobuf.Value} request.parameters * The parameters that govern the prediction. The schema of the parameters may - * be specified via Endpoint's DeployedModels' {@link google.cloud.aiplatform.v1.DeployedModel.model|Model's } + * be specified via Endpoint's DeployedModels' [Model's + * ][google.cloud.aiplatform.v1.DeployedModel.model] * {@link google.cloud.aiplatform.v1.Model.predict_schemata|PredictSchemata's} * {@link google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri|parameters_schema_uri}. * @param {object} [options] @@ -524,11 +525,13 @@ export class PredictionServiceClient { * * The response includes the following HTTP headers: * - * * `X-Vertex-AI-Endpoint-Id`: ID of the {@link google.cloud.aiplatform.v1.Endpoint|Endpoint} that served this + * * `X-Vertex-AI-Endpoint-Id`: ID of the + * {@link google.cloud.aiplatform.v1.Endpoint|Endpoint} that served this * prediction. * - * * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's {@link google.cloud.aiplatform.v1.DeployedModel|DeployedModel} - * that served this prediction. + * * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's + * {@link google.cloud.aiplatform.v1.DeployedModel|DeployedModel} that served this + * prediction. * * @param {Object} request * The request object that will be sent. @@ -539,16 +542,18 @@ export class PredictionServiceClient { * @param {google.api.HttpBody} request.httpBody * The prediction input. Supports HTTP headers and arbitrary data payload. * - * A {@link google.cloud.aiplatform.v1.DeployedModel|DeployedModel} may have an upper limit on the number of instances it - * supports per request. When this limit it is exceeded for an AutoML model, - * the {@link google.cloud.aiplatform.v1.PredictionService.RawPredict|RawPredict} method returns an error. - * When this limit is exceeded for a custom-trained model, the behavior varies - * depending on the model. + * A {@link google.cloud.aiplatform.v1.DeployedModel|DeployedModel} may have an + * upper limit on the number of instances it supports per request. When this + * limit it is exceeded for an AutoML model, the + * {@link google.cloud.aiplatform.v1.PredictionService.RawPredict|RawPredict} + * method returns an error. When this limit is exceeded for a custom-trained + * model, the behavior varies depending on the model. * * You can specify the schema for each instance in the * {@link google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri|predict_schemata.instance_schema_uri} - * field when you create a {@link google.cloud.aiplatform.v1.Model|Model}. This schema applies when you deploy the - * `Model` as a `DeployedModel` to an {@link google.cloud.aiplatform.v1.Endpoint|Endpoint} and use the `RawPredict` + * field when you create a {@link google.cloud.aiplatform.v1.Model|Model}. This + * schema applies when you deploy the `Model` as a `DeployedModel` to an + * {@link google.cloud.aiplatform.v1.Endpoint|Endpoint} and use the `RawPredict` * method. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. @@ -631,10 +636,12 @@ export class PredictionServiceClient { /** * Perform an online explanation. * - * If {@link google.cloud.aiplatform.v1.ExplainRequest.deployed_model_id|deployed_model_id} is specified, - * the corresponding DeployModel must have + * If + * {@link google.cloud.aiplatform.v1.ExplainRequest.deployed_model_id|deployed_model_id} + * is specified, the corresponding DeployModel must have * {@link google.cloud.aiplatform.v1.DeployedModel.explanation_spec|explanation_spec} - * populated. If {@link google.cloud.aiplatform.v1.ExplainRequest.deployed_model_id|deployed_model_id} + * populated. If + * {@link google.cloud.aiplatform.v1.ExplainRequest.deployed_model_id|deployed_model_id} * is not specified, all DeployedModels must have * {@link google.cloud.aiplatform.v1.DeployedModel.explanation_spec|explanation_spec} * populated. Only deployed AutoML tabular Models have @@ -658,21 +665,23 @@ export class PredictionServiceClient { * {@link google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri|instance_schema_uri}. * @param {google.protobuf.Value} request.parameters * The parameters that govern the prediction. The schema of the parameters may - * be specified via Endpoint's DeployedModels' {@link google.cloud.aiplatform.v1.DeployedModel.model|Model's } + * be specified via Endpoint's DeployedModels' [Model's + * ][google.cloud.aiplatform.v1.DeployedModel.model] * {@link google.cloud.aiplatform.v1.Model.predict_schemata|PredictSchemata's} * {@link google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri|parameters_schema_uri}. * @param {google.cloud.aiplatform.v1.ExplanationSpecOverride} request.explanationSpecOverride * If specified, overrides the - * {@link google.cloud.aiplatform.v1.DeployedModel.explanation_spec|explanation_spec} of the DeployedModel. - * Can be used for explaining prediction results with different - * configurations, such as: + * {@link google.cloud.aiplatform.v1.DeployedModel.explanation_spec|explanation_spec} + * of the DeployedModel. Can be used for explaining prediction results with + * different configurations, such as: * - Explaining top-5 predictions results as opposed to top-1; * - Increasing path count or step count of the attribution methods to reduce * approximate errors; * - Using different baselines for explaining the prediction results. * @param {string} request.deployedModelId * If specified, this ExplainRequest will be served by the chosen - * DeployedModel, overriding {@link google.cloud.aiplatform.v1.Endpoint.traffic_split|Endpoint.traffic_split}. + * DeployedModel, overriding + * {@link google.cloud.aiplatform.v1.Endpoint.traffic_split|Endpoint.traffic_split}. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. diff --git a/packages/google-cloud-aiplatform/src/v1/specialist_pool_service_client.ts b/packages/google-cloud-aiplatform/src/v1/specialist_pool_service_client.ts index 66ab05973bf..2a8ffdafdbf 100644 --- a/packages/google-cloud-aiplatform/src/v1/specialist_pool_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1/specialist_pool_service_client.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -335,8 +335,14 @@ export class SpecialistPoolServiceClient { }, { selector: 'google.iam.v1.IAMPolicy.GetIamPolicy', - post: '/ui/{resource=projects/*/locations/*/featurestores/*}:getIamPolicy', + post: '/v1/{resource=projects/*/locations/*/featurestores/*}:getIamPolicy', additional_bindings: [ + { + post: '/v1/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:getIamPolicy', + }, + { + post: '/ui/{resource=projects/*/locations/*/featurestores/*}:getIamPolicy', + }, { post: '/ui/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:getIamPolicy', }, @@ -344,9 +350,17 @@ export class SpecialistPoolServiceClient { }, { selector: 'google.iam.v1.IAMPolicy.SetIamPolicy', - post: '/ui/{resource=projects/*/locations/*/featurestores/*}:setIamPolicy', + post: '/v1/{resource=projects/*/locations/*/featurestores/*}:setIamPolicy', body: '*', additional_bindings: [ + { + post: '/v1/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:setIamPolicy', + body: '*', + }, + { + post: '/ui/{resource=projects/*/locations/*/featurestores/*}:setIamPolicy', + body: '*', + }, { post: '/ui/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:setIamPolicy', body: '*', @@ -355,8 +369,14 @@ export class SpecialistPoolServiceClient { }, { selector: 'google.iam.v1.IAMPolicy.TestIamPermissions', - post: '/ui/{resource=projects/*/locations/*/featurestores/*}:testIamPermissions', + post: '/v1/{resource=projects/*/locations/*/featurestores/*}:testIamPermissions', additional_bindings: [ + { + post: '/v1/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:testIamPermissions', + }, + { + post: '/ui/{resource=projects/*/locations/*/featurestores/*}:testIamPermissions', + }, { post: '/ui/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:testIamPermissions', }, @@ -1974,9 +1994,11 @@ export class SpecialistPoolServiceClient { * The standard list page size. * @param {string} request.pageToken * The standard list page token. - * Typically obtained by {@link google.cloud.aiplatform.v1.ListSpecialistPoolsResponse.next_page_token|ListSpecialistPoolsResponse.next_page_token} of - * the previous {@link google.cloud.aiplatform.v1.SpecialistPoolService.ListSpecialistPools|SpecialistPoolService.ListSpecialistPools} call. Return - * first page if empty. + * Typically obtained by + * {@link google.cloud.aiplatform.v1.ListSpecialistPoolsResponse.next_page_token|ListSpecialistPoolsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1.SpecialistPoolService.ListSpecialistPools|SpecialistPoolService.ListSpecialistPools} + * call. Return first page if empty. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. FieldMask represents a set of * @param {object} [options] @@ -2078,9 +2100,11 @@ export class SpecialistPoolServiceClient { * The standard list page size. * @param {string} request.pageToken * The standard list page token. - * Typically obtained by {@link google.cloud.aiplatform.v1.ListSpecialistPoolsResponse.next_page_token|ListSpecialistPoolsResponse.next_page_token} of - * the previous {@link google.cloud.aiplatform.v1.SpecialistPoolService.ListSpecialistPools|SpecialistPoolService.ListSpecialistPools} call. Return - * first page if empty. + * Typically obtained by + * {@link google.cloud.aiplatform.v1.ListSpecialistPoolsResponse.next_page_token|ListSpecialistPoolsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1.SpecialistPoolService.ListSpecialistPools|SpecialistPoolService.ListSpecialistPools} + * call. Return first page if empty. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. FieldMask represents a set of * @param {object} [options] @@ -2130,9 +2154,11 @@ export class SpecialistPoolServiceClient { * The standard list page size. * @param {string} request.pageToken * The standard list page token. - * Typically obtained by {@link google.cloud.aiplatform.v1.ListSpecialistPoolsResponse.next_page_token|ListSpecialistPoolsResponse.next_page_token} of - * the previous {@link google.cloud.aiplatform.v1.SpecialistPoolService.ListSpecialistPools|SpecialistPoolService.ListSpecialistPools} call. Return - * first page if empty. + * Typically obtained by + * {@link google.cloud.aiplatform.v1.ListSpecialistPoolsResponse.next_page_token|ListSpecialistPoolsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1.SpecialistPoolService.ListSpecialistPools|SpecialistPoolService.ListSpecialistPools} + * call. Return first page if empty. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. FieldMask represents a set of * @param {object} [options] diff --git a/packages/google-cloud-aiplatform/src/v1/tensorboard_service_client.ts b/packages/google-cloud-aiplatform/src/v1/tensorboard_service_client.ts index a96220ba8fb..3dc7d83c7b2 100644 --- a/packages/google-cloud-aiplatform/src/v1/tensorboard_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1/tensorboard_service_client.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -361,8 +361,14 @@ export class TensorboardServiceClient { }, { selector: 'google.iam.v1.IAMPolicy.GetIamPolicy', - post: '/ui/{resource=projects/*/locations/*/featurestores/*}:getIamPolicy', + post: '/v1/{resource=projects/*/locations/*/featurestores/*}:getIamPolicy', additional_bindings: [ + { + post: '/v1/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:getIamPolicy', + }, + { + post: '/ui/{resource=projects/*/locations/*/featurestores/*}:getIamPolicy', + }, { post: '/ui/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:getIamPolicy', }, @@ -370,9 +376,17 @@ export class TensorboardServiceClient { }, { selector: 'google.iam.v1.IAMPolicy.SetIamPolicy', - post: '/ui/{resource=projects/*/locations/*/featurestores/*}:setIamPolicy', + post: '/v1/{resource=projects/*/locations/*/featurestores/*}:setIamPolicy', body: '*', additional_bindings: [ + { + post: '/v1/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:setIamPolicy', + body: '*', + }, + { + post: '/ui/{resource=projects/*/locations/*/featurestores/*}:setIamPolicy', + body: '*', + }, { post: '/ui/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:setIamPolicy', body: '*', @@ -381,8 +395,14 @@ export class TensorboardServiceClient { }, { selector: 'google.iam.v1.IAMPolicy.TestIamPermissions', - post: '/ui/{resource=projects/*/locations/*/featurestores/*}:testIamPermissions', + post: '/v1/{resource=projects/*/locations/*/featurestores/*}:testIamPermissions', additional_bindings: [ + { + post: '/v1/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:testIamPermissions', + }, + { + post: '/ui/{resource=projects/*/locations/*/featurestores/*}:testIamPermissions', + }, { post: '/ui/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:testIamPermissions', }, @@ -1421,6 +1441,7 @@ export class TensorboardServiceClient { const tensorboardServiceStubMethods = [ 'createTensorboard', 'getTensorboard', + 'readTensorboardUsage', 'updateTensorboard', 'listTensorboards', 'deleteTensorboard', @@ -1642,20 +1663,119 @@ export class TensorboardServiceClient { this.initialize(); return this.innerApiCalls.getTensorboard(request, options, callback); } + /** + * Returns a list of monthly active users for a given TensorBoard instance. + * + * @param {Object} request + * The request object that will be sent. + * @param {string} request.tensorboard + * Required. The name of the Tensorboard resource. + * Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}` + * @param {object} [options] + * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. + * @returns {Promise} - The promise which resolves to an array. + * The first element of the array is an object representing [ReadTensorboardUsageResponse]{@link google.cloud.aiplatform.v1.ReadTensorboardUsageResponse}. + * Please see the + * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * for more details and examples. + * @example include:samples/generated/v1/tensorboard_service.read_tensorboard_usage.js + * region_tag:aiplatform_v1_generated_TensorboardService_ReadTensorboardUsage_async + */ + readTensorboardUsage( + request?: protos.google.cloud.aiplatform.v1.IReadTensorboardUsageRequest, + options?: CallOptions + ): Promise< + [ + protos.google.cloud.aiplatform.v1.IReadTensorboardUsageResponse, + ( + | protos.google.cloud.aiplatform.v1.IReadTensorboardUsageRequest + | undefined + ), + {} | undefined + ] + >; + readTensorboardUsage( + request: protos.google.cloud.aiplatform.v1.IReadTensorboardUsageRequest, + options: CallOptions, + callback: Callback< + protos.google.cloud.aiplatform.v1.IReadTensorboardUsageResponse, + | protos.google.cloud.aiplatform.v1.IReadTensorboardUsageRequest + | null + | undefined, + {} | null | undefined + > + ): void; + readTensorboardUsage( + request: protos.google.cloud.aiplatform.v1.IReadTensorboardUsageRequest, + callback: Callback< + protos.google.cloud.aiplatform.v1.IReadTensorboardUsageResponse, + | protos.google.cloud.aiplatform.v1.IReadTensorboardUsageRequest + | null + | undefined, + {} | null | undefined + > + ): void; + readTensorboardUsage( + request?: protos.google.cloud.aiplatform.v1.IReadTensorboardUsageRequest, + optionsOrCallback?: + | CallOptions + | Callback< + protos.google.cloud.aiplatform.v1.IReadTensorboardUsageResponse, + | protos.google.cloud.aiplatform.v1.IReadTensorboardUsageRequest + | null + | undefined, + {} | null | undefined + >, + callback?: Callback< + protos.google.cloud.aiplatform.v1.IReadTensorboardUsageResponse, + | protos.google.cloud.aiplatform.v1.IReadTensorboardUsageRequest + | null + | undefined, + {} | null | undefined + > + ): Promise< + [ + protos.google.cloud.aiplatform.v1.IReadTensorboardUsageResponse, + ( + | protos.google.cloud.aiplatform.v1.IReadTensorboardUsageRequest + | undefined + ), + {} | undefined + ] + > | void { + request = request || {}; + let options: CallOptions; + if (typeof optionsOrCallback === 'function' && callback === undefined) { + callback = optionsOrCallback; + options = {}; + } else { + options = optionsOrCallback as CallOptions; + } + options = options || {}; + options.otherArgs = options.otherArgs || {}; + options.otherArgs.headers = options.otherArgs.headers || {}; + options.otherArgs.headers['x-goog-request-params'] = + this._gaxModule.routingHeader.fromParams({ + tensorboard: request.tensorboard ?? '', + }); + this.initialize(); + return this.innerApiCalls.readTensorboardUsage(request, options, callback); + } /** * Creates a TensorboardExperiment. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the Tensorboard to create the TensorboardExperiment - * in. Format: + * Required. The resource name of the Tensorboard to create the + * TensorboardExperiment in. Format: * `projects/{project}/locations/{location}/tensorboards/{tensorboard}` * @param {google.cloud.aiplatform.v1.TensorboardExperiment} request.tensorboardExperiment * The TensorboardExperiment to create. * @param {string} request.tensorboardExperimentId - * Required. The ID to use for the Tensorboard experiment, which will become the final - * component of the Tensorboard experiment's resource name. + * Required. The ID to use for the Tensorboard experiment, which becomes the + * final component of the Tensorboard experiment's resource name. * * This value should be 1-128 characters, and valid characters * are /{@link 0-9|a-z}-/. @@ -1865,8 +1985,8 @@ export class TensorboardServiceClient { * Required. Field mask is used to specify the fields to be overwritten in the * TensorboardExperiment resource by the update. * The fields specified in the update_mask are relative to the resource, not - * the full request. A field will be overwritten if it is in the mask. If the - * user does not provide a mask then all fields will be overwritten if new + * the full request. A field is overwritten if it's in the mask. If the + * user does not provide a mask then all fields are overwritten if new * values are specified. * @param {google.cloud.aiplatform.v1.TensorboardExperiment} request.tensorboardExperiment * Required. The TensorboardExperiment's `name` field is used to identify the @@ -1973,13 +2093,13 @@ export class TensorboardServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the TensorboardExperiment to create the TensorboardRun - * in. Format: + * Required. The resource name of the TensorboardExperiment to create the + * TensorboardRun in. Format: * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` * @param {google.cloud.aiplatform.v1.TensorboardRun} request.tensorboardRun * Required. The TensorboardRun to create. * @param {string} request.tensorboardRunId - * Required. The ID to use for the Tensorboard run, which will become the final + * Required. The ID to use for the Tensorboard run, which becomes the final * component of the Tensorboard run's resource name. * * This value should be 1-128 characters, and valid characters @@ -2284,12 +2404,12 @@ export class TensorboardServiceClient { * Required. Field mask is used to specify the fields to be overwritten in the * TensorboardRun resource by the update. * The fields specified in the update_mask are relative to the resource, not - * the full request. A field will be overwritten if it is in the mask. If the - * user does not provide a mask then all fields will be overwritten if new + * the full request. A field is overwritten if it's in the mask. If the + * user does not provide a mask then all fields are overwritten if new * values are specified. * @param {google.cloud.aiplatform.v1.TensorboardRun} request.tensorboardRun - * Required. The TensorboardRun's `name` field is used to identify the TensorboardRun to - * be updated. Format: + * Required. The TensorboardRun's `name` field is used to identify the + * TensorboardRun to be updated. Format: * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. @@ -2395,8 +2515,8 @@ export class TensorboardServiceClient { * CreateTensorboardTimeSeriesRequest messages must be sub resources of this * TensorboardExperiment. * @param {number[]} request.requests - * Required. The request message specifying the TensorboardTimeSeries to create. - * A maximum of 1000 TensorboardTimeSeries can be created in a batch. + * Required. The request message specifying the TensorboardTimeSeries to + * create. A maximum of 1000 TensorboardTimeSeries can be created in a batch. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -2502,10 +2622,10 @@ export class TensorboardServiceClient { * Format: * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` * @param {string} [request.tensorboardTimeSeriesId] - * Optional. The user specified unique ID to use for the TensorboardTimeSeries, which - * will become the final component of the TensorboardTimeSeries's resource - * name. - * This value should match "{@link a-z0-9-|a-z0-9}{0, 127}" + * Optional. The user specified unique ID to use for the + * TensorboardTimeSeries, which becomes the final component of the + * TensorboardTimeSeries's resource name. This value should match + * "{@link a-z0-9-|a-z0-9}{0, 127}" * @param {google.cloud.aiplatform.v1.TensorboardTimeSeries} request.tensorboardTimeSeries * Required. The TensorboardTimeSeries to create. * @param {object} [options] @@ -2714,8 +2834,8 @@ export class TensorboardServiceClient { * Required. Field mask is used to specify the fields to be overwritten in the * TensorboardTimeSeries resource by the update. * The fields specified in the update_mask are relative to the resource, not - * the full request. A field will be overwritten if it is in the mask. If the - * user does not provide a mask then all fields will be overwritten if new + * the full request. A field is overwritten if it's in the mask. If the + * user does not provide a mask then all fields are overwritten if new * values are specified. * @param {google.cloud.aiplatform.v1.TensorboardTimeSeries} request.tensorboardTimeSeries * Required. The TensorboardTimeSeries' `name` field is used to identify the @@ -2820,20 +2940,22 @@ export class TensorboardServiceClient { /** * 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 + * data points stored is less than the limit, all data is returned. + * Otherwise, the number limit of data points is randomly selected from * this time series and returned. * * @param {Object} request * The request object that will be sent. * @param {string} request.tensorboard - * Required. The resource name of the Tensorboard containing TensorboardTimeSeries to - * read data from. Format: + * Required. The resource name of the Tensorboard containing + * TensorboardTimeSeries to read data from. Format: * `projects/{project}/locations/{location}/tensorboards/{tensorboard}`. - * The TensorboardTimeSeries referenced by {@link google.cloud.aiplatform.v1.BatchReadTensorboardTimeSeriesDataRequest.time_series|time_series} must be sub - * resources of this Tensorboard. + * The TensorboardTimeSeries referenced by + * {@link google.cloud.aiplatform.v1.BatchReadTensorboardTimeSeriesDataRequest.time_series|time_series} + * must be sub resources of this Tensorboard. * @param {string[]} request.timeSeries - * Required. The resource names of the TensorboardTimeSeries to read data from. Format: + * Required. The resource names of the TensorboardTimeSeries to read data + * from. Format: * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}` * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. @@ -2931,8 +3053,8 @@ export class TensorboardServiceClient { } /** * 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. + * points stored is less than 1000, all data is returned. Otherwise, 1000 + * data points is randomly selected from this time series and returned. * This value can be changed by changing max_data_points, which can't be * greater than 10k. * @@ -3045,8 +3167,7 @@ export class TensorboardServiceClient { } /** * Write time series data points of multiple TensorboardTimeSeries in multiple - * TensorboardRun's. If any data fail to be ingested, an error will be - * returned. + * TensorboardRun's. If any data fail to be ingested, an error is returned. * * @param {Object} request * The request object that will be sent. @@ -3152,8 +3273,7 @@ export class TensorboardServiceClient { } /** * Write time series data points into multiple TensorboardTimeSeries under - * a TensorboardRun. If any data fail to be ingested, an error will be - * returned. + * a TensorboardRun. If any data fail to be ingested, an error is returned. * * @param {Object} request * The request object that will be sent. @@ -3273,7 +3393,7 @@ export class TensorboardServiceClient { * @param {string} request.timeSeries * Required. The resource name of the TensorboardTimeSeries to list Blobs. * Format: - * 'projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}' + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}` * @param {string[]} request.blobIds * IDs of the blobs to read. * @param {object} [options] @@ -3452,8 +3572,8 @@ export class TensorboardServiceClient { * Required. Field mask is used to specify the fields to be overwritten in the * Tensorboard resource by the update. * The fields specified in the update_mask are relative to the resource, not - * the full request. A field will be overwritten if it is in the mask. If the - * user does not provide a mask then all fields will be overwritten if new + * the full request. A field is overwritten if it's in the mask. If the + * user does not provide a mask then all fields are overwritten if new * values are specified. * @param {google.cloud.aiplatform.v1.Tensorboard} request.tensorboard * Required. The Tensorboard's `name` field is used to identify the @@ -4171,17 +4291,17 @@ export class TensorboardServiceClient { * Lists the Tensorboards that match the filter expression. * @param {number} request.pageSize * The maximum number of Tensorboards to return. The service may return - * fewer than this value. If unspecified, at most 100 Tensorboards will be - * returned. The maximum value is 100; values above 100 will be coerced to + * fewer than this value. If unspecified, at most 100 Tensorboards are + * returned. The maximum value is 100; values above 100 are coerced to * 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} + * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. * @param {google.protobuf.FieldMask} request.readMask @@ -4286,17 +4406,17 @@ export class TensorboardServiceClient { * Lists the Tensorboards that match the filter expression. * @param {number} request.pageSize * The maximum number of Tensorboards to return. The service may return - * fewer than this value. If unspecified, at most 100 Tensorboards will be - * returned. The maximum value is 100; values above 100 will be coerced to + * fewer than this value. If unspecified, at most 100 Tensorboards are + * returned. The maximum value is 100; values above 100 are coerced to * 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} + * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. * @param {google.protobuf.FieldMask} request.readMask @@ -4349,17 +4469,17 @@ export class TensorboardServiceClient { * Lists the Tensorboards that match the filter expression. * @param {number} request.pageSize * The maximum number of Tensorboards to return. The service may return - * fewer than this value. If unspecified, at most 100 Tensorboards will be - * returned. The maximum value is 100; values above 100 will be coerced to + * fewer than this value. If unspecified, at most 100 Tensorboards are + * returned. The maximum value is 100; values above 100 are coerced to * 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} + * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. * @param {google.protobuf.FieldMask} request.readMask @@ -4404,24 +4524,24 @@ export class TensorboardServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the Tensorboard to list TensorboardExperiments. - * Format: - * 'projects/{project}/locations/{location}/tensorboards/{tensorboard}' + * Required. The resource name of the Tensorboard to list + * TensorboardExperiments. Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}` * @param {string} request.filter * Lists the TensorboardExperiments that match the filter expression. * @param {number} request.pageSize * The maximum number of TensorboardExperiments to return. The service may * return fewer than this value. If unspecified, at most 50 - * TensorboardExperiments will be returned. The maximum value is 1000; values - * above 1000 will be coerced to 1000. + * TensorboardExperiments are returned. The maximum value is 1000; values + * above 1000 are coerced to 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} + * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. * @param {google.protobuf.FieldMask} request.readMask @@ -4523,24 +4643,24 @@ export class TensorboardServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the Tensorboard to list TensorboardExperiments. - * Format: - * 'projects/{project}/locations/{location}/tensorboards/{tensorboard}' + * Required. The resource name of the Tensorboard to list + * TensorboardExperiments. Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}` * @param {string} request.filter * Lists the TensorboardExperiments that match the filter expression. * @param {number} request.pageSize * The maximum number of TensorboardExperiments to return. The service may * return fewer than this value. If unspecified, at most 50 - * TensorboardExperiments will be returned. The maximum value is 1000; values - * above 1000 will be coerced to 1000. + * TensorboardExperiments are returned. The maximum value is 1000; values + * above 1000 are coerced to 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} + * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. * @param {google.protobuf.FieldMask} request.readMask @@ -4586,24 +4706,24 @@ export class TensorboardServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the Tensorboard to list TensorboardExperiments. - * Format: - * 'projects/{project}/locations/{location}/tensorboards/{tensorboard}' + * Required. The resource name of the Tensorboard to list + * TensorboardExperiments. Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}` * @param {string} request.filter * Lists the TensorboardExperiments that match the filter expression. * @param {number} request.pageSize * The maximum number of TensorboardExperiments to return. The service may * return fewer than this value. If unspecified, at most 50 - * TensorboardExperiments will be returned. The maximum value is 1000; values - * above 1000 will be coerced to 1000. + * TensorboardExperiments are returned. The maximum value is 1000; values + * above 1000 are coerced to 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} + * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. * @param {google.protobuf.FieldMask} request.readMask @@ -4648,24 +4768,24 @@ export class TensorboardServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the TensorboardExperiment to list TensorboardRuns. - * Format: - * 'projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}' + * Required. The resource name of the TensorboardExperiment to list + * TensorboardRuns. Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` * @param {string} request.filter * Lists the TensorboardRuns that match the filter expression. * @param {number} request.pageSize * The maximum number of TensorboardRuns to return. The service may return - * fewer than this value. If unspecified, at most 50 TensorboardRuns will be - * returned. The maximum value is 1000; values above 1000 will be coerced to + * fewer than this value. If unspecified, at most 50 TensorboardRuns are + * returned. The maximum value is 1000; values above 1000 are coerced to * 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} + * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. * @param {google.protobuf.FieldMask} request.readMask @@ -4763,24 +4883,24 @@ export class TensorboardServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the TensorboardExperiment to list TensorboardRuns. - * Format: - * 'projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}' + * Required. The resource name of the TensorboardExperiment to list + * TensorboardRuns. Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` * @param {string} request.filter * Lists the TensorboardRuns that match the filter expression. * @param {number} request.pageSize * The maximum number of TensorboardRuns to return. The service may return - * fewer than this value. If unspecified, at most 50 TensorboardRuns will be - * returned. The maximum value is 1000; values above 1000 will be coerced to + * fewer than this value. If unspecified, at most 50 TensorboardRuns are + * returned. The maximum value is 1000; values above 1000 are coerced to * 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} + * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. * @param {google.protobuf.FieldMask} request.readMask @@ -4826,24 +4946,24 @@ export class TensorboardServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the TensorboardExperiment to list TensorboardRuns. - * Format: - * 'projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}' + * Required. The resource name of the TensorboardExperiment to list + * TensorboardRuns. Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` * @param {string} request.filter * Lists the TensorboardRuns that match the filter expression. * @param {number} request.pageSize * The maximum number of TensorboardRuns to return. The service may return - * fewer than this value. If unspecified, at most 50 TensorboardRuns will be - * returned. The maximum value is 1000; values above 1000 will be coerced to + * fewer than this value. If unspecified, at most 50 TensorboardRuns are + * returned. The maximum value is 1000; values above 1000 are coerced to * 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} + * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. * @param {google.protobuf.FieldMask} request.readMask @@ -4888,24 +5008,24 @@ export class TensorboardServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. - * Format: - * 'projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}' + * Required. The resource name of the TensorboardRun to list + * TensorboardTimeSeries. Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` * @param {string} request.filter * Lists the TensorboardTimeSeries that match the filter expression. * @param {number} request.pageSize * The maximum number of TensorboardTimeSeries to return. The service may * return fewer than this value. If unspecified, at most 50 - * TensorboardTimeSeries will be returned. The maximum value is 1000; values - * above 1000 will be coerced to 1000. + * TensorboardTimeSeries are returned. The maximum value is 1000; values + * above 1000 are coerced to 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} + * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. * @param {google.protobuf.FieldMask} request.readMask @@ -5007,24 +5127,24 @@ export class TensorboardServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. - * Format: - * 'projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}' + * Required. The resource name of the TensorboardRun to list + * TensorboardTimeSeries. Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` * @param {string} request.filter * Lists the TensorboardTimeSeries that match the filter expression. * @param {number} request.pageSize * The maximum number of TensorboardTimeSeries to return. The service may * return fewer than this value. If unspecified, at most 50 - * TensorboardTimeSeries will be returned. The maximum value is 1000; values - * above 1000 will be coerced to 1000. + * TensorboardTimeSeries are returned. The maximum value is 1000; values + * above 1000 are coerced to 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} + * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. * @param {google.protobuf.FieldMask} request.readMask @@ -5070,24 +5190,24 @@ export class TensorboardServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. - * Format: - * 'projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}' + * Required. The resource name of the TensorboardRun to list + * TensorboardTimeSeries. Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` * @param {string} request.filter * Lists the TensorboardTimeSeries that match the filter expression. * @param {number} request.pageSize * The maximum number of TensorboardTimeSeries to return. The service may * return fewer than this value. If unspecified, at most 50 - * TensorboardTimeSeries will be returned. The maximum value is 1000; values - * above 1000 will be coerced to 1000. + * TensorboardTimeSeries are returned. The maximum value is 1000; values + * above 1000 are coerced to 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} + * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. * @param {google.protobuf.FieldMask} request.readMask @@ -5133,15 +5253,15 @@ export class TensorboardServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.tensorboardTimeSeries - * Required. The resource name of the TensorboardTimeSeries to export data from. - * Format: + * Required. The resource name of the TensorboardTimeSeries to export data + * from. Format: * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}` * @param {string} request.filter * Exports the TensorboardTimeSeries' data that match the filter expression. * @param {number} request.pageSize * The maximum number of data points to return per page. - * The default page_size will be 1000. Values must be between 1 and 10000. - * Values above 10000 will be coerced to 10000. + * The default page_size is 1000. Values must be between 1 and 10000. + * Values above 10000 are coerced to 10000. * @param {string} request.pageToken * A page token, received from a previous * {@link |TensorboardService.ExportTensorboardTimeSeries} call. @@ -5152,7 +5272,7 @@ export class TensorboardServiceClient { * match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the TensorboardTimeSeries' data. - * By default, TensorboardTimeSeries' data will be returned in a pseudo random + * By default, TensorboardTimeSeries' data is returned in a pseudo random * order. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. @@ -5251,15 +5371,15 @@ export class TensorboardServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.tensorboardTimeSeries - * Required. The resource name of the TensorboardTimeSeries to export data from. - * Format: + * Required. The resource name of the TensorboardTimeSeries to export data + * from. Format: * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}` * @param {string} request.filter * Exports the TensorboardTimeSeries' data that match the filter expression. * @param {number} request.pageSize * The maximum number of data points to return per page. - * The default page_size will be 1000. Values must be between 1 and 10000. - * Values above 10000 will be coerced to 10000. + * The default page_size is 1000. Values must be between 1 and 10000. + * Values above 10000 are coerced to 10000. * @param {string} request.pageToken * A page token, received from a previous * {@link |TensorboardService.ExportTensorboardTimeSeries} call. @@ -5270,7 +5390,7 @@ export class TensorboardServiceClient { * match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the TensorboardTimeSeries' data. - * By default, TensorboardTimeSeries' data will be returned in a pseudo random + * By default, TensorboardTimeSeries' data is returned in a pseudo random * order. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. @@ -5314,15 +5434,15 @@ export class TensorboardServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.tensorboardTimeSeries - * Required. The resource name of the TensorboardTimeSeries to export data from. - * Format: + * Required. The resource name of the TensorboardTimeSeries to export data + * from. Format: * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}` * @param {string} request.filter * Exports the TensorboardTimeSeries' data that match the filter expression. * @param {number} request.pageSize * The maximum number of data points to return per page. - * The default page_size will be 1000. Values must be between 1 and 10000. - * Values above 10000 will be coerced to 10000. + * The default page_size is 1000. Values must be between 1 and 10000. + * Values above 10000 are coerced to 10000. * @param {string} request.pageToken * A page token, received from a previous * {@link |TensorboardService.ExportTensorboardTimeSeries} call. @@ -5333,7 +5453,7 @@ export class TensorboardServiceClient { * match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the TensorboardTimeSeries' data. - * By default, TensorboardTimeSeries' data will be returned in a pseudo random + * By default, TensorboardTimeSeries' data is returned in a pseudo random * order. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. diff --git a/packages/google-cloud-aiplatform/src/v1/tensorboard_service_client_config.json b/packages/google-cloud-aiplatform/src/v1/tensorboard_service_client_config.json index 8f49b63c40b..649e11414ce 100644 --- a/packages/google-cloud-aiplatform/src/v1/tensorboard_service_client_config.json +++ b/packages/google-cloud-aiplatform/src/v1/tensorboard_service_client_config.json @@ -28,6 +28,10 @@ "retry_codes_name": "non_idempotent", "retry_params_name": "default" }, + "ReadTensorboardUsage": { + "retry_codes_name": "non_idempotent", + "retry_params_name": "default" + }, "UpdateTensorboard": { "retry_codes_name": "non_idempotent", "retry_params_name": "default" diff --git a/packages/google-cloud-aiplatform/src/v1/vizier_service_client.ts b/packages/google-cloud-aiplatform/src/v1/vizier_service_client.ts index 41a69050aae..084a3323c5a 100644 --- a/packages/google-cloud-aiplatform/src/v1/vizier_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1/vizier_service_client.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -338,8 +338,14 @@ export class VizierServiceClient { }, { selector: 'google.iam.v1.IAMPolicy.GetIamPolicy', - post: '/ui/{resource=projects/*/locations/*/featurestores/*}:getIamPolicy', + post: '/v1/{resource=projects/*/locations/*/featurestores/*}:getIamPolicy', additional_bindings: [ + { + post: '/v1/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:getIamPolicy', + }, + { + post: '/ui/{resource=projects/*/locations/*/featurestores/*}:getIamPolicy', + }, { post: '/ui/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:getIamPolicy', }, @@ -347,9 +353,17 @@ export class VizierServiceClient { }, { selector: 'google.iam.v1.IAMPolicy.SetIamPolicy', - post: '/ui/{resource=projects/*/locations/*/featurestores/*}:setIamPolicy', + post: '/v1/{resource=projects/*/locations/*/featurestores/*}:setIamPolicy', body: '*', additional_bindings: [ + { + post: '/v1/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:setIamPolicy', + body: '*', + }, + { + post: '/ui/{resource=projects/*/locations/*/featurestores/*}:setIamPolicy', + body: '*', + }, { post: '/ui/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:setIamPolicy', body: '*', @@ -358,8 +372,14 @@ export class VizierServiceClient { }, { selector: 'google.iam.v1.IAMPolicy.TestIamPermissions', - post: '/ui/{resource=projects/*/locations/*/featurestores/*}:testIamPermissions', + post: '/v1/{resource=projects/*/locations/*/featurestores/*}:testIamPermissions', additional_bindings: [ + { + post: '/v1/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:testIamPermissions', + }, + { + post: '/ui/{resource=projects/*/locations/*/featurestores/*}:testIamPermissions', + }, { post: '/ui/{resource=projects/*/locations/*/featurestores/*/entityTypes/*}:testIamPermissions', }, diff --git a/packages/google-cloud-aiplatform/src/v1beta1/dataset_service_client.ts b/packages/google-cloud-aiplatform/src/v1beta1/dataset_service_client.ts index 748e4e0dce0..5513e78f9e9 100644 --- a/packages/google-cloud-aiplatform/src/v1beta1/dataset_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1beta1/dataset_service_client.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -313,6 +313,11 @@ export class DatasetServiceClient { 'nextPageToken', 'dataItems' ), + searchDataItems: new this._gaxModule.PageDescriptor( + 'pageToken', + 'nextPageToken', + 'dataItemViews' + ), listSavedQueries: new this._gaxModule.PageDescriptor( 'pageToken', 'nextPageToken', @@ -553,6 +558,9 @@ export class DatasetServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}:cancel', }, + { + post: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}:cancel', + }, { post: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}:cancel', }, @@ -565,6 +573,9 @@ export class DatasetServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}:cancel', }, + { + post: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}:cancel', + }, { post: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}:cancel', }, @@ -780,6 +791,10 @@ export class DatasetServiceClient { delete: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}', }, + { + delete: + '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}', + }, { delete: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}', @@ -796,6 +811,10 @@ export class DatasetServiceClient { delete: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}', }, + { + delete: + '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}', + }, { delete: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}', @@ -963,6 +982,9 @@ export class DatasetServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}', }, + { + get: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}', + }, { get: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}', }, @@ -975,6 +997,9 @@ export class DatasetServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}', }, + { + get: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}', + }, { get: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}', }, @@ -1128,6 +1153,9 @@ export class DatasetServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*}/operations', }, + { + get: '/v1beta1/{name=projects/*/locations/*/persistentResources/*}/operations', + }, { get: '/v1beta1/{name=projects/*/locations/*/studies/*}/operations', }, @@ -1140,6 +1168,9 @@ export class DatasetServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*}/operations', }, + { + get: '/v1beta1/{name=projects/*/locations/*/schedules/*}/operations', + }, { get: '/v1beta1/{name=projects/*/locations/*/specialistPools/*}/operations', }, @@ -1309,6 +1340,9 @@ export class DatasetServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}:wait', }, + { + post: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}:wait', + }, { post: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}:wait', }, @@ -1321,6 +1355,9 @@ export class DatasetServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}:wait', }, + { + post: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}:wait', + }, { post: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}:wait', }, @@ -1449,6 +1486,7 @@ export class DatasetServiceClient { 'importData', 'exportData', 'listDataItems', + 'searchDataItems', 'listSavedQueries', 'getAnnotationSpec', 'listAnnotations', @@ -1640,8 +1678,8 @@ export class DatasetServiceClient { * Required. The Dataset which replaces the resource on the server. * @param {google.protobuf.FieldMask} request.updateMask * Required. The update mask applies to the resource. - * For the `FieldMask` definition, see {@link google.protobuf.FieldMask|google.protobuf.FieldMask}. - * Updatable fields: + * For the `FieldMask` definition, see + * {@link google.protobuf.FieldMask|google.protobuf.FieldMask}. Updatable fields: * * * `display_name` * * `description` @@ -2123,8 +2161,8 @@ export class DatasetServiceClient { * Format: * `projects/{project}/locations/{location}/datasets/{dataset}` * @param {number[]} request.importConfigs - * Required. The desired input locations. The contents of all input locations will be - * imported in one batch. + * Required. The desired input locations. The contents of all input locations + * will be imported in one batch. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -2881,6 +2919,366 @@ export class DatasetServiceClient { callSettings ) as AsyncIterable; } + /** + * Searches DataItems in a Dataset. + * + * @param {Object} request + * The request object that will be sent. + * @param {string} request.orderByDataItem + * A comma-separated list of data item fields to order by, sorted in + * ascending order. Use "desc" after a field name for descending. + * @param {google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation} request.orderByAnnotation + * Expression that allows ranking results based on annotation's property. + * @param {string} request.dataset + * Required. The resource name of the Dataset from which to search DataItems. + * Format: + * `projects/{project}/locations/{location}/datasets/{dataset}` + * @param {string} request.savedQuery + * The resource name of a SavedQuery(annotation set in UI). + * Format: + * `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}` + * All of the search will be done in the context of this SavedQuery. + * @param {string} request.dataLabelingJob + * The resource name of a DataLabelingJob. + * Format: + * `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` + * If this field is set, all of the search will be done in the context of + * this DataLabelingJob. + * @param {string} request.dataItemFilter + * An expression for filtering the DataItem that will be returned. + * + * * `data_item_id` - for = or !=. + * * `labeled` - for = or !=. + * * `has_annotation(ANNOTATION_SPEC_ID)` - true only for DataItem that + * have at least one annotation with annotation_spec_id = + * `ANNOTATION_SPEC_ID` in the context of SavedQuery or DataLabelingJob. + * + * For example: + * + * * `data_item=1` + * * `has_annotation(5)` + * @param {string} request.annotationsFilter + * An expression for filtering the Annotations that will be returned per + * DataItem. + * * `annotation_spec_id` - for = or !=. + * @param {string[]} request.annotationFilters + * An expression that specifies what Annotations will be returned per + * DataItem. Annotations satisfied either of the conditions will be returned. + * * `annotation_spec_id` - for = or !=. + * Must specify `saved_query_id=` - saved query id that annotations should + * belong to. + * @param {google.protobuf.FieldMask} request.fieldMask + * Mask specifying which fields of + * {@link google.cloud.aiplatform.v1beta1.DataItemView|DataItemView} to read. + * @param {number} request.annotationsLimit + * If set, only up to this many of Annotations will be returned per + * DataItemView. The maximum value is 1000. If not set, the maximum value will + * be used. + * @param {number} request.pageSize + * Requested page size. Server may return fewer results than requested. + * Default and maximum page size is 100. + * @param {string} request.orderBy + * A comma-separated list of fields to order by, sorted in ascending order. + * Use "desc" after a field name for descending. + * @param {string} request.pageToken + * A token identifying a page of results for the server to return + * Typically obtained via + * {@link google.cloud.aiplatform.v1beta1.SearchDataItemsResponse.next_page_token|SearchDataItemsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1beta1.DatasetService.SearchDataItems|DatasetService.SearchDataItems} + * call. + * @param {object} [options] + * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. + * @returns {Promise} - The promise which resolves to an array. + * The first element of the array is Array of [DataItemView]{@link google.cloud.aiplatform.v1beta1.DataItemView}. + * The client library will perform auto-pagination by default: it will call the API as many + * times as needed and will merge results from all the pages into this array. + * Note that it can affect your quota. + * We recommend using `searchDataItemsAsync()` + * method described below for async iteration which you can stop as needed. + * Please see the + * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * for more details and examples. + */ + searchDataItems( + request?: protos.google.cloud.aiplatform.v1beta1.ISearchDataItemsRequest, + options?: CallOptions + ): Promise< + [ + protos.google.cloud.aiplatform.v1beta1.IDataItemView[], + protos.google.cloud.aiplatform.v1beta1.ISearchDataItemsRequest | null, + protos.google.cloud.aiplatform.v1beta1.ISearchDataItemsResponse + ] + >; + searchDataItems( + request: protos.google.cloud.aiplatform.v1beta1.ISearchDataItemsRequest, + options: CallOptions, + callback: PaginationCallback< + protos.google.cloud.aiplatform.v1beta1.ISearchDataItemsRequest, + | protos.google.cloud.aiplatform.v1beta1.ISearchDataItemsResponse + | null + | undefined, + protos.google.cloud.aiplatform.v1beta1.IDataItemView + > + ): void; + searchDataItems( + request: protos.google.cloud.aiplatform.v1beta1.ISearchDataItemsRequest, + callback: PaginationCallback< + protos.google.cloud.aiplatform.v1beta1.ISearchDataItemsRequest, + | protos.google.cloud.aiplatform.v1beta1.ISearchDataItemsResponse + | null + | undefined, + protos.google.cloud.aiplatform.v1beta1.IDataItemView + > + ): void; + searchDataItems( + request?: protos.google.cloud.aiplatform.v1beta1.ISearchDataItemsRequest, + optionsOrCallback?: + | CallOptions + | PaginationCallback< + protos.google.cloud.aiplatform.v1beta1.ISearchDataItemsRequest, + | protos.google.cloud.aiplatform.v1beta1.ISearchDataItemsResponse + | null + | undefined, + protos.google.cloud.aiplatform.v1beta1.IDataItemView + >, + callback?: PaginationCallback< + protos.google.cloud.aiplatform.v1beta1.ISearchDataItemsRequest, + | protos.google.cloud.aiplatform.v1beta1.ISearchDataItemsResponse + | null + | undefined, + protos.google.cloud.aiplatform.v1beta1.IDataItemView + > + ): Promise< + [ + protos.google.cloud.aiplatform.v1beta1.IDataItemView[], + protos.google.cloud.aiplatform.v1beta1.ISearchDataItemsRequest | null, + protos.google.cloud.aiplatform.v1beta1.ISearchDataItemsResponse + ] + > | void { + request = request || {}; + let options: CallOptions; + if (typeof optionsOrCallback === 'function' && callback === undefined) { + callback = optionsOrCallback; + options = {}; + } else { + options = optionsOrCallback as CallOptions; + } + options = options || {}; + options.otherArgs = options.otherArgs || {}; + options.otherArgs.headers = options.otherArgs.headers || {}; + options.otherArgs.headers['x-goog-request-params'] = + this._gaxModule.routingHeader.fromParams({ + dataset: request.dataset ?? '', + }); + this.initialize(); + return this.innerApiCalls.searchDataItems(request, options, callback); + } + + /** + * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object. + * @param {Object} request + * The request object that will be sent. + * @param {string} request.orderByDataItem + * A comma-separated list of data item fields to order by, sorted in + * ascending order. Use "desc" after a field name for descending. + * @param {google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation} request.orderByAnnotation + * Expression that allows ranking results based on annotation's property. + * @param {string} request.dataset + * Required. The resource name of the Dataset from which to search DataItems. + * Format: + * `projects/{project}/locations/{location}/datasets/{dataset}` + * @param {string} request.savedQuery + * The resource name of a SavedQuery(annotation set in UI). + * Format: + * `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}` + * All of the search will be done in the context of this SavedQuery. + * @param {string} request.dataLabelingJob + * The resource name of a DataLabelingJob. + * Format: + * `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` + * If this field is set, all of the search will be done in the context of + * this DataLabelingJob. + * @param {string} request.dataItemFilter + * An expression for filtering the DataItem that will be returned. + * + * * `data_item_id` - for = or !=. + * * `labeled` - for = or !=. + * * `has_annotation(ANNOTATION_SPEC_ID)` - true only for DataItem that + * have at least one annotation with annotation_spec_id = + * `ANNOTATION_SPEC_ID` in the context of SavedQuery or DataLabelingJob. + * + * For example: + * + * * `data_item=1` + * * `has_annotation(5)` + * @param {string} request.annotationsFilter + * An expression for filtering the Annotations that will be returned per + * DataItem. + * * `annotation_spec_id` - for = or !=. + * @param {string[]} request.annotationFilters + * An expression that specifies what Annotations will be returned per + * DataItem. Annotations satisfied either of the conditions will be returned. + * * `annotation_spec_id` - for = or !=. + * Must specify `saved_query_id=` - saved query id that annotations should + * belong to. + * @param {google.protobuf.FieldMask} request.fieldMask + * Mask specifying which fields of + * {@link google.cloud.aiplatform.v1beta1.DataItemView|DataItemView} to read. + * @param {number} request.annotationsLimit + * If set, only up to this many of Annotations will be returned per + * DataItemView. The maximum value is 1000. If not set, the maximum value will + * be used. + * @param {number} request.pageSize + * Requested page size. Server may return fewer results than requested. + * Default and maximum page size is 100. + * @param {string} request.orderBy + * A comma-separated list of fields to order by, sorted in ascending order. + * Use "desc" after a field name for descending. + * @param {string} request.pageToken + * A token identifying a page of results for the server to return + * Typically obtained via + * {@link google.cloud.aiplatform.v1beta1.SearchDataItemsResponse.next_page_token|SearchDataItemsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1beta1.DatasetService.SearchDataItems|DatasetService.SearchDataItems} + * call. + * @param {object} [options] + * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. + * @returns {Stream} + * An object stream which emits an object representing [DataItemView]{@link google.cloud.aiplatform.v1beta1.DataItemView} on 'data' event. + * The client library will perform auto-pagination by default: it will call the API as many + * times as needed. Note that it can affect your quota. + * We recommend using `searchDataItemsAsync()` + * method described below for async iteration which you can stop as needed. + * Please see the + * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * for more details and examples. + */ + searchDataItemsStream( + request?: protos.google.cloud.aiplatform.v1beta1.ISearchDataItemsRequest, + options?: CallOptions + ): Transform { + request = request || {}; + options = options || {}; + options.otherArgs = options.otherArgs || {}; + options.otherArgs.headers = options.otherArgs.headers || {}; + options.otherArgs.headers['x-goog-request-params'] = + this._gaxModule.routingHeader.fromParams({ + dataset: request.dataset ?? '', + }); + const defaultCallSettings = this._defaults['searchDataItems']; + const callSettings = defaultCallSettings.merge(options); + this.initialize(); + return this.descriptors.page.searchDataItems.createStream( + this.innerApiCalls.searchDataItems as GaxCall, + request, + callSettings + ); + } + + /** + * Equivalent to `searchDataItems`, but returns an iterable object. + * + * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand. + * @param {Object} request + * The request object that will be sent. + * @param {string} request.orderByDataItem + * A comma-separated list of data item fields to order by, sorted in + * ascending order. Use "desc" after a field name for descending. + * @param {google.cloud.aiplatform.v1beta1.SearchDataItemsRequest.OrderByAnnotation} request.orderByAnnotation + * Expression that allows ranking results based on annotation's property. + * @param {string} request.dataset + * Required. The resource name of the Dataset from which to search DataItems. + * Format: + * `projects/{project}/locations/{location}/datasets/{dataset}` + * @param {string} request.savedQuery + * The resource name of a SavedQuery(annotation set in UI). + * Format: + * `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}` + * All of the search will be done in the context of this SavedQuery. + * @param {string} request.dataLabelingJob + * The resource name of a DataLabelingJob. + * Format: + * `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` + * If this field is set, all of the search will be done in the context of + * this DataLabelingJob. + * @param {string} request.dataItemFilter + * An expression for filtering the DataItem that will be returned. + * + * * `data_item_id` - for = or !=. + * * `labeled` - for = or !=. + * * `has_annotation(ANNOTATION_SPEC_ID)` - true only for DataItem that + * have at least one annotation with annotation_spec_id = + * `ANNOTATION_SPEC_ID` in the context of SavedQuery or DataLabelingJob. + * + * For example: + * + * * `data_item=1` + * * `has_annotation(5)` + * @param {string} request.annotationsFilter + * An expression for filtering the Annotations that will be returned per + * DataItem. + * * `annotation_spec_id` - for = or !=. + * @param {string[]} request.annotationFilters + * An expression that specifies what Annotations will be returned per + * DataItem. Annotations satisfied either of the conditions will be returned. + * * `annotation_spec_id` - for = or !=. + * Must specify `saved_query_id=` - saved query id that annotations should + * belong to. + * @param {google.protobuf.FieldMask} request.fieldMask + * Mask specifying which fields of + * {@link google.cloud.aiplatform.v1beta1.DataItemView|DataItemView} to read. + * @param {number} request.annotationsLimit + * If set, only up to this many of Annotations will be returned per + * DataItemView. The maximum value is 1000. If not set, the maximum value will + * be used. + * @param {number} request.pageSize + * Requested page size. Server may return fewer results than requested. + * Default and maximum page size is 100. + * @param {string} request.orderBy + * A comma-separated list of fields to order by, sorted in ascending order. + * Use "desc" after a field name for descending. + * @param {string} request.pageToken + * A token identifying a page of results for the server to return + * Typically obtained via + * {@link google.cloud.aiplatform.v1beta1.SearchDataItemsResponse.next_page_token|SearchDataItemsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1beta1.DatasetService.SearchDataItems|DatasetService.SearchDataItems} + * call. + * @param {object} [options] + * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. + * @returns {Object} + * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * When you iterate the returned iterable, each element will be an object representing + * [DataItemView]{@link google.cloud.aiplatform.v1beta1.DataItemView}. The API will be called under the hood as needed, once per the page, + * so you can stop the iteration when you don't need more results. + * Please see the + * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * for more details and examples. + * @example include:samples/generated/v1beta1/dataset_service.search_data_items.js + * region_tag:aiplatform_v1beta1_generated_DatasetService_SearchDataItems_async + */ + searchDataItemsAsync( + request?: protos.google.cloud.aiplatform.v1beta1.ISearchDataItemsRequest, + options?: CallOptions + ): AsyncIterable { + request = request || {}; + options = options || {}; + options.otherArgs = options.otherArgs || {}; + options.otherArgs.headers = options.otherArgs.headers || {}; + options.otherArgs.headers['x-goog-request-params'] = + this._gaxModule.routingHeader.fromParams({ + dataset: request.dataset ?? '', + }); + const defaultCallSettings = this._defaults['searchDataItems']; + const callSettings = defaultCallSettings.merge(options); + this.initialize(); + return this.descriptors.page.searchDataItems.asyncIterate( + this.innerApiCalls['searchDataItems'] as GaxCall, + request as {}, + callSettings + ) as AsyncIterable; + } /** * Lists SavedQueries in a Dataset. * diff --git a/packages/google-cloud-aiplatform/src/v1beta1/dataset_service_client_config.json b/packages/google-cloud-aiplatform/src/v1beta1/dataset_service_client_config.json index 6ddf573c33d..697d04ac3f8 100644 --- a/packages/google-cloud-aiplatform/src/v1beta1/dataset_service_client_config.json +++ b/packages/google-cloud-aiplatform/src/v1beta1/dataset_service_client_config.json @@ -60,6 +60,10 @@ "retry_codes_name": "non_idempotent", "retry_params_name": "default" }, + "SearchDataItems": { + "retry_codes_name": "non_idempotent", + "retry_params_name": "default" + }, "ListSavedQueries": { "retry_codes_name": "non_idempotent", "retry_params_name": "default" diff --git a/packages/google-cloud-aiplatform/src/v1beta1/deployment_resource_pool_service_client.ts b/packages/google-cloud-aiplatform/src/v1beta1/deployment_resource_pool_service_client.ts index c0055dc2713..68482cc4787 100644 --- a/packages/google-cloud-aiplatform/src/v1beta1/deployment_resource_pool_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1beta1/deployment_resource_pool_service_client.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -546,6 +546,9 @@ export class DeploymentResourcePoolServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}:cancel', }, + { + post: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}:cancel', + }, { post: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}:cancel', }, @@ -558,6 +561,9 @@ export class DeploymentResourcePoolServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}:cancel', }, + { + post: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}:cancel', + }, { post: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}:cancel', }, @@ -773,6 +779,10 @@ export class DeploymentResourcePoolServiceClient { delete: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}', }, + { + delete: + '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}', + }, { delete: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}', @@ -789,6 +799,10 @@ export class DeploymentResourcePoolServiceClient { delete: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}', }, + { + delete: + '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}', + }, { delete: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}', @@ -956,6 +970,9 @@ export class DeploymentResourcePoolServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}', }, + { + get: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}', + }, { get: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}', }, @@ -968,6 +985,9 @@ export class DeploymentResourcePoolServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}', }, + { + get: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}', + }, { get: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}', }, @@ -1121,6 +1141,9 @@ export class DeploymentResourcePoolServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*}/operations', }, + { + get: '/v1beta1/{name=projects/*/locations/*/persistentResources/*}/operations', + }, { get: '/v1beta1/{name=projects/*/locations/*/studies/*}/operations', }, @@ -1133,6 +1156,9 @@ export class DeploymentResourcePoolServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*}/operations', }, + { + get: '/v1beta1/{name=projects/*/locations/*/schedules/*}/operations', + }, { get: '/v1beta1/{name=projects/*/locations/*/specialistPools/*}/operations', }, @@ -1302,6 +1328,9 @@ export class DeploymentResourcePoolServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}:wait', }, + { + post: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}:wait', + }, { post: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}:wait', }, @@ -1314,6 +1343,9 @@ export class DeploymentResourcePoolServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}:wait', }, + { + post: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}:wait', + }, { post: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}:wait', }, @@ -1520,7 +1552,7 @@ export class DeploymentResourcePoolServiceClient { * @param {string} request.name * Required. The name of the DeploymentResourcePool to retrieve. * Format: - * projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool} + * `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -1622,8 +1654,8 @@ export class DeploymentResourcePoolServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The parent location resource where this DeploymentResourcePool will be - * created. Format: projects/{project}/locations/{location} + * Required. The parent location resource where this DeploymentResourcePool + * will be created. Format: `projects/{project}/locations/{location}` * @param {google.cloud.aiplatform.v1beta1.DeploymentResourcePool} request.deploymentResourcePool * Required. The DeploymentResourcePool to create. * @param {string} request.deploymentResourcePoolId @@ -1776,7 +1808,7 @@ export class DeploymentResourcePoolServiceClient { * @param {string} request.name * Required. The name of the DeploymentResourcePool to delete. * Format: - * projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool} + * `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -1918,8 +1950,8 @@ export class DeploymentResourcePoolServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The parent Location which owns this collection of DeploymentResourcePools. - * Format: projects/{project}/locations/{location} + * Required. The parent Location which owns this collection of + * DeploymentResourcePools. Format: `projects/{project}/locations/{location}` * @param {number} request.pageSize * The maximum number of DeploymentResourcePools to return. The service may * return fewer than this value. @@ -2027,8 +2059,8 @@ export class DeploymentResourcePoolServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The parent Location which owns this collection of DeploymentResourcePools. - * Format: projects/{project}/locations/{location} + * Required. The parent Location which owns this collection of + * DeploymentResourcePools. Format: `projects/{project}/locations/{location}` * @param {number} request.pageSize * The maximum number of DeploymentResourcePools to return. The service may * return fewer than this value. @@ -2080,8 +2112,8 @@ export class DeploymentResourcePoolServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The parent Location which owns this collection of DeploymentResourcePools. - * Format: projects/{project}/locations/{location} + * Required. The parent Location which owns this collection of + * DeploymentResourcePools. Format: `projects/{project}/locations/{location}` * @param {number} request.pageSize * The maximum number of DeploymentResourcePools to return. The service may * return fewer than this value. @@ -2134,7 +2166,7 @@ export class DeploymentResourcePoolServiceClient { * @param {string} request.deploymentResourcePool * Required. The name of the target DeploymentResourcePool to query. * Format: - * projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool} + * `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` * @param {number} request.pageSize * The maximum number of DeployedModels to return. The service may return * fewer than this value. @@ -2240,7 +2272,7 @@ export class DeploymentResourcePoolServiceClient { * @param {string} request.deploymentResourcePool * Required. The name of the target DeploymentResourcePool to query. * Format: - * projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool} + * `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` * @param {number} request.pageSize * The maximum number of DeployedModels to return. The service may return * fewer than this value. @@ -2294,7 +2326,7 @@ export class DeploymentResourcePoolServiceClient { * @param {string} request.deploymentResourcePool * Required. The name of the target DeploymentResourcePool to query. * Format: - * projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool} + * `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` * @param {number} request.pageSize * The maximum number of DeployedModels to return. The service may return * fewer than this value. diff --git a/packages/google-cloud-aiplatform/src/v1beta1/endpoint_service_client.ts b/packages/google-cloud-aiplatform/src/v1beta1/endpoint_service_client.ts index 4c9bbd32861..24334929640 100644 --- a/packages/google-cloud-aiplatform/src/v1beta1/endpoint_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1beta1/endpoint_service_client.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -537,6 +537,9 @@ export class EndpointServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}:cancel', }, + { + post: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}:cancel', + }, { post: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}:cancel', }, @@ -549,6 +552,9 @@ export class EndpointServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}:cancel', }, + { + post: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}:cancel', + }, { post: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}:cancel', }, @@ -764,6 +770,10 @@ export class EndpointServiceClient { delete: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}', }, + { + delete: + '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}', + }, { delete: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}', @@ -780,6 +790,10 @@ export class EndpointServiceClient { delete: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}', }, + { + delete: + '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}', + }, { delete: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}', @@ -947,6 +961,9 @@ export class EndpointServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}', }, + { + get: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}', + }, { get: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}', }, @@ -959,6 +976,9 @@ export class EndpointServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}', }, + { + get: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}', + }, { get: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}', }, @@ -1112,6 +1132,9 @@ export class EndpointServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*}/operations', }, + { + get: '/v1beta1/{name=projects/*/locations/*/persistentResources/*}/operations', + }, { get: '/v1beta1/{name=projects/*/locations/*/studies/*}/operations', }, @@ -1124,6 +1147,9 @@ export class EndpointServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*}/operations', }, + { + get: '/v1beta1/{name=projects/*/locations/*/schedules/*}/operations', + }, { get: '/v1beta1/{name=projects/*/locations/*/specialistPools/*}/operations', }, @@ -1293,6 +1319,9 @@ export class EndpointServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}:wait', }, + { + post: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}:wait', + }, { post: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}:wait', }, @@ -1305,6 +1334,9 @@ export class EndpointServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}:wait', }, + { + post: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}:wait', + }, { post: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}:wait', }, @@ -1619,7 +1651,8 @@ export class EndpointServiceClient { * @param {google.cloud.aiplatform.v1beta1.Endpoint} request.endpoint * Required. The Endpoint which replaces the resource on the server. * @param {google.protobuf.FieldMask} request.updateMask - * Required. The update mask applies to the resource. See {@link google.protobuf.FieldMask|google.protobuf.FieldMask}. + * Required. The update mask applies to the resource. See + * {@link google.protobuf.FieldMask|google.protobuf.FieldMask}. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -2006,21 +2039,24 @@ export class EndpointServiceClient { * `projects/{project}/locations/{location}/endpoints/{endpoint}` * @param {google.cloud.aiplatform.v1beta1.DeployedModel} request.deployedModel * Required. The DeployedModel to be created within the Endpoint. Note that - * {@link google.cloud.aiplatform.v1beta1.Endpoint.traffic_split|Endpoint.traffic_split} must be updated for the DeployedModel to start - * receiving traffic, either as part of this call, or via + * {@link google.cloud.aiplatform.v1beta1.Endpoint.traffic_split|Endpoint.traffic_split} + * must be updated for the DeployedModel to start receiving traffic, either as + * part of this call, or via * {@link google.cloud.aiplatform.v1beta1.EndpointService.UpdateEndpoint|EndpointService.UpdateEndpoint}. * @param {number[]} request.trafficSplit * A map from a DeployedModel's ID to the percentage of this Endpoint's * traffic that should be forwarded to that DeployedModel. * * If this field is non-empty, then the Endpoint's - * {@link google.cloud.aiplatform.v1beta1.Endpoint.traffic_split|traffic_split} will be overwritten with it. - * To refer to the ID of the just being deployed Model, a "0" should be used, - * and the actual ID of the new DeployedModel will be filled in its place by - * this method. The traffic percentage values must add up to 100. + * {@link google.cloud.aiplatform.v1beta1.Endpoint.traffic_split|traffic_split} + * will be overwritten with it. To refer to the ID of the just being deployed + * Model, a "0" should be used, and the actual ID of the new DeployedModel + * will be filled in its place by this method. The traffic percentage values + * must add up to 100. * * If this field is empty, then the Endpoint's - * {@link google.cloud.aiplatform.v1beta1.Endpoint.traffic_split|traffic_split} is not updated. + * {@link google.cloud.aiplatform.v1beta1.Endpoint.traffic_split|traffic_split} is + * not updated. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -2166,12 +2202,12 @@ export class EndpointServiceClient { * Required. The ID of the DeployedModel to be undeployed from the Endpoint. * @param {number[]} request.trafficSplit * If this field is provided, then the Endpoint's - * {@link google.cloud.aiplatform.v1beta1.Endpoint.traffic_split|traffic_split} will be overwritten with it. If - * last DeployedModel is being undeployed from the Endpoint, the - * [Endpoint.traffic_split] will always end up empty when this call returns. - * A DeployedModel will be successfully undeployed only if it doesn't have - * any traffic assigned to it when this method executes, or if this field - * unassigns any traffic to it. + * {@link google.cloud.aiplatform.v1beta1.Endpoint.traffic_split|traffic_split} + * will be overwritten with it. If last DeployedModel is being undeployed from + * the Endpoint, the [Endpoint.traffic_split] will always end up empty when + * this call returns. A DeployedModel will be successfully undeployed only if + * it doesn't have any traffic assigned to it when this method executes, or if + * this field unassigns any traffic to it. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -2309,14 +2345,15 @@ export class EndpointServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the Location from which to list the Endpoints. - * Format: `projects/{project}/locations/{location}` + * Required. The resource name of the Location from which to list the + * Endpoints. Format: `projects/{project}/locations/{location}` * @param {string} [request.filter] - * Optional. An expression for filtering the results of the request. For field names - * both snake_case and camelCase are supported. + * Optional. An expression for filtering the results of the request. For field + * names both snake_case and camelCase are supported. * * * `endpoint` supports = and !=. `endpoint` represents the Endpoint ID, - * i.e. the last segment of the Endpoint's {@link google.cloud.aiplatform.v1beta1.Endpoint.name|resource name}. + * i.e. the last segment of the Endpoint's [resource + * name][google.cloud.aiplatform.v1beta1.Endpoint.name]. * * `display_name` supports = and, != * * `labels` supports general map functions that is: * * `labels.key=value` - key:value equality @@ -2332,8 +2369,10 @@ export class EndpointServiceClient { * @param {string} [request.pageToken] * Optional. The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListEndpointsResponse.next_page_token|ListEndpointsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1beta1.EndpointService.ListEndpoints|EndpointService.ListEndpoints} call. + * {@link google.cloud.aiplatform.v1beta1.ListEndpointsResponse.next_page_token|ListEndpointsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1beta1.EndpointService.ListEndpoints|EndpointService.ListEndpoints} + * call. * @param {google.protobuf.FieldMask} [request.readMask] * Optional. Mask specifying which fields to read. * @param {object} [options] @@ -2429,14 +2468,15 @@ export class EndpointServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the Location from which to list the Endpoints. - * Format: `projects/{project}/locations/{location}` + * Required. The resource name of the Location from which to list the + * Endpoints. Format: `projects/{project}/locations/{location}` * @param {string} [request.filter] - * Optional. An expression for filtering the results of the request. For field names - * both snake_case and camelCase are supported. + * Optional. An expression for filtering the results of the request. For field + * names both snake_case and camelCase are supported. * * * `endpoint` supports = and !=. `endpoint` represents the Endpoint ID, - * i.e. the last segment of the Endpoint's {@link google.cloud.aiplatform.v1beta1.Endpoint.name|resource name}. + * i.e. the last segment of the Endpoint's [resource + * name][google.cloud.aiplatform.v1beta1.Endpoint.name]. * * `display_name` supports = and, != * * `labels` supports general map functions that is: * * `labels.key=value` - key:value equality @@ -2452,8 +2492,10 @@ export class EndpointServiceClient { * @param {string} [request.pageToken] * Optional. The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListEndpointsResponse.next_page_token|ListEndpointsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1beta1.EndpointService.ListEndpoints|EndpointService.ListEndpoints} call. + * {@link google.cloud.aiplatform.v1beta1.ListEndpointsResponse.next_page_token|ListEndpointsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1beta1.EndpointService.ListEndpoints|EndpointService.ListEndpoints} + * call. * @param {google.protobuf.FieldMask} [request.readMask] * Optional. Mask specifying which fields to read. * @param {object} [options] @@ -2497,14 +2539,15 @@ export class EndpointServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the Location from which to list the Endpoints. - * Format: `projects/{project}/locations/{location}` + * Required. The resource name of the Location from which to list the + * Endpoints. Format: `projects/{project}/locations/{location}` * @param {string} [request.filter] - * Optional. An expression for filtering the results of the request. For field names - * both snake_case and camelCase are supported. + * Optional. An expression for filtering the results of the request. For field + * names both snake_case and camelCase are supported. * * * `endpoint` supports = and !=. `endpoint` represents the Endpoint ID, - * i.e. the last segment of the Endpoint's {@link google.cloud.aiplatform.v1beta1.Endpoint.name|resource name}. + * i.e. the last segment of the Endpoint's [resource + * name][google.cloud.aiplatform.v1beta1.Endpoint.name]. * * `display_name` supports = and, != * * `labels` supports general map functions that is: * * `labels.key=value` - key:value equality @@ -2520,8 +2563,10 @@ export class EndpointServiceClient { * @param {string} [request.pageToken] * Optional. The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListEndpointsResponse.next_page_token|ListEndpointsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1beta1.EndpointService.ListEndpoints|EndpointService.ListEndpoints} call. + * {@link google.cloud.aiplatform.v1beta1.ListEndpointsResponse.next_page_token|ListEndpointsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1beta1.EndpointService.ListEndpoints|EndpointService.ListEndpoints} + * call. * @param {google.protobuf.FieldMask} [request.readMask] * Optional. Mask specifying which fields to read. * @param {object} [options] diff --git a/packages/google-cloud-aiplatform/src/v1beta1/featurestore_online_serving_service_client.ts b/packages/google-cloud-aiplatform/src/v1beta1/featurestore_online_serving_service_client.ts index d566e8d61cf..0c596380408 100644 --- a/packages/google-cloud-aiplatform/src/v1beta1/featurestore_online_serving_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1beta1/featurestore_online_serving_service_client.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -568,14 +568,15 @@ export class FeaturestoreOnlineServingServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.entityType - * Required. The resource name of the EntityType for the entities being written. - * Value format: `projects/{project}/locations/{location}/featurestores/ + * Required. The resource name of the EntityType for the entities being + * written. Value format: + * `projects/{project}/locations/{location}/featurestores/ * {featurestore}/entityTypes/{entityType}`. For example, * for a machine learning model predicting user clicks on a website, an * EntityType ID could be `user`. * @param {number[]} request.payloads - * Required. The entities to be written. Up to 100,000 feature values can be written - * across all `payloads`. + * Required. The entities to be written. Up to 100,000 feature values can be + * written across all `payloads`. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -682,12 +683,12 @@ export class FeaturestoreOnlineServingServiceClient { * for a machine learning model predicting user clicks on a website, an * EntityType ID could be `user`. * @param {string[]} request.entityIds - * Required. IDs of entities to read Feature values of. The maximum number of IDs is - * 100. For example, for a machine learning model predicting user clicks on a - * website, an entity ID could be `user_123`. + * Required. IDs of entities to read Feature values of. The maximum number of + * IDs is 100. For example, for a machine learning model predicting user + * clicks on a website, an entity ID could be `user_123`. * @param {google.cloud.aiplatform.v1beta1.FeatureSelector} request.featureSelector - * Required. Selector choosing Features of the target EntityType. Feature IDs will be - * deduplicated. + * Required. Selector choosing Features of the target EntityType. Feature IDs + * will be deduplicated. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} diff --git a/packages/google-cloud-aiplatform/src/v1beta1/featurestore_service_client.ts b/packages/google-cloud-aiplatform/src/v1beta1/featurestore_service_client.ts index b8832431cf1..c0da42d46df 100644 --- a/packages/google-cloud-aiplatform/src/v1beta1/featurestore_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1beta1/featurestore_service_client.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -555,6 +555,9 @@ export class FeaturestoreServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}:cancel', }, + { + post: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}:cancel', + }, { post: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}:cancel', }, @@ -567,6 +570,9 @@ export class FeaturestoreServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}:cancel', }, + { + post: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}:cancel', + }, { post: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}:cancel', }, @@ -782,6 +788,10 @@ export class FeaturestoreServiceClient { delete: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}', }, + { + delete: + '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}', + }, { delete: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}', @@ -798,6 +808,10 @@ export class FeaturestoreServiceClient { delete: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}', }, + { + delete: + '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}', + }, { delete: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}', @@ -965,6 +979,9 @@ export class FeaturestoreServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}', }, + { + get: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}', + }, { get: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}', }, @@ -977,6 +994,9 @@ export class FeaturestoreServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}', }, + { + get: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}', + }, { get: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}', }, @@ -1130,6 +1150,9 @@ export class FeaturestoreServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*}/operations', }, + { + get: '/v1beta1/{name=projects/*/locations/*/persistentResources/*}/operations', + }, { get: '/v1beta1/{name=projects/*/locations/*/studies/*}/operations', }, @@ -1142,6 +1165,9 @@ export class FeaturestoreServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*}/operations', }, + { + get: '/v1beta1/{name=projects/*/locations/*/schedules/*}/operations', + }, { get: '/v1beta1/{name=projects/*/locations/*/specialistPools/*}/operations', }, @@ -1311,6 +1337,9 @@ export class FeaturestoreServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}:wait', }, + { + post: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}:wait', + }, { post: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}:wait', }, @@ -1323,6 +1352,9 @@ export class FeaturestoreServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}:wait', }, + { + post: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}:wait', + }, { post: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}:wait', }, @@ -1839,9 +1871,8 @@ export class FeaturestoreServiceClient { * @param {Object} request * The request object that will be sent. * @param {google.cloud.aiplatform.v1beta1.EntityType} request.entityType - * Required. The EntityType's `name` field is used to identify the EntityType to be - * updated. - * Format: + * Required. The EntityType's `name` field is used to identify the EntityType + * to be updated. Format: * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` * @param {google.protobuf.FieldMask} request.updateMask * Field mask is used to specify the fields to be overwritten in the @@ -1863,6 +1894,7 @@ export class FeaturestoreServiceClient { * * `monitoring_config.import_features_analysis.anomaly_detection_baseline` * * `monitoring_config.numerical_threshold_config.value` * * `monitoring_config.categorical_threshold_config.value` + * * `offline_storage_ttl_days` (available in Preview) * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -2167,8 +2199,8 @@ export class FeaturestoreServiceClient { * @param {google.cloud.aiplatform.v1beta1.Featurestore} request.featurestore * Required. The Featurestore to create. * @param {string} request.featurestoreId - * Required. The ID to use for this Featurestore, which will become the final component - * of the Featurestore's resource name. + * Required. The ID to use for this Featurestore, which will become the final + * component of the Featurestore's resource name. * * This value may be up to 60 characters, and valid characters are * `[a-z0-9_]`. The first character cannot be a number. @@ -2311,9 +2343,8 @@ export class FeaturestoreServiceClient { * @param {Object} request * The request object that will be sent. * @param {google.cloud.aiplatform.v1beta1.Featurestore} request.featurestore - * Required. The Featurestore's `name` field is used to identify the Featurestore to be - * updated. - * Format: + * Required. The Featurestore's `name` field is used to identify the + * Featurestore to be updated. Format: * `projects/{project}/locations/{location}/featurestores/{featurestore}` * @param {google.protobuf.FieldMask} request.updateMask * Field mask is used to specify the fields to be overwritten in the @@ -2329,6 +2360,7 @@ export class FeaturestoreServiceClient { * * `labels` * * `online_serving_config.fixed_node_count` * * `online_serving_config.scaling` + * * `online_storage_ttl_days` (available in Preview) * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -2617,8 +2649,8 @@ export class FeaturestoreServiceClient { * @param {google.cloud.aiplatform.v1beta1.EntityType} request.entityType * The EntityType to create. * @param {string} request.entityTypeId - * Required. The ID to use for the EntityType, which will become the final component of - * the EntityType's resource name. + * Required. The ID to use for the EntityType, which will become the final + * component of the EntityType's resource name. * * This value may be up to 60 characters, and valid characters are * `[a-z0-9_]`. The first character cannot be a number. @@ -2911,10 +2943,10 @@ export class FeaturestoreServiceClient { * @param {google.cloud.aiplatform.v1beta1.Feature} request.feature * Required. The Feature to create. * @param {string} request.featureId - * Required. The ID to use for the Feature, which will become the final component of - * the Feature's resource name. + * Required. The ID to use for the Feature, which will become the final + * component of the Feature's resource name. * - * This value may be up to 60 characters, and valid characters are + * This value may be up to 128 characters, and valid characters are * `[a-z0-9_]`. The first character cannot be a number. * * The value must be unique within an EntityType. @@ -3055,14 +3087,15 @@ export class FeaturestoreServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the EntityType to create the batch of Features under. - * Format: + * Required. The resource name of the EntityType to create the batch of + * Features under. Format: * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` * @param {number[]} request.requests - * Required. The request message specifying the Features to create. All Features must be - * created under the same parent EntityType. The `parent` field in each child - * request message can be omitted. If `parent` is set in a child request, then - * the value must match the `parent` value in this request message. + * Required. The request message specifying the Features to create. All + * Features must be created under the same parent EntityType. The `parent` + * field in each child request message can be omitted. If `parent` is set in a + * child request, then the value must match the `parent` value in this request + * message. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -3368,16 +3401,16 @@ export class FeaturestoreServiceClient { * Single Feature timestamp for all entities being imported. The * timestamp must not have higher than millisecond precision. * @param {string} request.entityType - * Required. The resource name of the EntityType grouping the Features for which values - * are being imported. Format: + * Required. The resource name of the EntityType grouping the Features for + * which values are being imported. Format: * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}` * @param {string} request.entityIdField * Source column that holds entity IDs. If not provided, entity IDs are * extracted from the column named `entity_id`. * @param {number[]} request.featureSpecs - * Required. Specifications defining which Feature values to import from the entity. The - * request fails if no feature_specs are provided, and having multiple - * feature_specs for one Feature is not allowed. + * Required. Specifications defining which Feature values to import from the + * entity. The request fails if no feature_specs are provided, and having + * multiple feature_specs for one Feature is not allowed. * @param {boolean} request.disableOnlineServing * If set, data will not be imported for online serving. This * is typically used for backfilling, where Feature generation timestamps are @@ -3560,8 +3593,8 @@ export class FeaturestoreServiceClient { * @param {google.cloud.aiplatform.v1beta1.BigQuerySource} request.bigqueryReadInstances * Similar to csv_read_instances, but from BigQuery source. * @param {string} request.featurestore - * Required. The resource name of the Featurestore from which to query Feature values. - * Format: + * Required. The resource name of the Featurestore from which to query Feature + * values. Format: * `projects/{project}/locations/{location}/featurestores/{featurestore}` * @param {google.cloud.aiplatform.v1beta1.FeatureValueDestination} request.destination * Required. Specifies output location and format. @@ -3574,11 +3607,15 @@ export class FeaturestoreServiceClient { * automatically inferred. For CSV source, the pass-through values will be * passed as opaque bytes. * @param {number[]} request.entityTypeSpecs - * Required. Specifies EntityType grouping Features to read values of and settings. - * Each EntityType referenced in + * Required. Specifies EntityType grouping Features to read values of and + * settings. Each EntityType referenced in * [BatchReadFeatureValuesRequest.entity_type_specs] must have a column * specifying entity IDs in the EntityType in * {@link |BatchReadFeatureValuesRequest.request} . + * @param {google.protobuf.Timestamp} [request.startTime] + * Optional. Excludes Feature values with feature generation timestamp before + * this timestamp. If not set, retrieve oldest values kept in Feature Store. + * Timestamp, if present, must not have higher than millisecond precision. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -3726,8 +3763,8 @@ export class FeaturestoreServiceClient { * Exports all historical values of all entities of the EntityType within a * time range * @param {string} request.entityType - * Required. The resource name of the EntityType from which to export Feature values. - * Format: + * Required. The resource name of the EntityType from which to export Feature + * values. Format: * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` * @param {google.cloud.aiplatform.v1beta1.FeatureValueDestination} request.destination * Required. Specifies destination location and format. @@ -3886,8 +3923,8 @@ export class FeaturestoreServiceClient { * Select feature values to be deleted by specifying time range and * features. * @param {string} request.entityType - * Required. The resource name of the EntityType grouping the Features for which values - * are being deleted from. Format: + * Required. The resource name of the EntityType grouping the Features for + * which values are being deleted from. Format: * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}` * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. @@ -4056,12 +4093,12 @@ export class FeaturestoreServiceClient { * coerced to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} + * must match the call that provided the page token. * @param {string} request.orderBy * A comma-separated list of fields to order by, sorted in ascending order. * Use "desc" after a field name for descending. @@ -4195,12 +4232,12 @@ export class FeaturestoreServiceClient { * coerced to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} + * must match the call that provided the page token. * @param {string} request.orderBy * A comma-separated list of fields to order by, sorted in ascending order. * Use "desc" after a field name for descending. @@ -4282,12 +4319,12 @@ export class FeaturestoreServiceClient { * coerced to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeaturestores|FeaturestoreService.ListFeaturestores} + * must match the call that provided the page token. * @param {string} request.orderBy * A comma-separated list of fields to order by, sorted in ascending order. * Use "desc" after a field name for descending. @@ -4367,12 +4404,12 @@ export class FeaturestoreServiceClient { * 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} + * must match the call that provided the page token. * @param {string} request.orderBy * A comma-separated list of fields to order by, sorted in ascending order. * Use "desc" after a field name for descending. @@ -4506,12 +4543,12 @@ export class FeaturestoreServiceClient { * 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} + * must match the call that provided the page token. * @param {string} request.orderBy * A comma-separated list of fields to order by, sorted in ascending order. * Use "desc" after a field name for descending. @@ -4593,12 +4630,12 @@ export class FeaturestoreServiceClient { * 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes|FeaturestoreService.ListEntityTypes} + * must match the call that provided the page token. * @param {string} request.orderBy * A comma-separated list of fields to order by, sorted in ascending order. * Use "desc" after a field name for descending. @@ -4681,12 +4718,12 @@ export class FeaturestoreServiceClient { * 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} + * must match the call that provided the page token. * @param {string} request.orderBy * A comma-separated list of fields to order by, sorted in ascending order. * Use "desc" after a field name for descending. @@ -4699,10 +4736,12 @@ export class FeaturestoreServiceClient { * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {number} request.latestStatsCount - * If set, return the most recent {@link google.cloud.aiplatform.v1beta1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count} + * If set, return the most recent + * {@link google.cloud.aiplatform.v1beta1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count} * of stats for each Feature in response. Valid value is [0, 10]. If number of - * stats exists < {@link google.cloud.aiplatform.v1beta1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count}, return all - * existing stats. + * stats exists < + * {@link google.cloud.aiplatform.v1beta1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count}, + * return all existing stats. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -4827,12 +4866,12 @@ export class FeaturestoreServiceClient { * 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} + * must match the call that provided the page token. * @param {string} request.orderBy * A comma-separated list of fields to order by, sorted in ascending order. * Use "desc" after a field name for descending. @@ -4845,10 +4884,12 @@ export class FeaturestoreServiceClient { * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {number} request.latestStatsCount - * If set, return the most recent {@link google.cloud.aiplatform.v1beta1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count} + * If set, return the most recent + * {@link google.cloud.aiplatform.v1beta1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count} * of stats for each Feature in response. Valid value is [0, 10]. If number of - * stats exists < {@link google.cloud.aiplatform.v1beta1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count}, return all - * existing stats. + * stats exists < + * {@link google.cloud.aiplatform.v1beta1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count}, + * return all existing stats. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} @@ -4921,12 +4962,12 @@ export class FeaturestoreServiceClient { * 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures|FeaturestoreService.ListFeatures} + * must match the call that provided the page token. * @param {string} request.orderBy * A comma-separated list of fields to order by, sorted in ascending order. * Use "desc" after a field name for descending. @@ -4939,10 +4980,12 @@ export class FeaturestoreServiceClient { * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {number} request.latestStatsCount - * If set, return the most recent {@link google.cloud.aiplatform.v1beta1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count} + * If set, return the most recent + * {@link google.cloud.aiplatform.v1beta1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count} * of stats for each Feature in response. Valid value is [0, 10]. If number of - * stats exists < {@link google.cloud.aiplatform.v1beta1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count}, return all - * existing stats. + * stats exists < + * {@link google.cloud.aiplatform.v1beta1.ListFeaturesRequest.latest_stats_count|ListFeaturesRequest.latest_stats_count}, + * return all existing stats. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} @@ -5053,12 +5096,12 @@ export class FeaturestoreServiceClient { * 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures}, except `page_size`, must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures}, + * except `page_size`, must match the call that provided the page token. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -5222,12 +5265,12 @@ export class FeaturestoreServiceClient { * 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures}, except `page_size`, must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures}, + * except `page_size`, must match the call that provided the page token. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} @@ -5339,12 +5382,12 @@ export class FeaturestoreServiceClient { * 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures}, except `page_size`, must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1beta1.FeaturestoreService.SearchFeatures|FeaturestoreService.SearchFeatures}, + * except `page_size`, must match the call that provided the page token. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} diff --git a/packages/google-cloud-aiplatform/src/v1beta1/gapic_metadata.json b/packages/google-cloud-aiplatform/src/v1beta1/gapic_metadata.json index 1a399b184ac..69243ea4e5e 100644 --- a/packages/google-cloud-aiplatform/src/v1beta1/gapic_metadata.json +++ b/packages/google-cloud-aiplatform/src/v1beta1/gapic_metadata.json @@ -59,6 +59,13 @@ "listDataItemsAsync" ] }, + "SearchDataItems": { + "methods": [ + "searchDataItems", + "searchDataItemsStream", + "searchDataItemsAsync" + ] + }, "ListSavedQueries": { "methods": [ "listSavedQueries", @@ -127,6 +134,13 @@ "listDataItemsAsync" ] }, + "SearchDataItems": { + "methods": [ + "searchDataItems", + "searchDataItemsStream", + "searchDataItemsAsync" + ] + }, "ListSavedQueries": { "methods": [ "listSavedQueries", @@ -1914,6 +1928,11 @@ "getTensorboard" ] }, + "ReadTensorboardUsage": { + "methods": [ + "readTensorboardUsage" + ] + }, "CreateTensorboardExperiment": { "methods": [ "createTensorboardExperiment" @@ -2069,6 +2088,11 @@ "getTensorboard" ] }, + "ReadTensorboardUsage": { + "methods": [ + "readTensorboardUsage" + ] + }, "CreateTensorboardExperiment": { "methods": [ "createTensorboardExperiment" diff --git a/packages/google-cloud-aiplatform/src/v1beta1/index.ts b/packages/google-cloud-aiplatform/src/v1beta1/index.ts index 838f26309b1..ba40ede8c26 100644 --- a/packages/google-cloud-aiplatform/src/v1beta1/index.ts +++ b/packages/google-cloud-aiplatform/src/v1beta1/index.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/packages/google-cloud-aiplatform/src/v1beta1/index_endpoint_service_client.ts b/packages/google-cloud-aiplatform/src/v1beta1/index_endpoint_service_client.ts index 1021257bd19..70f6cfa68f5 100644 --- a/packages/google-cloud-aiplatform/src/v1beta1/index_endpoint_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1beta1/index_endpoint_service_client.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -537,6 +537,9 @@ export class IndexEndpointServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}:cancel', }, + { + post: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}:cancel', + }, { post: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}:cancel', }, @@ -549,6 +552,9 @@ export class IndexEndpointServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}:cancel', }, + { + post: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}:cancel', + }, { post: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}:cancel', }, @@ -764,6 +770,10 @@ export class IndexEndpointServiceClient { delete: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}', }, + { + delete: + '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}', + }, { delete: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}', @@ -780,6 +790,10 @@ export class IndexEndpointServiceClient { delete: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}', }, + { + delete: + '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}', + }, { delete: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}', @@ -947,6 +961,9 @@ export class IndexEndpointServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}', }, + { + get: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}', + }, { get: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}', }, @@ -959,6 +976,9 @@ export class IndexEndpointServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}', }, + { + get: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}', + }, { get: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}', }, @@ -1112,6 +1132,9 @@ export class IndexEndpointServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*}/operations', }, + { + get: '/v1beta1/{name=projects/*/locations/*/persistentResources/*}/operations', + }, { get: '/v1beta1/{name=projects/*/locations/*/studies/*}/operations', }, @@ -1124,6 +1147,9 @@ export class IndexEndpointServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*}/operations', }, + { + get: '/v1beta1/{name=projects/*/locations/*/schedules/*}/operations', + }, { get: '/v1beta1/{name=projects/*/locations/*/specialistPools/*}/operations', }, @@ -1293,6 +1319,9 @@ export class IndexEndpointServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}:wait', }, + { + post: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}:wait', + }, { post: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}:wait', }, @@ -1305,6 +1334,9 @@ export class IndexEndpointServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}:wait', }, + { + post: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}:wait', + }, { post: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}:wait', }, @@ -1638,7 +1670,8 @@ export class IndexEndpointServiceClient { * @param {google.cloud.aiplatform.v1beta1.IndexEndpoint} request.indexEndpoint * Required. The IndexEndpoint which replaces the resource on the server. * @param {google.protobuf.FieldMask} request.updateMask - * Required. The update mask applies to the resource. See {@link google.protobuf.FieldMask|google.protobuf.FieldMask}. + * Required. The update mask applies to the resource. See + * {@link google.protobuf.FieldMask|google.protobuf.FieldMask}. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -2019,8 +2052,8 @@ export class IndexEndpointServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.indexEndpoint - * Required. The name of the IndexEndpoint resource into which to deploy an Index. - * Format: + * Required. The name of the IndexEndpoint resource into which to deploy an + * Index. Format: * `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}` * @param {google.cloud.aiplatform.v1beta1.DeployedIndex} request.deployedIndex * Required. The DeployedIndex to be created within the IndexEndpoint. @@ -2162,11 +2195,12 @@ export class IndexEndpointServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.indexEndpoint - * Required. The name of the IndexEndpoint resource from which to undeploy an Index. - * Format: + * Required. The name of the IndexEndpoint resource from which to undeploy an + * Index. Format: * `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}` * @param {string} request.deployedIndexId - * Required. The ID of the DeployedIndex to be undeployed from the IndexEndpoint. + * Required. The ID of the DeployedIndex to be undeployed from the + * IndexEndpoint. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -2304,8 +2338,8 @@ export class IndexEndpointServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.indexEndpoint - * Required. The name of the IndexEndpoint resource into which to deploy an Index. - * Format: + * Required. The name of the IndexEndpoint resource into which to deploy an + * Index. Format: * `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}` * @param {google.cloud.aiplatform.v1beta1.DeployedIndex} request.deployedIndex * Required. The DeployedIndex to be updated within the IndexEndpoint. @@ -2448,11 +2482,11 @@ export class IndexEndpointServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the Location from which to list the IndexEndpoints. - * Format: `projects/{project}/locations/{location}` + * Required. The resource name of the Location from which to list the + * IndexEndpoints. Format: `projects/{project}/locations/{location}` * @param {string} [request.filter] - * Optional. An expression for filtering the results of the request. For field names - * both snake_case and camelCase are supported. + * Optional. An expression for filtering the results of the request. For field + * names both snake_case and camelCase are supported. * * * `index_endpoint` supports = and !=. `index_endpoint` represents the * IndexEndpoint ID, ie. the last segment of the IndexEndpoint's @@ -2474,8 +2508,10 @@ export class IndexEndpointServiceClient { * @param {string} [request.pageToken] * Optional. The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListIndexEndpointsResponse.next_page_token|ListIndexEndpointsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1beta1.IndexEndpointService.ListIndexEndpoints|IndexEndpointService.ListIndexEndpoints} call. + * {@link google.cloud.aiplatform.v1beta1.ListIndexEndpointsResponse.next_page_token|ListIndexEndpointsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1beta1.IndexEndpointService.ListIndexEndpoints|IndexEndpointService.ListIndexEndpoints} + * call. * @param {google.protobuf.FieldMask} [request.readMask] * Optional. Mask specifying which fields to read. * @param {object} [options] @@ -2571,11 +2607,11 @@ export class IndexEndpointServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the Location from which to list the IndexEndpoints. - * Format: `projects/{project}/locations/{location}` + * Required. The resource name of the Location from which to list the + * IndexEndpoints. Format: `projects/{project}/locations/{location}` * @param {string} [request.filter] - * Optional. An expression for filtering the results of the request. For field names - * both snake_case and camelCase are supported. + * Optional. An expression for filtering the results of the request. For field + * names both snake_case and camelCase are supported. * * * `index_endpoint` supports = and !=. `index_endpoint` represents the * IndexEndpoint ID, ie. the last segment of the IndexEndpoint's @@ -2597,8 +2633,10 @@ export class IndexEndpointServiceClient { * @param {string} [request.pageToken] * Optional. The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListIndexEndpointsResponse.next_page_token|ListIndexEndpointsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1beta1.IndexEndpointService.ListIndexEndpoints|IndexEndpointService.ListIndexEndpoints} call. + * {@link google.cloud.aiplatform.v1beta1.ListIndexEndpointsResponse.next_page_token|ListIndexEndpointsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1beta1.IndexEndpointService.ListIndexEndpoints|IndexEndpointService.ListIndexEndpoints} + * call. * @param {google.protobuf.FieldMask} [request.readMask] * Optional. Mask specifying which fields to read. * @param {object} [options] @@ -2642,11 +2680,11 @@ export class IndexEndpointServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the Location from which to list the IndexEndpoints. - * Format: `projects/{project}/locations/{location}` + * Required. The resource name of the Location from which to list the + * IndexEndpoints. Format: `projects/{project}/locations/{location}` * @param {string} [request.filter] - * Optional. An expression for filtering the results of the request. For field names - * both snake_case and camelCase are supported. + * Optional. An expression for filtering the results of the request. For field + * names both snake_case and camelCase are supported. * * * `index_endpoint` supports = and !=. `index_endpoint` represents the * IndexEndpoint ID, ie. the last segment of the IndexEndpoint's @@ -2668,8 +2706,10 @@ export class IndexEndpointServiceClient { * @param {string} [request.pageToken] * Optional. The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListIndexEndpointsResponse.next_page_token|ListIndexEndpointsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1beta1.IndexEndpointService.ListIndexEndpoints|IndexEndpointService.ListIndexEndpoints} call. + * {@link google.cloud.aiplatform.v1beta1.ListIndexEndpointsResponse.next_page_token|ListIndexEndpointsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1beta1.IndexEndpointService.ListIndexEndpoints|IndexEndpointService.ListIndexEndpoints} + * call. * @param {google.protobuf.FieldMask} [request.readMask] * Optional. Mask specifying which fields to read. * @param {object} [options] diff --git a/packages/google-cloud-aiplatform/src/v1beta1/index_service_client.ts b/packages/google-cloud-aiplatform/src/v1beta1/index_service_client.ts index fbd5190702e..aaceaca57f3 100644 --- a/packages/google-cloud-aiplatform/src/v1beta1/index_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1beta1/index_service_client.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -537,6 +537,9 @@ export class IndexServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}:cancel', }, + { + post: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}:cancel', + }, { post: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}:cancel', }, @@ -549,6 +552,9 @@ export class IndexServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}:cancel', }, + { + post: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}:cancel', + }, { post: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}:cancel', }, @@ -764,6 +770,10 @@ export class IndexServiceClient { delete: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}', }, + { + delete: + '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}', + }, { delete: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}', @@ -780,6 +790,10 @@ export class IndexServiceClient { delete: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}', }, + { + delete: + '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}', + }, { delete: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}', @@ -947,6 +961,9 @@ export class IndexServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}', }, + { + get: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}', + }, { get: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}', }, @@ -959,6 +976,9 @@ export class IndexServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}', }, + { + get: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}', + }, { get: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}', }, @@ -1112,6 +1132,9 @@ export class IndexServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*}/operations', }, + { + get: '/v1beta1/{name=projects/*/locations/*/persistentResources/*}/operations', + }, { get: '/v1beta1/{name=projects/*/locations/*/studies/*}/operations', }, @@ -1124,6 +1147,9 @@ export class IndexServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*}/operations', }, + { + get: '/v1beta1/{name=projects/*/locations/*/schedules/*}/operations', + }, { get: '/v1beta1/{name=projects/*/locations/*/specialistPools/*}/operations', }, @@ -1293,6 +1319,9 @@ export class IndexServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}:wait', }, + { + post: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}:wait', + }, { post: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}:wait', }, @@ -1305,6 +1334,9 @@ export class IndexServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}:wait', }, + { + post: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}:wait', + }, { post: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}:wait', }, @@ -1953,7 +1985,8 @@ export class IndexServiceClient { * Required. The Index which updates the resource on the server. * @param {google.protobuf.FieldMask} request.updateMask * The update mask applies to the resource. - * For the `FieldMask` definition, see {@link google.protobuf.FieldMask|google.protobuf.FieldMask}. + * For the `FieldMask` definition, see + * {@link google.protobuf.FieldMask|google.protobuf.FieldMask}. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -2088,7 +2121,8 @@ export class IndexServiceClient { /** * Deletes an Index. * An Index can only be deleted when all its - * {@link google.cloud.aiplatform.v1beta1.Index.deployed_indexes|DeployedIndexes} had been undeployed. + * {@link google.cloud.aiplatform.v1beta1.Index.deployed_indexes|DeployedIndexes} + * had been undeployed. * * @param {Object} request * The request object that will be sent. @@ -2242,8 +2276,10 @@ export class IndexServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListIndexesResponse.next_page_token|ListIndexesResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1beta1.IndexService.ListIndexes|IndexService.ListIndexes} call. + * {@link google.cloud.aiplatform.v1beta1.ListIndexesResponse.next_page_token|ListIndexesResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1beta1.IndexService.ListIndexes|IndexService.ListIndexes} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] @@ -2348,8 +2384,10 @@ export class IndexServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListIndexesResponse.next_page_token|ListIndexesResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1beta1.IndexService.ListIndexes|IndexService.ListIndexes} call. + * {@link google.cloud.aiplatform.v1beta1.ListIndexesResponse.next_page_token|ListIndexesResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1beta1.IndexService.ListIndexes|IndexService.ListIndexes} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] @@ -2402,8 +2440,10 @@ export class IndexServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListIndexesResponse.next_page_token|ListIndexesResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1beta1.IndexService.ListIndexes|IndexService.ListIndexes} call. + * {@link google.cloud.aiplatform.v1beta1.ListIndexesResponse.next_page_token|ListIndexesResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1beta1.IndexService.ListIndexes|IndexService.ListIndexes} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] diff --git a/packages/google-cloud-aiplatform/src/v1beta1/job_service_client.ts b/packages/google-cloud-aiplatform/src/v1beta1/job_service_client.ts index 19087e74f7b..288adb5dfcb 100644 --- a/packages/google-cloud-aiplatform/src/v1beta1/job_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1beta1/job_service_client.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -563,6 +563,9 @@ export class JobServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}:cancel', }, + { + post: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}:cancel', + }, { post: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}:cancel', }, @@ -575,6 +578,9 @@ export class JobServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}:cancel', }, + { + post: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}:cancel', + }, { post: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}:cancel', }, @@ -790,6 +796,10 @@ export class JobServiceClient { delete: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}', }, + { + delete: + '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}', + }, { delete: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}', @@ -806,6 +816,10 @@ export class JobServiceClient { delete: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}', }, + { + delete: + '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}', + }, { delete: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}', @@ -973,6 +987,9 @@ export class JobServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}', }, + { + get: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}', + }, { get: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}', }, @@ -985,6 +1002,9 @@ export class JobServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}', }, + { + get: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}', + }, { get: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}', }, @@ -1138,6 +1158,9 @@ export class JobServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*}/operations', }, + { + get: '/v1beta1/{name=projects/*/locations/*/persistentResources/*}/operations', + }, { get: '/v1beta1/{name=projects/*/locations/*/studies/*}/operations', }, @@ -1150,6 +1173,9 @@ export class JobServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*}/operations', }, + { + get: '/v1beta1/{name=projects/*/locations/*/schedules/*}/operations', + }, { get: '/v1beta1/{name=projects/*/locations/*/specialistPools/*}/operations', }, @@ -1319,6 +1345,9 @@ export class JobServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}:wait', }, + { + post: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}:wait', + }, { post: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}:wait', }, @@ -1331,6 +1360,9 @@ export class JobServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}:wait', }, + { + post: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}:wait', + }, { post: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}:wait', }, @@ -1805,13 +1837,16 @@ export class JobServiceClient { * 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 {@link google.cloud.aiplatform.v1beta1.JobService.GetCustomJob|JobService.GetCustomJob} or - * other methods to check whether the cancellation succeeded or whether the + * guaranteed. Clients can use + * {@link google.cloud.aiplatform.v1beta1.JobService.GetCustomJob|JobService.GetCustomJob} + * or other methods to check whether the cancellation succeeded or whether the * job completed despite cancellation. On successful cancellation, * the CustomJob is not deleted; instead it becomes a job with - * a {@link google.cloud.aiplatform.v1beta1.CustomJob.error|CustomJob.error} value with a {@link google.rpc.Status.code|google.rpc.Status.code} of 1, - * corresponding to `Code.CANCELLED`, and {@link google.cloud.aiplatform.v1beta1.CustomJob.state|CustomJob.state} is set to - * `CANCELLED`. + * a {@link google.cloud.aiplatform.v1beta1.CustomJob.error|CustomJob.error} value + * with a {@link google.rpc.Status.code|google.rpc.Status.code} of 1, corresponding + * to `Code.CANCELLED`, and + * {@link google.cloud.aiplatform.v1beta1.CustomJob.state|CustomJob.state} is set + * to `CANCELLED`. * * @param {Object} request * The request object that will be sent. @@ -2213,8 +2248,9 @@ export class JobServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the Location to create the HyperparameterTuningJob in. - * Format: `projects/{project}/locations/{location}` + * Required. The resource name of the Location to create the + * HyperparameterTuningJob in. Format: + * `projects/{project}/locations/{location}` * @param {google.cloud.aiplatform.v1beta1.HyperparameterTuningJob} request.hyperparameterTuningJob * Required. The HyperparameterTuningJob to create. * @param {object} [options] @@ -2418,13 +2454,17 @@ export class JobServiceClient { * 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 {@link google.cloud.aiplatform.v1beta1.JobService.GetHyperparameterTuningJob|JobService.GetHyperparameterTuningJob} or - * other methods to check whether the cancellation succeeded or whether the + * guaranteed. Clients can use + * {@link google.cloud.aiplatform.v1beta1.JobService.GetHyperparameterTuningJob|JobService.GetHyperparameterTuningJob} + * or other methods to check whether the cancellation succeeded or whether the * job completed despite cancellation. On successful cancellation, * the HyperparameterTuningJob is not deleted; instead it becomes a job with - * a {@link google.cloud.aiplatform.v1beta1.HyperparameterTuningJob.error|HyperparameterTuningJob.error} value with a {@link google.rpc.Status.code|google.rpc.Status.code} - * of 1, corresponding to `Code.CANCELLED`, and - * {@link google.cloud.aiplatform.v1beta1.HyperparameterTuningJob.state|HyperparameterTuningJob.state} is set to `CANCELLED`. + * a + * {@link google.cloud.aiplatform.v1beta1.HyperparameterTuningJob.error|HyperparameterTuningJob.error} + * value with a {@link google.rpc.Status.code|google.rpc.Status.code} of 1, + * corresponding to `Code.CANCELLED`, and + * {@link google.cloud.aiplatform.v1beta1.HyperparameterTuningJob.state|HyperparameterTuningJob.state} + * is set to `CANCELLED`. * * @param {Object} request * The request object that will be sent. @@ -2533,8 +2573,8 @@ export class JobServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the Location to create the BatchPredictionJob in. - * Format: `projects/{project}/locations/{location}` + * Required. The resource name of the Location to create the + * BatchPredictionJob in. Format: `projects/{project}/locations/{location}` * @param {google.cloud.aiplatform.v1beta1.BatchPredictionJob} request.batchPredictionJob * Required. The BatchPredictionJob to create. * @param {object} [options] @@ -2735,12 +2775,14 @@ export class JobServiceClient { * * Starts asynchronous cancellation on the BatchPredictionJob. The server * makes the best effort to cancel the job, but success is not - * guaranteed. Clients can use {@link google.cloud.aiplatform.v1beta1.JobService.GetBatchPredictionJob|JobService.GetBatchPredictionJob} or - * other methods to check whether the cancellation succeeded or whether the + * guaranteed. Clients can use + * {@link google.cloud.aiplatform.v1beta1.JobService.GetBatchPredictionJob|JobService.GetBatchPredictionJob} + * or other methods to check whether the cancellation succeeded or whether the * job completed despite cancellation. On a successful cancellation, * the BatchPredictionJob is not deleted;instead its - * {@link google.cloud.aiplatform.v1beta1.BatchPredictionJob.state|BatchPredictionJob.state} is set to `CANCELLED`. Any files already - * outputted by the job are not deleted. + * {@link google.cloud.aiplatform.v1beta1.BatchPredictionJob.state|BatchPredictionJob.state} + * is set to `CANCELLED`. Any files already outputted by the job are not + * deleted. * * @param {Object} request * The request object that will be sent. @@ -3053,7 +3095,8 @@ export class JobServiceClient { /** * Pauses a ModelDeploymentMonitoringJob. If the job is running, the server * makes a best effort to cancel the job. Will mark - * {@link google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob.state|ModelDeploymentMonitoringJob.state} to 'PAUSED'. + * {@link google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob.state|ModelDeploymentMonitoringJob.state} + * to 'PAUSED'. * * @param {Object} request * The request object that will be sent. @@ -3836,17 +3879,16 @@ export class JobServiceClient { * @param {Object} request * The request object that will be sent. * @param {google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob} request.modelDeploymentMonitoringJob - * Required. The model monitoring configuration which replaces the resource on the - * server. + * Required. The model monitoring configuration which replaces the resource on + * the server. * @param {google.protobuf.FieldMask} request.updateMask - * Required. The update mask is used to specify the fields to be overwritten in the - * ModelDeploymentMonitoringJob resource by the update. - * The fields specified in the update_mask are relative to the resource, not - * the full request. A field will be overwritten if it is in the mask. If the - * user does not provide a mask then only the non-empty fields present in the - * request will be overwritten. Set the update_mask to `*` to override all - * fields. - * For the objective config, the user can either provide the update mask for + * Required. The update mask is used to specify the fields to be overwritten + * in the ModelDeploymentMonitoringJob resource by the update. The fields + * specified in the update_mask are relative to the resource, not the full + * request. A field will be overwritten if it is in the mask. If the user does + * not provide a mask then only the non-empty fields present in the request + * will be overwritten. Set the update_mask to `*` to override all fields. For + * the objective config, the user can either provide the update mask for * model_deployment_monitoring_objective_configs or any combination of its * nested fields, such as: * model_deployment_monitoring_objective_configs.objective_config.training_dataset. @@ -4180,8 +4222,10 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListCustomJobsResponse.next_page_token|ListCustomJobsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1beta1.JobService.ListCustomJobs|JobService.ListCustomJobs} call. + * {@link google.cloud.aiplatform.v1beta1.ListCustomJobsResponse.next_page_token|ListCustomJobsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1beta1.JobService.ListCustomJobs|JobService.ListCustomJobs} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] @@ -4305,8 +4349,10 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListCustomJobsResponse.next_page_token|ListCustomJobsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1beta1.JobService.ListCustomJobs|JobService.ListCustomJobs} call. + * {@link google.cloud.aiplatform.v1beta1.ListCustomJobsResponse.next_page_token|ListCustomJobsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1beta1.JobService.ListCustomJobs|JobService.ListCustomJobs} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] @@ -4378,8 +4424,10 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListCustomJobsResponse.next_page_token|ListCustomJobsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1beta1.JobService.ListCustomJobs|JobService.ListCustomJobs} call. + * {@link google.cloud.aiplatform.v1beta1.ListCustomJobsResponse.next_page_token|ListCustomJobsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1beta1.JobService.ListCustomJobs|JobService.ListCustomJobs} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] @@ -4704,8 +4752,9 @@ export class JobServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the Location to list the HyperparameterTuningJobs - * from. Format: `projects/{project}/locations/{location}` + * Required. The resource name of the Location to list the + * HyperparameterTuningJobs from. Format: + * `projects/{project}/locations/{location}` * @param {string} request.filter * The standard list filter. * @@ -4732,8 +4781,10 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListHyperparameterTuningJobsResponse.next_page_token|ListHyperparameterTuningJobsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1beta1.JobService.ListHyperparameterTuningJobs|JobService.ListHyperparameterTuningJobs} call. + * {@link google.cloud.aiplatform.v1beta1.ListHyperparameterTuningJobsResponse.next_page_token|ListHyperparameterTuningJobsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1beta1.JobService.ListHyperparameterTuningJobs|JobService.ListHyperparameterTuningJobs} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] @@ -4833,8 +4884,9 @@ export class JobServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the Location to list the HyperparameterTuningJobs - * from. Format: `projects/{project}/locations/{location}` + * Required. The resource name of the Location to list the + * HyperparameterTuningJobs from. Format: + * `projects/{project}/locations/{location}` * @param {string} request.filter * The standard list filter. * @@ -4861,8 +4913,10 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListHyperparameterTuningJobsResponse.next_page_token|ListHyperparameterTuningJobsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1beta1.JobService.ListHyperparameterTuningJobs|JobService.ListHyperparameterTuningJobs} call. + * {@link google.cloud.aiplatform.v1beta1.ListHyperparameterTuningJobsResponse.next_page_token|ListHyperparameterTuningJobsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1beta1.JobService.ListHyperparameterTuningJobs|JobService.ListHyperparameterTuningJobs} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] @@ -4906,8 +4960,9 @@ export class JobServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the Location to list the HyperparameterTuningJobs - * from. Format: `projects/{project}/locations/{location}` + * Required. The resource name of the Location to list the + * HyperparameterTuningJobs from. Format: + * `projects/{project}/locations/{location}` * @param {string} request.filter * The standard list filter. * @@ -4934,8 +4989,10 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListHyperparameterTuningJobsResponse.next_page_token|ListHyperparameterTuningJobsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1beta1.JobService.ListHyperparameterTuningJobs|JobService.ListHyperparameterTuningJobs} call. + * {@link google.cloud.aiplatform.v1beta1.ListHyperparameterTuningJobsResponse.next_page_token|ListHyperparameterTuningJobsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1beta1.JobService.ListHyperparameterTuningJobs|JobService.ListHyperparameterTuningJobs} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] @@ -5007,8 +5064,10 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListBatchPredictionJobsResponse.next_page_token|ListBatchPredictionJobsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1beta1.JobService.ListBatchPredictionJobs|JobService.ListBatchPredictionJobs} call. + * {@link google.cloud.aiplatform.v1beta1.ListBatchPredictionJobsResponse.next_page_token|ListBatchPredictionJobsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1beta1.JobService.ListBatchPredictionJobs|JobService.ListBatchPredictionJobs} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] @@ -5137,8 +5196,10 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListBatchPredictionJobsResponse.next_page_token|ListBatchPredictionJobsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1beta1.JobService.ListBatchPredictionJobs|JobService.ListBatchPredictionJobs} call. + * {@link google.cloud.aiplatform.v1beta1.ListBatchPredictionJobsResponse.next_page_token|ListBatchPredictionJobsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1beta1.JobService.ListBatchPredictionJobs|JobService.ListBatchPredictionJobs} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] @@ -5211,8 +5272,10 @@ export class JobServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListBatchPredictionJobsResponse.next_page_token|ListBatchPredictionJobsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1beta1.JobService.ListBatchPredictionJobs|JobService.ListBatchPredictionJobs} call. + * {@link google.cloud.aiplatform.v1beta1.ListBatchPredictionJobsResponse.next_page_token|ListBatchPredictionJobsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1beta1.JobService.ListBatchPredictionJobs|JobService.ListBatchPredictionJobs} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] diff --git a/packages/google-cloud-aiplatform/src/v1beta1/metadata_service_client.ts b/packages/google-cloud-aiplatform/src/v1beta1/metadata_service_client.ts index 5051851910d..558e262b0c3 100644 --- a/packages/google-cloud-aiplatform/src/v1beta1/metadata_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1beta1/metadata_service_client.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -560,6 +560,9 @@ export class MetadataServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}:cancel', }, + { + post: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}:cancel', + }, { post: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}:cancel', }, @@ -572,6 +575,9 @@ export class MetadataServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}:cancel', }, + { + post: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}:cancel', + }, { post: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}:cancel', }, @@ -787,6 +793,10 @@ export class MetadataServiceClient { delete: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}', }, + { + delete: + '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}', + }, { delete: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}', @@ -803,6 +813,10 @@ export class MetadataServiceClient { delete: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}', }, + { + delete: + '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}', + }, { delete: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}', @@ -970,6 +984,9 @@ export class MetadataServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}', }, + { + get: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}', + }, { get: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}', }, @@ -982,6 +999,9 @@ export class MetadataServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}', }, + { + get: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}', + }, { get: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}', }, @@ -1135,6 +1155,9 @@ export class MetadataServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*}/operations', }, + { + get: '/v1beta1/{name=projects/*/locations/*/persistentResources/*}/operations', + }, { get: '/v1beta1/{name=projects/*/locations/*/studies/*}/operations', }, @@ -1147,6 +1170,9 @@ export class MetadataServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*}/operations', }, + { + get: '/v1beta1/{name=projects/*/locations/*/schedules/*}/operations', + }, { get: '/v1beta1/{name=projects/*/locations/*/specialistPools/*}/operations', }, @@ -1316,6 +1342,9 @@ export class MetadataServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}:wait', }, + { + post: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}:wait', + }, { post: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}:wait', }, @@ -1328,6 +1357,9 @@ export class MetadataServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}:wait', }, + { + post: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}:wait', + }, { post: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}:wait', }, @@ -1913,16 +1945,17 @@ export class MetadataServiceClient { * The request object that will be sent. * @param {google.cloud.aiplatform.v1beta1.Artifact} request.artifact * Required. The Artifact containing updates. - * The Artifact's {@link google.cloud.aiplatform.v1beta1.Artifact.name|Artifact.name} field is used to identify the Artifact to - * be updated. - * Format: + * The Artifact's + * {@link google.cloud.aiplatform.v1beta1.Artifact.name|Artifact.name} field is + * used to identify the Artifact to be updated. Format: * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` * @param {google.protobuf.FieldMask} [request.updateMask] * Optional. A FieldMask indicating which fields should be updated. * Functionality of this field is not yet supported. * @param {boolean} request.allowMissing - * If set to true, and the {@link google.cloud.aiplatform.v1beta1.Artifact|Artifact} is not found, a new {@link google.cloud.aiplatform.v1beta1.Artifact|Artifact} is - * created. + * If set to true, and the + * {@link google.cloud.aiplatform.v1beta1.Artifact|Artifact} is not found, a new + * {@link google.cloud.aiplatform.v1beta1.Artifact|Artifact} is created. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -2013,9 +2046,8 @@ export class MetadataServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the MetadataStore where the Context should be - * created. - * Format: + * Required. The resource name of the MetadataStore where the Context should + * be created. Format: * `projects/{project}/locations/{location}/metadataStores/{metadatastore}` * @param {google.cloud.aiplatform.v1beta1.Context} request.context * Required. The Context to create. @@ -2211,15 +2243,15 @@ export class MetadataServiceClient { * The request object that will be sent. * @param {google.cloud.aiplatform.v1beta1.Context} request.context * Required. The Context containing updates. - * The Context's {@link google.cloud.aiplatform.v1beta1.Context.name|Context.name} field is used to identify the Context to be - * updated. - * Format: + * The Context's {@link google.cloud.aiplatform.v1beta1.Context.name|Context.name} + * field is used to identify the Context to be updated. Format: * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}` * @param {google.protobuf.FieldMask} [request.updateMask] * Optional. A FieldMask indicating which fields should be updated. * Functionality of this field is not yet supported. * @param {boolean} request.allowMissing - * If set to true, and the {@link google.cloud.aiplatform.v1beta1.Context|Context} is not found, a new {@link google.cloud.aiplatform.v1beta1.Context|Context} is + * If set to true, and the {@link google.cloud.aiplatform.v1beta1.Context|Context} + * is not found, a new {@link google.cloud.aiplatform.v1beta1.Context|Context} is * created. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. @@ -2313,9 +2345,8 @@ export class MetadataServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.context - * Required. The resource name of the Context that the Artifacts and Executions - * belong to. - * Format: + * Required. The resource name of the Context that the Artifacts and + * Executions belong to. Format: * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}` * @param {string[]} request.artifacts * The resource names of the Artifacts to attribute to the Context. @@ -2952,16 +2983,17 @@ export class MetadataServiceClient { * The request object that will be sent. * @param {google.cloud.aiplatform.v1beta1.Execution} request.execution * Required. The Execution containing updates. - * The Execution's {@link google.cloud.aiplatform.v1beta1.Execution.name|Execution.name} field is used to identify the Execution - * to be updated. - * Format: + * The Execution's + * {@link google.cloud.aiplatform.v1beta1.Execution.name|Execution.name} field is + * used to identify the Execution to be updated. Format: * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` * @param {google.protobuf.FieldMask} [request.updateMask] * Optional. A FieldMask indicating which fields should be updated. * Functionality of this field is not yet supported. * @param {boolean} request.allowMissing - * If set to true, and the {@link google.cloud.aiplatform.v1beta1.Execution|Execution} is not found, a new {@link google.cloud.aiplatform.v1beta1.Execution|Execution} - * is created. + * If set to true, and the + * {@link google.cloud.aiplatform.v1beta1.Execution|Execution} is not found, a new + * {@link google.cloud.aiplatform.v1beta1.Execution|Execution} is created. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -3165,9 +3197,8 @@ export class MetadataServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.execution - * Required. The resource name of the Execution whose input and output Artifacts should - * be retrieved as a LineageSubgraph. - * Format: + * Required. The resource name of the Execution whose input and output + * Artifacts should be retrieved as a LineageSubgraph. Format: * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. @@ -3269,9 +3300,8 @@ export class MetadataServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the MetadataStore where the MetadataSchema should - * be created. - * Format: + * Required. The resource name of the MetadataStore where the MetadataSchema + * should be created. Format: * `projects/{project}/locations/{location}/metadataStores/{metadatastore}` * @param {google.cloud.aiplatform.v1beta1.MetadataSchema} request.metadataSchema * Required. The MetadataSchema to create. @@ -3480,9 +3510,8 @@ export class MetadataServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.artifact - * Required. The resource name of the Artifact whose Lineage needs to be retrieved as a - * LineageSubgraph. - * Format: + * Required. The resource name of the Artifact whose Lineage needs to be + * retrieved as a LineageSubgraph. Format: * `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` * * The request may error with FAILED_PRECONDITION if the number of Artifacts, @@ -3513,7 +3542,8 @@ export class MetadataServiceClient { * For example: `metadata.field_1.number_value = 10.0` * * Each of the above supported filter types can be combined together using - * logical operators (`AND` & `OR`). + * logical operators (`AND` & `OR`). Maximum nested expression depth allowed + * is 5. * * For example: `display_name = "test" AND metadata.field1.bool_value = true`. * @param {object} [options] @@ -4796,8 +4826,8 @@ export class MetadataServiceClient { * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataStores|MetadataService.ListMetadataStores} call. Provide this to retrieve the - * subsequent page. + * {@link google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataStores|MetadataService.ListMetadataStores} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that * provided the page token. (Otherwise the request will fail with @@ -4904,8 +4934,8 @@ export class MetadataServiceClient { * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataStores|MetadataService.ListMetadataStores} call. Provide this to retrieve the - * subsequent page. + * {@link google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataStores|MetadataService.ListMetadataStores} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that * provided the page token. (Otherwise the request will fail with @@ -4960,8 +4990,8 @@ export class MetadataServiceClient { * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataStores|MetadataService.ListMetadataStores} call. Provide this to retrieve the - * subsequent page. + * {@link google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataStores|MetadataService.ListMetadataStores} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that * provided the page token. (Otherwise the request will fail with @@ -5013,7 +5043,8 @@ export class MetadataServiceClient { * The maximum number of Artifacts to return. The service may return fewer. * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken - * A page token, received from a previous {@link google.cloud.aiplatform.v1beta1.MetadataService.ListArtifacts|MetadataService.ListArtifacts} + * A page token, received from a previous + * {@link google.cloud.aiplatform.v1beta1.MetadataService.ListArtifacts|MetadataService.ListArtifacts} * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that @@ -5044,7 +5075,8 @@ export class MetadataServiceClient { * `in_context("projects//locations//metadataStores//contexts/")` * * Each of the above supported filter types can be combined together using - * logical operators (`AND` & `OR`). + * logical operators (`AND` & `OR`). Maximum nested expression depth allowed + * is 5. * * For example: `display_name = "test" AND metadata.field1.bool_value = true`. * @param {string} request.orderBy @@ -5154,7 +5186,8 @@ export class MetadataServiceClient { * The maximum number of Artifacts to return. The service may return fewer. * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken - * A page token, received from a previous {@link google.cloud.aiplatform.v1beta1.MetadataService.ListArtifacts|MetadataService.ListArtifacts} + * A page token, received from a previous + * {@link google.cloud.aiplatform.v1beta1.MetadataService.ListArtifacts|MetadataService.ListArtifacts} * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that @@ -5185,7 +5218,8 @@ export class MetadataServiceClient { * `in_context("projects//locations//metadataStores//contexts/")` * * Each of the above supported filter types can be combined together using - * logical operators (`AND` & `OR`). + * logical operators (`AND` & `OR`). Maximum nested expression depth allowed + * is 5. * * For example: `display_name = "test" AND metadata.field1.bool_value = true`. * @param {string} request.orderBy @@ -5243,7 +5277,8 @@ export class MetadataServiceClient { * The maximum number of Artifacts to return. The service may return fewer. * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken - * A page token, received from a previous {@link google.cloud.aiplatform.v1beta1.MetadataService.ListArtifacts|MetadataService.ListArtifacts} + * A page token, received from a previous + * {@link google.cloud.aiplatform.v1beta1.MetadataService.ListArtifacts|MetadataService.ListArtifacts} * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that @@ -5274,7 +5309,8 @@ export class MetadataServiceClient { * `in_context("projects//locations//metadataStores//contexts/")` * * Each of the above supported filter types can be combined together using - * logical operators (`AND` & `OR`). + * logical operators (`AND` & `OR`). Maximum nested expression depth allowed + * is 5. * * For example: `display_name = "test" AND metadata.field1.bool_value = true`. * @param {string} request.orderBy @@ -5331,7 +5367,8 @@ export class MetadataServiceClient { * The maximum number of Contexts to return. The service may return fewer. * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken - * A page token, received from a previous {@link google.cloud.aiplatform.v1beta1.MetadataService.ListContexts|MetadataService.ListContexts} + * A page token, received from a previous + * {@link google.cloud.aiplatform.v1beta1.MetadataService.ListContexts|MetadataService.ListContexts} * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that @@ -5366,7 +5403,8 @@ export class MetadataServiceClient { * ``` * * Each of the above supported filters can be combined together using - * logical operators (`AND` & `OR`). + * logical operators (`AND` & `OR`). Maximum nested expression depth allowed + * is 5. * * For example: `display_name = "test" AND metadata.field1.bool_value = true`. * @param {string} request.orderBy @@ -5476,7 +5514,8 @@ export class MetadataServiceClient { * The maximum number of Contexts to return. The service may return fewer. * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken - * A page token, received from a previous {@link google.cloud.aiplatform.v1beta1.MetadataService.ListContexts|MetadataService.ListContexts} + * A page token, received from a previous + * {@link google.cloud.aiplatform.v1beta1.MetadataService.ListContexts|MetadataService.ListContexts} * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that @@ -5511,7 +5550,8 @@ export class MetadataServiceClient { * ``` * * Each of the above supported filters can be combined together using - * logical operators (`AND` & `OR`). + * logical operators (`AND` & `OR`). Maximum nested expression depth allowed + * is 5. * * For example: `display_name = "test" AND metadata.field1.bool_value = true`. * @param {string} request.orderBy @@ -5569,7 +5609,8 @@ export class MetadataServiceClient { * The maximum number of Contexts to return. The service may return fewer. * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken - * A page token, received from a previous {@link google.cloud.aiplatform.v1beta1.MetadataService.ListContexts|MetadataService.ListContexts} + * A page token, received from a previous + * {@link google.cloud.aiplatform.v1beta1.MetadataService.ListContexts|MetadataService.ListContexts} * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that @@ -5604,7 +5645,8 @@ export class MetadataServiceClient { * ``` * * Each of the above supported filters can be combined together using - * logical operators (`AND` & `OR`). + * logical operators (`AND` & `OR`). Maximum nested expression depth allowed + * is 5. * * For example: `display_name = "test" AND metadata.field1.bool_value = true`. * @param {string} request.orderBy @@ -5661,7 +5703,8 @@ export class MetadataServiceClient { * The maximum number of Executions to return. The service may return fewer. * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken - * A page token, received from a previous {@link google.cloud.aiplatform.v1beta1.MetadataService.ListExecutions|MetadataService.ListExecutions} + * A page token, received from a previous + * {@link google.cloud.aiplatform.v1beta1.MetadataService.ListExecutions|MetadataService.ListExecutions} * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that @@ -5692,7 +5735,9 @@ export class MetadataServiceClient { * `in_context("projects//locations//metadataStores//contexts/")` * * Each of the above supported filters can be combined together using - * logical operators (`AND` & `OR`). + * logical operators (`AND` & `OR`). Maximum nested expression depth allowed + * is 5. + * * For example: `display_name = "test" AND metadata.field1.bool_value = true`. * @param {string} request.orderBy * How the list of messages is ordered. Specify the values to order by and an @@ -5801,7 +5846,8 @@ export class MetadataServiceClient { * The maximum number of Executions to return. The service may return fewer. * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken - * A page token, received from a previous {@link google.cloud.aiplatform.v1beta1.MetadataService.ListExecutions|MetadataService.ListExecutions} + * A page token, received from a previous + * {@link google.cloud.aiplatform.v1beta1.MetadataService.ListExecutions|MetadataService.ListExecutions} * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that @@ -5832,7 +5878,9 @@ export class MetadataServiceClient { * `in_context("projects//locations//metadataStores//contexts/")` * * Each of the above supported filters can be combined together using - * logical operators (`AND` & `OR`). + * logical operators (`AND` & `OR`). Maximum nested expression depth allowed + * is 5. + * * For example: `display_name = "test" AND metadata.field1.bool_value = true`. * @param {string} request.orderBy * How the list of messages is ordered. Specify the values to order by and an @@ -5889,7 +5937,8 @@ export class MetadataServiceClient { * The maximum number of Executions to return. The service may return fewer. * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken - * A page token, received from a previous {@link google.cloud.aiplatform.v1beta1.MetadataService.ListExecutions|MetadataService.ListExecutions} + * A page token, received from a previous + * {@link google.cloud.aiplatform.v1beta1.MetadataService.ListExecutions|MetadataService.ListExecutions} * call. Provide this to retrieve the subsequent page. * * When paginating, all other provided parameters must match the call that @@ -5920,7 +5969,9 @@ export class MetadataServiceClient { * `in_context("projects//locations//metadataStores//contexts/")` * * Each of the above supported filters can be combined together using - * logical operators (`AND` & `OR`). + * logical operators (`AND` & `OR`). Maximum nested expression depth allowed + * is 5. + * * For example: `display_name = "test" AND metadata.field1.bool_value = true`. * @param {string} request.orderBy * How the list of messages is ordered. Specify the values to order by and an @@ -5978,8 +6029,8 @@ export class MetadataServiceClient { * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataSchemas|MetadataService.ListMetadataSchemas} call. Provide this to retrieve the - * next page. + * {@link google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataSchemas|MetadataService.ListMetadataSchemas} + * call. Provide this to retrieve the next page. * * When paginating, all other provided parameters must match the call that * provided the page token. (Otherwise the request will fail with @@ -6088,8 +6139,8 @@ export class MetadataServiceClient { * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataSchemas|MetadataService.ListMetadataSchemas} call. Provide this to retrieve the - * next page. + * {@link google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataSchemas|MetadataService.ListMetadataSchemas} + * call. Provide this to retrieve the next page. * * When paginating, all other provided parameters must match the call that * provided the page token. (Otherwise the request will fail with @@ -6146,8 +6197,8 @@ export class MetadataServiceClient { * Must be in range 1-1000, inclusive. Defaults to 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataSchemas|MetadataService.ListMetadataSchemas} call. Provide this to retrieve the - * next page. + * {@link google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataSchemas|MetadataService.ListMetadataSchemas} + * call. Provide this to retrieve the next page. * * When paginating, all other provided parameters must match the call that * provided the page token. (Otherwise the request will fail with diff --git a/packages/google-cloud-aiplatform/src/v1beta1/migration_service_client.ts b/packages/google-cloud-aiplatform/src/v1beta1/migration_service_client.ts index 9d7e5ca1414..c14264c57a5 100644 --- a/packages/google-cloud-aiplatform/src/v1beta1/migration_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1beta1/migration_service_client.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -538,6 +538,9 @@ export class MigrationServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}:cancel', }, + { + post: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}:cancel', + }, { post: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}:cancel', }, @@ -550,6 +553,9 @@ export class MigrationServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}:cancel', }, + { + post: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}:cancel', + }, { post: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}:cancel', }, @@ -765,6 +771,10 @@ export class MigrationServiceClient { delete: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}', }, + { + delete: + '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}', + }, { delete: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}', @@ -781,6 +791,10 @@ export class MigrationServiceClient { delete: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}', }, + { + delete: + '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}', + }, { delete: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}', @@ -948,6 +962,9 @@ export class MigrationServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}', }, + { + get: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}', + }, { get: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}', }, @@ -960,6 +977,9 @@ export class MigrationServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}', }, + { + get: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}', + }, { get: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}', }, @@ -1113,6 +1133,9 @@ export class MigrationServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*}/operations', }, + { + get: '/v1beta1/{name=projects/*/locations/*/persistentResources/*}/operations', + }, { get: '/v1beta1/{name=projects/*/locations/*/studies/*}/operations', }, @@ -1125,6 +1148,9 @@ export class MigrationServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*}/operations', }, + { + get: '/v1beta1/{name=projects/*/locations/*/schedules/*}/operations', + }, { get: '/v1beta1/{name=projects/*/locations/*/specialistPools/*}/operations', }, @@ -1294,6 +1320,9 @@ export class MigrationServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}:wait', }, + { + post: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}:wait', + }, { post: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}:wait', }, @@ -1306,6 +1335,9 @@ export class MigrationServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}:wait', }, + { + post: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}:wait', + }, { post: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}:wait', }, @@ -1637,10 +1669,9 @@ export class MigrationServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The location that the migratable resources should be searched from. - * It's the Vertex AI location that the resources can be migrated to, not - * the resources' original location. - * Format: + * Required. The location that the migratable resources should be searched + * from. It's the Vertex AI location that the resources can be migrated to, + * not the resources' original location. Format: * `projects/{project}/locations/{location}` * @param {number} request.pageSize * The standard page size. @@ -1651,7 +1682,8 @@ export class MigrationServiceClient { * A filter for your search. You can use the following types of filters: * * * Resource type filters. The following strings filter for a specific type - * of {@link google.cloud.aiplatform.v1beta1.MigratableResource|MigratableResource}: + * of + * {@link google.cloud.aiplatform.v1beta1.MigratableResource|MigratableResource}: * * `ml_engine_model_version:*` * * `automl_model:*` * * `automl_dataset:*` @@ -1757,10 +1789,9 @@ export class MigrationServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The location that the migratable resources should be searched from. - * It's the Vertex AI location that the resources can be migrated to, not - * the resources' original location. - * Format: + * Required. The location that the migratable resources should be searched + * from. It's the Vertex AI location that the resources can be migrated to, + * not the resources' original location. Format: * `projects/{project}/locations/{location}` * @param {number} request.pageSize * The standard page size. @@ -1771,7 +1802,8 @@ export class MigrationServiceClient { * A filter for your search. You can use the following types of filters: * * * Resource type filters. The following strings filter for a specific type - * of {@link google.cloud.aiplatform.v1beta1.MigratableResource|MigratableResource}: + * of + * {@link google.cloud.aiplatform.v1beta1.MigratableResource|MigratableResource}: * * `ml_engine_model_version:*` * * `automl_model:*` * * `automl_dataset:*` @@ -1821,10 +1853,9 @@ export class MigrationServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The location that the migratable resources should be searched from. - * It's the Vertex AI location that the resources can be migrated to, not - * the resources' original location. - * Format: + * Required. The location that the migratable resources should be searched + * from. It's the Vertex AI location that the resources can be migrated to, + * not the resources' original location. Format: * `projects/{project}/locations/{location}` * @param {number} request.pageSize * The standard page size. @@ -1835,7 +1866,8 @@ export class MigrationServiceClient { * A filter for your search. You can use the following types of filters: * * * Resource type filters. The following strings filter for a specific type - * of {@link google.cloud.aiplatform.v1beta1.MigratableResource|MigratableResource}: + * of + * {@link google.cloud.aiplatform.v1beta1.MigratableResource|MigratableResource}: * * `ml_engine_model_version:*` * * `automl_model:*` * * `automl_dataset:*` diff --git a/packages/google-cloud-aiplatform/src/v1beta1/model_service_client.ts b/packages/google-cloud-aiplatform/src/v1beta1/model_service_client.ts index a89bb9fd978..e1836c8ebee 100644 --- a/packages/google-cloud-aiplatform/src/v1beta1/model_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1beta1/model_service_client.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -552,6 +552,9 @@ export class ModelServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}:cancel', }, + { + post: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}:cancel', + }, { post: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}:cancel', }, @@ -564,6 +567,9 @@ export class ModelServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}:cancel', }, + { + post: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}:cancel', + }, { post: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}:cancel', }, @@ -779,6 +785,10 @@ export class ModelServiceClient { delete: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}', }, + { + delete: + '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}', + }, { delete: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}', @@ -795,6 +805,10 @@ export class ModelServiceClient { delete: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}', }, + { + delete: + '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}', + }, { delete: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}', @@ -962,6 +976,9 @@ export class ModelServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}', }, + { + get: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}', + }, { get: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}', }, @@ -974,6 +991,9 @@ export class ModelServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}', }, + { + get: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}', + }, { get: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}', }, @@ -1127,6 +1147,9 @@ export class ModelServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*}/operations', }, + { + get: '/v1beta1/{name=projects/*/locations/*/persistentResources/*}/operations', + }, { get: '/v1beta1/{name=projects/*/locations/*/studies/*}/operations', }, @@ -1139,6 +1162,9 @@ export class ModelServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*}/operations', }, + { + get: '/v1beta1/{name=projects/*/locations/*/schedules/*}/operations', + }, { get: '/v1beta1/{name=projects/*/locations/*/specialistPools/*}/operations', }, @@ -1308,6 +1334,9 @@ export class ModelServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}:wait', }, + { + post: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}:wait', + }, { post: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}:wait', }, @@ -1320,6 +1349,9 @@ export class ModelServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}:wait', }, + { + post: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}:wait', + }, { post: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}:wait', }, @@ -1685,7 +1717,8 @@ export class ModelServiceClient { * must update them separately. * @param {google.protobuf.FieldMask} request.updateMask * Required. The update mask applies to the resource. - * For the `FieldMask` definition, see {@link google.protobuf.FieldMask|google.protobuf.FieldMask}. + * For the `FieldMask` definition, see + * {@link google.protobuf.FieldMask|google.protobuf.FieldMask}. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -2300,8 +2333,8 @@ export class ModelServiceClient { * Required. The resource name of the Location into which to upload the Model. * Format: `projects/{project}/locations/{location}` * @param {string} [request.parentModel] - * Optional. The resource name of the model into which to upload the version. Only - * specify this field when uploading a new version. + * Optional. The resource name of the model into which to upload the version. + * Only specify this field when uploading a new version. * @param {string} [request.modelId] * Optional. The ID to use for the uploaded Model, which will become the final * component of the model resource name. @@ -2310,6 +2343,14 @@ export class ModelServiceClient { * `[a-z0-9_-]`. The first character cannot be a number or hyphen. * @param {google.cloud.aiplatform.v1beta1.Model} request.model * Required. The Model to create. + * @param {string} [request.serviceAccount] + * Optional. The user-provided custom service account to use to do the model + * upload. If empty, [Vertex AI Service + * Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) + * will be used. Users uploading the Model must have the + * `iam.serviceAccounts.actAs` permission on this service account. Also, this + * account must belong to the project specified in the `parent` field and have + * all necessary read permissions. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -2589,9 +2630,12 @@ export class ModelServiceClient { /** * Deletes a Model. * - * A model cannot be deleted if any {@link google.cloud.aiplatform.v1beta1.Endpoint|Endpoint} resource has a - * {@link google.cloud.aiplatform.v1beta1.DeployedModel|DeployedModel} based on the model in its - * {@link google.cloud.aiplatform.v1beta1.Endpoint.deployed_models|deployed_models} field. + * A model cannot be deleted if any + * {@link google.cloud.aiplatform.v1beta1.Endpoint|Endpoint} resource has a + * {@link google.cloud.aiplatform.v1beta1.DeployedModel|DeployedModel} based on the + * model in its + * {@link google.cloud.aiplatform.v1beta1.Endpoint.deployed_models|deployed_models} + * field. * * @param {Object} request * The request object that will be sent. @@ -2734,13 +2778,14 @@ export class ModelServiceClient { * * Model version can only be deleted if there are no {@link |DeployedModels} * created from it. Deleting the only version in the Model is not allowed. Use - * {@link google.cloud.aiplatform.v1beta1.ModelService.DeleteModel|DeleteModel} for deleting the Model instead. + * {@link google.cloud.aiplatform.v1beta1.ModelService.DeleteModel|DeleteModel} for + * deleting the Model instead. * * @param {Object} request * The request object that will be sent. * @param {string} request.name - * Required. The name of the model version to be deleted, with a version ID explicitly - * included. + * Required. The name of the model version to be deleted, with a version ID + * explicitly included. * * Example: `projects/{project}/locations/{location}/models/{model}@1234` * @param {object} [options] @@ -2877,7 +2922,8 @@ export class ModelServiceClient { /** * 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 - * {@link google.cloud.aiplatform.v1beta1.Model.supported_export_formats|supported export format}. + * [supported export + * format][google.cloud.aiplatform.v1beta1.Model.supported_export_formats]. * * @param {Object} request * The request object that will be sent. @@ -3031,7 +3077,8 @@ export class ModelServiceClient { * both snake_case and camelCase are supported. * * * `model` supports = and !=. `model` represents the Model ID, - * i.e. the last segment of the Model's {@link google.cloud.aiplatform.v1beta1.Model.name|resource name}. + * i.e. the last segment of the Model's [resource + * name][google.cloud.aiplatform.v1beta1.Model.name]. * * `display_name` supports = and != * * `labels` supports general map functions that is: * * `labels.key=value` - key:value equality @@ -3048,8 +3095,10 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListModelsResponse.next_page_token|ListModelsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1beta1.ModelService.ListModels|ModelService.ListModels} call. + * {@link google.cloud.aiplatform.v1beta1.ListModelsResponse.next_page_token|ListModelsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1beta1.ModelService.ListModels|ModelService.ListModels} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] @@ -3152,7 +3201,8 @@ export class ModelServiceClient { * both snake_case and camelCase are supported. * * * `model` supports = and !=. `model` represents the Model ID, - * i.e. the last segment of the Model's {@link google.cloud.aiplatform.v1beta1.Model.name|resource name}. + * i.e. the last segment of the Model's [resource + * name][google.cloud.aiplatform.v1beta1.Model.name]. * * `display_name` supports = and != * * `labels` supports general map functions that is: * * `labels.key=value` - key:value equality @@ -3169,8 +3219,10 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListModelsResponse.next_page_token|ListModelsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1beta1.ModelService.ListModels|ModelService.ListModels} call. + * {@link google.cloud.aiplatform.v1beta1.ListModelsResponse.next_page_token|ListModelsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1beta1.ModelService.ListModels|ModelService.ListModels} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] @@ -3221,7 +3273,8 @@ export class ModelServiceClient { * both snake_case and camelCase are supported. * * * `model` supports = and !=. `model` represents the Model ID, - * i.e. the last segment of the Model's {@link google.cloud.aiplatform.v1beta1.Model.name|resource name}. + * i.e. the last segment of the Model's [resource + * name][google.cloud.aiplatform.v1beta1.Model.name]. * * `display_name` supports = and != * * `labels` supports general map functions that is: * * `labels.key=value` - key:value equality @@ -3238,8 +3291,10 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListModelsResponse.next_page_token|ListModelsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1beta1.ModelService.ListModels|ModelService.ListModels} call. + * {@link google.cloud.aiplatform.v1beta1.ListModelsResponse.next_page_token|ListModelsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1beta1.ModelService.ListModels|ModelService.ListModels} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] @@ -3288,8 +3343,8 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListModelVersionsResponse.next_page_token|ListModelVersionsResponse.next_page_token} of the previous - * {@link |ModelService.ListModelversions} call. + * {@link google.cloud.aiplatform.v1beta1.ListModelVersionsResponse.next_page_token|ListModelVersionsResponse.next_page_token} + * of the previous {@link |ModelService.ListModelversions} call. * @param {string} request.filter * An expression for filtering the results of the request. For field names * both snake_case and camelCase are supported. @@ -3304,6 +3359,15 @@ export class ModelServiceClient { * * `labels.myKey="myValue"` * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. + * @param {string} request.orderBy + * A comma-separated list of fields to order by, sorted in ascending order. + * Use "desc" after a field name for descending. + * Supported fields: + * + * * `create_time` + * * `update_time` + * + * Example: `update_time asc, create_time desc`. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -3403,8 +3467,8 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListModelVersionsResponse.next_page_token|ListModelVersionsResponse.next_page_token} of the previous - * {@link |ModelService.ListModelversions} call. + * {@link google.cloud.aiplatform.v1beta1.ListModelVersionsResponse.next_page_token|ListModelVersionsResponse.next_page_token} + * of the previous {@link |ModelService.ListModelversions} call. * @param {string} request.filter * An expression for filtering the results of the request. For field names * both snake_case and camelCase are supported. @@ -3419,6 +3483,15 @@ export class ModelServiceClient { * * `labels.myKey="myValue"` * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. + * @param {string} request.orderBy + * A comma-separated list of fields to order by, sorted in ascending order. + * Use "desc" after a field name for descending. + * Supported fields: + * + * * `create_time` + * * `update_time` + * + * Example: `update_time asc, create_time desc`. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} @@ -3466,8 +3539,8 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListModelVersionsResponse.next_page_token|ListModelVersionsResponse.next_page_token} of the previous - * {@link |ModelService.ListModelversions} call. + * {@link google.cloud.aiplatform.v1beta1.ListModelVersionsResponse.next_page_token|ListModelVersionsResponse.next_page_token} + * of the previous {@link |ModelService.ListModelversions} call. * @param {string} request.filter * An expression for filtering the results of the request. For field names * both snake_case and camelCase are supported. @@ -3482,6 +3555,15 @@ export class ModelServiceClient { * * `labels.myKey="myValue"` * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. + * @param {string} request.orderBy + * A comma-separated list of fields to order by, sorted in ascending order. + * Use "desc" after a field name for descending. + * Supported fields: + * + * * `create_time` + * * `update_time` + * + * Example: `update_time asc, create_time desc`. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} @@ -3531,8 +3613,10 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListModelEvaluationsResponse.next_page_token|ListModelEvaluationsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluations|ModelService.ListModelEvaluations} call. + * {@link google.cloud.aiplatform.v1beta1.ListModelEvaluationsResponse.next_page_token|ListModelEvaluationsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluations|ModelService.ListModelEvaluations} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] @@ -3637,8 +3721,10 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListModelEvaluationsResponse.next_page_token|ListModelEvaluationsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluations|ModelService.ListModelEvaluations} call. + * {@link google.cloud.aiplatform.v1beta1.ListModelEvaluationsResponse.next_page_token|ListModelEvaluationsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluations|ModelService.ListModelEvaluations} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] @@ -3691,8 +3777,10 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListModelEvaluationsResponse.next_page_token|ListModelEvaluationsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluations|ModelService.ListModelEvaluations} call. + * {@link google.cloud.aiplatform.v1beta1.ListModelEvaluationsResponse.next_page_token|ListModelEvaluationsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluations|ModelService.ListModelEvaluations} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] @@ -3735,8 +3823,8 @@ export class ModelServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the ModelEvaluation to list the ModelEvaluationSlices - * from. Format: + * Required. The resource name of the ModelEvaluation to list the + * ModelEvaluationSlices from. Format: * `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}` * @param {string} request.filter * The standard list filter. @@ -3747,8 +3835,10 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListModelEvaluationSlicesResponse.next_page_token|ListModelEvaluationSlicesResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluationSlices|ModelService.ListModelEvaluationSlices} call. + * {@link google.cloud.aiplatform.v1beta1.ListModelEvaluationSlicesResponse.next_page_token|ListModelEvaluationSlicesResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluationSlices|ModelService.ListModelEvaluationSlices} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] @@ -3848,8 +3938,8 @@ export class ModelServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the ModelEvaluation to list the ModelEvaluationSlices - * from. Format: + * Required. The resource name of the ModelEvaluation to list the + * ModelEvaluationSlices from. Format: * `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}` * @param {string} request.filter * The standard list filter. @@ -3860,8 +3950,10 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListModelEvaluationSlicesResponse.next_page_token|ListModelEvaluationSlicesResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluationSlices|ModelService.ListModelEvaluationSlices} call. + * {@link google.cloud.aiplatform.v1beta1.ListModelEvaluationSlicesResponse.next_page_token|ListModelEvaluationSlicesResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluationSlices|ModelService.ListModelEvaluationSlices} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] @@ -3905,8 +3997,8 @@ export class ModelServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the ModelEvaluation to list the ModelEvaluationSlices - * from. Format: + * Required. The resource name of the ModelEvaluation to list the + * ModelEvaluationSlices from. Format: * `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}` * @param {string} request.filter * The standard list filter. @@ -3917,8 +4009,10 @@ export class ModelServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListModelEvaluationSlicesResponse.next_page_token|ListModelEvaluationSlicesResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluationSlices|ModelService.ListModelEvaluationSlices} call. + * {@link google.cloud.aiplatform.v1beta1.ListModelEvaluationSlicesResponse.next_page_token|ListModelEvaluationSlicesResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluationSlices|ModelService.ListModelEvaluationSlices} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] diff --git a/packages/google-cloud-aiplatform/src/v1beta1/pipeline_service_client.ts b/packages/google-cloud-aiplatform/src/v1beta1/pipeline_service_client.ts index 87f21a5dbf4..66d925df593 100644 --- a/packages/google-cloud-aiplatform/src/v1beta1/pipeline_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1beta1/pipeline_service_client.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -544,6 +544,9 @@ export class PipelineServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}:cancel', }, + { + post: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}:cancel', + }, { post: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}:cancel', }, @@ -556,6 +559,9 @@ export class PipelineServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}:cancel', }, + { + post: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}:cancel', + }, { post: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}:cancel', }, @@ -771,6 +777,10 @@ export class PipelineServiceClient { delete: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}', }, + { + delete: + '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}', + }, { delete: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}', @@ -787,6 +797,10 @@ export class PipelineServiceClient { delete: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}', }, + { + delete: + '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}', + }, { delete: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}', @@ -954,6 +968,9 @@ export class PipelineServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}', }, + { + get: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}', + }, { get: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}', }, @@ -966,6 +983,9 @@ export class PipelineServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}', }, + { + get: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}', + }, { get: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}', }, @@ -1119,6 +1139,9 @@ export class PipelineServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*}/operations', }, + { + get: '/v1beta1/{name=projects/*/locations/*/persistentResources/*}/operations', + }, { get: '/v1beta1/{name=projects/*/locations/*/studies/*}/operations', }, @@ -1131,6 +1154,9 @@ export class PipelineServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*}/operations', }, + { + get: '/v1beta1/{name=projects/*/locations/*/schedules/*}/operations', + }, { get: '/v1beta1/{name=projects/*/locations/*/specialistPools/*}/operations', }, @@ -1300,6 +1326,9 @@ export class PipelineServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}:wait', }, + { + post: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}:wait', + }, { post: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}:wait', }, @@ -1312,6 +1341,9 @@ export class PipelineServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}:wait', }, + { + post: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}:wait', + }, { post: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}:wait', }, @@ -1517,8 +1549,8 @@ export class PipelineServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the Location to create the TrainingPipeline in. - * Format: `projects/{project}/locations/{location}` + * Required. The resource name of the Location to create the TrainingPipeline + * in. Format: `projects/{project}/locations/{location}` * @param {google.cloud.aiplatform.v1beta1.TrainingPipeline} request.trainingPipeline * Required. The TrainingPipeline to create. * @param {object} [options] @@ -1718,13 +1750,17 @@ export class PipelineServiceClient { * 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 {@link google.cloud.aiplatform.v1beta1.PipelineService.GetTrainingPipeline|PipelineService.GetTrainingPipeline} or - * other methods to check whether the cancellation succeeded or whether the + * guaranteed. Clients can use + * {@link google.cloud.aiplatform.v1beta1.PipelineService.GetTrainingPipeline|PipelineService.GetTrainingPipeline} + * or other methods to check whether the cancellation succeeded or whether the * pipeline completed despite cancellation. On successful cancellation, * the TrainingPipeline is not deleted; instead it becomes a pipeline with - * a {@link google.cloud.aiplatform.v1beta1.TrainingPipeline.error|TrainingPipeline.error} value with a {@link google.rpc.Status.code|google.rpc.Status.code} of 1, - * corresponding to `Code.CANCELLED`, and {@link google.cloud.aiplatform.v1beta1.TrainingPipeline.state|TrainingPipeline.state} is set to - * `CANCELLED`. + * a + * {@link google.cloud.aiplatform.v1beta1.TrainingPipeline.error|TrainingPipeline.error} + * value with a {@link google.rpc.Status.code|google.rpc.Status.code} of 1, + * corresponding to `Code.CANCELLED`, and + * {@link google.cloud.aiplatform.v1beta1.TrainingPipeline.state|TrainingPipeline.state} + * is set to `CANCELLED`. * * @param {Object} request * The request object that will be sent. @@ -2030,13 +2066,16 @@ export class PipelineServiceClient { * 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 {@link google.cloud.aiplatform.v1beta1.PipelineService.GetPipelineJob|PipelineService.GetPipelineJob} or - * other methods to check whether the cancellation succeeded or whether the + * guaranteed. Clients can use + * {@link google.cloud.aiplatform.v1beta1.PipelineService.GetPipelineJob|PipelineService.GetPipelineJob} + * or other methods to check whether the cancellation succeeded or whether the * pipeline completed despite cancellation. On successful cancellation, * the PipelineJob is not deleted; instead it becomes a pipeline with - * a {@link google.cloud.aiplatform.v1beta1.PipelineJob.error|PipelineJob.error} value with a {@link google.rpc.Status.code|google.rpc.Status.code} of 1, - * corresponding to `Code.CANCELLED`, and {@link google.cloud.aiplatform.v1beta1.PipelineJob.state|PipelineJob.state} is set to - * `CANCELLED`. + * a {@link google.cloud.aiplatform.v1beta1.PipelineJob.error|PipelineJob.error} + * value with a {@link google.rpc.Status.code|google.rpc.Status.code} of 1, + * corresponding to `Code.CANCELLED`, and + * {@link google.cloud.aiplatform.v1beta1.PipelineJob.state|PipelineJob.state} is + * set to `CANCELLED`. * * @param {Object} request * The request object that will be sent. @@ -2425,8 +2464,8 @@ export class PipelineServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the Location to list the TrainingPipelines from. - * Format: `projects/{project}/locations/{location}` + * Required. The resource name of the Location to list the TrainingPipelines + * from. Format: `projects/{project}/locations/{location}` * @param {string} request.filter * The standard list filter. * @@ -2453,8 +2492,10 @@ export class PipelineServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListTrainingPipelinesResponse.next_page_token|ListTrainingPipelinesResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1beta1.PipelineService.ListTrainingPipelines|PipelineService.ListTrainingPipelines} call. + * {@link google.cloud.aiplatform.v1beta1.ListTrainingPipelinesResponse.next_page_token|ListTrainingPipelinesResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1beta1.PipelineService.ListTrainingPipelines|PipelineService.ListTrainingPipelines} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] @@ -2550,8 +2591,8 @@ export class PipelineServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the Location to list the TrainingPipelines from. - * Format: `projects/{project}/locations/{location}` + * Required. The resource name of the Location to list the TrainingPipelines + * from. Format: `projects/{project}/locations/{location}` * @param {string} request.filter * The standard list filter. * @@ -2578,8 +2619,10 @@ export class PipelineServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListTrainingPipelinesResponse.next_page_token|ListTrainingPipelinesResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1beta1.PipelineService.ListTrainingPipelines|PipelineService.ListTrainingPipelines} call. + * {@link google.cloud.aiplatform.v1beta1.ListTrainingPipelinesResponse.next_page_token|ListTrainingPipelinesResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1beta1.PipelineService.ListTrainingPipelines|PipelineService.ListTrainingPipelines} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] @@ -2623,8 +2666,8 @@ export class PipelineServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the Location to list the TrainingPipelines from. - * Format: `projects/{project}/locations/{location}` + * Required. The resource name of the Location to list the TrainingPipelines + * from. Format: `projects/{project}/locations/{location}` * @param {string} request.filter * The standard list filter. * @@ -2651,8 +2694,10 @@ export class PipelineServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListTrainingPipelinesResponse.next_page_token|ListTrainingPipelinesResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1beta1.PipelineService.ListTrainingPipelines|PipelineService.ListTrainingPipelines} call. + * {@link google.cloud.aiplatform.v1beta1.ListTrainingPipelinesResponse.next_page_token|ListTrainingPipelinesResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1beta1.PipelineService.ListTrainingPipelines|PipelineService.ListTrainingPipelines} + * call. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * @param {object} [options] @@ -2737,8 +2782,10 @@ export class PipelineServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListPipelineJobsResponse.next_page_token|ListPipelineJobsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1beta1.PipelineService.ListPipelineJobs|PipelineService.ListPipelineJobs} call. + * {@link google.cloud.aiplatform.v1beta1.ListPipelineJobsResponse.next_page_token|ListPipelineJobsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1beta1.PipelineService.ListPipelineJobs|PipelineService.ListPipelineJobs} + * call. * @param {string} request.orderBy * A comma-separated list of fields to order by. The default sort order is in * ascending order. Use "desc" after a field name for descending. You can have @@ -2890,8 +2937,10 @@ export class PipelineServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListPipelineJobsResponse.next_page_token|ListPipelineJobsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1beta1.PipelineService.ListPipelineJobs|PipelineService.ListPipelineJobs} call. + * {@link google.cloud.aiplatform.v1beta1.ListPipelineJobsResponse.next_page_token|ListPipelineJobsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1beta1.PipelineService.ListPipelineJobs|PipelineService.ListPipelineJobs} + * call. * @param {string} request.orderBy * A comma-separated list of fields to order by. The default sort order is in * ascending order. Use "desc" after a field name for descending. You can have @@ -2991,8 +3040,10 @@ export class PipelineServiceClient { * @param {string} request.pageToken * The standard list page token. * Typically obtained via - * {@link google.cloud.aiplatform.v1beta1.ListPipelineJobsResponse.next_page_token|ListPipelineJobsResponse.next_page_token} of the previous - * {@link google.cloud.aiplatform.v1beta1.PipelineService.ListPipelineJobs|PipelineService.ListPipelineJobs} call. + * {@link google.cloud.aiplatform.v1beta1.ListPipelineJobsResponse.next_page_token|ListPipelineJobsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1beta1.PipelineService.ListPipelineJobs|PipelineService.ListPipelineJobs} + * call. * @param {string} request.orderBy * A comma-separated list of fields to order by. The default sort order is in * ascending order. Use "desc" after a field name for descending. You can have diff --git a/packages/google-cloud-aiplatform/src/v1beta1/prediction_service_client.ts b/packages/google-cloud-aiplatform/src/v1beta1/prediction_service_client.ts index bd10d22f02a..b4fc7c19446 100644 --- a/packages/google-cloud-aiplatform/src/v1beta1/prediction_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1beta1/prediction_service_client.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -439,12 +439,14 @@ export class PredictionServiceClient { * in case of AutoML Models, or, in case of customer created Models, the * behaviour is as documented by that Model. * The schema of any single instance may be specified via Endpoint's - * DeployedModels' {@link google.cloud.aiplatform.v1beta1.DeployedModel.model|Model's} + * DeployedModels' + * {@link google.cloud.aiplatform.v1beta1.DeployedModel.model|Model's} * {@link google.cloud.aiplatform.v1beta1.Model.predict_schemata|PredictSchemata's} * {@link google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri|instance_schema_uri}. * @param {google.protobuf.Value} request.parameters * The parameters that govern the prediction. The schema of the parameters may - * be specified via Endpoint's DeployedModels' {@link google.cloud.aiplatform.v1beta1.DeployedModel.model|Model's } + * be specified via Endpoint's DeployedModels' [Model's + * ][google.cloud.aiplatform.v1beta1.DeployedModel.model] * {@link google.cloud.aiplatform.v1beta1.Model.predict_schemata|PredictSchemata's} * {@link google.cloud.aiplatform.v1beta1.PredictSchemata.parameters_schema_uri|parameters_schema_uri}. * @param {object} [options] @@ -530,11 +532,13 @@ export class PredictionServiceClient { * * The response includes the following HTTP headers: * - * * `X-Vertex-AI-Endpoint-Id`: ID of the {@link google.cloud.aiplatform.v1beta1.Endpoint|Endpoint} that served this + * * `X-Vertex-AI-Endpoint-Id`: ID of the + * {@link google.cloud.aiplatform.v1beta1.Endpoint|Endpoint} that served this * prediction. * - * * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's {@link google.cloud.aiplatform.v1beta1.DeployedModel|DeployedModel} - * that served this prediction. + * * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's + * {@link google.cloud.aiplatform.v1beta1.DeployedModel|DeployedModel} that served + * this prediction. * * @param {Object} request * The request object that will be sent. @@ -545,17 +549,19 @@ export class PredictionServiceClient { * @param {google.api.HttpBody} request.httpBody * The prediction input. Supports HTTP headers and arbitrary data payload. * - * A {@link google.cloud.aiplatform.v1beta1.DeployedModel|DeployedModel} may have an upper limit on the number of instances it - * supports per request. When this limit it is exceeded for an AutoML model, - * the {@link google.cloud.aiplatform.v1beta1.PredictionService.RawPredict|RawPredict} method returns an error. - * When this limit is exceeded for a custom-trained model, the behavior varies - * depending on the model. + * A {@link google.cloud.aiplatform.v1beta1.DeployedModel|DeployedModel} may have + * an upper limit on the number of instances it supports per request. When + * this limit it is exceeded for an AutoML model, the + * {@link google.cloud.aiplatform.v1beta1.PredictionService.RawPredict|RawPredict} + * method returns an error. When this limit is exceeded for a custom-trained + * model, the behavior varies depending on the model. * * You can specify the schema for each instance in the * {@link google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri|predict_schemata.instance_schema_uri} - * field when you create a {@link google.cloud.aiplatform.v1beta1.Model|Model}. This schema applies when you deploy the - * `Model` as a `DeployedModel` to an {@link google.cloud.aiplatform.v1beta1.Endpoint|Endpoint} and use the `RawPredict` - * method. + * field when you create a {@link google.cloud.aiplatform.v1beta1.Model|Model}. + * This schema applies when you deploy the `Model` as a `DeployedModel` to an + * {@link google.cloud.aiplatform.v1beta1.Endpoint|Endpoint} and use the + * `RawPredict` method. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -643,10 +649,12 @@ export class PredictionServiceClient { /** * Perform an online explanation. * - * If {@link google.cloud.aiplatform.v1beta1.ExplainRequest.deployed_model_id|deployed_model_id} is specified, - * the corresponding DeployModel must have + * If + * {@link google.cloud.aiplatform.v1beta1.ExplainRequest.deployed_model_id|deployed_model_id} + * is specified, the corresponding DeployModel must have * {@link google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec|explanation_spec} - * populated. If {@link google.cloud.aiplatform.v1beta1.ExplainRequest.deployed_model_id|deployed_model_id} + * populated. If + * {@link google.cloud.aiplatform.v1beta1.ExplainRequest.deployed_model_id|deployed_model_id} * is not specified, all DeployedModels must have * {@link google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec|explanation_spec} * populated. Only deployed AutoML tabular Models have @@ -665,26 +673,29 @@ export class PredictionServiceClient { * in case of AutoML Models, or, in case of customer created Models, the * behaviour is as documented by that Model. * The schema of any single instance may be specified via Endpoint's - * DeployedModels' {@link google.cloud.aiplatform.v1beta1.DeployedModel.model|Model's} + * DeployedModels' + * {@link google.cloud.aiplatform.v1beta1.DeployedModel.model|Model's} * {@link google.cloud.aiplatform.v1beta1.Model.predict_schemata|PredictSchemata's} * {@link google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri|instance_schema_uri}. * @param {google.protobuf.Value} request.parameters * The parameters that govern the prediction. The schema of the parameters may - * be specified via Endpoint's DeployedModels' {@link google.cloud.aiplatform.v1beta1.DeployedModel.model|Model's } + * be specified via Endpoint's DeployedModels' [Model's + * ][google.cloud.aiplatform.v1beta1.DeployedModel.model] * {@link google.cloud.aiplatform.v1beta1.Model.predict_schemata|PredictSchemata's} * {@link google.cloud.aiplatform.v1beta1.PredictSchemata.parameters_schema_uri|parameters_schema_uri}. * @param {google.cloud.aiplatform.v1beta1.ExplanationSpecOverride} request.explanationSpecOverride * If specified, overrides the - * {@link google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec|explanation_spec} of the DeployedModel. - * Can be used for explaining prediction results with different - * configurations, such as: + * {@link google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec|explanation_spec} + * of the DeployedModel. Can be used for explaining prediction results with + * different configurations, such as: * - Explaining top-5 predictions results as opposed to top-1; * - Increasing path count or step count of the attribution methods to reduce * approximate errors; * - Using different baselines for explaining the prediction results. * @param {string} request.deployedModelId * If specified, this ExplainRequest will be served by the chosen - * DeployedModel, overriding {@link google.cloud.aiplatform.v1beta1.Endpoint.traffic_split|Endpoint.traffic_split}. + * DeployedModel, overriding + * {@link google.cloud.aiplatform.v1beta1.Endpoint.traffic_split|Endpoint.traffic_split}. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. diff --git a/packages/google-cloud-aiplatform/src/v1beta1/specialist_pool_service_client.ts b/packages/google-cloud-aiplatform/src/v1beta1/specialist_pool_service_client.ts index 2746d0121a3..3c442e2a31b 100644 --- a/packages/google-cloud-aiplatform/src/v1beta1/specialist_pool_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1beta1/specialist_pool_service_client.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -543,6 +543,9 @@ export class SpecialistPoolServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}:cancel', }, + { + post: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}:cancel', + }, { post: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}:cancel', }, @@ -555,6 +558,9 @@ export class SpecialistPoolServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}:cancel', }, + { + post: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}:cancel', + }, { post: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}:cancel', }, @@ -770,6 +776,10 @@ export class SpecialistPoolServiceClient { delete: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}', }, + { + delete: + '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}', + }, { delete: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}', @@ -786,6 +796,10 @@ export class SpecialistPoolServiceClient { delete: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}', }, + { + delete: + '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}', + }, { delete: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}', @@ -953,6 +967,9 @@ export class SpecialistPoolServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}', }, + { + get: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}', + }, { get: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}', }, @@ -965,6 +982,9 @@ export class SpecialistPoolServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}', }, + { + get: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}', + }, { get: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}', }, @@ -1118,6 +1138,9 @@ export class SpecialistPoolServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*}/operations', }, + { + get: '/v1beta1/{name=projects/*/locations/*/persistentResources/*}/operations', + }, { get: '/v1beta1/{name=projects/*/locations/*/studies/*}/operations', }, @@ -1130,6 +1153,9 @@ export class SpecialistPoolServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*}/operations', }, + { + get: '/v1beta1/{name=projects/*/locations/*/schedules/*}/operations', + }, { get: '/v1beta1/{name=projects/*/locations/*/specialistPools/*}/operations', }, @@ -1299,6 +1325,9 @@ export class SpecialistPoolServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}:wait', }, + { + post: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}:wait', + }, { post: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}:wait', }, @@ -1311,6 +1340,9 @@ export class SpecialistPoolServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}:wait', }, + { + post: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}:wait', + }, { post: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}:wait', }, @@ -2048,9 +2080,11 @@ export class SpecialistPoolServiceClient { * The standard list page size. * @param {string} request.pageToken * The standard list page token. - * Typically obtained by {@link google.cloud.aiplatform.v1beta1.ListSpecialistPoolsResponse.next_page_token|ListSpecialistPoolsResponse.next_page_token} of - * the previous {@link google.cloud.aiplatform.v1beta1.SpecialistPoolService.ListSpecialistPools|SpecialistPoolService.ListSpecialistPools} call. Return - * first page if empty. + * Typically obtained by + * {@link google.cloud.aiplatform.v1beta1.ListSpecialistPoolsResponse.next_page_token|ListSpecialistPoolsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1beta1.SpecialistPoolService.ListSpecialistPools|SpecialistPoolService.ListSpecialistPools} + * call. Return first page if empty. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. FieldMask represents a set of * @param {object} [options] @@ -2152,9 +2186,11 @@ export class SpecialistPoolServiceClient { * The standard list page size. * @param {string} request.pageToken * The standard list page token. - * Typically obtained by {@link google.cloud.aiplatform.v1beta1.ListSpecialistPoolsResponse.next_page_token|ListSpecialistPoolsResponse.next_page_token} of - * the previous {@link google.cloud.aiplatform.v1beta1.SpecialistPoolService.ListSpecialistPools|SpecialistPoolService.ListSpecialistPools} call. Return - * first page if empty. + * Typically obtained by + * {@link google.cloud.aiplatform.v1beta1.ListSpecialistPoolsResponse.next_page_token|ListSpecialistPoolsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1beta1.SpecialistPoolService.ListSpecialistPools|SpecialistPoolService.ListSpecialistPools} + * call. Return first page if empty. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. FieldMask represents a set of * @param {object} [options] @@ -2204,9 +2240,11 @@ export class SpecialistPoolServiceClient { * The standard list page size. * @param {string} request.pageToken * The standard list page token. - * Typically obtained by {@link google.cloud.aiplatform.v1beta1.ListSpecialistPoolsResponse.next_page_token|ListSpecialistPoolsResponse.next_page_token} of - * the previous {@link google.cloud.aiplatform.v1beta1.SpecialistPoolService.ListSpecialistPools|SpecialistPoolService.ListSpecialistPools} call. Return - * first page if empty. + * Typically obtained by + * {@link google.cloud.aiplatform.v1beta1.ListSpecialistPoolsResponse.next_page_token|ListSpecialistPoolsResponse.next_page_token} + * of the previous + * {@link google.cloud.aiplatform.v1beta1.SpecialistPoolService.ListSpecialistPools|SpecialistPoolService.ListSpecialistPools} + * call. Return first page if empty. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. FieldMask represents a set of * @param {object} [options] diff --git a/packages/google-cloud-aiplatform/src/v1beta1/tensorboard_service_client.ts b/packages/google-cloud-aiplatform/src/v1beta1/tensorboard_service_client.ts index beb5e659e5e..cbba2f5875f 100644 --- a/packages/google-cloud-aiplatform/src/v1beta1/tensorboard_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1beta1/tensorboard_service_client.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -569,6 +569,9 @@ export class TensorboardServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}:cancel', }, + { + post: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}:cancel', + }, { post: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}:cancel', }, @@ -581,6 +584,9 @@ export class TensorboardServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}:cancel', }, + { + post: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}:cancel', + }, { post: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}:cancel', }, @@ -796,6 +802,10 @@ export class TensorboardServiceClient { delete: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}', }, + { + delete: + '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}', + }, { delete: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}', @@ -812,6 +822,10 @@ export class TensorboardServiceClient { delete: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}', }, + { + delete: + '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}', + }, { delete: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}', @@ -979,6 +993,9 @@ export class TensorboardServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}', }, + { + get: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}', + }, { get: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}', }, @@ -991,6 +1008,9 @@ export class TensorboardServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}', }, + { + get: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}', + }, { get: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}', }, @@ -1144,6 +1164,9 @@ export class TensorboardServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*}/operations', }, + { + get: '/v1beta1/{name=projects/*/locations/*/persistentResources/*}/operations', + }, { get: '/v1beta1/{name=projects/*/locations/*/studies/*}/operations', }, @@ -1156,6 +1179,9 @@ export class TensorboardServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*}/operations', }, + { + get: '/v1beta1/{name=projects/*/locations/*/schedules/*}/operations', + }, { get: '/v1beta1/{name=projects/*/locations/*/specialistPools/*}/operations', }, @@ -1325,6 +1351,9 @@ export class TensorboardServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}:wait', }, + { + post: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}:wait', + }, { post: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}:wait', }, @@ -1337,6 +1366,9 @@ export class TensorboardServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}:wait', }, + { + post: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}:wait', + }, { post: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}:wait', }, @@ -1490,6 +1522,7 @@ export class TensorboardServiceClient { const tensorboardServiceStubMethods = [ 'createTensorboard', 'getTensorboard', + 'readTensorboardUsage', 'updateTensorboard', 'listTensorboards', 'deleteTensorboard', @@ -1708,20 +1741,119 @@ export class TensorboardServiceClient { this.initialize(); return this.innerApiCalls.getTensorboard(request, options, callback); } + /** + * Returns a list of monthly active users for a given TensorBoard instance. + * + * @param {Object} request + * The request object that will be sent. + * @param {string} request.tensorboard + * Required. The name of the Tensorboard resource. + * Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}` + * @param {object} [options] + * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. + * @returns {Promise} - The promise which resolves to an array. + * The first element of the array is an object representing [ReadTensorboardUsageResponse]{@link google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse}. + * Please see the + * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * for more details and examples. + * @example include:samples/generated/v1beta1/tensorboard_service.read_tensorboard_usage.js + * region_tag:aiplatform_v1beta1_generated_TensorboardService_ReadTensorboardUsage_async + */ + readTensorboardUsage( + request?: protos.google.cloud.aiplatform.v1beta1.IReadTensorboardUsageRequest, + options?: CallOptions + ): Promise< + [ + protos.google.cloud.aiplatform.v1beta1.IReadTensorboardUsageResponse, + ( + | protos.google.cloud.aiplatform.v1beta1.IReadTensorboardUsageRequest + | undefined + ), + {} | undefined + ] + >; + readTensorboardUsage( + request: protos.google.cloud.aiplatform.v1beta1.IReadTensorboardUsageRequest, + options: CallOptions, + callback: Callback< + protos.google.cloud.aiplatform.v1beta1.IReadTensorboardUsageResponse, + | protos.google.cloud.aiplatform.v1beta1.IReadTensorboardUsageRequest + | null + | undefined, + {} | null | undefined + > + ): void; + readTensorboardUsage( + request: protos.google.cloud.aiplatform.v1beta1.IReadTensorboardUsageRequest, + callback: Callback< + protos.google.cloud.aiplatform.v1beta1.IReadTensorboardUsageResponse, + | protos.google.cloud.aiplatform.v1beta1.IReadTensorboardUsageRequest + | null + | undefined, + {} | null | undefined + > + ): void; + readTensorboardUsage( + request?: protos.google.cloud.aiplatform.v1beta1.IReadTensorboardUsageRequest, + optionsOrCallback?: + | CallOptions + | Callback< + protos.google.cloud.aiplatform.v1beta1.IReadTensorboardUsageResponse, + | protos.google.cloud.aiplatform.v1beta1.IReadTensorboardUsageRequest + | null + | undefined, + {} | null | undefined + >, + callback?: Callback< + protos.google.cloud.aiplatform.v1beta1.IReadTensorboardUsageResponse, + | protos.google.cloud.aiplatform.v1beta1.IReadTensorboardUsageRequest + | null + | undefined, + {} | null | undefined + > + ): Promise< + [ + protos.google.cloud.aiplatform.v1beta1.IReadTensorboardUsageResponse, + ( + | protos.google.cloud.aiplatform.v1beta1.IReadTensorboardUsageRequest + | undefined + ), + {} | undefined + ] + > | void { + request = request || {}; + let options: CallOptions; + if (typeof optionsOrCallback === 'function' && callback === undefined) { + callback = optionsOrCallback; + options = {}; + } else { + options = optionsOrCallback as CallOptions; + } + options = options || {}; + options.otherArgs = options.otherArgs || {}; + options.otherArgs.headers = options.otherArgs.headers || {}; + options.otherArgs.headers['x-goog-request-params'] = + this._gaxModule.routingHeader.fromParams({ + tensorboard: request.tensorboard ?? '', + }); + this.initialize(); + return this.innerApiCalls.readTensorboardUsage(request, options, callback); + } /** * Creates a TensorboardExperiment. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the Tensorboard to create the TensorboardExperiment - * in. Format: + * Required. The resource name of the Tensorboard to create the + * TensorboardExperiment in. Format: * `projects/{project}/locations/{location}/tensorboards/{tensorboard}` * @param {google.cloud.aiplatform.v1beta1.TensorboardExperiment} request.tensorboardExperiment * The TensorboardExperiment to create. * @param {string} request.tensorboardExperimentId - * Required. The ID to use for the Tensorboard experiment, which will become the final - * component of the Tensorboard experiment's resource name. + * Required. The ID to use for the Tensorboard experiment, which becomes the + * final component of the Tensorboard experiment's resource name. * * This value should be 1-128 characters, and valid characters * are /{@link 0-9|a-z}-/. @@ -1931,8 +2063,8 @@ export class TensorboardServiceClient { * Required. Field mask is used to specify the fields to be overwritten in the * TensorboardExperiment resource by the update. * The fields specified in the update_mask are relative to the resource, not - * the full request. A field will be overwritten if it is in the mask. If the - * user does not provide a mask then all fields will be overwritten if new + * the full request. A field is overwritten if it's in the mask. If the + * user does not provide a mask then all fields are overwritten if new * values are specified. * @param {google.cloud.aiplatform.v1beta1.TensorboardExperiment} request.tensorboardExperiment * Required. The TensorboardExperiment's `name` field is used to identify the @@ -2039,13 +2171,13 @@ export class TensorboardServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the TensorboardExperiment to create the TensorboardRun - * in. Format: + * Required. The resource name of the TensorboardExperiment to create the + * TensorboardRun in. Format: * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` * @param {google.cloud.aiplatform.v1beta1.TensorboardRun} request.tensorboardRun * Required. The TensorboardRun to create. * @param {string} request.tensorboardRunId - * Required. The ID to use for the Tensorboard run, which will become the final + * Required. The ID to use for the Tensorboard run, which becomes the final * component of the Tensorboard run's resource name. * * This value should be 1-128 characters, and valid characters @@ -2356,12 +2488,12 @@ export class TensorboardServiceClient { * Required. Field mask is used to specify the fields to be overwritten in the * TensorboardRun resource by the update. * The fields specified in the update_mask are relative to the resource, not - * the full request. A field will be overwritten if it is in the mask. If the - * user does not provide a mask then all fields will be overwritten if new + * the full request. A field is overwritten if it's in the mask. If the + * user does not provide a mask then all fields are overwritten if new * values are specified. * @param {google.cloud.aiplatform.v1beta1.TensorboardRun} request.tensorboardRun - * Required. The TensorboardRun's `name` field is used to identify the TensorboardRun to - * be updated. Format: + * Required. The TensorboardRun's `name` field is used to identify the + * TensorboardRun to be updated. Format: * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. @@ -2467,8 +2599,8 @@ export class TensorboardServiceClient { * CreateTensorboardTimeSeriesRequest messages must be sub resources of this * TensorboardExperiment. * @param {number[]} request.requests - * Required. The request message specifying the TensorboardTimeSeries to create. - * A maximum of 1000 TensorboardTimeSeries can be created in a batch. + * Required. The request message specifying the TensorboardTimeSeries to + * create. A maximum of 1000 TensorboardTimeSeries can be created in a batch. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -2574,10 +2706,10 @@ export class TensorboardServiceClient { * Format: * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` * @param {string} [request.tensorboardTimeSeriesId] - * Optional. The user specified unique ID to use for the TensorboardTimeSeries, which - * will become the final component of the TensorboardTimeSeries's resource - * name. - * This value should match "{@link a-z0-9-|a-z0-9}{0, 127}" + * Optional. The user specified unique ID to use for the + * TensorboardTimeSeries, which becomes the final component of the + * TensorboardTimeSeries's resource name. This value should match + * "{@link a-z0-9-|a-z0-9}{0, 127}" * @param {google.cloud.aiplatform.v1beta1.TensorboardTimeSeries} request.tensorboardTimeSeries * Required. The TensorboardTimeSeries to create. * @param {object} [options] @@ -2786,8 +2918,8 @@ export class TensorboardServiceClient { * Required. Field mask is used to specify the fields to be overwritten in the * TensorboardTimeSeries resource by the update. * The fields specified in the update_mask are relative to the resource, not - * the full request. A field will be overwritten if it is in the mask. If the - * user does not provide a mask then all fields will be overwritten if new + * the full request. A field is overwritten if it's in the mask. If the + * user does not provide a mask then all fields are overwritten if new * values are specified. * @param {google.cloud.aiplatform.v1beta1.TensorboardTimeSeries} request.tensorboardTimeSeries * Required. The TensorboardTimeSeries' `name` field is used to identify the @@ -2892,20 +3024,22 @@ export class TensorboardServiceClient { /** * 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 + * data points stored is less than the limit, all data is returned. + * Otherwise, the number limit of data points is randomly selected from * this time series and returned. * * @param {Object} request * The request object that will be sent. * @param {string} request.tensorboard - * Required. The resource name of the Tensorboard containing TensorboardTimeSeries to - * read data from. Format: + * Required. The resource name of the Tensorboard containing + * TensorboardTimeSeries to read data from. Format: * `projects/{project}/locations/{location}/tensorboards/{tensorboard}`. - * The TensorboardTimeSeries referenced by {@link google.cloud.aiplatform.v1beta1.BatchReadTensorboardTimeSeriesDataRequest.time_series|time_series} must be sub - * resources of this Tensorboard. + * The TensorboardTimeSeries referenced by + * {@link google.cloud.aiplatform.v1beta1.BatchReadTensorboardTimeSeriesDataRequest.time_series|time_series} + * must be sub resources of this Tensorboard. * @param {string[]} request.timeSeries - * Required. The resource names of the TensorboardTimeSeries to read data from. Format: + * Required. The resource names of the TensorboardTimeSeries to read data + * from. Format: * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}` * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. @@ -3003,8 +3137,8 @@ export class TensorboardServiceClient { } /** * 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. + * points stored is less than 1000, all data is returned. Otherwise, 1000 + * data points is randomly selected from this time series and returned. * This value can be changed by changing max_data_points, which can't be * greater than 10k. * @@ -3117,8 +3251,7 @@ export class TensorboardServiceClient { } /** * Write time series data points of multiple TensorboardTimeSeries in multiple - * TensorboardRun's. If any data fail to be ingested, an error will be - * returned. + * TensorboardRun's. If any data fail to be ingested, an error is returned. * * @param {Object} request * The request object that will be sent. @@ -3224,8 +3357,7 @@ export class TensorboardServiceClient { } /** * Write time series data points into multiple TensorboardTimeSeries under - * a TensorboardRun. If any data fail to be ingested, an error will be - * returned. + * a TensorboardRun. If any data fail to be ingested, an error is returned. * * @param {Object} request * The request object that will be sent. @@ -3345,7 +3477,7 @@ export class TensorboardServiceClient { * @param {string} request.timeSeries * Required. The resource name of the TensorboardTimeSeries to list Blobs. * Format: - * 'projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}' + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}` * @param {string[]} request.blobIds * IDs of the blobs to read. * @param {object} [options] @@ -3524,8 +3656,8 @@ export class TensorboardServiceClient { * Required. Field mask is used to specify the fields to be overwritten in the * Tensorboard resource by the update. * The fields specified in the update_mask are relative to the resource, not - * the full request. A field will be overwritten if it is in the mask. If the - * user does not provide a mask then all fields will be overwritten if new + * the full request. A field is overwritten if it's in the mask. If the + * user does not provide a mask then all fields are overwritten if new * values are specified. * @param {google.cloud.aiplatform.v1beta1.Tensorboard} request.tensorboard * Required. The Tensorboard's `name` field is used to identify the @@ -4243,17 +4375,17 @@ export class TensorboardServiceClient { * Lists the Tensorboards that match the filter expression. * @param {number} request.pageSize * The maximum number of Tensorboards to return. The service may return - * fewer than this value. If unspecified, at most 100 Tensorboards will be - * returned. The maximum value is 100; values above 100 will be coerced to + * fewer than this value. If unspecified, at most 100 Tensorboards are + * returned. The maximum value is 100; values above 100 are coerced to * 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} + * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. * @param {google.protobuf.FieldMask} request.readMask @@ -4358,17 +4490,17 @@ export class TensorboardServiceClient { * Lists the Tensorboards that match the filter expression. * @param {number} request.pageSize * The maximum number of Tensorboards to return. The service may return - * fewer than this value. If unspecified, at most 100 Tensorboards will be - * returned. The maximum value is 100; values above 100 will be coerced to + * fewer than this value. If unspecified, at most 100 Tensorboards are + * returned. The maximum value is 100; values above 100 are coerced to * 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} + * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. * @param {google.protobuf.FieldMask} request.readMask @@ -4421,17 +4553,17 @@ export class TensorboardServiceClient { * Lists the Tensorboards that match the filter expression. * @param {number} request.pageSize * The maximum number of Tensorboards to return. The service may return - * fewer than this value. If unspecified, at most 100 Tensorboards will be - * returned. The maximum value is 100; values above 100 will be coerced to + * fewer than this value. If unspecified, at most 100 Tensorboards are + * returned. The maximum value is 100; values above 100 are coerced to * 100. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards|TensorboardService.ListTensorboards} + * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. * @param {google.protobuf.FieldMask} request.readMask @@ -4476,24 +4608,24 @@ export class TensorboardServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the Tensorboard to list TensorboardExperiments. - * Format: - * 'projects/{project}/locations/{location}/tensorboards/{tensorboard}' + * Required. The resource name of the Tensorboard to list + * TensorboardExperiments. Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}` * @param {string} request.filter * Lists the TensorboardExperiments that match the filter expression. * @param {number} request.pageSize * The maximum number of TensorboardExperiments to return. The service may * return fewer than this value. If unspecified, at most 50 - * TensorboardExperiments will be returned. The maximum value is 1000; values - * above 1000 will be coerced to 1000. + * TensorboardExperiments are returned. The maximum value is 1000; values + * above 1000 are coerced to 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} + * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. * @param {google.protobuf.FieldMask} request.readMask @@ -4595,24 +4727,24 @@ export class TensorboardServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the Tensorboard to list TensorboardExperiments. - * Format: - * 'projects/{project}/locations/{location}/tensorboards/{tensorboard}' + * Required. The resource name of the Tensorboard to list + * TensorboardExperiments. Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}` * @param {string} request.filter * Lists the TensorboardExperiments that match the filter expression. * @param {number} request.pageSize * The maximum number of TensorboardExperiments to return. The service may * return fewer than this value. If unspecified, at most 50 - * TensorboardExperiments will be returned. The maximum value is 1000; values - * above 1000 will be coerced to 1000. + * TensorboardExperiments are returned. The maximum value is 1000; values + * above 1000 are coerced to 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} + * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. * @param {google.protobuf.FieldMask} request.readMask @@ -4658,24 +4790,24 @@ export class TensorboardServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the Tensorboard to list TensorboardExperiments. - * Format: - * 'projects/{project}/locations/{location}/tensorboards/{tensorboard}' + * Required. The resource name of the Tensorboard to list + * TensorboardExperiments. Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}` * @param {string} request.filter * Lists the TensorboardExperiments that match the filter expression. * @param {number} request.pageSize * The maximum number of TensorboardExperiments to return. The service may * return fewer than this value. If unspecified, at most 50 - * TensorboardExperiments will be returned. The maximum value is 1000; values - * above 1000 will be coerced to 1000. + * TensorboardExperiments are returned. The maximum value is 1000; values + * above 1000 are coerced to 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardExperiments|TensorboardService.ListTensorboardExperiments} + * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. * @param {google.protobuf.FieldMask} request.readMask @@ -4720,24 +4852,24 @@ export class TensorboardServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the TensorboardExperiment to list TensorboardRuns. - * Format: - * 'projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}' + * Required. The resource name of the TensorboardExperiment to list + * TensorboardRuns. Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` * @param {string} request.filter * Lists the TensorboardRuns that match the filter expression. * @param {number} request.pageSize * The maximum number of TensorboardRuns to return. The service may return - * fewer than this value. If unspecified, at most 50 TensorboardRuns will be - * returned. The maximum value is 1000; values above 1000 will be coerced to + * fewer than this value. If unspecified, at most 50 TensorboardRuns are + * returned. The maximum value is 1000; values above 1000 are coerced to * 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} + * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. * @param {google.protobuf.FieldMask} request.readMask @@ -4835,24 +4967,24 @@ export class TensorboardServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the TensorboardExperiment to list TensorboardRuns. - * Format: - * 'projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}' + * Required. The resource name of the TensorboardExperiment to list + * TensorboardRuns. Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` * @param {string} request.filter * Lists the TensorboardRuns that match the filter expression. * @param {number} request.pageSize * The maximum number of TensorboardRuns to return. The service may return - * fewer than this value. If unspecified, at most 50 TensorboardRuns will be - * returned. The maximum value is 1000; values above 1000 will be coerced to + * fewer than this value. If unspecified, at most 50 TensorboardRuns are + * returned. The maximum value is 1000; values above 1000 are coerced to * 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} + * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. * @param {google.protobuf.FieldMask} request.readMask @@ -4898,24 +5030,24 @@ export class TensorboardServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the TensorboardExperiment to list TensorboardRuns. - * Format: - * 'projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}' + * Required. The resource name of the TensorboardExperiment to list + * TensorboardRuns. Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` * @param {string} request.filter * Lists the TensorboardRuns that match the filter expression. * @param {number} request.pageSize * The maximum number of TensorboardRuns to return. The service may return - * fewer than this value. If unspecified, at most 50 TensorboardRuns will be - * returned. The maximum value is 1000; values above 1000 will be coerced to + * fewer than this value. If unspecified, at most 50 TensorboardRuns are + * returned. The maximum value is 1000; values above 1000 are coerced to * 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardRuns|TensorboardService.ListTensorboardRuns} + * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. * @param {google.protobuf.FieldMask} request.readMask @@ -4960,24 +5092,24 @@ export class TensorboardServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. - * Format: - * 'projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}' + * Required. The resource name of the TensorboardRun to list + * TensorboardTimeSeries. Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` * @param {string} request.filter * Lists the TensorboardTimeSeries that match the filter expression. * @param {number} request.pageSize * The maximum number of TensorboardTimeSeries to return. The service may * return fewer than this value. If unspecified, at most 50 - * TensorboardTimeSeries will be returned. The maximum value is 1000; values - * above 1000 will be coerced to 1000. + * TensorboardTimeSeries are returned. The maximum value is 1000; values + * above 1000 are coerced to 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} + * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. * @param {google.protobuf.FieldMask} request.readMask @@ -5079,24 +5211,24 @@ export class TensorboardServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. - * Format: - * 'projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}' + * Required. The resource name of the TensorboardRun to list + * TensorboardTimeSeries. Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` * @param {string} request.filter * Lists the TensorboardTimeSeries that match the filter expression. * @param {number} request.pageSize * The maximum number of TensorboardTimeSeries to return. The service may * return fewer than this value. If unspecified, at most 50 - * TensorboardTimeSeries will be returned. The maximum value is 1000; values - * above 1000 will be coerced to 1000. + * TensorboardTimeSeries are returned. The maximum value is 1000; values + * above 1000 are coerced to 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} + * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. * @param {google.protobuf.FieldMask} request.readMask @@ -5142,24 +5274,24 @@ export class TensorboardServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. - * Format: - * 'projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}' + * Required. The resource name of the TensorboardRun to list + * TensorboardTimeSeries. Format: + * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` * @param {string} request.filter * Lists the TensorboardTimeSeries that match the filter expression. * @param {number} request.pageSize * The maximum number of TensorboardTimeSeries to return. The service may * return fewer than this value. If unspecified, at most 50 - * TensorboardTimeSeries will be returned. The maximum value is 1000; values - * above 1000 will be coerced to 1000. + * TensorboardTimeSeries are returned. The maximum value is 1000; values + * above 1000 are coerced to 1000. * @param {string} request.pageToken * A page token, received from a previous - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} call. - * Provide this to retrieve the subsequent page. + * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} + * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} must - * match the call that provided the page token. + * {@link google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboardTimeSeries|TensorboardService.ListTensorboardTimeSeries} + * must match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the list. * @param {google.protobuf.FieldMask} request.readMask @@ -5205,15 +5337,15 @@ export class TensorboardServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.tensorboardTimeSeries - * Required. The resource name of the TensorboardTimeSeries to export data from. - * Format: + * Required. The resource name of the TensorboardTimeSeries to export data + * from. Format: * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}` * @param {string} request.filter * Exports the TensorboardTimeSeries' data that match the filter expression. * @param {number} request.pageSize * The maximum number of data points to return per page. - * The default page_size will be 1000. Values must be between 1 and 10000. - * Values above 10000 will be coerced to 10000. + * The default page_size is 1000. Values must be between 1 and 10000. + * Values above 10000 are coerced to 10000. * @param {string} request.pageToken * A page token, received from a previous * {@link |TensorboardService.ExportTensorboardTimeSeries} call. @@ -5224,7 +5356,7 @@ export class TensorboardServiceClient { * match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the TensorboardTimeSeries' data. - * By default, TensorboardTimeSeries' data will be returned in a pseudo random + * By default, TensorboardTimeSeries' data is returned in a pseudo random * order. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. @@ -5323,15 +5455,15 @@ export class TensorboardServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.tensorboardTimeSeries - * Required. The resource name of the TensorboardTimeSeries to export data from. - * Format: + * Required. The resource name of the TensorboardTimeSeries to export data + * from. Format: * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}` * @param {string} request.filter * Exports the TensorboardTimeSeries' data that match the filter expression. * @param {number} request.pageSize * The maximum number of data points to return per page. - * The default page_size will be 1000. Values must be between 1 and 10000. - * Values above 10000 will be coerced to 10000. + * The default page_size is 1000. Values must be between 1 and 10000. + * Values above 10000 are coerced to 10000. * @param {string} request.pageToken * A page token, received from a previous * {@link |TensorboardService.ExportTensorboardTimeSeries} call. @@ -5342,7 +5474,7 @@ export class TensorboardServiceClient { * match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the TensorboardTimeSeries' data. - * By default, TensorboardTimeSeries' data will be returned in a pseudo random + * By default, TensorboardTimeSeries' data is returned in a pseudo random * order. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. @@ -5386,15 +5518,15 @@ export class TensorboardServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.tensorboardTimeSeries - * Required. The resource name of the TensorboardTimeSeries to export data from. - * Format: + * Required. The resource name of the TensorboardTimeSeries to export data + * from. Format: * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}` * @param {string} request.filter * Exports the TensorboardTimeSeries' data that match the filter expression. * @param {number} request.pageSize * The maximum number of data points to return per page. - * The default page_size will be 1000. Values must be between 1 and 10000. - * Values above 10000 will be coerced to 10000. + * The default page_size is 1000. Values must be between 1 and 10000. + * Values above 10000 are coerced to 10000. * @param {string} request.pageToken * A page token, received from a previous * {@link |TensorboardService.ExportTensorboardTimeSeries} call. @@ -5405,7 +5537,7 @@ export class TensorboardServiceClient { * match the call that provided the page token. * @param {string} request.orderBy * Field to use to sort the TensorboardTimeSeries' data. - * By default, TensorboardTimeSeries' data will be returned in a pseudo random + * By default, TensorboardTimeSeries' data is returned in a pseudo random * order. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. diff --git a/packages/google-cloud-aiplatform/src/v1beta1/tensorboard_service_client_config.json b/packages/google-cloud-aiplatform/src/v1beta1/tensorboard_service_client_config.json index 96886a76c84..58394e25501 100644 --- a/packages/google-cloud-aiplatform/src/v1beta1/tensorboard_service_client_config.json +++ b/packages/google-cloud-aiplatform/src/v1beta1/tensorboard_service_client_config.json @@ -28,6 +28,10 @@ "retry_codes_name": "non_idempotent", "retry_params_name": "default" }, + "ReadTensorboardUsage": { + "retry_codes_name": "non_idempotent", + "retry_params_name": "default" + }, "UpdateTensorboard": { "retry_codes_name": "non_idempotent", "retry_params_name": "default" diff --git a/packages/google-cloud-aiplatform/src/v1beta1/vizier_service_client.ts b/packages/google-cloud-aiplatform/src/v1beta1/vizier_service_client.ts index afeacfbec68..7bfa1a807b6 100644 --- a/packages/google-cloud-aiplatform/src/v1beta1/vizier_service_client.ts +++ b/packages/google-cloud-aiplatform/src/v1beta1/vizier_service_client.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -546,6 +546,9 @@ export class VizierServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}:cancel', }, + { + post: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}:cancel', + }, { post: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}:cancel', }, @@ -558,6 +561,9 @@ export class VizierServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}:cancel', }, + { + post: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}:cancel', + }, { post: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}:cancel', }, @@ -773,6 +779,10 @@ export class VizierServiceClient { delete: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}', }, + { + delete: + '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}', + }, { delete: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}', @@ -789,6 +799,10 @@ export class VizierServiceClient { delete: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}', }, + { + delete: + '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}', + }, { delete: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}', @@ -956,6 +970,9 @@ export class VizierServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}', }, + { + get: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}', + }, { get: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}', }, @@ -968,6 +985,9 @@ export class VizierServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}', }, + { + get: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}', + }, { get: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}', }, @@ -1121,6 +1141,9 @@ export class VizierServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*}/operations', }, + { + get: '/v1beta1/{name=projects/*/locations/*/persistentResources/*}/operations', + }, { get: '/v1beta1/{name=projects/*/locations/*/studies/*}/operations', }, @@ -1133,6 +1156,9 @@ export class VizierServiceClient { { get: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*}/operations', }, + { + get: '/v1beta1/{name=projects/*/locations/*/schedules/*}/operations', + }, { get: '/v1beta1/{name=projects/*/locations/*/specialistPools/*}/operations', }, @@ -1302,6 +1328,9 @@ export class VizierServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/models/*/evaluations/*/operations/*}:wait', }, + { + post: '/v1beta1/{name=projects/*/locations/*/persistentResources/*/operations/*}:wait', + }, { post: '/v1beta1/{name=projects/*/locations/*/studies/*/operations/*}:wait', }, @@ -1314,6 +1343,9 @@ export class VizierServiceClient { { post: '/v1beta1/{name=projects/*/locations/*/pipelineJobs/*/operations/*}:wait', }, + { + post: '/v1beta1/{name=projects/*/locations/*/schedules/*/operations/*}:wait', + }, { post: '/v1beta1/{name=projects/*/locations/*/specialistPools/*/operations/*}:wait', }, diff --git a/packages/google-cloud-aiplatform/system-test/fixtures/sample/src/index.js b/packages/google-cloud-aiplatform/system-test/fixtures/sample/src/index.js index 5aec1b4b857..6aced5b57ed 100644 --- a/packages/google-cloud-aiplatform/system-test/fixtures/sample/src/index.js +++ b/packages/google-cloud-aiplatform/system-test/fixtures/sample/src/index.js @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/packages/google-cloud-aiplatform/system-test/fixtures/sample/src/index.ts b/packages/google-cloud-aiplatform/system-test/fixtures/sample/src/index.ts index 50dd41d5e24..68aa7cc1424 100644 --- a/packages/google-cloud-aiplatform/system-test/fixtures/sample/src/index.ts +++ b/packages/google-cloud-aiplatform/system-test/fixtures/sample/src/index.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/packages/google-cloud-aiplatform/system-test/install.ts b/packages/google-cloud-aiplatform/system-test/install.ts index 6dd1eaadafa..f61fe236476 100644 --- a/packages/google-cloud-aiplatform/system-test/install.ts +++ b/packages/google-cloud-aiplatform/system-test/install.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/packages/google-cloud-aiplatform/test/gapic_dataset_service_v1.ts b/packages/google-cloud-aiplatform/test/gapic_dataset_service_v1.ts index bdadeeecf8d..752e010af9a 100644 --- a/packages/google-cloud-aiplatform/test/gapic_dataset_service_v1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_dataset_service_v1.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -2031,6 +2031,331 @@ describe('v1.DatasetServiceClient', () => { }); }); + describe('searchDataItems', () => { + it('invokes searchDataItems without error', async () => { + const client = new datasetserviceModule.v1.DatasetServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.SearchDataItemsRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.SearchDataItemsRequest', + ['dataset'] + ); + request.dataset = defaultValue1; + const expectedHeaderRequestParams = `dataset=${defaultValue1}`; + const expectedResponse = [ + generateSampleMessage( + new protos.google.cloud.aiplatform.v1.DataItemView() + ), + generateSampleMessage( + new protos.google.cloud.aiplatform.v1.DataItemView() + ), + generateSampleMessage( + new protos.google.cloud.aiplatform.v1.DataItemView() + ), + ]; + client.innerApiCalls.searchDataItems = stubSimpleCall(expectedResponse); + const [response] = await client.searchDataItems(request); + assert.deepStrictEqual(response, expectedResponse); + const actualRequest = ( + client.innerApiCalls.searchDataItems as SinonStub + ).getCall(0).args[0]; + assert.deepStrictEqual(actualRequest, request); + const actualHeaderRequestParams = ( + client.innerApiCalls.searchDataItems as SinonStub + ).getCall(0).args[1].otherArgs.headers['x-goog-request-params']; + assert(actualHeaderRequestParams.includes(expectedHeaderRequestParams)); + }); + + it('invokes searchDataItems without error using callback', async () => { + const client = new datasetserviceModule.v1.DatasetServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.SearchDataItemsRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.SearchDataItemsRequest', + ['dataset'] + ); + request.dataset = defaultValue1; + const expectedHeaderRequestParams = `dataset=${defaultValue1}`; + const expectedResponse = [ + generateSampleMessage( + new protos.google.cloud.aiplatform.v1.DataItemView() + ), + generateSampleMessage( + new protos.google.cloud.aiplatform.v1.DataItemView() + ), + generateSampleMessage( + new protos.google.cloud.aiplatform.v1.DataItemView() + ), + ]; + client.innerApiCalls.searchDataItems = + stubSimpleCallWithCallback(expectedResponse); + const promise = new Promise((resolve, reject) => { + client.searchDataItems( + request, + ( + err?: Error | null, + result?: protos.google.cloud.aiplatform.v1.IDataItemView[] | null + ) => { + if (err) { + reject(err); + } else { + resolve(result); + } + } + ); + }); + const response = await promise; + assert.deepStrictEqual(response, expectedResponse); + const actualRequest = ( + client.innerApiCalls.searchDataItems as SinonStub + ).getCall(0).args[0]; + assert.deepStrictEqual(actualRequest, request); + const actualHeaderRequestParams = ( + client.innerApiCalls.searchDataItems as SinonStub + ).getCall(0).args[1].otherArgs.headers['x-goog-request-params']; + assert(actualHeaderRequestParams.includes(expectedHeaderRequestParams)); + }); + + it('invokes searchDataItems with error', async () => { + const client = new datasetserviceModule.v1.DatasetServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.SearchDataItemsRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.SearchDataItemsRequest', + ['dataset'] + ); + request.dataset = defaultValue1; + const expectedHeaderRequestParams = `dataset=${defaultValue1}`; + const expectedError = new Error('expected'); + client.innerApiCalls.searchDataItems = stubSimpleCall( + undefined, + expectedError + ); + await assert.rejects(client.searchDataItems(request), expectedError); + const actualRequest = ( + client.innerApiCalls.searchDataItems as SinonStub + ).getCall(0).args[0]; + assert.deepStrictEqual(actualRequest, request); + const actualHeaderRequestParams = ( + client.innerApiCalls.searchDataItems as SinonStub + ).getCall(0).args[1].otherArgs.headers['x-goog-request-params']; + assert(actualHeaderRequestParams.includes(expectedHeaderRequestParams)); + }); + + it('invokes searchDataItemsStream without error', async () => { + const client = new datasetserviceModule.v1.DatasetServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.SearchDataItemsRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.SearchDataItemsRequest', + ['dataset'] + ); + request.dataset = defaultValue1; + const expectedHeaderRequestParams = `dataset=${defaultValue1}`; + const expectedResponse = [ + generateSampleMessage( + new protos.google.cloud.aiplatform.v1.DataItemView() + ), + generateSampleMessage( + new protos.google.cloud.aiplatform.v1.DataItemView() + ), + generateSampleMessage( + new protos.google.cloud.aiplatform.v1.DataItemView() + ), + ]; + client.descriptors.page.searchDataItems.createStream = + stubPageStreamingCall(expectedResponse); + const stream = client.searchDataItemsStream(request); + const promise = new Promise((resolve, reject) => { + const responses: protos.google.cloud.aiplatform.v1.DataItemView[] = []; + stream.on( + 'data', + (response: protos.google.cloud.aiplatform.v1.DataItemView) => { + responses.push(response); + } + ); + stream.on('end', () => { + resolve(responses); + }); + stream.on('error', (err: Error) => { + reject(err); + }); + }); + const responses = await promise; + assert.deepStrictEqual(responses, expectedResponse); + assert( + (client.descriptors.page.searchDataItems.createStream as SinonStub) + .getCall(0) + .calledWith(client.innerApiCalls.searchDataItems, request) + ); + assert( + (client.descriptors.page.searchDataItems.createStream as SinonStub) + .getCall(0) + .args[2].otherArgs.headers['x-goog-request-params'].includes( + expectedHeaderRequestParams + ) + ); + }); + + it('invokes searchDataItemsStream with error', async () => { + const client = new datasetserviceModule.v1.DatasetServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.SearchDataItemsRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.SearchDataItemsRequest', + ['dataset'] + ); + request.dataset = defaultValue1; + const expectedHeaderRequestParams = `dataset=${defaultValue1}`; + const expectedError = new Error('expected'); + client.descriptors.page.searchDataItems.createStream = + stubPageStreamingCall(undefined, expectedError); + const stream = client.searchDataItemsStream(request); + const promise = new Promise((resolve, reject) => { + const responses: protos.google.cloud.aiplatform.v1.DataItemView[] = []; + stream.on( + 'data', + (response: protos.google.cloud.aiplatform.v1.DataItemView) => { + responses.push(response); + } + ); + stream.on('end', () => { + resolve(responses); + }); + stream.on('error', (err: Error) => { + reject(err); + }); + }); + await assert.rejects(promise, expectedError); + assert( + (client.descriptors.page.searchDataItems.createStream as SinonStub) + .getCall(0) + .calledWith(client.innerApiCalls.searchDataItems, request) + ); + assert( + (client.descriptors.page.searchDataItems.createStream as SinonStub) + .getCall(0) + .args[2].otherArgs.headers['x-goog-request-params'].includes( + expectedHeaderRequestParams + ) + ); + }); + + it('uses async iteration with searchDataItems without error', async () => { + const client = new datasetserviceModule.v1.DatasetServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.SearchDataItemsRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.SearchDataItemsRequest', + ['dataset'] + ); + request.dataset = defaultValue1; + const expectedHeaderRequestParams = `dataset=${defaultValue1}`; + const expectedResponse = [ + generateSampleMessage( + new protos.google.cloud.aiplatform.v1.DataItemView() + ), + generateSampleMessage( + new protos.google.cloud.aiplatform.v1.DataItemView() + ), + generateSampleMessage( + new protos.google.cloud.aiplatform.v1.DataItemView() + ), + ]; + client.descriptors.page.searchDataItems.asyncIterate = + stubAsyncIterationCall(expectedResponse); + const responses: protos.google.cloud.aiplatform.v1.IDataItemView[] = []; + const iterable = client.searchDataItemsAsync(request); + for await (const resource of iterable) { + responses.push(resource!); + } + assert.deepStrictEqual(responses, expectedResponse); + assert.deepStrictEqual( + ( + client.descriptors.page.searchDataItems.asyncIterate as SinonStub + ).getCall(0).args[1], + request + ); + assert( + (client.descriptors.page.searchDataItems.asyncIterate as SinonStub) + .getCall(0) + .args[2].otherArgs.headers['x-goog-request-params'].includes( + expectedHeaderRequestParams + ) + ); + }); + + it('uses async iteration with searchDataItems with error', async () => { + const client = new datasetserviceModule.v1.DatasetServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.SearchDataItemsRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.SearchDataItemsRequest', + ['dataset'] + ); + request.dataset = defaultValue1; + const expectedHeaderRequestParams = `dataset=${defaultValue1}`; + const expectedError = new Error('expected'); + client.descriptors.page.searchDataItems.asyncIterate = + stubAsyncIterationCall(undefined, expectedError); + const iterable = client.searchDataItemsAsync(request); + await assert.rejects(async () => { + const responses: protos.google.cloud.aiplatform.v1.IDataItemView[] = []; + for await (const resource of iterable) { + responses.push(resource!); + } + }); + assert.deepStrictEqual( + ( + client.descriptors.page.searchDataItems.asyncIterate as SinonStub + ).getCall(0).args[1], + request + ); + assert( + (client.descriptors.page.searchDataItems.asyncIterate as SinonStub) + .getCall(0) + .args[2].otherArgs.headers['x-goog-request-params'].includes( + expectedHeaderRequestParams + ) + ); + }); + }); + describe('listSavedQueries', () => { it('invokes listSavedQueries without error', async () => { const client = new datasetserviceModule.v1.DatasetServiceClient({ diff --git a/packages/google-cloud-aiplatform/test/gapic_dataset_service_v1beta1.ts b/packages/google-cloud-aiplatform/test/gapic_dataset_service_v1beta1.ts index 00eb7e21ce1..45930386df4 100644 --- a/packages/google-cloud-aiplatform/test/gapic_dataset_service_v1beta1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_dataset_service_v1beta1.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -2080,6 +2080,337 @@ describe('v1beta1.DatasetServiceClient', () => { }); }); + describe('searchDataItems', () => { + it('invokes searchDataItems without error', async () => { + const client = new datasetserviceModule.v1beta1.DatasetServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1beta1.SearchDataItemsRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1beta1.SearchDataItemsRequest', + ['dataset'] + ); + request.dataset = defaultValue1; + const expectedHeaderRequestParams = `dataset=${defaultValue1}`; + const expectedResponse = [ + generateSampleMessage( + new protos.google.cloud.aiplatform.v1beta1.DataItemView() + ), + generateSampleMessage( + new protos.google.cloud.aiplatform.v1beta1.DataItemView() + ), + generateSampleMessage( + new protos.google.cloud.aiplatform.v1beta1.DataItemView() + ), + ]; + client.innerApiCalls.searchDataItems = stubSimpleCall(expectedResponse); + const [response] = await client.searchDataItems(request); + assert.deepStrictEqual(response, expectedResponse); + const actualRequest = ( + client.innerApiCalls.searchDataItems as SinonStub + ).getCall(0).args[0]; + assert.deepStrictEqual(actualRequest, request); + const actualHeaderRequestParams = ( + client.innerApiCalls.searchDataItems as SinonStub + ).getCall(0).args[1].otherArgs.headers['x-goog-request-params']; + assert(actualHeaderRequestParams.includes(expectedHeaderRequestParams)); + }); + + it('invokes searchDataItems without error using callback', async () => { + const client = new datasetserviceModule.v1beta1.DatasetServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1beta1.SearchDataItemsRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1beta1.SearchDataItemsRequest', + ['dataset'] + ); + request.dataset = defaultValue1; + const expectedHeaderRequestParams = `dataset=${defaultValue1}`; + const expectedResponse = [ + generateSampleMessage( + new protos.google.cloud.aiplatform.v1beta1.DataItemView() + ), + generateSampleMessage( + new protos.google.cloud.aiplatform.v1beta1.DataItemView() + ), + generateSampleMessage( + new protos.google.cloud.aiplatform.v1beta1.DataItemView() + ), + ]; + client.innerApiCalls.searchDataItems = + stubSimpleCallWithCallback(expectedResponse); + const promise = new Promise((resolve, reject) => { + client.searchDataItems( + request, + ( + err?: Error | null, + result?: + | protos.google.cloud.aiplatform.v1beta1.IDataItemView[] + | null + ) => { + if (err) { + reject(err); + } else { + resolve(result); + } + } + ); + }); + const response = await promise; + assert.deepStrictEqual(response, expectedResponse); + const actualRequest = ( + client.innerApiCalls.searchDataItems as SinonStub + ).getCall(0).args[0]; + assert.deepStrictEqual(actualRequest, request); + const actualHeaderRequestParams = ( + client.innerApiCalls.searchDataItems as SinonStub + ).getCall(0).args[1].otherArgs.headers['x-goog-request-params']; + assert(actualHeaderRequestParams.includes(expectedHeaderRequestParams)); + }); + + it('invokes searchDataItems with error', async () => { + const client = new datasetserviceModule.v1beta1.DatasetServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1beta1.SearchDataItemsRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1beta1.SearchDataItemsRequest', + ['dataset'] + ); + request.dataset = defaultValue1; + const expectedHeaderRequestParams = `dataset=${defaultValue1}`; + const expectedError = new Error('expected'); + client.innerApiCalls.searchDataItems = stubSimpleCall( + undefined, + expectedError + ); + await assert.rejects(client.searchDataItems(request), expectedError); + const actualRequest = ( + client.innerApiCalls.searchDataItems as SinonStub + ).getCall(0).args[0]; + assert.deepStrictEqual(actualRequest, request); + const actualHeaderRequestParams = ( + client.innerApiCalls.searchDataItems as SinonStub + ).getCall(0).args[1].otherArgs.headers['x-goog-request-params']; + assert(actualHeaderRequestParams.includes(expectedHeaderRequestParams)); + }); + + it('invokes searchDataItemsStream without error', async () => { + const client = new datasetserviceModule.v1beta1.DatasetServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1beta1.SearchDataItemsRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1beta1.SearchDataItemsRequest', + ['dataset'] + ); + request.dataset = defaultValue1; + const expectedHeaderRequestParams = `dataset=${defaultValue1}`; + const expectedResponse = [ + generateSampleMessage( + new protos.google.cloud.aiplatform.v1beta1.DataItemView() + ), + generateSampleMessage( + new protos.google.cloud.aiplatform.v1beta1.DataItemView() + ), + generateSampleMessage( + new protos.google.cloud.aiplatform.v1beta1.DataItemView() + ), + ]; + client.descriptors.page.searchDataItems.createStream = + stubPageStreamingCall(expectedResponse); + const stream = client.searchDataItemsStream(request); + const promise = new Promise((resolve, reject) => { + const responses: protos.google.cloud.aiplatform.v1beta1.DataItemView[] = + []; + stream.on( + 'data', + (response: protos.google.cloud.aiplatform.v1beta1.DataItemView) => { + responses.push(response); + } + ); + stream.on('end', () => { + resolve(responses); + }); + stream.on('error', (err: Error) => { + reject(err); + }); + }); + const responses = await promise; + assert.deepStrictEqual(responses, expectedResponse); + assert( + (client.descriptors.page.searchDataItems.createStream as SinonStub) + .getCall(0) + .calledWith(client.innerApiCalls.searchDataItems, request) + ); + assert( + (client.descriptors.page.searchDataItems.createStream as SinonStub) + .getCall(0) + .args[2].otherArgs.headers['x-goog-request-params'].includes( + expectedHeaderRequestParams + ) + ); + }); + + it('invokes searchDataItemsStream with error', async () => { + const client = new datasetserviceModule.v1beta1.DatasetServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1beta1.SearchDataItemsRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1beta1.SearchDataItemsRequest', + ['dataset'] + ); + request.dataset = defaultValue1; + const expectedHeaderRequestParams = `dataset=${defaultValue1}`; + const expectedError = new Error('expected'); + client.descriptors.page.searchDataItems.createStream = + stubPageStreamingCall(undefined, expectedError); + const stream = client.searchDataItemsStream(request); + const promise = new Promise((resolve, reject) => { + const responses: protos.google.cloud.aiplatform.v1beta1.DataItemView[] = + []; + stream.on( + 'data', + (response: protos.google.cloud.aiplatform.v1beta1.DataItemView) => { + responses.push(response); + } + ); + stream.on('end', () => { + resolve(responses); + }); + stream.on('error', (err: Error) => { + reject(err); + }); + }); + await assert.rejects(promise, expectedError); + assert( + (client.descriptors.page.searchDataItems.createStream as SinonStub) + .getCall(0) + .calledWith(client.innerApiCalls.searchDataItems, request) + ); + assert( + (client.descriptors.page.searchDataItems.createStream as SinonStub) + .getCall(0) + .args[2].otherArgs.headers['x-goog-request-params'].includes( + expectedHeaderRequestParams + ) + ); + }); + + it('uses async iteration with searchDataItems without error', async () => { + const client = new datasetserviceModule.v1beta1.DatasetServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1beta1.SearchDataItemsRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1beta1.SearchDataItemsRequest', + ['dataset'] + ); + request.dataset = defaultValue1; + const expectedHeaderRequestParams = `dataset=${defaultValue1}`; + const expectedResponse = [ + generateSampleMessage( + new protos.google.cloud.aiplatform.v1beta1.DataItemView() + ), + generateSampleMessage( + new protos.google.cloud.aiplatform.v1beta1.DataItemView() + ), + generateSampleMessage( + new protos.google.cloud.aiplatform.v1beta1.DataItemView() + ), + ]; + client.descriptors.page.searchDataItems.asyncIterate = + stubAsyncIterationCall(expectedResponse); + const responses: protos.google.cloud.aiplatform.v1beta1.IDataItemView[] = + []; + const iterable = client.searchDataItemsAsync(request); + for await (const resource of iterable) { + responses.push(resource!); + } + assert.deepStrictEqual(responses, expectedResponse); + assert.deepStrictEqual( + ( + client.descriptors.page.searchDataItems.asyncIterate as SinonStub + ).getCall(0).args[1], + request + ); + assert( + (client.descriptors.page.searchDataItems.asyncIterate as SinonStub) + .getCall(0) + .args[2].otherArgs.headers['x-goog-request-params'].includes( + expectedHeaderRequestParams + ) + ); + }); + + it('uses async iteration with searchDataItems with error', async () => { + const client = new datasetserviceModule.v1beta1.DatasetServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1beta1.SearchDataItemsRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1beta1.SearchDataItemsRequest', + ['dataset'] + ); + request.dataset = defaultValue1; + const expectedHeaderRequestParams = `dataset=${defaultValue1}`; + const expectedError = new Error('expected'); + client.descriptors.page.searchDataItems.asyncIterate = + stubAsyncIterationCall(undefined, expectedError); + const iterable = client.searchDataItemsAsync(request); + await assert.rejects(async () => { + const responses: protos.google.cloud.aiplatform.v1beta1.IDataItemView[] = + []; + for await (const resource of iterable) { + responses.push(resource!); + } + }); + assert.deepStrictEqual( + ( + client.descriptors.page.searchDataItems.asyncIterate as SinonStub + ).getCall(0).args[1], + request + ); + assert( + (client.descriptors.page.searchDataItems.asyncIterate as SinonStub) + .getCall(0) + .args[2].otherArgs.headers['x-goog-request-params'].includes( + expectedHeaderRequestParams + ) + ); + }); + }); + describe('listSavedQueries', () => { it('invokes listSavedQueries without error', async () => { const client = new datasetserviceModule.v1beta1.DatasetServiceClient({ diff --git a/packages/google-cloud-aiplatform/test/gapic_deployment_resource_pool_service_v1beta1.ts b/packages/google-cloud-aiplatform/test/gapic_deployment_resource_pool_service_v1beta1.ts index 8174c72ac6c..3aae22614e3 100644 --- a/packages/google-cloud-aiplatform/test/gapic_deployment_resource_pool_service_v1beta1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_deployment_resource_pool_service_v1beta1.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/packages/google-cloud-aiplatform/test/gapic_endpoint_service_v1.ts b/packages/google-cloud-aiplatform/test/gapic_endpoint_service_v1.ts index 9f851ac20ee..1182cf36dc5 100644 --- a/packages/google-cloud-aiplatform/test/gapic_endpoint_service_v1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_endpoint_service_v1.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/packages/google-cloud-aiplatform/test/gapic_endpoint_service_v1beta1.ts b/packages/google-cloud-aiplatform/test/gapic_endpoint_service_v1beta1.ts index c22cd7fac31..5188a097bdb 100644 --- a/packages/google-cloud-aiplatform/test/gapic_endpoint_service_v1beta1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_endpoint_service_v1beta1.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/packages/google-cloud-aiplatform/test/gapic_featurestore_online_serving_service_v1.ts b/packages/google-cloud-aiplatform/test/gapic_featurestore_online_serving_service_v1.ts index cdccbf6e675..9e7d0549d6d 100644 --- a/packages/google-cloud-aiplatform/test/gapic_featurestore_online_serving_service_v1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_featurestore_online_serving_service_v1.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -381,6 +381,149 @@ describe('v1.FeaturestoreOnlineServingServiceClient', () => { }); }); + describe('writeFeatureValues', () => { + it('invokes writeFeatureValues without error', async () => { + const client = + new featurestoreonlineservingserviceModule.v1.FeaturestoreOnlineServingServiceClient( + { + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + } + ); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.WriteFeatureValuesRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.WriteFeatureValuesRequest', + ['entityType'] + ); + request.entityType = defaultValue1; + const expectedHeaderRequestParams = `entity_type=${defaultValue1}`; + const expectedResponse = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.WriteFeatureValuesResponse() + ); + client.innerApiCalls.writeFeatureValues = + stubSimpleCall(expectedResponse); + const [response] = await client.writeFeatureValues(request); + assert.deepStrictEqual(response, expectedResponse); + const actualRequest = ( + client.innerApiCalls.writeFeatureValues as SinonStub + ).getCall(0).args[0]; + assert.deepStrictEqual(actualRequest, request); + const actualHeaderRequestParams = ( + client.innerApiCalls.writeFeatureValues as SinonStub + ).getCall(0).args[1].otherArgs.headers['x-goog-request-params']; + assert(actualHeaderRequestParams.includes(expectedHeaderRequestParams)); + }); + + it('invokes writeFeatureValues without error using callback', async () => { + const client = + new featurestoreonlineservingserviceModule.v1.FeaturestoreOnlineServingServiceClient( + { + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + } + ); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.WriteFeatureValuesRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.WriteFeatureValuesRequest', + ['entityType'] + ); + request.entityType = defaultValue1; + const expectedHeaderRequestParams = `entity_type=${defaultValue1}`; + const expectedResponse = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.WriteFeatureValuesResponse() + ); + client.innerApiCalls.writeFeatureValues = + stubSimpleCallWithCallback(expectedResponse); + const promise = new Promise((resolve, reject) => { + client.writeFeatureValues( + request, + ( + err?: Error | null, + result?: protos.google.cloud.aiplatform.v1.IWriteFeatureValuesResponse | null + ) => { + if (err) { + reject(err); + } else { + resolve(result); + } + } + ); + }); + const response = await promise; + assert.deepStrictEqual(response, expectedResponse); + const actualRequest = ( + client.innerApiCalls.writeFeatureValues as SinonStub + ).getCall(0).args[0]; + assert.deepStrictEqual(actualRequest, request); + const actualHeaderRequestParams = ( + client.innerApiCalls.writeFeatureValues as SinonStub + ).getCall(0).args[1].otherArgs.headers['x-goog-request-params']; + assert(actualHeaderRequestParams.includes(expectedHeaderRequestParams)); + }); + + it('invokes writeFeatureValues with error', async () => { + const client = + new featurestoreonlineservingserviceModule.v1.FeaturestoreOnlineServingServiceClient( + { + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + } + ); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.WriteFeatureValuesRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.WriteFeatureValuesRequest', + ['entityType'] + ); + request.entityType = defaultValue1; + const expectedHeaderRequestParams = `entity_type=${defaultValue1}`; + const expectedError = new Error('expected'); + client.innerApiCalls.writeFeatureValues = stubSimpleCall( + undefined, + expectedError + ); + await assert.rejects(client.writeFeatureValues(request), expectedError); + const actualRequest = ( + client.innerApiCalls.writeFeatureValues as SinonStub + ).getCall(0).args[0]; + assert.deepStrictEqual(actualRequest, request); + const actualHeaderRequestParams = ( + client.innerApiCalls.writeFeatureValues as SinonStub + ).getCall(0).args[1].otherArgs.headers['x-goog-request-params']; + assert(actualHeaderRequestParams.includes(expectedHeaderRequestParams)); + }); + + it('invokes writeFeatureValues with closed client', async () => { + const client = + new featurestoreonlineservingserviceModule.v1.FeaturestoreOnlineServingServiceClient( + { + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + } + ); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.WriteFeatureValuesRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.WriteFeatureValuesRequest', + ['entityType'] + ); + request.entityType = defaultValue1; + const expectedError = new Error('The client has already been closed.'); + client.close(); + await assert.rejects(client.writeFeatureValues(request), expectedError); + }); + }); + describe('streamingReadFeatureValues', () => { it('invokes streamingReadFeatureValues without error', async () => { const client = diff --git a/packages/google-cloud-aiplatform/test/gapic_featurestore_online_serving_service_v1beta1.ts b/packages/google-cloud-aiplatform/test/gapic_featurestore_online_serving_service_v1beta1.ts index ee0038b5d5b..f17c7f21348 100644 --- a/packages/google-cloud-aiplatform/test/gapic_featurestore_online_serving_service_v1beta1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_featurestore_online_serving_service_v1beta1.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/packages/google-cloud-aiplatform/test/gapic_featurestore_service_v1.ts b/packages/google-cloud-aiplatform/test/gapic_featurestore_service_v1.ts index d926d1e5ab0..782c306f4af 100644 --- a/packages/google-cloud-aiplatform/test/gapic_featurestore_service_v1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_featurestore_service_v1.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/packages/google-cloud-aiplatform/test/gapic_featurestore_service_v1beta1.ts b/packages/google-cloud-aiplatform/test/gapic_featurestore_service_v1beta1.ts index df5a9799f79..7de3d5bd9c7 100644 --- a/packages/google-cloud-aiplatform/test/gapic_featurestore_service_v1beta1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_featurestore_service_v1beta1.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/packages/google-cloud-aiplatform/test/gapic_index_endpoint_service_v1.ts b/packages/google-cloud-aiplatform/test/gapic_index_endpoint_service_v1.ts index 502a3b4a17d..8dfc689d72d 100644 --- a/packages/google-cloud-aiplatform/test/gapic_index_endpoint_service_v1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_index_endpoint_service_v1.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/packages/google-cloud-aiplatform/test/gapic_index_endpoint_service_v1beta1.ts b/packages/google-cloud-aiplatform/test/gapic_index_endpoint_service_v1beta1.ts index 881461f2ba6..d2d74b2431b 100644 --- a/packages/google-cloud-aiplatform/test/gapic_index_endpoint_service_v1beta1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_index_endpoint_service_v1beta1.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/packages/google-cloud-aiplatform/test/gapic_index_service_v1.ts b/packages/google-cloud-aiplatform/test/gapic_index_service_v1.ts index 2eb80271fec..18907fd42e3 100644 --- a/packages/google-cloud-aiplatform/test/gapic_index_service_v1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_index_service_v1.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/packages/google-cloud-aiplatform/test/gapic_index_service_v1beta1.ts b/packages/google-cloud-aiplatform/test/gapic_index_service_v1beta1.ts index 550304afe97..661d87a6863 100644 --- a/packages/google-cloud-aiplatform/test/gapic_index_service_v1beta1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_index_service_v1beta1.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/packages/google-cloud-aiplatform/test/gapic_job_service_v1.ts b/packages/google-cloud-aiplatform/test/gapic_job_service_v1.ts index 70d12861c97..ff6cae173bc 100644 --- a/packages/google-cloud-aiplatform/test/gapic_job_service_v1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_job_service_v1.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/packages/google-cloud-aiplatform/test/gapic_job_service_v1beta1.ts b/packages/google-cloud-aiplatform/test/gapic_job_service_v1beta1.ts index 79a998e323f..e48659eb07e 100644 --- a/packages/google-cloud-aiplatform/test/gapic_job_service_v1beta1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_job_service_v1beta1.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/packages/google-cloud-aiplatform/test/gapic_metadata_service_v1.ts b/packages/google-cloud-aiplatform/test/gapic_metadata_service_v1.ts index f2d9ecccd1b..e14f0184ccf 100644 --- a/packages/google-cloud-aiplatform/test/gapic_metadata_service_v1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_metadata_service_v1.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/packages/google-cloud-aiplatform/test/gapic_metadata_service_v1beta1.ts b/packages/google-cloud-aiplatform/test/gapic_metadata_service_v1beta1.ts index bdba0c1d1be..8ad599a0c09 100644 --- a/packages/google-cloud-aiplatform/test/gapic_metadata_service_v1beta1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_metadata_service_v1beta1.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/packages/google-cloud-aiplatform/test/gapic_migration_service_v1.ts b/packages/google-cloud-aiplatform/test/gapic_migration_service_v1.ts index 8e23e2dcd40..9a88853b770 100644 --- a/packages/google-cloud-aiplatform/test/gapic_migration_service_v1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_migration_service_v1.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/packages/google-cloud-aiplatform/test/gapic_migration_service_v1beta1.ts b/packages/google-cloud-aiplatform/test/gapic_migration_service_v1beta1.ts index 4d554be9dfe..65049fdf9dc 100644 --- a/packages/google-cloud-aiplatform/test/gapic_migration_service_v1beta1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_migration_service_v1beta1.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/packages/google-cloud-aiplatform/test/gapic_model_service_v1.ts b/packages/google-cloud-aiplatform/test/gapic_model_service_v1.ts index a35377ce9bd..43afd6ae104 100644 --- a/packages/google-cloud-aiplatform/test/gapic_model_service_v1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_model_service_v1.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/packages/google-cloud-aiplatform/test/gapic_model_service_v1beta1.ts b/packages/google-cloud-aiplatform/test/gapic_model_service_v1beta1.ts index 8e128ffa0e7..49e1bb4551c 100644 --- a/packages/google-cloud-aiplatform/test/gapic_model_service_v1beta1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_model_service_v1beta1.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/packages/google-cloud-aiplatform/test/gapic_pipeline_service_v1.ts b/packages/google-cloud-aiplatform/test/gapic_pipeline_service_v1.ts index 06f68df61b8..5393114b02e 100644 --- a/packages/google-cloud-aiplatform/test/gapic_pipeline_service_v1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_pipeline_service_v1.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/packages/google-cloud-aiplatform/test/gapic_pipeline_service_v1beta1.ts b/packages/google-cloud-aiplatform/test/gapic_pipeline_service_v1beta1.ts index e015b8ee381..e156d17cf2b 100644 --- a/packages/google-cloud-aiplatform/test/gapic_pipeline_service_v1beta1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_pipeline_service_v1beta1.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/packages/google-cloud-aiplatform/test/gapic_prediction_service_v1.ts b/packages/google-cloud-aiplatform/test/gapic_prediction_service_v1.ts index 2b3d8d1bdd3..d290db674dd 100644 --- a/packages/google-cloud-aiplatform/test/gapic_prediction_service_v1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_prediction_service_v1.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/packages/google-cloud-aiplatform/test/gapic_prediction_service_v1beta1.ts b/packages/google-cloud-aiplatform/test/gapic_prediction_service_v1beta1.ts index 7b17634ca14..45c0ce2e9c8 100644 --- a/packages/google-cloud-aiplatform/test/gapic_prediction_service_v1beta1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_prediction_service_v1beta1.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/packages/google-cloud-aiplatform/test/gapic_specialist_pool_service_v1.ts b/packages/google-cloud-aiplatform/test/gapic_specialist_pool_service_v1.ts index 8a55e992106..6d52146da73 100644 --- a/packages/google-cloud-aiplatform/test/gapic_specialist_pool_service_v1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_specialist_pool_service_v1.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/packages/google-cloud-aiplatform/test/gapic_specialist_pool_service_v1beta1.ts b/packages/google-cloud-aiplatform/test/gapic_specialist_pool_service_v1beta1.ts index e640445eff1..b727ba22eef 100644 --- a/packages/google-cloud-aiplatform/test/gapic_specialist_pool_service_v1beta1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_specialist_pool_service_v1beta1.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/packages/google-cloud-aiplatform/test/gapic_tensorboard_service_v1.ts b/packages/google-cloud-aiplatform/test/gapic_tensorboard_service_v1.ts index fc1b7599dad..db37fdeb064 100644 --- a/packages/google-cloud-aiplatform/test/gapic_tensorboard_service_v1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_tensorboard_service_v1.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -416,6 +416,137 @@ describe('v1.TensorboardServiceClient', () => { }); }); + describe('readTensorboardUsage', () => { + it('invokes readTensorboardUsage without error', async () => { + const client = new tensorboardserviceModule.v1.TensorboardServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.ReadTensorboardUsageRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.ReadTensorboardUsageRequest', + ['tensorboard'] + ); + request.tensorboard = defaultValue1; + const expectedHeaderRequestParams = `tensorboard=${defaultValue1}`; + const expectedResponse = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.ReadTensorboardUsageResponse() + ); + client.innerApiCalls.readTensorboardUsage = + stubSimpleCall(expectedResponse); + const [response] = await client.readTensorboardUsage(request); + assert.deepStrictEqual(response, expectedResponse); + const actualRequest = ( + client.innerApiCalls.readTensorboardUsage as SinonStub + ).getCall(0).args[0]; + assert.deepStrictEqual(actualRequest, request); + const actualHeaderRequestParams = ( + client.innerApiCalls.readTensorboardUsage as SinonStub + ).getCall(0).args[1].otherArgs.headers['x-goog-request-params']; + assert(actualHeaderRequestParams.includes(expectedHeaderRequestParams)); + }); + + it('invokes readTensorboardUsage without error using callback', async () => { + const client = new tensorboardserviceModule.v1.TensorboardServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.ReadTensorboardUsageRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.ReadTensorboardUsageRequest', + ['tensorboard'] + ); + request.tensorboard = defaultValue1; + const expectedHeaderRequestParams = `tensorboard=${defaultValue1}`; + const expectedResponse = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.ReadTensorboardUsageResponse() + ); + client.innerApiCalls.readTensorboardUsage = + stubSimpleCallWithCallback(expectedResponse); + const promise = new Promise((resolve, reject) => { + client.readTensorboardUsage( + request, + ( + err?: Error | null, + result?: protos.google.cloud.aiplatform.v1.IReadTensorboardUsageResponse | null + ) => { + if (err) { + reject(err); + } else { + resolve(result); + } + } + ); + }); + const response = await promise; + assert.deepStrictEqual(response, expectedResponse); + const actualRequest = ( + client.innerApiCalls.readTensorboardUsage as SinonStub + ).getCall(0).args[0]; + assert.deepStrictEqual(actualRequest, request); + const actualHeaderRequestParams = ( + client.innerApiCalls.readTensorboardUsage as SinonStub + ).getCall(0).args[1].otherArgs.headers['x-goog-request-params']; + assert(actualHeaderRequestParams.includes(expectedHeaderRequestParams)); + }); + + it('invokes readTensorboardUsage with error', async () => { + const client = new tensorboardserviceModule.v1.TensorboardServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.ReadTensorboardUsageRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.ReadTensorboardUsageRequest', + ['tensorboard'] + ); + request.tensorboard = defaultValue1; + const expectedHeaderRequestParams = `tensorboard=${defaultValue1}`; + const expectedError = new Error('expected'); + client.innerApiCalls.readTensorboardUsage = stubSimpleCall( + undefined, + expectedError + ); + await assert.rejects(client.readTensorboardUsage(request), expectedError); + const actualRequest = ( + client.innerApiCalls.readTensorboardUsage as SinonStub + ).getCall(0).args[0]; + assert.deepStrictEqual(actualRequest, request); + const actualHeaderRequestParams = ( + client.innerApiCalls.readTensorboardUsage as SinonStub + ).getCall(0).args[1].otherArgs.headers['x-goog-request-params']; + assert(actualHeaderRequestParams.includes(expectedHeaderRequestParams)); + }); + + it('invokes readTensorboardUsage with closed client', async () => { + const client = new tensorboardserviceModule.v1.TensorboardServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1.ReadTensorboardUsageRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1.ReadTensorboardUsageRequest', + ['tensorboard'] + ); + request.tensorboard = defaultValue1; + const expectedError = new Error('The client has already been closed.'); + client.close(); + await assert.rejects(client.readTensorboardUsage(request), expectedError); + }); + }); + describe('createTensorboardExperiment', () => { it('invokes createTensorboardExperiment without error', async () => { const client = new tensorboardserviceModule.v1.TensorboardServiceClient({ diff --git a/packages/google-cloud-aiplatform/test/gapic_tensorboard_service_v1beta1.ts b/packages/google-cloud-aiplatform/test/gapic_tensorboard_service_v1beta1.ts index 22584782b02..43ce533242a 100644 --- a/packages/google-cloud-aiplatform/test/gapic_tensorboard_service_v1beta1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_tensorboard_service_v1beta1.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -428,6 +428,141 @@ describe('v1beta1.TensorboardServiceClient', () => { }); }); + describe('readTensorboardUsage', () => { + it('invokes readTensorboardUsage without error', async () => { + const client = + new tensorboardserviceModule.v1beta1.TensorboardServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1beta1.ReadTensorboardUsageRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1beta1.ReadTensorboardUsageRequest', + ['tensorboard'] + ); + request.tensorboard = defaultValue1; + const expectedHeaderRequestParams = `tensorboard=${defaultValue1}`; + const expectedResponse = generateSampleMessage( + new protos.google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse() + ); + client.innerApiCalls.readTensorboardUsage = + stubSimpleCall(expectedResponse); + const [response] = await client.readTensorboardUsage(request); + assert.deepStrictEqual(response, expectedResponse); + const actualRequest = ( + client.innerApiCalls.readTensorboardUsage as SinonStub + ).getCall(0).args[0]; + assert.deepStrictEqual(actualRequest, request); + const actualHeaderRequestParams = ( + client.innerApiCalls.readTensorboardUsage as SinonStub + ).getCall(0).args[1].otherArgs.headers['x-goog-request-params']; + assert(actualHeaderRequestParams.includes(expectedHeaderRequestParams)); + }); + + it('invokes readTensorboardUsage without error using callback', async () => { + const client = + new tensorboardserviceModule.v1beta1.TensorboardServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1beta1.ReadTensorboardUsageRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1beta1.ReadTensorboardUsageRequest', + ['tensorboard'] + ); + request.tensorboard = defaultValue1; + const expectedHeaderRequestParams = `tensorboard=${defaultValue1}`; + const expectedResponse = generateSampleMessage( + new protos.google.cloud.aiplatform.v1beta1.ReadTensorboardUsageResponse() + ); + client.innerApiCalls.readTensorboardUsage = + stubSimpleCallWithCallback(expectedResponse); + const promise = new Promise((resolve, reject) => { + client.readTensorboardUsage( + request, + ( + err?: Error | null, + result?: protos.google.cloud.aiplatform.v1beta1.IReadTensorboardUsageResponse | null + ) => { + if (err) { + reject(err); + } else { + resolve(result); + } + } + ); + }); + const response = await promise; + assert.deepStrictEqual(response, expectedResponse); + const actualRequest = ( + client.innerApiCalls.readTensorboardUsage as SinonStub + ).getCall(0).args[0]; + assert.deepStrictEqual(actualRequest, request); + const actualHeaderRequestParams = ( + client.innerApiCalls.readTensorboardUsage as SinonStub + ).getCall(0).args[1].otherArgs.headers['x-goog-request-params']; + assert(actualHeaderRequestParams.includes(expectedHeaderRequestParams)); + }); + + it('invokes readTensorboardUsage with error', async () => { + const client = + new tensorboardserviceModule.v1beta1.TensorboardServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1beta1.ReadTensorboardUsageRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1beta1.ReadTensorboardUsageRequest', + ['tensorboard'] + ); + request.tensorboard = defaultValue1; + const expectedHeaderRequestParams = `tensorboard=${defaultValue1}`; + const expectedError = new Error('expected'); + client.innerApiCalls.readTensorboardUsage = stubSimpleCall( + undefined, + expectedError + ); + await assert.rejects(client.readTensorboardUsage(request), expectedError); + const actualRequest = ( + client.innerApiCalls.readTensorboardUsage as SinonStub + ).getCall(0).args[0]; + assert.deepStrictEqual(actualRequest, request); + const actualHeaderRequestParams = ( + client.innerApiCalls.readTensorboardUsage as SinonStub + ).getCall(0).args[1].otherArgs.headers['x-goog-request-params']; + assert(actualHeaderRequestParams.includes(expectedHeaderRequestParams)); + }); + + it('invokes readTensorboardUsage with closed client', async () => { + const client = + new tensorboardserviceModule.v1beta1.TensorboardServiceClient({ + credentials: {client_email: 'bogus', private_key: 'bogus'}, + projectId: 'bogus', + }); + client.initialize(); + const request = generateSampleMessage( + new protos.google.cloud.aiplatform.v1beta1.ReadTensorboardUsageRequest() + ); + const defaultValue1 = getTypeDefaultValue( + '.google.cloud.aiplatform.v1beta1.ReadTensorboardUsageRequest', + ['tensorboard'] + ); + request.tensorboard = defaultValue1; + const expectedError = new Error('The client has already been closed.'); + client.close(); + await assert.rejects(client.readTensorboardUsage(request), expectedError); + }); + }); + describe('createTensorboardExperiment', () => { it('invokes createTensorboardExperiment without error', async () => { const client = diff --git a/packages/google-cloud-aiplatform/test/gapic_vizier_service_v1.ts b/packages/google-cloud-aiplatform/test/gapic_vizier_service_v1.ts index f31e7621466..036860b56aa 100644 --- a/packages/google-cloud-aiplatform/test/gapic_vizier_service_v1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_vizier_service_v1.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. diff --git a/packages/google-cloud-aiplatform/test/gapic_vizier_service_v1beta1.ts b/packages/google-cloud-aiplatform/test/gapic_vizier_service_v1beta1.ts index efcdae79b53..21323ddcb46 100644 --- a/packages/google-cloud-aiplatform/test/gapic_vizier_service_v1beta1.ts +++ b/packages/google-cloud-aiplatform/test/gapic_vizier_service_v1beta1.ts @@ -1,4 +1,4 @@ -// Copyright 2022 Google LLC +// Copyright 2023 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License.