@maxim_mazurok/gapi.client.aiplatform-v1 0.0.20240312 → 0.0.20240313

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 (2) hide show
  1. package/index.d.ts +343 -6
  2. package/package.json +1 -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: 20240312
12
+ // Revision: 20240313
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -932,6 +932,12 @@ declare namespace gapi.client {
932
932
  /** The operation generic information. */
933
933
  genericMetadata?: GoogleCloudAiplatformV1GenericOperationMetadata;
934
934
  }
935
+ interface GoogleCloudAiplatformV1CreatePersistentResourceOperationMetadata {
936
+ /** Operation metadata for PersistentResource. */
937
+ genericMetadata?: GoogleCloudAiplatformV1GenericOperationMetadata;
938
+ /** Progress Message for Create LRO */
939
+ progressMessage?: string;
940
+ }
935
941
  interface GoogleCloudAiplatformV1CreatePipelineJobRequest {
936
942
  /** Required. The resource name of the Location to create the PipelineJob in. Format: `projects/{project}/locations/{location}` */
937
943
  parent?: string;
@@ -1375,8 +1381,6 @@ declare namespace gapi.client {
1375
1381
  network?: string;
1376
1382
  /** Configures the request-response logging for online prediction. */
1377
1383
  predictRequestResponseLoggingConfig?: GoogleCloudAiplatformV1PredictRequestResponseLoggingConfig;
1378
- /** Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive. */
1379
- privateServiceConnectConfig?: GoogleCloudAiplatformV1PrivateServiceConnectConfig;
1380
1384
  /** A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If a DeployedModel's ID is not listed in this map, then it receives no traffic. The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment. */
1381
1385
  trafficSplit?: {[P in string]: number};
1382
1386
  /** Output only. Timestamp when this Endpoint was last updated. */
@@ -2141,9 +2145,9 @@ declare namespace gapi.client {
2141
2145
  interface GoogleCloudAiplatformV1FunctionDeclaration {
2142
2146
  /** Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. */
2143
2147
  description?: string;
2144
- /** Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. */
2148
+ /** Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64. */
2145
2149
  name?: string;
2146
- /** Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 */
2150
+ /** Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 */
2147
2151
  parameters?: GoogleCloudAiplatformV1Schema;
2148
2152
  }
2149
2153
  interface GoogleCloudAiplatformV1FunctionResponse {
@@ -2167,6 +2171,8 @@ declare namespace gapi.client {
2167
2171
  generationConfig?: GoogleCloudAiplatformV1GenerationConfig;
2168
2172
  /** Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates. */
2169
2173
  safetySettings?: GoogleCloudAiplatformV1SafetySetting[];
2174
+ /** Optional. The user provided system instructions for the model. */
2175
+ systemInstructions?: GoogleCloudAiplatformV1Content[];
2170
2176
  /** Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. */
2171
2177
  tools?: GoogleCloudAiplatformV1Tool[];
2172
2178
  }
@@ -2219,6 +2225,10 @@ declare namespace gapi.client {
2219
2225
  /** Required. The public base model URI. */
2220
2226
  baseModelUri?: string;
2221
2227
  }
2228
+ interface GoogleCloudAiplatformV1GoogleSearchRetrieval {
2229
+ /** Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. */
2230
+ disableAttribution?: boolean;
2231
+ }
2222
2232
  interface GoogleCloudAiplatformV1GroundingAttribution {
2223
2233
  /** Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident. */
2224
2234
  confidenceScore?: number;
@@ -2712,6 +2722,11 @@ declare namespace gapi.client {
2712
2722
  /** The pareto-optimal Trials for multiple objective Study or the optimal trial for single objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency */
2713
2723
  optimalTrials?: GoogleCloudAiplatformV1Trial[];
2714
2724
  }
2725
+ interface GoogleCloudAiplatformV1ListPersistentResourcesResponse {
2726
+ /** A token to retrieve next page of results. Pass to ListPersistentResourcesRequest.page_token to obtain that page. */
2727
+ nextPageToken?: string;
2728
+ persistentResources?: GoogleCloudAiplatformV1PersistentResource[];
2729
+ }
2715
2730
  interface GoogleCloudAiplatformV1ListPipelineJobsResponse {
2716
2731
  /** A token to retrieve the next page of results. Pass to ListPipelineJobsRequest.page_token to obtain that page. */
2717
2732
  nextPageToken?: string;
@@ -3662,6 +3677,36 @@ declare namespace gapi.client {
3662
3677
  /** 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 Persistent Disk) "pd-extreme" (Extreme Persistent Disk) */
3663
3678
  diskType?: string;
3664
3679
  }
3680
+ interface GoogleCloudAiplatformV1PersistentResource {
3681
+ /** Output only. Time when the PersistentResource was created. */
3682
+ createTime?: string;
3683
+ /** Optional. The display name of the PersistentResource. The name can be up to 128 characters long and can consist of any UTF-8 characters. */
3684
+ displayName?: string;
3685
+ /** Optional. Customer-managed encryption key spec for a PersistentResource. If set, this PersistentResource and all sub-resources of this PersistentResource will be secured by this key. */
3686
+ encryptionSpec?: GoogleCloudAiplatformV1EncryptionSpec;
3687
+ /** Output only. Only populated when persistent resource's state is `STOPPING` or `ERROR`. */
3688
+ error?: GoogleRpcStatus;
3689
+ /** Optional. The labels with user-defined metadata to organize PersistentResource. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. */
3690
+ labels?: {[P in string]: string};
3691
+ /** Immutable. Resource name of a PersistentResource. */
3692
+ name?: string;
3693
+ /** Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to peered with Vertex AI to host the persistent resources. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources aren't peered with any network. */
3694
+ network?: string;
3695
+ /** Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. */
3696
+ reservedIpRanges?: string[];
3697
+ /** Required. The spec of the pools of different resources. */
3698
+ resourcePools?: GoogleCloudAiplatformV1ResourcePool[];
3699
+ /** Output only. Runtime information of the Persistent Resource. */
3700
+ resourceRuntime?: GoogleCloudAiplatformV1ResourceRuntime;
3701
+ /** Optional. Persistent Resource runtime spec. For example, used for Ray cluster configuration. */
3702
+ resourceRuntimeSpec?: GoogleCloudAiplatformV1ResourceRuntimeSpec;
3703
+ /** Output only. Time when the PersistentResource for the first time entered the `RUNNING` state. */
3704
+ startTime?: string;
3705
+ /** Output only. The detailed state of a Study. */
3706
+ state?: string;
3707
+ /** Output only. Time when the PersistentResource was most recently updated. */
3708
+ updateTime?: string;
3709
+ }
3665
3710
  interface GoogleCloudAiplatformV1PipelineJob {
3666
3711
  /** Output only. Pipeline creation time. */
3667
3712
  createTime?: string;
@@ -4076,6 +4121,20 @@ declare namespace gapi.client {
4076
4121
  /** The prediction input. Supports HTTP headers and arbitrary data payload. A DeployedModel may have an upper limit on the number of instances it supports per request. When this limit it is exceeded for an AutoML model, the RawPredict method returns an error. When this limit is exceeded for a custom-trained model, the behavior varies depending on the model. You can specify the schema for each instance in the predict_schemata.instance_schema_uri field when you create a Model. This schema applies when you deploy the `Model` as a `DeployedModel` to an Endpoint and use the `RawPredict` method. */
4077
4122
  httpBody?: GoogleApiHttpBody;
4078
4123
  }
4124
+ interface GoogleCloudAiplatformV1RayMetricSpec {
4125
+ /** Optional. Flag to disable the Ray metrics collection. */
4126
+ disabled?: boolean;
4127
+ }
4128
+ interface GoogleCloudAiplatformV1RaySpec {
4129
+ /** 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 head node by default if this field isn't set. */
4130
+ headNodeResourcePoolId?: string;
4131
+ /** Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt 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 to have the same Ray image. Otherwise, use the {@code resource_pool_images} field. */
4132
+ imageUri?: string;
4133
+ /** Optional. Ray metrics configurations. */
4134
+ rayMetricSpec?: GoogleCloudAiplatformV1RayMetricSpec;
4135
+ /** Optional. Required if image_uri isn't 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 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" } */
4136
+ resourcePoolImages?: {[P in string]: string};
4137
+ }
4079
4138
  interface GoogleCloudAiplatformV1ReadFeatureValuesRequest {
4080
4139
  /** 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`. */
4081
4140
  entityId?: string;
@@ -4148,6 +4207,12 @@ declare namespace gapi.client {
4148
4207
  /** Number of times the user has read data within the Tensorboard. */
4149
4208
  viewCount?: string;
4150
4209
  }
4210
+ interface GoogleCloudAiplatformV1RebootPersistentResourceOperationMetadata {
4211
+ /** Operation metadata for PersistentResource. */
4212
+ genericMetadata?: GoogleCloudAiplatformV1GenericOperationMetadata;
4213
+ /** Progress Message for Reboot LRO */
4214
+ progressMessage?: string;
4215
+ }
4151
4216
  interface GoogleCloudAiplatformV1RemoveContextChildrenRequest {
4152
4217
  /** The resource names of the child Contexts. */
4153
4218
  childContexts?: string[];
@@ -4158,6 +4223,38 @@ declare namespace gapi.client {
4158
4223
  datapointIds?: string[];
4159
4224
  }
4160
4225
  interface GoogleCloudAiplatformV1RemoveDatapointsResponse {}
4226
+ interface GoogleCloudAiplatformV1ResourcePool {
4227
+ /** Optional. Optional spec to configure GKE autoscaling */
4228
+ autoscalingSpec?: GoogleCloudAiplatformV1ResourcePoolAutoscalingSpec;
4229
+ /** Optional. Disk spec for the machine in this node pool. */
4230
+ diskSpec?: GoogleCloudAiplatformV1DiskSpec;
4231
+ /** Immutable. The unique ID in a PersistentResource for referring to this resource pool. User can specify it if necessary. Otherwise, it's generated automatically. */
4232
+ id?: string;
4233
+ /** Required. Immutable. The specification of a single machine. */
4234
+ machineSpec?: GoogleCloudAiplatformV1MachineSpec;
4235
+ /** Optional. The total number of machines to use for this resource pool. */
4236
+ replicaCount?: string;
4237
+ /** Output only. The number of machines currently in use by training jobs for this resource pool. Will replace idle_replica_count. */
4238
+ usedReplicaCount?: string;
4239
+ }
4240
+ interface GoogleCloudAiplatformV1ResourcePoolAutoscalingSpec {
4241
+ /** Optional. max replicas in the node pool, must be ≥ replica_count and > min_replica_count or will throw error */
4242
+ maxReplicaCount?: string;
4243
+ /** Optional. min replicas in the node pool, must be ≤ replica_count and < max_replica_count or will throw error */
4244
+ minReplicaCount?: string;
4245
+ }
4246
+ interface GoogleCloudAiplatformV1ResourceRuntime {
4247
+ /** 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" } */
4248
+ accessUris?: {[P in string]: string};
4249
+ /** 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 Python version as the Persistent Cluster. Example: "projects/1000/locations/us-central1/notebookRuntimeTemplates/abc123" */
4250
+ notebookRuntimeTemplate?: string;
4251
+ }
4252
+ interface GoogleCloudAiplatformV1ResourceRuntimeSpec {
4253
+ /** Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource. */
4254
+ raySpec?: GoogleCloudAiplatformV1RaySpec;
4255
+ /** Optional. Configure the use of workload identity on the PersistentResource */
4256
+ serviceAccountSpec?: GoogleCloudAiplatformV1ServiceAccountSpec;
4257
+ }
4161
4258
  interface GoogleCloudAiplatformV1ResourcesConsumed {
4162
4259
  /** Output only. The number of replica hours used. Note that many replicas may run in parallel, and additionally any given work may be queued for some time. Therefore this value is not strictly related to wall time. */
4163
4260
  replicaHours?: number;
@@ -4171,6 +4268,12 @@ declare namespace gapi.client {
4171
4268
  /** Optional. Whether to backfill missed runs when the schedule is resumed from PAUSED state. If set to true, all missed runs will be scheduled. New runs will be scheduled after the backfill is complete. This will also update Schedule.catch_up field. Default to false. */
4172
4269
  catchUp?: boolean;
4173
4270
  }
4271
+ interface GoogleCloudAiplatformV1Retrieval {
4272
+ /** Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. */
4273
+ disableAttribution?: boolean;
4274
+ /** Set to use data source powered by Vertex AI Search. */
4275
+ vertexAiSearch?: GoogleCloudAiplatformV1VertexAISearch;
4276
+ }
4174
4277
  interface GoogleCloudAiplatformV1SafetyRating {
4175
4278
  /** Output only. Indicates whether the content was filtered out because of this rating. */
4176
4279
  blocked?: boolean;
@@ -4188,6 +4291,8 @@ declare namespace gapi.client {
4188
4291
  interface GoogleCloudAiplatformV1SafetySetting {
4189
4292
  /** Required. Harm category. */
4190
4293
  category?: string;
4294
+ /** Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score. */
4295
+ method?: string;
4191
4296
  /** Required. The harm block threshold. */
4192
4297
  threshold?: string;
4193
4298
  }
@@ -5657,6 +5762,12 @@ declare namespace gapi.client {
5657
5762
  /** Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. */
5658
5763
  startIndex?: number;
5659
5764
  }
5765
+ interface GoogleCloudAiplatformV1ServiceAccountSpec {
5766
+ /** Required. If true, custom user-managed service account is enforced to run any workloads (for example, Vertex Jobs) on the resource. Otherwise, uses the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). */
5767
+ enableCustomServiceAccount?: boolean;
5768
+ /** Optional. Default service account that this PersistentResource's workloads run as. The workloads include: * Any runtime specified via `ResourceRuntimeSpec` on creation time, for example, Ray. * Jobs submitted to PersistentResource, if no other service account specified in the job specs. Only works when custom service account is enabled and users have the `iam.serviceAccounts.actAs` permission on this service account. Required if any containers are specified in `ResourceRuntimeSpec`. */
5769
+ serviceAccount?: string;
5770
+ }
5660
5771
  interface GoogleCloudAiplatformV1ShieldedVmConfig {
5661
5772
  /** Defines whether the instance has [Secure Boot](https://cloud.google.com/compute/shielded-vm/docs/shielded-vm#secure-boot) enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. */
5662
5773
  enableSecureBoot?: boolean;
@@ -6095,6 +6206,10 @@ declare namespace gapi.client {
6095
6206
  interface GoogleCloudAiplatformV1Tool {
6096
6207
  /** Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 64 function declarations can be provided. */
6097
6208
  functionDeclarations?: GoogleCloudAiplatformV1FunctionDeclaration[];
6209
+ /** Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. */
6210
+ googleSearchRetrieval?: GoogleCloudAiplatformV1GoogleSearchRetrieval;
6211
+ /** Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. */
6212
+ retrieval?: GoogleCloudAiplatformV1Retrieval;
6098
6213
  }
6099
6214
  interface GoogleCloudAiplatformV1TrainingConfig {
6100
6215
  /** The timeout hours for the CMLE training job, expressed in milli hours i.e. 1,000 value in this field means 1 hour. */
@@ -6245,6 +6360,12 @@ declare namespace gapi.client {
6245
6360
  /** The operation generic information. */
6246
6361
  genericMetadata?: GoogleCloudAiplatformV1GenericOperationMetadata;
6247
6362
  }
6363
+ interface GoogleCloudAiplatformV1UpdatePersistentResourceOperationMetadata {
6364
+ /** Operation metadata for PersistentResource. */
6365
+ genericMetadata?: GoogleCloudAiplatformV1GenericOperationMetadata;
6366
+ /** Progress Message for Update LRO */
6367
+ progressMessage?: string;
6368
+ }
6248
6369
  interface GoogleCloudAiplatformV1UpdateSpecialistPoolOperationMetadata {
6249
6370
  /** The operation generic information. */
6250
6371
  genericMetadata?: GoogleCloudAiplatformV1GenericOperationMetadata;
@@ -6305,6 +6426,10 @@ declare namespace gapi.client {
6305
6426
  /** A string value. */
6306
6427
  stringValue?: string;
6307
6428
  }
6429
+ interface GoogleCloudAiplatformV1VertexAISearch {
6430
+ /** Required. Fully-qualified Vertex AI Search's datastore resource ID. projects/<>/locations/<>/collections/<>/dataStores/<> */
6431
+ datastore?: string;
6432
+ }
6308
6433
  interface GoogleCloudAiplatformV1VideoMetadata {
6309
6434
  /** Optional. The end offset of the video. */
6310
6435
  endOffset?: string;
@@ -20059,7 +20184,7 @@ declare namespace gapi.client {
20059
20184
  callback?: string;
20060
20185
  /** Selector specifying which fields to include in a partial response. */
20061
20186
  fields?: string;
20062
- /** Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. Some examples: * `notebookRuntime="notebookRuntime123"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` * `notebookRuntimeTemplate="notebookRuntimeTemplate321"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser="test@google.com"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` * `notebookRuntimeType=USER_DEFINED` */
20187
+ /** Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED, ERROR, INVALID]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. Some examples: * `notebookRuntime="notebookRuntime123"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` * `notebookRuntimeTemplate="notebookRuntimeTemplate321"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser="test@google.com"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` * `notebookRuntimeType=USER_DEFINED` */
20063
20188
  filter?: string;
20064
20189
  /** 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. */
20065
20190
  key?: string;
@@ -20589,6 +20714,217 @@ declare namespace gapi.client {
20589
20714
  uploadType?: string;
20590
20715
  }): Request<GoogleLongrunningOperation>;
20591
20716
  }
20717
+ interface PersistentResourcesResource {
20718
+ /** Creates a PersistentResource. */
20719
+ create(request: {
20720
+ /** V1 error format. */
20721
+ '$.xgafv'?: string;
20722
+ /** OAuth access token. */
20723
+ access_token?: string;
20724
+ /** Data format for response. */
20725
+ alt?: string;
20726
+ /** JSONP */
20727
+ callback?: string;
20728
+ /** Selector specifying which fields to include in a partial response. */
20729
+ fields?: string;
20730
+ /** 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. */
20731
+ key?: string;
20732
+ /** OAuth 2.0 token for the current user. */
20733
+ oauth_token?: string;
20734
+ /** Required. The resource name of the Location to create the PersistentResource in. Format: `projects/{project}/locations/{location}` */
20735
+ parent: string;
20736
+ /** 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 characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`. */
20737
+ persistentResourceId?: string;
20738
+ /** Returns response with indentations and line breaks. */
20739
+ prettyPrint?: boolean;
20740
+ /** 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. */
20741
+ quotaUser?: string;
20742
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
20743
+ upload_protocol?: string;
20744
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
20745
+ uploadType?: string;
20746
+ /** Request body */
20747
+ resource: GoogleCloudAiplatformV1PersistentResource;
20748
+ }): Request<GoogleLongrunningOperation>;
20749
+ create(
20750
+ request: {
20751
+ /** V1 error format. */
20752
+ '$.xgafv'?: string;
20753
+ /** OAuth access token. */
20754
+ access_token?: string;
20755
+ /** Data format for response. */
20756
+ alt?: string;
20757
+ /** JSONP */
20758
+ callback?: string;
20759
+ /** Selector specifying which fields to include in a partial response. */
20760
+ fields?: string;
20761
+ /** 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. */
20762
+ key?: string;
20763
+ /** OAuth 2.0 token for the current user. */
20764
+ oauth_token?: string;
20765
+ /** Required. The resource name of the Location to create the PersistentResource in. Format: `projects/{project}/locations/{location}` */
20766
+ parent: string;
20767
+ /** 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 characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`. */
20768
+ persistentResourceId?: string;
20769
+ /** Returns response with indentations and line breaks. */
20770
+ prettyPrint?: boolean;
20771
+ /** 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. */
20772
+ quotaUser?: string;
20773
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
20774
+ upload_protocol?: string;
20775
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
20776
+ uploadType?: string;
20777
+ },
20778
+ body: GoogleCloudAiplatformV1PersistentResource
20779
+ ): Request<GoogleLongrunningOperation>;
20780
+ /** Deletes a PersistentResource. */
20781
+ delete(request?: {
20782
+ /** V1 error format. */
20783
+ '$.xgafv'?: string;
20784
+ /** OAuth access token. */
20785
+ access_token?: string;
20786
+ /** Data format for response. */
20787
+ alt?: string;
20788
+ /** JSONP */
20789
+ callback?: string;
20790
+ /** Selector specifying which fields to include in a partial response. */
20791
+ fields?: string;
20792
+ /** 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. */
20793
+ key?: string;
20794
+ /** Required. The name of the PersistentResource to be deleted. Format: `projects/{project}/locations/{location}/persistentResources/{persistent_resource}` */
20795
+ name: string;
20796
+ /** OAuth 2.0 token for the current user. */
20797
+ oauth_token?: string;
20798
+ /** Returns response with indentations and line breaks. */
20799
+ prettyPrint?: boolean;
20800
+ /** 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. */
20801
+ quotaUser?: string;
20802
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
20803
+ upload_protocol?: string;
20804
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
20805
+ uploadType?: string;
20806
+ }): Request<GoogleLongrunningOperation>;
20807
+ /** Gets a PersistentResource. */
20808
+ get(request?: {
20809
+ /** V1 error format. */
20810
+ '$.xgafv'?: string;
20811
+ /** OAuth access token. */
20812
+ access_token?: string;
20813
+ /** Data format for response. */
20814
+ alt?: string;
20815
+ /** JSONP */
20816
+ callback?: string;
20817
+ /** Selector specifying which fields to include in a partial response. */
20818
+ fields?: string;
20819
+ /** 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. */
20820
+ key?: string;
20821
+ /** Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}` */
20822
+ name: string;
20823
+ /** OAuth 2.0 token for the current user. */
20824
+ oauth_token?: string;
20825
+ /** Returns response with indentations and line breaks. */
20826
+ prettyPrint?: boolean;
20827
+ /** 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. */
20828
+ quotaUser?: string;
20829
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
20830
+ upload_protocol?: string;
20831
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
20832
+ uploadType?: string;
20833
+ }): Request<GoogleCloudAiplatformV1PersistentResource>;
20834
+ /** Lists PersistentResources in a Location. */
20835
+ list(request?: {
20836
+ /** V1 error format. */
20837
+ '$.xgafv'?: string;
20838
+ /** OAuth access token. */
20839
+ access_token?: string;
20840
+ /** Data format for response. */
20841
+ alt?: string;
20842
+ /** JSONP */
20843
+ callback?: string;
20844
+ /** Selector specifying which fields to include in a partial response. */
20845
+ fields?: string;
20846
+ /** 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. */
20847
+ key?: string;
20848
+ /** OAuth 2.0 token for the current user. */
20849
+ oauth_token?: string;
20850
+ /** Optional. The standard list page size. */
20851
+ pageSize?: number;
20852
+ /** Optional. The standard list page token. Typically obtained via ListPersistentResourceResponse.next_page_token of the previous PersistentResourceService.ListPersistentResource call. */
20853
+ pageToken?: string;
20854
+ /** Required. The resource name of the Location to list the PersistentResources from. Format: `projects/{project}/locations/{location}` */
20855
+ parent: string;
20856
+ /** Returns response with indentations and line breaks. */
20857
+ prettyPrint?: boolean;
20858
+ /** 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. */
20859
+ quotaUser?: string;
20860
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
20861
+ upload_protocol?: string;
20862
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
20863
+ uploadType?: string;
20864
+ }): Request<GoogleCloudAiplatformV1ListPersistentResourcesResponse>;
20865
+ /** Updates a PersistentResource. */
20866
+ patch(request: {
20867
+ /** V1 error format. */
20868
+ '$.xgafv'?: string;
20869
+ /** OAuth access token. */
20870
+ access_token?: string;
20871
+ /** Data format for response. */
20872
+ alt?: string;
20873
+ /** JSONP */
20874
+ callback?: string;
20875
+ /** Selector specifying which fields to include in a partial response. */
20876
+ fields?: string;
20877
+ /** 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. */
20878
+ key?: string;
20879
+ /** Immutable. Resource name of a PersistentResource. */
20880
+ name: string;
20881
+ /** OAuth 2.0 token for the current user. */
20882
+ oauth_token?: string;
20883
+ /** Returns response with indentations and line breaks. */
20884
+ prettyPrint?: boolean;
20885
+ /** 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. */
20886
+ quotaUser?: string;
20887
+ /** Required. Specify the fields to be overwritten in the PersistentResource by the update method. */
20888
+ updateMask?: string;
20889
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
20890
+ upload_protocol?: string;
20891
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
20892
+ uploadType?: string;
20893
+ /** Request body */
20894
+ resource: GoogleCloudAiplatformV1PersistentResource;
20895
+ }): Request<GoogleLongrunningOperation>;
20896
+ patch(
20897
+ request: {
20898
+ /** V1 error format. */
20899
+ '$.xgafv'?: string;
20900
+ /** OAuth access token. */
20901
+ access_token?: string;
20902
+ /** Data format for response. */
20903
+ alt?: string;
20904
+ /** JSONP */
20905
+ callback?: string;
20906
+ /** Selector specifying which fields to include in a partial response. */
20907
+ fields?: string;
20908
+ /** 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. */
20909
+ key?: string;
20910
+ /** Immutable. Resource name of a PersistentResource. */
20911
+ name: string;
20912
+ /** OAuth 2.0 token for the current user. */
20913
+ oauth_token?: string;
20914
+ /** Returns response with indentations and line breaks. */
20915
+ prettyPrint?: boolean;
20916
+ /** 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. */
20917
+ quotaUser?: string;
20918
+ /** Required. Specify the fields to be overwritten in the PersistentResource by the update method. */
20919
+ updateMask?: string;
20920
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
20921
+ upload_protocol?: string;
20922
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
20923
+ uploadType?: string;
20924
+ },
20925
+ body: GoogleCloudAiplatformV1PersistentResource
20926
+ ): Request<GoogleLongrunningOperation>;
20927
+ }
20592
20928
  interface OperationsResource {
20593
20929
  /** 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 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 completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. */
20594
20930
  cancel(request?: {
@@ -25729,6 +26065,7 @@ declare namespace gapi.client {
25729
26065
  notebookRuntimes: NotebookRuntimesResource;
25730
26066
  notebookRuntimeTemplates: NotebookRuntimeTemplatesResource;
25731
26067
  operations: OperationsResource;
26068
+ persistentResources: PersistentResourcesResource;
25732
26069
  pipelineJobs: PipelineJobsResource;
25733
26070
  publishers: PublishersResource;
25734
26071
  schedules: SchedulesResource;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.aiplatform-v1",
3
- "version": "0.0.20240312",
3
+ "version": "0.0.20240313",
4
4
  "description": "TypeScript typings for Vertex AI API v1",
5
5
  "repository": {
6
6
  "type": "git",