Skip to content

Commit 70db788

Browse files
committed
update again
1 parent c18dc36 commit 70db788

File tree

15 files changed

+119
-28
lines changed

15 files changed

+119
-28
lines changed

.codegen.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515
],
1616
"post_generate": [
1717
"make fmt",
18-
"pytest -m 'not integration' --cov=databricks --cov-report html tests",
1918
"pip install .",
2019
"python3.12 docs/gen-client-docs.py"
2120
]

docs/account/provisioning/workspaces.rst

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
These endpoints are available if your account is on the E2 version of the platform or on a select custom
1212
plan that allows multiple workspaces per account.
1313

14-
.. py:method:: create( [, aws_region: Optional[str], cloud: Optional[str], cloud_resource_container: Optional[CloudResourceContainer], credentials_id: Optional[str], custom_tags: Optional[Dict[str, str]], deployment_name: Optional[str], gcp_managed_network_config: Optional[GcpManagedNetworkConfig], gke_config: Optional[GkeConfig], location: Optional[str], managed_services_customer_managed_key_id: Optional[str], network_id: Optional[str], pricing_tier: Optional[PricingTier], private_access_settings_id: Optional[str], storage_configuration_id: Optional[str], storage_customer_managed_key_id: Optional[str], workspace_name: Optional[str]]) -> Wait[Workspace]
14+
.. py:method:: create( [, aws_region: Optional[str], cloud: Optional[str], cloud_resource_container: Optional[CloudResourceContainer], compute_mode: Optional[CustomerFacingComputeMode], credentials_id: Optional[str], custom_tags: Optional[Dict[str, str]], deployment_name: Optional[str], gcp_managed_network_config: Optional[GcpManagedNetworkConfig], gke_config: Optional[GkeConfig], location: Optional[str], managed_services_customer_managed_key_id: Optional[str], network_id: Optional[str], pricing_tier: Optional[PricingTier], private_access_settings_id: Optional[str], storage_configuration_id: Optional[str], storage_customer_managed_key_id: Optional[str], workspace_name: Optional[str]]) -> Wait[Workspace]
1515
1616
1717
Usage:
@@ -84,6 +84,12 @@
8484
:param cloud: str (optional)
8585
The cloud name. This field always has the value `gcp`.
8686
:param cloud_resource_container: :class:`CloudResourceContainer` (optional)
87+
:param compute_mode: :class:`CustomerFacingComputeMode` (optional)
88+
If the compute mode is `SERVERLESS`, a serverless workspace is created that comes pre-configured
89+
with serverless compute and default storage, providing a fully-managed, enterprise-ready SaaS
90+
experience. This means you don't need to provide any resources managed by you, such as credentials,
91+
storage, or network. If the compute mode is `HYBRID` (which is the default option), a classic
92+
workspace is created that uses customer-managed resources.
8793
:param credentials_id: str (optional)
8894
ID of the workspace's credential configuration object.
8995
:param custom_tags: Dict[str,str] (optional)
@@ -141,7 +147,7 @@
141147
See :method:wait_get_workspace_running for more details.
142148

143149

144-
.. py:method:: create_and_wait( [, aws_region: Optional[str], cloud: Optional[str], cloud_resource_container: Optional[CloudResourceContainer], credentials_id: Optional[str], custom_tags: Optional[Dict[str, str]], deployment_name: Optional[str], gcp_managed_network_config: Optional[GcpManagedNetworkConfig], gke_config: Optional[GkeConfig], location: Optional[str], managed_services_customer_managed_key_id: Optional[str], network_id: Optional[str], pricing_tier: Optional[PricingTier], private_access_settings_id: Optional[str], storage_configuration_id: Optional[str], storage_customer_managed_key_id: Optional[str], workspace_name: Optional[str], timeout: datetime.timedelta = 0:20:00]) -> Workspace
150+
.. py:method:: create_and_wait( [, aws_region: Optional[str], cloud: Optional[str], cloud_resource_container: Optional[CloudResourceContainer], compute_mode: Optional[CustomerFacingComputeMode], credentials_id: Optional[str], custom_tags: Optional[Dict[str, str]], deployment_name: Optional[str], gcp_managed_network_config: Optional[GcpManagedNetworkConfig], gke_config: Optional[GkeConfig], location: Optional[str], managed_services_customer_managed_key_id: Optional[str], network_id: Optional[str], pricing_tier: Optional[PricingTier], private_access_settings_id: Optional[str], storage_configuration_id: Optional[str], storage_customer_managed_key_id: Optional[str], workspace_name: Optional[str], timeout: datetime.timedelta = 0:20:00]) -> Workspace
145151
146152
147153
.. py:method:: delete(workspace_id: int) -> Workspace

docs/dbdataclasses/settings.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ These dataclasses are used in the SDK to represent API requests and responses fo
123123

124124
.. py:class:: ComplianceStandard
125125
126-
Compliance stardard for SHIELD customers
126+
Compliance standard for SHIELD customers. See README.md for how instructions of how to add new standards.
127127

