@maxim_mazurok/gapi.client.aiplatform-v1 0.0.20231012 → 0.0.20231023

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://aiplatform.googleapis.com/$discovery/rest?version=v1
-// Revision: 20231012
+// Revision: 20231023
 
 /// <reference types="gapi.client" />
 
@@ -890,6 +890,11 @@ declare namespace gapi.client {
              */
             featureId?:
                 string;
+            /**
+             * Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent:
+             * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent:
+             * `projects/{project}/locations/{location}/featureGroups/{feature_group}`
+             */
             parent?:
                 string;
         }
@@ -1072,6 +1077,12 @@ declare namespace gapi.client {
              */
             network?:
                 string;
+            /**
+             * The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations:
+             * https://cloud.google.com/vertex-ai/docs/general/locations
+             */
+            protectedArtifactLocationId?:
+                string;
             /**
              * Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise,
              * the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
@@ -2376,15 +2387,15 @@ declare namespace gapi.client {
                 GoogleCloudAiplatformV1TimeSeriesDataPoint[];
         }
         interface GoogleCloudAiplatformV1Feature {
-            /** Output only. Timestamp when this EntityType was created. */
+            /** Output only. Only applicable for Vertex AI Feature Store (Legacy). Timestamp when this EntityType was created. */
             createTime?:
                 string;
             /** Description of the Feature. */
             description?:
                 string;
             /**
-             * Optional. If not set, use the monitoring_config defined for the EntityType this Feature belongs to. Only Features with type (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.
+             * Optional. Only applicable for Vertex AI Feature Store (Legacy). If not set, use the monitoring_config defined for the EntityType this Feature belongs to. Only Features with type
+             * (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.
              */
             disableMonitoring?:
                 boolean;
@@ -2398,20 +2409,20 @@ declare namespace gapi.client {
              */
             labels?:
                 { [P in string]: string };
-            /** Output only. The list of historical stats and anomalies with specified objectives. */
+            /** Output only. Only applicable for Vertex AI Feature Store (Legacy). The list of historical stats and anomalies with specified objectives. */
             monitoringStatsAnomalies?:
                 GoogleCloudAiplatformV1FeatureMonitoringStatsAnomaly[];
             /**
-             * Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` The last part feature is
-             * assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a
-             * letter. The value will be unique given an entity type.
+             * Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}`
+             * `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}` The last part feature is assigned by the client. The feature can be up to 64 characters
+             * long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type.
              */
             name?:
                 string;
-            /** Output only. Timestamp when this EntityType was most recently updated. */
+            /** Output only. Only applicable for Vertex AI Feature Store (Legacy). Timestamp when this EntityType was most recently updated. */
             updateTime?:
                 string;
-            /** Immutable. Type of Feature value. */
+            /** Immutable. Only applicable for Vertex AI Feature Store (Legacy). Type of Feature value. */
             valueType?:
                 string;
         }
@@ -8193,6 +8204,9 @@ declare namespace gapi.client {
             /** Required. The set of parameters to tune. */
             parameters?:
                 GoogleCloudAiplatformV1StudySpecParameterSpec[];
+            /** Conditions for automated stopping of a Study. Enable automated stopping by configuring at least one condition. */
+            studyStoppingConfig?:
+                GoogleCloudAiplatformV1StudySpecStudyStoppingConfig;
         }
         interface GoogleCloudAiplatformV1StudySpecConvexAutomatedStoppingSpec {
             /**
@@ -8379,6 +8393,49 @@ declare namespace gapi.client {
             minValue?:
                 string;
         }
+        interface GoogleCloudAiplatformV1StudySpecStudyStoppingConfig {
+            /** If the objective value has not improved for this much time, stop the study. WARNING: Effective only for single-objective studies. */
+            maxDurationNoProgress?:
+                string;
+            /** If the specified time or duration has passed, stop the study. */
+            maximumRuntimeConstraint?:
+                GoogleCloudAiplatformV1StudyTimeConstraint;
+            /** If there are more than this many trials, stop the study. */
+            maxNumTrials?:
+                number;
+            /** If the objective value has not improved for this many consecutive trials, stop the study. WARNING: Effective only for single-objective studies. */
+            maxNumTrialsNoProgress?:
+                number;
+            /**
+             * Each "stopping rule" in this proto specifies an "if" condition. Before Vizier would generate a new suggestion, it first checks each specified stopping rule, from top to bottom in
+             * this list. Note that the first few rules (e.g. minimum_runtime_constraint, min_num_trials) will prevent other stopping rules from being evaluated until they are met. For example,
+             * setting `min_num_trials=5` and `always_stop_after= 1 hour` means that the Study will ONLY stop after it has 5 COMPLETED trials, even if more than an hour has passed since its
+             * creation. It follows the first applicable rule (whose "if" condition is satisfied) to make a stopping decision. If none of the specified rules are applicable, then Vizier decides
+             * that the study should not stop. If Vizier decides that the study should stop, the study enters STOPPING state (or STOPPING_ASAP if should_stop_asap = true). IMPORTANT: The automatic
+             * study state transition happens precisely as described above; that is, deleting trials or updating StudyConfig NEVER automatically moves the study state back to ACTIVE. If you want
+             * to _resume_ a Study that was stopped, 1) change the stopping conditions if necessary, 2) activate the study, and then 3) ask for suggestions. If the specified time or duration has
+             * not passed, do not stop the study.
+             */
+            minimumRuntimeConstraint?:
+                GoogleCloudAiplatformV1StudyTimeConstraint;
+            /** If there are fewer than this many COMPLETED trials, do not stop the study. */
+            minNumTrials?:
+                number;
+            /**
+             * If true, a Study enters STOPPING_ASAP whenever it would normally enters STOPPING state. The bottom line is: set to true if you want to interrupt on-going evaluations of Trials as
+             * soon as the study stopping condition is met. (Please see Study.State documentation for the source of truth).
+             */
+            shouldStopAsap?:
+                boolean;
+        }
+        interface GoogleCloudAiplatformV1StudyTimeConstraint {
+            /** Compares the wallclock time to this time. Must use UTC timezone. */
+            endTime?:
+                string;
+            /** Counts the wallclock time passed since the creation of this Study. */
+            maxDuration?:
+                string;
+        }
         interface GoogleCloudAiplatformV1SuggestTrialsMetadata {
             /**
              * 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
@@ -14582,6 +14639,11 @@ declare namespace gapi.client {
                 /** OAuth 2.0 token for the current user. */
                 oauth_token?:
                     string;
+                /**
+                 * Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent:
+                 * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent:
+                 * `projects/{project}/locations/{location}/featureGroups/{feature_group}`
+                 */
                 parent:
                     string;
                 /** Returns response with indentations and line breaks. */
@@ -14628,6 +14690,11 @@ declare namespace gapi.client {
                 /** OAuth 2.0 token for the current user. */
                 oauth_token?:
                     string;
+                /**
+                 * Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent:
+                 * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent:
+                 * `projects/{project}/locations/{location}/featureGroups/{feature_group}`
+                 */
                 parent:
                     string;
                 /** Returns response with indentations and line breaks. */
@@ -14707,8 +14774,8 @@ declare namespace gapi.client {
                 key?:
                     string;
                 /**
-                 * Required. The name of the Feature resource. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
-                 * `projects/{project}/locations/{location}/featureGroups/{feature_group}`
+                 * Required. The name of the Feature resource. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
+                 * Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`
                  */
                 name:
                     string;
@@ -14758,8 +14825,8 @@ declare namespace gapi.client {
                 key?:
                     string;
                 /**
-                 * If set, return the most recent 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, return all existing stats.
+                 * Only applicable for Vertex AI Feature Store (Legacy). If set, return the most recent 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, return all existing stats.
                  */
                 latestStatsCount?:
                     number;
@@ -14779,13 +14846,14 @@ declare namespace gapi.client {
                 pageSize?:
                     number;
                 /**
-                 * A page token, received from a previous FeaturestoreService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to
-                 * FeaturestoreService.ListFeatures must match the call that provided the page token.
+                 * A page token, received from a previous FeaturestoreService.ListFeatures call or FeatureRegistryService.ListFeatures call. Provide this to retrieve the subsequent page. When
+                 * paginating, all other parameters provided to FeaturestoreService.ListFeatures or or FeatureRegistryService.ListFeatures must match the call that provided the page token.
                  */
                 pageToken?:
                     string;
                 /**
-                 * Required. The resource name of the Location to list Features. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
+                 * Required. The resource name of the Location to list Features. Format for entity_type as parent:
+                 * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent:
                  * `projects/{project}/locations/{location}/featureGroups/{feature_group}`
                  */
                 parent:
@@ -14827,9 +14895,10 @@ declare namespace gapi.client {
                 key?:
                     string;
                 /**
-                 * Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` The last part feature
-                 * is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with
-                 * a letter. The value will be unique given an entity type.
+                 * Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}`
+                 * `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}` The last part feature is assigned by the client. The feature can be up to 64
+                 * characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity
+                 * type.
                  */
                 name:
                     string;
@@ -14845,7 +14914,7 @@ declare namespace gapi.client {
                 /**
                  * 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`
+                 * Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistry Feature)
                  */
                 updateMask?:
                     string;
@@ -14879,9 +14948,10 @@ declare namespace gapi.client {
                 key?:
                     string;
                 /**
-                 * Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` The last part feature
-                 * is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with
-                 * a letter. The value will be unique given an entity type.
+                 * Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}`
+                 * `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}` The last part feature is assigned by the client. The feature can be up to 64
+                 * characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity
+                 * type.
                  */
                 name:
                     string;
@@ -14897,7 +14967,7 @@ declare namespace gapi.client {
                 /**
                  * 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`
+                 * Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistry Feature)
                  */
                 updateMask?:
                     string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.aiplatform-v1",
-  "version": "0.0.20231012",
+  "version": "0.0.20231023",
   "description": "TypeScript typings for Vertex AI API v1",
   "license": "MIT",
   "author": {

package/tests.ts

@@ -3,7 +3,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 
-// Revision: 20231012
+// Revision: 20231023
 
 gapi.load('client', async () => {
     /** now we can use gapi.client */
@@ -343,6 +343,7 @@ gapi.load('client', async () => {
                 experiment: "Test string",
                 experimentRun: "Test string",
                 network: "Test string",
+                protectedArtifactLocationId: "Test string",
                 reservedIpRanges: [
                     "Test string"
                 ],
@@ -2766,6 +2767,21 @@ gapi.load('client', async () => {
                         scaleType: "Test string",
                     }
                 ],
+                studyStoppingConfig: {
+                    maxDurationNoProgress: "Test string",
+                    maximumRuntimeConstraint: {
+                        endTime: "Test string",
+                        maxDuration: "Test string",
+                    },
+                    maxNumTrials: 42,
+                    maxNumTrialsNoProgress: 42,
+                    minimumRuntimeConstraint: {
+                        endTime: "Test string",
+                        maxDuration: "Test string",
+                    },
+                    minNumTrials: 42,
+                    shouldStopAsap: true,
+                },
             },
             trialJobSpec: {
                 baseOutputDirectory: {
@@ -2776,6 +2792,7 @@ gapi.load('client', async () => {
                 experiment: "Test string",
                 experimentRun: "Test string",
                 network: "Test string",
+                protectedArtifactLocationId: "Test string",
                 reservedIpRanges: [
                     "Test string"
                 ],
@@ -5087,6 +5104,7 @@ gapi.load('client', async () => {
                             experiment: "Test string",
                             experimentRun: "Test string",
                             network: "Test string",
+                            protectedArtifactLocationId: "Test string",
                             reservedIpRanges: [
                                 "Test string"
                             ],
@@ -5164,6 +5182,7 @@ gapi.load('client', async () => {
                             experiment: "Test string",
                             experimentRun: "Test string",
                             network: "Test string",
+                            protectedArtifactLocationId: "Test string",
                             reservedIpRanges: [
                                 "Test string"
                             ],
@@ -6562,6 +6581,21 @@ gapi.load('client', async () => {
                         scaleType: "Test string",
                     }
                 ],
+                studyStoppingConfig: {
+                    maxDurationNoProgress: "Test string",
+                    maximumRuntimeConstraint: {
+                        endTime: "Test string",
+                        maxDuration: "Test string",
+                    },
+                    maxNumTrials: 42,
+                    maxNumTrialsNoProgress: 42,
+                    minimumRuntimeConstraint: {
+                        endTime: "Test string",
+                        maxDuration: "Test string",
+                    },
+                    minNumTrials: 42,
+                    shouldStopAsap: true,
+                },
             },
         });
         /** Deletes a Study. */