@maxim_mazurok/gapi.client.aiplatform-v1 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 +969 -46
  2. package/package.json +1 -1
  3. package/tests.ts +165 -1
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=v1
12
- // Revision: 20230812
12
+ // Revision: 20230914
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -185,6 +185,25 @@ declare namespace gapi.client {
185
185
  uri?:
186
186
  string;
187
187
  }
188
+ interface GoogleCloudAiplatformV1AssignNotebookRuntimeOperationMetadata {
189
+ /** The operation generic information. */
190
+ genericMetadata?:
191
+ GoogleCloudAiplatformV1GenericOperationMetadata;
192
+ /** A human-readable message that shows the intermediate progress details of NotebookRuntime. */
193
+ progressMessage?:
194
+ string;
195
+ }
196
+ interface GoogleCloudAiplatformV1AssignNotebookRuntimeRequest {
197
+ /** Required. Provide runtime specific information (e.g. runtime owner, notebook id) used for NotebookRuntime assignment. */
198
+ notebookRuntime?:
199
+ GoogleCloudAiplatformV1NotebookRuntime;
200
+ /** Optional. User specified ID for the notebook runtime. */
201
+ notebookRuntimeId?:
202
+ string;
203
+ /** Required. The resource name of the NotebookRuntimeTemplate based on which a NotebookRuntime will be assigned (reuse or create a new one). */
204
+ notebookRuntimeTemplate?:
205
+ string;
206
+ }
188
207
  interface GoogleCloudAiplatformV1Attribution {
189
208
  /**
190
209
  * Output only. Error of feature_attributions caused by approximation used in the explanation method. Lower value means more precise attributions. * For Sampled Shapley attribution,
@@ -867,14 +886,11 @@ declare namespace gapi.client {
867
886
  GoogleCloudAiplatformV1Feature;
868
887
  /**
869
888
  * 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
870
- * `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup.
889
+ * `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType .
871
890
  */
872
891
  featureId?:
873
892
  string;
874
- /**
875
- * Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format:
876
- * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}`
877
- */
893
+ /** Required. The resource name of the EntityType to create a Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` */
878
894
  parent?:
879
895
  string;
880
896
  }
@@ -901,6 +917,11 @@ declare namespace gapi.client {
901
917
  genericMetadata?:
902
918
  GoogleCloudAiplatformV1GenericOperationMetadata;
903
919
  }