128128
.. py:attribute:: CANADA_PROTECTED_B
129129
:value: "CANADA_PROTECTED_B"
@@ -143,6 +143,9 @@ These dataclasses are used in the SDK to represent API requests and responses fo
143143
.. py:attribute:: GERMANY_C5
144144
:value: "GERMANY_C5"
145145

146+
.. py:attribute:: GERMANY_TISAX
147+
:value: "GERMANY_TISAX"
148+
146149
.. py:attribute:: HIPAA
147150
:value: "HIPAA"
148151

docs/workspace/catalog/catalogs.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,14 @@
118118
**USE_CATALOG** privilege) will be retrieved. There is no guarantee of a specific ordering of the
119119
elements in the array.
120120

121+
NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls
122+
will be deprecated soon.
123+
124+
PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while
125+
still providing a next_page_token. Clients must continue reading pages until next_page_token is
126+
absent, which is the only indication that the end of results has been reached. This behavior follows
127+
Google AIP-158 guidelines.
128+
121129
:param include_browse: bool (optional)
122130
Whether to include catalogs in the response for which the principal can only access selective
123131
metadata for

docs/workspace/catalog/connections.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,14 @@
135135
136136
List all connections.
137137

138+
NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls
139+
will be deprecated soon.
140+
141+
PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while
142+
still providing a next_page_token. Clients must continue reading pages until next_page_token is
143+
absent, which is the only indication that the end of results has been reached. This behavior follows
144+
Google AIP-158 guidelines.
145+
138146
:param max_results: int (optional)
139147
Maximum number of connections to return. - If not set, all connections are returned (not
140148
recommended). - when set to a value greater than 0, the page length is the minimum of this value and

docs/workspace/catalog/external_locations.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,14 @@
152152
must be a metastore admin, the owner of the external location, or a user that has some privilege on
153153
the external location. There is no guarantee of a specific ordering of the elements in the array.
154154

155+
NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls
156+
will be deprecated soon.
157+
158+
PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while
159+
still providing a next_page_token. Clients must continue reading pages until next_page_token is
160+
absent, which is the only indication that the end of results has been reached. This behavior follows
161+
Google AIP-158 guidelines.
162+
155163
:param include_browse: bool (optional)
156164
Whether to include external locations in the response for which the principal can only access
157165
selective metadata for

docs/workspace/catalog/functions.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,14 @@
7070
functions for which either the user has the **EXECUTE** privilege or the user is the owner. There is
7171
no guarantee of a specific ordering of the elements in the array.
7272

73+
NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls
74+
will be deprecated soon.
75+
76+
PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while
77+
still providing a next_page_token. Clients must continue reading pages until next_page_token is
78+
absent, which is the only indication that the end of results has been reached. This behavior follows
79+
Google AIP-158 guidelines.
80+
7381
:param catalog_name: str
7482
Name of parent catalog for functions of interest.
7583
:param schema_name: str

docs/workspace/catalog/metastores.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,14 @@
174174
Gets an array of the available metastores (as __MetastoreInfo__ objects). The caller must be an admin
175175
to retrieve this info. There is no guarantee of a specific ordering of the elements in the array.
176176

177+
NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls
178+
will be deprecated soon.
179+
180+
PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while
181+
still providing a next_page_token. Clients must continue reading pages until next_page_token is
182+
absent, which is the only indication that the end of results has been reached. This behavior follows
183+
Google AIP-158 guidelines.
184+
177185
:param max_results: int (optional)
178186
Maximum number of metastores to return. - when set to a value greater than 0, the page length is the
179187
minimum of this value and a server configured value; - when set to 0, the page length is set to a

docs/workspace/catalog/schemas.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,14 @@
120120
owned by the caller (or for which the caller has the **USE_SCHEMA** privilege) will be retrieved.
121121
There is no guarantee of a specific ordering of the elements in the array.
122122

123+
NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls
124+
will be deprecated soon.
125+
126+
PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while
127+
still providing a next_page_token. Clients must continue reading pages until next_page_token is
128+
absent, which is the only indication that the end of results has been reached. This behavior follows
129+
Google AIP-158 guidelines.
130+
123131
:param catalog_name: str
124132
Parent catalog for schemas of interest.
125133
:param include_browse: bool (optional)

docs/workspace/catalog/storage_credentials.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,14 @@
134134
admin, retrieval of credentials is unrestricted. There is no guarantee of a specific ordering of the
135135
elements in the array.
136136

137+
NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls
138+
will be deprecated soon.
139+
140+
PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while
141+
still providing a next_page_token. Clients must continue reading pages until next_page_token is
142+
absent, which is the only indication that the end of results has been reached. This behavior follows
143+
Google AIP-158 guidelines.
144+
137145
:param include_unbound: bool (optional)
138146
Whether to include credentials not bound to the workspace. Effective only if the user has permission
139147
to update the credential–workspace binding.

0 commit comments

Comments
 (0)