databricks-sdk 0.56.0__py3-none-any.whl → 0.57.0__py3-none-any.whl

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.

Potentially problematic release.


This version of databricks-sdk might be problematic. Click here for more details.

Files changed (31) hide show
  1. databricks/sdk/__init__.py +15 -9
  2. databricks/sdk/service/aibuilder.py +157 -16
  3. databricks/sdk/service/apps.py +14 -42
  4. databricks/sdk/service/billing.py +17 -51
  5. databricks/sdk/service/catalog.py +198 -399
  6. databricks/sdk/service/cleanrooms.py +11 -33
  7. databricks/sdk/service/compute.py +63 -189
  8. databricks/sdk/service/dashboards.py +21 -63
  9. databricks/sdk/service/database.py +45 -30
  10. databricks/sdk/service/files.py +18 -54
  11. databricks/sdk/service/iam.py +55 -165
  12. databricks/sdk/service/jobs.py +232 -85
  13. databricks/sdk/service/marketplace.py +46 -146
  14. databricks/sdk/service/ml.py +455 -216
  15. databricks/sdk/service/oauth2.py +17 -45
  16. databricks/sdk/service/pipelines.py +81 -40
  17. databricks/sdk/service/provisioning.py +30 -90
  18. databricks/sdk/service/qualitymonitorv2.py +5 -15
  19. databricks/sdk/service/serving.py +30 -42
  20. databricks/sdk/service/settings.py +103 -314
  21. databricks/sdk/service/sharing.py +30 -86
  22. databricks/sdk/service/sql.py +74 -184
  23. databricks/sdk/service/vectorsearch.py +13 -43
  24. databricks/sdk/service/workspace.py +35 -105
  25. databricks/sdk/version.py +1 -1
  26. {databricks_sdk-0.56.0.dist-info → databricks_sdk-0.57.0.dist-info}/METADATA +1 -1
  27. {databricks_sdk-0.56.0.dist-info → databricks_sdk-0.57.0.dist-info}/RECORD +31 -31
  28. {databricks_sdk-0.56.0.dist-info → databricks_sdk-0.57.0.dist-info}/WHEEL +0 -0
  29. {databricks_sdk-0.56.0.dist-info → databricks_sdk-0.57.0.dist-info}/licenses/LICENSE +0 -0
  30. {databricks_sdk-0.56.0.dist-info → databricks_sdk-0.57.0.dist-info}/licenses/NOTICE +0 -0
  31. {databricks_sdk-0.56.0.dist-info → databricks_sdk-0.57.0.dist-info}/top_level.txt +0 -0
@@ -2326,9 +2326,7 @@ class CredentialsAPI:
2326
2326
  self._api = api_client
2327
2327
 
2328
2328
  def create(self, credentials_name: str, aws_credentials: CreateCredentialAwsCredentials) -> Credential:
2329
- """Create credential configuration.
2330
-
2331
- Creates a Databricks credential configuration that represents cloud cross-account credentials for a
2329
+ """Creates a Databricks credential configuration that represents cloud cross-account credentials for a
2332
2330
  specified account. Databricks uses this to set up network infrastructure properly to host Databricks
2333
2331
  clusters. For your AWS IAM role, you need to trust the External ID (the Databricks Account API account
2334
2332
  ID) in the returned credential object, and configure the required access policy.
@@ -2361,9 +2359,7 @@ class CredentialsAPI:
2361
2359
  return Credential.from_dict(res)
2362
2360
 
2363
2361
  def delete(self, credentials_id: str):
2364
- """Delete credential configuration.
2365
-
2366
- Deletes a Databricks credential configuration object for an account, both specified by ID. You cannot
2362
+ """Deletes a Databricks credential configuration object for an account, both specified by ID. You cannot
2367
2363
  delete a credential that is associated with any workspace.
2368
2364
 
2369
2365
  :param credentials_id: str
@@ -2381,9 +2377,7 @@ class CredentialsAPI:
2381
2377
  )
2382
2378
 
2383
2379
  def get(self, credentials_id: str) -> Credential:
2384
- """Get credential configuration.
2385
-
2386
- Gets a Databricks credential configuration object for an account, both specified by ID.
2380
+ """Gets a Databricks credential configuration object for an account, both specified by ID.
2387
2381
 
2388
2382
  :param credentials_id: str
2389
2383
  Databricks Account API credential configuration ID
@@ -2401,9 +2395,7 @@ class CredentialsAPI:
2401
2395
  return Credential.from_dict(res)
2402
2396
 
2403
2397
  def list(self) -> Iterator[Credential]:
2404
- """Get all credential configurations.
2405
-
2406
- Gets all Databricks credential configurations associated with an account specified by ID.
2398
+ """Gets all Databricks credential configurations associated with an account specified by ID.
2407
2399
 
2408
2400
  :returns: Iterator over :class:`Credential`
2409
2401
  """
@@ -2441,9 +2433,7 @@ class EncryptionKeysAPI:
2441
2433
  aws_key_info: Optional[CreateAwsKeyInfo] = None,
2442
2434
  gcp_key_info: Optional[CreateGcpKeyInfo] = None,
2443
2435
  ) -> CustomerManagedKey:
2444
- """Create encryption key configuration.
2445
-
2446
- Creates a customer-managed key configuration object for an account, specified by ID. This operation
2436
+ """Creates a customer-managed key configuration object for an account, specified by ID. This operation
2447
2437
  uploads a reference to a customer-managed key to Databricks. If the key is assigned as a workspace's
2448
2438
  customer-managed key for managed services, Databricks uses the key to encrypt the workspaces notebooks
2449
2439
  and secrets in the control plane, in addition to Databricks SQL queries and query history. If it is
@@ -2482,9 +2472,7 @@ class EncryptionKeysAPI:
2482
2472
  return CustomerManagedKey.from_dict(res)
2483
2473
 
2484
2474
  def delete(self, customer_managed_key_id: str):
2485
- """Delete encryption key configuration.
2486
-
2487
- Deletes a customer-managed key configuration object for an account. You cannot delete a configuration
2475
+ """Deletes a customer-managed key configuration object for an account. You cannot delete a configuration
2488
2476
  that is associated with a running workspace.
2489
2477
 
2490
2478
  :param customer_managed_key_id: str
@@ -2504,9 +2492,7 @@ class EncryptionKeysAPI:
2504
2492
  )
2505
2493
 
2506
2494
  def get(self, customer_managed_key_id: str) -> CustomerManagedKey:
2507
- """Get encryption key configuration.
2508
-
2509
- Gets a customer-managed key configuration object for an account, specified by ID. This operation
2495
+ """Gets a customer-managed key configuration object for an account, specified by ID. This operation
2510
2496
  uploads a reference to a customer-managed key to Databricks. If assigned as a workspace's
2511
2497
  customer-managed key for managed services, Databricks uses the key to encrypt the workspaces notebooks
2512
2498
  and secrets in the control plane, in addition to Databricks SQL queries and query history. If it is
@@ -2537,9 +2523,7 @@ class EncryptionKeysAPI:
2537
2523
  return CustomerManagedKey.from_dict(res)
2538
2524
 
2539
2525
  def list(self) -> Iterator[CustomerManagedKey]:
2540
- """Get all encryption key configurations.
2541
-
2542
- Gets all customer-managed key configuration objects for an account. If the key is specified as a
2526
+ """Gets all customer-managed key configuration objects for an account. If the key is specified as a
2543
2527
  workspace's managed services customer-managed key, Databricks uses the key to encrypt the workspace's
2544
2528
  notebooks and secrets in the control plane, in addition to Databricks SQL queries and query history.
2545
2529
  If the key is specified as a workspace's storage customer-managed key, the key is used to encrypt the
@@ -2578,9 +2562,7 @@ class NetworksAPI:
2578
2562
  vpc_endpoints: Optional[NetworkVpcEndpoints] = None,
2579
2563
  vpc_id: Optional[str] = None,
2580
2564
  ) -> Network:
2581
- """Create network configuration.
2582
-
2583
- Creates a Databricks network configuration that represents an VPC and its resources. The VPC will be
2565
+ """Creates a Databricks network configuration that represents an VPC and its resources. The VPC will be
2584
2566
  used for new Databricks clusters. This requires a pre-existing VPC and subnets.
2585
2567
 
2586
2568
  :param network_name: str
@@ -2627,9 +2609,7 @@ class NetworksAPI:
2627
2609
  return Network.from_dict(res)
2628
2610
 
2629
2611
  def delete(self, network_id: str):
2630
- """Delete a network configuration.
2631
-
2632
- Deletes a Databricks network configuration, which represents a cloud VPC and its resources. You cannot
2612
+ """Deletes a Databricks network configuration, which represents a cloud VPC and its resources. You cannot
2633
2613
  delete a network that is associated with a workspace.
2634
2614
 
2635
2615
  This operation is available only if your account is on the E2 version of the platform.
@@ -2647,9 +2627,7 @@ class NetworksAPI:
2647
2627
  self._api.do("DELETE", f"/api/2.0/accounts/{self._api.account_id}/networks/{network_id}", headers=headers)
2648
2628
 
2649
2629
  def get(self, network_id: str) -> Network:
2650
- """Get a network configuration.
2651
-
2652
- Gets a Databricks network configuration, which represents a cloud VPC and its resources.
2630
+ """Gets a Databricks network configuration, which represents a cloud VPC and its resources.
2653
2631
 
2654
2632
  :param network_id: str
2655
2633
  Databricks Account API network configuration ID.
@@ -2665,9 +2643,7 @@ class NetworksAPI:
2665
2643
  return Network.from_dict(res)
2666
2644
 
2667
2645
  def list(self) -> Iterator[Network]:
2668
- """Get all network configurations.
2669
-
2670
- Gets a list of all Databricks network configurations for an account, specified by ID.
2646
+ """Gets a list of all Databricks network configurations for an account, specified by ID.
2671
2647
 
2672
2648
  This operation is available only if your account is on the E2 version of the platform.
2673
2649
 
@@ -2697,9 +2673,7 @@ class PrivateAccessAPI:
2697
2673
  private_access_level: Optional[PrivateAccessLevel] = None,
2698
2674
  public_access_enabled: Optional[bool] = None,
2699
2675
  ) -> PrivateAccessSettings:
2700
- """Create private access settings.
2701
-
2702
- Creates a private access settings object, which specifies how your workspace is accessed over [AWS
2676
+ """Creates a private access settings object, which specifies how your workspace is accessed over [AWS
2703
2677
  PrivateLink]. To use AWS PrivateLink, a workspace must have a private access settings object
2704
2678
  referenced by ID in the workspace's `private_access_settings_id` property.
2705
2679
 
@@ -2764,9 +2738,7 @@ class PrivateAccessAPI:
2764
2738
  return PrivateAccessSettings.from_dict(res)
2765
2739
 
2766
2740
  def delete(self, private_access_settings_id: str):
2767
- """Delete a private access settings object.
2768
-
2769
- Deletes a private access settings object, which determines how your workspace is accessed over [AWS
2741
+ """Deletes a private access settings object, which determines how your workspace is accessed over [AWS
2770
2742
  PrivateLink].
2771
2743
 
2772
2744
  Before configuring PrivateLink, read the [Databricks article about PrivateLink].",
@@ -2791,9 +2763,7 @@ class PrivateAccessAPI:
2791
2763
  )
2792
2764
 
2793
2765
  def get(self, private_access_settings_id: str) -> PrivateAccessSettings:
2794
- """Get a private access settings object.
2795
-
2796
- Gets a private access settings object, which specifies how your workspace is accessed over [AWS
2766
+ """Gets a private access settings object, which specifies how your workspace is accessed over [AWS
2797
2767
  PrivateLink].
2798
2768
 
2799
2769
  Before configuring PrivateLink, read the [Databricks article about PrivateLink].",
@@ -2819,9 +2789,7 @@ class PrivateAccessAPI:
2819
2789
  return PrivateAccessSettings.from_dict(res)
2820
2790
 
2821
2791
  def list(self) -> Iterator[PrivateAccessSettings]:
2822
- """Get all private access settings objects.
2823
-
2824
- Gets a list of all private access settings objects for an account, specified by ID.
2792
+ """Gets a list of all private access settings objects for an account, specified by ID.
2825
2793
 
2826
2794
  :returns: Iterator over :class:`PrivateAccessSettings`
2827
2795
  """
@@ -2843,9 +2811,7 @@ class PrivateAccessAPI:
2843
2811
  private_access_level: Optional[PrivateAccessLevel] = None,
2844
2812
  public_access_enabled: Optional[bool] = None,
2845
2813
  ):
2846
- """Replace private access settings.
2847
-
2848
- Updates an existing private access settings object, which specifies how your workspace is accessed
2814
+ """Updates an existing private access settings object, which specifies how your workspace is accessed
2849
2815
  over [AWS PrivateLink]. To use AWS PrivateLink, a workspace must have a private access settings object
2850
2816
  referenced by ID in the workspace's `private_access_settings_id` property.
2851
2817
 
@@ -2929,9 +2895,7 @@ class StorageAPI:
2929
2895
  self._api = api_client
2930
2896
 
2931
2897
  def create(self, storage_configuration_name: str, root_bucket_info: RootBucketInfo) -> StorageConfiguration:
2932
- """Create new storage configuration.
2933
-
2934
- Creates new storage configuration for an account, specified by ID. Uploads a storage configuration
2898
+ """Creates new storage configuration for an account, specified by ID. Uploads a storage configuration
2935
2899
  object that represents the root AWS S3 bucket in your account. Databricks stores related workspace
2936
2900
  assets including DBFS, cluster logs, and job results. For the AWS S3 bucket, you need to configure the
2937
2901
  required bucket policy.
@@ -2964,9 +2928,7 @@ class StorageAPI:
2964
2928
  return StorageConfiguration.from_dict(res)
2965
2929
 
2966
2930
  def delete(self, storage_configuration_id: str):
2967
- """Delete storage configuration.
2968
-
2969
- Deletes a Databricks storage configuration. You cannot delete a storage configuration that is
2931
+ """Deletes a Databricks storage configuration. You cannot delete a storage configuration that is
2970
2932
  associated with any workspace.
2971
2933
 
2972
2934
  :param storage_configuration_id: str
@@ -2986,9 +2948,7 @@ class StorageAPI:
2986
2948
  )
2987
2949
 
2988
2950
  def get(self, storage_configuration_id: str) -> StorageConfiguration:
2989
- """Get storage configuration.
2990
-
2991
- Gets a Databricks storage configuration for an account, both specified by ID.
2951
+ """Gets a Databricks storage configuration for an account, both specified by ID.
2992
2952
 
2993
2953
  :param storage_configuration_id: str
2994
2954
  Databricks Account API storage configuration ID.
@@ -3008,9 +2968,7 @@ class StorageAPI:
3008
2968
  return StorageConfiguration.from_dict(res)
3009
2969
 
3010
2970
  def list(self) -> Iterator[StorageConfiguration]:
3011
- """Get all storage configurations.
3012
-
3013
- Gets a list of all Databricks storage configurations for your account, specified by ID.
2971
+ """Gets a list of all Databricks storage configurations for your account, specified by ID.
3014
2972
 
3015
2973
  :returns: Iterator over :class:`StorageConfiguration`
3016
2974
  """
@@ -3037,9 +2995,7 @@ class VpcEndpointsAPI:
3037
2995
  gcp_vpc_endpoint_info: Optional[GcpVpcEndpointInfo] = None,
3038
2996
  region: Optional[str] = None,
3039
2997
  ) -> VpcEndpoint:
3040
- """Create VPC endpoint configuration.
3041
-
3042
- Creates a VPC endpoint configuration, which represents a [VPC endpoint] object in AWS used to
2998
+ """Creates a VPC endpoint configuration, which represents a [VPC endpoint] object in AWS used to
3043
2999
  communicate privately with Databricks over [AWS PrivateLink].
3044
3000
 
3045
3001
  After you create the VPC endpoint configuration, the Databricks [endpoint service] automatically
@@ -3083,9 +3039,7 @@ class VpcEndpointsAPI:
3083
3039
  return VpcEndpoint.from_dict(res)
3084
3040
 
3085
3041
  def delete(self, vpc_endpoint_id: str):
3086
- """Delete VPC endpoint configuration.
3087
-
3088
- Deletes a VPC endpoint configuration, which represents an [AWS VPC endpoint] that can communicate
3042
+ """Deletes a VPC endpoint configuration, which represents an [AWS VPC endpoint] that can communicate
3089
3043
  privately with Databricks over [AWS PrivateLink].
3090
3044
 
3091
3045
  Before configuring PrivateLink, read the [Databricks article about PrivateLink].
@@ -3109,9 +3063,7 @@ class VpcEndpointsAPI:
3109
3063
  )
3110
3064
 
3111
3065
  def get(self, vpc_endpoint_id: str) -> VpcEndpoint:
3112
- """Get a VPC endpoint configuration.
3113
-
3114
- Gets a VPC endpoint configuration, which represents a [VPC endpoint] object in AWS used to communicate
3066
+ """Gets a VPC endpoint configuration, which represents a [VPC endpoint] object in AWS used to communicate
3115
3067
  privately with Databricks over [AWS PrivateLink].
3116
3068
 
3117
3069
  [AWS PrivateLink]: https://aws.amazon.com/privatelink
@@ -3133,9 +3085,7 @@ class VpcEndpointsAPI:
3133
3085
  return VpcEndpoint.from_dict(res)
3134
3086
 
3135
3087
  def list(self) -> Iterator[VpcEndpoint]:
3136
- """Get all VPC endpoint configurations.
3137
-
3138
- Gets a list of all VPC endpoints for an account, specified by ID.
3088
+ """Gets a list of all VPC endpoints for an account, specified by ID.
3139
3089
 
3140
3090
  Before configuring PrivateLink, read the [Databricks article about PrivateLink].
3141
3091
 
@@ -3216,9 +3166,7 @@ class WorkspacesAPI:
3216
3166
  storage_configuration_id: Optional[str] = None,
3217
3167
  storage_customer_managed_key_id: Optional[str] = None,
3218
3168
  ) -> Wait[Workspace]:
3219
- """Create a new workspace.
3220
-
3221
- Creates a new workspace.
3169
+ """Creates a new workspace.
3222
3170
 
3223
3171
  **Important**: This operation is asynchronous. A response with HTTP status code 200 means the request
3224
3172
  has been accepted and is in progress, but does not mean that the workspace deployed successfully and
@@ -3412,9 +3360,7 @@ class WorkspacesAPI:
3412
3360
  ).result(timeout=timeout)
3413
3361
 
3414
3362
  def delete(self, workspace_id: int):
3415
- """Delete a workspace.
3416
-
3417
- Terminates and deletes a Databricks workspace. From an API perspective, deletion is immediate.
3363
+ """Terminates and deletes a Databricks workspace. From an API perspective, deletion is immediate.
3418
3364
  However, it might take a few minutes for all workspaces resources to be deleted, depending on the size
3419
3365
  and number of workspace resources.
3420
3366
 
@@ -3434,9 +3380,7 @@ class WorkspacesAPI:
3434
3380
  self._api.do("DELETE", f"/api/2.0/accounts/{self._api.account_id}/workspaces/{workspace_id}", headers=headers)
3435
3381
 
3436
3382
  def get(self, workspace_id: int) -> Workspace:
3437
- """Get a workspace.
3438
-
3439
- Gets information including status for a Databricks workspace, specified by ID. In the response, the
3383
+ """Gets information including status for a Databricks workspace, specified by ID. In the response, the
3440
3384
  `workspace_status` field indicates the current status. After initial workspace creation (which is
3441
3385
  asynchronous), make repeated `GET` requests with the workspace ID and check its status. The workspace
3442
3386
  becomes available when the status changes to `RUNNING`.
@@ -3465,9 +3409,7 @@ class WorkspacesAPI:
3465
3409
  return Workspace.from_dict(res)
3466
3410
 
3467
3411
  def list(self) -> Iterator[Workspace]:
3468
- """Get all workspaces.
3469
-
3470
- Gets a list of all workspaces associated with an account, specified by ID.
3412
+ """Gets a list of all workspaces associated with an account, specified by ID.
3471
3413
 
3472
3414
  This operation is available only if your account is on the E2 version of the platform or on a select
3473
3415
  custom plan that allows multiple workspaces per account.
@@ -3496,9 +3438,7 @@ class WorkspacesAPI:
3496
3438
  storage_configuration_id: Optional[str] = None,
3497
3439
  storage_customer_managed_key_id: Optional[str] = None,
3498
3440
  ) -> Wait[Workspace]:
3499
- """Update workspace configuration.
3500
-
3501
- Updates a workspace configuration for either a running workspace or a failed workspace. The elements
3441
+ """Updates a workspace configuration for either a running workspace or a failed workspace. The elements
3502
3442
  that can be updated varies between these two use cases.
3503
3443
 
3504
3444
  ### Update a failed workspace You can update a Databricks workspace configuration for failed workspace
@@ -163,9 +163,7 @@ class QualityMonitorV2API:
163
163
  self._api = api_client
164
164
 
165
165
  def create_quality_monitor(self, quality_monitor: QualityMonitor) -> QualityMonitor:
166
- """Create a quality monitor.
167
-
168
- Create a quality monitor on UC object
166
+ """Create a quality monitor on UC object
169
167
 
170
168
  :param quality_monitor: :class:`QualityMonitor`
171
169
 
@@ -181,9 +179,7 @@ class QualityMonitorV2API:
181
179
  return QualityMonitor.from_dict(res)
182
180
 
183
181
  def delete_quality_monitor(self, object_type: str, object_id: str):
184
- """Delete a quality monitor.
185
-
186
- Delete a quality monitor on UC object
182
+ """Delete a quality monitor on UC object
187
183
 
188
184
  :param object_type: str
189
185
  The type of the monitored object. Can be one of the following: schema.
@@ -200,9 +196,7 @@ class QualityMonitorV2API:
200
196
  self._api.do("DELETE", f"/api/2.0/quality-monitors/{object_type}/{object_id}", headers=headers)
201
197
 
202
198
  def get_quality_monitor(self, object_type: str, object_id: str) -> QualityMonitor:
203
- """Read a quality monitor.
204
-
205
- Read a quality monitor on UC object
199
+ """Read a quality monitor on UC object
206
200
 
207
201
  :param object_type: str
208
202
  The type of the monitored object. Can be one of the following: schema.
@@ -222,9 +216,7 @@ class QualityMonitorV2API:
222
216
  def list_quality_monitor(
223
217
  self, *, page_size: Optional[int] = None, page_token: Optional[str] = None
224
218
  ) -> Iterator[QualityMonitor]:
225
- """List quality monitors.
226
-
227
- (Unimplemented) List quality monitors
219
+ """(Unimplemented) List quality monitors
228
220
 
229
221
  :param page_size: int (optional)
230
222
  :param page_token: str (optional)
@@ -253,9 +245,7 @@ class QualityMonitorV2API:
253
245
  def update_quality_monitor(
254
246
  self, object_type: str, object_id: str, quality_monitor: QualityMonitor
255
247
  ) -> QualityMonitor:
256
- """Update a quality monitor.
257
-
258
- (Unimplemented) Update a quality monitor on UC object
248
+ """(Unimplemented) Update a quality monitor on UC object
259
249
 
260
250
  :param object_type: str
261
251
  The type of the monitored object. Can be one of the following: schema.
@@ -3799,6 +3799,9 @@ class ServingEndpoint:
3799
3799
  creator: Optional[str] = None
3800
3800
  """The email of the user who created the serving endpoint."""
3801
3801
 
3802
+ description: Optional[str] = None
3803
+ """Description of the endpoint"""
3804
+
3802
3805
  id: Optional[str] = None
3803
3806
  """System-generated ID of the endpoint, included to be used by the Permissions API."""
3804
3807
 
@@ -3830,6 +3833,8 @@ class ServingEndpoint:
3830
3833
  body["creation_timestamp"] = self.creation_timestamp
3831
3834
  if self.creator is not None:
3832
3835
  body["creator"] = self.creator
3836
+ if self.description is not None:
3837
+ body["description"] = self.description
3833
3838
  if self.id is not None:
3834
3839
  body["id"] = self.id
3835
3840
  if self.last_updated_timestamp is not None:
@@ -3857,6 +3862,8 @@ class ServingEndpoint:
3857
3862
  body["creation_timestamp"] = self.creation_timestamp
3858
3863
  if self.creator is not None:
3859
3864
  body["creator"] = self.creator
3865
+ if self.description is not None:
3866
+ body["description"] = self.description
3860
3867
  if self.id is not None:
3861
3868
  body["id"] = self.id
3862
3869
  if self.last_updated_timestamp is not None:
@@ -3880,6 +3887,7 @@ class ServingEndpoint:
3880
3887
  config=_from_dict(d, "config", EndpointCoreConfigSummary),
3881
3888
  creation_timestamp=d.get("creation_timestamp", None),
3882
3889
  creator=d.get("creator", None),
3890
+ description=d.get("description", None),
3883
3891
  id=d.get("id", None),
3884
3892
  last_updated_timestamp=d.get("last_updated_timestamp", None),
3885
3893
  name=d.get("name", None),
@@ -4021,6 +4029,9 @@ class ServingEndpointDetailed:
4021
4029
  data_plane_info: Optional[ModelDataPlaneInfo] = None
4022
4030
  """Information required to query DataPlane APIs."""
4023
4031
 
4032
+ description: Optional[str] = None
4033
+ """Description of the serving model"""
4034
+
4024
4035
  endpoint_url: Optional[str] = None
4025
4036
  """Endpoint invocation url if route optimization is enabled for endpoint"""
4026
4037
 
@@ -4067,6 +4078,8 @@ class ServingEndpointDetailed:
4067
4078
  body["creator"] = self.creator
4068
4079
  if self.data_plane_info:
4069
4080
  body["data_plane_info"] = self.data_plane_info.as_dict()
4081
+ if self.description is not None:
4082
+ body["description"] = self.description
4070
4083
  if self.endpoint_url is not None:
4071
4084
  body["endpoint_url"] = self.endpoint_url
4072
4085
  if self.id is not None:
@@ -4104,6 +4117,8 @@ class ServingEndpointDetailed:
4104
4117
  body["creator"] = self.creator
4105
4118
  if self.data_plane_info:
4106
4119
  body["data_plane_info"] = self.data_plane_info
4120
+ if self.description is not None:
4121
+ body["description"] = self.description
4107
4122
  if self.endpoint_url is not None:
4108
4123
  body["endpoint_url"] = self.endpoint_url
4109
4124
  if self.id is not None:
@@ -4136,6 +4151,7 @@ class ServingEndpointDetailed:
4136
4151
  creation_timestamp=d.get("creation_timestamp", None),
4137
4152
  creator=d.get("creator", None),
4138
4153
  data_plane_info=_from_dict(d, "data_plane_info", ModelDataPlaneInfo),
4154
+ description=d.get("description", None),
4139
4155
  endpoint_url=d.get("endpoint_url", None),
4140
4156
  id=d.get("id", None),
4141
4157
  last_updated_timestamp=d.get("last_updated_timestamp", None),
@@ -4489,9 +4505,7 @@ class ServingEndpointsAPI:
4489
4505
  raise TimeoutError(f"timed out after {timeout}: {status_message}")
4490
4506
 
4491
4507
  def build_logs(self, name: str, served_model_name: str) -> BuildLogsResponse:
4492
- """Get build logs for a served model.
4493
-
4494
- Retrieves the build logs associated with the provided served model.
4508
+ """Retrieves the build logs associated with the provided served model.
4495
4509
 
4496
4510
  :param name: str
4497
4511
  The name of the serving endpoint that the served model belongs to. This field is required.
@@ -4672,9 +4686,7 @@ class ServingEndpointsAPI:
4672
4686
  self._api.do("DELETE", f"/api/2.0/serving-endpoints/{name}", headers=headers)
4673
4687
 
4674
4688
  def export_metrics(self, name: str) -> ExportMetricsResponse:
4675
- """Get metrics of a serving endpoint.
4676
-
4677
- Retrieves the metrics associated with the provided serving endpoint in either Prometheus or
4689
+ """Retrieves the metrics associated with the provided serving endpoint in either Prometheus or
4678
4690
  OpenMetrics exposition format.
4679
4691
 
4680
4692
  :param name: str
@@ -4691,9 +4703,7 @@ class ServingEndpointsAPI:
4691
4703
  return ExportMetricsResponse.from_dict(res)
4692
4704
 
4693
4705
  def get(self, name: str) -> ServingEndpointDetailed:
4694
- """Get a single serving endpoint.
4695
-
4696
- Retrieves the details for a single serving endpoint.
4706
+ """Retrieves the details for a single serving endpoint.
4697
4707
 
4698
4708
  :param name: str
4699
4709
  The name of the serving endpoint. This field is required.
@@ -4709,9 +4719,7 @@ class ServingEndpointsAPI:
4709
4719
  return ServingEndpointDetailed.from_dict(res)
4710
4720
 
4711
4721
  def get_open_api(self, name: str) -> GetOpenApiResponse:
4712
- """Get the schema for a serving endpoint.
4713
-
4714
- Get the query schema of the serving endpoint in OpenAPI format. The schema contains information for
4722
+ """Get the query schema of the serving endpoint in OpenAPI format. The schema contains information for
4715
4723
  the supported paths, input and output format and datatypes.
4716
4724
 
4717
4725
  :param name: str
@@ -4728,9 +4736,7 @@ class ServingEndpointsAPI:
4728
4736
  return GetOpenApiResponse.from_dict(res)
4729
4737
 
4730
4738
  def get_permission_levels(self, serving_endpoint_id: str) -> GetServingEndpointPermissionLevelsResponse:
4731
- """Get serving endpoint permission levels.
4732
-
4733
- Gets the permission levels that a user can have on an object.
4739
+ """Gets the permission levels that a user can have on an object.
4734
4740
 
4735
4741
  :param serving_endpoint_id: str
4736
4742
  The serving endpoint for which to get or manage permissions.
@@ -4748,9 +4754,7 @@ class ServingEndpointsAPI:
4748
4754
  return GetServingEndpointPermissionLevelsResponse.from_dict(res)
4749
4755
 
4750
4756
  def get_permissions(self, serving_endpoint_id: str) -> ServingEndpointPermissions:
4751
- """Get serving endpoint permissions.
4752
-
4753
- Gets the permissions of a serving endpoint. Serving endpoints can inherit permissions from their root
4757
+ """Gets the permissions of a serving endpoint. Serving endpoints can inherit permissions from their root
4754
4758
  object.
4755
4759
 
4756
4760
  :param serving_endpoint_id: str
@@ -4830,9 +4834,7 @@ class ServingEndpointsAPI:
4830
4834
  return parsed if parsed is not None else []
4831
4835
 
4832
4836
  def logs(self, name: str, served_model_name: str) -> ServerLogsResponse:
4833
- """Get the latest logs for a served model.
4834
-
4835
- Retrieves the service logs associated with the provided served model.
4837
+ """Retrieves the service logs associated with the provided served model.
4836
4838
 
4837
4839
  :param name: str
4838
4840
  The name of the serving endpoint that the served model belongs to. This field is required.
@@ -4854,9 +4856,7 @@ class ServingEndpointsAPI:
4854
4856
  def patch(
4855
4857
  self, name: str, *, add_tags: Optional[List[EndpointTag]] = None, delete_tags: Optional[List[str]] = None
4856
4858
  ) -> EndpointTags:
4857
- """Update tags of a serving endpoint.
4858
-
4859
- Used to batch add and delete tags from a serving endpoint with a single API call.
4859
+ """Used to batch add and delete tags from a serving endpoint with a single API call.
4860
4860
 
4861
4861
  :param name: str
4862
4862
  The name of the serving endpoint who's tags to patch. This field is required.
@@ -4881,9 +4881,7 @@ class ServingEndpointsAPI:
4881
4881
  return EndpointTags.from_dict(res)
4882
4882
 
4883
4883
  def put(self, name: str, *, rate_limits: Optional[List[RateLimit]] = None) -> PutResponse:
4884
- """Update rate limits of a serving endpoint.
4885
-
4886
- Deprecated: Please use AI Gateway to manage rate limits instead.
4884
+ """Deprecated: Please use AI Gateway to manage rate limits instead.
4887
4885
 
4888
4886
  :param name: str
4889
4887
  The name of the serving endpoint whose rate limits are being updated. This field is required.
@@ -4913,9 +4911,7 @@ class ServingEndpointsAPI:
4913
4911
  rate_limits: Optional[List[AiGatewayRateLimit]] = None,
4914
4912
  usage_tracking_config: Optional[AiGatewayUsageTrackingConfig] = None,
4915
4913
  ) -> PutAiGatewayResponse:
4916
- """Update AI Gateway of a serving endpoint.
4917
-
4918
- Used to update the AI Gateway of a serving endpoint. NOTE: External model, provisioned throughput, and
4914
+ """Used to update the AI Gateway of a serving endpoint. NOTE: External model, provisioned throughput, and
4919
4915
  pay-per-token endpoints are fully supported; agent endpoints currently only support inference tables.
4920
4916
 
4921
4917
  :param name: str
@@ -5070,9 +5066,7 @@ class ServingEndpointsAPI:
5070
5066
  *,
5071
5067
  access_control_list: Optional[List[ServingEndpointAccessControlRequest]] = None,
5072
5068
  ) -> ServingEndpointPermissions:
5073
- """Set serving endpoint permissions.
5074
-
5075
- Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct
5069
+ """Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct
5076
5070
  permissions if none are specified. Objects can inherit permissions from their root object.
5077
5071
 
5078
5072
  :param serving_endpoint_id: str
@@ -5103,9 +5097,7 @@ class ServingEndpointsAPI:
5103
5097
  served_models: Optional[List[ServedModelInput]] = None,
5104
5098
  traffic_config: Optional[TrafficConfig] = None,
5105
5099
  ) -> Wait[ServingEndpointDetailed]:
5106
- """Update config of a serving endpoint.
5107
-
5108
- Updates any combination of the serving endpoint's served entities, the compute configuration of those
5100
+ """Updates any combination of the serving endpoint's served entities, the compute configuration of those
5109
5101
  served entities, and the endpoint's traffic config. An endpoint that already has an update in progress
5110
5102
  can not be updated until the current update completes or fails.
5111
5103
 
@@ -5173,9 +5165,7 @@ class ServingEndpointsAPI:
5173
5165
  *,
5174
5166
  access_control_list: Optional[List[ServingEndpointAccessControlRequest]] = None,
5175
5167
  ) -> ServingEndpointPermissions:
5176
- """Update serving endpoint permissions.
5177
-
5178
- Updates the permissions on a serving endpoint. Serving endpoints can inherit permissions from their
5168
+ """Updates the permissions on a serving endpoint. Serving endpoints can inherit permissions from their
5179
5169
  root object.
5180
5170
 
5181
5171
  :param serving_endpoint_id: str
@@ -5200,9 +5190,7 @@ class ServingEndpointsAPI:
5200
5190
  def update_provisioned_throughput_endpoint_config(
5201
5191
  self, name: str, config: PtEndpointCoreConfig
5202
5192
  ) -> Wait[ServingEndpointDetailed]:
5203
- """Update config of a PT serving endpoint.
5204
-
5205
- Updates any combination of the pt endpoint's served entities, the compute configuration of those
5193
+ """Updates any combination of the pt endpoint's served entities, the compute configuration of those
5206
5194
  served entities, and the endpoint's traffic config. Updates are instantaneous and endpoint should be
5207
5195
  updated instantly
5208
5196