920
+ interface GoogleCloudAiplatformV1CreateNotebookRuntimeTemplateOperationMetadata {
921
+ /** The operation generic information. */
922
+ genericMetadata?:
923
+ GoogleCloudAiplatformV1GenericOperationMetadata;
924
+ }
904
925
  interface GoogleCloudAiplatformV1CreatePipelineJobRequest {
905
926
  /** Required. The resource name of the Location to create the PipelineJob in. Format: `projects/{project}/locations/{location}` */
906
927
  parent?:
@@ -910,7 +931,7 @@ declare namespace gapi.client {
910
931
  GoogleCloudAiplatformV1PipelineJob;
911
932
  /**
912
933
  * 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
913
- * than 128 characters, and valid characters are /a-z-/.
934
+ * than 128 characters, and valid characters are `/a-z-/`.
914
935
  */
915
936
  pipelineJobId?:
916
937
  string;
@@ -937,7 +958,7 @@ declare namespace gapi.client {
937
958
  GoogleCloudAiplatformV1TensorboardRun;
938
959
  /**
939
960
  * 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
940
- * characters are /a-z-/.
961
+ * characters are `/a-z-/`.
941
962
  */
942
963
  tensorboardRunId?:
943
964
  string;
@@ -1423,7 +1444,8 @@ declare namespace gapi.client {
1423
1444
  /**
1424
1445
  * 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
1425
1446
  * index might be deployed to any ip ranges under the provided VPC network. The value should be the name of the address
1426
- * (https://cloud.google.com/compute/docs/reference/rest/v1/addresses) Example: 'vertex-ai-ip-range'.
1447
+ * (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
1448
+ * https://cloud.google.com/vpc/docs/subnets#manually_created_subnet_ip_ranges.
1427
1449
  */
1428
1450
  reservedIpRanges?:
1429
1451
  string[];
@@ -1487,7 +1509,7 @@ declare namespace gapi.client {
1487
1509
  GoogleCloudAiplatformV1ExplanationSpec;
1488
1510
  /**
1489
1511
  * 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
1490
- * /[0-9]/.
1512
+ * `/[0-9]/`.
1491
1513
  */
1492
1514
  id?:
1493
1515
  string;
@@ -2373,7 +2395,7 @@ declare namespace gapi.client {
2373
2395
  /** Output only. Timestamp when this EntityType was most recently updated. */
2374
2396
  updateTime?:
2375
2397
  string;
2376
- /** Required. Immutable. Type of Feature value. */
2398
+ /** Immutable. Type of Feature value. */
2377
2399
  valueType?:
2378
2400
  string;
2379
2401
  }
@@ -2969,6 +2991,9 @@ declare namespace gapi.client {
2969
2991
  /** Required. The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters. */
2970
2992
  displayName?:
2971
2993
  string;
2994
+ /** 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. */
2995
+ encryptionSpec?:
2996
+ GoogleCloudAiplatformV1EncryptionSpec;
2972
2997
  /** Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. */
2973
2998
  etag?:
2974
2999
  string;
@@ -3017,8 +3042,8 @@ declare namespace gapi.client {
3017
3042
  featureVector?:
3018
3043
  number[];
3019
3044
  /**
3020
- * 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:
3021
- * https://cloud.google.com/vertex-ai/docs/matching-engine/filtering
3045
+ * 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
3046
+ * categorical tokens. See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering
3022
3047
  */
3023
3048
  restricts?:
3024
3049
  GoogleCloudAiplatformV1IndexDatapointRestriction[];
@@ -3032,13 +3057,13 @@ declare namespace gapi.client {
3032
3057
  string;
3033
3058
  }
3034
3059
  interface GoogleCloudAiplatformV1IndexDatapointRestriction {
3035
- /** The attributes to allow in this namespace. eg: 'red' */
3060
+ /** The attributes to allow in this namespace. e.g.: 'red' */
3036
3061
  allowList?:
3037
3062
  string[];
3038
- /** The attributes to deny in this namespace. eg: 'blue' */
3063
+ /** The attributes to deny in this namespace. e.g.: 'blue' */
3039
3064
  denyList?:
3040
3065
  string[];
3041
- /** The namespace of this restriction. eg: color. */
3066
+ /** The namespace of this restriction. e.g.: color. */
3042
3067
  namespace?:
3043
3068
  string;
3044
3069
  }
@@ -3058,6 +3083,9 @@ declare namespace gapi.client {
3058
3083
  /** 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. */
3059
3084
  enablePrivateServiceConnect?:
3060
3085
  boolean;
3086
+ /** 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. */
3087
+ encryptionSpec?:
3088
+ GoogleCloudAiplatformV1EncryptionSpec;
3061
3089
  /** Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. */
3062
3090
  etag?:
3063
3091
  string;
@@ -3420,6 +3448,22 @@ declare namespace gapi.client {
3420
3448
  nextPageToken?:
3421
3449
  string;
3422
3450
  }
3451
+ interface GoogleCloudAiplatformV1ListNotebookRuntimesResponse {
3452
+ /** A token to retrieve next page of results. Pass to ListNotebookRuntimesRequest.page_token to obtain that page. */
3453
+ nextPageToken?:
3454
+ string;
3455
+ /** List of NotebookRuntimes in the requested page. */
3456
+ notebookRuntimes?:
3457
+ GoogleCloudAiplatformV1NotebookRuntime[];
3458
+ }
3459
+ interface GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse {
3460
+ /** A token to retrieve next page of results. Pass to ListNotebookRuntimeTemplatesRequest.page_token to obtain that page. */
3461
+ nextPageToken?:
3462
+ string;
3463
+ /** List of NotebookRuntimeTemplates in the requested page. */
3464
+ notebookRuntimeTemplates?:
3465
+ GoogleCloudAiplatformV1NotebookRuntimeTemplate[];
3466
+ }
3423
3467
  // tslint:disable-next-line:no-empty-interface
3424
3468
  interface GoogleCloudAiplatformV1ListOptimalTrialsRequest {
3425
3469
  }
@@ -4675,6 +4719,17 @@ declare namespace gapi.client {
4675
4719
  neighborId?:
4676
4720
  string;
4677
4721
  }
4722
+ interface GoogleCloudAiplatformV1NetworkSpec {
4723
+ /** Whether to enable public internet access. Default false. */
4724
+ enableInternetAccess?:
4725
+ boolean;
4726
+ /** The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) */
4727
+ network?:
4728
+ string;
4729
+ /** The name of the subnet that this instance is in. Format: `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}` */
4730
+ subnetwork?:
4731
+ string;
4732
+ }
4678
4733
  interface GoogleCloudAiplatformV1NfsMount {
4679
4734
  /** Required. Destination mount path. The NFS will be mounted for the user under /mnt/nfs/ */
4680
4735
  mountPoint?:
@@ -4686,12 +4741,155 @@ declare namespace gapi.client {
4686
4741
  server?:
4687
4742
  string;
4688
4743
  }
4744
+ interface GoogleCloudAiplatformV1NotebookEucConfig {
4745
+ /**
4746
+ * Output only. Whether ActAs check is bypassed for service account attached to the VM. If false, we need ActAs check for the default Compute Engine Service account. When a Runtime is
4747
+ * created, a VM is allocated using Default Compute Engine Service Account. Any user requesting to use this Runtime requires Service Account User (ActAs) permission over this SA. If
4748
+ * true, Runtime owner is using EUC and does not require the above permission as VM no longer use default Compute Engine SA, but a P4SA.
4749
+ */
4750
+ bypassActasCheck?:
4751
+ boolean;
4752
+ /**
4753
+ * Input only. Whether EUC is disabled in this NotebookRuntimeTemplate. In proto3, the default value of a boolean is false. In this way, by default EUC will be enabled for
4754
+ * NotebookRuntimeTemplate.
4755
+ */
4756
+ eucDisabled?:
4757
+ boolean;
4758
+ }
4759
+ interface GoogleCloudAiplatformV1NotebookIdleShutdownConfig {
4760
+ /** Whether Idle Shutdown is disabled in this NotebookRuntimeTemplate. */
4761
+ idleShutdownDisabled?:
4762
+ boolean;
4763
+ /** Required. Duration is accurate to the second. In Notebook, Idle Timeout is accurate to minute so the range of idle_timeout (second) is: 10 * 60 ~ 1440 * 60. */
4764
+ idleTimeout?:
4765
+ string;
4766
+ }
4767
+ interface GoogleCloudAiplatformV1NotebookRuntime {
4768
+ /** Output only. Timestamp when this NotebookRuntime was created. */
4769
+ createTime?:
4770
+ string;
4771
+ /** The description of the NotebookRuntime. */
4772
+ description?:
4773
+ string;
4774
+ /** Required. The display name of the NotebookRuntime. The name can be up to 128 characters long and can consist of any UTF-8 characters. */
4775
+ displayName?:
4776
+ string;
4777
+ /**
4778
+ * Output only. Timestamp when this NotebookRuntime will be expired: 1. System Predefined NotebookRuntime: 24 hours after creation. After expiration, system predifined runtime will be
4779
+ * deleted. 2. User created NotebookRuntime: 6 months after last upgrade. After expiration, user created runtime will be stopped and allowed for upgrade.
4780
+ */
4781
+ expirationTime?:
4782
+ string;
4783
+ /** Output only. The health state of the NotebookRuntime. */
4784
+ healthState?:
4785
+ string;
4786
+ /**
4787
+ * 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
4788
+ * 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
4789
+ * 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.
4790
+ * Following system labels exist for NotebookRuntime: * "aiplatform.googleapis.com/notebook_runtime_gce_instance_id": output only, its value is the Compute Engine instance id. *
4791
+ * "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,
4792
+ * either BigQuery or Vertex.
4793
+ */
4794
+ labels?:
4795
+ { [P in string]: string };
4796
+ /** Output only. The resource name of the NotebookRuntime. */
4797
+ name?:
4798
+ string;
4799
+ /** Output only. The pointer to NotebookRuntimeTemplate this NotebookRuntime is created from. */
4800
+ notebookRuntimeTemplateRef?:
4801
+ GoogleCloudAiplatformV1NotebookRuntimeTemplateRef;
4802
+ /** Output only. The proxy endpoint used to access the NotebookRuntime. */
4803
+ proxyUri?:
4804
+ string;
4805
+ /** Output only. The runtime (instance) state of the NotebookRuntime. */
4806
+ runtimeState?:
4807
+ string;
4808
+ /** Required. The user email of the NotebookRuntime. */
4809
+ runtimeUser?:
4810
+ string;
4811
+ /** Output only. The service account that the NotebookRuntime workload runs as. */
4812
+ serviceAccount?:
4813
+ string;
4814
+ /** Output only. Timestamp when this NotebookRuntime was most recently updated. */
4815
+ updateTime?:
4816
+ string;
4817
+ /** Output only. The VM os image version of NotebookRuntime. */
4818
+ version?:
4819
+ string;
4820
+ }
4821
+ interface GoogleCloudAiplatformV1NotebookRuntimeTemplate {
4822
+ /** Output only. Timestamp when this NotebookRuntimeTemplate was created. */
4823
+ createTime?:
4824
+ string;
4825
+ /** Optional. The specification of persistent disk attached to the runtime as data disk storage. */
4826
+ dataPersistentDiskSpec?:
4827
+ GoogleCloudAiplatformV1PersistentDiskSpec;
4828
+ /** The description of the NotebookRuntimeTemplate. */
4829
+ description?:
4830
+ string;
4831
+ /** Required. The display name of the NotebookRuntimeTemplate. The name can be up to 128 characters long and can consist of any UTF-8 characters. */
4832
+ displayName?:
4833
+ string;
4834
+ /** Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. */
4835
+ etag?:
4836
+ string;
4837
+ /** EUC configuration of the NotebookRuntimeTemplate. */
4838
+ eucConfig?:
4839
+ GoogleCloudAiplatformV1NotebookEucConfig;
4840
+ /** The idle shutdown configuration of NotebookRuntimeTemplate. This config will only be set when idle shutdown is enabled. */
4841
+ idleShutdownConfig?:
4842
+ GoogleCloudAiplatformV1NotebookIdleShutdownConfig;
4843
+ /** Output only. The default template to use if not specified. */
4844
+ isDefault?:
4845
+ boolean;
4846
+ /**
4847
+ * The labels with user-defined metadata to organize the NotebookRuntimeTemplates. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain
4848
+ * lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
4849
+ */
4850
+ labels?:
4851
+ { [P in string]: string };
4852
+ /** Optional. Immutable. The specification of a single machine for the template. */
4853
+ machineSpec?:
4854
+ GoogleCloudAiplatformV1MachineSpec;
4855
+ /** Output only. The resource name of the NotebookRuntimeTemplate. */
4856
+ name?:
4857
+ string;
4858
+ /** Optional. Network spec. */
4859
+ networkSpec?:
4860
+ GoogleCloudAiplatformV1NetworkSpec;
4861
+ /**
4862
+ * The service account that the runtime workload runs as. You can use any service account within the same project, but you must have the service account user permission to use the
4863
+ * instance. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.
4864
+ */
4865
+ serviceAccount?:
4866
+ string;
4867
+ /** Output only. Timestamp when this NotebookRuntimeTemplate was most recently updated. */
4868
+ updateTime?:
4869
+ string;
4870
+ }
4871
+ interface GoogleCloudAiplatformV1NotebookRuntimeTemplateRef {
4872
+ /** Immutable. A resource name of the NotebookRuntimeTemplate. */
4873
+ notebookRuntimeTemplate?:
4874
+ string;
4875
+ }
4689
4876
  // tslint:disable-next-line:no-empty-interface
4690
4877
  interface GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest {
4691
4878
  }
4692
4879
  // tslint:disable-next-line:no-empty-interface
4693
4880
  interface GoogleCloudAiplatformV1PauseScheduleRequest {
4694
4881
  }
4882
+ interface GoogleCloudAiplatformV1PersistentDiskSpec {
4883
+ /** Size in GB of the disk (default is 100GB). */
4884
+ diskSizeGb?:
4885
+ string;
4886
+ /**
4887
+ * Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced
4888
+ * Persistent Disk) "pd-extreme" (Extreme Persistent Disk)
4889
+ */
4890
+ diskType?:
4891
+ string;
4892
+ }
4695
4893
  interface GoogleCloudAiplatformV1PipelineJob {
4696
4894
  /** Output only. Pipeline creation time. */
4697
4895
  createTime?:
@@ -7829,6 +8027,17 @@ declare namespace gapi.client {
7829
8027
  specialistWorkerEmails?:
7830
8028
  string[];
7831
8029
  }
8030
+ interface GoogleCloudAiplatformV1StartNotebookRuntimeOperationMetadata {
8031
+ /** The operation generic information. */
8032
+ genericMetadata?:
8033
+ GoogleCloudAiplatformV1GenericOperationMetadata;
8034
+ /** A human-readable message that shows the intermediate progress details of NotebookRuntime. */
8035
+ progressMessage?:
8036
+ string;
8037
+ }
8038
+ // tslint:disable-next-line:no-empty-interface
8039
+ interface GoogleCloudAiplatformV1StartNotebookRuntimeRequest {
8040
+ }
7832
8041
  // tslint:disable-next-line:no-empty-interface
7833
8042
  interface GoogleCloudAiplatformV1StopTrialRequest {
7834
8043
  }
@@ -8127,6 +8336,21 @@ declare namespace gapi.client {
8127
8336
  */
8128
8337
  clientId?:
8129
8338
  string;
8339
+ /**
8340
+ * 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
8341
+ * 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
8342
+ * 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,
8343
+ * 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"
8344
+ * 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"
8345
+ * 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
8346
+ * 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
8347
+ * 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
8348
+ * 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
8349
+ * 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
8350
+ * 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.
8351
+ */
8352
+ contexts?:
8353
+ GoogleCloudAiplatformV1TrialContext[];
8130
8354
  /** Required. The number of suggestions requested. It must be positive. */
8131
8355
  suggestionCount?:
8132
8356
  number;
@@ -8552,6 +8776,18 @@ declare namespace gapi.client {
8552
8776
  webAccessUris?:
8553
8777
  { [P in string]: string };
8554
8778
  }
8779
+ interface GoogleCloudAiplatformV1TrialContext {
8780
+ /** A human-readable field which can store a description of this context. This will become part of the resulting Trial's description field. */
8781
+ description?:
8782
+ string;
8783
+ /**
8784
+ * 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,
8785
+ * 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,
8786
+ * we generate suggestions in the subspace defined by the parameters specified here. NOTE: a Context without any Parameters matches the entire feasible search space.
8787
+ */
8788
+ parameters?:
8789
+ GoogleCloudAiplatformV1TrialParameter[];
8790
+ }
8555
8791
  interface GoogleCloudAiplatformV1TrialParameter {
8556
8792
  /** Output only. The ID of the parameter. The parameter should be defined in StudySpec's Parameters. */
8557
8793
  parameterId?:
@@ -14013,7 +14249,7 @@ declare namespace gapi.client {
14013
14249
  string;
14014
14250
  /**
14015
14251
  * 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
14016
- * `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup.
14252
+ * `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType .
14017
14253
  */
14018
14254
  featureId?:
14019
14255
  string;
@@ -14026,10 +14262,7 @@ declare namespace gapi.client {
14026
14262
  /** OAuth 2.0 token for the current user. */
14027
14263
  oauth_token?:
14028
14264
  string;
14029
- /**
14030
- * Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format:
14031
- * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}`
14032
- */
14265
+ /** Required. The resource name of the EntityType to create a Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` */
14033
14266
  parent:
14034
14267
  string;
14035
14268
  /** Returns response with indentations and line breaks. */
@@ -14063,7 +14296,7 @@ declare namespace gapi.client {
14063
14296
  string;
14064
14297
  /**
14065
14298
  * 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
14066
- * `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup.
14299
+ * `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType .
14067
14300
  */
14068
14301
  featureId?:
14069
14302
  string;
@@ -14076,10 +14309,7 @@ declare namespace gapi.client {
14076
14309
  /** OAuth 2.0 token for the current user. */
14077
14310
  oauth_token?:
14078
14311
  string;
14079
- /**
14080
- * Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format:
14081
- * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}`
14082
- */
14312
+ /** Required. The resource name of the EntityType to create a Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` */
14083
14313
  parent:
14084
14314
  string;
14085
14315
  /** Returns response with indentations and line breaks. */
@@ -14116,10 +14346,7 @@ declare namespace gapi.client {
14116
14346
  /** 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. */
14117
14347
  key?:
14118
14348
  string;
14119
- /**
14120
- * Required. The name of the Features to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}`
14121
- * `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}`
14122
- */
14349
+ /** Required. The name of the Features to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` */
14123
14350
  name:
14124
14351
  string;
14125
14352
  /** OAuth 2.0 token for the current user. */
@@ -14158,10 +14385,7 @@ declare namespace gapi.client {
14158
14385
  /** 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. */
14159
14386
  key?:
14160
14387
  string;
14161
- /**
14162
- * Required. The name of the Feature resource. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
14163
- * `projects/{project}/locations/{location}/featureGroups/{feature_group}`
14164
- */
14388
+ /** Required. The name of the Feature resource. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` */
14165
14389
  name:
14166
14390
  string;
14167
14391
  /** OAuth 2.0 token for the current user. */
@@ -14219,8 +14443,8 @@ declare namespace gapi.client {
14219
14443
  oauth_token?:
14220
14444
  string;
14221
14445
  /**
14222
- * 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` *
14223
- * `create_time` * `update_time`
14446
+ * 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
14447
+ * supported for FeatureRegistry Feature) * `create_time` * `update_time`
14224
14448
  */
14225
14449
  orderBy?:
14226
14450
  string;
@@ -14236,10 +14460,7 @@ declare namespace gapi.client {
14236
14460
  */
14237
14461
  pageToken?:
14238
14462
  string;
14239
- /**
14240
- * Required. The resource name of the Location to list Features. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
14241
- * `projects/{project}/locations/{location}/featureGroups/{feature_group}`
14242
- */
14463
+ /** Required. The resource name of the Location to list Features. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` */
14243
14464
  parent:
14244
14465
  string;
14245
14466
  /** Returns response with indentations and line breaks. */
@@ -23980,6 +24201,704 @@ declare namespace gapi.client {
23980
24201
  nasTrialDetails:
23981
24202
  NasTrialDetailsResource;
23982
24203
  }
24204
+ interface NotebookRuntimesResource {
24205
+ /** Assigns a NotebookRuntime to a user for a particular Notebook file. This method will either returns an existing assignment or generates a new one. */
24206
+ assign(request: {
24207
+ /** V1 error format. */
24208
+ "$.xgafv"?:
24209
+ string;
24210
+ /** OAuth access token. */
24211
+ access_token?:
24212
+ string;
24213
+ /** Data format for response. */
24214
+ alt?:
24215
+ string;
24216
+ /** JSONP */
24217
+ callback?:
24218
+ string;
24219
+ /** Selector specifying which fields to include in a partial response. */
24220
+ fields?:
24221
+ string;
24222
+ /** 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. */
24223
+ key?:
24224
+ string;
24225
+ /** OAuth 2.0 token for the current user. */
24226
+ oauth_token?:
24227
+ string;
24228
+ /** Required. The resource name of the Location to get the NotebookRuntime assignment. Format: `projects/{project}/locations/{location}` */
24229
+ parent:
24230
+ string;
24231
+ /** Returns response with indentations and line breaks. */
24232
+ prettyPrint?:
24233
+ boolean;
24234
+ /** 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. */
24235
+ quotaUser?:
24236
+ string;
24237
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
24238
+ upload_protocol?:
24239
+ string;
24240
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
24241
+ uploadType?:
24242
+ string;
24243
+ /** Request body */
24244
+ resource:
24245
+ GoogleCloudAiplatformV1AssignNotebookRuntimeRequest;
24246
+ }): Request<GoogleLongrunningOperation>;
24247
+ assign(request: {
24248
+ /** V1 error format. */
24249
+ "$.xgafv"?:
24250
+ string;
24251
+ /** OAuth access token. */
24252
+ access_token?:
24253
+ string;
24254
+ /** Data format for response. */
24255
+ alt?:
24256
+ string;
24257
+ /** JSONP */
24258
+ callback?:
24259
+ string;
24260
+ /** Selector specifying which fields to include in a partial response. */
24261
+ fields?:
24262
+ string;
24263
+ /** 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. */
24264
+ key?:
24265
+ string;
24266
+ /** OAuth 2.0 token for the current user. */
24267
+ oauth_token?:
24268
+ string;
24269
+ /** Required. The resource name of the Location to get the NotebookRuntime assignment. Format: `projects/{project}/locations/{location}` */
24270
+ parent:
24271
+ string;
24272
+ /** Returns response with indentations and line breaks. */
24273
+ prettyPrint?:
24274
+ boolean;
24275
+ /** 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. */
24276
+ quotaUser?:
24277
+ string;
24278
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
24279
+ upload_protocol?:
24280
+ string;
24281
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
24282
+ uploadType?:
24283
+ string;
24284
+ },
24285
+ body: GoogleCloudAiplatformV1AssignNotebookRuntimeRequest): Request<GoogleLongrunningOperation>;
24286
+ /** Deletes a NotebookRuntime. */
24287
+ delete(request?: {
24288
+ /** V1 error format. */
24289
+ "$.xgafv"?:
24290
+ string;
24291
+ /** OAuth access token. */
24292
+ access_token?:
24293
+ string;
24294
+ /** Data format for response. */
24295
+ alt?:
24296
+ string;
24297
+ /** JSONP */
24298
+ callback?:
24299
+ string;
24300
+ /** Selector specifying which fields to include in a partial response. */
24301
+ fields?:
24302
+ string;
24303
+ /** 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. */
24304
+ key?:
24305
+ string;
24306
+ /**
24307
+ * Required. The name of the NotebookRuntime resource to be deleted. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound
24308
+ * exception if there is no such NotebookRuntime in spanner.
24309
+ */
24310
+ name:
24311
+ string;
24312
+ /** OAuth 2.0 token for the current user. */
24313
+ oauth_token?:
24314
+ string;
24315
+ /** Returns response with indentations and line breaks. */
24316
+ prettyPrint?:
24317
+ boolean;
24318
+ /** 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. */
24319
+ quotaUser?:
24320
+ string;
24321
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
24322
+ upload_protocol?:
24323
+ string;
24324
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
24325
+ uploadType?:
24326
+ string;
24327
+ }): Request<GoogleLongrunningOperation>;
24328
+ /** Gets a NotebookRuntime. */
24329
+ get(request?: {
24330
+ /** V1 error format. */
24331
+ "$.xgafv"?:
24332
+ string;
24333
+ /** OAuth access token. */
24334
+ access_token?:
24335
+ string;
24336
+ /** Data format for response. */
24337
+ alt?:
24338
+ string;
24339
+ /** JSONP */
24340
+ callback?:
24341
+ string;
24342
+ /** Selector specifying which fields to include in a partial response. */
24343
+ fields?:
24344
+ string;
24345
+ /** 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. */
24346
+ key?:
24347
+ string;
24348
+ /**
24349
+ * Required. The name of the NotebookRuntime resource. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if
24350
+ * there is no such NotebookRuntime in spanner.
24351
+ */
24352
+ name:
24353
+ string;
24354
+ /** OAuth 2.0 token for the current user. */
24355
+ oauth_token?:
24356
+ string;
24357
+ /** Returns response with indentations and line breaks. */
24358
+ prettyPrint?:
24359
+ boolean;
24360
+ /** 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. */
24361
+ quotaUser?:
24362
+ string;
24363
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
24364
+ upload_protocol?:
24365
+ string;
24366
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
24367
+ uploadType?:
24368
+ string;
24369
+ }): Request<GoogleCloudAiplatformV1NotebookRuntime>;
24370
+ /** Lists NotebookRuntimes in a Location. */
24371
+ list(request?: {
24372
+ /** V1 error format. */
24373
+ "$.xgafv"?:
24374
+ string;
24375
+ /** OAuth access token. */
24376
+ access_token?:
24377
+ string;
24378
+ /** Data format for response. */
24379
+ alt?:
24380
+ string;
24381
+ /** JSONP */
24382
+ callback?:
24383
+ string;
24384
+ /** Selector specifying which fields to include in a partial response. */
24385
+ fields?:
24386
+ string;
24387
+ /**
24388
+ * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=.
24389
+ * `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. *
24390
+ * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource
24391
+ * name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum:
24392
+ * [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports =
24393
+ * and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED,
24394
+ * UI_RESOURCE_STATE_CREATION_FAILED]. Some examples: * `notebookRuntime="notebookRuntime123"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` *
24395
+ * `notebookRuntimeTemplate="notebookRuntimeTemplate321"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser="test@google.com"` *
24396
+ * `uiState=UI_RESOURCE_STATE_BEING_DELETED`
24397
+ */
24398
+ filter?:
24399
+ string;
24400
+ /** 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. */
24401
+ key?:
24402
+ string;
24403
+ /** OAuth 2.0 token for the current user. */
24404
+ oauth_token?:
24405
+ string;
24406
+ /**
24407
+ * Optional. 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` *
24408
+ * `create_time` * `update_time` Example: `display_name, create_time desc`.
24409
+ */
24410
+ orderBy?:
24411
+ string;
24412
+ /** Optional. The standard list page size. */
24413
+ pageSize?:
24414
+ number;
24415
+ /** Optional. The standard list page token. Typically obtained via ListNotebookRuntimesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimes call. */
24416
+ pageToken?:
24417
+ string;
24418
+ /** Required. The resource name of the Location from which to list the NotebookRuntimes. Format: `projects/{project}/locations/{location}` */
24419
+ parent:
24420
+ string;
24421
+ /** Returns response with indentations and line breaks. */
24422
+ prettyPrint?:
24423
+ boolean;
24424
+ /** 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. */
24425
+ quotaUser?:
24426
+ string;
24427
+ /** Optional. Mask specifying which fields to read. */
24428
+ readMask?:
24429
+ string;
24430
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
24431
+ upload_protocol?:
24432
+ string;
24433
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
24434
+ uploadType?:
24435
+ string;
24436
+ }): Request<GoogleCloudAiplatformV1ListNotebookRuntimesResponse>;
24437
+ /** Starts a NotebookRuntime. */
24438
+ start(request: {
24439
+ /** V1 error format. */
24440
+ "$.xgafv"?:
24441
+ string;
24442
+ /** OAuth access token. */
24443
+ access_token?:
24444
+ string;
24445
+ /** Data format for response. */
24446
+ alt?:
24447
+ string;
24448
+ /** JSONP */
24449
+ callback?:
24450
+ string;
24451
+ /** Selector specifying which fields to include in a partial response. */
24452
+ fields?:
24453
+ string;
24454
+ /** 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. */
24455
+ key?:
24456
+ string;
24457
+ /**
24458
+ * Required. The name of the NotebookRuntime resource to be started. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound
24459
+ * exception if there is no such NotebookRuntime in spanner.
24460
+ */
24461
+ name:
24462
+ string;
24463
+ /** OAuth 2.0 token for the current user. */
24464
+ oauth_token?:
24465
+ string;
24466
+ /** Returns response with indentations and line breaks. */
24467
+ prettyPrint?:
24468
+ boolean;
24469
+ /** 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. */
24470
+ quotaUser?:
24471
+ string;
24472
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
24473
+ upload_protocol?:
24474
+ string;
24475
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
24476
+ uploadType?:
24477
+ string;
24478
+ /** Request body */
24479
+ resource:
24480
+ GoogleCloudAiplatformV1StartNotebookRuntimeRequest;
24481
+ }): Request<GoogleLongrunningOperation>;
24482
+ start(request: {
24483
+ /** V1 error format. */
24484
+ "$.xgafv"?:
24485
+ string;
24486
+ /** OAuth access token. */
24487
+ access_token?:
24488
+ string;
24489
+ /** Data format for response. */
24490
+ alt?:
24491
+ string;
24492
+ /** JSONP */
24493
+ callback?:
24494
+ string;
24495
+ /** Selector specifying which fields to include in a partial response. */
24496
+ fields?:
24497
+ string;
24498
+ /** 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. */
24499
+ key?:
24500
+ string;
24501
+ /**
24502
+ * Required. The name of the NotebookRuntime resource to be started. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound
24503
+ * exception if there is no such NotebookRuntime in spanner.
24504
+ */
24505
+ name:
24506
+ string;
24507
+ /** OAuth 2.0 token for the current user. */
24508
+ oauth_token?:
24509
+ string;
24510
+ /** Returns response with indentations and line breaks. */
24511
+ prettyPrint?:
24512
+ boolean;
24513
+ /** 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. */
24514
+ quotaUser?:
24515
+ string;
24516
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
24517
+ upload_protocol?:
24518
+ string;
24519
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
24520
+ uploadType?:
24521
+ string;
24522
+ },
24523
+ body: GoogleCloudAiplatformV1StartNotebookRuntimeRequest): Request<GoogleLongrunningOperation>;
24524
+ }
24525
+ interface NotebookRuntimeTemplatesResource {
24526
+ /** Creates a NotebookRuntimeTemplate. */
24527
+ create(request: {
24528
+ /** V1 error format. */
24529
+ "$.xgafv"?:
24530
+ string;
24531
+ /** OAuth access token. */
24532
+ access_token?:
24533
+ string;
24534
+ /** Data format for response. */
24535
+ alt?:
24536
+ string;
24537
+ /** JSONP */
24538
+ callback?:
24539
+ string;
24540
+ /** Selector specifying which fields to include in a partial response. */
24541
+ fields?:
24542
+ string;
24543
+ /** 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. */
24544
+ key?:
24545
+ string;
24546
+ /** Optional. User specified ID for the notebook runtime template. */
24547
+ notebookRuntimeTemplateId?:
24548
+ string;
24549
+ /** OAuth 2.0 token for the current user. */
24550
+ oauth_token?:
24551
+ string;
24552
+ /** Required. The resource name of the Location to create the NotebookRuntimeTemplate. Format: `projects/{project}/locations/{location}` */
24553
+ parent:
24554
+ string;
24555
+ /** Returns response with indentations and line breaks. */
24556
+ prettyPrint?:
24557
+ boolean;
24558
+ /** 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. */
24559
+ quotaUser?:
24560
+ string;
24561
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
24562
+ upload_protocol?:
24563
+ string;
24564
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
24565
+ uploadType?:
24566
+ string;
24567
+ /** Request body */
24568
+ resource:
24569
+ GoogleCloudAiplatformV1NotebookRuntimeTemplate;
24570
+ }): Request<GoogleLongrunningOperation>;
24571
+ create(request: {
24572
+ /** V1 error format. */
24573
+ "$.xgafv"?:
24574
+ string;
24575
+ /** OAuth access token. */
24576
+ access_token?:
24577
+ string;
24578
+ /** Data format for response. */
24579
+ alt?:
24580
+ string;
24581
+ /** JSONP */
24582
+ callback?:
24583
+ string;
24584
+ /** Selector specifying which fields to include in a partial response. */
24585
+ fields?:
24586
+ string;
24587
+ /** 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. */
24588
+ key?:
24589
+ string;
24590
+ /** Optional. User specified ID for the notebook runtime template. */
24591
+ notebookRuntimeTemplateId?:
24592
+ string;
24593
+ /** OAuth 2.0 token for the current user. */
24594
+ oauth_token?:
24595
+ string;
24596
+ /** Required. The resource name of the Location to create the NotebookRuntimeTemplate. Format: `projects/{project}/locations/{location}` */
24597
+ parent:
24598
+ string;
24599
+ /** Returns response with indentations and line breaks. */
24600
+ prettyPrint?:
24601
+ boolean;
24602
+ /** 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. */
24603
+ quotaUser?:
24604
+ string;
24605
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
24606
+ upload_protocol?:
24607
+ string;
24608
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
24609
+ uploadType?:
24610
+ string;
24611
+ },
24612
+ body: GoogleCloudAiplatformV1NotebookRuntimeTemplate): Request<GoogleLongrunningOperation>;
24613
+ /** Deletes a NotebookRuntimeTemplate. */
24614
+ delete(request?: {
24615
+ /** V1 error format. */
24616
+ "$.xgafv"?:
24617
+ string;
24618
+ /** OAuth access token. */
24619
+ access_token?:
24620
+ string;
24621
+ /** Data format for response. */
24622
+ alt?:
24623
+ string;
24624
+ /** JSONP */
24625
+ callback?:
24626
+ string;
24627
+ /** Selector specifying which fields to include in a partial response. */
24628
+ fields?:
24629
+ string;
24630
+ /** 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. */
24631
+ key?:
24632
+ string;
24633
+ /** Required. The name of the NotebookRuntimeTemplate resource to be deleted. Format: `projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}` */
24634
+ name:
24635
+ string;
24636
+ /** OAuth 2.0 token for the current user. */
24637
+ oauth_token?:
24638
+ string;
24639
+ /** Returns response with indentations and line breaks. */
24640
+ prettyPrint?:
24641
+ boolean;
24642
+ /** 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. */
24643
+ quotaUser?:
24644
+ string;
24645
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
24646
+ upload_protocol?:
24647
+ string;
24648
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
24649
+ uploadType?:
24650
+ string;
24651
+ }): Request<GoogleLongrunningOperation>;
24652
+ /** Gets a NotebookRuntimeTemplate. */
24653
+ get(request?: {
24654
+ /** V1 error format. */
24655
+ "$.xgafv"?:
24656
+ string;
24657
+ /** OAuth access token. */
24658
+ access_token?:
24659
+ string;
24660
+ /** Data format for response. */
24661
+ alt?:
24662
+ string;
24663
+ /** JSONP */
24664
+ callback?:
24665
+ string;
24666
+ /** Selector specifying which fields to include in a partial response. */
24667
+ fields?:
24668
+ string;
24669
+ /** 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. */
24670
+ key?:
24671
+ string;
24672
+ /** Required. The name of the NotebookRuntimeTemplate resource. Format: `projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}` */
24673
+ name:
24674
+ string;
24675
+ /** OAuth 2.0 token for the current user. */
24676
+ oauth_token?:
24677
+ string;
24678
+ /** Returns response with indentations and line breaks. */
24679
+ prettyPrint?:
24680
+ boolean;
24681
+ /** 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. */
24682
+ quotaUser?:
24683
+ string;
24684
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
24685
+ upload_protocol?:
24686
+ string;
24687
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
24688
+ uploadType?:
24689
+ string;
24690
+ }): Request<GoogleCloudAiplatformV1NotebookRuntimeTemplate>;
24691
+ /** Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. */
24692
+ getIamPolicy(request?: {
24693
+ /** V1 error format. */
24694
+ "$.xgafv"?:
24695
+ string;
24696
+ /** OAuth access token. */
24697
+ access_token?:
24698
+ string;
24699
+ /** Data format for response. */
24700
+ alt?:
24701
+ string;
24702
+ /** JSONP */
24703
+ callback?:
24704
+ string;
24705
+ /** Selector specifying which fields to include in a partial response. */
24706
+ fields?:
24707
+ string;
24708
+ /** 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. */
24709
+ key?:
24710
+ string;
24711
+ /** OAuth 2.0 token for the current user. */
24712
+ oauth_token?:
24713
+ string;
24714
+ /**
24715
+ * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for
24716
+ * policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy
24717
+ * in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional
24718
+ * role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM
24719
+ * documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
24720
+ */
24721
+ "options.requestedPolicyVersion"?:
24722
+ number;
24723
+ /** Returns response with indentations and line breaks. */
24724
+ prettyPrint?:
24725
+ boolean;
24726
+ /** 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. */
24727
+ quotaUser?:
24728
+ string;
24729
+ /**
24730
+ * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this
24731
+ * field.
24732
+ */
24733
+ resource:
24734
+ string;
24735
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
24736
+ upload_protocol?:
24737
+ string;
24738
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
24739
+ uploadType?:
24740
+ string;
24741
+ }): Request<GoogleIamV1Policy>;
24742
+ /** Lists NotebookRuntimeTemplates in a Location. */
24743
+ list(request?: {
24744
+ /** V1 error format. */
24745
+ "$.xgafv"?:
24746
+ string;
24747
+ /** OAuth access token. */
24748
+ access_token?:
24749
+ string;
24750
+ /** Data format for response. */
24751
+ alt?:
24752
+ string;
24753
+ /** JSONP */
24754
+ callback?:
24755
+ string;
24756
+ /** Selector specifying which fields to include in a partial response. */
24757
+ fields?:
24758
+ string;
24759
+ /**
24760
+ * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntimeTemplate` supports = and !=.
24761
+ * `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `display_name` supports = and != *
24762
+ * `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
24763
+ * quoted. `labels."a key"`. Some examples: * `notebookRuntimeTemplate=notebookRuntimeTemplate123` * `displayName="myDisplayName"` * `labels.myKey="myValue"`
24764
+ */
24765
+ filter?:
24766
+ string;
24767
+ /** 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. */
24768
+ key?:
24769
+ string;
24770
+ /** OAuth 2.0 token for the current user. */
24771
+ oauth_token?:
24772
+ string;
24773
+ /**
24774
+ * Optional. 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` *
24775
+ * `create_time` * `update_time` Example: `display_name, create_time desc`.
24776
+ */
24777
+ orderBy?:
24778
+ string;
24779
+ /** Optional. The standard list page size. */
24780
+ pageSize?:
24781
+ number;
24782
+ /**
24783
+ * Optional. The standard list page token. Typically obtained via ListNotebookRuntimeTemplatesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimeTemplates
24784
+ * call.
24785
+ */
24786
+ pageToken?:
24787
+ string;
24788
+ /** Required. The resource name of the Location from which to list the NotebookRuntimeTemplates. Format: `projects/{project}/locations/{location}` */
24789
+ parent:
24790
+ string;
24791
+ /** Returns response with indentations and line breaks. */
24792
+ prettyPrint?:
24793
+ boolean;
24794
+ /** 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. */
24795
+ quotaUser?:
24796
+ string;
24797
+ /** Optional. Mask specifying which fields to read. */
24798
+ readMask?:
24799
+ string;
24800
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
24801
+ upload_protocol?:
24802
+ string;
24803
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
24804
+ uploadType?:
24805
+ string;
24806
+ }): Request<GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse>;
24807
+ /** Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. */
24808
+ setIamPolicy(request: {
24809
+ /** V1 error format. */
24810
+ "$.xgafv"?:
24811
+ string;
24812
+ /** OAuth access token. */
24813
+ access_token?:
24814
+ string;
24815
+ /** Data format for response. */
24816
+ alt?:
24817
+ string;
24818
+ /** JSONP */
24819
+ callback?:
24820
+ string;
24821
+ /** Selector specifying which fields to include in a partial response. */
24822
+ fields?:
24823
+ string;
24824
+ /** 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. */
24825
+ key?:
24826
+ string;
24827
+ /** OAuth 2.0 token for the current user. */
24828
+ oauth_token?:
24829
+ string;
24830
+ /** Returns response with indentations and line breaks. */
24831
+ prettyPrint?:
24832
+ boolean;
24833
+ /** 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. */
24834
+ quotaUser?:
24835
+ string;
24836
+ /**
24837
+ * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this
24838
+ * field.
24839
+ */
24840
+ resource:
24841
+ string;
24842
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
24843
+ upload_protocol?:
24844
+ string;
24845
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
24846
+ uploadType?:
24847
+ string;
24848
+ },
24849
+ body: GoogleIamV1SetIamPolicyRequest): Request<GoogleIamV1Policy>;
24850
+ /**
24851
+ * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This
24852
+ * operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
24853
+ */
24854
+ testIamPermissions(request?: {
24855
+ /** V1 error format. */
24856
+ "$.xgafv"?:
24857
+ string;
24858
+ /** OAuth access token. */
24859
+ access_token?:
24860
+ string;
24861
+ /** Data format for response. */
24862
+ alt?:
24863
+ string;
24864
+ /** JSONP */
24865
+ callback?:
24866
+ string;
24867
+ /** Selector specifying which fields to include in a partial response. */
24868
+ fields?:
24869
+ string;
24870
+ /** 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. */
24871
+ key?:
24872
+ string;
24873
+ /** OAuth 2.0 token for the current user. */
24874
+ oauth_token?:
24875
+ string;
24876
+ /**
24877
+ * The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM
24878
+ * Overview](https://cloud.google.com/iam/docs/overview#permissions).
24879
+ */
24880
+ permissions?:
24881
+ string | string[];
24882
+ /** Returns response with indentations and line breaks. */
24883
+ prettyPrint?:
24884
+ boolean;
24885
+ /** 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. */
24886
+ quotaUser?:
24887
+ string;
24888
+ /**
24889
+ * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for
24890
+ * this field.
24891
+ */
24892
+ resource:
24893
+ string;
24894
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
24895
+ upload_protocol?:
24896
+ string;
24897
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
24898
+ uploadType?:
24899
+ string;
24900
+ }): Request<GoogleIamV1TestIamPermissionsResponse>;
24901
+ }
23983
24902
  interface OperationsResource {
23984
24903
  /**
23985
24904
  * 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
@@ -24545,7 +25464,7 @@ declare namespace gapi.client {
24545
25464
  string;
24546
25465
  /**
24547
25466
  * 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
24548
- * less than 128 characters, and valid characters are /a-z-/.
25467
+ * less than 128 characters, and valid characters are `/a-z-/`.
24549
25468
  */
24550
25469
  pipelineJobId?:
24551
25470
  string;
@@ -24592,7 +25511,7 @@ declare namespace gapi.client {
24592
25511
  string;
24593
25512
  /**
24594
25513
  * 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
24595
- * less than 128 characters, and valid characters are /a-z-/.
25514
+ * less than 128 characters, and valid characters are `/a-z-/`.
24596
25515
  */
24597
25516
  pipelineJobId?:
24598
25517
  string;
@@ -29164,7 +30083,7 @@ declare namespace gapi.client {
29164
30083
  string;
29165
30084
  /**
29166
30085
  * 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
29167
- * characters are /a-z-/.
30086
+ * characters are `/a-z-/`.
29168
30087
  */
29169
30088
  tensorboardRunId?:
29170
30089
  string;
@@ -29214,7 +30133,7 @@ declare namespace gapi.client {
29214
30133
  string;
29215
30134
  /**
29216
30135
  * 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
29217
- * characters are /a-z-/.
30136
+ * characters are `/a-z-/`.
29218
30137
  */
29219
30138
  tensorboardRunId?:
29220
30139
  string;
@@ -29587,7 +30506,7 @@ declare namespace gapi.client {
29587
30506
  string;
29588
30507
  /**
29589
30508
  * 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,
29590
- * and valid characters are /a-z-/.
30509
+ * and valid characters are `/a-z-/`.
29591
30510
  */
29592
30511
  tensorboardExperimentId?:
29593
30512
  string;
@@ -29634,7 +30553,7 @@ declare namespace gapi.client {
29634
30553
  string;
29635
30554
  /**
29636
30555
  * 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,
29637
- * and valid characters are /a-z-/.
30556
+ * and valid characters are `/a-z-/`.
29638
30557
  */
29639
30558
  tensorboardExperimentId?:
29640
30559
  string;
@@ -31236,6 +32155,10 @@ declare namespace gapi.client {
31236
32155
  ModelsResource;
31237
32156
  nasJobs:
31238
32157
  NasJobsResource;
32158
+ notebookRuntimes:
32159
+ NotebookRuntimesResource;
32160
+ notebookRuntimeTemplates:
32161
+ NotebookRuntimeTemplatesResource;
31239
32162
  operations:
31240
32163
  OperationsResource;
31241
32164
  pipelineJobs: