@maxim_mazurok/gapi.client.aiplatform-v1beta1 0.0.20230812 → 0.0.20230914

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/index.d.ts +366 -53
  2. package/package.json +1 -1
  3. package/tests.ts +118 -6
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://aiplatform.googleapis.com/$discovery/rest?version=v1beta1
12
- // Revision: 20230812
12
+ // Revision: 20230914
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -934,14 +934,11 @@ declare namespace gapi.client {
934
934
  GoogleCloudAiplatformV1beta1Feature;
935
935
  /**
936
936
  * 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
937
- * `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup.
937
+ * `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType .
938
938
  */
939
939
  featureId?:
940
940
  string;
941
- /**
942
- * Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format:
943
- * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}`
944
- */
941
+ /** Required. The resource name of the EntityType to create a Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` */
945
942
  parent?:
946
943
  string;
947
944
  }
@@ -987,7 +984,7 @@ declare namespace gapi.client {
987
984
  GoogleCloudAiplatformV1beta1PipelineJob;
988
985
  /**
989
986
  * 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
990
- * than 128 characters, and valid characters are /a-z-/.
987
+ * than 128 characters, and valid characters are `/a-z-/`.
991
988
  */
992
989
  pipelineJobId?:
993
990
  string;
@@ -1019,7 +1016,7 @@ declare namespace gapi.client {
1019
1016
  GoogleCloudAiplatformV1beta1TensorboardRun;
1020
1017
  /**
1021
1018
  * 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
1022
- * characters are /a-z-/.
1019
+ * characters are `/a-z-/`.
1023
1020
  */
1024
1021
  tensorboardRunId?:
1025
1022
  string;
@@ -1512,7 +1509,8 @@ declare namespace gapi.client {
1512
1509
  /**
1513
1510
  * Optional. A list of reserved ip ranges under the VPC network that can be used for this DeployedIndex. If set, we will deploy the index within the provided ip ranges. Otherwise, the
1514
1511
  * index might be deployed to any ip ranges under the provided VPC network. The value should be the name of the address
1515
- * (https://cloud.google.com/compute/docs/reference/rest/v1/addresses) Example: 'vertex-ai-ip-range'.
1512
+ * (https://cloud.google.com/compute/docs/reference/rest/v1/addresses) Example: ['vertex-ai-ip-range']. For more information about subnets and network IP ranges, please see
1513
+ * https://cloud.google.com/vpc/docs/subnets#manually_created_subnet_ip_ranges.
1516
1514
  */
1517
1515
  reservedIpRanges?:
1518
1516
  string[];
@@ -1576,7 +1574,7 @@ declare namespace gapi.client {
1576
1574
  GoogleCloudAiplatformV1beta1ExplanationSpec;
1577
1575
  /**
1578
1576
  * 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
1579
- * /[0-9]/.
1577
+ * `/[0-9]/`.
1580
1578
  */
1581
1579
  id?:
1582
1580
  string;
@@ -2320,6 +2318,21 @@ declare namespace gapi.client {
2320
2318
  exportedFiles?:
2321
2319
  string[];
2322
2320
  }
2321
+ interface GoogleCloudAiplatformV1beta1ExportEndpointOperationMetadata {
2322
+ /** The common part of the operation metadata. */
2323
+ genericMetadata?:
2324
+ GoogleCloudAiplatformV1beta1GenericOperationMetadata;
2325
+ }
2326
+ interface GoogleCloudAiplatformV1beta1ExportEndpointResponse {
2327
+ /** Information further describing the output of this Endpoint export. */
2328
+ outputInfo?:
2329
+ GoogleCloudAiplatformV1beta1ExportEndpointResponseOutputInfo;
2330
+ }
2331
+ interface GoogleCloudAiplatformV1beta1ExportEndpointResponseOutputInfo {
2332
+ /** If the Endpoint is being exported to BigQuery this is the full path of the BigQuery ML model created. */
2333
+ bigQueryDestination?:
2334
+ GoogleCloudAiplatformV1beta1BigQueryDestination;
2335
+ }
2323
2336
  interface GoogleCloudAiplatformV1beta1ExportFeatureValuesOperationMetadata {
2324
2337
  /** Operation metadata for Featurestore export Feature values. */
2325
2338
  genericMetadata?:
@@ -2495,7 +2508,7 @@ declare namespace gapi.client {
2495
2508
  /** Output only. Timestamp when this EntityType was most recently updated. */
2496
2509
  updateTime?:
2497
2510
  string;
2498
- /** Required. Immutable. Type of Feature value. */
2511
+ /** Immutable. Type of Feature value. */
2499
2512
  valueType?:
2500
2513
  string;
2501
2514
  }
@@ -3121,6 +3134,9 @@ declare namespace gapi.client {
3121
3134
  /** Required. The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters. */
3122
3135
  displayName?:
3123
3136
  string;
3137
+ /** Immutable. Customer-managed encryption key spec for an Index. If set, this Index and all sub-resources of this Index will be secured by this key. */
3138
+ encryptionSpec?:
3139
+ GoogleCloudAiplatformV1beta1EncryptionSpec;
3124
3140
  /** Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. */
3125
3141
  etag?:
3126
3142
  string;
@@ -3169,8 +3185,8 @@ declare namespace gapi.client {
3169
3185
  featureVector?:
3170
3186
  number[];
3171
3187
  /**
3172
- * 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:
3173
- * https://cloud.google.com/vertex-ai/docs/matching-engine/filtering
3188
+ * 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. This uses
3189
+ * categorical tokens. See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering
3174
3190
  */
3175
3191
  restricts?:
3176
3192
  GoogleCloudAiplatformV1beta1IndexDatapointRestriction[];
@@ -3184,13 +3200,13 @@ declare namespace gapi.client {
3184
3200
  string;
3185
3201
  }
3186
3202
  interface GoogleCloudAiplatformV1beta1IndexDatapointRestriction {
3187
- /** The attributes to allow in this namespace. eg: 'red' */
3203
+ /** The attributes to allow in this namespace. e.g.: 'red' */
3188
3204
  allowList?:
3189
3205
  string[];
3190
- /** The attributes to deny in this namespace. eg: 'blue' */
3206
+ /** The attributes to deny in this namespace. e.g.: 'blue' */
3191
3207
  denyList?:
3192
3208
  string[];
3193
- /** The namespace of this restriction. eg: color. */
3209
+ /** The namespace of this restriction. e.g.: color. */
3194
3210
  namespace?:
3195
3211
  string;
3196
3212
  }
@@ -3210,6 +3226,9 @@ declare namespace gapi.client {
3210
3226
  /** Optional. Deprecated: If true, expose the IndexEndpoint via private service connect. Only one of the fields, network or enable_private_service_connect, can be set. */
3211
3227
  enablePrivateServiceConnect?:
3212
3228
  boolean;
3229
+ /** Immutable. Customer-managed encryption key spec for an IndexEndpoint. If set, this IndexEndpoint and all sub-resources of this IndexEndpoint will be secured by this key. */
3230
+ encryptionSpec?:
3231
+ GoogleCloudAiplatformV1beta1EncryptionSpec;
3213
3232
  /** Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. */
3214
3233
  etag?:
3215
3234
  string;
@@ -4947,6 +4966,16 @@ declare namespace gapi.client {
4947
4966
  /** Output only. The health state of the NotebookRuntime. */
4948
4967
  healthState?:
4949
4968
  string;
4969
+ /**
4970
+ * The labels with user-defined metadata to organize your NotebookRuntime. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase
4971
+ * letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are
4972
+ * excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
4973
+ * Following system labels exist for NotebookRuntime: * "aiplatform.googleapis.com/notebook_runtime_gce_instance_id": output only, its value is the Compute Engine instance id. *
4974
+ * "aiplatform.googleapis.com/colab_enterprise_entry_service": its value is either "BigQuery" or "Vertex"; if absent, it should be "Vertex". This is to describe the entry service,
4975
+ * either BigQuery or Vertex.
4976
+ */
4977
+ labels?:
4978
+ { [P in string]: string };
4950
4979
  /** Output only. The resource name of the NotebookRuntime. */
4951
4980
  name?:
4952
4981
  string;
@@ -4968,6 +4997,9 @@ declare namespace gapi.client {
4968
4997
  /** Output only. Timestamp when this NotebookRuntime was most recently updated. */
4969
4998
  updateTime?:
4970
4999
  string;
5000
+ /** Output only. The VM os image version of NotebookRuntime. */
5001
+ version?:
5002
+ string;
4971
5003
  }
4972
5004
  interface GoogleCloudAiplatformV1beta1NotebookRuntimeTemplate {
4973
5005
  /** Output only. Timestamp when this NotebookRuntimeTemplate was created. */
@@ -5000,7 +5032,7 @@ declare namespace gapi.client {
5000
5032
  */
5001
5033
  labels?:
5002
5034
  { [P in string]: string };
5003
- /** Required. Immutable. The specification of a single machine used by the prediction. */
5035
+ /** Optional. Immutable. The specification of a single machine for the template. */
5004
5036
  machineSpec?:
5005
5037
  GoogleCloudAiplatformV1beta1MachineSpec;
5006
5038
  /** Output only. The resource name of the NotebookRuntimeTemplate. */
@@ -5693,11 +5725,11 @@ declare namespace gapi.client {
5693
5725
  }
5694
5726
  interface GoogleCloudAiplatformV1beta1RaySpec {
5695
5727
  /**
5696
- * Optional. Will use the machine from the first workerpool as the head node by default. For Ray-on-Vertex Experimental scope launch, we will only support one resource pool for Ray
5697
- * cluster and thus will not support head machine selection.
5728
+ * Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the
5729
+ * head node by default if this field is not set.
5698
5730
  */
5699
- headMachineSpec?:
5700
- GoogleCloudAiplatformV1beta1MachineSpec;
5731
+ headNodeResourcePoolId?:
5732
+ string;
5701
5733
  /**
5702
5734
  * Optional. Default image for user to choose a preferred ML framework(e.g. tensorflow or Pytorch) by choosing from Vertex prebuild
5703
5735
  * images(https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools
@@ -5705,6 +5737,12 @@ declare namespace gapi.client {
5705
5737
  */
5706
5738
  imageUri?:
5707
5739
  string;
5740
+ /**
5741
+ * Optional. Required if image_uri is not set. A map of resource_pool_id to prebuild Ray image if user need to use different images for different head/worker pools. This map needs to
5742
+ * cover all the resource pool ids. Example: { "ray_head_node_pool": "head image" "ray_worker_node_pool1": "worker image" "ray_worker_node_pool2": "another worker image" }
5743
+ */
5744
+ resourcePoolImages?:
5745
+ { [P in string]: string };
5708
5746
  }
5709
5747
  interface GoogleCloudAiplatformV1beta1ReadFeatureValuesRequest {
5710
5748
  /** 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`. */
@@ -5870,6 +5908,12 @@ declare namespace gapi.client {
5870
5908
  /** Output only. URIs for user to connect to the Cluster. Example: { "RAY_HEAD_NODE_INTERNAL_IP": "head-node-IP:10001" "RAY_DASHBOARD_URI": "ray-dashboard-address:8888" } */
5871
5909
  accessUris?:
5872
5910
  { [P in string]: string };
5911
+ /**
5912
+ * Output only. The resource name of NotebookRuntimeTemplate for the RoV Persistent Cluster The NotebokRuntimeTemplate is created in the same VPC (if set), and with the same Ray and
5913
+ * Python version as the Persistent Cluster. Example: "projects/1000/locations/us-central1/notebookRuntimeTemplates/abc123"
5914
+ */
5915
+ notebookRuntimeTemplate?:
5916
+ string;
5873
5917
  }
5874
5918
  interface GoogleCloudAiplatformV1beta1ResourceRuntimeSpec {
5875
5919
  /** Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource. */
@@ -8682,6 +8726,21 @@ declare namespace gapi.client {
8682
8726
  */
8683
8727
  clientId?:
8684
8728
  string;
8729
+ /**
8730
+ * Optional. This allows you to specify the "context" for a Trial; a context is a slice (a subspace) of the search space. Typical uses for contexts: 1) You are using Vizier to tune a
8731
+ * server for best performance, but there's a strong weekly cycle. The context specifies the day-of-week. This allows Tuesday to generalize from Wednesday without assuming that
8732
+ * everything is identical. 2) Imagine you're optimizing some medical treatment for people. As they walk in the door, you know certain facts about them (e.g. sex, weight, height,
8733
+ * blood-pressure). Put that information in the context, and Vizier will adapt its suggestions to the patient. 3) You want to do a fair A/B test efficiently. Specify the "A" and "B"
8734
+ * conditions as contexts, and Vizier will generalize between "A" and "B" conditions. If they are similar, this will allow Vizier to converge to the optimum faster than if "A" and "B"
8735
+ * were separate Studies. NOTE: You can also enter contexts as REQUESTED Trials, e.g. via the CreateTrial() RPC; that's the asynchronous option where you don't need a close association
8736
+ * between contexts and suggestions. NOTE: All the Parameters you set in a context MUST be defined in the Study. NOTE: You must supply 0 or $suggestion_count contexts. If you don't
8737
+ * supply any contexts, Vizier will make suggestions from the full search space specified in the StudySpec; if you supply a full set of context, each suggestion will match the
8738
+ * corresponding context. NOTE: A Context with no features set matches anything, and allows suggestions from the full search space. NOTE: Contexts MUST lie within the search space
8739
+ * specified in the StudySpec. It's an error if they don't. NOTE: Contexts preferentially match ACTIVE then REQUESTED trials before new suggestions are generated. NOTE: Generation of
8740
+ * suggestions involves a match between a Context and (optionally) a REQUESTED trial; if that match is not fully specified, a suggestion will be geneated in the merged subspace.
8741
+ */
8742
+ contexts?:
8743
+ GoogleCloudAiplatformV1beta1TrialContext[];
8685
8744
  /** Required. The number of suggestions requested. It must be positive. */
8686
8745
  suggestionCount?:
8687
8746
  number;
@@ -9107,6 +9166,18 @@ declare namespace gapi.client {
9107
9166
  webAccessUris?:
9108
9167
  { [P in string]: string };
9109
9168
  }
9169
+ interface GoogleCloudAiplatformV1beta1TrialContext {
9170
+ /** A human-readable field which can store a description of this context. This will become part of the resulting Trial's description field. */
9171
+ description?:
9172
+ string;
9173
+ /**
9174
+ * If/when a Trial is generated or selected from this Context, its Parameters will match any parameters specified here. (I.e. if this context specifies parameter name:'a' int_value:3,
9175
+ * then a resulting Trial will have int_value:3 for its parameter named 'a'.) Note that we first attempt to match existing REQUESTED Trials with contexts, and if there are no matches,
9176
+ * we generate suggestions in the subspace defined by the parameters specified here. NOTE: a Context without any Parameters matches the entire feasible search space.
9177
+ */
9178
+ parameters?:
9179
+ GoogleCloudAiplatformV1beta1TrialParameter[];
9180
+ }
9110
9181
  interface GoogleCloudAiplatformV1beta1TrialParameter {
9111
9182
  /** Output only. The ID of the parameter. The parameter should be defined in StudySpec's Parameters. */
9112
9183
  parameterId?:
@@ -9203,6 +9274,11 @@ declare namespace gapi.client {
9203
9274
  genericMetadata?:
9204
9275
  GoogleCloudAiplatformV1beta1GenericOperationMetadata;
9205
9276
  }
9277
+ interface GoogleCloudAiplatformV1beta1UpdatePersistentResourceOperationMetadata {
9278
+ /** Operation metadata for PersistentResource. */
9279
+ genericMetadata?:
9280
+ GoogleCloudAiplatformV1beta1GenericOperationMetadata;
9281
+ }
9206
9282
  interface GoogleCloudAiplatformV1beta1UpdateSpecialistPoolOperationMetadata {
9207
9283
  /** The operation generic information. */
9208
9284
  genericMetadata?:
@@ -16739,7 +16815,7 @@ declare namespace gapi.client {
16739
16815
  string;
16740
16816
  /**
16741
16817
  * 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
16742
- * `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup.
16818
+ * `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType .
16743
16819
  */
16744
16820
  featureId?:
16745
16821
  string;
@@ -16752,10 +16828,7 @@ declare namespace gapi.client {
16752
16828
  /** OAuth 2.0 token for the current user. */
16753
16829
  oauth_token?:
16754
16830
  string;
16755
- /**
16756
- * Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format:
16757
- * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}`
16758
- */
16831
+ /** Required. The resource name of the EntityType to create a Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` */
16759
16832
  parent:
16760
16833
  string;
16761
16834
  /** Returns response with indentations and line breaks. */
@@ -16789,7 +16862,7 @@ declare namespace gapi.client {
16789
16862
  string;
16790
16863
  /**
16791
16864
  * 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
16792
- * `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup.
16865
+ * `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType .
16793
16866
  */
16794
16867
  featureId?:
16795
16868
  string;
@@ -16802,10 +16875,7 @@ declare namespace gapi.client {
16802
16875
  /** OAuth 2.0 token for the current user. */
16803
16876
  oauth_token?:
16804
16877
  string;
16805
- /**
16806
- * Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format:
16807
- * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}`
16808
- */
16878
+ /** Required. The resource name of the EntityType to create a Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` */
16809
16879
  parent:
16810
16880
  string;
16811
16881
  /** Returns response with indentations and line breaks. */
@@ -16842,10 +16912,7 @@ declare namespace gapi.client {
16842
16912
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
16843
16913
  key?:
16844
16914
  string;
16845
- /**
16846
- * Required. The name of the Features to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}`
16847
- * `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}`
16848
- */
16915
+ /** Required. The name of the Features to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` */
16849
16916
  name:
16850
16917
  string;
16851
16918
  /** OAuth 2.0 token for the current user. */
@@ -16884,10 +16951,7 @@ declare namespace gapi.client {
16884
16951
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
16885
16952
  key?:
16886
16953
  string;
16887
- /**
16888
- * Required. The name of the Feature resource. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
16889
- * `projects/{project}/locations/{location}/featureGroups/{feature_group}`
16890
- */
16954
+ /** Required. The name of the Feature resource. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` */
16891
16955
  name:
16892
16956
  string;
16893
16957
  /** OAuth 2.0 token for the current user. */
@@ -16945,8 +17009,8 @@ declare namespace gapi.client {
16945
17009
  oauth_token?:
16946
17010
  string;
16947
17011
  /**
16948
- * 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` *
16949
- * `create_time` * `update_time`
17012
+ * 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` (Not
17013
+ * supported for FeatureRegistry Feature) * `create_time` * `update_time`
16950
17014
  */
16951
17015
  orderBy?:
16952
17016
  string;
@@ -16962,10 +17026,7 @@ declare namespace gapi.client {
16962
17026
  */
16963
17027
  pageToken?:
16964
17028
  string;
16965
- /**
16966
- * Required. The resource name of the Location to list Features. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
16967
- * `projects/{project}/locations/{location}/featureGroups/{feature_group}`
16968
- */
17029
+ /** Required. The resource name of the Location to list Features. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` */
16969
17030
  parent:
16970
17031
  string;
16971
17032
  /** Returns response with indentations and line breaks. */
@@ -27061,6 +27122,169 @@ declare namespace gapi.client {
27061
27122
  nasTrialDetails:
27062
27123
  NasTrialDetailsResource;
27063
27124
  }
27125
+ interface NotebookExecutionJobsResource {
27126
+ /** Internal only: Called from Compute Engine instance to obtain EUC for owner Anonymous access: authenticates caller using VM identity JWT. Design doc: go/colab-on-vertex-euc-dd */
27127
+ generateAccessToken(request: {
27128
+ /** V1 error format. */
27129
+ "$.xgafv"?:
27130
+ string;
27131
+ /** OAuth access token. */
27132
+ access_token?:
27133
+ string;
27134
+ /** Data format for response. */
27135
+ alt?:
27136
+ string;
27137
+ /** JSONP */
27138
+ callback?:
27139
+ string;
27140
+ /** Selector specifying which fields to include in a partial response. */
27141
+ fields?:
27142
+ string;
27143
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
27144
+ key?:
27145
+ string;
27146
+ /** Required. The name of the NotebookRuntime resource. Format: `projects/{project}/locations/{location}/notebookRuntimes/{notebook_runtime}` */
27147
+ name:
27148
+ string;
27149
+ /** OAuth 2.0 token for the current user. */
27150
+ oauth_token?:
27151
+ string;
27152
+ /** Returns response with indentations and line breaks. */
27153
+ prettyPrint?:
27154
+ boolean;
27155
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
27156
+ quotaUser?:
27157
+ string;
27158
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
27159
+ upload_protocol?:
27160
+ string;
27161
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
27162
+ uploadType?:
27163
+ string;
27164
+ /** Request body */
27165
+ resource:
27166
+ GoogleCloudAiplatformV1beta1GenerateAccessTokenRequest;
27167
+ }): Request<GoogleCloudAiplatformV1beta1GenerateAccessTokenResponse>;
27168
+ generateAccessToken(request: {
27169
+ /** V1 error format. */
27170
+ "$.xgafv"?:
27171
+ string;
27172
+ /** OAuth access token. */
27173
+ access_token?:
27174
+ string;
27175
+ /** Data format for response. */
27176
+ alt?:
27177
+ string;
27178
+ /** JSONP */
27179
+ callback?:
27180
+ string;
27181
+ /** Selector specifying which fields to include in a partial response. */
27182
+ fields?:
27183
+ string;
27184
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
27185
+ key?:
27186
+ string;
27187
+ /** Required. The name of the NotebookRuntime resource. Format: `projects/{project}/locations/{location}/notebookRuntimes/{notebook_runtime}` */
27188
+ name:
27189
+ string;
27190
+ /** OAuth 2.0 token for the current user. */
27191
+ oauth_token?:
27192
+ string;
27193
+ /** Returns response with indentations and line breaks. */
27194
+ prettyPrint?:
27195
+ boolean;
27196
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
27197
+ quotaUser?:
27198
+ string;
27199
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
27200
+ upload_protocol?:
27201
+ string;
27202
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
27203
+ uploadType?:
27204
+ string;
27205
+ },
27206
+ body: GoogleCloudAiplatformV1beta1GenerateAccessTokenRequest): Request<GoogleCloudAiplatformV1beta1GenerateAccessTokenResponse>;
27207
+ reportEvent(request: {
27208
+ /** V1 error format. */
27209
+ "$.xgafv"?:
27210
+ string;
27211
+ /** OAuth access token. */
27212
+ access_token?:
27213
+ string;
27214
+ /** Data format for response. */
27215
+ alt?:
27216
+ string;
27217
+ /** JSONP */
27218
+ callback?:
27219
+ string;
27220
+ /** Selector specifying which fields to include in a partial response. */
27221
+ fields?:
27222
+ string;
27223
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
27224
+ key?:
27225
+ string;
27226
+ /** Required. The name of the NotebookRuntime resource. Format: `projects/{project}/locations/{location}/notebookRuntimes/{notebook_runtime}` */
27227
+ name:
27228
+ string;
27229
+ /** OAuth 2.0 token for the current user. */
27230
+ oauth_token?:
27231
+ string;
27232
+ /** Returns response with indentations and line breaks. */
27233
+ prettyPrint?:
27234
+ boolean;
27235
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
27236
+ quotaUser?:
27237
+ string;
27238
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
27239
+ upload_protocol?:
27240
+ string;
27241
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
27242
+ uploadType?:
27243
+ string;
27244
+ /** Request body */
27245
+ resource:
27246
+ GoogleCloudAiplatformV1beta1ReportRuntimeEventRequest;
27247
+ }): Request<GoogleCloudAiplatformV1beta1ReportRuntimeEventResponse>;
27248
+ reportEvent(request: {
27249
+ /** V1 error format. */
27250
+ "$.xgafv"?:
27251
+ string;
27252
+ /** OAuth access token. */
27253
+ access_token?:
27254
+ string;
27255
+ /** Data format for response. */
27256
+ alt?:
27257
+ string;
27258
+ /** JSONP */
27259
+ callback?:
27260
+ string;
27261
+ /** Selector specifying which fields to include in a partial response. */
27262
+ fields?:
27263
+ string;
27264
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
27265
+ key?:
27266
+ string;
27267
+ /** Required. The name of the NotebookRuntime resource. Format: `projects/{project}/locations/{location}/notebookRuntimes/{notebook_runtime}` */
27268
+ name:
27269
+ string;
27270
+ /** OAuth 2.0 token for the current user. */
27271
+ oauth_token?:
27272
+ string;
27273
+ /** Returns response with indentations and line breaks. */
27274
+ prettyPrint?:
27275
+ boolean;
27276
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
27277
+ quotaUser?:
27278
+ string;
27279
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
27280
+ upload_protocol?:
27281
+ string;
27282
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
27283
+ uploadType?:
27284
+ string;
27285
+ },
27286
+ body: GoogleCloudAiplatformV1beta1ReportRuntimeEventRequest): Request<GoogleCloudAiplatformV1beta1ReportRuntimeEventResponse>;
27287
+ }
27064
27288
  interface NotebookRuntimesResource {
27065
27289
  /** Assigns a NotebookRuntime to a user for a particular Notebook file. This method will either returns an existing assignment or generates a new one. */
27066
27290
  assign(request: {
@@ -28399,7 +28623,7 @@ declare namespace gapi.client {
28399
28623
  string;
28400
28624
  /**
28401
28625
  * Required. The ID to use for the PersistentResource, which become the final component of the PersistentResource's resource name. The maximum length is 63 characters, and valid
28402
- * characters are /^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/.
28626
+ * characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.
28403
28627
  */
28404
28628
  persistentResourceId?:
28405
28629
  string;
@@ -28446,7 +28670,7 @@ declare namespace gapi.client {
28446
28670
  string;
28447
28671
  /**
28448
28672
  * Required. The ID to use for the PersistentResource, which become the final component of the PersistentResource's resource name. The maximum length is 63 characters, and valid
28449
- * characters are /^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/.
28673
+ * characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.
28450
28674
  */
28451
28675
  persistentResourceId?:
28452
28676
  string;
@@ -28590,6 +28814,93 @@ declare namespace gapi.client {
28590
28814
  uploadType?:
28591
28815
  string;
28592
28816
  }): Request<GoogleCloudAiplatformV1beta1ListPersistentResourcesResponse>;
28817
+ /** Updates a PersistentResource. */
28818
+ patch(request: {
28819
+ /** V1 error format. */
28820
+ "$.xgafv"?:
28821
+ string;
28822
+ /** OAuth access token. */
28823
+ access_token?:
28824
+ string;
28825
+ /** Data format for response. */
28826
+ alt?:
28827
+ string;
28828
+ /** JSONP */
28829
+ callback?:
28830
+ string;
28831
+ /** Selector specifying which fields to include in a partial response. */
28832
+ fields?:
28833
+ string;
28834
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
28835
+ key?:
28836
+ string;
28837
+ /** Immutable. Resource name of a PersistentResource. */
28838
+ name:
28839
+ string;
28840
+ /** OAuth 2.0 token for the current user. */
28841
+ oauth_token?:
28842
+ string;
28843
+ /** Returns response with indentations and line breaks. */
28844
+ prettyPrint?:
28845
+ boolean;
28846
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
28847
+ quotaUser?:
28848
+ string;
28849
+ /** Required. Specify the fields to be overwritten in the PersistentResource by the update method. */
28850
+ updateMask?:
28851
+ string;
28852
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
28853
+ upload_protocol?:
28854
+ string;
28855
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
28856
+ uploadType?:
28857
+ string;
28858
+ /** Request body */
28859
+ resource:
28860
+ GoogleCloudAiplatformV1beta1PersistentResource;
28861
+ }): Request<GoogleLongrunningOperation>;
28862
+ patch(request: {
28863
+ /** V1 error format. */
28864
+ "$.xgafv"?:
28865
+ string;
28866
+ /** OAuth access token. */
28867
+ access_token?:
28868
+ string;
28869
+ /** Data format for response. */
28870
+ alt?:
28871
+ string;
28872
+ /** JSONP */
28873
+ callback?:
28874
+ string;
28875
+ /** Selector specifying which fields to include in a partial response. */
28876
+ fields?:
28877
+ string;
28878
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
28879
+ key?:
28880
+ string;
28881
+ /** Immutable. Resource name of a PersistentResource. */
28882
+ name:
28883
+ string;
28884
+ /** OAuth 2.0 token for the current user. */
28885
+ oauth_token?:
28886
+ string;
28887
+ /** Returns response with indentations and line breaks. */
28888
+ prettyPrint?:
28889
+ boolean;
28890
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
28891
+ quotaUser?:
28892
+ string;
28893
+ /** Required. Specify the fields to be overwritten in the PersistentResource by the update method. */
28894
+ updateMask?:
28895
+ string;
28896
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
28897
+ upload_protocol?:
28898
+ string;
28899
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
28900
+ uploadType?:
28901
+ string;
28902
+ },
28903
+ body: GoogleCloudAiplatformV1beta1PersistentResource): Request<GoogleLongrunningOperation>;
28593
28904
  operations:
28594
28905
  OperationsResource;
28595
28906
  }
@@ -28933,7 +29244,7 @@ declare namespace gapi.client {
28933
29244
  string;
28934
29245
  /**
28935
29246
  * 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
28936
- * less than 128 characters, and valid characters are /a-z-/.
29247
+ * less than 128 characters, and valid characters are `/a-z-/`.
28937
29248
  */
28938
29249
  pipelineJobId?:
28939
29250
  string;
@@ -28980,7 +29291,7 @@ declare namespace gapi.client {
28980
29291
  string;
28981
29292
  /**
28982
29293
  * 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
28983
- * less than 128 characters, and valid characters are /a-z-/.
29294
+ * less than 128 characters, and valid characters are `/a-z-/`.
28984
29295
  */
28985
29296
  pipelineJobId?:
28986
29297
  string;
@@ -33768,7 +34079,7 @@ declare namespace gapi.client {
33768
34079
  string;
33769
34080
  /**
33770
34081
  * 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
33771
- * characters are /a-z-/.
34082
+ * characters are `/a-z-/`.
33772
34083
  */
33773
34084
  tensorboardRunId?:
33774
34085
  string;
@@ -33818,7 +34129,7 @@ declare namespace gapi.client {
33818
34129
  string;
33819
34130
  /**
33820
34131
  * 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
33821
- * characters are /a-z-/.
34132
+ * characters are `/a-z-/`.
33822
34133
  */
33823
34134
  tensorboardRunId?:
33824
34135
  string;
@@ -34191,7 +34502,7 @@ declare namespace gapi.client {
34191
34502
  string;
34192
34503
  /**
34193
34504
  * 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,
34194
- * and valid characters are /a-z-/.
34505
+ * and valid characters are `/a-z-/`.
34195
34506
  */
34196
34507
  tensorboardExperimentId?:
34197
34508
  string;
@@ -34238,7 +34549,7 @@ declare namespace gapi.client {
34238
34549
  string;
34239
34550
  /**
34240
34551
  * 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,
34241
- * and valid characters are /a-z-/.
34552
+ * and valid characters are `/a-z-/`.
34242
34553
  */
34243
34554
  tensorboardExperimentId?:
34244
34555
  string;
@@ -35852,6 +36163,8 @@ declare namespace gapi.client {
35852
36163
  ModelsResource;
35853
36164
  nasJobs:
35854
36165
  NasJobsResource;
36166
+ notebookExecutionJobs:
36167
+ NotebookExecutionJobsResource;
35855
36168
  notebookRuntimes:
35856
36169
  NotebookRuntimesResource;
35857
36170
  notebookRuntimeTemplates:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.aiplatform-v1beta1",
3
- "version": "0.0.20230812",
3
+ "version": "0.0.20230914",
4
4
  "description": "TypeScript typings for Vertex AI API v1beta1",
5
5
  "license": "MIT",
6
6
  "author": {
package/tests.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
4
4
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
5
5
 
6
- // Revision: 20230812
6
+ // Revision: 20230914
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */
@@ -3575,6 +3575,9 @@ gapi.load('client', async () => {
3575
3575
  description: "Test string",
3576
3576
  displayName: "Test string",
3577
3577
  enablePrivateServiceConnect: true,
3578
+ encryptionSpec: {
3579
+ kmsKeyName: "Test string",
3580
+ },
3578
3581
  etag: "Test string",
3579
3582
  labels: {
3580
3583
  A: "Test string"
@@ -3796,6 +3799,9 @@ gapi.load('client', async () => {
3796
3799
  description: "Test string",
3797
3800
  displayName: "Test string",
3798
3801
  enablePrivateServiceConnect: true,
3802
+ encryptionSpec: {
3803
+ kmsKeyName: "Test string",
3804
+ },
3799
3805
  etag: "Test string",
3800
3806
  labels: {
3801
3807
  A: "Test string"
@@ -3877,6 +3883,9 @@ gapi.load('client', async () => {
3877
3883
  ],
3878
3884
  description: "Test string",
3879
3885
  displayName: "Test string",
3886
+ encryptionSpec: {
3887
+ kmsKeyName: "Test string",
3888
+ },
3880
3889
  etag: "Test string",
3881
3890
  indexStats: {
3882
3891
  shardsCount: 42,
@@ -3921,6 +3930,9 @@ gapi.load('client', async () => {
3921
3930
  ],
3922
3931
  description: "Test string",
3923
3932
  displayName: "Test string",
3933
+ encryptionSpec: {
3934
+ kmsKeyName: "Test string",
3935
+ },
3924
3936
  etag: "Test string",
3925
3937
  indexStats: {
3926
3938
  shardsCount: 42,
@@ -5937,6 +5949,21 @@ gapi.load('client', async () => {
5937
5949
  pageToken: "Test string",
5938
5950
  parent: "Test string",
5939
5951
  });
5952
+ /** Internal only: Called from Compute Engine instance to obtain EUC for owner Anonymous access: authenticates caller using VM identity JWT. Design doc: go/colab-on-vertex-euc-dd */
5953
+ await gapi.client.aiplatform.projects.locations.notebookExecutionJobs.generateAccessToken({
5954
+ name: "Test string",
5955
+ }, {
5956
+ vmToken: "Test string",
5957
+ });
5958
+ await gapi.client.aiplatform.projects.locations.notebookExecutionJobs.reportEvent({
5959
+ name: "Test string",
5960
+ }, {
5961
+ eventDetails: {
5962
+ A: "Test string"
5963
+ },
5964
+ eventType: "Test string",
5965
+ vmToken: "Test string",
5966
+ });
5940
5967
  /** Assigns a NotebookRuntime to a user for a particular Notebook file. This method will either returns an existing assignment or generates a new one. */
5941
5968
  await gapi.client.aiplatform.projects.locations.notebookRuntimes.assign({
5942
5969
  parent: "Test string",
@@ -5947,6 +5974,9 @@ gapi.load('client', async () => {
5947
5974
  displayName: "Test string",
5948
5975
  expirationTime: "Test string",
5949
5976
  healthState: "Test string",
5977
+ labels: {
5978
+ A: "Test string"
5979
+ },
5950
5980
  name: "Test string",
5951
5981
  notebookRuntimeTemplateRef: {
5952
5982
  notebookRuntimeTemplate: "Test string",
@@ -5956,6 +5986,7 @@ gapi.load('client', async () => {
5956
5986
  runtimeUser: "Test string",
5957
5987
  serviceAccount: "Test string",
5958
5988
  updateTime: "Test string",
5989
+ version: "Test string",
5959
5990
  },
5960
5991
  notebookRuntimeId: "Test string",
5961
5992
  notebookRuntimeTemplate: "Test string",
@@ -6177,15 +6208,15 @@ gapi.load('client', async () => {
6177
6208
  accessUris: {
6178
6209
  A: "Test string"
6179
6210
  },
6211
+ notebookRuntimeTemplate: "Test string",
6180
6212
  },
6181
6213
  resourceRuntimeSpec: {
6182
6214
  raySpec: {
6183
- headMachineSpec: {
6184
- acceleratorCount: 42,
6185
- acceleratorType: "Test string",
6186
- machineType: "Test string",
6187
- },
6215
+ headNodeResourcePoolId: "Test string",
6188
6216
  imageUri: "Test string",
6217
+ resourcePoolImages: {
6218
+ A: "Test string"
6219
+ },
6189
6220
  },
6190
6221
  serviceAccountSpec: {
6191
6222
  enableCustomServiceAccount: true,
@@ -6210,6 +6241,76 @@ gapi.load('client', async () => {
6210
6241
  pageToken: "Test string",
6211
6242
  parent: "Test string",
6212
6243
  });
6244
+ /** Updates a PersistentResource. */
6245
+ await gapi.client.aiplatform.projects.locations.persistentResources.patch({
6246
+ name: "Test string",
6247
+ updateMask: "Test string",
6248
+ }, {
6249
+ createTime: "Test string",
6250
+ displayName: "Test string",
6251
+ encryptionSpec: {
6252
+ kmsKeyName: "Test string",
6253
+ },
6254
+ error: {
6255
+ code: 42,
6256
+ details: [
6257
+ {
6258
+ A: 42
6259
+ }
6260
+ ],
6261
+ message: "Test string",
6262
+ },
6263
+ labels: {
6264
+ A: "Test string"
6265
+ },
6266
+ name: "Test string",
6267
+ network: "Test string",
6268
+ reservedIpRanges: [
6269
+ "Test string"
6270
+ ],
6271
+ resourcePools: [
6272
+ {
6273
+ autoscalingSpec: {
6274
+ maxReplicaCount: "Test string",
6275
+ minReplicaCount: "Test string",
6276
+ },
6277
+ diskSpec: {
6278
+ bootDiskSizeGb: 42,
6279
+ bootDiskType: "Test string",
6280
+ },
6281
+ id: "Test string",
6282
+ machineSpec: {
6283
+ acceleratorCount: 42,
6284
+ acceleratorType: "Test string",
6285
+ machineType: "Test string",
6286
+ },
6287
+ replicaCount: "Test string",
6288
+ usedReplicaCount: "Test string",
6289
+ }
6290
+ ],
6291
+ resourceRuntime: {
6292
+ accessUris: {
6293
+ A: "Test string"
6294
+ },
6295
+ notebookRuntimeTemplate: "Test string",
6296
+ },
6297
+ resourceRuntimeSpec: {
6298
+ raySpec: {
6299
+ headNodeResourcePoolId: "Test string",
6300
+ imageUri: "Test string",
6301
+ resourcePoolImages: {
6302
+ A: "Test string"
6303
+ },
6304
+ },
6305
+ serviceAccountSpec: {
6306
+ enableCustomServiceAccount: true,
6307
+ serviceAccount: "Test string",
6308
+ },
6309
+ },
6310
+ startTime: "Test string",
6311
+ state: "Test string",
6312
+ updateTime: "Test string",
6313
+ });
6213
6314
  /**
6214
6315
  * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this
6215
6316
  * method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation
@@ -7579,6 +7680,17 @@ gapi.load('client', async () => {
7579
7680
  parent: "Test string",
7580
7681
  }, {
7581
7682
  clientId: "Test string",
7683
+ contexts: [
7684
+ {
7685
+ description: "Test string",
7686
+ parameters: [
7687
+ {
7688
+ parameterId: "Test string",
7689
+ value: 42,
7690
+ }
7691
+ ],
7692
+ }
7693
+ ],
7582
7694
  suggestionCount: 42,
7583
7695
  });
7584
7696
  /**