diff --git a/.codegen/_last_sha b/.codegen/_last_sha index d5de729c9..2a64ce6ad 100644 --- a/.codegen/_last_sha +++ b/.codegen/_last_sha @@ -1 +1 @@ -e13a7b6206adbdb6c4008e2a58b7cc785e32cb1c \ No newline at end of file +b4c5fc35beb5ed8fe8790b448b97238daef64520 \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index b684dd4e6..62fcded03 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,23 @@ # Version changelog +## Release v0.181.0 (2026-11-16) + +### API Changes +* Add `com.databricks.sdk.service.statementexecutionv2` package. +* Add `workspaceClient.statementExecutionV2()` service. +* Add `getAppDeploymentScanFinding()`, `listAppDeploymentScanFindings()` and `updateAppDeploymentScanFinding()` methods for `workspaceClient.apps()` service. +* Add `scanOmittedCountIsLowerBound`, `scanOmittedFindingsCount` and `scanStatus` fields for `com.databricks.sdk.service.apps.AppDeployment`. +* Add `imageUri` field for `com.databricks.sdk.service.compute.Environment`. +* Add `icebergTableSource` field for `com.databricks.sdk.service.ml.DataSource`. +* Add `testing` field for `com.databricks.sdk.service.pipelines.ClonePipelineRequest`. +* Add `testing` field for `com.databricks.sdk.service.pipelines.CreatePipeline`. +* Add `testing` field for `com.databricks.sdk.service.pipelines.EditPipeline`. +* Add `testing` field for `com.databricks.sdk.service.pipelines.PipelineSpec`. +* Add `testOnly` and `testOptions` fields for `com.databricks.sdk.service.pipelines.StartUpdate`. +* Add `testOnly` field for `com.databricks.sdk.service.pipelines.UpdateInfo`. +* Add `overwrite` field for `com.databricks.sdk.service.sandbox.UploadFileRequest`. +* Add `DAY` enum value for `com.databricks.sdk.service.billing.AlertConfigurationTimePeriod`. + ## Release v0.180.0 (2026-11-12) ### API Changes diff --git a/databricks-sdk-java/lockfile.json b/databricks-sdk-java/lockfile.json index 71f6c9359..c68144d0b 100644 --- a/databricks-sdk-java/lockfile.json +++ b/databricks-sdk-java/lockfile.json @@ -1,7 +1,7 @@ { "artifactId": "databricks-sdk-java", "groupId": "com.databricks", - "version": "0.180.0", + "version": "0.181.0", "lockFileVersion": 1, "dependencies": [ { diff --git a/databricks-sdk-java/pom.xml b/databricks-sdk-java/pom.xml index f9ad9bf38..138d6cfb1 100644 --- a/databricks-sdk-java/pom.xml +++ b/databricks-sdk-java/pom.xml @@ -5,7 +5,7 @@ com.databricks databricks-sdk-parent - 0.180.0 + 0.181.0 databricks-sdk-java Databricks SDK for Java diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/WorkspaceClient.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/WorkspaceClient.java index b4eadcc85..7abe4594f 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/WorkspaceClient.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/WorkspaceClient.java @@ -276,6 +276,8 @@ import com.databricks.sdk.service.sql.StatementExecutionService; import com.databricks.sdk.service.sql.WarehousesAPI; import com.databricks.sdk.service.sql.WarehousesService; +import com.databricks.sdk.service.statementexecutionv2.StatementExecutionV2API; +import com.databricks.sdk.service.statementexecutionv2.StatementExecutionV2Service; import com.databricks.sdk.service.supervisoragents.SupervisorAgentsAPI; import com.databricks.sdk.service.supervisoragents.SupervisorAgentsService; import com.databricks.sdk.service.tags.TagPoliciesAPI; @@ -420,6 +422,7 @@ public class WorkspaceClient { private SharesAPI sharesAPI; private SoftwareArtifactsAPI softwareArtifactsAPI; private StatementExecutionAPI statementExecutionAPI; + private StatementExecutionV2API statementExecutionV2API; private StorageCredentialsAPI storageCredentialsAPI; private SupervisorAgentsAPI supervisorAgentsAPI; private SystemSchemasAPI systemSchemasAPI; @@ -573,6 +576,7 @@ public WorkspaceClient(DatabricksConfig config) { sharesAPI = new SharesAPI(apiClient); softwareArtifactsAPI = new SoftwareArtifactsAPI(apiClient); statementExecutionAPI = new StatementExecutionAPI(apiClient); + statementExecutionV2API = new StatementExecutionV2API(apiClient); storageCredentialsAPI = new StorageCredentialsAPI(apiClient); supervisorAgentsAPI = new SupervisorAgentsAPI(apiClient); systemSchemasAPI = new SystemSchemasAPI(apiClient); @@ -1956,6 +1960,12 @@ public SoftwareArtifactsAPI softwareArtifacts() { * *

We suggest beginning with the [Databricks SQL Statement Execution API tutorial]. * + *

**Lakehouse//RT warehouses** + * + *

You can run statements on [Lakehouse//RT] warehouses with this API. For lower latency and + * higher concurrency, use version 2 of this API, Statement Execution (Lakehouse//RT), instead. It + * works the same way, except that `warehouse_id` is a path parameter. + * *

**Overview of statement execution and result fetching** * *

Statement execution begins by issuing a :method:statementexecution/executeStatement request @@ -2042,11 +2052,28 @@ public SoftwareArtifactsAPI softwareArtifacts() { * *

[Apache Arrow Columnar]: https://arrow.apache.org/overview/ [Databricks SQL Statement * Execution API tutorial]: https://docs.databricks.com/sql/api/sql-execution-tutorial.html + * [Lakehouse//RT]: https://docs.databricks.com/compute/sql-warehouse/real-time.html */ public StatementExecutionAPI statementExecution() { return statementExecutionAPI; } + /** + * The Statement Execution API v2 can be used to execute SQL statements on a SQL warehouse and + * fetch the result. It works the same as the Statement Execution API (v1), except that + * `warehouse_id` is a path parameter on every call, including polling, fetching result chunks, + * and canceling. Routing on the warehouse ID gives lower latency and higher concurrency. + * + *

Version 2 currently supports [Lakehouse//RT] warehouses only. For other warehouse types, use + * the Statement Execution API (v1). You can also run statements on Lakehouse//RT warehouses with + * version 1, but version 2 is optimized for them. + * + *

[Lakehouse//RT]: https://docs.databricks.com/compute/sql-warehouse/real-time.html + */ + public StatementExecutionV2API statementExecutionV2() { + return statementExecutionV2API; + } + /** * A storage credential represents an authentication and authorization mechanism for accessing * data stored on your cloud tenant. Each storage credential is subject to Unity Catalog @@ -3725,6 +3752,18 @@ public WorkspaceClient withStatementExecutionAPI(StatementExecutionAPI statement return this; } + /** Replace the default StatementExecutionV2Service with a custom implementation. */ + public WorkspaceClient withStatementExecutionV2Impl( + StatementExecutionV2Service statementExecutionV2) { + return this.withStatementExecutionV2API(new StatementExecutionV2API(statementExecutionV2)); + } + + /** Replace the default StatementExecutionV2API with a custom implementation. */ + public WorkspaceClient withStatementExecutionV2API(StatementExecutionV2API statementExecutionV2) { + this.statementExecutionV2API = statementExecutionV2; + return this; + } + /** Replace the default StorageCredentialsService with a custom implementation. */ public WorkspaceClient withStorageCredentialsImpl(StorageCredentialsService storageCredentials) { return this.withStorageCredentialsAPI(new StorageCredentialsAPI(storageCredentials)); diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/core/UserAgent.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/core/UserAgent.java index ab0a4957d..394ec8b4d 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/core/UserAgent.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/core/UserAgent.java @@ -36,7 +36,7 @@ public String getValue() { // TODO: check if reading from // /META-INF/maven/com.databricks/databrics-sdk-java/pom.properties // or getClass().getPackage().getImplementationVersion() is enough. - private static final String version = "0.180.0"; + private static final String version = "0.181.0"; public static void withProduct(String product, String productVersion) { UserAgent.product = product; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aifunctions/Batch.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aifunctions/Batch.java index 98033501d..3c1c6f027 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aifunctions/Batch.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aifunctions/Batch.java @@ -12,7 +12,8 @@ /** * The AI Functions Asynchronous API lets you process large volumes of requests as a batch in a - * single call. + * single call. It is in Beta: a workspace admin must turn on the **AI Functions Asynchronous API** + * preview on the workspace Previews page before you can call it. */ @Generated public class Batch { @@ -40,7 +41,9 @@ public class Batch { /** * Unity Catalog volume path to write the JSONL output file to. If the path is a directory, the - * file is `/_output.jsonl`. + * file is `/_output.jsonl`. Each line is the result of one request, in the form + * `{"custom_id": ..., "response": ...}`, or `{"custom_id": ..., "error": {"type": ..., "message": + * ...}}` for a request that failed. */ @JsonProperty("output_ref") private String outputRef; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/AiSearchAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/AiSearchAPI.java index cf64d580d..83256c56b 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/AiSearchAPI.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/AiSearchAPI.java @@ -32,7 +32,10 @@ public Endpoint createEndpoint(CreateEndpointRequest request) { return impl.createEndpoint(request); } - /** Create a new AI Search index. */ + /** + * Create a new AI Search index. The index is provisioned asynchronously; `status.ready` on + * GetIndex reports when it can serve queries. + */ public Index createIndex(CreateIndexRequest request) { return impl.createIndex(request); } @@ -127,8 +130,9 @@ public ScanIndexResponse scanIndex(ScanIndexRequest request) { } /** - * Synchronize a Delta Sync AI Search index with its source Delta table. Applies only to Delta - * Sync indexes; Direct Access indexes are written via the data-plane upsert path. + * Start a sync of a Delta Sync AI Search index with its source Delta table. Use it with + * `TRIGGERED` pipelines; `CONTINUOUS` pipelines sync automatically. Direct Access indexes are + * written through UpsertData instead. */ public SyncIndexResponse syncIndex(SyncIndexRequest request) { return impl.syncIndex(request); diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/AiSearchService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/AiSearchService.java index 3b5a9fc67..e2e3d1625 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/AiSearchService.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/AiSearchService.java @@ -16,7 +16,10 @@ public interface AiSearchService { /** Create a new AI Search endpoint. */ Endpoint createEndpoint(CreateEndpointRequest createEndpointRequest); - /** Create a new AI Search index. */ + /** + * Create a new AI Search index. The index is provisioned asynchronously; `status.ready` on + * GetIndex reports when it can serve queries. + */ Index createIndex(CreateIndexRequest createIndexRequest); /** Delete an AI Search endpoint. */ @@ -47,8 +50,9 @@ public interface AiSearchService { ScanIndexResponse scanIndex(ScanIndexRequest scanIndexRequest); /** - * Synchronize a Delta Sync AI Search index with its source Delta table. Applies only to Delta - * Sync indexes; Direct Access indexes are written via the data-plane upsert path. + * Start a sync of a Delta Sync AI Search index with its source Delta table. Use it with + * `TRIGGERED` pipelines; `CONTINUOUS` pipelines sync automatically. Direct Access indexes are + * written through UpsertData instead. */ SyncIndexResponse syncIndex(SyncIndexRequest syncIndexRequest); diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/CreateIndexRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/CreateIndexRequest.java index cdd2273ad..a2b6a2943 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/CreateIndexRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/CreateIndexRequest.java @@ -19,10 +19,9 @@ public class CreateIndexRequest { private Index index; /** - * The user-supplied Unity Catalog table name for the Index, per AIP-133. The server composes the - * full `Index.name` as `{parent}/indexes/{index_id}`. AIP-133 does not list `index_id` as a - * fields-may-be-required entry, so we annotate it OPTIONAL on the wire; the server still rejects - * empty values with INVALID_PARAMETER_VALUE. + * Three-level Unity Catalog table name for the new index, in the form `catalog.schema.name`. The + * server composes the full `Index.name` as `{parent}/indexes/{index_id}` and rejects an empty + * value. */ @JsonIgnore @QueryParam("index_id") diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/DeltaSyncIndexSpec.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/DeltaSyncIndexSpec.java index 37a4b9ed7..3abf03f23 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/DeltaSyncIndexSpec.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/DeltaSyncIndexSpec.java @@ -12,22 +12,32 @@ @Generated public class DeltaSyncIndexSpec { /** - * [Optional] Select the columns to sync with the index. If left blank, all columns from the - * source table are synced. The primary key column and embedding source or vector column are - * always synced. + * Columns of the source table to include in the index. When empty, all columns are synced. The + * primary key and the embedding source or vector column are always synced. Only synced columns + * can be returned in query results or used in filters. */ @JsonProperty("columns_to_sync") private Collection columnsToSync; - /** The columns that contain the embedding source. */ + /** + * Columns whose text Databricks embeds during sync, using the model endpoint named on each + * column. Set either this field or `embedding_vector_columns`, not both. + */ @JsonProperty("embedding_source_columns") private Collection embeddingSourceColumns; - /** The columns that contain the embedding vectors. */ + /** + * Columns of the source table that already hold precomputed embedding vectors. Set either this + * field or `embedding_source_columns`, not both. + */ @JsonProperty("embedding_vector_columns") private Collection embeddingVectorColumns; - /** [Optional] Name of the Delta table to sync the index contents and computed embeddings to. */ + /** + * Three-level name of a Delta table to write the synced rows and computed embeddings to. It + * applies only when embeddings are computed from `embedding_source_columns`, and the table must + * not already exist. + */ @JsonProperty("embedding_writeback_table") private String embeddingWritebackTable; @@ -36,16 +46,16 @@ public class DeltaSyncIndexSpec { private String pipelineId; /** - * Pipeline execution mode. Required on create — the backend rejects an unset value. Storage - * Optimized endpoints accept only `TRIGGERED`; Standard endpoints accept both. No explicit - * `stage` — a REQUIRED field staged below its service would be dropped from combined specs while - * remaining in `required`, tripping the OpenAPI required-vs-properties consistency check. The - * field inherits the service's launch stage. + * Sync mode of the pipeline that keeps the index up to date. `TRIGGERED` syncs at creation and + * then each time SyncIndex is called; `CONTINUOUS` processes source changes as they arrive. + * Storage Optimized endpoints accept only `TRIGGERED`, and an unset value is rejected. */ @JsonProperty("pipeline_type") private PipelineType pipelineType; - /** The full name of the source Delta table. */ + /** + * Three-level Unity Catalog name of the source Delta table, in the form `catalog.schema.table`. + */ @JsonProperty("source_table") private String sourceTable; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/DirectAccessIndexSpec.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/DirectAccessIndexSpec.java index 6905223ea..1599bda00 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/DirectAccessIndexSpec.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/DirectAccessIndexSpec.java @@ -11,18 +11,25 @@ /** Specification for a Direct Access index — the customer manages vectors and metadata directly. */ @Generated public class DirectAccessIndexSpec { - /** The columns that contain the embedding source. */ + /** + * Columns that contain the text to embed, each with the model endpoint that computes its + * embeddings. + */ @JsonProperty("embedding_source_columns") private Collection embeddingSourceColumns; - /** The columns that contain the embedding vectors. */ + /** + * Columns that hold precomputed embedding vectors. A single vector column is supported, and it + * cannot be the primary key. + */ @JsonProperty("embedding_vector_columns") private Collection embeddingVectorColumns; /** - * The schema of the index in JSON format. Supported types are `integer`, `long`, `float`, - * `double`, `boolean`, `string`, `date`, `timestamp`. Supported types for vector columns: - * `array`, `array`. + * The schema of the index in JSON format, mapping each column name to its type. Supported types + * are `integer`, `long`, `float`, `double`, `boolean`, `string`, `date`, `timestamp`. Supported + * types for vector columns: `array`, `array`. The schema must include the primary + * key column and the embedding vector column. */ @JsonProperty("schema_json") private String schemaJson; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/EmbeddingSourceColumn.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/EmbeddingSourceColumn.java index d71103c11..fb9a9edca 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/EmbeddingSourceColumn.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/EmbeddingSourceColumn.java @@ -20,7 +20,7 @@ public class EmbeddingSourceColumn { @JsonProperty("model_endpoint_name_for_query") private String modelEndpointNameForQuery; - /** Name of the source column. */ + /** Name of the column whose text is embedded. */ @JsonProperty("name") private String name; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/EmbeddingVectorColumn.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/EmbeddingVectorColumn.java index 5b31d1fed..6eedb1f96 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/EmbeddingVectorColumn.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/EmbeddingVectorColumn.java @@ -10,11 +10,11 @@ /** Name and dimension of an embedding vector column. */ @Generated public class EmbeddingVectorColumn { - /** Dimension of the embedding vector. */ + /** Number of elements in each embedding vector. It must be positive. */ @JsonProperty("embedding_dimension") private Long embeddingDimension; - /** Name of the column. */ + /** Name of the column that holds the precomputed embedding vectors. */ @JsonProperty("name") private String name; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/Index.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/Index.java index f05f12cb5..9b89c4546 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/Index.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/Index.java @@ -33,11 +33,19 @@ public class Index { @JsonProperty("endpoint") private String endpoint; - /** The subtype of the index. Set on create and immutable thereafter. */ + /** + * Subtype of the index. Use `HYBRID` for vector and hybrid search, or `FULL_TEXT` for + * keyword-only search without embeddings; `VECTOR` is not a supported create value. Set on create + * and immutable thereafter. + */ @JsonProperty("index_subtype") private IndexSubtype indexSubtype; - /** Type of index. Required on create and immutable thereafter. */ + /** + * Type of index. A `DELTA_SYNC` index is kept in sync with a source Delta table; a + * `DIRECT_ACCESS` index holds rows that you write through UpsertData and RemoveData. Set on + * create and immutable thereafter. + */ @JsonProperty("index_type") private IndexType indexType; @@ -51,7 +59,11 @@ public class Index { @JsonProperty("name") private String name; - /** Primary key of the index. Set on create and immutable thereafter. */ + /** + * Name of the column that uniquely identifies each row. It must exist in the source table (Delta + * Sync) or in `schema_json` (Direct Access) and cannot be the embedding source or vector column. + * Set on create and immutable thereafter. + */ @JsonProperty("primary_key") private String primaryKey; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/IndexStatus.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/IndexStatus.java index 3202d3222..2a497ab41 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/IndexStatus.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/IndexStatus.java @@ -25,7 +25,10 @@ public class IndexStatus { @JsonProperty("message") private String message; - /** Whether the index is ready for search. */ + /** + * Whether the index is ready to serve queries. After CreateIndex, poll GetIndex until this is + * true; `message` describes the current state in the meantime. + */ @JsonProperty("ready") private Boolean ready; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/ListIndexesRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/ListIndexesRequest.java index 2409ed7b1..25fcb5561 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/ListIndexesRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/ListIndexesRequest.java @@ -10,11 +10,7 @@ @Generated public class ListIndexesRequest { - /** - * Best-effort upper bound on the number of results to return. Honored as an upper bound by the - * shim: `page_size` only narrows the legacy backend's response, never widens it, so the practical - * cap is `min(page_size, legacy_fixed_page_size)`. - */ + /** Maximum number of indexes to return. When unset, every index on the endpoint is returned. */ @JsonIgnore @QueryParam("page_size") private Long pageSize; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/QueryIndexRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/QueryIndexRequest.java index c04c3586e..2b58637e3 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/QueryIndexRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/QueryIndexRequest.java @@ -16,7 +16,9 @@ */ @Generated public class QueryIndexRequest { - /** Column names to include in each result row. */ + /** + * Columns to include in each result row. Only columns that are part of the index can be returned. + */ @JsonProperty("columns") private Collection columns; @@ -28,13 +30,19 @@ public class QueryIndexRequest { @JsonProperty("facets") private Collection facets; - /** JSON string describing query filters (e.g. `{"id >": 5}`). */ + /** + * JSON object of filters to apply, serialized as a string. Each key is a column name with an + * optional operator suffix such as `<`, `>=`, `NOT`, or `OR`, and each value is the value to + * compare against. Only columns that are part of the index can be filtered. See + * https://docs.databricks.com/aws/en/ai-search/query-ai-search#filters for the supported + * operators. + */ @JsonProperty("filters_json") private String filtersJson; /** - * Maximum number of results to return (the legacy `num_results`). Defaults to 10. Prefer - * `page_size`; when both are set, `page_size` takes precedence. + * Maximum number of results to return. Defaults to 10. It corresponds to `num_results` in the + * Vector Search API. */ @JsonProperty("max_results") private Long maxResults; @@ -49,11 +57,17 @@ public class QueryIndexRequest { @JsonProperty("query_columns") private Collection queryColumns; - /** Query text. Required for Delta Sync indexes that compute embeddings from a model endpoint. */ + /** + * Query text. Required for Delta Sync indexes that compute embeddings from a model endpoint, and + * for `HYBRID` and `FULL_TEXT` queries. + */ @JsonProperty("query_text") private String queryText; - /** Query type: `ANN`, `HYBRID`, or `FULL_TEXT`. Defaults to `ANN`. */ + /** + * Query type: `ANN` for vector similarity search, `HYBRID` for combined vector and keyword + * search, or `FULL_TEXT` for keyword search without embeddings. Defaults to `ANN`. + */ @JsonProperty("query_type") private String queryType; @@ -64,11 +78,17 @@ public class QueryIndexRequest { @JsonProperty("query_vector") private Collection queryVector; - /** If set, results are reranked before being returned. */ + /** + * If set, results are reranked before being returned. See + * https://docs.databricks.com/aws/en/ai-search/query-ai-search#rerank for details. + */ @JsonProperty("reranker") private RerankerConfig reranker; - /** Score threshold for the approximate nearest-neighbor search. Defaults to 0.0. */ + /** + * Score threshold for the approximate nearest-neighbor search; results that score below it are + * not returned. Defaults to 0.0. + */ @JsonProperty("score_threshold") private Double scoreThreshold; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/RemoveDataResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/RemoveDataResponse.java index 6a23a1bf3..55ead4120 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/RemoveDataResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/RemoveDataResponse.java @@ -14,7 +14,10 @@ public class RemoveDataResponse { @JsonProperty("result") private DataModificationResult result; - /** Overall status of the delete. */ + /** + * Overall status of the delete: `SUCCESS` when every row was removed, `PARTIAL_SUCCESS` when some + * rows failed (see `result.failed_primary_keys`), or `FAILURE` when the operation failed. + */ @JsonProperty("status") private DataModificationStatus status; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/ScanIndexRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/ScanIndexRequest.java index 40f12c709..941a779c1 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/ScanIndexRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/ScanIndexRequest.java @@ -20,7 +20,7 @@ public class ScanIndexRequest { */ @JsonIgnore private String name; - /** Maximum number of rows to return in this page. */ + /** Maximum number of rows to return in this page. Defaults to 10. */ @JsonProperty("page_size") private Long pageSize; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/ScanIndexResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/ScanIndexResponse.java index 48cc06ac3..bd98c5e61 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/ScanIndexResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/ScanIndexResponse.java @@ -13,7 +13,10 @@ /** Response for ScanIndex carrying a page of rows and an optional continuation token. */ @Generated public class ScanIndexResponse { - /** The rows in this page, each a struct of column name to value. */ + /** + * Rows in this page, ordered by primary key. Each row is a JSON object that maps column names to + * values. + */ @JsonProperty("data") private Collection> data; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/UpsertDataRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/UpsertDataRequest.java index 69e4840a4..55d2e6286 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/UpsertDataRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/UpsertDataRequest.java @@ -11,7 +11,12 @@ /** Request to upsert rows into a Direct Access AI Search index. */ @Generated public class UpsertDataRequest { - /** JSON document describing the rows to upsert. */ + /** + * JSON array of the rows to insert or update, serialized as a string. Each element is an object + * that maps column names to values and must include the primary key column; vector columns are + * given as arrays of numbers. A row whose primary key already exists is overwritten. The array + * must not be empty. + */ @JsonProperty("inputs_json") private String inputsJson; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/UpsertDataResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/UpsertDataResponse.java index 5728986b1..296977b8f 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/UpsertDataResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/aisearch/UpsertDataResponse.java @@ -14,7 +14,10 @@ public class UpsertDataResponse { @JsonProperty("result") private DataModificationResult result; - /** Overall status of the upsert. */ + /** + * Overall status of the upsert: `SUCCESS` when every row was written, `PARTIAL_SUCCESS` when some + * rows failed (see `result.failed_primary_keys`), or `FAILURE` when the operation failed. + */ @JsonProperty("status") private DataModificationStatus status; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/App.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/App.java index 26a1b3497..306b9c885 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/App.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/App.java @@ -8,6 +8,11 @@ import java.util.Collection; import java.util.Objects; +/** + * An app that runs on Databricks Apps. The app runs on managed compute in the workspace and is + * deployed from a workspace folder or a Git repository. Each app acts as its own dedicated service + * principal. + */ @Generated public class App { /** @@ -17,11 +22,15 @@ public class App { @JsonProperty("active_deployment") private AppDeployment activeDeployment; - /** */ + /** Status of the application process on the app compute, as reported by the app runtime. */ @JsonProperty("app_status") private ApplicationStatus appStatus; - /** */ + /** + * ID of the serverless budget policy that the app's compute usage is attributed to. Budget + * policies and usage policies are alternatives: set at most one of `budget_policy_id` and + * `usage_policy_id`. + */ @JsonProperty("budget_policy_id") private String budgetPolicyId; @@ -39,15 +48,19 @@ public class App { @JsonProperty("compute_min_instances") private Long computeMinInstances; - /** */ + /** + * Size of the compute instances the app runs on. Defaults to MEDIUM. Larger sizes provide more + * CPU and memory at a higher hourly cost. See + * https://docs.databricks.com/aws/en/dev-tools/databricks-apps/compute-size. + */ @JsonProperty("compute_size") private ComputeSize computeSize; - /** */ + /** Status of the compute that runs the app. */ @JsonProperty("compute_status") private ComputeStatus computeStatus; - /** The creation time of the app. Formatted timestamp in ISO 6801. */ + /** The creation time of the app. Formatted timestamp in ISO 8601. */ @JsonProperty("create_time") private String createTime; @@ -74,7 +87,7 @@ public class App { @JsonProperty("description") private String description; - /** */ + /** ID of the budget policy in effect for the app, after Databricks applies any defaults. */ @JsonProperty("effective_budget_policy_id") private String effectiveBudgetPolicyId; @@ -85,7 +98,7 @@ public class App { @JsonProperty("effective_resources") private Collection effectiveResources; - /** */ + /** ID of the usage policy in effect for the app, after Databricks applies any defaults. */ @JsonProperty("effective_usage_policy_id") private String effectiveUsagePolicyId; @@ -125,11 +138,11 @@ public class App { @JsonProperty("name") private String name; - /** */ + /** OAuth client ID of the app integration that signs in the app's users. */ @JsonProperty("oauth2_app_client_id") private String oauth2AppClientId; - /** */ + /** ID of the OAuth app integration that Databricks creates for the app to sign in its users. */ @JsonProperty("oauth2_app_integration_id") private String oauth2AppIntegrationId; @@ -140,23 +153,37 @@ public class App { @JsonProperty("pending_deployment") private AppDeployment pendingDeployment; - /** Resources for the app. */ + /** + * Databricks resources the app depends on. Each entry grants the app's service principal the + * listed permission on one resource and makes that resource available to the app under the + * entry's name. + */ @JsonProperty("resources") private Collection resources; - /** */ + /** + * OAuth client ID of the app's service principal. The app runtime exposes it to the app as the + * DATABRICKS_CLIENT_ID environment variable. + */ @JsonProperty("service_principal_client_id") private String servicePrincipalClientId; - /** */ + /** + * Numeric ID of the service principal the app runs as. Databricks creates a dedicated service + * principal for each app and deletes it with the app. Apps in some older spaces run as the + * space's shared service principal instead. + */ @JsonProperty("service_principal_id") private Long servicePrincipalId; - /** */ + /** Display name of the app's service principal. */ @JsonProperty("service_principal_name") private String servicePrincipalName; - /** */ + /** + * Workspace file system path of the app source code. On create, the app is deployed from this + * path. Alternative to `git_source`. + */ @JsonProperty("source_code_path") private String sourceCodePath; @@ -164,7 +191,10 @@ public class App { @JsonProperty("space") private String space; - /** */ + /** + * Destinations that receive the app's OpenTelemetry logs, metrics and traces. Changes take effect + * when the app is next deployed. + */ @JsonProperty("telemetry_export_destinations") private Collection telemetryExportDestinations; @@ -172,7 +202,7 @@ public class App { @JsonProperty("thumbnail_url") private String thumbnailUrl; - /** The update time of the app. Formatted timestamp in ISO 6801. */ + /** The update time of the app. Formatted timestamp in ISO 8601. */ @JsonProperty("update_time") private String updateTime; @@ -184,11 +214,20 @@ public class App { @JsonProperty("url") private String url; - /** */ + /** + * ID of the usage policy that the app's compute usage is attributed to. Alternative to + * `budget_policy_id`. + */ @JsonProperty("usage_policy_id") private String usagePolicyId; - /** */ + /** + * API scopes the app requests for user authorization. The user access token that Databricks + * forwards to the app is limited to these scopes plus the default identity scopes, so the app can + * act on the user's behalf only within them. Workspace admins can restrict which scopes apps in + * the workspace may request. See + * https://docs.databricks.com/aws/en/dev-tools/databricks-apps/auth. + */ @JsonProperty("user_api_scopes") private Collection userApiScopes; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppDeployment.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppDeployment.java index 6d7f57511..6f0084d02 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppDeployment.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppDeployment.java @@ -55,6 +55,28 @@ public class AppDeployment { @JsonProperty("mode") private AppDeploymentMode mode; + /** + * Whether `scan_omitted_findings_count` is a lower bound rather than an exact count, because the + * scanner itself stopped counting. + */ + @JsonProperty("scan_omitted_count_is_lower_bound") + private Boolean scanOmittedCountIsLowerBound; + + /** + * The number of findings the scan reported but did not store, because the deployment hit the + * per-deployment findings cap. Non-zero means the listed findings are incomplete. + */ + @JsonProperty("scan_omitted_findings_count") + private Long scanOmittedFindingsCount; + + /** + * The security scan outcome for this deployment. UNSPECIFIED means no scan result has been + * recorded: the scan may still be in flight, or it ended without recording one, so don't wait + * indefinitely for it to change. The other values are terminal. + */ + @JsonProperty("scan_status") + private AppDeploymentScanStatus scanStatus; + /** * The workspace file system path of the source code used to create the app deployment. This is * different from `deployment_artifacts.source_code_path`, which is the path used by the deployed @@ -154,6 +176,33 @@ public AppDeploymentMode getMode() { return mode; } + public AppDeployment setScanOmittedCountIsLowerBound(Boolean scanOmittedCountIsLowerBound) { + this.scanOmittedCountIsLowerBound = scanOmittedCountIsLowerBound; + return this; + } + + public Boolean getScanOmittedCountIsLowerBound() { + return scanOmittedCountIsLowerBound; + } + + public AppDeployment setScanOmittedFindingsCount(Long scanOmittedFindingsCount) { + this.scanOmittedFindingsCount = scanOmittedFindingsCount; + return this; + } + + public Long getScanOmittedFindingsCount() { + return scanOmittedFindingsCount; + } + + public AppDeployment setScanStatus(AppDeploymentScanStatus scanStatus) { + this.scanStatus = scanStatus; + return this; + } + + public AppDeploymentScanStatus getScanStatus() { + return scanStatus; + } + public AppDeployment setSourceCodePath(String sourceCodePath) { this.sourceCodePath = sourceCodePath; return this; @@ -195,6 +244,9 @@ public boolean equals(Object o) { && Objects.equals(gitSource, that.gitSource) && Objects.equals(healthCheck, that.healthCheck) && Objects.equals(mode, that.mode) + && Objects.equals(scanOmittedCountIsLowerBound, that.scanOmittedCountIsLowerBound) + && Objects.equals(scanOmittedFindingsCount, that.scanOmittedFindingsCount) + && Objects.equals(scanStatus, that.scanStatus) && Objects.equals(sourceCodePath, that.sourceCodePath) && Objects.equals(status, that.status) && Objects.equals(updateTime, that.updateTime); @@ -212,6 +264,9 @@ public int hashCode() { gitSource, healthCheck, mode, + scanOmittedCountIsLowerBound, + scanOmittedFindingsCount, + scanStatus, sourceCodePath, status, updateTime); @@ -229,6 +284,9 @@ public String toString() { .add("gitSource", gitSource) .add("healthCheck", healthCheck) .add("mode", mode) + .add("scanOmittedCountIsLowerBound", scanOmittedCountIsLowerBound) + .add("scanOmittedFindingsCount", scanOmittedFindingsCount) + .add("scanStatus", scanStatus) .add("sourceCodePath", sourceCodePath) .add("status", status) .add("updateTime", updateTime) diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppDeploymentScanFinding.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppDeploymentScanFinding.java new file mode 100644 index 000000000..aa4b41fe5 --- /dev/null +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppDeploymentScanFinding.java @@ -0,0 +1,179 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. + +package com.databricks.sdk.service.apps; + +import com.databricks.sdk.support.Generated; +import com.databricks.sdk.support.ToStringer; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.Objects; + +/** + * A single security scan finding for an app deployment. Findings are produced when a deployment's + * source code is scanned, and their triage `status` is preserved across re-scans of the same + * deployment. + */ +@Generated +public class AppDeploymentScanFinding { + /** The app-relative path of the file the finding was reported in. */ + @JsonProperty("file_path") + private String filePath; + + /** + * The stable id of the finding (the last segment of `name`), derived from the rule, file, and + * line so the same issue keeps its triage status across re-scans. + */ + @JsonProperty("finding_id") + private String findingId; + + /** The line number the finding was reported at. */ + @JsonProperty("line") + private Long line; + + /** A human-readable description of the finding. */ + @JsonProperty("message") + private String message; + + /** + * The resource name of the finding, in the form + * `apps/{app}/deployments/{deployment}/scanFindings/{finding_id}`. + */ + @JsonProperty("name") + private String name; + + /** The scanner rule that produced the finding. */ + @JsonProperty("rule_id") + private String ruleId; + + /** The scanner that produced the finding. */ + @JsonProperty("scanner_type") + private ScanFindingScannerType scannerType; + + /** The severity reported by the scanner. */ + @JsonProperty("severity") + private ScanFindingSeverity severity; + + /** + * The triage status of the finding. This is the only client-writable field; set it to resolve or + * ignore a finding. + */ + @JsonProperty("status") + private ScanFindingStatus status; + + public AppDeploymentScanFinding setFilePath(String filePath) { + this.filePath = filePath; + return this; + } + + public String getFilePath() { + return filePath; + } + + public AppDeploymentScanFinding setFindingId(String findingId) { + this.findingId = findingId; + return this; + } + + public String getFindingId() { + return findingId; + } + + public AppDeploymentScanFinding setLine(Long line) { + this.line = line; + return this; + } + + public Long getLine() { + return line; + } + + public AppDeploymentScanFinding setMessage(String message) { + this.message = message; + return this; + } + + public String getMessage() { + return message; + } + + public AppDeploymentScanFinding setName(String name) { + this.name = name; + return this; + } + + public String getName() { + return name; + } + + public AppDeploymentScanFinding setRuleId(String ruleId) { + this.ruleId = ruleId; + return this; + } + + public String getRuleId() { + return ruleId; + } + + public AppDeploymentScanFinding setScannerType(ScanFindingScannerType scannerType) { + this.scannerType = scannerType; + return this; + } + + public ScanFindingScannerType getScannerType() { + return scannerType; + } + + public AppDeploymentScanFinding setSeverity(ScanFindingSeverity severity) { + this.severity = severity; + return this; + } + + public ScanFindingSeverity getSeverity() { + return severity; + } + + public AppDeploymentScanFinding setStatus(ScanFindingStatus status) { + this.status = status; + return this; + } + + public ScanFindingStatus getStatus() { + return status; + } + + @Override + public boolean equals(Object o) { + if (this == o) return true; + if (o == null || getClass() != o.getClass()) return false; + AppDeploymentScanFinding that = (AppDeploymentScanFinding) o; + return Objects.equals(filePath, that.filePath) + && Objects.equals(findingId, that.findingId) + && Objects.equals(line, that.line) + && Objects.equals(message, that.message) + && Objects.equals(name, that.name) + && Objects.equals(ruleId, that.ruleId) + && Objects.equals(scannerType, that.scannerType) + && Objects.equals(severity, that.severity) + && Objects.equals(status, that.status); + } + + @Override + public int hashCode() { + return Objects.hash( + filePath, findingId, line, message, name, ruleId, scannerType, severity, status); + } + + @Override + public String toString() { + return new ToStringer(AppDeploymentScanFinding.class) + .add("filePath", filePath) + .add("findingId", findingId) + .add("line", line) + .add("message", message) + .add("name", name) + .add("ruleId", ruleId) + .add("scannerType", scannerType) + .add("severity", severity) + .add("status", status) + .toString(); + } +} diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppDeploymentScanStatus.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppDeploymentScanStatus.java new file mode 100644 index 000000000..cbd234db5 --- /dev/null +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppDeploymentScanStatus.java @@ -0,0 +1,15 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. + +package com.databricks.sdk.service.apps; + +import com.databricks.sdk.support.Generated; + +/** The security scan outcome for an app deployment, mirrored from the durable scan record. */ +@Generated +public enum AppDeploymentScanStatus { + APP_DEPLOYMENT_SCAN_STATUS_CLEAN, + APP_DEPLOYMENT_SCAN_STATUS_FINDINGS, + APP_DEPLOYMENT_SCAN_STATUS_NOT_SCANNED, + APP_DEPLOYMENT_SCAN_STATUS_PARTIAL, + APP_DEPLOYMENT_SCAN_STATUS_UNAVAILABLE, +} diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppResource.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppResource.java index f2dffc5ae..5de87500e 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppResource.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppResource.java @@ -9,11 +9,11 @@ @Generated public class AppResource { - /** */ + /** Another app in the workspace that this app is granted access to. */ @JsonProperty("app") private AppResourceApp app; - /** */ + /** Lakebase Provisioned database the app is granted access to. */ @JsonProperty("database") private AppResourceDatabase database; @@ -21,39 +21,45 @@ public class AppResource { @JsonProperty("description") private String description; - /** */ + /** MLflow experiment the app is granted access to. */ @JsonProperty("experiment") private AppResourceExperiment experiment; - /** */ + /** Genie space the app is granted access to. */ @JsonProperty("genie_space") private AppResourceGenieSpace genieSpace; - /** */ + /** Lakeflow job the app is granted access to. */ @JsonProperty("job") private AppResourceJob job; - /** Name of the App Resource. */ + /** + * Key that identifies the resource within the app. The app configuration (app.yaml) references + * the resource by this key. + */ @JsonProperty("name") private String name; - /** */ + /** Lakebase Autoscaling Postgres database the app is granted access to. */ @JsonProperty("postgres") private AppResourcePostgres postgres; - /** */ + /** Secret the app is granted access to. */ @JsonProperty("secret") private AppResourceSecret secret; - /** */ + /** Model serving endpoint the app is granted access to. */ @JsonProperty("serving_endpoint") private AppResourceServingEndpoint servingEndpoint; - /** */ + /** SQL warehouse the app is granted access to. */ @JsonProperty("sql_warehouse") private AppResourceSqlWarehouse sqlWarehouse; - /** */ + /** + * Unity Catalog securable (volume, table, function, connection or model service) the app is + * granted a privilege on. + */ @JsonProperty("uc_securable") private AppResourceUcSecurable ucSecurable; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppResourceApp.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppResourceApp.java index 94f288a2d..6681adae8 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppResourceApp.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppResourceApp.java @@ -9,11 +9,11 @@ @Generated public class AppResourceApp { - /** */ + /** Name of the app to grant access to. */ @JsonProperty("name") private String name; - /** */ + /** Permission to grant on that app. */ @JsonProperty("permission") private AppResourceAppAppPermission permission; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppResourceDatabase.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppResourceDatabase.java index 971241179..2dbf53e0f 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppResourceDatabase.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppResourceDatabase.java @@ -9,15 +9,15 @@ @Generated public class AppResourceDatabase { - /** */ + /** Name of the database within the instance. */ @JsonProperty("database_name") private String databaseName; - /** */ + /** Name of the Lakebase database instance. */ @JsonProperty("instance_name") private String instanceName; - /** */ + /** Permission to grant the app on the database. */ @JsonProperty("permission") private AppResourceDatabaseDatabasePermission permission; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppResourceExperiment.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppResourceExperiment.java index 6f194ec5c..f746e28e9 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppResourceExperiment.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppResourceExperiment.java @@ -9,11 +9,11 @@ @Generated public class AppResourceExperiment { - /** */ + /** ID of the MLflow experiment. */ @JsonProperty("experiment_id") private String experimentId; - /** */ + /** Permission to grant the app on the experiment. */ @JsonProperty("permission") private AppResourceExperimentExperimentPermission permission; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppResourceGenieSpace.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppResourceGenieSpace.java index 00045cdbd..4f06b8eba 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppResourceGenieSpace.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppResourceGenieSpace.java @@ -13,11 +13,11 @@ public class AppResourceGenieSpace { @JsonProperty("name") private String name; - /** */ + /** Permission to grant the app on the Genie space. */ @JsonProperty("permission") private AppResourceGenieSpaceGenieSpacePermission permission; - /** */ + /** ID of the Genie space. */ @JsonProperty("space_id") private String spaceId; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppResourcePostgres.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppResourcePostgres.java index f16acb6a7..16a96fbc5 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppResourcePostgres.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppResourcePostgres.java @@ -9,15 +9,21 @@ @Generated public class AppResourcePostgres { - /** */ + /** + * Resource name of the Lakebase Autoscaling branch, in the form + * `projects/{project}/branches/{branch}`. + */ @JsonProperty("branch") private String branch; - /** */ + /** + * Resource name of the database within the branch, in the form + * `projects/{project}/branches/{branch}/databases/{database}`. + */ @JsonProperty("database") private String database; - /** */ + /** Permission to grant the app on the database. */ @JsonProperty("permission") private AppResourcePostgresPostgresPermission permission; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppResourceUcSecurable.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppResourceUcSecurable.java index 59d35fde3..b3090a403 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppResourceUcSecurable.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppResourceUcSecurable.java @@ -9,11 +9,17 @@ @Generated public class AppResourceUcSecurable { - /** */ + /** + * Privilege to grant the app on the securable. The privilege must be valid for the securable + * type, such as READ_VOLUME for a volume or SELECT for a table. + */ @JsonProperty("permission") private AppResourceUcSecurableUcSecurablePermission permission; - /** */ + /** + * Full name of the Unity Catalog securable. For volumes, tables and functions this is the + * three-level catalog.schema.object name. + */ @JsonProperty("securable_full_name") private String securableFullName; @@ -24,7 +30,7 @@ public class AppResourceUcSecurable { @JsonProperty("securable_kind") private String securableKind; - /** */ + /** Kind of Unity Catalog securable that `securable_full_name` refers to. */ @JsonProperty("securable_type") private AppResourceUcSecurableUcSecurableType securableType; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppUpdate.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppUpdate.java index 59ed5d36a..1d4e8cf16 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppUpdate.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppUpdate.java @@ -8,9 +8,13 @@ import java.util.Collection; import java.util.Objects; +/** + * Progress of an app update started by AsyncUpdateApp, together with the values the update + * requested. + */ @Generated public class AppUpdate { - /** */ + /** Budget policy ID requested by the update. */ @JsonProperty("budget_policy_id") private String budgetPolicyId; @@ -28,11 +32,11 @@ public class AppUpdate { @JsonProperty("compute_min_instances") private Long computeMinInstances; - /** */ + /** Compute size requested by the update. */ @JsonProperty("compute_size") private ComputeSize computeSize; - /** */ + /** Description requested by the update. */ @JsonProperty("description") private String description; @@ -43,27 +47,27 @@ public class AppUpdate { @JsonProperty("forward_user_access_token") private Boolean forwardUserAccessToken; - /** */ + /** Git repository configuration requested by the update. */ @JsonProperty("git_repository") private GitRepository gitRepository; - /** */ + /** Resources requested by the update. */ @JsonProperty("resources") private Collection resources; - /** */ + /** Progress of the update. */ @JsonProperty("status") private AppUpdateUpdateStatus status; - /** */ + /** Telemetry export destinations requested by the update. */ @JsonProperty("telemetry_export_destinations") private Collection telemetryExportDestinations; - /** */ + /** Usage policy ID requested by the update. */ @JsonProperty("usage_policy_id") private String usagePolicyId; - /** */ + /** User API scopes requested by the update. */ @JsonProperty("user_api_scopes") private Collection userApiScopes; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppUpdateUpdateStatus.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppUpdateUpdateStatus.java index d666a314b..1d2110bf3 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppUpdateUpdateStatus.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppUpdateUpdateStatus.java @@ -9,11 +9,11 @@ @Generated public class AppUpdateUpdateStatus { - /** */ + /** Human-readable detail about the update state. */ @JsonProperty("message") private String message; - /** */ + /** State of the update. */ @JsonProperty("state") private AppUpdateUpdateStatusUpdateState state; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/ApplicationStatus.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/ApplicationStatus.java index ca64de094..1bef716a3 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/ApplicationStatus.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/ApplicationStatus.java @@ -9,7 +9,7 @@ @Generated public class ApplicationStatus { - /** Application status message */ + /** Human-readable detail about the application state. */ @JsonProperty("message") private String message; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppsAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppsAPI.java index 0f309a656..bdf761073 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppsAPI.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppsAPI.java @@ -256,7 +256,7 @@ public App delete(String name) { return delete(new DeleteAppRequest().setName(name)); } - /** Deletes an app. */ + /** Deletes an app and the dedicated service principal created for it. */ public App delete(DeleteAppRequest request) { return impl.delete(request); } @@ -299,6 +299,16 @@ public App get(GetAppRequest request) { return impl.get(request); } + public AppDeploymentScanFinding getAppDeploymentScanFinding(String name) { + return getAppDeploymentScanFinding(new GetAppDeploymentScanFindingRequest().setName(name)); + } + + /** Retrieves a single security scan finding for an app deployment. */ + public AppDeploymentScanFinding getAppDeploymentScanFinding( + GetAppDeploymentScanFindingRequest request) { + return impl.getAppDeploymentScanFinding(request); + } + public AppDeployment getDeployment(String appName, String deploymentId) { return getDeployment( new GetAppDeploymentRequest().setAppName(appName).setDeploymentId(deploymentId)); @@ -369,6 +379,27 @@ public Iterable list(ListAppsRequest request) { }); } + public Iterable listAppDeploymentScanFindings(String parent) { + return listAppDeploymentScanFindings( + new ListAppDeploymentScanFindingsRequest().setParent(parent)); + } + + /** Lists the security scan findings for an app deployment. */ + public Iterable listAppDeploymentScanFindings( + ListAppDeploymentScanFindingsRequest request) { + return Paginator.newTokenPagination( + request, + impl::listAppDeploymentScanFindings, + ListAppDeploymentScanFindingsResponse::getAppDeploymentScanFindings, + response -> { + String token = response.getNextPageToken(); + if (token == null || token.isEmpty()) { + return null; + } + return request.setPageToken(token); + }); + } + public Iterable listDeployments(String appName) { return listDeployments(new ListAppDeploymentsRequest().setAppName(appName)); } @@ -433,6 +464,12 @@ public App update(UpdateAppRequest request) { return impl.update(request); } + /** Updates the triage status (resolved / ignored / in-progress) of a single scan finding. */ + public AppDeploymentScanFinding updateAppDeploymentScanFinding( + UpdateAppDeploymentScanFindingRequest request) { + return impl.updateAppDeploymentScanFinding(request); + } + /** Updates the thumbnail for an app. */ public AppThumbnail updateAppThumbnail(UpdateAppThumbnailRequest request) { return impl.updateAppThumbnail(request); diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppsImpl.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppsImpl.java index 5226267d2..08391d354 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppsImpl.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppsImpl.java @@ -156,6 +156,24 @@ public App get(GetAppRequest request) { } } + @Override + public AppDeploymentScanFinding getAppDeploymentScanFinding( + GetAppDeploymentScanFindingRequest request) { + String path = String.format("/api/2.0/%s", request.getName()); + try { + Request req = new Request("GET", path); + + ApiClient.setQuery(req, request); + req.withHeader("Accept", "application/json"); + if (apiClient.workspaceId() != null) { + req.withHeader("X-Databricks-Workspace-Id", apiClient.workspaceId()); + } + return apiClient.execute(req, AppDeploymentScanFinding.class); + } catch (IOException e) { + throw new DatabricksException("IO error: " + e.getMessage(), e); + } + } + @Override public AppDeployment getDeployment(GetAppDeploymentRequest request) { String path = @@ -278,6 +296,24 @@ public ListAppsResponse list(ListAppsRequest request) { } } + @Override + public ListAppDeploymentScanFindingsResponse listAppDeploymentScanFindings( + ListAppDeploymentScanFindingsRequest request) { + String path = String.format("/api/2.0/%s/scanFindings", request.getParent()); + try { + Request req = new Request("GET", path); + + ApiClient.setQuery(req, request); + req.withHeader("Accept", "application/json"); + if (apiClient.workspaceId() != null) { + req.withHeader("X-Databricks-Workspace-Id", apiClient.workspaceId()); + } + return apiClient.execute(req, ListAppDeploymentScanFindingsResponse.class); + } catch (IOException e) { + throw new DatabricksException("IO error: " + e.getMessage(), e); + } + } + @Override public ListAppDeploymentsResponse listDeployments(ListAppDeploymentsRequest request) { String path = String.format("/api/2.0/apps/%s/deployments", request.getAppName()); @@ -384,6 +420,26 @@ public App update(UpdateAppRequest request) { } } + @Override + public AppDeploymentScanFinding updateAppDeploymentScanFinding( + UpdateAppDeploymentScanFindingRequest request) { + String path = String.format("/api/2.0/%s", request.getName()); + try { + Request req = + new Request("PATCH", path, apiClient.serialize(request.getAppDeploymentScanFinding())); + + ApiClient.setQuery(req, request); + req.withHeader("Accept", "application/json"); + req.withHeader("Content-Type", "application/json"); + if (apiClient.workspaceId() != null) { + req.withHeader("X-Databricks-Workspace-Id", apiClient.workspaceId()); + } + return apiClient.execute(req, AppDeploymentScanFinding.class); + } catch (IOException e) { + throw new DatabricksException("IO error: " + e.getMessage(), e); + } + } + @Override public AppThumbnail updateAppThumbnail(UpdateAppThumbnailRequest request) { String path = String.format("/api/2.0/apps/%s/thumbnail", request.getName()); diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppsService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppsService.java index c6984c6d6..90ee29ba3 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppsService.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AppsService.java @@ -25,7 +25,7 @@ public interface AppsService { */ AppUpdate createUpdate(AsyncUpdateAppRequest asyncUpdateAppRequest); - /** Deletes an app. */ + /** Deletes an app and the dedicated service principal created for it. */ App delete(DeleteAppRequest deleteAppRequest); /** Deletes the thumbnail for an app. */ @@ -40,6 +40,10 @@ public interface AppsService { /** Retrieves information for the app with the supplied name. */ App get(GetAppRequest getAppRequest); + /** Retrieves a single security scan finding for an app deployment. */ + AppDeploymentScanFinding getAppDeploymentScanFinding( + GetAppDeploymentScanFindingRequest getAppDeploymentScanFindingRequest); + /** Retrieves information for the app deployment with the supplied name and deployment id. */ AppDeployment getDeployment(GetAppDeploymentRequest getAppDeploymentRequest); @@ -62,6 +66,10 @@ GetAppPermissionLevelsResponse getPermissionLevels( /** Lists all apps in the workspace. */ ListAppsResponse list(ListAppsRequest listAppsRequest); + /** Lists the security scan findings for an app deployment. */ + ListAppDeploymentScanFindingsResponse listAppDeploymentScanFindings( + ListAppDeploymentScanFindingsRequest listAppDeploymentScanFindingsRequest); + /** Lists all app deployments for the app with the supplied name. */ ListAppDeploymentsResponse listDeployments(ListAppDeploymentsRequest listAppDeploymentsRequest); @@ -86,6 +94,10 @@ GetAppPermissionLevelsResponse getPermissionLevels( */ App update(UpdateAppRequest updateAppRequest); + /** Updates the triage status (resolved / ignored / in-progress) of a single scan finding. */ + AppDeploymentScanFinding updateAppDeploymentScanFinding( + UpdateAppDeploymentScanFindingRequest updateAppDeploymentScanFindingRequest); + /** Updates the thumbnail for an app. */ AppThumbnail updateAppThumbnail(UpdateAppThumbnailRequest updateAppThumbnailRequest); diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AsyncUpdateAppRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AsyncUpdateAppRequest.java index 136f919eb..57394c2f0 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AsyncUpdateAppRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/AsyncUpdateAppRequest.java @@ -10,19 +10,26 @@ @Generated public class AsyncUpdateAppRequest { - /** */ + /** + * The new values for the app. Only the fields named in `update_mask` are applied; the others must + * still be valid. + */ @JsonProperty("app") private App app; - /** */ + /** The name of the app to update. */ @JsonIgnore private String appName; /** - * The field mask must be a single string, with multiple fields separated by commas (no spaces). - * The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields - * (e.g., `author.given_name`). Specification of elements in sequence or map fields is not - * allowed, as only the entire collection field can be specified. Field names must exactly match - * the resource field names. + * Comma-separated names of the `app` fields to update, such as `description` or `resources`. A + * field named in the mask but absent from `app` is cleared, except `compute_size`, which resets + * to `MEDIUM`. + * + *

The field mask must be a single string, with multiple fields separated by commas (no + * spaces). The field path is relative to the resource object, using a dot (`.`) to navigate + * sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is + * not allowed, as only the entire collection field can be specified. Field names must exactly + * match the resource field names. * *

A field mask of `*` indicates full replacement. It’s recommended to always explicitly list * the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/ComputeStatus.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/ComputeStatus.java index 64a0a658c..27e0cfdf8 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/ComputeStatus.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/ComputeStatus.java @@ -13,7 +13,7 @@ public class ComputeStatus { @JsonProperty("active_instances") private Long activeInstances; - /** Compute status message */ + /** Human-readable detail about the compute state. */ @JsonProperty("message") private String message; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/GetAppDeploymentScanFindingRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/GetAppDeploymentScanFindingRequest.java new file mode 100644 index 000000000..2a0d1f68e --- /dev/null +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/GetAppDeploymentScanFindingRequest.java @@ -0,0 +1,44 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. + +package com.databricks.sdk.service.apps; + +import com.databricks.sdk.support.Generated; +import com.databricks.sdk.support.ToStringer; +import com.fasterxml.jackson.annotation.JsonIgnore; +import java.util.Objects; + +@Generated +public class GetAppDeploymentScanFindingRequest { + /** + * The resource name of the finding, in the form + * `apps/{app}/deployments/{deployment}/scanFindings/{finding_id}`. + */ + @JsonIgnore private String name; + + public GetAppDeploymentScanFindingRequest setName(String name) { + this.name = name; + return this; + } + + public String getName() { + return name; + } + + @Override + public boolean equals(Object o) { + if (this == o) return true; + if (o == null || getClass() != o.getClass()) return false; + GetAppDeploymentScanFindingRequest that = (GetAppDeploymentScanFindingRequest) o; + return Objects.equals(name, that.name); + } + + @Override + public int hashCode() { + return Objects.hash(name); + } + + @Override + public String toString() { + return new ToStringer(GetAppDeploymentScanFindingRequest.class).add("name", name).toString(); + } +} diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/ListAppDeploymentScanFindingsRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/ListAppDeploymentScanFindingsRequest.java new file mode 100644 index 000000000..3c253ee94 --- /dev/null +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/ListAppDeploymentScanFindingsRequest.java @@ -0,0 +1,79 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. + +package com.databricks.sdk.service.apps; + +import com.databricks.sdk.support.Generated; +import com.databricks.sdk.support.QueryParam; +import com.databricks.sdk.support.ToStringer; +import com.fasterxml.jackson.annotation.JsonIgnore; +import java.util.Objects; + +@Generated +public class ListAppDeploymentScanFindingsRequest { + /** Upper bound for the number of findings returned. */ + @JsonIgnore + @QueryParam("page_size") + private Long pageSize; + + /** Pagination token to request the next page. Requests the first page if absent. */ + @JsonIgnore + @QueryParam("page_token") + private String pageToken; + + /** + * The parent deployment whose findings to list, in the form + * `apps/{app}/deployments/{deployment}`. + */ + @JsonIgnore private String parent; + + public ListAppDeploymentScanFindingsRequest setPageSize(Long pageSize) { + this.pageSize = pageSize; + return this; + } + + public Long getPageSize() { + return pageSize; + } + + public ListAppDeploymentScanFindingsRequest setPageToken(String pageToken) { + this.pageToken = pageToken; + return this; + } + + public String getPageToken() { + return pageToken; + } + + public ListAppDeploymentScanFindingsRequest setParent(String parent) { + this.parent = parent; + return this; + } + + public String getParent() { + return parent; + } + + @Override + public boolean equals(Object o) { + if (this == o) return true; + if (o == null || getClass() != o.getClass()) return false; + ListAppDeploymentScanFindingsRequest that = (ListAppDeploymentScanFindingsRequest) o; + return Objects.equals(pageSize, that.pageSize) + && Objects.equals(pageToken, that.pageToken) + && Objects.equals(parent, that.parent); + } + + @Override + public int hashCode() { + return Objects.hash(pageSize, pageToken, parent); + } + + @Override + public String toString() { + return new ToStringer(ListAppDeploymentScanFindingsRequest.class) + .add("pageSize", pageSize) + .add("pageToken", pageToken) + .add("parent", parent) + .toString(); + } +} diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/ListAppDeploymentScanFindingsResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/ListAppDeploymentScanFindingsResponse.java new file mode 100644 index 000000000..7f4e02535 --- /dev/null +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/ListAppDeploymentScanFindingsResponse.java @@ -0,0 +1,62 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. + +package com.databricks.sdk.service.apps; + +import com.databricks.sdk.support.Generated; +import com.databricks.sdk.support.ToStringer; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.Collection; +import java.util.Objects; + +/** Response message for ListAppDeploymentScanFindings. */ +@Generated +public class ListAppDeploymentScanFindingsResponse { + /** The scan findings for the deployment. */ + @JsonProperty("app_deployment_scan_findings") + private Collection appDeploymentScanFindings; + + /** Pagination token to request the next page of findings. */ + @JsonProperty("next_page_token") + private String nextPageToken; + + public ListAppDeploymentScanFindingsResponse setAppDeploymentScanFindings( + Collection appDeploymentScanFindings) { + this.appDeploymentScanFindings = appDeploymentScanFindings; + return this; + } + + public Collection getAppDeploymentScanFindings() { + return appDeploymentScanFindings; + } + + public ListAppDeploymentScanFindingsResponse setNextPageToken(String nextPageToken) { + this.nextPageToken = nextPageToken; + return this; + } + + public String getNextPageToken() { + return nextPageToken; + } + + @Override + public boolean equals(Object o) { + if (this == o) return true; + if (o == null || getClass() != o.getClass()) return false; + ListAppDeploymentScanFindingsResponse that = (ListAppDeploymentScanFindingsResponse) o; + return Objects.equals(appDeploymentScanFindings, that.appDeploymentScanFindings) + && Objects.equals(nextPageToken, that.nextPageToken); + } + + @Override + public int hashCode() { + return Objects.hash(appDeploymentScanFindings, nextPageToken); + } + + @Override + public String toString() { + return new ToStringer(ListAppDeploymentScanFindingsResponse.class) + .add("appDeploymentScanFindings", appDeploymentScanFindings) + .add("nextPageToken", nextPageToken) + .toString(); + } +} diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/ScanFindingScannerType.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/ScanFindingScannerType.java new file mode 100644 index 000000000..489847110 --- /dev/null +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/ScanFindingScannerType.java @@ -0,0 +1,11 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. + +package com.databricks.sdk.service.apps; + +import com.databricks.sdk.support.Generated; + +/** The scanner that produced a finding. */ +@Generated +public enum ScanFindingScannerType { + SCAN_FINDING_SCANNER_TYPE_SEMGREP, +} diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/ScanFindingSeverity.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/ScanFindingSeverity.java new file mode 100644 index 000000000..1e70382f4 --- /dev/null +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/ScanFindingSeverity.java @@ -0,0 +1,13 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. + +package com.databricks.sdk.service.apps; + +import com.databricks.sdk.support.Generated; + +/** Severity of a scan finding, as reported by the scanner. */ +@Generated +public enum ScanFindingSeverity { + SCAN_FINDING_SEVERITY_ERROR, + SCAN_FINDING_SEVERITY_INFO, + SCAN_FINDING_SEVERITY_WARNING, +} diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/ScanFindingStatus.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/ScanFindingStatus.java new file mode 100644 index 000000000..c1e1a53aa --- /dev/null +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/ScanFindingStatus.java @@ -0,0 +1,13 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. + +package com.databricks.sdk.service.apps; + +import com.databricks.sdk.support.Generated; + +/** User triage state for a single scan finding. */ +@Generated +public enum ScanFindingStatus { + SCAN_FINDING_STATUS_IGNORED, + SCAN_FINDING_STATUS_IN_PROGRESS, + SCAN_FINDING_STATUS_RESOLVED, +} diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/TelemetryExportDestination.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/TelemetryExportDestination.java index 962a7b3bb..4efa09aab 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/TelemetryExportDestination.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/TelemetryExportDestination.java @@ -10,7 +10,7 @@ /** A single telemetry export destination with its configuration and status. */ @Generated public class TelemetryExportDestination { - /** */ + /** Unity Catalog tables that receive the telemetry. */ @JsonProperty("unity_catalog") private UnityCatalog unityCatalog; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/UnityCatalog.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/UnityCatalog.java index 314f79b04..0e2d5bdd7 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/UnityCatalog.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/UnityCatalog.java @@ -10,15 +10,24 @@ /** Unity Catalog Destinations for OTEL telemetry export. */ @Generated public class UnityCatalog { - /** Unity Catalog table for OTEL logs. */ + /** + * Three-level name of the Unity Catalog table that receives OpenTelemetry logs. The table is + * created if it does not exist. + */ @JsonProperty("logs_table") private String logsTable; - /** Unity Catalog table for OTEL metrics. */ + /** + * Three-level name of the Unity Catalog table that receives OpenTelemetry metrics. The table is + * created if it does not exist. + */ @JsonProperty("metrics_table") private String metricsTable; - /** Unity Catalog table for OTEL traces (spans). */ + /** + * Three-level name of the Unity Catalog table that receives OpenTelemetry traces (spans). The + * table is created if it does not exist. + */ @JsonProperty("traces_table") private String tracesTable; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/UpdateAppDeploymentScanFindingRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/UpdateAppDeploymentScanFindingRequest.java new file mode 100644 index 000000000..e5a572e50 --- /dev/null +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/apps/UpdateAppDeploymentScanFindingRequest.java @@ -0,0 +1,81 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. + +package com.databricks.sdk.service.apps; + +import com.databricks.sdk.support.Generated; +import com.databricks.sdk.support.QueryParam; +import com.databricks.sdk.support.ToStringer; +import com.fasterxml.jackson.annotation.JsonIgnore; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.google.protobuf.FieldMask; +import java.util.Objects; + +@Generated +public class UpdateAppDeploymentScanFindingRequest { + /** The finding to update. `name` identifies the finding and `status` is the new triage status. */ + @JsonProperty("app_deployment_scan_finding") + private AppDeploymentScanFinding appDeploymentScanFinding; + + /** + * The resource name of the finding, in the form + * `apps/{app}/deployments/{deployment}/scanFindings/{finding_id}`. + */ + @JsonIgnore private String name; + + /** The fields to update. Must be exactly `status`, the only updatable field on a scan finding. */ + @JsonIgnore + @QueryParam("update_mask") + private FieldMask updateMask; + + public UpdateAppDeploymentScanFindingRequest setAppDeploymentScanFinding( + AppDeploymentScanFinding appDeploymentScanFinding) { + this.appDeploymentScanFinding = appDeploymentScanFinding; + return this; + } + + public AppDeploymentScanFinding getAppDeploymentScanFinding() { + return appDeploymentScanFinding; + } + + public UpdateAppDeploymentScanFindingRequest setName(String name) { + this.name = name; + return this; + } + + public String getName() { + return name; + } + + public UpdateAppDeploymentScanFindingRequest setUpdateMask(FieldMask updateMask) { + this.updateMask = updateMask; + return this; + } + + public FieldMask getUpdateMask() { + return updateMask; + } + + @Override + public boolean equals(Object o) { + if (this == o) return true; + if (o == null || getClass() != o.getClass()) return false; + UpdateAppDeploymentScanFindingRequest that = (UpdateAppDeploymentScanFindingRequest) o; + return Objects.equals(appDeploymentScanFinding, that.appDeploymentScanFinding) + && Objects.equals(name, that.name) + && Objects.equals(updateMask, that.updateMask); + } + + @Override + public int hashCode() { + return Objects.hash(appDeploymentScanFinding, name, updateMask); + } + + @Override + public String toString() { + return new ToStringer(UpdateAppDeploymentScanFindingRequest.class) + .add("appDeploymentScanFinding", appDeploymentScanFinding) + .add("name", name) + .add("updateMask", updateMask) + .toString(); + } +} diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/AlertConfigurationTimePeriod.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/AlertConfigurationTimePeriod.java index b2fadadc8..b35635b21 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/AlertConfigurationTimePeriod.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/AlertConfigurationTimePeriod.java @@ -6,5 +6,6 @@ @Generated public enum AlertConfigurationTimePeriod { + DAY, MONTH, } diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/AccessRequestDestinations.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/AccessRequestDestinations.java index bb3858506..ac8bc16c5 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/AccessRequestDestinations.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/AccessRequestDestinations.java @@ -8,6 +8,11 @@ import java.util.Collection; import java.util.Objects; +/** + * The notification destinations that receive access requests for a Unity Catalog securable. A + * securable without destinations of its own uses its owner's email when default owner email + * destinations are on; otherwise it inherits the destinations of its nearest parent that has any. + */ @Generated public class AccessRequestDestinations { /** @@ -29,10 +34,7 @@ public class AccessRequestDestinations { @JsonProperty("destinations") private Collection destinations; - /** - * The full name of the securable. Redundant with the name in the securable object, but necessary - * for Terraform integration - */ + /** The full name of the securable, repeated from **securable**. */ @JsonProperty("full_name") private String fullName; @@ -40,10 +42,7 @@ public class AccessRequestDestinations { @JsonProperty("securable") private Securable securable; - /** - * The type of the securable. Redundant with the type in the securable object, but necessary for - * Terraform integration - */ + /** The type of the securable, repeated from **securable** as a plain string. */ @JsonProperty("securable_type") private String securableType; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/AwsSqsQueue.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/AwsSqsQueue.java index 03fece6f9..94a4998ba 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/AwsSqsQueue.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/AwsSqsQueue.java @@ -14,7 +14,7 @@ public class AwsSqsQueue { private String managedResourceId; /** - * The AQS queue url in the format https://sqs.{region}.amazonaws.com/{account id}/{queue name}. + * The SQS queue URL in the format `https://sqs.{region}.amazonaws.com/{account id}/{queue name}`. * Only required for provided_sqs. */ @JsonProperty("queue_url") diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/AzureQueueStorage.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/AzureQueueStorage.java index c07b5e105..140d0805e 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/AzureQueueStorage.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/AzureQueueStorage.java @@ -14,8 +14,8 @@ public class AzureQueueStorage { private String managedResourceId; /** - * The AQS queue url in the format https://{storage account}.queue.core.windows.net/{queue name} - * Only required for provided_aqs. + * The AQS queue URL in the format `https://{storage account}.queue.core.windows.net/{queue + * name}`. Only required for provided_aqs. */ @JsonProperty("queue_url") private String queueUrl; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/BatchCreateAccessRequestsResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/BatchCreateAccessRequestsResponse.java index 5f0d00228..1d46a1dc5 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/BatchCreateAccessRequestsResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/BatchCreateAccessRequestsResponse.java @@ -8,6 +8,7 @@ import java.util.Collection; import java.util.Objects; +/** The access request destinations resolved for each principal and securable in the batch. */ @Generated public class BatchCreateAccessRequestsResponse { /** The access request destinations for each securable object the principal requested. */ diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CatalogInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CatalogInfo.java index d5a55616a..90454df73 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CatalogInfo.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CatalogInfo.java @@ -8,6 +8,12 @@ import java.util.Map; import java.util.Objects; +/** + * A catalog is the first layer of Unity Catalog's three-level namespace and groups the schemas, + * tables, volumes, and other data assets under it. Catalogs created through this API are standard + * catalogs, Delta Sharing catalogs created from a share, or foreign catalogs that mirror a database + * behind a connection to an external data source. + */ @Generated public class CatalogInfo { /** @@ -17,7 +23,12 @@ public class CatalogInfo { @JsonProperty("browse_only") private Boolean browseOnly; - /** */ + /** + * The server sets the catalog type from the create request. Catalogs created through this API are + * MANAGED_CATALOG (standard catalogs), DELTASHARING_CATALOG when created from a share with + * provider_name and share_name, or FOREIGN_CATALOG when created from a connection with + * connection_name. The remaining types are provisioned by Databricks. + */ @JsonProperty("catalog_type") private CatalogType catalogType; @@ -25,7 +36,12 @@ public class CatalogInfo { @JsonProperty("comment") private String comment; - /** The name of the connection to an external data source. */ + /** + * Naming a connection to an external data source creates a foreign catalog that mirrors a + * database in that source, which requires ownership of or the CREATE FOREIGN CATALOG privilege on + * the connection. Connection-specific settings, such as the database to mirror, go in options. + * The connection cannot be changed after creation. + */ @JsonProperty("connection_name") private String connectionName; @@ -37,15 +53,28 @@ public class CatalogInfo { @JsonProperty("created_by") private String createdBy; - /** Custom maximum retention period in hours for the catalog */ + /** + * Dropped objects in the catalog remain recoverable for this number of hours before they are + * permanently purged. The value applies to standard catalogs only, must be 0 or within the range + * allowed for the metastore, and is inherited by schemas and tables that do not set their own + * value. + */ @JsonProperty("custom_max_retention_hours") private Long customMaxRetentionHours; - /** */ + /** + * Indicates the predictive optimization setting that is in effect for the catalog once inherited + * values are resolved. + */ @JsonProperty("effective_predictive_optimization_flag") private EffectivePredictiveOptimizationFlag effectivePredictiveOptimizationFlag; - /** Whether predictive optimization should be enabled for this object and objects under it. */ + /** + * Whether predictive optimization is enabled for this catalog and the objects under it. Valid + * values are ENABLE, DISABLE, and INHERIT, where INHERIT applies the account-level setting. + * Standard catalogs start as INHERIT and other catalog types as DISABLE. It cannot be set when + * creating a catalog; use the update method instead. + */ @JsonProperty("enable_predictive_optimization") private EnablePredictiveOptimization enablePredictiveOptimization; @@ -54,13 +83,20 @@ public class CatalogInfo { private String fullName; /** - * Whether the current securable is accessible from all workspaces or a specific set of - * workspaces. + * Whether the catalog is accessible from all workspaces attached to the metastore (OPEN) or only + * from the workspaces bound to it (ISOLATED). It cannot be set when creating a catalog; change it + * with the update method and manage the bound workspaces with the workspace bindings API. See + * [Workspace-catalog binding]. + * + *

[Workspace-catalog binding]: https://docs.databricks.com/aws/en/catalogs/binding */ @JsonProperty("isolation_mode") private CatalogIsolationMode isolationMode; - /** Control CMK encryption for managed catalog data */ + /** + * Customer-managed key (CMK) settings control the encryption at rest of the catalog's managed + * data. + */ @JsonProperty("managed_encryption_settings") private EncryptionSettings managedEncryptionSettings; @@ -68,7 +104,10 @@ public class CatalogInfo { @JsonProperty("metastore_id") private String metastoreId; - /** Name of catalog. */ + /** + * The name of the catalog is stored in lowercase, can be at most 255 characters long, and cannot + * contain periods, spaces, forward slashes, or control characters. + */ @JsonProperty("name") private String name; @@ -85,31 +124,44 @@ public class CatalogInfo { private Map properties; /** - * The name of delta sharing provider. - * - *

A Delta Sharing catalog is a catalog that is based on a Delta share on a remote sharing - * server. + * The Delta Sharing provider that owns the share must be named here, together with share_name, to + * create a Delta Sharing catalog that exposes the data of the share on a remote sharing server. + * The provider cannot be changed after creation. */ @JsonProperty("provider_name") private String providerName; - /** */ + /** + * Indicates the provisioning status of the catalog. It is present only for catalogs that are + * provisioned asynchronously. + */ @JsonProperty("provisioning_info") private ProvisioningInfo provisioningInfo; - /** */ + /** The securable type is always CATALOG for a catalog. */ @JsonProperty("securable_type") private SecurableType securableType; - /** The name of the share under the share provider. */ + /** + * The share under the Delta Sharing provider must be named here, together with provider_name, to + * create a Delta Sharing catalog. The share cannot be changed after creation. + */ @JsonProperty("share_name") private String shareName; - /** Storage Location URL (full path) for managed tables within catalog. */ + /** + * The server derives this full storage location URL for managed tables and volumes within the + * catalog from storage_root and the catalog ID. + */ @JsonProperty("storage_location") private String storageLocation; - /** Storage root URL for managed tables within catalog. */ + /** + * Managed tables and volumes in the catalog are stored under this storage root URL. The path must + * be inside an external location on which the caller has the CREATE MANAGED STORAGE privilege. If + * omitted, managed data is stored under the metastore's root storage location, which must then be + * configured. Delta Sharing catalogs cannot have a storage root. + */ @JsonProperty("storage_root") private String storageRoot; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ColumnRelationship.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ColumnRelationship.java index f08281b4c..3468ab328 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ColumnRelationship.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ColumnRelationship.java @@ -7,13 +7,14 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.util.Objects; +/** Mapping from a column of the source object to a column of the target object. */ @Generated public class ColumnRelationship { - /** */ + /** Name of the column in the source object. */ @JsonProperty("source") private String source; - /** */ + /** Name of the column in the target object. */ @JsonProperty("target") private String target; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateAccountsStorageCredential.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateAccountsStorageCredential.java index 8e636a900..691ac9220 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateAccountsStorageCredential.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateAccountsStorageCredential.java @@ -7,6 +7,12 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.util.Objects; +/** + * A storage credential represents an authentication and authorization mechanism for accessing data + * stored on your cloud tenant. It holds exactly one cloud credential, for example an AWS IAM role, + * an Azure managed identity or service principal, or a GCP service account. Only the field for the + * selected credential type is set in requests and responses. + */ @Generated public class CreateAccountsStorageCredential { /** The AWS IAM role configuration. */ diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateCatalog.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateCatalog.java index c866e1215..91558c279 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateCatalog.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateCatalog.java @@ -14,19 +14,35 @@ public class CreateCatalog { @JsonProperty("comment") private String comment; - /** The name of the connection to an external data source. */ + /** + * Naming a connection to an external data source creates a foreign catalog that mirrors a + * database in that source, which requires ownership of or the CREATE FOREIGN CATALOG privilege on + * the connection. Connection-specific settings, such as the database to mirror, go in options. + * The connection cannot be changed after creation. + */ @JsonProperty("connection_name") private String connectionName; - /** Custom maximum retention period in hours for the catalog */ + /** + * Dropped objects in the catalog remain recoverable for this number of hours before they are + * permanently purged. The value applies to standard catalogs only, must be 0 or within the range + * allowed for the metastore, and is inherited by schemas and tables that do not set their own + * value. + */ @JsonProperty("custom_max_retention_hours") private Long customMaxRetentionHours; - /** Control CMK encryption for managed catalog data */ + /** + * Customer-managed key (CMK) settings control the encryption at rest of the catalog's managed + * data. + */ @JsonProperty("managed_encryption_settings") private EncryptionSettings managedEncryptionSettings; - /** Name of catalog. */ + /** + * The name of the catalog is stored in lowercase, can be at most 255 characters long, and cannot + * contain periods, spaces, forward slashes, or control characters. + */ @JsonProperty("name") private String name; @@ -39,19 +55,26 @@ public class CreateCatalog { private Map properties; /** - * The name of delta sharing provider. - * - *

A Delta Sharing catalog is a catalog that is based on a Delta share on a remote sharing - * server. + * The Delta Sharing provider that owns the share must be named here, together with share_name, to + * create a Delta Sharing catalog that exposes the data of the share on a remote sharing server. + * The provider cannot be changed after creation. */ @JsonProperty("provider_name") private String providerName; - /** The name of the share under the share provider. */ + /** + * The share under the Delta Sharing provider must be named here, together with provider_name, to + * create a Delta Sharing catalog. The share cannot be changed after creation. + */ @JsonProperty("share_name") private String shareName; - /** Storage root URL for managed tables within catalog. */ + /** + * Managed tables and volumes in the catalog are stored under this storage root URL. The path must + * be inside an external location on which the caller has the CREATE MANAGED STORAGE privilege. If + * omitted, managed data is stored under the metastore's root storage location, which must then be + * configured. Delta Sharing catalogs cannot have a storage root. + */ @JsonProperty("storage_root") private String storageRoot; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateExternalLocation.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateExternalLocation.java index f37810b3b..4a3dada30 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateExternalLocation.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateExternalLocation.java @@ -31,14 +31,14 @@ public class CreateExternalLocation { private FileEventQueue effectiveFileEventQueue; /** - * Whether to enable file events on this external location. Default to `true`. Set to `false` to + * Whether to enable file events on this external location. Defaults to `true`. Set to `false` to * disable file events. The actual applied value may differ due to server-side defaults; check * `effective_enable_file_events` for the effective state. */ @JsonProperty("enable_file_events") private Boolean enableFileEvents; - /** */ + /** Encryption options that apply to clients connecting to cloud storage. */ @JsonProperty("encryption_details") private EncryptionDetails encryptionDetails; @@ -51,8 +51,8 @@ public class CreateExternalLocation { private Boolean fallback; /** - * File event queue settings. If `enable_file_events` is not `false`, must be defined and have - * exactly one of the documented properties. + * File event queue settings. When `enable_file_events` is `true`, exactly one of the queue + * options must be set. Must be omitted when `enable_file_events` is `false`. */ @JsonProperty("file_event_queue") private FileEventQueue fileEventQueue; @@ -69,7 +69,10 @@ public class CreateExternalLocation { @JsonProperty("skip_validation") private Boolean skipValidation; - /** Path URL of the external location. */ + /** + * URL of the cloud storage path that the external location points to, including the scheme (for + * example `s3://`, `abfss://`, or `gs://`). + */ @JsonProperty("url") private String url; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateModelServiceRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateModelServiceRequest.java index ba2d80283..bc33688b3 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateModelServiceRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateModelServiceRequest.java @@ -18,7 +18,10 @@ public class CreateModelServiceRequest { @JsonProperty("model_service") private ModelService modelService; - /** Name for the model service, e.g. "my_model_service". */ + /** + * Name of the model service within the parent schema. The name must not contain periods, spaces, + * forward slashes, percent signs, or control characters, and it is stored in lowercase. + */ @JsonIgnore @QueryParam("model_service_id") private String modelServiceId; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateRequestExternalLineage.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateRequestExternalLineage.java index c8ba0491e..7e1df60f4 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateRequestExternalLineage.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateRequestExternalLineage.java @@ -9,9 +9,19 @@ import java.util.Map; import java.util.Objects; +/** + * A lineage relationship between a source object and a target object, where at least one of the two + * is an external metadata object. The other object can be a Unity Catalog table, a cloud storage + * path, a model version, or another external metadata object. A relationship is identified by its + * source and target; optional column mappings and key-value properties describe the data flow + * between them. + */ @Generated public class CreateRequestExternalLineage { - /** List of column relationships between source and target objects. */ + /** + * List of column relationships between source and target objects. The combined size of all source + * and target column names is limited. + */ @JsonProperty("columns") private Collection columns; @@ -19,7 +29,10 @@ public class CreateRequestExternalLineage { @JsonProperty("id") private String id; - /** Key-value properties associated with the external lineage relationship. */ + /** + * Key-value properties associated with the external lineage relationship. The combined length of + * all keys and values must not exceed 5000 characters. + */ @JsonProperty("properties") private Map properties; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateVolumeRequestContent.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateVolumeRequestContent.java index bbe39faf4..0a0f4d57b 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateVolumeRequestContent.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateVolumeRequestContent.java @@ -25,7 +25,12 @@ public class CreateVolumeRequestContent { @JsonProperty("schema_name") private String schemaName; - /** The storage location on the cloud */ + /** + * The cloud storage URL where the files of the volume are stored. For an external volume, it must + * be set on creation to a path within an existing external location. For a managed volume, it + * must be omitted on creation; the volume is placed under the managed storage location of the + * parent schema, catalog, or metastore, and the assigned path is returned in this field. + */ @JsonProperty("storage_location") private String storageLocation; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CredentialInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CredentialInfo.java index 002c7de8e..8eb54486e 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CredentialInfo.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CredentialInfo.java @@ -7,6 +7,12 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.util.Objects; +/** + * A storage credential represents an authentication and authorization mechanism for accessing data + * stored on your cloud tenant. It holds exactly one cloud credential, for example an AWS IAM role, + * an Azure managed identity or service principal, or a GCP service account. Only the field for the + * selected credential type is set in requests and responses. + */ @Generated public class CredentialInfo { /** The AWS IAM role configuration. */ diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeleteCredentialRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeleteCredentialRequest.java index 67d0cc835..3095e7bb0 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeleteCredentialRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeleteCredentialRequest.java @@ -11,7 +11,7 @@ @Generated public class DeleteCredentialRequest { /** - * Force an update even if there are dependent services (when purpose is **SERVICE**) or dependent + * Force deletion even if there are dependent services (when purpose is **SERVICE**) or dependent * external locations and external tables (when purpose is **STORAGE**). */ @JsonIgnore diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeleteExternalLineageRelationshipRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeleteExternalLineageRelationshipRequest.java index d74cea315..5844fafe6 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeleteExternalLineageRelationshipRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeleteExternalLineageRelationshipRequest.java @@ -10,7 +10,11 @@ @Generated public class DeleteExternalLineageRelationshipRequest { - /** */ + /** + * The relationship to delete, identified by its `source` and `target` objects. Since this field + * is a query parameter, flatten the nested fields, for example + * `external_lineage_relationship.source.table.name=main.sales.orders`. + */ @JsonIgnore @QueryParam("external_lineage_relationship") private DeleteRequestExternalLineage externalLineageRelationship; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeleteRequestExternalLineage.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeleteRequestExternalLineage.java index 4a6d348b8..2699d83e0 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeleteRequestExternalLineage.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeleteRequestExternalLineage.java @@ -8,6 +8,13 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.util.Objects; +/** + * A lineage relationship between a source object and a target object, where at least one of the two + * is an external metadata object. The other object can be a Unity Catalog table, a cloud storage + * path, a model version, or another external metadata object. A relationship is identified by its + * source and target; optional column mappings and key-value properties describe the data flow + * between them. + */ @Generated public class DeleteRequestExternalLineage { /** Unique identifier of the external lineage relationship. */ diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeleteStorageCredentialRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeleteStorageCredentialRequest.java index 8c23769e9..b8035f75c 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeleteStorageCredentialRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeleteStorageCredentialRequest.java @@ -10,10 +10,7 @@ @Generated public class DeleteStorageCredentialRequest { - /** - * Force an update even if there are dependent external locations or external tables (when purpose - * is **STORAGE**) or dependent services (when purpose is **SERVICE**). - */ + /** Force deletion even if there are dependent external locations or external tables. */ @JsonIgnore @QueryParam("force") private Boolean force; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalLineageExternalMetadata.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalLineageExternalMetadata.java index 5aea7ac91..75c4f42fc 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalLineageExternalMetadata.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalLineageExternalMetadata.java @@ -8,9 +8,10 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.util.Objects; +/** An external metadata object at one end of an external lineage relationship. */ @Generated public class ExternalLineageExternalMetadata { - /** */ + /** Name of the external metadata object. */ @JsonProperty("name") @QueryParam("name") private String name; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalLineageModelVersion.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalLineageModelVersion.java index ae60fd1df..a056310ec 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalLineageModelVersion.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalLineageModelVersion.java @@ -8,14 +8,15 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.util.Objects; +/** A version of a Unity Catalog registered model at one end of an external lineage relationship. */ @Generated public class ExternalLineageModelVersion { - /** */ + /** Full name of the registered model, in the form `catalog.schema.model`. */ @JsonProperty("name") @QueryParam("name") private String name; - /** */ + /** Version number of the model, as a string. */ @JsonProperty("version") @QueryParam("version") private String version; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalLineageObject.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalLineageObject.java index 056633d4d..6aadedb4f 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalLineageObject.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalLineageObject.java @@ -8,24 +8,28 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.util.Objects; +/** An object at one end of an external lineage relationship. Exactly one of the fields is set. */ @Generated public class ExternalLineageObject { - /** */ + /** An external metadata object registered in Unity Catalog. */ @JsonProperty("external_metadata") @QueryParam("external_metadata") private ExternalLineageExternalMetadata externalMetadata; - /** */ + /** A version of a Unity Catalog registered model. */ @JsonProperty("model_version") @QueryParam("model_version") private ExternalLineageModelVersion modelVersion; - /** */ + /** + * A cloud storage path registered in Unity Catalog, i.e. under a table, volume, or external + * location. + */ @JsonProperty("path") @QueryParam("path") private ExternalLineagePath path; - /** */ + /** A Unity Catalog table. */ @JsonProperty("table") @QueryParam("table") private ExternalLineageTable table; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalLineagePath.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalLineagePath.java index 36638cd52..c9d57e9fa 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalLineagePath.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalLineagePath.java @@ -8,9 +8,13 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.util.Objects; +/** A cloud storage path at one end of an external lineage relationship. */ @Generated public class ExternalLineagePath { - /** */ + /** + * URL of the cloud storage path. The path must be registered in Unity Catalog, i.e. under a + * table, volume, or external location. + */ @JsonProperty("url") @QueryParam("url") private String url; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalLineageRelationship.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalLineageRelationship.java index 313eedb5a..8f02467d2 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalLineageRelationship.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalLineageRelationship.java @@ -9,9 +9,19 @@ import java.util.Map; import java.util.Objects; +/** + * A lineage relationship between a source object and a target object, where at least one of the two + * is an external metadata object. The other object can be a Unity Catalog table, a cloud storage + * path, a model version, or another external metadata object. A relationship is identified by its + * source and target; optional column mappings and key-value properties describe the data flow + * between them. + */ @Generated public class ExternalLineageRelationship { - /** List of column relationships between source and target objects. */ + /** + * List of column relationships between source and target objects. The combined size of all source + * and target column names is limited. + */ @JsonProperty("columns") private Collection columns; @@ -19,7 +29,10 @@ public class ExternalLineageRelationship { @JsonProperty("id") private String id; - /** Key-value properties associated with the external lineage relationship. */ + /** + * Key-value properties associated with the external lineage relationship. The combined length of + * all keys and values must not exceed 5000 characters. + */ @JsonProperty("properties") private Map properties; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalLineageRelationshipInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalLineageRelationshipInfo.java index 65a6fd1bd..19f161ae2 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalLineageRelationshipInfo.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalLineageRelationshipInfo.java @@ -9,9 +9,19 @@ import java.util.Map; import java.util.Objects; +/** + * A lineage relationship between a source object and a target object, where at least one of the two + * is an external metadata object. The other object can be a Unity Catalog table, a cloud storage + * path, a model version, or another external metadata object. A relationship is identified by its + * source and target; optional column mappings and key-value properties describe the data flow + * between them. + */ @Generated public class ExternalLineageRelationshipInfo { - /** List of column relationships between source and target objects. */ + /** + * List of column relationships between source and target objects. The combined size of all source + * and target column names is limited. + */ @JsonProperty("columns") private Collection columns; @@ -19,7 +29,10 @@ public class ExternalLineageRelationshipInfo { @JsonProperty("id") private String id; - /** Key-value properties associated with the external lineage relationship. */ + /** + * Key-value properties associated with the external lineage relationship. The combined length of + * all keys and values must not exceed 5000 characters. + */ @JsonProperty("properties") private Map properties; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalLineageTable.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalLineageTable.java index 9c10e00fc..0ec617172 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalLineageTable.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalLineageTable.java @@ -8,9 +8,10 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.util.Objects; +/** A Unity Catalog table at one end of an external lineage relationship. */ @Generated public class ExternalLineageTable { - /** */ + /** Full name of the table, in the form `catalog.schema.table`. */ @JsonProperty("name") @QueryParam("name") private String name; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalLocationInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalLocationInfo.java index a370e06da..805b030fe 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalLocationInfo.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalLocationInfo.java @@ -7,6 +7,12 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.util.Objects; +/** + * An external location combines a cloud storage path with a storage credential that authorizes + * access to that path. Privileges granted on the external location control which users and groups + * can access the cloud storage path, for example to create external tables, external volumes, or + * managed storage locations under it. + */ @Generated public class ExternalLocationInfo { /** @@ -50,14 +56,14 @@ public class ExternalLocationInfo { private FileEventQueue effectiveFileEventQueue; /** - * Whether to enable file events on this external location. Default to `true`. Set to `false` to + * Whether to enable file events on this external location. Defaults to `true`. Set to `false` to * disable file events. The actual applied value may differ due to server-side defaults; check * `effective_enable_file_events` for the effective state. */ @JsonProperty("enable_file_events") private Boolean enableFileEvents; - /** */ + /** Encryption options that apply to clients connecting to cloud storage. */ @JsonProperty("encryption_details") private EncryptionDetails encryptionDetails; @@ -70,13 +76,16 @@ public class ExternalLocationInfo { private Boolean fallback; /** - * File event queue settings. If `enable_file_events` is not `false`, must be defined and have - * exactly one of the documented properties. + * File event queue settings. When `enable_file_events` is `true`, exactly one of the queue + * options must be set. Must be omitted when `enable_file_events` is `false`. */ @JsonProperty("file_event_queue") private FileEventQueue fileEventQueue; - /** */ + /** + * Whether the current securable is accessible from all workspaces or a specific set of + * workspaces. Cannot be set when creating an external location. + */ @JsonProperty("isolation_mode") private IsolationMode isolationMode; @@ -96,7 +105,7 @@ public class ExternalLocationInfo { @JsonProperty("read_only") private Boolean readOnly; - /** Time at which external location this was last modified, in epoch milliseconds. */ + /** Time at which this external location was last modified, in epoch milliseconds. */ @JsonProperty("updated_at") private Long updatedAt; @@ -104,7 +113,10 @@ public class ExternalLocationInfo { @JsonProperty("updated_by") private String updatedBy; - /** Path URL of the external location. */ + /** + * URL of the cloud storage path that the external location points to, including the scheme (for + * example `s3://`, `abfss://`, or `gs://`). + */ @JsonProperty("url") private String url; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GcpPubsub.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GcpPubsub.java index 1e2b9c93c..54f9f6d84 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GcpPubsub.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GcpPubsub.java @@ -14,8 +14,8 @@ public class GcpPubsub { private String managedResourceId; /** - * The Pub/Sub subscription name in the format projects/{project}/subscriptions/{subscription - * name}. Only required for provided_pubsub. + * The Pub/Sub subscription name in the format `projects/{project}/subscriptions/{subscription + * name}`. Only required for provided_pubsub. */ @JsonProperty("subscription_name") private String subscriptionName; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetAccessRequestDestinationsRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetAccessRequestDestinationsRequest.java index 31a34b389..0e3f693a1 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetAccessRequestDestinationsRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetAccessRequestDestinationsRequest.java @@ -9,10 +9,16 @@ @Generated public class GetAccessRequestDestinationsRequest { - /** The full name of the securable. */ + /** + * The full name of the securable: the names of its parents followed by its own name, separated by + * dots, for example `main.sales.orders` for a table. + */ @JsonIgnore private String fullName; - /** The type of the securable. */ + /** + * The type of the securable. Matching is case-insensitive, and hyphens may replace underscores in + * multi-word types. + */ @JsonIgnore private String securableType; public GetAccessRequestDestinationsRequest setFullName(String fullName) { diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetCatalogRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetCatalogRequest.java index 75a5c6596..a07d033a2 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetCatalogRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetCatalogRequest.java @@ -11,8 +11,8 @@ @Generated public class GetCatalogRequest { /** - * Whether to include catalogs in the response for which the principal can only access selective - * metadata for + * Whether to return the catalog when the principal can only access selective metadata for it + * through the BROWSE privilege. The response then has browse_only set to true. */ @JsonIgnore @QueryParam("include_browse") diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetExternalLocationRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetExternalLocationRequest.java index 5158a373c..46a042bcf 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetExternalLocationRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetExternalLocationRequest.java @@ -12,7 +12,7 @@ public class GetExternalLocationRequest { /** * Whether to include external locations in the response for which the principal can only access - * selective metadata for + * selective metadata. */ @JsonIgnore @QueryParam("include_browse") diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/InferenceTableConfig.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/InferenceTableConfig.java index 8d4bf3510..0244d5dd4 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/InferenceTableConfig.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/InferenceTableConfig.java @@ -29,7 +29,10 @@ public class InferenceTableConfig { @JsonProperty("parent") private String parent; - /** Resolved UC table for payload logs. Format: `tables/{catalog}.{schema}.{table}`. */ + /** + * Resource name of the Unity Catalog table that receives the payload logs. Format: + * `tables/{catalog}.{schema}.{table}`. + */ @JsonProperty("table") private String table; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListCatalogsRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListCatalogsRequest.java index 758e8afff..f90e8aad5 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListCatalogsRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListCatalogsRequest.java @@ -11,8 +11,8 @@ @Generated public class ListCatalogsRequest { /** - * Whether to include catalogs in the response for which the principal can only access selective - * metadata for + * Whether to include catalogs for which the principal can only access selective metadata through + * the BROWSE privilege. Such catalogs are returned with browse_only set to true. */ @JsonIgnore @QueryParam("include_browse") diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListExternalLineageRelationshipsRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListExternalLineageRelationshipsRequest.java index 37261ec39..d05dde8de 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListExternalLineageRelationshipsRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListExternalLineageRelationshipsRequest.java @@ -10,7 +10,12 @@ @Generated public class ListExternalLineageRelationshipsRequest { - /** The lineage direction to filter on. */ + /** + * Direction of the relationships to return, relative to `object_info`. `UPSTREAM` returns the + * relationships in which the object is the target, so each result describes a source; + * `DOWNSTREAM` returns the relationships in which the object is the source, so each result + * describes a target. + */ @JsonIgnore @QueryParam("lineage_direction") private LineageDirection lineageDirection; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListExternalLineageRelationshipsResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListExternalLineageRelationshipsResponse.java index 7bf328c52..656d0c79e 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListExternalLineageRelationshipsResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListExternalLineageRelationshipsResponse.java @@ -10,11 +10,15 @@ @Generated public class ListExternalLineageRelationshipsResponse { - /** */ + /** + * Relationships that match the query. Each entry describes the object at the other end of the + * relationship in one of `table_info`, `file_info`, `model_info`, or `external_metadata_info`, + * together with the relationship itself in `external_lineage_info`. + */ @JsonProperty("external_lineage_relationships") private Collection externalLineageRelationships; - /** */ + /** Opaque token to retrieve the next page of results. Omitted when there are no more results. */ @JsonProperty("next_page_token") private String nextPageToken; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListExternalLocationsRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListExternalLocationsRequest.java index 71bfa3314..789acb09b 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListExternalLocationsRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListExternalLocationsRequest.java @@ -12,7 +12,7 @@ public class ListExternalLocationsRequest { /** * Whether to include external locations in the response for which the principal can only access - * selective metadata for + * selective metadata. */ @JsonIgnore @QueryParam("include_browse") diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListVolumesRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListVolumesRequest.java index 5c2502a3a..375985fee 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListVolumesRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListVolumesRequest.java @@ -10,14 +10,14 @@ @Generated public class ListVolumesRequest { - /** The identifier of the catalog */ + /** The name of the catalog that contains the schema. */ @JsonIgnore @QueryParam("catalog_name") private String catalogName; /** - * Whether to include volumes in the response for which the principal can only access selective - * metadata for + * Whether to include volumes for which the principal can only access selective metadata through + * the BROWSE privilege. */ @JsonIgnore @QueryParam("include_browse") @@ -48,7 +48,7 @@ public class ListVolumesRequest { @QueryParam("page_token") private String pageToken; - /** The identifier of the schema */ + /** The name of the schema whose volumes are listed. */ @JsonIgnore @QueryParam("schema_name") private String schemaName; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelService.java index 7352ed932..c612f74a2 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelService.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelService.java @@ -31,11 +31,11 @@ public class ModelService { @JsonProperty("create_time") private Timestamp createTime; - /** Creator identity. */ + /** Username of the user who created the model service. */ @JsonProperty("created_by") private String createdBy; - /** Owner of the model service. */ + /** Username or group name of the model service owner. */ @JsonProperty("effective_owner") private String effectiveOwner; @@ -47,15 +47,15 @@ public class ModelService { @JsonProperty("etag") private String etag; - /** Metastore hosting the model service. */ + /** Unique identifier of the metastore that contains the model service. */ @JsonProperty("metastore_id") private String metastoreId; /** * Resource name of the model service. Format: * `model-services/{catalog}.{schema}.{model_service}`. Each `{...}` component is capped at 255 - * characters individually. Server-derived on Create from `parent` + `model_service_id`; required - * and immutable on Update/Get/Delete. + * characters individually. The server derives the name on Create from `parent` and + * `model_service_id`; it is required and immutable on Update, Get, and Delete. */ @JsonProperty("name") private String name; @@ -72,7 +72,7 @@ public class ModelService { @JsonProperty("update_time") private Timestamp updateTime; - /** Identity of the last updater. */ + /** Username of the user who last updated the model service. */ @JsonProperty("updated_by") private String updatedBy; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelServiceConfig.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelServiceConfig.java index 183171b42..f3db264d6 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelServiceConfig.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelServiceConfig.java @@ -11,7 +11,10 @@ /** Operational configuration wrapped around the ModelService resource. */ @Generated public class ModelServiceConfig { - /** Inference table configuration for payload logging. */ + /** + * Configuration for logging request and response payloads to a Unity Catalog inference table. + * Omit this field to leave payload logging off. + */ @JsonProperty("inference_table") private InferenceTableConfig inferenceTable; @@ -19,7 +22,10 @@ public class ModelServiceConfig { @JsonProperty("rate_limits") private Collection rateLimits; - /** Routing configuration: destinations and fallback. */ + /** + * Routing configuration: the primary destinations that receive traffic and the fallback + * destinations tried when a primary destination fails. + */ @JsonProperty("routing") private ModelServiceConfigRoutingConfig routing; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelServiceConfigDestinationConfig.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelServiceConfigDestinationConfig.java index 677ebe3b6..fc9d5ee6e 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelServiceConfigDestinationConfig.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelServiceConfigDestinationConfig.java @@ -32,7 +32,10 @@ public class ModelServiceConfigDestinationConfig { @JsonProperty("is_deleted") private Boolean isDeleted; - /** User-facing label for this destination, used in routing references. */ + /** + * Label that identifies this destination. Names are compared case-insensitively and must be + * unique within the primary destinations and within the fallback destinations. + */ @JsonProperty("name") private String name; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelServiceConfigPayPerTokenConfig.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelServiceConfigPayPerTokenConfig.java index f911c9d12..4b003fe78 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelServiceConfigPayPerTokenConfig.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelServiceConfigPayPerTokenConfig.java @@ -13,7 +13,10 @@ */ @Generated public class ModelServiceConfigPayPerTokenConfig { - /** Resource name of the Unity Catalog model. Format: `models/{catalog}.{schema}.{model}`. */ + /** + * Resource name of the Unity Catalog foundation model. Pay-per-token foundation models live in + * the `system.ai` schema, so the name has the form `models/system.ai.{model}`. + */ @JsonProperty("model") private String model; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelServiceConfigProvisionedThroughputConfig.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelServiceConfigProvisionedThroughputConfig.java index c03320833..c67480961 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelServiceConfigProvisionedThroughputConfig.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelServiceConfigProvisionedThroughputConfig.java @@ -15,8 +15,9 @@ @Generated public class ModelServiceConfigProvisionedThroughputConfig { /** - * UC model FQN of the model served by the backing endpoint (e.g., - * `system.ai.databricks-claude-opus-4-6`). Resolved from Model Serving at Create/Update time. + * Resource name of the Unity Catalog model served by the backing endpoint, in the form + * `models/{catalog}.{schema}.{model}`. Resolved from Model Serving when the model service is + * created or updated. */ @JsonProperty("model") private String model; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/Principal.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/Principal.java index 55ed154c7..a1e047fd7 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/Principal.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/Principal.java @@ -13,7 +13,7 @@ public class Principal { @JsonProperty("id") private String id; - /** */ + /** The type of principal that **id** identifies: a user, a group, or a service principal. */ @JsonProperty("principal_type") private PrincipalType principalType; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/RateLimit.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/RateLimit.java index 93ded55b6..5b9385ffc 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/RateLimit.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/RateLimit.java @@ -27,7 +27,7 @@ public class RateLimit { @JsonProperty("principal") private String principal; - /** Renewal period. */ + /** Interval after which the request and token counters reset. */ @JsonProperty("renewal_period") private RateLimitRateLimitRenewalPeriod renewalPeriod; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ReadVolumeRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ReadVolumeRequest.java index 14872d9a5..abe657572 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ReadVolumeRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ReadVolumeRequest.java @@ -11,8 +11,8 @@ @Generated public class ReadVolumeRequest { /** - * Whether to include volumes in the response for which the principal can only access selective - * metadata for + * Whether to include volumes for which the principal can only access selective metadata through + * the BROWSE privilege. */ @JsonIgnore @QueryParam("include_browse") diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/RfaAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/RfaAPI.java index 0276d7bbb..2af56abcd 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/RfaAPI.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/RfaAPI.java @@ -69,7 +69,8 @@ public AccessRequestDestinations getAccessRequestDestinations( * in order to assign destinations. A maximum of 5 emails and 5 external notification destinations * (Slack, Microsoft Teams, Generic Webhook, Databricks App Slack/Teams, Asana, ServiceNow, and * EventBridge destinations) can be assigned to a securable. If a URL destination is assigned, no - * other destinations can be set. + * other destinations can be set. An update replaces every destination assigned directly to the + * securable in this workspace. An empty list removes them all. * *

The supported securable types are: "metastore", "catalog", "schema", "table", * "external_location", "connection", "credential", "function", "registered_model", and "volume". diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/RfaService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/RfaService.java index b5cd69efc..2eeac9983 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/RfaService.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/RfaService.java @@ -44,7 +44,8 @@ AccessRequestDestinations getAccessRequestDestinations( * in order to assign destinations. A maximum of 5 emails and 5 external notification destinations * (Slack, Microsoft Teams, Generic Webhook, Databricks App Slack/Teams, Asana, ServiceNow, and * EventBridge destinations) can be assigned to a securable. If a URL destination is assigned, no - * other destinations can be set. + * other destinations can be set. An update replaces every destination assigned directly to the + * securable in this workspace. An empty list removes them all. * *

The supported securable types are: "metastore", "catalog", "schema", "table", * "external_location", "connection", "credential", "function", "registered_model", and "volume". diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/SecurableKindManifest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/SecurableKindManifest.java index fff872001..0b4de5ed6 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/SecurableKindManifest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/SecurableKindManifest.java @@ -8,7 +8,9 @@ import java.util.Collection; import java.util.Objects; -/** Manifest of a specific securable kind. */ +/** + * Manifest of a specific securable kind, or of an Atlas-native securable type, which has no kinds. + */ @Generated public class SecurableKindManifest { /** Privileges that can be assigned to the securable. */ @@ -23,7 +25,7 @@ public class SecurableKindManifest { @JsonProperty("options") private Collection options; - /** Securable kind to get manifest of. */ + /** Securable kind to get manifest of. Unset for Atlas-native securable types. */ @JsonProperty("securable_kind") private SecurableKind securableKind; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/SecurablePermissions.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/SecurablePermissions.java index 2a5854931..479501a03 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/SecurablePermissions.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/SecurablePermissions.java @@ -14,7 +14,7 @@ public class SecurablePermissions { @JsonProperty("permissions") private Collection permissions; - /** The securable for which the access request destinations are being requested. */ + /** The securable on which the permissions are requested. */ @JsonProperty("securable") private Securable securable; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/StorageCredentialInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/StorageCredentialInfo.java index 4ea241418..a44b2072e 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/StorageCredentialInfo.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/StorageCredentialInfo.java @@ -7,6 +7,12 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.util.Objects; +/** + * A storage credential represents an authentication and authorization mechanism for accessing data + * stored on your cloud tenant. It holds exactly one cloud credential, for example an AWS IAM role, + * an Azure managed identity or service principal, or a GCP service account. Only the field for the + * selected credential type is set in requests and responses. + */ @Generated public class StorageCredentialInfo { /** The AWS IAM role configuration. */ diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateAccessRequestDestinationsRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateAccessRequestDestinationsRequest.java index dac6c0ae3..d312956cc 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateAccessRequestDestinationsRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateAccessRequestDestinationsRequest.java @@ -19,15 +19,8 @@ public class UpdateAccessRequestDestinationsRequest { private AccessRequestDestinations accessRequestDestinations; /** - * The field mask must be a single string, with multiple fields separated by commas (no spaces). - * The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields - * (e.g., `author.given_name`). Specification of elements in sequence or map fields is not - * allowed, as only the entire collection field can be specified. Field names must exactly match - * the resource field names. - * - *

A field mask of `*` indicates full replacement. It’s recommended to always explicitly list - * the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if - * the API changes in the future. + * The paths of the field mask are not evaluated, because an update always replaces the full list + * of destinations. */ @JsonIgnore @QueryParam("update_mask") diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateAccountsStorageCredential.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateAccountsStorageCredential.java index 22801de40..ffece562f 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateAccountsStorageCredential.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateAccountsStorageCredential.java @@ -7,6 +7,12 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.util.Objects; +/** + * A storage credential represents an authentication and authorization mechanism for accessing data + * stored on your cloud tenant. It holds exactly one cloud credential, for example an AWS IAM role, + * an Azure managed identity or service principal, or a GCP service account. Only the field for the + * selected credential type is set in requests and responses. + */ @Generated public class UpdateAccountsStorageCredential { /** The AWS IAM role configuration. */ diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateCatalog.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateCatalog.java index ff58e0226..2d989e604 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateCatalog.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateCatalog.java @@ -15,22 +15,39 @@ public class UpdateCatalog { @JsonProperty("comment") private String comment; - /** Custom maximum retention period in hours for the catalog */ + /** + * Dropped objects in the catalog remain recoverable for this number of hours before they are + * permanently purged. The value applies to standard catalogs only, must be 0 or within the range + * allowed for the metastore, and is inherited by schemas and tables that do not set their own + * value. + */ @JsonProperty("custom_max_retention_hours") private Long customMaxRetentionHours; - /** Whether predictive optimization should be enabled for this object and objects under it. */ + /** + * Whether predictive optimization is enabled for this catalog and the objects under it. Valid + * values are ENABLE, DISABLE, and INHERIT, where INHERIT applies the account-level setting. + * Standard catalogs start as INHERIT and other catalog types as DISABLE. It cannot be set when + * creating a catalog; use the update method instead. + */ @JsonProperty("enable_predictive_optimization") private EnablePredictiveOptimization enablePredictiveOptimization; /** - * Whether the current securable is accessible from all workspaces or a specific set of - * workspaces. + * Whether the catalog is accessible from all workspaces attached to the metastore (OPEN) or only + * from the workspaces bound to it (ISOLATED). It cannot be set when creating a catalog; change it + * with the update method and manage the bound workspaces with the workspace bindings API. See + * [Workspace-catalog binding]. + * + *

[Workspace-catalog binding]: https://docs.databricks.com/aws/en/catalogs/binding */ @JsonProperty("isolation_mode") private CatalogIsolationMode isolationMode; - /** Control CMK encryption for managed catalog data */ + /** + * Customer-managed key (CMK) settings control the encryption at rest of the catalog's managed + * data. + */ @JsonProperty("managed_encryption_settings") private EncryptionSettings managedEncryptionSettings; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateExternalLineageRelationshipRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateExternalLineageRelationshipRequest.java index 1b42084f5..983197510 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateExternalLineageRelationshipRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateExternalLineageRelationshipRequest.java @@ -16,15 +16,9 @@ public class UpdateExternalLineageRelationshipRequest { private UpdateRequestExternalLineage externalLineageRelationship; /** - * The field mask must be a single string, with multiple fields separated by commas (no spaces). - * The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields - * (e.g., `author.given_name`). Specification of elements in sequence or map fields is not - * allowed, as only the entire collection field can be specified. Field names must exactly match - * the resource field names. - * - *

A field mask of `*` indicates full replacement. It’s recommended to always explicitly list - * the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if - * the API changes in the future. + * The fields of the relationship to update. The field mask must be a single string, with multiple + * fields separated by commas (no spaces), for example `columns,properties`. The `source` and + * `target` identify the relationship and cannot be changed. */ @JsonIgnore @QueryParam("update_mask") diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateExternalLocation.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateExternalLocation.java index 30a957764..3a7316dcb 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateExternalLocation.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateExternalLocation.java @@ -32,14 +32,14 @@ public class UpdateExternalLocation { private FileEventQueue effectiveFileEventQueue; /** - * Whether to enable file events on this external location. Default to `true`. Set to `false` to + * Whether to enable file events on this external location. Defaults to `true`. Set to `false` to * disable file events. The actual applied value may differ due to server-side defaults; check * `effective_enable_file_events` for the effective state. */ @JsonProperty("enable_file_events") private Boolean enableFileEvents; - /** */ + /** Encryption options that apply to clients connecting to cloud storage. */ @JsonProperty("encryption_details") private EncryptionDetails encryptionDetails; @@ -52,8 +52,8 @@ public class UpdateExternalLocation { private Boolean fallback; /** - * File event queue settings. If `enable_file_events` is not `false`, must be defined and have - * exactly one of the documented properties. + * File event queue settings. When `enable_file_events` is `true`, exactly one of the queue + * options must be set. Must be omitted when `enable_file_events` is `false`. */ @JsonProperty("file_event_queue") private FileEventQueue fileEventQueue; @@ -62,7 +62,10 @@ public class UpdateExternalLocation { @JsonProperty("force") private Boolean force; - /** */ + /** + * Whether the current securable is accessible from all workspaces or a specific set of + * workspaces. Cannot be set when creating an external location. + */ @JsonProperty("isolation_mode") private IsolationMode isolationMode; @@ -85,7 +88,10 @@ public class UpdateExternalLocation { @JsonProperty("skip_validation") private Boolean skipValidation; - /** Path URL of the external location. */ + /** + * URL of the cloud storage path that the external location points to, including the scheme (for + * example `s3://`, `abfss://`, or `gs://`). + */ @JsonProperty("url") private String url; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateModelServiceRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateModelServiceRequest.java index 95ae56a32..576ac26cc 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateModelServiceRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateModelServiceRequest.java @@ -32,8 +32,8 @@ public class UpdateModelServiceRequest { /** * Resource name of the model service. Format: * `model-services/{catalog}.{schema}.{model_service}`. Each `{...}` component is capped at 255 - * characters individually. Server-derived on Create from `parent` + `model_service_id`; required - * and immutable on Update/Get/Delete. + * characters individually. The server derives the name on Create from `parent` and + * `model_service_id`; it is required and immutable on Update, Get, and Delete. */ @JsonIgnore private String name; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateRequestExternalLineage.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateRequestExternalLineage.java index 4ca0b7552..366e76a42 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateRequestExternalLineage.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateRequestExternalLineage.java @@ -9,9 +9,19 @@ import java.util.Map; import java.util.Objects; +/** + * A lineage relationship between a source object and a target object, where at least one of the two + * is an external metadata object. The other object can be a Unity Catalog table, a cloud storage + * path, a model version, or another external metadata object. A relationship is identified by its + * source and target; optional column mappings and key-value properties describe the data flow + * between them. + */ @Generated public class UpdateRequestExternalLineage { - /** List of column relationships between source and target objects. */ + /** + * List of column relationships between source and target objects. The combined size of all source + * and target column names is limited. + */ @JsonProperty("columns") private Collection columns; @@ -19,7 +29,10 @@ public class UpdateRequestExternalLineage { @JsonProperty("id") private String id; - /** Key-value properties associated with the external lineage relationship. */ + /** + * Key-value properties associated with the external lineage relationship. The combined length of + * all keys and values must not exceed 5000 characters. + */ @JsonProperty("properties") private Map properties; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateVolumeRequestContent.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateVolumeRequestContent.java index 73bcf0400..6aa1ef970 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateVolumeRequestContent.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateVolumeRequestContent.java @@ -17,11 +17,14 @@ public class UpdateVolumeRequestContent { /** The three-level (fully qualified) name of the volume */ @JsonIgnore private String name; - /** New name for the volume. */ + /** The new name for the volume. Set it to rename the volume. */ @JsonProperty("new_name") private String newName; - /** The identifier of the user who owns the volume */ + /** + * The user or group that owns the volume. The user who creates a volume becomes its owner; the + * owner can be changed afterwards with an update. + */ @JsonProperty("owner") private String owner; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/VolumeInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/VolumeInfo.java index 3f74f8647..57bbf6011 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/VolumeInfo.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/VolumeInfo.java @@ -9,7 +9,7 @@ @Generated public class VolumeInfo { - /** The AWS access point to use when accesing s3 for this external location. */ + /** The AWS access point to use when accessing S3 for the storage location of this volume. */ @JsonProperty("access_point") private String accessPoint; @@ -28,7 +28,7 @@ public class VolumeInfo { @JsonProperty("comment") private String comment; - /** */ + /** Time at which the volume was created, in epoch milliseconds. */ @JsonProperty("created_at") private Long createdAt; @@ -40,7 +40,10 @@ public class VolumeInfo { @JsonProperty("encryption_details") private EncryptionDetails encryptionDetails; - /** The three-level (fully qualified) name of the volume */ + /** + * The three-level (fully qualified) name of the volume, in the form + * catalog_name.schema_name.name. + */ @JsonProperty("full_name") private String fullName; @@ -52,7 +55,10 @@ public class VolumeInfo { @JsonProperty("name") private String name; - /** The identifier of the user who owns the volume */ + /** + * The user or group that owns the volume. The user who creates a volume becomes its owner; the + * owner can be changed afterwards with an update. + */ @JsonProperty("owner") private String owner; @@ -60,11 +66,16 @@ public class VolumeInfo { @JsonProperty("schema_name") private String schemaName; - /** The storage location on the cloud */ + /** + * The cloud storage URL where the files of the volume are stored. For an external volume, it must + * be set on creation to a path within an existing external location. For a managed volume, it + * must be omitted on creation; the volume is placed under the managed storage location of the + * parent schema, catalog, or metastore, and the assigned path is returned in this field. + */ @JsonProperty("storage_location") private String storageLocation; - /** */ + /** Time at which the volume was last updated, in epoch milliseconds. */ @JsonProperty("updated_at") private Long updatedAt; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/VolumesAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/VolumesAPI.java index cfe043d21..0088ec2ef 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/VolumesAPI.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/VolumesAPI.java @@ -40,15 +40,15 @@ public VolumesAPI(VolumesService mock) { * default location which is specified by the parent schema, or the parent catalog, or the * Metastore. * - *

For the volume creation to succeed, the user must satisfy following conditions: - The caller - * must be a metastore admin, or be the owner of the parent catalog and schema, or have the + *

For the volume creation to succeed, the user must satisfy the following conditions: - The + * caller must be a metastore admin, or be the owner of the parent catalog and schema, or have the * **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent * schema. - The caller must have **CREATE VOLUME** privilege on the parent schema. * - *

For an external volume, following conditions also need to satisfy - The caller must have - * **CREATE EXTERNAL VOLUME** privilege on the external location. - There are no other tables, nor - * volumes existing in the specified storage location. - The specified storage location is not - * under the location of other tables, nor volumes, or catalogs or schemas. + *

For an external volume, the following conditions must also be satisfied: - The caller must + * have **CREATE EXTERNAL VOLUME** privilege on the external location. - There are no other + * tables, nor volumes existing in the specified storage location. - The specified storage + * location is not under the location of other tables, nor volumes, or catalogs or schemas. */ public VolumeInfo create(CreateVolumeRequestContent request) { return impl.create(request); @@ -125,7 +125,7 @@ public VolumeInfo read(ReadVolumeRequest request) { * caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog and * the **USE_SCHEMA** privilege on the parent schema. * - *

Currently only the name, the owner or the comment of the volume could be updated. + *

Currently only the name, the owner, or the comment of the volume can be updated. */ public VolumeInfo update(UpdateVolumeRequestContent request) { return impl.update(request); diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/VolumesService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/VolumesService.java index fd74b2630..b4d091b43 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/VolumesService.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/VolumesService.java @@ -26,15 +26,15 @@ public interface VolumesService { * default location which is specified by the parent schema, or the parent catalog, or the * Metastore. * - *

For the volume creation to succeed, the user must satisfy following conditions: - The caller - * must be a metastore admin, or be the owner of the parent catalog and schema, or have the + *

For the volume creation to succeed, the user must satisfy the following conditions: - The + * caller must be a metastore admin, or be the owner of the parent catalog and schema, or have the * **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent * schema. - The caller must have **CREATE VOLUME** privilege on the parent schema. * - *

For an external volume, following conditions also need to satisfy - The caller must have - * **CREATE EXTERNAL VOLUME** privilege on the external location. - There are no other tables, nor - * volumes existing in the specified storage location. - The specified storage location is not - * under the location of other tables, nor volumes, or catalogs or schemas. + *

For an external volume, the following conditions must also be satisfied: - The caller must + * have **CREATE EXTERNAL VOLUME** privilege on the external location. - There are no other + * tables, nor volumes existing in the specified storage location. - The specified storage + * location is not under the location of other tables, nor volumes, or catalogs or schemas. */ VolumeInfo create(CreateVolumeRequestContent createVolumeRequestContent); @@ -81,7 +81,7 @@ public interface VolumesService { * caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog and * the **USE_SCHEMA** privilege on the parent schema. * - *

Currently only the name, the owner or the comment of the volume could be updated. + *

Currently only the name, the owner, or the comment of the volume can be updated. */ VolumeInfo update(UpdateVolumeRequestContent updateVolumeRequestContent); } diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CancelCommand.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CancelCommand.java index 2ddfa2fb9..7e7972c01 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CancelCommand.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CancelCommand.java @@ -9,15 +9,15 @@ @Generated public class CancelCommand { - /** */ + /** ID of the cluster that hosts the execution context. */ @JsonProperty("clusterId") private String clusterId; - /** */ + /** ID of the command to cancel, as returned by __execute__. */ @JsonProperty("commandId") private String commandId; - /** */ + /** ID of the execution context the command runs in. */ @JsonProperty("contextId") private String contextId; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/Command.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/Command.java index d6f71db37..73656f6c6 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/Command.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/Command.java @@ -9,19 +9,19 @@ @Generated public class Command { - /** Running cluster id */ + /** ID of the cluster that hosts the execution context. */ @JsonProperty("clusterId") private String clusterId; - /** Executable code */ + /** Code to run, written in the specified language. */ @JsonProperty("command") private String command; - /** Running context id */ + /** ID of the execution context to run the command in, as returned by __Create__. */ @JsonProperty("contextId") private String contextId; - /** */ + /** Language the command is written in. */ @JsonProperty("language") private Language language; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CommandExecutionAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CommandExecutionAPI.java index cb3ff1831..f62f1ddf7 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CommandExecutionAPI.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CommandExecutionAPI.java @@ -208,7 +208,11 @@ public CommandStatusResponse waitCommandStatusCommandExecutionFinishedOrError( /** * Cancels a currently running command within an execution context. * - *

The command ID is obtained from a prior successful call to __execute__. + *

The command ID is obtained from a prior successful call to __execute__. Cancellation is + * asynchronous: this method returns once the request is accepted, and the command moves through + * the `Cancelling` status before reaching a terminal one. Poll __commandStatus__ to observe the + * outcome; a cancelled command ends in the `Finished` status with an `error` result that + * describes the cancellation. */ public Wait cancel(CancelCommand request) { impl.cancel(request); @@ -233,7 +237,9 @@ public CommandStatusResponse commandStatus(String clusterId, String contextId, S /** * Gets the status of and, if available, the results from a currently executing command. * - *

The command ID is obtained from a prior successful call to __execute__. + *

The command ID is obtained from a prior successful call to __execute__. Poll this method + * until the status is one of the terminal values `Finished`, `Error` or `Cancelled`; the + * `results` field is populated only once the command has reached a terminal status. */ public CommandStatusResponse commandStatus(CommandStatusRequest request) { return impl.commandStatus(request); @@ -244,7 +250,12 @@ public ContextStatusResponse contextStatus(String clusterId, String contextId) { new ContextStatusRequest().setClusterId(clusterId).setContextId(contextId)); } - /** Gets the status for an execution context. */ + /** + * Gets the status for an execution context. + * + *

After __Create__, poll this method until the status is `Running` or `Error`. Requests for a + * context that has been deleted fail with an error instead of returning a status. + */ public ContextStatusResponse contextStatus(ContextStatusRequest request) { return impl.contextStatus(request); } @@ -252,7 +263,10 @@ public ContextStatusResponse contextStatus(ContextStatusRequest request) { /** * Creates an execution context for running cluster commands. * - *

If successful, this method returns the ID of the new execution context. + *

If successful, this method returns the ID of the new execution context. The context may + * still be initializing when this method returns, so poll __contextStatus__ until the status is + * `Running` before running commands in it. This method and the other methods of this API require + * the CAN ATTACH TO permission on the cluster. */ public Wait create(CreateContext request) { Created response = impl.create(request); @@ -263,7 +277,13 @@ public Wait create(CreateContext request) { response); } - /** Deletes an execution context. */ + /** + * Deletes an execution context. + * + *

Delete contexts you no longer need, because a cluster can host only a limited number of + * execution contexts at a time. Deleting a context that no longer exists succeeds, so the call is + * safe to retry. + */ public void destroy(DestroyContext request) { impl.destroy(request); } @@ -271,7 +291,9 @@ public void destroy(DestroyContext request) { /** * Runs a cluster command in the given execution context, using the provided language. * - *

If successful, it returns an ID for tracking the status of the command's execution. + *

If successful, it returns an ID for tracking the status of the command's execution. This + * method returns as soon as the command is accepted, so poll __commandStatus__ with the returned + * ID to wait for the command to finish and to read its results. */ public Wait execute(Command request) { Created response = impl.execute(request); diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CommandExecutionService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CommandExecutionService.java index a28c23aaf..4b21241a2 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CommandExecutionService.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CommandExecutionService.java @@ -16,34 +16,56 @@ public interface CommandExecutionService { /** * Cancels a currently running command within an execution context. * - *

The command ID is obtained from a prior successful call to __execute__. + *

The command ID is obtained from a prior successful call to __execute__. Cancellation is + * asynchronous: this method returns once the request is accepted, and the command moves through + * the `Cancelling` status before reaching a terminal one. Poll __commandStatus__ to observe the + * outcome; a cancelled command ends in the `Finished` status with an `error` result that + * describes the cancellation. */ void cancel(CancelCommand cancelCommand); /** * Gets the status of and, if available, the results from a currently executing command. * - *

The command ID is obtained from a prior successful call to __execute__. + *

The command ID is obtained from a prior successful call to __execute__. Poll this method + * until the status is one of the terminal values `Finished`, `Error` or `Cancelled`; the + * `results` field is populated only once the command has reached a terminal status. */ CommandStatusResponse commandStatus(CommandStatusRequest commandStatusRequest); - /** Gets the status for an execution context. */ + /** + * Gets the status for an execution context. + * + *

After __Create__, poll this method until the status is `Running` or `Error`. Requests for a + * context that has been deleted fail with an error instead of returning a status. + */ ContextStatusResponse contextStatus(ContextStatusRequest contextStatusRequest); /** * Creates an execution context for running cluster commands. * - *

If successful, this method returns the ID of the new execution context. + *

If successful, this method returns the ID of the new execution context. The context may + * still be initializing when this method returns, so poll __contextStatus__ until the status is + * `Running` before running commands in it. This method and the other methods of this API require + * the CAN ATTACH TO permission on the cluster. */ Created create(CreateContext createContext); - /** Deletes an execution context. */ + /** + * Deletes an execution context. + * + *

Delete contexts you no longer need, because a cluster can host only a limited number of + * execution contexts at a time. Deleting a context that no longer exists succeeds, so the call is + * safe to retry. + */ void destroy(DestroyContext destroyContext); /** * Runs a cluster command in the given execution context, using the provided language. * - *

If successful, it returns an ID for tracking the status of the command's execution. + *

If successful, it returns an ID for tracking the status of the command's execution. This + * method returns as soon as the command is accepted, so poll __commandStatus__ with the returned + * ID to wait for the command to finish and to read its results. */ Created execute(Command command); } diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CommandStatusRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CommandStatusRequest.java index 24fa19723..d306d068b 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CommandStatusRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CommandStatusRequest.java @@ -10,17 +10,17 @@ @Generated public class CommandStatusRequest { - /** */ + /** ID of the cluster that hosts the execution context. */ @JsonIgnore @QueryParam("clusterId") private String clusterId; - /** */ + /** ID of the command, as returned by __execute__. */ @JsonIgnore @QueryParam("commandId") private String commandId; - /** */ + /** ID of the execution context the command runs in. */ @JsonIgnore @QueryParam("contextId") private String contextId; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CommandStatusResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CommandStatusResponse.java index 0d0531086..349a9dcc2 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CommandStatusResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CommandStatusResponse.java @@ -9,15 +9,24 @@ @Generated public class CommandStatusResponse { - /** */ + /** ID of the command. */ @JsonProperty("id") private String id; - /** */ + /** + * Output of the command. It is populated only once the command has reached a terminal status, and + * its `resultType` tells which of its other fields are set. + */ @JsonProperty("results") private Results results; - /** */ + /** + * Current status of the command. `Queued` and `Running` mean the command has not completed yet, + * and `Cancelling` means a cancellation is in progress. `Finished`, `Error` and `Cancelled` are + * terminal: `Finished` means the command ran to completion, including when the code itself raised + * an error (reported in `results` with the `error` result type), while `Error` means the + * execution environment failed, for example because the driver or the context stopped. + */ @JsonProperty("status") private CommandStatus status; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ContextStatusRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ContextStatusRequest.java index f3219d506..9c53c6ab9 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ContextStatusRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ContextStatusRequest.java @@ -10,12 +10,12 @@ @Generated public class ContextStatusRequest { - /** */ + /** ID of the cluster that hosts the execution context. */ @JsonIgnore @QueryParam("clusterId") private String clusterId; - /** */ + /** ID of the execution context, as returned by __Create__. */ @JsonIgnore @QueryParam("contextId") private String contextId; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ContextStatusResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ContextStatusResponse.java index 5507ed220..08b4a043b 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ContextStatusResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ContextStatusResponse.java @@ -9,11 +9,15 @@ @Generated public class ContextStatusResponse { - /** */ + /** ID of the execution context. */ @JsonProperty("id") private String id; - /** */ + /** + * Current status of the execution context. `Pending` means the context is still initializing and + * does not accept commands yet, `Running` means it is ready, and `Error` means it failed: running + * commands may not complete and new commands may be rejected, so create a new context. + */ @JsonProperty("status") private ContextStatus status; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CreateContext.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CreateContext.java index f904593e6..a48c947cb 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CreateContext.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CreateContext.java @@ -9,11 +9,11 @@ @Generated public class CreateContext { - /** Running cluster id */ + /** ID of the cluster to create the execution context on. The cluster must be running. */ @JsonProperty("clusterId") private String clusterId; - /** */ + /** Programming language of the execution context. */ @JsonProperty("language") private Language language; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/Created.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/Created.java index 4667668f3..094e6d012 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/Created.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/Created.java @@ -9,7 +9,11 @@ @Generated public class Created { - /** */ + /** + * ID of the new execution context when returned by __Create__, or of the submitted command when + * returned by __execute__. Pass it to the other methods of this API as `contextId` or + * `commandId`. + */ @JsonProperty("id") private String id; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/DestroyContext.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/DestroyContext.java index edc144f8b..1dd28963a 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/DestroyContext.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/DestroyContext.java @@ -9,11 +9,11 @@ @Generated public class DestroyContext { - /** */ + /** ID of the cluster that hosts the execution context. */ @JsonProperty("clusterId") private String clusterId; - /** */ + /** ID of the execution context to delete, as returned by __Create__. */ @JsonProperty("contextId") private String contextId; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/Environment.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/Environment.java index 7826a6822..ce675966f 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/Environment.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/Environment.java @@ -56,6 +56,15 @@ public class Environment { @JsonProperty("environment_version") private String environmentVersion; + /** + * Customer-provided container image to use as the whole environment for this workload, stored in + * Databricks Artifact Registry and named by its Unity Catalog name and tag, as + * `catalog.schema.artifact:tag`. Cannot be combined with `environment_version` or + * `base_environment`. + */ + @JsonProperty("image_uri") + private String imageUri; + /** * List of Java dependencies. Each dependency is a string representing a Java library path. For * example: `/Volumes/path/to/test.jar`. @@ -108,6 +117,15 @@ public String getEnvironmentVersion() { return environmentVersion; } + public Environment setImageUri(String imageUri) { + this.imageUri = imageUri; + return this; + } + + public String getImageUri() { + return imageUri; + } + public Environment setJavaDependencies(Collection javaDependencies) { this.javaDependencies = javaDependencies; return this; @@ -135,6 +153,7 @@ public boolean equals(Object o) { && Objects.equals(client, that.client) && Objects.equals(dependencies, that.dependencies) && Objects.equals(environmentVersion, that.environmentVersion) + && Objects.equals(imageUri, that.imageUri) && Objects.equals(javaDependencies, that.javaDependencies) && Objects.equals(projectEnvironment, that.projectEnvironment); } @@ -146,6 +165,7 @@ public int hashCode() { client, dependencies, environmentVersion, + imageUri, javaDependencies, projectEnvironment); } @@ -157,6 +177,7 @@ public String toString() { .add("client", client) .add("dependencies", dependencies) .add("environmentVersion", environmentVersion) + .add("imageUri", imageUri) .add("javaDependencies", javaDependencies) .add("projectEnvironment", projectEnvironment) .toString(); diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/Results.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/Results.java index 4ea0454c8..aa8cdb974 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/Results.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/Results.java @@ -11,11 +11,14 @@ @Generated public class Results { - /** The cause of the error */ + /** Details of an `error` result, usually the exception message or stack trace. */ @JsonProperty("cause") private String cause; - /** */ + /** + * Output of a `text` result as a string, or the rows of a `table` result as an array of rows, + * each an array of column values in the order of `schema`. + */ @JsonProperty("data") private Object data; @@ -43,19 +46,30 @@ public class Results { @JsonProperty("pos") private Long pos; - /** */ + /** + * Type of the result, which determines which other fields are set: `text` puts the output in + * `data`, `table` fills `data`, `schema`, `truncated` and `isJsonSchema`, `image` and `images` + * fill `fileName` and `fileNames` respectively, and `error` fills `cause` and `summary`. + */ @JsonProperty("resultType") private ResultType resultType; - /** The table schema */ + /** + * Columns of a `table` result, in the order of the values within each row of `data`. Each entry + * has a `name`, a `type` and a `metadata` key. + */ @JsonProperty("schema") private Collection> schema; - /** The summary of the error */ + /** + * Short description of an `error` result, such as the exception type and message, when available. + */ @JsonProperty("summary") private String summary; - /** true if partial results are returned. */ + /** + * Whether a `table` result was cut off because the command output exceeded the row or byte limit. + */ @JsonProperty("truncated") private Boolean truncated; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/TshirtSize.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/TshirtSize.java index edfcef767..03ac3f0a2 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/TshirtSize.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/TshirtSize.java @@ -4,7 +4,7 @@ import com.databricks.sdk.support.Generated; -/** T-shirt size for per-workload Spark executor limits. */ +/** T-shirt size for Spark executor limits. */ @Generated public enum TshirtSize { T_SHIRT_SIZE_2X_LARGE, diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/Dashboard.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/Dashboard.java index d94cee027..d6cd7f1ec 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/Dashboard.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/Dashboard.java @@ -17,7 +17,11 @@ public class Dashboard { @JsonProperty("dashboard_id") private String dashboardId; - /** The display name of the dashboard. */ + /** + * The display name of the dashboard. It is also the file name of the dashboard asset in the + * workspace, so it must be unique within the parent folder, cannot contain `/`, and cannot end + * with `.json`, `.lvdash` or `.yml`. The display name must not exceed 500 characters. + */ @JsonProperty("display_name") private String displayName; @@ -34,7 +38,8 @@ public class Dashboard { /** * The workspace path of the folder containing the dashboard. Includes leading slash and no - * trailing slash. This field is excluded in List Dashboards responses. + * trailing slash. The folder must already exist; when omitted on create, the dashboard is created + * in the caller's home folder. This field is excluded in List Dashboards responses. */ @JsonProperty("parent_path") private String parentPath; @@ -47,10 +52,11 @@ public class Dashboard { private String path; /** - * The contents of the dashboard in serialized string form. This field is excluded in List - * Dashboards responses. Use the [get dashboard API] to retrieve an example response, which - * includes the `serialized_dashboard` field. This field provides the structure of the JSON string - * that represents the dashboard's layout and components. + * The dashboard definition (datasets, pages and widgets) as a JSON string, in the same format as + * a dashboard file exported from the workspace (`.lvdash.json`). When omitted on create, an empty + * dashboard is created; when omitted on update, the existing definition is kept and only the + * other fields change. Use the [get dashboard API] on an existing dashboard to see a complete + * example. This field is excluded in List Dashboards responses. * *

[get dashboard API]: https://docs.databricks.com/api/workspace/lakeview/get */ diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieAPI.java index d51289504..b217767d8 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieAPI.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieAPI.java @@ -94,7 +94,9 @@ public GenieMessage waitGetMessageGenieCompleted( /** * Sends a new message in a chat-mode [conversation](:method:genie/startconversation). The AI - * response uses all previously created messages in the conversation to respond. + * response uses all previously created messages in the conversation to respond. The message is + * processed asynchronously. Poll [Get a conversation message](:method:genie/getmessage) until its + * `status` is `COMPLETED`, `FAILED`, or `CANCELLED`. */ public Wait createMessage( GenieCreateConversationMessageRequest request) { @@ -125,7 +127,10 @@ public void deleteConversation(String spaceId, String conversationId) { new GenieDeleteConversationRequest().setSpaceId(spaceId).setConversationId(conversationId)); } - /** Delete a conversation. */ + /** + * Deletes a conversation and all of its messages. Users can delete their own conversations. + * Deleting another user's conversation requires at least CAN MANAGE permission on the space. + */ public void deleteConversation(GenieDeleteConversationRequest request) { impl.deleteConversation(request); } @@ -327,8 +332,8 @@ public GenieGetMessageQueryResultResponse getMessageAttachmentQueryResult( } /** - * Get the result of SQL query if the message has a query attachment. This is only available if a - * message has a query attachment and the message status is `EXECUTING_QUERY` OR `COMPLETED`. + * Gets the result of the SQL query in a message's query attachment. The result is available only + * while the message status is `EXECUTING_QUERY` or `COMPLETED`. */ public GenieGetMessageQueryResultResponse getMessageAttachmentQueryResult( GenieGetMessageAttachmentQueryResultRequest request) { @@ -417,7 +422,11 @@ public GenieListConversationsResponse listConversations(String spaceId) { return listConversations(new GenieListConversationsRequest().setSpaceId(spaceId)); } - /** Get a list of conversations in a Genie Space. */ + /** + * Lists the conversations in a Genie space. By default the list contains only the caller's own + * conversations, ordered by most recent activity. With `include_all`, it contains every user's + * conversations in the space, ordered by creation time with the newest first. + */ public GenieListConversationsResponse listConversations(GenieListConversationsRequest request) { return impl.listConversations(request); } @@ -437,7 +446,7 @@ public GenieListMessageCommentsResponse listMessageComments( return impl.listMessageComments(request); } - /** Get list of Genie Spaces. */ + /** Lists the Genie spaces that the caller can access, most recently updated first. */ public GenieListSpacesResponse listSpaces(GenieListSpacesRequest request) { return impl.listSpaces(request); } @@ -447,7 +456,11 @@ public void sendMessageFeedback(GenieSendMessageFeedbackRequest request) { impl.sendMessageFeedback(request); } - /** Starts a new chat-mode conversation and sends its first message. */ + /** + * Starts a new chat-mode conversation and sends its first message. The message is processed + * asynchronously. Poll [Get a conversation message](:method:genie/getmessage) until its `status` + * is `COMPLETED`, `FAILED`, or `CANCELLED`. + */ public Wait startConversation( GenieStartConversationMessageRequest request) { GenieStartConversationResponse response = impl.startConversation(request); @@ -471,7 +484,11 @@ public void trashSpace(GenieTrashSpaceRequest request) { impl.trashSpace(request); } - /** Updates a Genie space with a serialized payload. */ + /** + * Updates a Genie space. Replaces the whole configuration when `serialized_space` is set and + * changes the title, description, warehouse or folder when those fields are set; omitted fields + * keep their current values. + */ public GenieSpace updateSpace(GenieUpdateSpaceRequest request) { return impl.updateSpace(request); } diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieAttachment.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieAttachment.java index 9e568fd08..a81407b1e 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieAttachment.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieAttachment.java @@ -7,10 +7,13 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.util.Objects; -/** Genie AI Response */ +/** One part of Genie's response to a message. Exactly one of the attachment fields is set. */ @Generated public class GenieAttachment { - /** Attachment ID */ + /** + * The ID of the attachment. The attachment query-result, execute-query, download, and + * visualization endpoints take this ID. + */ @JsonProperty("attachment_id") private String attachmentId; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieConversation.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieConversation.java index adafacd86..6264ca5fd 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieConversation.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieConversation.java @@ -18,7 +18,7 @@ public class GenieConversation { @JsonProperty("conversation_id") private String conversationId; - /** Timestamp when the message was created */ + /** Time when the conversation was created, in milliseconds since the Unix epoch. */ @JsonProperty("created_timestamp") private Long createdTimestamp; @@ -26,7 +26,7 @@ public class GenieConversation { @JsonProperty("id") private String id; - /** Timestamp when the message was last updated */ + /** Time when the conversation was last updated, in milliseconds since the Unix epoch. */ @JsonProperty("last_updated_timestamp") private Long lastUpdatedTimestamp; @@ -34,7 +34,10 @@ public class GenieConversation { @JsonProperty("space_id") private String spaceId; - /** Conversation title */ + /** + * Title of the conversation. Genie sets it to the text of the first message, truncated to 255 + * characters. + */ @JsonProperty("title") private String title; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieConversationSummary.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieConversationSummary.java index 0d8f01293..a841e48df 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieConversationSummary.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieConversationSummary.java @@ -7,6 +7,7 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.util.Objects; +/** A summary of a conversation, as returned when listing the conversations in a space. */ @Generated public class GenieConversationSummary { /** @@ -16,15 +17,15 @@ public class GenieConversationSummary { @JsonProperty("agent_type") private GenieConversationType agentType; - /** */ + /** The ID of the conversation. */ @JsonProperty("conversation_id") private String conversationId; - /** */ + /** Time when the conversation was created, in milliseconds since the Unix epoch. */ @JsonProperty("created_timestamp") private Long createdTimestamp; - /** */ + /** The title of the conversation. */ @JsonProperty("title") private String title; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieCreateSpaceRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieCreateSpaceRequest.java index bbd5e11b6..0ca1f17b0 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieCreateSpaceRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieCreateSpaceRequest.java @@ -9,28 +9,31 @@ @Generated public class GenieCreateSpaceRequest { - /** Optional description */ + /** Description of the space, up to 16384 bytes. */ @JsonProperty("description") private String description; - /** Parent folder path where the space will be registered */ + /** Path of the workspace folder in which to create the space. */ @JsonProperty("parent_path") private String parentPath; /** - * The contents of the Genie Space in serialized string form. Use the [Get Genie - * Space](:method:genie/getspace) API to retrieve an example response, which includes the - * `serialized_space` field. This field provides the structure of the JSON string that represents - * the space's layout and components. + * Configuration of the new space as a JSON string. To copy an existing space, use the value that + * [Get Genie Space](:method:genie/getspace) returns when `include_serialized_space` is true. For + * the JSON format and its validation rules, see + * https://docs.databricks.com/aws/en/genie-agents/conversation-api. */ @JsonProperty("serialized_space") private String serializedSpace; - /** Optional title override */ + /** Display name of the new space. A default name is assigned when omitted. */ @JsonProperty("title") private String title; - /** Warehouse to associate with the new space */ + /** + * ID of the SQL warehouse that runs the queries Genie generates for the space, as a 16-character + * hexadecimal string. + */ @JsonProperty("warehouse_id") private String warehouseId; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieGetSpaceRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieGetSpaceRequest.java index bf2fbf82b..0514bb39c 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieGetSpaceRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieGetSpaceRequest.java @@ -11,8 +11,8 @@ @Generated public class GenieGetSpaceRequest { /** - * Whether to include the serialized space export in the response. Requires at least CAN EDIT - * permission on the space. + * Whether to include the serialized space export in the response. When true, the response also + * carries the configuration `etag`. Requires at least CAN EDIT permission on the space. */ @JsonIgnore @QueryParam("include_serialized_space") diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieMessage.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieMessage.java index e43e20e2d..d99ff0392 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieMessage.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieMessage.java @@ -10,7 +10,10 @@ @Generated public class GenieMessage { - /** AI-generated response to the message */ + /** + * Genie's response to the message. Each attachment holds one part of the response, such as a text + * answer or a SQL query. + */ @JsonProperty("attachments") private Collection attachments; @@ -22,7 +25,7 @@ public class GenieMessage { @JsonProperty("conversation_id") private String conversationId; - /** Timestamp when the message was created */ + /** Time when the message was created, in milliseconds since the Unix epoch. */ @JsonProperty("created_timestamp") private Long createdTimestamp; @@ -38,7 +41,7 @@ public class GenieMessage { @JsonProperty("id") private String id; - /** Timestamp when the message was last updated */ + /** Time when the message was last updated, in milliseconds since the Unix epoch. */ @JsonProperty("last_updated_timestamp") private Long lastUpdatedTimestamp; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieQueryAttachment.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieQueryAttachment.java index b24fff598..35c8c5df7 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieQueryAttachment.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieQueryAttachment.java @@ -22,7 +22,7 @@ public class GenieQueryAttachment { @JsonProperty("last_updated_timestamp") private Long lastUpdatedTimestamp; - /** */ + /** The parameters of the SQL query, when the query is parameterized. */ @JsonProperty("parameters") private Collection parameters; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieService.java index 36198c6c2..b72654e8f 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieService.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieService.java @@ -17,7 +17,9 @@ public interface GenieService { /** * Sends a new message in a chat-mode [conversation](:method:genie/startconversation). The AI - * response uses all previously created messages in the conversation to respond. + * response uses all previously created messages in the conversation to respond. The message is + * processed asynchronously. Poll [Get a conversation message](:method:genie/getmessage) until its + * `status` is `COMPLETED`, `FAILED`, or `CANCELLED`. */ GenieMessage createMessage( GenieCreateConversationMessageRequest genieCreateConversationMessageRequest); @@ -29,7 +31,10 @@ GenieMessageComment createMessageComment( /** Creates a Genie space from a serialized payload. */ GenieSpace createSpace(GenieCreateSpaceRequest genieCreateSpaceRequest); - /** Delete a conversation. */ + /** + * Deletes a conversation and all of its messages. Users can delete their own conversations. + * Deleting another user's conversation requires at least CAN MANAGE permission on the space. + */ void deleteConversation(GenieDeleteConversationRequest genieDeleteConversationRequest); /** Delete a conversation message. */ @@ -135,8 +140,8 @@ GenieGetDownloadFullQueryResultResponse getDownloadFullQueryResult( GenieMessage getMessage(GenieGetConversationMessageRequest genieGetConversationMessageRequest); /** - * Get the result of SQL query if the message has a query attachment. This is only available if a - * message has a query attachment and the message status is `EXECUTING_QUERY` OR `COMPLETED`. + * Gets the result of the SQL query in a message's query attachment. The result is available only + * while the message status is `EXECUTING_QUERY` or `COMPLETED`. */ GenieGetMessageQueryResultResponse getMessageAttachmentQueryResult( GenieGetMessageAttachmentQueryResultRequest genieGetMessageAttachmentQueryResultRequest); @@ -170,7 +175,11 @@ GenieListConversationCommentsResponse listConversationComments( GenieListConversationMessagesResponse listConversationMessages( GenieListConversationMessagesRequest genieListConversationMessagesRequest); - /** Get a list of conversations in a Genie Space. */ + /** + * Lists the conversations in a Genie space. By default the list contains only the caller's own + * conversations, ordered by most recent activity. With `include_all`, it contains every user's + * conversations in the space, ordered by creation time with the newest first. + */ GenieListConversationsResponse listConversations( GenieListConversationsRequest genieListConversationsRequest); @@ -178,19 +187,27 @@ GenieListConversationsResponse listConversations( GenieListMessageCommentsResponse listMessageComments( GenieListMessageCommentsRequest genieListMessageCommentsRequest); - /** Get list of Genie Spaces. */ + /** Lists the Genie spaces that the caller can access, most recently updated first. */ GenieListSpacesResponse listSpaces(GenieListSpacesRequest genieListSpacesRequest); /** Sends feedback for a message in a chat-mode or agent-mode conversation. */ void sendMessageFeedback(GenieSendMessageFeedbackRequest genieSendMessageFeedbackRequest); - /** Starts a new chat-mode conversation and sends its first message. */ + /** + * Starts a new chat-mode conversation and sends its first message. The message is processed + * asynchronously. Poll [Get a conversation message](:method:genie/getmessage) until its `status` + * is `COMPLETED`, `FAILED`, or `CANCELLED`. + */ GenieStartConversationResponse startConversation( GenieStartConversationMessageRequest genieStartConversationMessageRequest); /** Move a Genie Space to the trash. */ void trashSpace(GenieTrashSpaceRequest genieTrashSpaceRequest); - /** Updates a Genie space with a serialized payload. */ + /** + * Updates a Genie space. Replaces the whole configuration when `serialized_space` is set and + * changes the title, description, warehouse or folder when those fields are set; omitted fields + * keep their current values. + */ GenieSpace updateSpace(GenieUpdateSpaceRequest genieUpdateSpaceRequest); } diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieSpace.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieSpace.java index 8b721ff1d..2827ac67e 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieSpace.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieSpace.java @@ -8,6 +8,11 @@ import com.google.protobuf.Timestamp; import java.util.Objects; +/** + * A Genie space that business users query in natural language. Its configuration (data sources, + * instructions, sample questions and benchmarks) travels as a JSON string in `serialized_space`; + * the other fields are metadata about the space. + */ @Generated public class GenieSpace { /** Time when the Genie space was created. */ @@ -25,15 +30,15 @@ public class GenieSpace { @JsonProperty("etag") private String etag; - /** Parent folder path of the Genie Space */ + /** Path of the workspace folder that contains the space. */ @JsonProperty("parent_path") private String parentPath; /** - * The contents of the Genie Space in serialized string form. This field is excluded in List Genie - * spaces responses. Use the [Get Genie Space](:method:genie/getspace) API to retrieve an example - * response, which includes the `serialized_space` field. This field provides the structure of the - * JSON string that represents the space's layout and components. + * Configuration of the space (data sources, instructions, sample questions and benchmarks) as a + * JSON string. [Get Genie Space](:method:genie/getspace) returns it only when + * `include_serialized_space` is true, and List Genie spaces never returns it. For the JSON format + * and its validation rules, see https://docs.databricks.com/aws/en/genie-agents/conversation-api. */ @JsonProperty("serialized_space") private String serializedSpace; @@ -52,7 +57,7 @@ public class GenieSpace { @JsonProperty("update_time") private Timestamp updateTime; - /** Warehouse associated with the Genie Space */ + /** ID of the SQL warehouse that runs the queries Genie generates for this space. */ @JsonProperty("warehouse_id") private String warehouseId; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieStartConversationResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieStartConversationResponse.java index d4a2f8079..de0499753 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieStartConversationResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieStartConversationResponse.java @@ -9,7 +9,7 @@ @Generated public class GenieStartConversationResponse { - /** */ + /** The newly created conversation. */ @JsonProperty("conversation") private GenieConversation conversation; @@ -17,7 +17,7 @@ public class GenieStartConversationResponse { @JsonProperty("conversation_id") private String conversationId; - /** */ + /** The first message of the conversation, in its initial state. */ @JsonProperty("message") private GenieMessage message; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieUpdateSpaceRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieUpdateSpaceRequest.java index 763052f59..53ad07e69 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieUpdateSpaceRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GenieUpdateSpaceRequest.java @@ -10,7 +10,7 @@ @Generated public class GenieUpdateSpaceRequest { - /** Optional description */ + /** New description for the space, up to 16384 bytes. */ @JsonProperty("description") private String description; @@ -26,10 +26,11 @@ public class GenieUpdateSpaceRequest { private String parentPath; /** - * The contents of the Genie Space in serialized string form (full replacement). Use the [Get - * Genie Space](:method:genie/getspace) API to retrieve an example response, which includes the - * `serialized_space` field. This field provides the structure of the JSON string that represents - * the space's layout and components. + * New configuration of the space as a JSON string. It replaces the whole configuration; when + * omitted, the current configuration is kept. Start from the value that [Get Genie + * Space](:method:genie/getspace) returns when `include_serialized_space` is true. For the JSON + * format and its validation rules, see + * https://docs.databricks.com/aws/en/genie-agents/conversation-api. */ @JsonProperty("serialized_space") private String serializedSpace; @@ -37,11 +38,11 @@ public class GenieUpdateSpaceRequest { /** Genie space ID */ @JsonIgnore private String spaceId; - /** Optional title override */ + /** New display name for the space. Cannot be empty or contain a slash. */ @JsonProperty("title") private String title; - /** Optional warehouse override */ + /** ID of the SQL warehouse that runs the queries Genie generates for the space. */ @JsonProperty("warehouse_id") private String warehouseId; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/LakeviewAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/LakeviewAPI.java index b9dced31d..5ad2b97dc 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/LakeviewAPI.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/LakeviewAPI.java @@ -27,14 +27,7 @@ public LakeviewAPI(LakeviewService mock) { impl = mock; } - /** - * Create a draft dashboard. - * - *

Requires the [Databricks SQL access] entitlement. Grant Databricks SQL access in addition to - * Workspace access. - * - *

[Databricks SQL access]: https://docs.databricks.com/security/auth/entitlements - */ + /** Create a draft dashboard. */ public Dashboard create(CreateDashboardRequest request) { return impl.create(request); } @@ -110,14 +103,7 @@ public Dashboard get(String dashboardId) { return get(new GetDashboardRequest().setDashboardId(dashboardId)); } - /** - * Get a draft dashboard. - * - *

Requires the [Databricks SQL access] entitlement. Grant Databricks SQL access in addition to - * Workspace access. - * - *

[Databricks SQL access]: https://docs.databricks.com/security/auth/entitlements - */ + /** Get a draft dashboard. */ public Dashboard get(GetDashboardRequest request) { return impl.get(request); } @@ -184,12 +170,8 @@ public Subscription getSubscription(GetSubscriptionRequest request) { } /** - * List dashboards. - * - *

Requires the [Databricks SQL access] entitlement. Grant Databricks SQL access in addition to - * Workspace access. - * - *

[Databricks SQL access]: https://docs.databricks.com/security/auth/entitlements + * List the dashboards that the caller can view. Each entry carries summary metadata only; use Get + * dashboard to retrieve a dashboard's full definition. */ public Iterable list(ListDashboardsRequest request) { return Paginator.newTokenPagination( @@ -272,26 +254,12 @@ public Dashboard migrate(MigrateDashboardRequest request) { return impl.migrate(request); } - /** - * Publish the current draft dashboard. - * - *

Requires the [Databricks SQL access] entitlement. Grant Databricks SQL access in addition to - * Workspace access. - * - *

[Databricks SQL access]: https://docs.databricks.com/security/auth/entitlements - */ + /** Publish the current draft dashboard. */ public PublishedDashboard publish(PublishRequest request) { return impl.publish(request); } - /** - * Revert a dashboard's definition in draft mode to the last published version. - * - *

Requires the [Databricks SQL access] entitlement. Grant Databricks SQL access in addition to - * Workspace access. - * - *

[Databricks SQL access]: https://docs.databricks.com/security/auth/entitlements - */ + /** Revert a dashboard's definition in draft mode to the last published version. */ public RevertDashboardResponse revert(RevertDashboardRequest request) { return impl.revert(request); } @@ -300,14 +268,7 @@ public void trash(String dashboardId) { trash(new TrashDashboardRequest().setDashboardId(dashboardId)); } - /** - * Trash a dashboard. - * - *

Requires the [Databricks SQL access] entitlement. Grant Databricks SQL access in addition to - * Workspace access. - * - *

[Databricks SQL access]: https://docs.databricks.com/security/auth/entitlements - */ + /** Trash a dashboard. */ public void trash(TrashDashboardRequest request) { impl.trash(request); } @@ -316,26 +277,12 @@ public void unpublish(String dashboardId) { unpublish(new UnpublishDashboardRequest().setDashboardId(dashboardId)); } - /** - * Unpublish the dashboard. - * - *

Requires the [Databricks SQL access] entitlement. Grant Databricks SQL access in addition to - * Workspace access. - * - *

[Databricks SQL access]: https://docs.databricks.com/security/auth/entitlements - */ + /** Unpublish the dashboard. */ public void unpublish(UnpublishDashboardRequest request) { impl.unpublish(request); } - /** - * Update a draft dashboard. - * - *

Requires the [Databricks SQL access] entitlement. Grant Databricks SQL access in addition to - * Workspace access. - * - *

[Databricks SQL access]: https://docs.databricks.com/security/auth/entitlements - */ + /** Update a draft dashboard. */ public Dashboard update(UpdateDashboardRequest request) { return impl.update(request); } diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/LakeviewService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/LakeviewService.java index 54be52dff..019e2265f 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/LakeviewService.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/LakeviewService.java @@ -13,14 +13,7 @@ */ @Generated public interface LakeviewService { - /** - * Create a draft dashboard. - * - *

Requires the [Databricks SQL access] entitlement. Grant Databricks SQL access in addition to - * Workspace access. - * - *

[Databricks SQL access]: https://docs.databricks.com/security/auth/entitlements - */ + /** Create a draft dashboard. */ Dashboard create(CreateDashboardRequest createDashboardRequest); /** @@ -69,14 +62,7 @@ public interface LakeviewService { */ void deleteSubscription(DeleteSubscriptionRequest deleteSubscriptionRequest); - /** - * Get a draft dashboard. - * - *

Requires the [Databricks SQL access] entitlement. Grant Databricks SQL access in addition to - * Workspace access. - * - *

[Databricks SQL access]: https://docs.databricks.com/security/auth/entitlements - */ + /** Get a draft dashboard. */ Dashboard get(GetDashboardRequest getDashboardRequest); /** @@ -117,12 +103,8 @@ public interface LakeviewService { Subscription getSubscription(GetSubscriptionRequest getSubscriptionRequest); /** - * List dashboards. - * - *

Requires the [Databricks SQL access] entitlement. Grant Databricks SQL access in addition to - * Workspace access. - * - *

[Databricks SQL access]: https://docs.databricks.com/security/auth/entitlements + * List the dashboards that the caller can view. Each entry carries summary metadata only; use Get + * dashboard to retrieve a dashboard's full definition. */ ListDashboardsResponse list(ListDashboardsRequest listDashboardsRequest); @@ -158,54 +140,19 @@ public interface LakeviewService { */ Dashboard migrate(MigrateDashboardRequest migrateDashboardRequest); - /** - * Publish the current draft dashboard. - * - *

Requires the [Databricks SQL access] entitlement. Grant Databricks SQL access in addition to - * Workspace access. - * - *

[Databricks SQL access]: https://docs.databricks.com/security/auth/entitlements - */ + /** Publish the current draft dashboard. */ PublishedDashboard publish(PublishRequest publishRequest); - /** - * Revert a dashboard's definition in draft mode to the last published version. - * - *

Requires the [Databricks SQL access] entitlement. Grant Databricks SQL access in addition to - * Workspace access. - * - *

[Databricks SQL access]: https://docs.databricks.com/security/auth/entitlements - */ + /** Revert a dashboard's definition in draft mode to the last published version. */ RevertDashboardResponse revert(RevertDashboardRequest revertDashboardRequest); - /** - * Trash a dashboard. - * - *

Requires the [Databricks SQL access] entitlement. Grant Databricks SQL access in addition to - * Workspace access. - * - *

[Databricks SQL access]: https://docs.databricks.com/security/auth/entitlements - */ + /** Trash a dashboard. */ void trash(TrashDashboardRequest trashDashboardRequest); - /** - * Unpublish the dashboard. - * - *

Requires the [Databricks SQL access] entitlement. Grant Databricks SQL access in addition to - * Workspace access. - * - *

[Databricks SQL access]: https://docs.databricks.com/security/auth/entitlements - */ + /** Unpublish the dashboard. */ void unpublish(UnpublishDashboardRequest unpublishDashboardRequest); - /** - * Update a draft dashboard. - * - *

Requires the [Databricks SQL access] entitlement. Grant Databricks SQL access in addition to - * Workspace access. - * - *

[Databricks SQL access]: https://docs.databricks.com/security/auth/entitlements - */ + /** Update a draft dashboard. */ Dashboard update(UpdateDashboardRequest updateDashboardRequest); /** diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/MessageError.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/MessageError.java index 955118cf8..49291091c 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/MessageError.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/MessageError.java @@ -9,11 +9,11 @@ @Generated public class MessageError { - /** */ + /** A human-readable description of the error. */ @JsonProperty("error") private String error; - /** */ + /** The category of the error. */ @JsonProperty("type") private MessageErrorType typeValue; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/QueryAttachmentParameter.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/QueryAttachmentParameter.java index e2609ee6a..f784beda0 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/QueryAttachmentParameter.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/QueryAttachmentParameter.java @@ -9,15 +9,15 @@ @Generated public class QueryAttachmentParameter { - /** */ + /** The name of the parameter as referenced in the SQL query. */ @JsonProperty("keyword") private String keyword; - /** */ + /** The SQL type of the parameter value. */ @JsonProperty("sql_type") private String sqlType; - /** */ + /** The value bound to the parameter. */ @JsonProperty("value") private String value; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/DatabaseAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/DatabaseAPI.java index 7dd2e8c99..7dbde5677 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/DatabaseAPI.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/DatabaseAPI.java @@ -117,8 +117,15 @@ public DatabaseInstanceRole createDatabaseInstanceRole( } /** - * Create a Database Table. Useful for registering pre-existing PG tables in UC. See - * CreateSyncedDatabaseTable for creating synced tables in PG from a source table in UC. + * Create a Database Table. This registers a table that already exists in a Postgres database of a + * database instance as a table in Unity Catalog. The Postgres database, schema and table must + * already exist; the request does not create them. Repeating the request for the same table + * succeeds, and a request for a name that is already registered from a different database or + * instance fails. To create a Postgres table from a Unity Catalog source table instead, use + * [Create a Synced Database Table]. + * + *

[Create a Synced Database Table]: + * https://docs.databricks.com/api/workspace/database/createsynceddatabasetable */ public DatabaseTable createDatabaseTable(CreateDatabaseTableRequest request) { return impl.createDatabaseTable(request); @@ -127,6 +134,10 @@ public DatabaseTable createDatabaseTable(CreateDatabaseTableRequest request) { /** * Create a Synced Database Table. * + *

The table and its data synchronization pipeline are provisioned asynchronously. The response + * reflects the initial state; use Get a Synced Database Table to follow the data synchronization + * status until the table is online. + * *

For new workloads, Databricks recommends the Postgres API equivalent: [Create a synced * table]. * @@ -141,7 +152,8 @@ public void deleteDatabaseCatalog(String name) { } /** - * Delete a Database Catalog. + * Delete a Database Catalog. This removes the catalog from Unity Catalog, while the Postgres + * database and its tables remain in the instance. * *

For new workloads, Databricks recommends the Postgres API equivalent: [Delete a catalog]. * @@ -186,7 +198,14 @@ public void deleteDatabaseTable(String name) { deleteDatabaseTable(new DeleteDatabaseTableRequest().setName(name)); } - /** Delete a Database Table. */ + /** + * Delete a Database Table. This removes the table from Unity Catalog only; the Postgres table and + * its data are kept. Tables in a database catalog cannot be deleted with this method, and synced + * tables must be deleted with [Delete a Synced Database Table]. + * + *

[Delete a Synced Database Table]: + * https://docs.databricks.com/api/workspace/database/deletesynceddatabasetable + */ public void deleteDatabaseTable(DeleteDatabaseTableRequest request) { impl.deleteDatabaseTable(request); } @@ -207,18 +226,21 @@ public void deleteSyncedDatabaseTable(DeleteSyncedDatabaseTableRequest request) impl.deleteSyncedDatabaseTable(request); } - /** Find a Database Instance by uid. */ + /** Find a Database Instance by its uid rather than by name. */ public DatabaseInstance findDatabaseInstanceByUid(FindDatabaseInstanceByUidRequest request) { return impl.findDatabaseInstanceByUid(request); } /** - * Generates a credential that can be used to access database instances. + * Generates a short-lived OAuth token for connecting to database instances. Connect with the + * caller's Databricks identity as the Postgres user and the returned token as the password. For + * details about OAuth token authentication, see [About authentication]. * *

For new workloads, Databricks recommends the Postgres API equivalent: [Generate a database * credential]. * - *

[Generate a database credential]: + *

[About authentication]: https://docs.databricks.com/aws/en/oltp/projects/authentication + * [Generate a database credential]: * https://docs.databricks.com/api/postgres/v1/generate-database-credential */ public DatabaseCredential generateDatabaseCredential(GenerateDatabaseCredentialRequest request) { @@ -275,7 +297,13 @@ public DatabaseTable getDatabaseTable(String name) { return getDatabaseTable(new GetDatabaseTableRequest().setName(name)); } - /** Get a Database Table. */ + /** + * Get a Database Table. The request fails if the name refers to a synced table or to a table that + * is not a database table; for synced tables, use [Get a Synced Database Table]. + * + *

[Get a Synced Database Table]: + * https://docs.databricks.com/api/workspace/database/getsynceddatabasetable + */ public DatabaseTable getDatabaseTable(GetDatabaseTableRequest request) { return impl.getDatabaseTable(request); } diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/DatabaseCatalog.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/DatabaseCatalog.java index aca405880..ef60cf2bc 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/DatabaseCatalog.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/DatabaseCatalog.java @@ -7,9 +7,18 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.util.Objects; +/** + * A Database Catalog registers a Postgres database that lives in a Lakebase database instance as a + * catalog in Unity Catalog, so that the database's schemas and tables are governed and discoverable + * through Unity Catalog. For an overview, see + * https://docs.databricks.com/aws/en/oltp/projects/register-uc. + */ @Generated public class DatabaseCatalog { - /** */ + /** + * If true, the database named in database_name is created in the instance when it does not + * already exist, with the calling user as its owner. Defaults to false. + */ @JsonProperty("create_database_if_not_exists") private Boolean createDatabaseIfNotExists; @@ -17,15 +26,19 @@ public class DatabaseCatalog { @JsonProperty("database_instance_name") private String databaseInstanceName; - /** The name of the database (in an instance) associated with the catalog. */ + /** + * The name of the Postgres database in the instance that the catalog registers. The database must + * already exist unless create_database_if_not_exists is true. The system databases postgres, + * databricks_system, template0 and template1 cannot be registered. + */ @JsonProperty("database_name") private String databaseName; - /** The name of the catalog in UC. */ + /** The name of the catalog in Unity Catalog. */ @JsonProperty("name") private String name; - /** */ + /** An immutable UUID identifier for the catalog, assigned when the catalog is created. */ @JsonProperty("uid") private String uid; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/DatabaseCredential.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/DatabaseCredential.java index 80007b73f..96a27d00c 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/DatabaseCredential.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/DatabaseCredential.java @@ -7,13 +7,20 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.util.Objects; +/** + * A short-lived credential for connecting to database instances with the caller's Databricks + * identity. + */ @Generated public class DatabaseCredential { - /** */ + /** + * The time at which the token expires. Tokens are valid for one hour after they are issued, and a + * new token is needed to open connections after that time. + */ @JsonProperty("expiration_time") private String expirationTime; - /** */ + /** The OAuth token to use as the Postgres password when connecting to a database instance. */ @JsonProperty("token") private String token; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/DatabaseInstance.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/DatabaseInstance.java index fcf25e60f..f4fb7347a 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/DatabaseInstance.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/DatabaseInstance.java @@ -13,7 +13,10 @@ */ @Generated public class DatabaseInstance { - /** The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8". */ + /** + * The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8". Must be set when + * creating an instance. + */ @JsonProperty("capacity") private String capacity; @@ -31,15 +34,15 @@ public class DatabaseInstance { /** * Custom tags associated with the instance. This field is only included on create and update - * responses. + * responses. An instance can have at most 10 tags; keys must be unique ignoring case. */ @JsonProperty("custom_tags") private Collection customTags; /** - * Deprecated. The sku of the instance; this field will always match the value of capacity. This - * is an output only field that contains the value computed from the input field combined with - * server side defaults. Use the field without the effective_ prefix to set the value. + * Deprecated: this field always matches the value of capacity; read capacity instead. This is an + * output only field that contains the value computed from the input field combined with server + * side defaults. Use the field without the effective_ prefix to set the value. */ @JsonProperty("effective_capacity") private String effectiveCapacity; @@ -106,11 +109,18 @@ public class DatabaseInstance { @JsonProperty("enable_pg_native_login") private Boolean enablePgNativeLogin; - /** Whether to enable secondaries to serve read-only traffic. Defaults to false. */ + /** + * Whether to enable secondaries to serve read-only traffic. Defaults to false. Requires a + * node_count greater than 1. + */ @JsonProperty("enable_readable_secondaries") private Boolean enableReadableSecondaries; - /** The name of the instance. This is the unique identifier for the instance. */ + /** + * The name of the instance. This is the unique identifier for the instance. Must be 1 to 63 + * characters long, contain only letters, digits and hyphens, start with a letter, and not contain + * consecutive hyphens. + */ @JsonProperty("name") private String name; @@ -123,7 +133,8 @@ public class DatabaseInstance { private Long nodeCount; /** - * The ref of the parent instance. This is only available if the instance is child instance. + * The ref of the parent instance. This is only available if the instance is a child instance. A + * child instance inherits custom_tags and usage_policy_id from its parent and cannot set them. * Input: For specifying the parent instance to create a child instance. Optional. Output: Only * populated if provided as input to create a child instance. */ @@ -156,7 +167,11 @@ public class DatabaseInstance { @JsonProperty("state") private DatabaseInstanceState state; - /** Whether to stop the instance. An input only param, see effective_stopped for the output. */ + /** + * Whether to stop the instance. An input only param, see effective_stopped for the output. An + * instance cannot be created in the stopped state; set this field on update to stop or start the + * instance. + */ @JsonProperty("stopped") private Boolean stopped; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/DatabaseService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/DatabaseService.java index 1aa709e8f..a20d387ec 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/DatabaseService.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/DatabaseService.java @@ -47,14 +47,25 @@ DatabaseInstanceRole createDatabaseInstanceRole( CreateDatabaseInstanceRoleRequest createDatabaseInstanceRoleRequest); /** - * Create a Database Table. Useful for registering pre-existing PG tables in UC. See - * CreateSyncedDatabaseTable for creating synced tables in PG from a source table in UC. + * Create a Database Table. This registers a table that already exists in a Postgres database of a + * database instance as a table in Unity Catalog. The Postgres database, schema and table must + * already exist; the request does not create them. Repeating the request for the same table + * succeeds, and a request for a name that is already registered from a different database or + * instance fails. To create a Postgres table from a Unity Catalog source table instead, use + * [Create a Synced Database Table]. + * + *

[Create a Synced Database Table]: + * https://docs.databricks.com/api/workspace/database/createsynceddatabasetable */ DatabaseTable createDatabaseTable(CreateDatabaseTableRequest createDatabaseTableRequest); /** * Create a Synced Database Table. * + *

The table and its data synchronization pipeline are provisioned asynchronously. The response + * reflects the initial state; use Get a Synced Database Table to follow the data synchronization + * status until the table is online. + * *

For new workloads, Databricks recommends the Postgres API equivalent: [Create a synced * table]. * @@ -64,7 +75,8 @@ SyncedDatabaseTable createSyncedDatabaseTable( CreateSyncedDatabaseTableRequest createSyncedDatabaseTableRequest); /** - * Delete a Database Catalog. + * Delete a Database Catalog. This removes the catalog from Unity Catalog, while the Postgres + * database and its tables remain in the instance. * *

For new workloads, Databricks recommends the Postgres API equivalent: [Delete a catalog]. * @@ -91,7 +103,14 @@ SyncedDatabaseTable createSyncedDatabaseTable( void deleteDatabaseInstanceRole( DeleteDatabaseInstanceRoleRequest deleteDatabaseInstanceRoleRequest); - /** Delete a Database Table. */ + /** + * Delete a Database Table. This removes the table from Unity Catalog only; the Postgres table and + * its data are kept. Tables in a database catalog cannot be deleted with this method, and synced + * tables must be deleted with [Delete a Synced Database Table]. + * + *

[Delete a Synced Database Table]: + * https://docs.databricks.com/api/workspace/database/deletesynceddatabasetable + */ void deleteDatabaseTable(DeleteDatabaseTableRequest deleteDatabaseTableRequest); /** @@ -104,17 +123,20 @@ void deleteDatabaseInstanceRole( */ void deleteSyncedDatabaseTable(DeleteSyncedDatabaseTableRequest deleteSyncedDatabaseTableRequest); - /** Find a Database Instance by uid. */ + /** Find a Database Instance by its uid rather than by name. */ DatabaseInstance findDatabaseInstanceByUid( FindDatabaseInstanceByUidRequest findDatabaseInstanceByUidRequest); /** - * Generates a credential that can be used to access database instances. + * Generates a short-lived OAuth token for connecting to database instances. Connect with the + * caller's Databricks identity as the Postgres user and the returned token as the password. For + * details about OAuth token authentication, see [About authentication]. * *

For new workloads, Databricks recommends the Postgres API equivalent: [Generate a database * credential]. * - *

[Generate a database credential]: + *

[About authentication]: https://docs.databricks.com/aws/en/oltp/projects/authentication + * [Generate a database credential]: * https://docs.databricks.com/api/postgres/v1/generate-database-credential */ DatabaseCredential generateDatabaseCredential( @@ -148,7 +170,13 @@ DatabaseCredential generateDatabaseCredential( DatabaseInstanceRole getDatabaseInstanceRole( GetDatabaseInstanceRoleRequest getDatabaseInstanceRoleRequest); - /** Get a Database Table. */ + /** + * Get a Database Table. The request fails if the name refers to a synced table or to a table that + * is not a database table; for synced tables, use [Get a Synced Database Table]. + * + *

[Get a Synced Database Table]: + * https://docs.databricks.com/api/workspace/database/getsynceddatabasetable + */ DatabaseTable getDatabaseTable(GetDatabaseTableRequest getDatabaseTableRequest); /** diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/DatabaseTable.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/DatabaseTable.java index b3213ea76..bd210cb23 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/DatabaseTable.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/DatabaseTable.java @@ -7,30 +7,36 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.util.Objects; +/** + * A database table is a table that already exists in a Postgres database of a Lakebase database + * instance and is registered in Unity Catalog, so that it is governed and discoverable there while + * the Postgres table remains the source of truth. Unlike a synced table, no data is copied from a + * Unity Catalog source table into Postgres. + */ @Generated public class DatabaseTable { /** - * Name of the target database instance. This is required when creating database tables in - * standard catalogs. This is optional when creating database tables in registered catalogs. If - * this field is specified when creating database tables in registered catalogs, the database - * instance name MUST match that of the registered catalog (or the request will be rejected). + * The name of the database instance that hosts the Postgres table. It must be set when creating a + * database table. */ @JsonProperty("database_instance_name") private String databaseInstanceName; /** - * Target Postgres database object (logical database) name for this table. - * - *

When creating a table in a standard catalog, this field is required. In this scenario, - * specifying this field will allow targeting an arbitrary postgres database. - * - *

Registration of database tables via /database/tables is currently only supported in standard - * catalogs. + * The name of the Postgres database in the instance that contains the table. It must be set when + * creating a database table. Tables in the system databases postgres, databricks_system, + * template0 and template1, and tables in the schemas pg_catalog and information_schema, cannot be + * registered. */ @JsonProperty("logical_database_name") private String logicalDatabaseName; - /** Full three-part (catalog, schema, table) name of the table. */ + /** + * Full three-part (catalog, schema, table) name of the table in Unity Catalog. The catalog must + * be a standard or default storage catalog; database tables cannot be registered in a database + * catalog. The schema and table parts must match the schema and table names of the Postgres table + * that is registered. + */ @JsonProperty("name") private String name; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/DeleteDatabaseCatalogRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/DeleteDatabaseCatalogRequest.java index 7759d67fc..86692a8eb 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/DeleteDatabaseCatalogRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/DeleteDatabaseCatalogRequest.java @@ -9,7 +9,7 @@ @Generated public class DeleteDatabaseCatalogRequest { - /** */ + /** The Unity Catalog name of the catalog to delete. */ @JsonIgnore private String name; public DeleteDatabaseCatalogRequest setName(String name) { diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/DeleteDatabaseInstanceRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/DeleteDatabaseInstanceRequest.java index 919f36b0a..e44460041 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/DeleteDatabaseInstanceRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/DeleteDatabaseInstanceRequest.java @@ -11,8 +11,9 @@ @Generated public class DeleteDatabaseInstanceRequest { /** - * By default, an instance cannot be deleted if it has descendant instances created via PITR. If - * this flag is specified as true, all descendent instances will be deleted as well. + * By default, an instance cannot be deleted if it has descendant instances created via PITR. + * Setting this flag to true is not supported and the request is rejected; delete the child + * instances first. */ @JsonIgnore @QueryParam("force") @@ -22,8 +23,8 @@ public class DeleteDatabaseInstanceRequest { @JsonIgnore private String name; /** - * Deprecated. Omitting the field or setting it to true will result in the field being hard - * deleted. Setting a value of false will throw a bad request. + * Deprecated: omitting the field or setting it to true hard deletes the instance. Setting it to + * false returns a bad request. */ @JsonIgnore @QueryParam("purge") diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/DeleteDatabaseTableRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/DeleteDatabaseTableRequest.java index fa719b7fa..2cc8692a2 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/DeleteDatabaseTableRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/DeleteDatabaseTableRequest.java @@ -9,7 +9,7 @@ @Generated public class DeleteDatabaseTableRequest { - /** */ + /** Specifies the database table by its full three-part (catalog, schema, table) name. */ @JsonIgnore private String name; public DeleteDatabaseTableRequest setName(String name) { diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/DeleteSyncedDatabaseTableRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/DeleteSyncedDatabaseTableRequest.java index e9023fbbd..f399640f5 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/DeleteSyncedDatabaseTableRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/DeleteSyncedDatabaseTableRequest.java @@ -10,10 +10,14 @@ @Generated public class DeleteSyncedDatabaseTableRequest { - /** */ + /** Specifies the synced table by its full three-part (catalog, schema, table) name. */ @JsonIgnore private String name; - /** Optional. When set to true, the actual PostgreSQL table will be dropped from the database. */ + /** + * When true, the Postgres table is also dropped from the database. When false, the synced table + * is unregistered from Unity Catalog and its pipeline stops syncing it, but the Postgres table + * and its data are kept. + */ @JsonIgnore @QueryParam("purge_data") private Boolean purgeData; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/FindDatabaseInstanceByUidRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/FindDatabaseInstanceByUidRequest.java index 06210fc7d..6a3a0b632 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/FindDatabaseInstanceByUidRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/FindDatabaseInstanceByUidRequest.java @@ -10,7 +10,7 @@ @Generated public class FindDatabaseInstanceByUidRequest { - /** UID of the cluster to get. */ + /** UID of the instance to get, as returned in the uid field of the instance. */ @JsonIgnore @QueryParam("uid") private String uid; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/GenerateDatabaseCredentialRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/GenerateDatabaseCredentialRequest.java index b9069139a..c92650822 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/GenerateDatabaseCredentialRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/GenerateDatabaseCredentialRequest.java @@ -12,23 +12,27 @@ @Generated public class GenerateDatabaseCredentialRequest { /** - * A set of UC permissions to add to the credential. We verify that the caller has the necessary - * permissions in UC and include a reference in the token. Postgres uses that token to give the - * connecting user additional grants to the Postgres resources that correspond to the UC - * resources. The UC resources need to be something that have a Postgres counterpart. For example, - * a synced table or a table in a UC database catalog. + * Unity Catalog permissions to embed in the credential. Databricks verifies that the caller holds + * each permission in Unity Catalog and records a reference to it in the token. When the user + * connects, Postgres grants them the matching privileges on the Postgres objects that back those + * Unity Catalog resources. Each resource must have a Postgres counterpart, such as a synced table + * or a table in a database catalog. */ @JsonProperty("claims") private Collection claims; /** - * Instances to request a credential for. At least one of instance_names or claims must be + * Names of the database instances to connect to with the credential. Every named instance must + * exist in the workspace, or the request fails. At least one of instance_names or claims must be * specified. */ @JsonProperty("instance_names") private Collection instanceNames; - /** */ + /** + * A client-generated identifier for this request, such as a UUID. The request fails when it is + * omitted. + */ @JsonProperty("request_id") private String requestId; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/GetDatabaseCatalogRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/GetDatabaseCatalogRequest.java index 95b33b025..697323c5c 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/GetDatabaseCatalogRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/GetDatabaseCatalogRequest.java @@ -9,7 +9,7 @@ @Generated public class GetDatabaseCatalogRequest { - /** */ + /** The Unity Catalog name of the catalog to retrieve. */ @JsonIgnore private String name; public GetDatabaseCatalogRequest setName(String name) { diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/GetDatabaseInstanceRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/GetDatabaseInstanceRequest.java index 4c66741c9..87082d46b 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/GetDatabaseInstanceRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/GetDatabaseInstanceRequest.java @@ -9,7 +9,7 @@ @Generated public class GetDatabaseInstanceRequest { - /** Name of the cluster to get. */ + /** Name of the instance to get. */ @JsonIgnore private String name; public GetDatabaseInstanceRequest setName(String name) { diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/GetDatabaseTableRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/GetDatabaseTableRequest.java index b2c0c89db..df95448ed 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/GetDatabaseTableRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/GetDatabaseTableRequest.java @@ -9,7 +9,7 @@ @Generated public class GetDatabaseTableRequest { - /** */ + /** Specifies the database table by its full three-part (catalog, schema, table) name. */ @JsonIgnore private String name; public GetDatabaseTableRequest setName(String name) { diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/GetSyncedDatabaseTableRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/GetSyncedDatabaseTableRequest.java index 045da6891..ad77ecc4f 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/GetSyncedDatabaseTableRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/GetSyncedDatabaseTableRequest.java @@ -9,7 +9,7 @@ @Generated public class GetSyncedDatabaseTableRequest { - /** */ + /** Specifies the synced table by its full three-part (catalog, schema, table) name. */ @JsonIgnore private String name; public GetSyncedDatabaseTableRequest setName(String name) { diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/ListDatabaseInstancesRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/ListDatabaseInstancesRequest.java index 8fe0c3652..7d834e4b9 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/ListDatabaseInstancesRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/ListDatabaseInstancesRequest.java @@ -10,7 +10,7 @@ @Generated public class ListDatabaseInstancesRequest { - /** Upper bound for items returned. The maximum value is 100. */ + /** Upper bound for items returned. Defaults to 100, which is also the maximum value. */ @JsonIgnore @QueryParam("page_size") private Long pageSize; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/RequestedClaims.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/RequestedClaims.java index d4c9dd181..01c77d05b 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/RequestedClaims.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/RequestedClaims.java @@ -10,11 +10,14 @@ @Generated public class RequestedClaims { - /** */ + /** + * The level of access that the credential grants on the listed resources. READ_ONLY covers SELECT + * on each table, along with USE SCHEMA on its schema and USE CATALOG on its catalog. + */ @JsonProperty("permission_set") private RequestedClaimsPermissionSet permissionSet; - /** */ + /** The Unity Catalog resources that the permission set applies to. */ @JsonProperty("resources") private Collection resources; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/RequestedClaimsPermissionSet.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/RequestedClaimsPermissionSet.java index e3532d1ff..1d6253a3e 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/RequestedClaimsPermissionSet.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/RequestedClaimsPermissionSet.java @@ -4,7 +4,7 @@ import com.databricks.sdk.support.Generated; -/** Might add WRITE in the future */ +/** The level of access that a claim grants on its resources. */ @Generated public enum RequestedClaimsPermissionSet { READ_ONLY, diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/RequestedResource.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/RequestedResource.java index e3c4ab6d8..b6c1b5ccc 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/RequestedResource.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/RequestedResource.java @@ -9,7 +9,10 @@ @Generated public class RequestedResource { - /** */ + /** + * The full three-level Unity Catalog name of the database table or synced table, in the form + * catalog.schema.table. + */ @JsonProperty("table_name") private String tableName; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/SyncedDatabaseTable.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/SyncedDatabaseTable.java index 5e85bb53a..03c14f817 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/SyncedDatabaseTable.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/SyncedDatabaseTable.java @@ -7,9 +7,19 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.util.Objects; +/** + * A synced table is a Postgres table in a Lakebase database instance that Databricks keeps in sync + * with a source table in Unity Catalog. A data synchronization pipeline loads the source data and + * then applies later changes according to the scheduling policy, so the table can serve low-latency + * queries without a hand-built ETL process. For an overview, see + * https://docs.databricks.com/aws/en/oltp/projects/sync-tables. + */ @Generated public class SyncedDatabaseTable { - /** Synced Table data synchronization status */ + /** + * Reports the status of the data synchronization pipeline that keeps this table in sync with its + * source, including the pipeline ID and the position of the last successful sync. + */ @JsonProperty("data_synchronization_status") private SyncedTableStatus dataSynchronizationStatus; @@ -25,8 +35,8 @@ public class SyncedDatabaseTable { /** * The name of the database instance that this table is registered to. This field is always - * returned, and for tables inside database catalogs is inferred database instance associated with - * the catalog. This is an output only field that contains the value computed from the input field + * returned; for tables inside database catalogs it is the database instance associated with the + * catalog. This is an output only field that contains the value computed from the input field * combined with server side defaults. Use the field without the effective_ prefix to set the * value. */ @@ -50,8 +60,9 @@ public class SyncedDatabaseTable { * will be rejected). * *

When creating a synced table in a standard catalog, this field is required. In this - * scenario, specifying this field will allow targeting an arbitrary postgres database. Note that - * this has implications for the `create_database_objects_is_missing` field in `spec`. + * scenario, specifying this field will allow targeting an arbitrary postgres database. If this + * database does not exist yet, it is created when `create_database_objects_if_missing` in `spec` + * is true. */ @JsonProperty("logical_database_name") private String logicalDatabaseName; @@ -60,7 +71,7 @@ public class SyncedDatabaseTable { @JsonProperty("name") private String name; - /** */ + /** Specifies the source table, the key columns and how the data synchronization pipeline runs. */ @JsonProperty("spec") private SyncedTableSpec spec; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/SyncedTableFailedStatus.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/SyncedTableFailedStatus.java index ff3ccaf29..8be17d507 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/SyncedTableFailedStatus.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/SyncedTableFailedStatus.java @@ -14,9 +14,8 @@ @Generated public class SyncedTableFailedStatus { /** - * The last source table Delta version that was successfully synced to the synced table. The last - * source table Delta version that was synced to the synced table. Only populated if the table is - * still synced and available for serving. + * The last source table Delta version that was successfully synced to the synced table. Only + * populated if the table is still synced and available for serving. */ @JsonProperty("last_processed_commit_version") private Long lastProcessedCommitVersion; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/SyncedTablePosition.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/SyncedTablePosition.java index 97402c518..c91660492 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/SyncedTablePosition.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/SyncedTablePosition.java @@ -9,7 +9,7 @@ @Generated public class SyncedTablePosition { - /** */ + /** Identifies the position in the source Delta table at the time of the last successful sync. */ @JsonProperty("delta_table_sync_info") private DeltaTableSyncInfo deltaTableSyncInfo; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/SyncedTableSpec.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/SyncedTableSpec.java index c2ad8abd5..b6066e1bd 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/SyncedTableSpec.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/SyncedTableSpec.java @@ -20,7 +20,8 @@ public class SyncedTableSpec { /** * If true, the synced table's logical database and schema resources in PG will be created if they - * do not already exist. + * do not already exist. The request fails if this is false and the database or schema does not + * exist. */ @JsonProperty("create_database_objects_if_missing") private Boolean createDatabaseObjectsIfMissing; @@ -48,11 +49,22 @@ public class SyncedTableSpec { @JsonProperty("new_pipeline_spec") private NewPipelineSpec newPipelineSpec; - /** Primary Key columns to be used for data insert/update in the destination. */ + /** + * The primary key columns are used to insert and update rows in the destination table. At least + * one column is required. Rows whose primary key columns contain null values are not synced, and + * the primary key cannot be changed after the table is created. + */ @JsonProperty("primary_key_columns") private Collection primaryKeyColumns; - /** Scheduling policy of the underlying pipeline. */ + /** + * Specifies the scheduling policy of the underlying pipeline. With CONTINUOUS, the pipeline keeps + * running and applies source changes as they happen. With TRIGGERED and SNAPSHOT, the pipeline + * stops after the initial load and syncs again only when it is run (manually, on a schedule or + * from a job); TRIGGERED applies source changes incrementally, while SNAPSHOT copies the full + * source table on every run. CONTINUOUS and TRIGGERED require the source table to provide a + * change data feed. + */ @JsonProperty("scheduling_policy") private SyncedTableSchedulingPolicy schedulingPolicy; @@ -60,7 +72,12 @@ public class SyncedTableSpec { @JsonProperty("source_table_full_name") private String sourceTableFullName; - /** Time series key to deduplicate (tie-break) rows with the same primary key. */ + /** + * The time series key deduplicates (tie-breaks) rows with the same primary key. When primary key + * values can repeat in the source table, the synced table keeps only the row with the latest + * value of this column for each primary key. The key cannot be changed after the table is + * created. + */ @JsonProperty("timeseries_key") private String timeseriesKey; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/SyncedTableStatus.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/SyncedTableStatus.java index 84ecf7c87..7f6315f54 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/SyncedTableStatus.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/SyncedTableStatus.java @@ -10,7 +10,11 @@ /** Status of a synced table. */ @Generated public class SyncedTableStatus { - /** */ + /** + * Provides detailed status for an online table with the CONTINUOUS scheduling policy. It is + * populated when detailed_state is SYNCED_TABLE_ONLINE_CONTINUOUS_UPDATE or + * SYNCED_TABLE_ONLINE_UPDATING_PIPELINE_RESOURCES. + */ @JsonProperty("continuous_update_status") private SyncedTableContinuousUpdateStatus continuousUpdateStatus; @@ -18,7 +22,11 @@ public class SyncedTableStatus { @JsonProperty("detailed_state") private SyncedTableState detailedState; - /** */ + /** + * Provides detailed status for a table whose data synchronization pipeline has failed. It is + * populated when detailed_state is SYNCED_TABLE_OFFLINE_FAILED or + * SYNCED_TABLE_ONLINE_PIPELINE_FAILED. + */ @JsonProperty("failed_status") private SyncedTableFailedStatus failedStatus; @@ -49,11 +57,19 @@ public class SyncedTableStatus { @JsonProperty("pipeline_id") private String pipelineId; - /** */ + /** + * Provides detailed status while the table is being provisioned. It is populated when + * detailed_state is SYNCED_TABLE_PROVISIONING_PIPELINE_RESOURCES or + * SYNCED_TABLE_PROVISIONING_INITIAL_SNAPSHOT. + */ @JsonProperty("provisioning_status") private SyncedTableProvisioningStatus provisioningStatus; - /** */ + /** + * Provides detailed status for an online table with the TRIGGERED or SNAPSHOT scheduling policy. + * It is populated when detailed_state is SYNCED_TABLE_ONLINE_TRIGGERED_UPDATE, + * SYNCED_TABLE_ONLINE_NO_PENDING_UPDATE or SYNCED_TABLE_ONLINE_UPDATING_PIPELINE_RESOURCES. + */ @JsonProperty("triggered_update_status") private SyncedTableTriggeredUpdateStatus triggeredUpdateStatus; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/UpdateDatabaseCatalogRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/UpdateDatabaseCatalogRequest.java index 49cca7c7a..5929e3a03 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/UpdateDatabaseCatalogRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/UpdateDatabaseCatalogRequest.java @@ -15,7 +15,7 @@ public class UpdateDatabaseCatalogRequest { @JsonProperty("database_catalog") private DatabaseCatalog databaseCatalog; - /** The name of the catalog in UC. */ + /** The name of the catalog in Unity Catalog. */ @JsonIgnore private String name; /** The list of fields to update. Setting this field is not yet supported. */ diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/UpdateDatabaseInstanceRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/UpdateDatabaseInstanceRequest.java index 6f2966edb..a66229015 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/UpdateDatabaseInstanceRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/database/UpdateDatabaseInstanceRequest.java @@ -11,16 +11,21 @@ @Generated public class UpdateDatabaseInstanceRequest { - /** */ + /** Specifies the instance to update, identified by its name. */ @JsonProperty("database_instance") private DatabaseInstance databaseInstance; - /** The name of the instance. This is the unique identifier for the instance. */ + /** + * The name of the instance. This is the unique identifier for the instance. Must be 1 to 63 + * characters long, contain only letters, digits and hyphens, start with a letter, and not contain + * consecutive hyphens. + */ @JsonIgnore private String name; /** - * The list of fields to update. If unspecified, all fields will be updated when possible. To wipe - * out custom_tags, specify custom_tags in the update_mask with an empty custom_tags map. + * The list of fields to update. If unspecified, all fields will be updated when possible. Use "*" + * to update every field. To wipe out custom_tags, specify custom_tags in the update_mask with an + * empty custom_tags list. */ @JsonIgnore @QueryParam("update_mask") diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/AiRuntimeTask.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/AiRuntimeTask.java index bc2ff419d..67e201adf 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/AiRuntimeTask.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/AiRuntimeTask.java @@ -77,9 +77,9 @@ public class AiRuntimeTask { private String mlflowRun; /** - * Scheduling priority class for the workload. May only be set together with a pre-provisioned - * capacity reservation (a deployment's `compute.provisioned_capacity_id`); it is rejected on a - * workload that runs on on-demand capacity. + * Scheduling priority class for the workload. May only be set together with a GPU Pool (a + * deployment's `compute.accelerator_pool_id` or legacy `compute.provisioned_capacity_id`); it is + * rejected on a workload that runs on on-demand capacity. */ @JsonProperty("priority_class") private AiRuntimeTaskPriorityClass priorityClass; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/ComputeSpec.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/ComputeSpec.java index fb65a9f85..3d7d1a476 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/ComputeSpec.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/ComputeSpec.java @@ -29,9 +29,8 @@ public class ComputeSpec { private ComputeSpecAcceleratorType acceleratorType; /** - * Optional ID of a pre-provisioned accelerator capacity reservation to run this AI Runtime - * workload on. When set, the workload is scheduled onto the referenced reserved capacity instead - * of the on-demand capacity shared among all Databricks customers. + * Legacy alias for `accelerator_pool_id`. Use `accelerator_pool_id` for new configurations. If + * both fields are set, they must contain the same ID. */ @JsonProperty("provisioned_capacity_id") private String provisionedCapacityId; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/CreateIssueRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/CreateIssueRequest.java index c8e2ed3d4..2832ab7e8 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/CreateIssueRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/CreateIssueRequest.java @@ -23,7 +23,10 @@ public class CreateIssueRequest { @QueryParam("issue_id") private String issueId; - /** experiments/{experiment} */ + /** + * The experiment to create the Issue in, as `experiments/{experiment}`, where `{experiment}` is + * the experiment ID. For example, `experiments/1234567890`. + */ @JsonIgnore private String parent; public CreateIssueRequest setIssue(Issue issue) { diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/DataSource.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/DataSource.java index 101d29049..7b9cc6443 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/DataSource.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/DataSource.java @@ -18,6 +18,10 @@ public class DataSource { @JsonProperty("feature_view_source") private FeatureViewSource featureViewSource; + /** A Unity Catalog managed or foreign Iceberg table source. */ + @JsonProperty("iceberg_table_source") + private IcebergTableSource icebergTableSource; + /** A Kafka stream data source. */ @JsonProperty("kafka_source") private KafkaSource kafkaSource; @@ -59,6 +63,15 @@ public FeatureViewSource getFeatureViewSource() { return featureViewSource; } + public DataSource setIcebergTableSource(IcebergTableSource icebergTableSource) { + this.icebergTableSource = icebergTableSource; + return this; + } + + public IcebergTableSource getIcebergTableSource() { + return icebergTableSource; + } + public DataSource setKafkaSource(KafkaSource kafkaSource) { this.kafkaSource = kafkaSource; return this; @@ -111,6 +124,7 @@ public boolean equals(Object o) { DataSource that = (DataSource) o; return Objects.equals(deltaTableSource, that.deltaTableSource) && Objects.equals(featureViewSource, that.featureViewSource) + && Objects.equals(icebergTableSource, that.icebergTableSource) && Objects.equals(kafkaSource, that.kafkaSource) && Objects.equals(lateness, that.lateness) && Objects.equals(requestSource, that.requestSource) @@ -123,6 +137,7 @@ public int hashCode() { return Objects.hash( deltaTableSource, featureViewSource, + icebergTableSource, kafkaSource, lateness, requestSource, @@ -135,6 +150,7 @@ public String toString() { return new ToStringer(DataSource.class) .add("deltaTableSource", deltaTableSource) .add("featureViewSource", featureViewSource) + .add("icebergTableSource", icebergTableSource) .add("kafkaSource", kafkaSource) .add("lateness", lateness) .add("requestSource", requestSource) diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/GetIssueRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/GetIssueRequest.java index a4d27c208..b67fc5b1e 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/GetIssueRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/GetIssueRequest.java @@ -9,7 +9,11 @@ @Generated public class GetIssueRequest { - /** experiments/{experiment}/issues/{issue} */ + /** + * The Issue to get, as `experiments/{experiment}/issues/{issue}`, where `{experiment}` is the + * experiment ID and `{issue}` is the Issue ID: `iss-` followed by 32 lowercase hex digits. For + * example, `experiments/1234567890/issues/iss-0123456789abcdef0123456789abcdef`. + */ @JsonIgnore private String name; public GetIssueRequest setName(String name) { diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/IcebergTableSource.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/IcebergTableSource.java new file mode 100644 index 000000000..9fffb453b --- /dev/null +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/IcebergTableSource.java @@ -0,0 +1,104 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. + +package com.databricks.sdk.service.ml; + +import com.databricks.sdk.support.Generated; +import com.databricks.sdk.support.ToStringer; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.Objects; + +/** + * A Unity Catalog managed or foreign Iceberg table, in Iceberg v2 or v3 format. Table identity, + * format, schema, and permissions are resolved through Unity Catalog. + */ +@Generated +public class IcebergTableSource { + /** + * Schema of the resulting dataframe after transformations, in Spark StructType JSON format (from + * df.schema.json()). Required if transformation_sql is specified. Example: + * {"type":"struct","fields":[{"name":"col_a","type":"integer","nullable":true,"metadata":{}},{"name":"col_c","type":"integer","nullable":true,"metadata":{}}]} + */ + @JsonProperty("dataframe_schema") + private String dataframeSchema; + + /** + * A single WHERE clause to filter the Iceberg table before applying transformations. The + * predicate is evaluated for each row. + */ + @JsonProperty("filter_condition") + private String filterCondition; + + /** Full three-part name of the source table. May be omitted on reads when inaccessible. */ + @JsonProperty("full_name") + private String fullName; + + /** + * A single SQL SELECT expression applied after filter_condition. The expression must contain all + * required columns (e.g., "*, col_a + col_b AS col_c"). If transformation_sql is not provided, + * all columns of the Iceberg table are present in the DataSource dataframe. + */ + @JsonProperty("transformation_sql") + private String transformationSql; + + public IcebergTableSource setDataframeSchema(String dataframeSchema) { + this.dataframeSchema = dataframeSchema; + return this; + } + + public String getDataframeSchema() { + return dataframeSchema; + } + + public IcebergTableSource setFilterCondition(String filterCondition) { + this.filterCondition = filterCondition; + return this; + } + + public String getFilterCondition() { + return filterCondition; + } + + public IcebergTableSource setFullName(String fullName) { + this.fullName = fullName; + return this; + } + + public String getFullName() { + return fullName; + } + + public IcebergTableSource setTransformationSql(String transformationSql) { + this.transformationSql = transformationSql; + return this; + } + + public String getTransformationSql() { + return transformationSql; + } + + @Override + public boolean equals(Object o) { + if (this == o) return true; + if (o == null || getClass() != o.getClass()) return false; + IcebergTableSource that = (IcebergTableSource) o; + return Objects.equals(dataframeSchema, that.dataframeSchema) + && Objects.equals(filterCondition, that.filterCondition) + && Objects.equals(fullName, that.fullName) + && Objects.equals(transformationSql, that.transformationSql); + } + + @Override + public int hashCode() { + return Objects.hash(dataframeSchema, filterCondition, fullName, transformationSql); + } + + @Override + public String toString() { + return new ToStringer(IcebergTableSource.class) + .add("dataframeSchema", dataframeSchema) + .add("filterCondition", filterCondition) + .add("fullName", fullName) + .add("transformationSql", transformationSql) + .toString(); + } +} diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/Issue.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/Issue.java index b4c0f74a3..ad0b28168 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/Issue.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/Issue.java @@ -58,7 +58,11 @@ public class Issue { @JsonProperty("metadata") private Map metadata; - /** experiments/{experiment}/issues/{issue} */ + /** + * The Issue's resource name, as `experiments/{experiment}/issues/{issue}`, where `{experiment}` + * is the experiment ID and `{issue}` is the Issue ID: `iss-` followed by 32 lowercase hex digits. + * For example, `experiments/1234567890/issues/iss-0123456789abcdef0123456789abcdef`. + */ @JsonProperty("name") private String name; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/SearchIssuesRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/SearchIssuesRequest.java index e9ddcea69..2e2173cb0 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/SearchIssuesRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/SearchIssuesRequest.java @@ -27,7 +27,10 @@ public class SearchIssuesRequest { @JsonProperty("page_token") private String pageToken; - /** experiments/{experiment} */ + /** + * The experiment to search, as `experiments/{experiment}`, where `{experiment}` is the experiment + * ID. For example, `experiments/1234567890`. + */ @JsonIgnore private String parent; /** Case-insensitive substring match on title. */ diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/UpdateIssueRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/UpdateIssueRequest.java index 60b12d23d..9dfee227d 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/UpdateIssueRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/UpdateIssueRequest.java @@ -16,7 +16,11 @@ public class UpdateIssueRequest { @JsonProperty("issue") private Issue issue; - /** experiments/{experiment}/issues/{issue} */ + /** + * The Issue's resource name, as `experiments/{experiment}/issues/{issue}`, where `{experiment}` + * is the experiment ID and `{issue}` is the Issue ID: `iss-` followed by 32 lowercase hex digits. + * For example, `experiments/1234567890/issues/iss-0123456789abcdef0123456789abcdef`. + */ @JsonIgnore private String name; /** diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/CreateCustomAppIntegration.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/CreateCustomAppIntegration.java index a1c47bb8a..49b14f1fd 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/CreateCustomAppIntegration.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/CreateCustomAppIntegration.java @@ -11,7 +11,8 @@ @Generated public class CreateCustomAppIntegration { /** - * This field indicates whether an OAuth client secret is required to authenticate this client. + * Whether to create a confidential client that authenticates with a client secret. Public clients + * receive no client secret. */ @JsonProperty("confidential") private Boolean confidential; @@ -20,18 +21,26 @@ public class CreateCustomAppIntegration { @JsonProperty("name") private String name; - /** List of OAuth redirect urls */ + /** + * OAuth redirect URLs for the application. Each URL must use https, except loopback URLs + * (localhost, 127.0.0.1 or ::1), which may use http. At most 100 URLs of at most 256 characters + * each. + */ @JsonProperty("redirect_urls") private Collection redirectUrls; /** - * OAuth scopes granted to the application. Supported scopes: all-apis, sql, offline_access, - * openid, profile, email. + * OAuth scopes granted to the application. At least one scope is required. Supported scopes: + * all-apis, sql, offline_access, openid, profile, email, and the fine-grained API scopes listed + * at https://docs.databricks.com/api/account/scopes. */ @JsonProperty("scopes") private Collection scopes; - /** Token access policy */ + /** + * Lifetimes of the tokens issued to the application. If omitted, access tokens are valid for 60 + * minutes and refresh tokens for 7 days (10080 minutes). If set, both TTL fields are required. + */ @JsonProperty("token_access_policy") private TokenAccessPolicy tokenAccessPolicy; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/CreateCustomAppIntegrationOutput.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/CreateCustomAppIntegrationOutput.java index 7ea7eeccf..1c88605ac 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/CreateCustomAppIntegrationOutput.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/CreateCustomAppIntegrationOutput.java @@ -9,13 +9,13 @@ @Generated public class CreateCustomAppIntegrationOutput { - /** OAuth client-id generated by the Databricks */ + /** OAuth client ID generated by Databricks. */ @JsonProperty("client_id") private String clientId; /** - * OAuth client-secret generated by the Databricks. If this is a confidential OAuth app - * client-secret will be generated. + * OAuth client secret generated by Databricks for confidential apps; empty for public apps. It is + * only returned in this response and cannot be retrieved later, so store it securely. */ @JsonProperty("client_secret") private String clientSecret; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/CustomAppIntegrationAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/CustomAppIntegrationAPI.java index 57cd17c5b..05f274ea5 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/CustomAppIntegrationAPI.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/CustomAppIntegrationAPI.java @@ -61,7 +61,7 @@ public GetCustomAppIntegrationOutput get(GetCustomAppIntegrationRequest request) return impl.get(request); } - /** Get the list of custom OAuth app integrations for the specified Databricks account */ + /** Get the list of custom OAuth app integrations for the specified Databricks account. */ public Iterable list(ListCustomAppIntegrationsRequest request) { return Paginator.newTokenPagination( request, diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/CustomAppIntegrationService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/CustomAppIntegrationService.java index 6f738f533..5b9c70fe3 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/CustomAppIntegrationService.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/CustomAppIntegrationService.java @@ -33,7 +33,7 @@ public interface CustomAppIntegrationService { /** Gets the Custom OAuth App Integration for the given integration id. */ GetCustomAppIntegrationOutput get(GetCustomAppIntegrationRequest getCustomAppIntegrationRequest); - /** Get the list of custom OAuth app integrations for the specified Databricks account */ + /** Get the list of custom OAuth app integrations for the specified Databricks account. */ GetCustomAppIntegrationsOutput list( ListCustomAppIntegrationsRequest listCustomAppIntegrationsRequest); diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/DeleteCustomAppIntegrationRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/DeleteCustomAppIntegrationRequest.java index e9d5140a0..9991576b0 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/DeleteCustomAppIntegrationRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/DeleteCustomAppIntegrationRequest.java @@ -9,7 +9,7 @@ @Generated public class DeleteCustomAppIntegrationRequest { - /** */ + /** ID of the custom OAuth app integration to delete. */ @JsonIgnore private String integrationId; public DeleteCustomAppIntegrationRequest setIntegrationId(String integrationId) { diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/GetCustomAppIntegrationOutput.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/GetCustomAppIntegrationOutput.java index b085c10d1..25b0b9e5e 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/GetCustomAppIntegrationOutput.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/GetCustomAppIntegrationOutput.java @@ -10,25 +10,29 @@ @Generated public class GetCustomAppIntegrationOutput { - /** The client id of the custom OAuth app */ + /** OAuth client ID that the application uses as client_id in the OAuth flow. */ @JsonProperty("client_id") private String clientId; /** - * This field indicates whether an OAuth client secret is required to authenticate this client. + * Whether the application is a confidential client that authenticates with a client secret. + * Public clients have no client secret. */ @JsonProperty("confidential") private Boolean confidential; - /** */ + /** Time the integration was created, as an ISO 8601 timestamp. */ @JsonProperty("create_time") private String createTime; - /** */ + /** ID of the user who created the integration. */ @JsonProperty("created_by") private Long createdBy; - /** */ + /** + * Username of the user who created the integration. Only returned by the list method when + * include_creator_username is true. + */ @JsonProperty("creator_username") private String creatorUsername; @@ -40,15 +44,15 @@ public class GetCustomAppIntegrationOutput { @JsonProperty("name") private String name; - /** List of OAuth redirect urls */ + /** OAuth redirect URLs the application is allowed to use in the authorization flow. */ @JsonProperty("redirect_urls") private Collection redirectUrls; - /** */ + /** OAuth scopes the application is allowed to request. */ @JsonProperty("scopes") private Collection scopes; - /** Token access policy */ + /** Lifetimes of the access and refresh tokens issued to the application. */ @JsonProperty("token_access_policy") private TokenAccessPolicy tokenAccessPolicy; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/GetCustomAppIntegrationsOutput.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/GetCustomAppIntegrationsOutput.java index f2e313bf2..7d78b9d3f 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/GetCustomAppIntegrationsOutput.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/GetCustomAppIntegrationsOutput.java @@ -14,7 +14,7 @@ public class GetCustomAppIntegrationsOutput { @JsonProperty("apps") private Collection apps; - /** */ + /** Token for the next page of results. If not present, there are no more results to show. */ @JsonProperty("next_page_token") private String nextPageToken; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/ListCustomAppIntegrationsRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/ListCustomAppIntegrationsRequest.java index 0ade6f297..1a44cbf20 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/ListCustomAppIntegrationsRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/ListCustomAppIntegrationsRequest.java @@ -10,17 +10,19 @@ @Generated public class ListCustomAppIntegrationsRequest { - /** */ + /** When true, each returned integration includes creator_username. */ @JsonIgnore @QueryParam("include_creator_username") private Boolean includeCreatorUsername; - /** */ + /** Maximum number of integrations to return in one page, at most 1000. */ @JsonIgnore @QueryParam("page_size") private Long pageSize; - /** */ + /** + * Token from the next_page_token field of a previous response. Omit it to request the first page. + */ @JsonIgnore @QueryParam("page_token") private String pageToken; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/TokenAccessPolicy.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/TokenAccessPolicy.java index 3b8602ead..bc417e037 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/TokenAccessPolicy.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/TokenAccessPolicy.java @@ -10,16 +10,17 @@ @Generated public class TokenAccessPolicy { /** - * Absolute OAuth session TTL in minutes. Effective only when the single-use refresh token feature - * is enabled. This is the absolute TTL of all refresh tokens issued in one OAuth session. When a - * new refresh token is issued during refresh token rotation, it will inherit the same absolute - * TTL as the old refresh token. In other words, this represents the maximum amount of time a user - * can stay logged in without re-authenticating. + * Absolute OAuth session TTL in minutes. Can only be set when enable_single_use_refresh_tokens is + * true, and must be at least refresh_token_ttl_in_minutes and at most 525600 (one year). This is + * the absolute TTL of all refresh tokens issued in one OAuth session. When a new refresh token is + * issued during refresh token rotation, it will inherit the same absolute TTL as the old refresh + * token. In other words, this represents the maximum amount of time a user can stay logged in + * without re-authenticating. */ @JsonProperty("absolute_session_lifetime_in_minutes") private Long absoluteSessionLifetimeInMinutes; - /** access token time to live in minutes */ + /** Lifetime of access tokens, in minutes. */ @JsonProperty("access_token_ttl_in_minutes") private Long accessTokenTtlInMinutes; @@ -34,9 +35,10 @@ public class TokenAccessPolicy { private Boolean enableSingleUseRefreshTokens; /** - * Refresh token time to live in minutes. When single-use refresh tokens are enabled, this - * represents the TTL of an individual refresh token. If the refresh token is used before it - * expires, a new one is issued with a renewed individual TTL. + * Lifetime of refresh tokens, in minutes. Must not be shorter than access_token_ttl_in_minutes. + * When single-use refresh tokens are enabled, this represents the TTL of an individual refresh + * token. If the refresh token is used before it expires, a new one is issued with a renewed + * individual TTL. */ @JsonProperty("refresh_token_ttl_in_minutes") private Long refreshTokenTtlInMinutes; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/UpdateCustomAppIntegration.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/UpdateCustomAppIntegration.java index e310550a4..6dddeb1ec 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/UpdateCustomAppIntegration.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/oauth2/UpdateCustomAppIntegration.java @@ -11,10 +11,13 @@ @Generated public class UpdateCustomAppIntegration { - /** */ + /** ID of the custom OAuth app integration to update. */ @JsonIgnore private String integrationId; - /** List of OAuth redirect urls to be updated in the custom OAuth app integration */ + /** + * New OAuth redirect URLs for the application. Replaces the existing list; same constraints as on + * create. + */ @JsonProperty("redirect_urls") private Collection redirectUrls; @@ -25,7 +28,10 @@ public class UpdateCustomAppIntegration { @JsonProperty("scopes") private Collection scopes; - /** Token access policy to be updated in the custom OAuth app integration */ + /** + * New token lifetimes for the application. Both TTL fields are required when the policy is set; + * the single-use refresh token settings keep their current values when omitted. + */ @JsonProperty("token_access_policy") private TokenAccessPolicy tokenAccessPolicy; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/ApplyEnvironmentRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/ApplyEnvironmentRequest.java index 00ce73ecb..522802f64 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/ApplyEnvironmentRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/ApplyEnvironmentRequest.java @@ -9,7 +9,7 @@ @Generated public class ApplyEnvironmentRequest { - /** */ + /** The ID of the pipeline to apply the environment to. */ @JsonIgnore private String pipelineId; public ApplyEnvironmentRequest setPipelineId(String pipelineId) { diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/ClonePipelineRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/ClonePipelineRequest.java index 9ecce1af1..26c344530 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/ClonePipelineRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/ClonePipelineRequest.java @@ -16,20 +16,27 @@ public class ClonePipelineRequest { @JsonProperty("allow_duplicate_names") private Boolean allowDuplicateNames; - /** Budget policy of this pipeline. */ + /** + * ID (UUID) of the serverless budget policy applied to this pipeline. Only supported for + * serverless pipelines. + */ @JsonProperty("budget_policy_id") private String budgetPolicyId; /** - * A catalog in Unity Catalog to publish data from this pipeline to. If `target` is specified, - * tables in this pipeline are published to a `target` schema inside `catalog` (for example, - * `catalog`.`target`.`table`). If `target` is not specified, no data is published to Unity - * Catalog. + * A catalog in Unity Catalog to publish data from this pipeline to. Tables are published to the + * schema set in `schema` (or the legacy `target`) inside this catalog, for example + * `catalog`.`schema`.`table`; source code can also use fully qualified names to write to other + * schemas and catalogs. If `catalog` is not specified, the pipeline uses the legacy Hive + * metastore. */ @JsonProperty("catalog") private String catalog; - /** SDP Release Channel that specifies which version to use. */ + /** + * Release channel that selects the pipeline runtime version: `CURRENT` (the default) or + * `PREVIEW`, which runs on the upcoming runtime release. + */ @JsonProperty("channel") private String channel; @@ -70,7 +77,10 @@ public class ClonePipelineRequest { @JsonProperty("development") private Boolean development; - /** Pipeline product edition. */ + /** + * Pipeline product edition: `CORE`, `PRO`, or `ADVANCED`. Serverless pipelines require + * `ADVANCED`. + */ @JsonProperty("edition") private String edition; @@ -184,6 +194,10 @@ public class ClonePipelineRequest { @JsonProperty("target") private String target; + /** Test configuration for this pipeline. Used only by test-only updates. */ + @JsonProperty("testing") + private PipelineTesting testing; + /** Which pipeline trigger to use. Deprecated: Use `continuous` instead. */ @JsonProperty("trigger") private PipelineTrigger trigger; @@ -482,6 +496,15 @@ public String getTarget() { return target; } + public ClonePipelineRequest setTesting(PipelineTesting testing) { + this.testing = testing; + return this; + } + + public PipelineTesting getTesting() { + return testing; + } + public ClonePipelineRequest setTrigger(PipelineTrigger trigger) { this.trigger = trigger; return this; @@ -537,6 +560,7 @@ public boolean equals(Object o) { && Objects.equals(storage, that.storage) && Objects.equals(tags, that.tags) && Objects.equals(target, that.target) + && Objects.equals(testing, that.testing) && Objects.equals(trigger, that.trigger) && Objects.equals(usagePolicyId, that.usagePolicyId); } @@ -576,6 +600,7 @@ public int hashCode() { storage, tags, target, + testing, trigger, usagePolicyId); } @@ -615,6 +640,7 @@ public String toString() { .add("storage", storage) .add("tags", tags) .add("target", target) + .add("testing", testing) .add("trigger", trigger) .add("usagePolicyId", usagePolicyId) .toString(); diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/CreatePipeline.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/CreatePipeline.java index c7b5d6e84..6d6328af4 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/CreatePipeline.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/CreatePipeline.java @@ -15,20 +15,27 @@ public class CreatePipeline { @JsonProperty("allow_duplicate_names") private Boolean allowDuplicateNames; - /** Budget policy of this pipeline. */ + /** + * ID (UUID) of the serverless budget policy applied to this pipeline. Only supported for + * serverless pipelines. + */ @JsonProperty("budget_policy_id") private String budgetPolicyId; /** - * A catalog in Unity Catalog to publish data from this pipeline to. If `target` is specified, - * tables in this pipeline are published to a `target` schema inside `catalog` (for example, - * `catalog`.`target`.`table`). If `target` is not specified, no data is published to Unity - * Catalog. + * A catalog in Unity Catalog to publish data from this pipeline to. Tables are published to the + * schema set in `schema` (or the legacy `target`) inside this catalog, for example + * `catalog`.`schema`.`table`; source code can also use fully qualified names to write to other + * schemas and catalogs. If `catalog` is not specified, the pipeline uses the legacy Hive + * metastore. */ @JsonProperty("catalog") private String catalog; - /** SDP Release Channel that specifies which version to use. */ + /** + * Release channel that selects the pipeline runtime version: `CURRENT` (the default) or + * `PREVIEW`, which runs on the upcoming runtime release. + */ @JsonProperty("channel") private String channel; @@ -65,11 +72,17 @@ public class CreatePipeline { @JsonProperty("development") private Boolean development; - /** */ + /** + * If true, no pipeline is created. The response contains the settings that would be applied, with + * server defaults filled in, instead of a pipeline ID. + */ @JsonProperty("dry_run") private Boolean dryRun; - /** Pipeline product edition. */ + /** + * Pipeline product edition: `CORE`, `PRO`, or `ADVANCED`. Serverless pipelines require + * `ADVANCED`. + */ @JsonProperty("edition") private String edition; @@ -143,7 +156,10 @@ public class CreatePipeline { @JsonProperty("root_path") private String rootPath; - /** */ + /** + * The user or service principal that the pipeline runs as. If not specified, the pipeline runs as + * the user who created the pipeline. + */ @JsonProperty("run_as") private RunAs runAs; @@ -184,6 +200,10 @@ public class CreatePipeline { @JsonProperty("target") private String target; + /** Test configuration for this pipeline. Used only by test-only updates. */ + @JsonProperty("testing") + private PipelineTesting testing; + /** Which pipeline trigger to use. Deprecated: Use `continuous` instead. */ @JsonProperty("trigger") private PipelineTrigger trigger; @@ -480,6 +500,15 @@ public String getTarget() { return target; } + public CreatePipeline setTesting(PipelineTesting testing) { + this.testing = testing; + return this; + } + + public PipelineTesting getTesting() { + return testing; + } + public CreatePipeline setTrigger(PipelineTrigger trigger) { this.trigger = trigger; return this; @@ -535,6 +564,7 @@ public boolean equals(Object o) { && Objects.equals(storage, that.storage) && Objects.equals(tags, that.tags) && Objects.equals(target, that.target) + && Objects.equals(testing, that.testing) && Objects.equals(trigger, that.trigger) && Objects.equals(usagePolicyId, that.usagePolicyId); } @@ -574,6 +604,7 @@ public int hashCode() { storage, tags, target, + testing, trigger, usagePolicyId); } @@ -613,6 +644,7 @@ public String toString() { .add("storage", storage) .add("tags", tags) .add("target", target) + .add("testing", testing) .add("trigger", trigger) .add("usagePolicyId", usagePolicyId) .toString(); diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/DeletePipelineRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/DeletePipelineRequest.java index 59948761f..6a068e4ef 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/DeletePipelineRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/DeletePipelineRequest.java @@ -26,7 +26,7 @@ public class DeletePipelineRequest { @QueryParam("force") private Boolean force; - /** */ + /** The ID of the pipeline to delete. */ @JsonIgnore private String pipelineId; public DeletePipelineRequest setCascade(Boolean cascade) { diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/EditPipeline.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/EditPipeline.java index 7e7da66ff..16b722160 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/EditPipeline.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/EditPipeline.java @@ -18,20 +18,27 @@ public class EditPipeline { @JsonProperty("allow_duplicate_names") private Boolean allowDuplicateNames; - /** Budget policy of this pipeline. */ + /** + * ID (UUID) of the serverless budget policy applied to this pipeline. Only supported for + * serverless pipelines. + */ @JsonProperty("budget_policy_id") private String budgetPolicyId; /** - * A catalog in Unity Catalog to publish data from this pipeline to. If `target` is specified, - * tables in this pipeline are published to a `target` schema inside `catalog` (for example, - * `catalog`.`target`.`table`). If `target` is not specified, no data is published to Unity - * Catalog. + * A catalog in Unity Catalog to publish data from this pipeline to. Tables are published to the + * schema set in `schema` (or the legacy `target`) inside this catalog, for example + * `catalog`.`schema`.`table`; source code can also use fully qualified names to write to other + * schemas and catalogs. If `catalog` is not specified, the pipeline uses the legacy Hive + * metastore. */ @JsonProperty("catalog") private String catalog; - /** SDP Release Channel that specifies which version to use. */ + /** + * Release channel that selects the pipeline runtime version: `CURRENT` (the default) or + * `PREVIEW`, which runs on the upcoming runtime release. + */ @JsonProperty("channel") private String channel; @@ -68,7 +75,10 @@ public class EditPipeline { @JsonProperty("development") private Boolean development; - /** Pipeline product edition. */ + /** + * Pipeline product edition: `CORE`, `PRO`, or `ADVANCED`. Serverless pipelines require + * `ADVANCED`. + */ @JsonProperty("edition") private String edition; @@ -152,7 +162,7 @@ public class EditPipeline { @JsonProperty("root_path") private String rootPath; - /** */ + /** The user or service principal that the pipeline runs as. */ @JsonProperty("run_as") private RunAs runAs; @@ -193,6 +203,10 @@ public class EditPipeline { @JsonProperty("target") private String target; + /** Test configuration for this pipeline. Used only by test-only updates. */ + @JsonProperty("testing") + private PipelineTesting testing; + /** Which pipeline trigger to use. Deprecated: Use `continuous` instead. */ @JsonProperty("trigger") private PipelineTrigger trigger; @@ -498,6 +512,15 @@ public String getTarget() { return target; } + public EditPipeline setTesting(PipelineTesting testing) { + this.testing = testing; + return this; + } + + public PipelineTesting getTesting() { + return testing; + } + public EditPipeline setTrigger(PipelineTrigger trigger) { this.trigger = trigger; return this; @@ -554,6 +577,7 @@ public boolean equals(Object o) { && Objects.equals(storage, that.storage) && Objects.equals(tags, that.tags) && Objects.equals(target, that.target) + && Objects.equals(testing, that.testing) && Objects.equals(trigger, that.trigger) && Objects.equals(usagePolicyId, that.usagePolicyId); } @@ -594,6 +618,7 @@ public int hashCode() { storage, tags, target, + testing, trigger, usagePolicyId); } @@ -634,6 +659,7 @@ public String toString() { .add("storage", storage) .add("tags", tags) .add("target", target) + .add("testing", testing) .add("trigger", trigger) .add("usagePolicyId", usagePolicyId) .toString(); diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/GetPipelineRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/GetPipelineRequest.java index 05304a860..065a34cef 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/GetPipelineRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/GetPipelineRequest.java @@ -9,7 +9,7 @@ @Generated public class GetPipelineRequest { - /** */ + /** The ID of the pipeline. */ @JsonIgnore private String pipelineId; public GetPipelineRequest setPipelineId(String pipelineId) { diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/ListUpdatesResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/ListUpdatesResponse.java index 191a24100..f77d3bad2 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/ListUpdatesResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/ListUpdatesResponse.java @@ -21,7 +21,7 @@ public class ListUpdatesResponse { @JsonProperty("prev_page_token") private String prevPageToken; - /** */ + /** The updates for the pipeline, ordered with the newest update first. */ @JsonProperty("updates") private Collection updates; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/PipelineSpec.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/PipelineSpec.java index 4e4c9aa23..dd68a08f6 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/PipelineSpec.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/PipelineSpec.java @@ -11,20 +11,27 @@ @Generated public class PipelineSpec { - /** Budget policy of this pipeline. */ + /** + * ID (UUID) of the serverless budget policy applied to this pipeline. Only supported for + * serverless pipelines. + */ @JsonProperty("budget_policy_id") private String budgetPolicyId; /** - * A catalog in Unity Catalog to publish data from this pipeline to. If `target` is specified, - * tables in this pipeline are published to a `target` schema inside `catalog` (for example, - * `catalog`.`target`.`table`). If `target` is not specified, no data is published to Unity - * Catalog. + * A catalog in Unity Catalog to publish data from this pipeline to. Tables are published to the + * schema set in `schema` (or the legacy `target`) inside this catalog, for example + * `catalog`.`schema`.`table`; source code can also use fully qualified names to write to other + * schemas and catalogs. If `catalog` is not specified, the pipeline uses the legacy Hive + * metastore. */ @JsonProperty("catalog") private String catalog; - /** SDP Release Channel that specifies which version to use. */ + /** + * Release channel that selects the pipeline runtime version: `CURRENT` (the default) or + * `PREVIEW`, which runs on the upcoming runtime release. + */ @JsonProperty("channel") private String channel; @@ -61,7 +68,10 @@ public class PipelineSpec { @JsonProperty("development") private Boolean development; - /** Pipeline product edition. */ + /** + * Pipeline product edition: `CORE`, `PRO`, or `ADVANCED`. Serverless pipelines require + * `ADVANCED`. + */ @JsonProperty("edition") private String edition; @@ -165,6 +175,10 @@ public class PipelineSpec { @JsonProperty("target") private String target; + /** Test configuration for this pipeline. Used only by test-only updates. */ + @JsonProperty("testing") + private PipelineTesting testing; + /** Which pipeline trigger to use. Deprecated: Use `continuous` instead. */ @JsonProperty("trigger") private PipelineTrigger trigger; @@ -425,6 +439,15 @@ public String getTarget() { return target; } + public PipelineSpec setTesting(PipelineTesting testing) { + this.testing = testing; + return this; + } + + public PipelineTesting getTesting() { + return testing; + } + public PipelineSpec setTrigger(PipelineTrigger trigger) { this.trigger = trigger; return this; @@ -476,6 +499,7 @@ public boolean equals(Object o) { && Objects.equals(storage, that.storage) && Objects.equals(tags, that.tags) && Objects.equals(target, that.target) + && Objects.equals(testing, that.testing) && Objects.equals(trigger, that.trigger) && Objects.equals(usagePolicyId, that.usagePolicyId); } @@ -511,6 +535,7 @@ public int hashCode() { storage, tags, target, + testing, trigger, usagePolicyId); } @@ -546,6 +571,7 @@ public String toString() { .add("storage", storage) .add("tags", tags) .add("target", target) + .add("testing", testing) .add("trigger", trigger) .add("usagePolicyId", usagePolicyId) .toString(); diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/PipelineStateInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/PipelineStateInfo.java index c454b4208..c847b33e8 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/PipelineStateInfo.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/PipelineStateInfo.java @@ -41,7 +41,7 @@ public class PipelineStateInfo { @JsonProperty("run_as_user_name") private String runAsUserName; - /** */ + /** The current state of the pipeline. */ @JsonProperty("state") private PipelineState state; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/PipelineTestEnvironment.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/PipelineTestEnvironment.java new file mode 100644 index 000000000..90ea919db --- /dev/null +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/PipelineTestEnvironment.java @@ -0,0 +1,51 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. + +package com.databricks.sdk.service.pipelines; + +import com.databricks.sdk.support.Generated; +import com.databricks.sdk.support.ToStringer; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.Collection; +import java.util.Objects; + +/** The packages that a pipeline's tests need in addition to the pipeline's environment. */ +@Generated +public class PipelineTestEnvironment { + /** + * A list of files that declare the packages the tests need: a project folder, a requirements + * file, or a wheel, in the workspace or a UC volume. A project folder can take `--editable` and + * an extra, for example `--editable /Workspace/Users/someone@example.com/orders[test]`. Package + * names, such as `faker==33.0`, and URLs are rejected. + */ + @JsonProperty("dependencies") + private Collection dependencies; + + public PipelineTestEnvironment setDependencies(Collection dependencies) { + this.dependencies = dependencies; + return this; + } + + public Collection getDependencies() { + return dependencies; + } + + @Override + public boolean equals(Object o) { + if (this == o) return true; + if (o == null || getClass() != o.getClass()) return false; + PipelineTestEnvironment that = (PipelineTestEnvironment) o; + return Objects.equals(dependencies, that.dependencies); + } + + @Override + public int hashCode() { + return Objects.hash(dependencies); + } + + @Override + public String toString() { + return new ToStringer(PipelineTestEnvironment.class) + .add("dependencies", dependencies) + .toString(); + } +} diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/PipelineTestOptions.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/PipelineTestOptions.java new file mode 100644 index 000000000..bf2be6dd6 --- /dev/null +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/PipelineTestOptions.java @@ -0,0 +1,69 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. + +package com.databricks.sdk.service.pipelines; + +import com.databricks.sdk.support.Generated; +import com.databricks.sdk.support.ToStringer; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.Collection; +import java.util.Objects; + +/** Options for selecting the tests that a test-only update runs. */ +@Generated +public class PipelineTestOptions { + /** + * A list of arguments to pass to pytest, for example `["-m", "slow"]`. Only `-k` and `-m` are + * accepted, each followed by its value. Other arguments are rejected. + */ + @JsonProperty("pytest_args") + private Collection pytestArgs; + + /** + * A list of test files or folders to run, as absolute workspace paths inside the pipeline's test + * sources. A path outside the test sources is rejected. To run one test, append `::` and the test + * name to a file path, for example `/Workspace/orders/tests/test_orders.py::test_backfill`. When + * empty, every test in the test sources runs. + */ + @JsonProperty("test_selection") + private Collection testSelection; + + public PipelineTestOptions setPytestArgs(Collection pytestArgs) { + this.pytestArgs = pytestArgs; + return this; + } + + public Collection getPytestArgs() { + return pytestArgs; + } + + public PipelineTestOptions setTestSelection(Collection testSelection) { + this.testSelection = testSelection; + return this; + } + + public Collection getTestSelection() { + return testSelection; + } + + @Override + public boolean equals(Object o) { + if (this == o) return true; + if (o == null || getClass() != o.getClass()) return false; + PipelineTestOptions that = (PipelineTestOptions) o; + return Objects.equals(pytestArgs, that.pytestArgs) + && Objects.equals(testSelection, that.testSelection); + } + + @Override + public int hashCode() { + return Objects.hash(pytestArgs, testSelection); + } + + @Override + public String toString() { + return new ToStringer(PipelineTestOptions.class) + .add("pytestArgs", pytestArgs) + .add("testSelection", testSelection) + .toString(); + } +} diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/PipelineTestSource.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/PipelineTestSource.java new file mode 100644 index 000000000..8ef322134 --- /dev/null +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/PipelineTestSource.java @@ -0,0 +1,43 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. + +package com.databricks.sdk.service.pipelines; + +import com.databricks.sdk.support.Generated; +import com.databricks.sdk.support.ToStringer; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.Objects; + +/** A workspace location that holds pipeline tests. */ +@Generated +public class PipelineTestSource { + /** An absolute workspace path to a test file, or to a folder followed by `/**`. */ + @JsonProperty("glob") + private PathPattern glob; + + public PipelineTestSource setGlob(PathPattern glob) { + this.glob = glob; + return this; + } + + public PathPattern getGlob() { + return glob; + } + + @Override + public boolean equals(Object o) { + if (this == o) return true; + if (o == null || getClass() != o.getClass()) return false; + PipelineTestSource that = (PipelineTestSource) o; + return Objects.equals(glob, that.glob); + } + + @Override + public int hashCode() { + return Objects.hash(glob); + } + + @Override + public String toString() { + return new ToStringer(PipelineTestSource.class).add("glob", glob).toString(); + } +} diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/PipelineTesting.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/PipelineTesting.java new file mode 100644 index 000000000..720e3f2bd --- /dev/null +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/PipelineTesting.java @@ -0,0 +1,66 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. + +package com.databricks.sdk.service.pipelines; + +import com.databricks.sdk.support.Generated; +import com.databricks.sdk.support.ToStringer; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.Collection; +import java.util.Objects; + +/** Test configuration for a pipeline. */ +@Generated +public class PipelineTesting { + /** + * Packages that only the tests need. Test-only updates install them in addition to the pipeline's + * `environment`. Other updates do not. + */ + @JsonProperty("environment") + private PipelineTestEnvironment environment; + + /** + * The workspace files and folders that hold the pipeline's tests. They must not overlap the + * pipeline's `libraries`. + */ + @JsonProperty("sources") + private Collection sources; + + public PipelineTesting setEnvironment(PipelineTestEnvironment environment) { + this.environment = environment; + return this; + } + + public PipelineTestEnvironment getEnvironment() { + return environment; + } + + public PipelineTesting setSources(Collection sources) { + this.sources = sources; + return this; + } + + public Collection getSources() { + return sources; + } + + @Override + public boolean equals(Object o) { + if (this == o) return true; + if (o == null || getClass() != o.getClass()) return false; + PipelineTesting that = (PipelineTesting) o; + return Objects.equals(environment, that.environment) && Objects.equals(sources, that.sources); + } + + @Override + public int hashCode() { + return Objects.hash(environment, sources); + } + + @Override + public String toString() { + return new ToStringer(PipelineTesting.class) + .add("environment", environment) + .add("sources", sources) + .toString(); + } +} diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/PipelinesAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/PipelinesAPI.java index ade245a37..5b568b052 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/PipelinesAPI.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/PipelinesAPI.java @@ -131,7 +131,10 @@ public GetPipelineResponse get(String pipelineId) { return get(new GetPipelineRequest().setPipelineId(pipelineId)); } - /** Get a pipeline. */ + /** + * Returns the details of a pipeline, including its settings, current state, and the status of its + * most recent updates. + */ public GetPipelineResponse get(GetPipelineRequest request) { return impl.get(request); } diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/PipelinesService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/PipelinesService.java index 4b7ec4a61..3155f2dd1 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/PipelinesService.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/PipelinesService.java @@ -50,7 +50,10 @@ public interface PipelinesService { */ void delete(DeletePipelineRequest deletePipelineRequest); - /** Get a pipeline. */ + /** + * Returns the details of a pipeline, including its settings, current state, and the status of its + * most recent updates. + */ GetPipelineResponse get(GetPipelineRequest getPipelineRequest); /** Gets the permission levels that a user can have on an object. */ diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/StartUpdate.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/StartUpdate.java index ee5c31f9d..eaffdf1e8 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/StartUpdate.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/StartUpdate.java @@ -12,7 +12,7 @@ @Generated public class StartUpdate { - /** */ + /** What triggered this update, as recorded in the update's `cause`. Defaults to `API_CALL`. */ @JsonProperty("cause") private StartUpdateCause cause; @@ -44,7 +44,7 @@ public class StartUpdate { @JsonProperty("parameters") private Map parameters; - /** */ + /** The ID of the pipeline to start an update for. */ @JsonIgnore private String pipelineId; /** @@ -81,6 +81,23 @@ public class StartUpdate { @JsonProperty("rewind_spec") private RewindSpec rewindSpec; + /** + * If true, this is a test-only update: it runs the pipeline's tests and does not update the + * pipeline's datasets. A failing test does not stop the other tests. The update is `COMPLETED` if + * at least one test runs and no test fails or errors. Otherwise the update is `FAILED`, including + * when no tests are found. Cannot be combined with `validate_only`, `explore_only`, or + * `rewind_spec`. + */ + @JsonProperty("test_only") + private Boolean testOnly; + + /** + * Options for selecting the tests that this test-only update runs. Requires `test_only`. When + * absent, every test in the pipeline's test sources runs. + */ + @JsonProperty("test_options") + private PipelineTestOptions testOptions; + /** * If true, this update only validates the correctness of pipeline source code but does not * materialize or publish any datasets. @@ -197,6 +214,24 @@ public RewindSpec getRewindSpec() { return rewindSpec; } + public StartUpdate setTestOnly(Boolean testOnly) { + this.testOnly = testOnly; + return this; + } + + public Boolean getTestOnly() { + return testOnly; + } + + public StartUpdate setTestOptions(PipelineTestOptions testOptions) { + this.testOptions = testOptions; + return this; + } + + public PipelineTestOptions getTestOptions() { + return testOptions; + } + public StartUpdate setValidateOnly(Boolean validateOnly) { this.validateOnly = validateOnly; return this; @@ -223,6 +258,8 @@ public boolean equals(Object o) { && Objects.equals(replaceWhereOverrides, that.replaceWhereOverrides) && Objects.equals(resetCheckpointSelection, that.resetCheckpointSelection) && Objects.equals(rewindSpec, that.rewindSpec) + && Objects.equals(testOnly, that.testOnly) + && Objects.equals(testOptions, that.testOptions) && Objects.equals(validateOnly, that.validateOnly); } @@ -241,6 +278,8 @@ public int hashCode() { replaceWhereOverrides, resetCheckpointSelection, rewindSpec, + testOnly, + testOptions, validateOnly); } @@ -259,6 +298,8 @@ public String toString() { .add("replaceWhereOverrides", replaceWhereOverrides) .add("resetCheckpointSelection", resetCheckpointSelection) .add("rewindSpec", rewindSpec) + .add("testOnly", testOnly) + .add("testOptions", testOptions) .add("validateOnly", validateOnly) .toString(); } diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/StartUpdateResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/StartUpdateResponse.java index 655c56a38..a37b56628 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/StartUpdateResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/StartUpdateResponse.java @@ -9,7 +9,7 @@ @Generated public class StartUpdateResponse { - /** */ + /** The ID of the update that was started. */ @JsonProperty("update_id") private String updateId; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/StopRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/StopRequest.java index c5e2b5d84..d1e177251 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/StopRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/StopRequest.java @@ -9,7 +9,7 @@ @Generated public class StopRequest { - /** */ + /** The ID of the pipeline to stop. */ @JsonIgnore private String pipelineId; public StopRequest setPipelineId(String pipelineId) { diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/UpdateInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/UpdateInfo.java index 114442e2a..b3cf6c8a3 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/UpdateInfo.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/UpdateInfo.java @@ -77,6 +77,10 @@ public class UpdateInfo { @JsonProperty("state") private UpdateInfoState state; + /** If true, this update is a test-only update. Absent for other updates. */ + @JsonProperty("test_only") + private Boolean testOnly; + /** The ID of this update. */ @JsonProperty("update_id") private String updateId; @@ -205,6 +209,15 @@ public UpdateInfoState getState() { return state; } + public UpdateInfo setTestOnly(Boolean testOnly) { + this.testOnly = testOnly; + return this; + } + + public Boolean getTestOnly() { + return testOnly; + } + public UpdateInfo setUpdateId(String updateId) { this.updateId = updateId; return this; @@ -241,6 +254,7 @@ public boolean equals(Object o) { && Objects.equals(refreshSelection, that.refreshSelection) && Objects.equals(refreshSelectionByPath, that.refreshSelectionByPath) && Objects.equals(state, that.state) + && Objects.equals(testOnly, that.testOnly) && Objects.equals(updateId, that.updateId) && Objects.equals(validateOnly, that.validateOnly); } @@ -261,6 +275,7 @@ public int hashCode() { refreshSelection, refreshSelectionByPath, state, + testOnly, updateId, validateOnly); } @@ -281,6 +296,7 @@ public String toString() { .add("refreshSelection", refreshSelection) .add("refreshSelectionByPath", refreshSelectionByPath) .add("state", state) + .add("testOnly", testOnly) .add("updateId", updateId) .add("validateOnly", validateOnly) .toString(); diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/UpdateStateInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/UpdateStateInfo.java index 6e7b2e749..eeaf7ce3c 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/UpdateStateInfo.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/UpdateStateInfo.java @@ -9,15 +9,15 @@ @Generated public class UpdateStateInfo { - /** */ + /** The time when the update was created, in ISO 8601 format. */ @JsonProperty("creation_time") private String creationTime; - /** */ + /** The state of the update. */ @JsonProperty("state") private UpdateStateInfoState state; - /** */ + /** The ID of the update. */ @JsonProperty("update_id") private String updateId; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/Branch.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/Branch.java index 67a76669d..5617e6fa7 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/Branch.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/Branch.java @@ -34,7 +34,12 @@ public class Branch { @JsonProperty("parent") private String parent; - /** The spec contains the branch configuration. */ + /** + * The spec contains the branch configuration. + * + *

Read the resource's current values from `status`, rather than `spec`. `spec` tracks field + * ownership for infrastructure-as-code tools and may omit unmanaged fields. + */ @JsonProperty("spec") private BranchSpec spec; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/Catalog.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/Catalog.java index c6368e56a..fcf5d9774 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/Catalog.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/Catalog.java @@ -10,7 +10,10 @@ @Generated public class Catalog { - /** The part of the name, chosen by the user when the resource was created. */ + /** + * The ID chosen when the catalog was created, which is also its name in Unity Catalog. It is the + * last segment of the name field. + */ @JsonProperty("catalog_id") private String catalogId; @@ -26,7 +29,10 @@ public class Catalog { @JsonProperty("name") private String name; - /** The desired state of the Catalog. */ + /** + * The desired state of the Catalog. The catalog has no update method, so the spec is fixed when + * the catalog is created. + */ @JsonProperty("spec") private CatalogCatalogSpec spec; @@ -34,7 +40,7 @@ public class Catalog { @JsonProperty("status") private CatalogCatalogStatus status; - /** System-generated unique identifier for the catalog. */ + /** The immutable UUID that identifies the catalog, assigned when the catalog is created. */ @JsonProperty("uid") private String uid; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/CatalogCatalogSpec.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/CatalogCatalogSpec.java index 2a5d34e3e..bce4883fb 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/CatalogCatalogSpec.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/CatalogCatalogSpec.java @@ -11,7 +11,8 @@ @Generated public class CatalogCatalogSpec { /** - * The resource path of the branch associated with the catalog. + * The resource path of the branch that holds the Postgres database. The branch must have a + * read-write compute endpoint. * *

Format: projects/{project_id}/branches/{branch_id}. */ @@ -32,7 +33,8 @@ public class CatalogCatalogSpec { /** * The name of the Postgres database inside the specified Lakebase project and branch to be * associated with the UC catalog. This database must already exist, unless - * create_database_if_missing is set to true on creation. + * create_database_if_missing is set to true on creation. The system databases postgres, + * databricks_system, template0 and template1 cannot be registered. * *

A database can only be registered with one UC catalog at a time. To re-register a database * with a different catalog, the existing catalog must be deleted first. diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/CreateCatalogRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/CreateCatalogRequest.java index dac7846d2..378acaf1a 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/CreateCatalogRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/CreateCatalogRequest.java @@ -16,8 +16,8 @@ public class CreateCatalogRequest { private Catalog catalog; /** - * The ID in the Unity Catalog. It becomes the full resource name, for example "my_catalog" - * becomes "catalogs/my_catalog". + * The ID of the catalog to create, which is also its name in Unity Catalog. It becomes the last + * segment of the catalog's resource name, catalogs/{catalog_id}. */ @JsonIgnore @QueryParam("catalog_id") diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/CreateEndpointRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/CreateEndpointRequest.java index 93fd4f3c6..9b2b59fb6 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/CreateEndpointRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/CreateEndpointRequest.java @@ -11,15 +11,18 @@ @Generated public class CreateEndpointRequest { - /** The Endpoint to create. */ + /** + * The endpoint to create. Only `spec` is read from this message; the system sets the other + * fields. + */ @JsonProperty("endpoint") private Endpoint endpoint; /** - * The ID to use for the Endpoint. This becomes the final component of the endpoint's resource - * name. The ID is required and must be 1-63 characters long, start with a lowercase letter, and - * contain only lowercase letters, numbers, and hyphens. For example, `primary` becomes - * `projects/my-app/branches/development/endpoints/primary`. + * The ID to use for the endpoint. It becomes the final segment of the endpoint's resource name, + * `projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}`. The ID must be 3 to 63 + * characters long, start with a lowercase letter, end with a lowercase letter or digit, and + * contain only lowercase letters, digits, and hyphens. */ @JsonIgnore @QueryParam("endpoint_id") @@ -31,7 +34,12 @@ public class CreateEndpointRequest { */ @JsonIgnore private String parent; - /** If true, update the endpoint if it already exists instead of returning an error. */ + /** + * If true, update the endpoint if it already exists instead of returning an error. The request's + * `spec.endpoint_type` must match the existing endpoint's type, and the other `spec` fields are + * applied as an update. Use this to configure the read-write endpoint that was created together + * with the branch. + */ @JsonIgnore @QueryParam("replace_existing") private Boolean replaceExisting; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/CreateProjectRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/CreateProjectRequest.java index c4dad1ccb..0893fc989 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/CreateProjectRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/CreateProjectRequest.java @@ -16,9 +16,10 @@ public class CreateProjectRequest { private Project project; /** - * The ID to use for the Project. This becomes the final component of the project's resource name. - * The ID is required and must be 1-63 characters long, start with a lowercase letter, and contain - * only lowercase letters, numbers, and hyphens. For example, `my-app` becomes `projects/my-app`. + * The ID to use for the project. It becomes the final segment of the project's resource name, + * `projects/{project_id}`. The ID must be 3 to 63 characters long, start with a lowercase letter, + * end with a lowercase letter or digit, and contain only lowercase letters, digits, and hyphens. + * The ID of a soft-deleted project stays reserved until that project is permanently deleted. */ @JsonIgnore @QueryParam("project_id") diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/Database.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/Database.java index 591c8f7a4..03c017fc8 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/Database.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/Database.java @@ -30,7 +30,12 @@ public class Database { @JsonProperty("parent") private String parent; - /** The desired state of the Database. */ + /** + * The desired state of the Database. + * + *

Read the resource's current values from `status`, rather than `spec`. `spec` tracks field + * ownership for infrastructure-as-code tools and may omit unmanaged fields. + */ @JsonProperty("spec") private DatabaseDatabaseSpec spec; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/DeleteEndpointRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/DeleteEndpointRequest.java index 73d3b898d..456951b90 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/DeleteEndpointRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/DeleteEndpointRequest.java @@ -12,9 +12,6 @@ public class DeleteEndpointRequest { /** * The full resource path of the endpoint to delete. Format: * projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id} - * - *

Read-write endpoints currently cannot be deleted directly. Their deletion is managed by the - * parent branch. To avoid compute costs, set `disabled` to `true` on the endpoint. */ @JsonIgnore private String name; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/DeleteProjectRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/DeleteProjectRequest.java index 071cf43bd..562ed0442 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/DeleteProjectRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/DeleteProjectRequest.java @@ -14,8 +14,11 @@ public class DeleteProjectRequest { @JsonIgnore private String name; /** - * If true, permanently deletes the project (hard delete). If false or unset, performs a soft - * delete. + * If true, permanently deletes the project and all of its data immediately. If false or unset, + * the project is soft-deleted: it stops accepting connections and is retained for 7 days, during + * which it can be restored with Undelete, and is then permanently deleted. Deleting an already + * soft-deleted project with `purge` set to true removes it immediately. See + * https://docs.databricks.com/aws/en/oltp/projects/manage-projects for details. */ @JsonIgnore @QueryParam("purge") diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/Endpoint.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/Endpoint.java index 892ccccae..6d40b1e5c 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/Endpoint.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/Endpoint.java @@ -8,13 +8,19 @@ import com.google.protobuf.Timestamp; import java.util.Objects; +/** + * A compute endpoint of a Lakebase Postgres branch. An endpoint provides the compute that runs + * Postgres for the branch's data and the hostnames that clients connect to. Each branch has one + * read-write endpoint, created together with the branch, and can have additional read-only + * endpoints (read replicas). + */ @Generated public class Endpoint { /** A timestamp indicating when the compute endpoint was created. */ @JsonProperty("create_time") private Timestamp createTime; - /** The part of the name, chosen by the user when the resource was created. */ + /** The endpoint ID chosen when the endpoint was created. It is the final segment of `name`. */ @JsonProperty("endpoint_id") private String endpointId; @@ -33,17 +39,26 @@ public class Endpoint { private String parent; /** - * The spec contains the compute endpoint configuration, including autoscaling limits, suspend - * timeout, and disabled state. + * The desired configuration of the endpoint. Every field under `spec` except `endpoint_type` can + * be changed after creation. See `status` for the configuration that is currently in effect. + * + *

Read the resource's current values from `status`, rather than `spec`. `spec` tracks field + * ownership for infrastructure-as-code tools and may omit unmanaged fields. */ @JsonProperty("spec") private EndpointSpec spec; - /** Current operational status of the compute endpoint. */ + /** + * The configuration and state of the endpoint that are currently in effect, as reported by the + * system, including the hostnames to connect to. + */ @JsonProperty("status") private EndpointStatus status; - /** System-generated unique ID for the endpoint. */ + /** + * A system-generated ID that identifies the endpoint. Unlike `name`, it is not derived from the + * user-chosen endpoint ID. The endpoint's connection hostnames are based on this ID. + */ @JsonProperty("uid") private String uid; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/EndpointGroupSpec.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/EndpointGroupSpec.java index ff9fc27c7..8da8f5d2d 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/EndpointGroupSpec.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/EndpointGroupSpec.java @@ -11,7 +11,8 @@ public class EndpointGroupSpec { /** * Whether to allow read-only connections to read-write endpoints. Only relevant for read-write - * endpoints where size.max > 1. + * endpoints where `max` is greater than 1. When enabled, the endpoint also reports a read-only + * host in `status.hosts`. */ @JsonProperty("enable_readable_secondaries") private Boolean enableReadableSecondaries; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/EndpointGroupStatus.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/EndpointGroupStatus.java index 4664f2c49..233c466ad 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/EndpointGroupStatus.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/EndpointGroupStatus.java @@ -10,8 +10,8 @@ @Generated public class EndpointGroupStatus { /** - * Whether read-only connections to read-write endpoints are allowed. Only relevant if read - * replicas are configured by specifying size.max > 1. + * Whether read-only connections to read-write endpoints are allowed. Only relevant if the + * endpoint has more than one compute (`max` greater than 1). */ @JsonProperty("enable_readable_secondaries") private Boolean enableReadableSecondaries; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/EndpointSettings.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/EndpointSettings.java index 9625626b6..8a3cd32e6 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/EndpointSettings.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/EndpointSettings.java @@ -11,7 +11,10 @@ /** A collection of settings for a compute endpoint. */ @Generated public class EndpointSettings { - /** A raw representation of Postgres settings. */ + /** + * Postgres server parameters to set on the compute endpoint, keyed by parameter name. Each value + * is given as a string. + */ @JsonProperty("pg_settings") private Map pgSettings; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/EndpointSpec.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/EndpointSpec.java index d97f7f699..c29bcdaea 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/EndpointSpec.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/EndpointSpec.java @@ -12,19 +12,25 @@ public class EndpointSpec { /** * The maximum number of Compute Units. The maximum value is 64. The difference between the - * minimum and maximum Compute Units (max - min) must not exceed 16. + * minimum and maximum Compute Units (max - min) must not exceed 16. Set it equal to + * `autoscaling_limit_min_cu` for a fixed-size compute. When omitted at creation, the project's + * default endpoint settings apply. */ @JsonProperty("autoscaling_limit_max_cu") private Double autoscalingLimitMaxCu; - /** The minimum number of Compute Units. Minimum value is 0.5. */ + /** + * The minimum number of Compute Units. Minimum value is 0.5, and it must not exceed + * `autoscaling_limit_max_cu`. When omitted at creation, the project's default endpoint settings + * apply. + */ @JsonProperty("autoscaling_limit_min_cu") private Double autoscalingLimitMinCu; /** * Whether to restrict connections to the compute endpoint. Enabling this option schedules a * suspend compute operation. A disabled compute endpoint cannot be enabled by a connection or - * console action. + * console action. To accept connections again, set this field back to false. */ @JsonProperty("disabled") private Boolean disabled; @@ -36,26 +42,32 @@ public class EndpointSpec { /** * Settings for optional HA configuration of the endpoint. If unspecified, the endpoint defaults * to non HA settings, with a single compute backing the endpoint (and no readable secondaries for - * Read/Write endpoints). + * Read/Write endpoints). Automatic suspension is not available for an endpoint with more than one + * compute, so set `no_suspension` to true when configuring one. */ @JsonProperty("group") private EndpointGroupSpec group; /** - * When set to true, explicitly disables automatic suspension (never suspend). Should be set to + * When set to true, explicitly disables automatic suspension (never suspend). The value must be * true when provided. Mutually exclusive with `suspend_timeout_duration`. */ @JsonProperty("no_suspension") private Boolean noSuspension; - /** */ + /** + * Postgres server parameters for the compute endpoint. On update, an empty `pg_settings` map + * leaves the current parameters unchanged. + */ @JsonProperty("settings") private EndpointSettings settings; /** * Duration of inactivity after which the compute endpoint is automatically suspended. If - * specified should be between 60s and 604800s (1 minute to 1 week). Mutually exclusive with - * `no_suspension`. + * specified, the value must be between 60s and 604800s (1 minute to 1 week). A suspended endpoint + * keeps its hostnames and configuration, and the next connection attempt restarts it. When + * neither this field nor `no_suspension` is set at creation, the project's default endpoint + * settings apply. Mutually exclusive with `no_suspension`. */ @JsonProperty("suspend_timeout_duration") private Duration suspendTimeoutDuration; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/EndpointStatus.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/EndpointStatus.java index a7e59bfbf..b48dee1af 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/EndpointStatus.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/EndpointStatus.java @@ -22,7 +22,7 @@ public class EndpointStatus { @JsonProperty("autoscaling_limit_min_cu") private Double autoscalingLimitMinCu; - /** */ + /** The state the compute endpoint is in now. */ @JsonProperty("current_state") private EndpointStatusState currentState; @@ -34,7 +34,7 @@ public class EndpointStatus { @JsonProperty("disabled") private Boolean disabled; - /** Part of the resource name. */ + /** The endpoint ID, which is the final segment of the endpoint's resource name. */ @JsonProperty("endpoint_id") private String endpointId; @@ -54,15 +54,18 @@ public class EndpointStatus { @JsonProperty("last_active_time") private Timestamp lastActiveTime; - /** */ + /** The state the compute endpoint is transitioning to, if a transition is in progress. */ @JsonProperty("pending_state") private EndpointStatusState pendingState; - /** */ + /** The Postgres server parameters currently set on the compute endpoint. */ @JsonProperty("settings") private EndpointSettings settings; - /** Duration of inactivity after which the compute endpoint is automatically suspended. */ + /** + * Duration of inactivity after which the compute endpoint is automatically suspended. Absent when + * automatic suspension is disabled. + */ @JsonProperty("suspend_timeout_duration") private Duration suspendTimeoutDuration; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/InitialEndpointSpec.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/InitialEndpointSpec.java index bb34e2b06..b45d010e3 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/InitialEndpointSpec.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/InitialEndpointSpec.java @@ -11,11 +11,14 @@ /** Configuration for the initial Read/Write endpoint created during project creation. */ @Generated public class InitialEndpointSpec { - /** The maximum number of Compute Units for the initial endpoint. */ + /** The maximum number of Compute Units for the initial endpoint. Minimum value is 0.5. */ @JsonProperty("autoscaling_limit_max_cu") private Double autoscalingLimitMaxCu; - /** The minimum number of Compute Units for the initial endpoint. */ + /** + * The minimum number of Compute Units for the initial endpoint. Minimum value is 0.5, and it must + * not exceed autoscaling_limit_max_cu. + */ @JsonProperty("autoscaling_limit_min_cu") private Double autoscalingLimitMinCu; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/ListEndpointsRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/ListEndpointsRequest.java index f8f7af036..c008a5fcc 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/ListEndpointsRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/ListEndpointsRequest.java @@ -10,7 +10,7 @@ @Generated public class ListEndpointsRequest { - /** Upper bound for items returned. Cannot be negative. */ + /** Upper bound for the number of endpoints returned. If set, the value must be at least 10. */ @JsonIgnore @QueryParam("page_size") private Long pageSize; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/ListProjectsRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/ListProjectsRequest.java index 5639ef257..492e1934b 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/ListProjectsRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/ListProjectsRequest.java @@ -10,7 +10,10 @@ @Generated public class ListProjectsRequest { - /** Upper bound for items returned. Cannot be negative. The maximum value is 100. */ + /** + * Upper bound for the number of projects returned. Cannot be negative. Values above the maximum + * page size are reduced to that maximum. + */ @JsonIgnore @QueryParam("page_size") private Long pageSize; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/PostgresAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/PostgresAPI.java index e880567fe..b6aee03ba 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/PostgresAPI.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/PostgresAPI.java @@ -56,7 +56,13 @@ public CreateBranchOperation createBranch(CreateBranchRequest request) { return new CreateBranchOperation(impl, operation); } - /** Register a Postgres database in the Unity Catalog. */ + /** + * Registers a Postgres database from a Lakebase project branch as a catalog in Unity Catalog, so + * that its schemas, tables and views are governed and discoverable through Unity Catalog. The + * catalog is read-only; the data stays managed through Postgres. Returns a long-running + * operation. Poll it until done is true; its response holds the new catalog. For an overview, see + * https://docs.databricks.com/aws/en/oltp/projects/register-uc. + */ public CreateCatalogOperation createCatalog(CreateCatalogRequest request) { Operation operation = impl.createCatalog(request); return new CreateCatalogOperation(impl, operation); @@ -88,7 +94,11 @@ public CreateDatabaseOperation createDatabase(CreateDatabaseRequest request) { return new CreateDatabaseOperation(impl, operation); } - /** Creates a new compute endpoint in the branch. */ + /** + * Creates a compute endpoint in the branch. Each branch gets its read-write endpoint when the + * branch is created, so use this method to add read-only endpoints (read replicas) or, with + * `replace_existing`, to reconfigure the existing read-write endpoint. + */ public CreateEndpointOperation createEndpoint(CreateEndpointRequest request) { Operation operation = impl.createEndpoint(request); return new CreateEndpointOperation(impl, operation); @@ -102,7 +112,9 @@ public CreateMigrationOperation createMigration(CreateMigrationRequest request) /** * Creates a new Lakebase Autoscaling Postgres database project, which contains branches and - * compute endpoints. + * compute endpoints. The new project starts with a single branch, a read-write compute endpoint + * on that branch, a Postgres database named `databricks_postgres`, and a Postgres role for the + * calling identity. */ public CreateProjectOperation createProject(CreateProjectRequest request) { Operation operation = impl.createProject(request); @@ -141,7 +153,11 @@ public DeleteCatalogOperation deleteCatalog(String name) { return deleteCatalog(new DeleteCatalogRequest().setName(name)); } - /** Delete a Database Catalog. */ + /** + * Deletes the catalog from Unity Catalog. The Postgres database and its tables remain in the + * branch, and the database can be registered again afterwards. Returns a long-running operation. + * Poll it until done is true. + */ public DeleteCatalogOperation deleteCatalog(DeleteCatalogRequest request) { Operation operation = impl.deleteCatalog(request); return new DeleteCatalogOperation(impl, operation); @@ -185,7 +201,12 @@ public DeleteEndpointOperation deleteEndpoint(String name) { return deleteEndpoint(new DeleteEndpointRequest().setName(name)); } - /** Deletes the specified compute endpoint. */ + /** + * Deletes the specified compute endpoint. Deletion is permanent. Only read-only endpoints can be + * deleted this way, because a branch's read-write endpoint is deleted together with the branch. + * To stop the compute costs of a read-write endpoint without deleting the branch, set + * `spec.disabled` to true. + */ public DeleteEndpointOperation deleteEndpoint(DeleteEndpointRequest request) { Operation operation = impl.deleteEndpoint(request); return new DeleteEndpointOperation(impl, operation); @@ -205,7 +226,10 @@ public DeleteProjectOperation deleteProject(String name) { return deleteProject(new DeleteProjectRequest().setName(name)); } - /** Deletes the specified database project. */ + /** + * Deletes the specified database project. By default the project is soft-deleted and can be + * restored with Undelete during its retention period; set `purge` to delete it permanently. + */ public DeleteProjectOperation deleteProject(DeleteProjectRequest request) { Operation operation = impl.deleteProject(request); return new DeleteProjectOperation(impl, operation); @@ -268,7 +292,10 @@ public Catalog getCatalog(String name) { return getCatalog(new GetCatalogRequest().setName(name)); } - /** Get a Database Catalog. */ + /** + * Gets the catalog with the given name. The status reports the Postgres database, project and + * branch that the catalog registers. + */ public Catalog getCatalog(GetCatalogRequest request) { return impl.getCatalog(request); } @@ -501,7 +528,10 @@ public Iterable listEndpoints(String parent) { return listEndpoints(new ListEndpointsRequest().setParent(parent)); } - /** Returns a paginated list of compute endpoints in the branch. */ + /** + * Lists the compute endpoints in the branch, including its read-write endpoint and any read-only + * endpoints. + */ public Iterable listEndpoints(ListEndpointsRequest request) { return Paginator.newTokenPagination( request, @@ -614,7 +644,11 @@ public UndeleteMigrationOperation undeleteMigration(UndeleteMigrationRequest req return new UndeleteMigrationOperation(impl, operation); } - /** Undeletes a soft-deleted project. */ + /** + * Restores a soft-deleted project together with its branches and their data, compute endpoints, + * Postgres databases and roles, project settings, and permissions. A project can be restored + * until its `purge_time`; after that it is permanently deleted and cannot be recovered. + */ public UndeleteProjectOperation undeleteProject(UndeleteProjectRequest request) { Operation operation = impl.undeleteProject(request); return new UndeleteProjectOperation(impl, operation); @@ -642,8 +676,9 @@ public UpdateDatabaseOperation updateDatabase(UpdateDatabaseRequest request) { } /** - * Updates the specified compute endpoint. You can update autoscaling limits, suspend timeout, or - * enable/disable the compute endpoint. + * Updates the configuration of the specified compute endpoint. Only the `spec` fields named in + * `update_mask` change, and `spec.endpoint_type` cannot be changed. The endpoint keeps its + * hostnames across updates, so existing connection strings stay valid. */ public UpdateEndpointOperation updateEndpoint(UpdateEndpointRequest request) { Operation operation = impl.updateEndpoint(request); @@ -656,7 +691,10 @@ public UpdateMigrationOperation updateMigration(UpdateMigrationRequest request) return new UpdateMigrationOperation(impl, operation); } - /** Updates the specified database project. */ + /** + * Updates the configuration of the specified database project. Only the fields named in + * `update_mask` change. + */ public UpdateProjectOperation updateProject(UpdateProjectRequest request) { Operation operation = impl.updateProject(request); return new UpdateProjectOperation(impl, operation); diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/PostgresService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/PostgresService.java index aad3b3a1e..98a4e3ac9 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/PostgresService.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/PostgresService.java @@ -33,7 +33,13 @@ Operation acknowledgeAssessmentWarnings( /** Creates a new database branch in the project. */ Operation createBranch(CreateBranchRequest createBranchRequest); - /** Register a Postgres database in the Unity Catalog. */ + /** + * Registers a Postgres database from a Lakebase project branch as a catalog in Unity Catalog, so + * that its schemas, tables and views are governed and discoverable through Unity Catalog. The + * catalog is read-only; the data stays managed through Postgres. Returns a long-running + * operation. Poll it until done is true; its response holds the new catalog. For an overview, see + * https://docs.databricks.com/aws/en/oltp/projects/register-uc. + */ Operation createCatalog(CreateCatalogRequest createCatalogRequest); /** @@ -53,7 +59,11 @@ Operation acknowledgeAssessmentWarnings( */ Operation createDatabase(CreateDatabaseRequest createDatabaseRequest); - /** Creates a new compute endpoint in the branch. */ + /** + * Creates a compute endpoint in the branch. Each branch gets its read-write endpoint when the + * branch is created, so use this method to add read-only endpoints (read replicas) or, with + * `replace_existing`, to reconfigure the existing read-write endpoint. + */ Operation createEndpoint(CreateEndpointRequest createEndpointRequest); /** Creates a migration. */ @@ -61,7 +71,9 @@ Operation acknowledgeAssessmentWarnings( /** * Creates a new Lakebase Autoscaling Postgres database project, which contains branches and - * compute endpoints. + * compute endpoints. The new project starts with a single branch, a read-write compute endpoint + * on that branch, a Postgres database named `databricks_postgres`, and a Postgres role for the + * calling identity. */ Operation createProject(CreateProjectRequest createProjectRequest); @@ -77,7 +89,11 @@ Operation acknowledgeAssessmentWarnings( /** Deletes the specified database branch. */ Operation deleteBranch(DeleteBranchRequest deleteBranchRequest); - /** Delete a Database Catalog. */ + /** + * Deletes the catalog from Unity Catalog. The Postgres database and its tables remain in the + * branch, and the database can be registered again afterwards. Returns a long-running operation. + * Poll it until done is true. + */ Operation deleteCatalog(DeleteCatalogRequest deleteCatalogRequest); /** @@ -93,13 +109,21 @@ Operation acknowledgeAssessmentWarnings( /** Delete a Database. */ Operation deleteDatabase(DeleteDatabaseRequest deleteDatabaseRequest); - /** Deletes the specified compute endpoint. */ + /** + * Deletes the specified compute endpoint. Deletion is permanent. Only read-only endpoints can be + * deleted this way, because a branch's read-write endpoint is deleted together with the branch. + * To stop the compute costs of a read-write endpoint without deleting the branch, set + * `spec.disabled` to true. + */ Operation deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest); /** Soft-deletes a migration. */ Operation deleteMigration(DeleteMigrationRequest deleteMigrationRequest); - /** Deletes the specified database project. */ + /** + * Deletes the specified database project. By default the project is soft-deleted and can be + * restored with Undelete during its retention period; set `purge` to delete it permanently. + */ Operation deleteProject(DeleteProjectRequest deleteProjectRequest); /** Deletes the specified Postgres role. */ @@ -121,7 +145,10 @@ DatabaseCredential generateDatabaseCredential( /** Retrieves information about the specified database branch. */ Branch getBranch(GetBranchRequest getBranchRequest); - /** Get a Database Catalog. */ + /** + * Gets the catalog with the given name. The status reports the Postgres database, project and + * branch that the catalog registers. + */ Catalog getCatalog(GetCatalogRequest getCatalogRequest); /** @@ -196,7 +223,10 @@ DatabaseCredential generateDatabaseCredential( /** List Databases. */ ListDatabasesResponse listDatabases(ListDatabasesRequest listDatabasesRequest); - /** Returns a paginated list of compute endpoints in the branch. */ + /** + * Lists the compute endpoints in the branch, including its read-write endpoint and any read-only + * endpoints. + */ ListEndpointsResponse listEndpoints(ListEndpointsRequest listEndpointsRequest); /** Lists migrations in the workspace. */ @@ -231,7 +261,11 @@ RevealRolePasswordResponse revealRolePassword( /** Restores a soft-deleted migration before it is permanently purged. */ Operation undeleteMigration(UndeleteMigrationRequest undeleteMigrationRequest); - /** Undeletes a soft-deleted project. */ + /** + * Restores a soft-deleted project together with its branches and their data, compute endpoints, + * Postgres databases and roles, project settings, and permissions. A project can be restored + * until its `purge_time`; after that it is permanently deleted and cannot be recovered. + */ Operation undeleteProject(UndeleteProjectRequest undeleteProjectRequest); /** @@ -247,15 +281,19 @@ RevealRolePasswordResponse revealRolePassword( Operation updateDatabase(UpdateDatabaseRequest updateDatabaseRequest); /** - * Updates the specified compute endpoint. You can update autoscaling limits, suspend timeout, or - * enable/disable the compute endpoint. + * Updates the configuration of the specified compute endpoint. Only the `spec` fields named in + * `update_mask` change, and `spec.endpoint_type` cannot be changed. The endpoint keeps its + * hostnames across updates, so existing connection strings stay valid. */ Operation updateEndpoint(UpdateEndpointRequest updateEndpointRequest); /** Updates user-owned migration configuration. */ Operation updateMigration(UpdateMigrationRequest updateMigrationRequest); - /** Updates the specified database project. */ + /** + * Updates the configuration of the specified database project. Only the fields named in + * `update_mask` change. + */ Operation updateProject(UpdateProjectRequest updateProjectRequest); /** diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/Project.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/Project.java index 4eb3fea4f..08556773d 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/Project.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/Project.java @@ -43,7 +43,7 @@ public class Project { @JsonProperty("name") private String name; - /** The part of the name, chosen by the user when the resource was created. */ + /** The project ID chosen when the project was created. It is the final segment of `name`. */ @JsonProperty("project_id") private String projectId; @@ -55,17 +55,27 @@ public class Project { private Timestamp purgeTime; /** - * The spec contains the project configuration, including display_name, pg_version (Postgres - * version), history_retention_duration, and default_endpoint_settings. + * The desired configuration of the project. The fields under `spec` are the ones that can be + * changed after creation, except `pg_version`, which is fixed when the project is created. See + * `status` for the configuration that is currently in effect. + * + *

Read the resource's current values from `status`, rather than `spec`. `spec` tracks field + * ownership for infrastructure-as-code tools and may omit unmanaged fields. */ @JsonProperty("spec") private ProjectSpec spec; - /** The current status of a Project. */ + /** + * The configuration and state of the project that are currently in effect, as reported by the + * system. + */ @JsonProperty("status") private ProjectStatus status; - /** System-generated unique ID for the project. */ + /** + * A system-generated UUID that identifies the project. Unlike `name`, it is not derived from the + * user-chosen project ID. + */ @JsonProperty("uid") private String uid; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/ProjectSpec.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/ProjectSpec.java index 75a1cd608..979b784e7 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/ProjectSpec.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/ProjectSpec.java @@ -19,23 +19,28 @@ public class ProjectSpec { private String budgetPolicyId; /** - * Custom tags to associate with the project. Forwarded to LBM for billing and cost tracking. To - * update tags, provide the new tag list and include "spec.custom_tags" in the update_mask. To - * clear all tags, provide an empty list and include "spec.custom_tags" in the update_mask. To - * preserve existing tags, omit this field from the update_mask (or use wildcard "*" which - * auto-excludes empty tags). + * Custom tags to associate with the project, used for billing and cost tracking. To update tags, + * provide the new tag list and include "spec.custom_tags" in the update_mask. To clear all tags, + * provide an empty list and include "spec.custom_tags" in the update_mask. To preserve existing + * tags, omit this field from the update_mask (or use wildcard "*" which auto-excludes empty + * tags). */ @JsonProperty("custom_tags") private Collection customTags; /** - * The full resource path for the default branch of the project Format: - * projects/{project_id}/branches/{branch_id} + * The full resource path of the default branch of the project. Format: + * projects/{project_id}/branches/{branch_id} At creation time, the branch ID in this path names + * the initial branch, which is called `production` when the field is omitted. On update, the path + * must name an existing branch of this project, which then becomes the default branch. */ @JsonProperty("default_branch") private String defaultBranch; - /** */ + /** + * Settings applied by default to compute endpoints created in this project. The initial endpoint + * also takes these values for any setting that initial_endpoint_spec does not provide. + */ @JsonProperty("default_endpoint_settings") private ProjectDefaultEndpointSettings defaultEndpointSettings; @@ -51,14 +56,15 @@ public class ProjectSpec { /** * The number of seconds to retain the shared history for point in time recovery for all branches - * in this project. Value should be between 172800s (2 days) and 3024000s (35 days). + * in this project. Value should be between 172800s (2 days) and 3024000s (35 days). Defaults to + * 604800s (7 days) when omitted. */ @JsonProperty("history_retention_duration") private Duration historyRetentionDuration; /** - * The major Postgres version number. The set of supported versions may vary; consult the API - * documentation for currently accepted values. + * The major Postgres version number. Defaults to 17 when omitted. The set of versions that new + * projects can use may change over time. */ @JsonProperty("pg_version") private Long pgVersion; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/ProjectStatus.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/ProjectStatus.java index 533987582..04f9d55e1 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/ProjectStatus.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/ProjectStatus.java @@ -28,7 +28,7 @@ public class ProjectStatus { @JsonProperty("custom_tags") private Collection customTags; - /** The full resource path of the default branch of the project */ + /** The full resource path of the default branch of the project. */ @JsonProperty("default_branch") private String defaultBranch; @@ -56,7 +56,7 @@ public class ProjectStatus { @JsonProperty("pg_version") private Long pgVersion; - /** Part of the resource name. */ + /** The project ID, which is the final segment of the project's resource name. */ @JsonProperty("project_id") private String projectId; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/Role.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/Role.java index 00d0ee547..e4b4c789b 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/Role.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/Role.java @@ -33,6 +33,9 @@ public class Role { /** * The spec contains the role configuration, including identity type, authentication method, and * role attributes. + * + *

Read the resource's current values from `status`, rather than `spec`. `spec` tracks field + * ownership for infrastructure-as-code tools and may omit unmanaged fields. */ @JsonProperty("spec") private RoleRoleSpec spec; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/UpdateEndpointRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/UpdateEndpointRequest.java index 534455782..efb35676c 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/UpdateEndpointRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/UpdateEndpointRequest.java @@ -27,7 +27,12 @@ public class UpdateEndpointRequest { */ @JsonIgnore private String name; - /** The list of fields to update. */ + /** + * The fields to update, as paths relative to the endpoint, for example + * `spec.autoscaling_limit_max_cu`. Pass `spec` to update every field that is set in `spec`. Only + * fields under `spec` can be updated. To change the suspension setting, include `spec.suspension` + * or the specific suspension field. + */ @JsonIgnore @QueryParam("update_mask") private FieldMask updateMask; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/UpdateProjectRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/UpdateProjectRequest.java index 6a6fc3d83..e23a469ae 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/UpdateProjectRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/UpdateProjectRequest.java @@ -24,7 +24,10 @@ public class UpdateProjectRequest { @JsonProperty("project") private Project project; - /** The list of fields to update. */ + /** + * The fields to update, as paths relative to the project, for example `spec.display_name`. Pass + * `*` to update every field that is set in the request. Only fields under `spec` can be updated. + */ @JsonIgnore @QueryParam("update_mask") private FieldMask updateMask; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/ComputeSpec.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/ComputeSpec.java index d60191370..0186817f2 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/ComputeSpec.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/ComputeSpec.java @@ -10,7 +10,11 @@ @Generated public class ComputeSpec { - /** Idle duration after which the sandbox is automatically terminated. */ + /** + * Idle time after which the sandbox is automatically stopped. Unset or 0 disables inactivity + * auto-stop. Negative values are rejected. Can be changed on an existing sandbox with + * UpdateSandbox. + */ @JsonProperty("inactivity_timeout") private Duration inactivityTimeout; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/CreateSandboxRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/CreateSandboxRequest.java index 5e022c576..84c080d92 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/CreateSandboxRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/CreateSandboxRequest.java @@ -11,11 +11,15 @@ @Generated public class CreateSandboxRequest { - /** The sandbox to create. */ + /** The sandbox to create. An empty body creates a sandbox with the default configuration. */ @JsonProperty("sandbox") private Sandbox sandbox; - /** Client-supplied ID that becomes the final path segment of the resource name. */ + /** + * Client-supplied ID that becomes the final path segment of the resource name. It must start with + * a lowercase letter, contain only lowercase letters, digits and hyphens, end with a letter or + * digit, and be at most 63 characters long. Values shaped like a UUID are rejected. + */ @JsonIgnore @QueryParam("sandbox_id") private String sandboxId; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/DeleteSandboxRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/DeleteSandboxRequest.java index afb338c9d..cdb9a65c6 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/DeleteSandboxRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/DeleteSandboxRequest.java @@ -9,7 +9,7 @@ @Generated public class DeleteSandboxRequest { - /** */ + /** Resource name of the sandbox to delete, in the form `sandboxes/{sandbox_id}`. */ @JsonIgnore private String name; public DeleteSandboxRequest setName(String name) { diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/EnvironmentSpec.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/EnvironmentSpec.java index 9ba83fce1..c952624ed 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/EnvironmentSpec.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/EnvironmentSpec.java @@ -10,10 +10,11 @@ @Generated public class EnvironmentSpec { /** - * The Unity Catalog container image to use for the sandbox environment (for example, - * `catalog.schema.folder.image:tag`). See [Artifact Registry]. + * The Unity Catalog container image to run the sandbox from, in the form + * `catalog.schema.artifact:tag`, or `catalog.schema.artifact@sha256:` to pin an exact + * version. When omitted, the sandbox runs the default sandbox image. See [custom images]. * - *

[Artifact Registry]: https://docs.databricks.com/en/artifact-registry/ + *

[custom images]: https://docs.databricks.com/en/compute/serverless/sandbox-custom-image */ @JsonProperty("image_uri") private String imageUri; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/GetSandboxRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/GetSandboxRequest.java index f996ce01c..0b71d450a 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/GetSandboxRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/GetSandboxRequest.java @@ -9,7 +9,7 @@ @Generated public class GetSandboxRequest { - /** */ + /** Resource name of the sandbox to retrieve, in the form `sandboxes/{sandbox_id}`. */ @JsonIgnore private String name; public GetSandboxRequest setName(String name) { diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/ListSandboxesRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/ListSandboxesRequest.java index 315eaadab..b095d3361 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/ListSandboxesRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/ListSandboxesRequest.java @@ -10,12 +10,18 @@ @Generated public class ListSandboxesRequest { - /** */ + /** + * Maximum number of sandboxes to return in one page. When unset or 0 the server returns up to + * 1000 sandboxes; values above 5000 are reduced to 5000. + */ @JsonIgnore @QueryParam("page_size") private Long pageSize; - /** */ + /** + * Page token from the `next_page_token` of a previous ListSandboxes response. Omit it to retrieve + * the first page. + */ @JsonIgnore @QueryParam("page_token") private String pageToken; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/ListSandboxesResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/ListSandboxesResponse.java index d795a93ab..dbdf01c45 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/ListSandboxesResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/ListSandboxesResponse.java @@ -11,11 +11,11 @@ /** A list of Sandboxes. */ @Generated public class ListSandboxesResponse { - /** */ + /** Token for retrieving the next page of results. Empty when there are no more results. */ @JsonProperty("next_page_token") private String nextPageToken; - /** */ + /** Sandboxes in this page of results. */ @JsonProperty("sandboxes") private Collection sandboxes; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/Sandbox.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/Sandbox.java index b02dfce34..c13db56aa 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/Sandbox.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/Sandbox.java @@ -8,7 +8,14 @@ import com.google.protobuf.Timestamp; import java.util.Objects; -/** A Sandbox resource representing an execution environment. */ +/** + * An isolated, pre-configured, low-latency Serverless compute environment for running code. Create + * a sandbox, wait until its state is `SANDBOX_STATE_RUNNING`, then run commands in it with + * ExecuteCommandSync. The data in its home directory persists across stop and start and is removed + * when the sandbox is deleted. See [Databricks Sandbox]. + * + *

[Databricks Sandbox]: https://docs.databricks.com/en/compute/serverless/sandbox + */ @Generated public class Sandbox { /** Output only. The creation time of the sandbox. */ @@ -19,7 +26,7 @@ public class Sandbox { @JsonProperty("display_name") private String displayName; - /** Metadata associated with the sandbox. */ + /** Tags and other metadata associated with the sandbox. */ @JsonProperty("metadata") private SandboxMetadata metadata; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/SandboxAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/SandboxAPI.java index af6394438..96c705172 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/SandboxAPI.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/SandboxAPI.java @@ -32,7 +32,13 @@ public CreateDirectoryResponse createDirectory(CreateDirectoryRequest request) { return impl.createDirectory(request); } - /** Creates a new Sandbox. */ + /** + * Creates a sandbox with the given `sandbox_id` and starts provisioning it. Provisioning is + * asynchronous: the response usually shows the sandbox in `SANDBOX_STATE_PENDING`, so poll + * GetSandbox until the state is `SANDBOX_STATE_RUNNING` before running commands in it. A sandbox + * that fails to provision ends in `SANDBOX_STATE_STOPPED`. Returns ALREADY_EXISTS if a sandbox + * with the same ID already exists in the workspace. + */ public Sandbox createSandbox(CreateSandboxRequest request) { return impl.createSandbox(request); } @@ -49,7 +55,11 @@ public void deleteSandbox(String name) { deleteSandbox(new DeleteSandboxRequest().setName(name)); } - /** Deletes a Sandbox. */ + /** + * Deletes a sandbox, including the data in its home directory. A pending or running sandbox is + * stopped first and is removed once the teardown completes, after which GetSandbox returns + * NOT_FOUND. Deleting a sandbox that is already being deleted succeeds. + */ public void deleteSandbox(DeleteSandboxRequest request) { impl.deleteSandbox(request); } @@ -139,7 +149,10 @@ public Iterable listDirectoryContents(ListDirectoryContentsRequ }); } - /** Lists all Sandboxes. */ + /** + * Lists the sandboxes in the workspace that are visible to the caller, including stopped + * sandboxes. Sandboxes that are being deleted are not returned. + */ public Iterable listSandboxes(ListSandboxesRequest request) { return Paginator.newTokenPagination( request, @@ -160,14 +173,23 @@ public RenamePathResponse renamePath(RenamePathRequest request) { } /** - * Starts a previously stopped Sandbox under the same sandbox name. Returns NOT_FOUND if there is - * no stopped sandbox to start for the given name. + * Starts a previously stopped sandbox under the same sandbox name, with the data in its home + * directory intact. Starting is asynchronous: the response usually shows the sandbox in + * `SANDBOX_STATE_PENDING`, so poll GetSandbox until the state is `SANDBOX_STATE_RUNNING`. Returns + * NOT_FOUND if the sandbox does not exist, FAILED_PRECONDITION if it is pending or running, and + * ABORTED while it is still stopping. */ public Sandbox startSandbox(StartSandboxRequest request) { return impl.startSandbox(request); } - /** Stops a running Sandbox, preserving it so it can later be restarted with a Start request. */ + /** + * Stops a running sandbox, preserving it so it can later be restarted with a Start request. + * Stopping is asynchronous: the response usually shows the sandbox in `SANDBOX_STATE_STOPPING`, + * and it settles to `SANDBOX_STATE_STOPPED` once the shutdown completes. The data in the home + * directory is kept; other local changes are discarded. Stopping a sandbox that is already + * stopped or stopping succeeds without changes. + */ public Sandbox stopSandbox(StopSandboxRequest request) { return impl.stopSandbox(request); } diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/SandboxService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/SandboxService.java index f5151215f..d309436de 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/SandboxService.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/SandboxService.java @@ -16,7 +16,13 @@ public interface SandboxService { /** Creates a directory in a sandbox, including missing parents by default. */ CreateDirectoryResponse createDirectory(CreateDirectoryRequest createDirectoryRequest); - /** Creates a new Sandbox. */ + /** + * Creates a sandbox with the given `sandbox_id` and starts provisioning it. Provisioning is + * asynchronous: the response usually shows the sandbox in `SANDBOX_STATE_PENDING`, so poll + * GetSandbox until the state is `SANDBOX_STATE_RUNNING` before running commands in it. A sandbox + * that fails to provision ends in `SANDBOX_STATE_STOPPED`. Returns ALREADY_EXISTS if a sandbox + * with the same ID already exists in the workspace. + */ Sandbox createSandbox(CreateSandboxRequest createSandboxRequest); /** @@ -25,7 +31,11 @@ public interface SandboxService { */ DeletePathResponse deletePath(DeletePathRequest deletePathRequest); - /** Deletes a Sandbox. */ + /** + * Deletes a sandbox, including the data in its home directory. A pending or running sandbox is + * stopped first and is removed once the teardown completes, after which GetSandbox returns + * NOT_FOUND. Deleting a sandbox that is already being deleted succeeds. + */ void deleteSandbox(DeleteSandboxRequest deleteSandboxRequest); /** @@ -72,19 +82,31 @@ ExecuteCommandSyncResponse executeCommandSync( ListDirectoryContentsResponse listDirectoryContents( ListDirectoryContentsRequest listDirectoryContentsRequest); - /** Lists all Sandboxes. */ + /** + * Lists the sandboxes in the workspace that are visible to the caller, including stopped + * sandboxes. Sandboxes that are being deleted are not returned. + */ ListSandboxesResponse listSandboxes(ListSandboxesRequest listSandboxesRequest); /** Renames a path within a sandbox. The destination must be absent and on the same filesystem. */ RenamePathResponse renamePath(RenamePathRequest renamePathRequest); /** - * Starts a previously stopped Sandbox under the same sandbox name. Returns NOT_FOUND if there is - * no stopped sandbox to start for the given name. + * Starts a previously stopped sandbox under the same sandbox name, with the data in its home + * directory intact. Starting is asynchronous: the response usually shows the sandbox in + * `SANDBOX_STATE_PENDING`, so poll GetSandbox until the state is `SANDBOX_STATE_RUNNING`. Returns + * NOT_FOUND if the sandbox does not exist, FAILED_PRECONDITION if it is pending or running, and + * ABORTED while it is still stopping. */ Sandbox startSandbox(StartSandboxRequest startSandboxRequest); - /** Stops a running Sandbox, preserving it so it can later be restarted with a Start request. */ + /** + * Stops a running sandbox, preserving it so it can later be restarted with a Start request. + * Stopping is asynchronous: the response usually shows the sandbox in `SANDBOX_STATE_STOPPING`, + * and it settles to `SANDBOX_STATE_STOPPED` once the shutdown completes. The data in the home + * directory is kept; other local changes are discarded. Stopping a sandbox that is already + * stopped or stopping succeeds without changes. + */ Sandbox stopSandbox(StopSandboxRequest stopSandboxRequest); /** diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/SandboxSpec.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/SandboxSpec.java index ddf7ce3d7..761f428f3 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/SandboxSpec.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/SandboxSpec.java @@ -9,11 +9,11 @@ @Generated public class SandboxSpec { - /** Compute configuration (size, inactivity timeout) requested for the sandbox. */ + /** Compute settings requested for the sandbox, such as the inactivity timeout. */ @JsonProperty("compute") private ComputeSpec compute; - /** The execution environment to use for the sandbox. */ + /** Software environment for the sandbox, such as the container image it runs. */ @JsonProperty("environment") private EnvironmentSpec environment; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/SandboxStatus.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/SandboxStatus.java index d96107cb1..e2fe84e7f 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/SandboxStatus.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/SandboxStatus.java @@ -9,7 +9,16 @@ @Generated public class SandboxStatus { - /** Lifecycle state of the sandbox. */ + /** + * Lifecycle state of the sandbox. + * + *

- `SANDBOX_STATE_PENDING`: The sandbox is being provisioned after a create or start request + * and cannot run commands yet. - `SANDBOX_STATE_RUNNING`: The sandbox is ready and commands can + * run in it. - `SANDBOX_STATE_STOPPING`: The sandbox is shutting down. It settles to + * `SANDBOX_STATE_STOPPED`, or disappears if it is being deleted. - `SANDBOX_STATE_STOPPED`: The + * sandbox is stopped, by a stop request, inactivity auto-stop, or a failed provisioning. Its home + * directory is kept and it can be started again with StartSandbox. + */ @JsonProperty("state") private SandboxState state; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/UploadFileRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/UploadFileRequest.java index 85faac215..a62972dda 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/UploadFileRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sandbox/UploadFileRequest.java @@ -14,6 +14,16 @@ public class UploadFileRequest { /** The complete file contents. An empty body creates an empty file. */ @JsonIgnore private InputStream contents; + /** + * Whether to replace an existing file. Defaults to true when omitted. If false, the upload + * atomically creates the file only if the destination does not exist, equivalent to + * If-None-Match: *. An existing entry returns 412 Precondition Failed. Explicit true conflicts + * with If-None-Match: *. + */ + @JsonIgnore + @QueryParam("overwrite") + private Boolean overwrite; + /** The sandbox resource name, in the form sandboxes/{sandbox_id}. */ @JsonIgnore private String parent; @@ -31,6 +41,15 @@ public InputStream getContents() { return contents; } + public UploadFileRequest setOverwrite(Boolean overwrite) { + this.overwrite = overwrite; + return this; + } + + public Boolean getOverwrite() { + return overwrite; + } + public UploadFileRequest setParent(String parent) { this.parent = parent; return this; @@ -55,19 +74,21 @@ public boolean equals(Object o) { if (o == null || getClass() != o.getClass()) return false; UploadFileRequest that = (UploadFileRequest) o; return Objects.equals(contents, that.contents) + && Objects.equals(overwrite, that.overwrite) && Objects.equals(parent, that.parent) && Objects.equals(path, that.path); } @Override public int hashCode() { - return Objects.hash(contents, parent, path); + return Objects.hash(contents, overwrite, parent, path); } @Override public String toString() { return new ToStringer(UploadFileRequest.class) .add("contents", contents) + .add("overwrite", overwrite) .add("parent", parent) .add("path", path) .toString(); diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/Config.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/Config.java index e7ab6207b..2c6405a3f 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/Config.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/Config.java @@ -7,33 +7,37 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.util.Objects; +/** Holds the destination-specific configuration. Exactly one of the nested configs is set. */ @Generated public class Config { - /** */ + /** Configures a Slack channel reached through the Databricks Genie app for Slack. */ @JsonProperty("databricks_app_slack") private DatabricksAppSlackConfig databricksAppSlack; - /** */ + /** + * Configures a Microsoft Teams channel reached through the Databricks Genie app for Microsoft + * Teams. + */ @JsonProperty("databricks_app_teams") private DatabricksAppTeamsConfig databricksAppTeams; - /** */ + /** Configures an email destination. */ @JsonProperty("email") private EmailConfig email; - /** */ + /** Configures a generic HTTPS webhook destination. */ @JsonProperty("generic_webhook") private GenericWebhookConfig genericWebhook; - /** */ + /** Configures a Microsoft Teams incoming webhook destination. */ @JsonProperty("microsoft_teams") private MicrosoftTeamsConfig microsoftTeams; - /** */ + /** Configures a PagerDuty destination. */ @JsonProperty("pagerduty") private PagerdutyConfig pagerduty; - /** */ + /** Configures a Slack incoming webhook destination. */ @JsonProperty("slack") private SlackConfig slack; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/DeleteNotificationDestinationRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/DeleteNotificationDestinationRequest.java index 9f262fd81..277ea90ec 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/DeleteNotificationDestinationRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/DeleteNotificationDestinationRequest.java @@ -9,7 +9,7 @@ @Generated public class DeleteNotificationDestinationRequest { - /** */ + /** A UUID identifying the notification destination. */ @JsonIgnore private String id; public DeleteNotificationDestinationRequest setId(String id) { diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/DestinationType.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/DestinationType.java index 74ca831fd..2ff781d5b 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/DestinationType.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/DestinationType.java @@ -4,6 +4,7 @@ import com.databricks.sdk.support.Generated; +/** The kind of destination that notifications are sent to. */ @Generated public enum DestinationType { DATABRICKS_APP_SLACK, diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/EmailConfig.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/EmailConfig.java index 56cfaf882..f7707ddb4 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/EmailConfig.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/EmailConfig.java @@ -8,9 +8,10 @@ import java.util.Collection; import java.util.Objects; +/** Configures an email destination. */ @Generated public class EmailConfig { - /** Email addresses to notify. */ + /** Email addresses to notify. At least one address is required. */ @JsonProperty("addresses") private Collection addresses; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/GenericWebhookConfig.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/GenericWebhookConfig.java index 4bbc481ad..e1e1c9b62 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/GenericWebhookConfig.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/GenericWebhookConfig.java @@ -7,9 +7,15 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.util.Objects; +/** + * Configures a generic webhook destination. Notifications are delivered as HTTPS POST requests to + * url, optionally authenticated with HTTP Basic authentication. + */ @Generated public class GenericWebhookConfig { - /** [Input-Only][Optional] Password for webhook. */ + /** + * [Input-Only][Optional] Password for HTTP Basic authentication. Set it together with username. + */ @JsonProperty("password") private String password; @@ -17,7 +23,7 @@ public class GenericWebhookConfig { @JsonProperty("password_set") private Boolean passwordSet; - /** [Input-Only] URL for webhook. */ + /** [Input-Only] HTTPS URL that notifications are posted to. */ @JsonProperty("url") private String url; @@ -25,7 +31,9 @@ public class GenericWebhookConfig { @JsonProperty("url_set") private Boolean urlSet; - /** [Input-Only][Optional] Username for webhook. */ + /** + * [Input-Only][Optional] Username for HTTP Basic authentication. Set it together with password. + */ @JsonProperty("username") private String username; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/GetNotificationDestinationRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/GetNotificationDestinationRequest.java index e5ea2ce40..86a1070b6 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/GetNotificationDestinationRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/GetNotificationDestinationRequest.java @@ -9,7 +9,7 @@ @Generated public class GetNotificationDestinationRequest { - /** */ + /** A UUID identifying the notification destination. */ @JsonIgnore private String id; public GetNotificationDestinationRequest setId(String id) { diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/ListNotificationDestinationsRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/ListNotificationDestinationsRequest.java index 0dd3f971a..17591db36 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/ListNotificationDestinationsRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/ListNotificationDestinationsRequest.java @@ -10,12 +10,14 @@ @Generated public class ListNotificationDestinationsRequest { - /** */ + /** Maximum number of notification destinations to return per page. Defaults to 20. */ @JsonIgnore @QueryParam("page_size") private Long pageSize; - /** */ + /** + * Opaque token returned as next_page_token by a previous call. Omit it to request the first page. + */ @JsonIgnore @QueryParam("page_token") private String pageToken; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/ListNotificationDestinationsResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/ListNotificationDestinationsResponse.java index fd6626b15..ed47dc4e0 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/ListNotificationDestinationsResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/ListNotificationDestinationsResponse.java @@ -10,11 +10,14 @@ @Generated public class ListNotificationDestinationsResponse { - /** Page token for next of results. */ + /** + * Token to pass as page_token to fetch the next page of results. Absent when there are no more + * results. + */ @JsonProperty("next_page_token") private String nextPageToken; - /** */ + /** Notification destinations in the current page. */ @JsonProperty("results") private Collection results; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/ListNotificationDestinationsResult.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/ListNotificationDestinationsResult.java index 652046f46..7d81bde4b 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/ListNotificationDestinationsResult.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/ListNotificationDestinationsResult.java @@ -7,10 +7,19 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.util.Objects; +/** + * A reusable definition of where a workspace sends notifications, such as a Slack channel, a set of + * email addresses, a PagerDuty service, a Microsoft Teams channel or a generic webhook. Job + * notifications, SQL alerts and other workspace features reference a destination by its id. Only + * workspace admins can create, update and delete destinations; once created, a destination is + * available to all users in the workspace. Secret values such as webhook URLs and tokens are + * write-only: responses report whether each one is set, never its value. + */ @Generated public class ListNotificationDestinationsResult { /** - * [Output-only] The type of the notification destination. The type can not be changed once set. + * [Output-only] The type of the notification destination, determined by which nested config was + * provided on creation. The type can not be changed once set. */ @JsonProperty("destination_type") private DestinationType destinationType; @@ -19,7 +28,7 @@ public class ListNotificationDestinationsResult { @JsonProperty("display_name") private String displayName; - /** UUID identifying notification destination. */ + /** A UUID identifying the notification destination. */ @JsonProperty("id") private String id; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/MicrosoftTeamsConfig.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/MicrosoftTeamsConfig.java index 866a8b0e4..81b558e55 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/MicrosoftTeamsConfig.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/MicrosoftTeamsConfig.java @@ -7,9 +7,17 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.util.Objects; +/** + * Configures a Microsoft Teams destination. Notifications are posted to the incoming webhook url, + * which is required. The app_id, auth_secret, channel_url and tenant_id fields can optionally be + * set together to post through a Microsoft Teams app. + */ @Generated public class MicrosoftTeamsConfig { - /** [Input-Only] App ID for Microsoft Teams App. */ + /** + * [Input-Only] Application (client) ID of the Microsoft Teams app, as a UUID. Optional; set it + * together with auth_secret, channel_url and tenant_id. + */ @JsonProperty("app_id") private String appId; @@ -17,7 +25,10 @@ public class MicrosoftTeamsConfig { @JsonProperty("app_id_set") private Boolean appIdSet; - /** [Input-Only] Secret for Microsoft Teams App authentication. */ + /** + * [Input-Only] Client secret of the Microsoft Teams app. Optional; set it together with app_id, + * channel_url and tenant_id. + */ @JsonProperty("auth_secret") private String authSecret; @@ -25,7 +36,10 @@ public class MicrosoftTeamsConfig { @JsonProperty("auth_secret_set") private Boolean authSecretSet; - /** [Input-Only] Channel URL for Microsoft Teams App. */ + /** + * [Input-Only] URL of the Microsoft Teams channel that the app posts to. Optional; set it + * together with app_id, auth_secret and tenant_id. + */ @JsonProperty("channel_url") private String channelUrl; @@ -33,7 +47,10 @@ public class MicrosoftTeamsConfig { @JsonProperty("channel_url_set") private Boolean channelUrlSet; - /** [Input-Only] Tenant ID for Microsoft Teams App. */ + /** + * [Input-Only] Microsoft Entra tenant ID of the Microsoft Teams app, as a UUID. Optional; set it + * together with app_id, auth_secret and channel_url. + */ @JsonProperty("tenant_id") private String tenantId; @@ -41,7 +58,10 @@ public class MicrosoftTeamsConfig { @JsonProperty("tenant_id_set") private Boolean tenantIdSet; - /** [Input-Only] URL for Microsoft Teams webhook. */ + /** + * [Input-Only] Microsoft Teams incoming webhook URL that notifications are posted to. Must be an + * HTTPS URL. The URL is required even when the app fields are set. + */ @JsonProperty("url") private String url; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/NotificationDestination.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/NotificationDestination.java index 15289ade8..08ff3ff68 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/NotificationDestination.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/NotificationDestination.java @@ -7,17 +7,26 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.util.Objects; +/** + * A reusable definition of where a workspace sends notifications, such as a Slack channel, a set of + * email addresses, a PagerDuty service, a Microsoft Teams channel or a generic webhook. Job + * notifications, SQL alerts and other workspace features reference a destination by its id. Only + * workspace admins can create, update and delete destinations; once created, a destination is + * available to all users in the workspace. Secret values such as webhook URLs and tokens are + * write-only: responses report whether each one is set, never its value. + */ @Generated public class NotificationDestination { /** * The configuration for the notification destination. Will be exactly one of the nested configs. - * Only returns for users with workspace admin permissions. + * Only returned to users with workspace admin permissions. */ @JsonProperty("config") private Config config; /** - * [Output-only] The type of the notification destination. The type can not be changed once set. + * [Output-only] The type of the notification destination, determined by which nested config was + * provided on creation. The type can not be changed once set. */ @JsonProperty("destination_type") private DestinationType destinationType; @@ -26,7 +35,7 @@ public class NotificationDestination { @JsonProperty("display_name") private String displayName; - /** UUID identifying notification destination. */ + /** A UUID identifying the notification destination. */ @JsonProperty("id") private String id; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/NotificationDestinationsAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/NotificationDestinationsAPI.java index db48f0cd2..aec27139a 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/NotificationDestinationsAPI.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/NotificationDestinationsAPI.java @@ -47,12 +47,15 @@ public NotificationDestination get(String id) { return get(new GetNotificationDestinationRequest().setId(id)); } - /** Gets a notification destination. */ + /** Gets a notification destination by ID. Workspace admins also receive its config. */ public NotificationDestination get(GetNotificationDestinationRequest request) { return impl.get(request); } - /** Lists notification destinations. */ + /** + * Lists the notification destinations in the workspace. Results never include a destination's + * config; workspace admins can retrieve it with Get. + */ public Iterable list( ListNotificationDestinationsRequest request) { return Paginator.newTokenPagination( @@ -70,7 +73,7 @@ public Iterable list( /** * Updates a notification destination. Requires workspace admin permissions. At least one field is - * required in the request body. + * required in the request body. A config provided in the request replaces the existing one. */ public NotificationDestination update(UpdateNotificationDestinationRequest request) { return impl.update(request); diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/NotificationDestinationsService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/NotificationDestinationsService.java index 74b8eb0c5..cd4596435 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/NotificationDestinationsService.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/NotificationDestinationsService.java @@ -22,16 +22,19 @@ NotificationDestination create( /** Deletes a notification destination. Requires workspace admin permissions. */ void delete(DeleteNotificationDestinationRequest deleteNotificationDestinationRequest); - /** Gets a notification destination. */ + /** Gets a notification destination by ID. Workspace admins also receive its config. */ NotificationDestination get(GetNotificationDestinationRequest getNotificationDestinationRequest); - /** Lists notification destinations. */ + /** + * Lists the notification destinations in the workspace. Results never include a destination's + * config; workspace admins can retrieve it with Get. + */ ListNotificationDestinationsResponse list( ListNotificationDestinationsRequest listNotificationDestinationsRequest); /** * Updates a notification destination. Requires workspace admin permissions. At least one field is - * required in the request body. + * required in the request body. A config provided in the request replaces the existing one. */ NotificationDestination update( UpdateNotificationDestinationRequest updateNotificationDestinationRequest); diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/PagerdutyConfig.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/PagerdutyConfig.java index 6d6dfd08b..489468b0a 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/PagerdutyConfig.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/PagerdutyConfig.java @@ -7,9 +7,16 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.util.Objects; +/** + * Configures a PagerDuty destination. Notifications are sent as events to the PagerDuty Events API + * v2. + */ @Generated public class PagerdutyConfig { - /** [Input-Only] Integration key for PagerDuty. */ + /** + * [Input-Only] Integration key from an Events API v2 integration on the PagerDuty service that + * receives the notifications. + */ @JsonProperty("integration_key") private String integrationKey; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/SlackConfig.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/SlackConfig.java index f517bef0c..f2b13ed96 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/SlackConfig.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/SlackConfig.java @@ -7,9 +7,17 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.util.Objects; +/** + * Configures a Slack destination. Notifications are posted to the incoming webhook url, which is + * required. A bot oauth_token and channel_id can optionally be set together to post to the channel + * through the Slack API. + */ @Generated public class SlackConfig { - /** [Input-Only] Slack channel ID for notifications. */ + /** + * [Input-Only] ID of the Slack channel that notifications are posted to through the Slack API. + * Optional; set it together with oauth_token. + */ @JsonProperty("channel_id") private String channelId; @@ -17,7 +25,10 @@ public class SlackConfig { @JsonProperty("channel_id_set") private Boolean channelIdSet; - /** [Input-Only] OAuth token for Slack authentication. */ + /** + * [Input-Only] Slack bot OAuth token (xoxb-...). Optional; when set together with channel_id, + * notifications are posted to that channel through the Slack API. + */ @JsonProperty("oauth_token") private String oauthToken; @@ -25,7 +36,10 @@ public class SlackConfig { @JsonProperty("oauth_token_set") private Boolean oauthTokenSet; - /** [Input-Only] URL for Slack destination. */ + /** + * [Input-Only] Slack incoming webhook URL that notifications are posted to. Must be an HTTPS URL. + * The URL is required even when oauth_token and channel_id are set. + */ @JsonProperty("url") private String url; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/UpdateNotificationDestinationRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/UpdateNotificationDestinationRequest.java index 7554ec304..108288ffb 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/UpdateNotificationDestinationRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/UpdateNotificationDestinationRequest.java @@ -21,7 +21,7 @@ public class UpdateNotificationDestinationRequest { @JsonProperty("display_name") private String displayName; - /** UUID identifying notification destination. */ + /** A UUID identifying the notification destination. */ @JsonIgnore private String id; public UpdateNotificationDestinationRequest setConfig(Config config) { diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/CreateQueryRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/CreateQueryRequest.java index 99a698477..639d99d47 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/CreateQueryRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/CreateQueryRequest.java @@ -16,7 +16,7 @@ public class CreateQueryRequest { @JsonProperty("auto_resolve_display_name") private Boolean autoResolveDisplayName; - /** */ + /** The query to create. A display name and query text are required. */ @JsonProperty("query") private CreateQueryRequestQuery query; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/CreateQueryRequestQuery.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/CreateQueryRequestQuery.java index 021b71fd0..874167c5e 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/CreateQueryRequestQuery.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/CreateQueryRequestQuery.java @@ -8,6 +8,10 @@ import java.util.Collection; import java.util.Objects; +/** + * A saved Databricks SQL query. A query stores the SQL text, the SQL warehouse it runs on, its + * parameters, and metadata such as the display name, description, owner, and tags. + */ @Generated public class CreateQueryRequestQuery { /** Whether to apply a 1000 row limit to the query result. */ @@ -42,7 +46,12 @@ public class CreateQueryRequestQuery { @JsonProperty("query_text") private String queryText; - /** Sets the "Run as" role for the object. */ + /** + * Whose credentials the query runs with when it is shared. `VIEWER` uses the credentials of the + * user running the query. `OWNER` uses the owner's credentials where the product supports that, + * such as for legacy alerts and jobs. When omitted on create, the workspace default applies. A + * workspace admin can disallow `OWNER`. + */ @JsonProperty("run_as_mode") private RunAsMode runAsMode; @@ -50,7 +59,7 @@ public class CreateQueryRequestQuery { @JsonProperty("schema") private String schema; - /** */ + /** Tags attached to the query. Tags appear in the query list and can be used to filter it. */ @JsonProperty("tags") private Collection tags; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/DateRange.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/DateRange.java index 34da06295..caaa3f96c 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/DateRange.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/DateRange.java @@ -9,11 +9,14 @@ @Generated public class DateRange { - /** */ + /** End of the range, in the same format as `start`. */ @JsonProperty("end") private String end; - /** */ + /** + * Start of the range in the format `yyyy-MM-dd`, optionally followed by a time as ` HH:mm` or ` + * HH:mm:ss`. + */ @JsonProperty("start") private String start; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/DateRangeValue.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/DateRangeValue.java index cd955201c..8605f2930 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/DateRangeValue.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/DateRangeValue.java @@ -24,7 +24,10 @@ public class DateRangeValue { @JsonProperty("precision") private DatePrecision precision; - /** */ + /** + * Day the week starts on for week-based dynamic ranges such as `THIS_WEEK` and `LAST_WEEK`, from + * 0 (Sunday) to 6 (Saturday). Defaults to 0. + */ @JsonProperty("start_day_of_week") private Long startDayOfWeek; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/DateValue.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/DateValue.java index 4125832ec..3192be3a8 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/DateValue.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/DateValue.java @@ -9,7 +9,10 @@ @Generated public class DateValue { - /** Manually specified date-time value. */ + /** + * Manually specified date-time value in the format `yyyy-MM-dd`, optionally followed by a time as + * ` HH:mm` or ` HH:mm:ss`. + */ @JsonProperty("date_value") private String dateValue; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/GetQueryRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/GetQueryRequest.java index cb97eae2e..b5ab75857 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/GetQueryRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/GetQueryRequest.java @@ -9,7 +9,7 @@ @Generated public class GetQueryRequest { - /** */ + /** UUID of the query to fetch. */ @JsonIgnore private String id; public GetQueryRequest setId(String id) { diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/ListQueriesRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/ListQueriesRequest.java index 47d3f64ec..dc7767725 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/ListQueriesRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/ListQueriesRequest.java @@ -10,12 +10,12 @@ @Generated public class ListQueriesRequest { - /** */ + /** Maximum number of queries to return per page. Values above 100 are coerced to 100. */ @JsonIgnore @QueryParam("page_size") private Long pageSize; - /** */ + /** Token from the `next_page_token` of a previous response. Omit it to fetch the first page. */ @JsonIgnore @QueryParam("page_token") private String pageToken; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/ListQueryObjectsResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/ListQueryObjectsResponse.java index af3f69497..65496b235 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/ListQueryObjectsResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/ListQueryObjectsResponse.java @@ -10,11 +10,11 @@ @Generated public class ListQueryObjectsResponse { - /** */ + /** Token to pass as `page_token` to fetch the next page. Omitted when there are no more pages. */ @JsonProperty("next_page_token") private String nextPageToken; - /** */ + /** Queries on this page. */ @JsonProperty("results") private Collection results; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/ListQueryObjectsResponseQuery.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/ListQueryObjectsResponseQuery.java index 1d3b1da0d..3af6f3c37 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/ListQueryObjectsResponseQuery.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/ListQueryObjectsResponseQuery.java @@ -8,6 +8,10 @@ import java.util.Collection; import java.util.Objects; +/** + * A saved Databricks SQL query. A query stores the SQL text, the SQL warehouse it runs on, its + * parameters, and metadata such as the display name, description, owner, and tags. + */ @Generated public class ListQueryObjectsResponseQuery { /** Whether to apply a 1000 row limit to the query result. */ @@ -58,7 +62,12 @@ public class ListQueryObjectsResponseQuery { @JsonProperty("query_text") private String queryText; - /** Sets the "Run as" role for the object. */ + /** + * Whose credentials the query runs with when it is shared. `VIEWER` uses the credentials of the + * user running the query. `OWNER` uses the owner's credentials where the product supports that, + * such as for legacy alerts and jobs. When omitted on create, the workspace default applies. A + * workspace admin can disallow `OWNER`. + */ @JsonProperty("run_as_mode") private RunAsMode runAsMode; @@ -66,7 +75,7 @@ public class ListQueryObjectsResponseQuery { @JsonProperty("schema") private String schema; - /** */ + /** Tags attached to the query. Tags appear in the query list and can be used to filter it. */ @JsonProperty("tags") private Collection tags; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/NumericValue.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/NumericValue.java index cf9dde0b1..b6beeb89d 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/NumericValue.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/NumericValue.java @@ -9,7 +9,7 @@ @Generated public class NumericValue { - /** */ + /** Number substituted for the parameter marker when the query runs. */ @JsonProperty("value") private Double value; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/QueriesAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/QueriesAPI.java index f44bdee1d..5253ce521 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/QueriesAPI.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/QueriesAPI.java @@ -29,7 +29,7 @@ public QueriesAPI(QueriesService mock) { impl = mock; } - /** Creates a query. */ + /** Creates a query. The caller becomes the owner of the new query. */ public Query create(CreateQueryRequest request) { return impl.create(request); } @@ -94,7 +94,11 @@ public Iterable listVisualizations(ListVisualizationsForQueryRequ }); } - /** Updates a query. */ + /** + * Updates the fields of a query named in `update_mask`. Changing `owner_user_name` requires + * workspace admin privileges. Changing `run_as_mode` requires CAN MANAGE permission on the query, + * and only the query owner can switch it to `OWNER`. + */ public Query update(UpdateQueryRequest request) { return impl.update(request); } diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/QueriesService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/QueriesService.java index 7e2bb0b9b..4034f893e 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/QueriesService.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/QueriesService.java @@ -15,7 +15,7 @@ */ @Generated public interface QueriesService { - /** Creates a query. */ + /** Creates a query. The caller becomes the owner of the new query. */ Query create(CreateQueryRequest createQueryRequest); /** @@ -39,6 +39,10 @@ public interface QueriesService { ListVisualizationsForQueryResponse listVisualizations( ListVisualizationsForQueryRequest listVisualizationsForQueryRequest); - /** Updates a query. */ + /** + * Updates the fields of a query named in `update_mask`. Changing `owner_user_name` requires + * workspace admin privileges. Changing `run_as_mode` requires CAN MANAGE permission on the query, + * and only the query owner can switch it to `OWNER`. + */ Query update(UpdateQueryRequest updateQueryRequest); } diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/Query.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/Query.java index 0b60ec358..16e589057 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/Query.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/Query.java @@ -8,6 +8,10 @@ import java.util.Collection; import java.util.Objects; +/** + * A saved Databricks SQL query. A query stores the SQL text, the SQL warehouse it runs on, its + * parameters, and metadata such as the display name, description, owner, and tags. + */ @Generated public class Query { /** Whether to apply a 1000 row limit to the query result. */ @@ -62,7 +66,12 @@ public class Query { @JsonProperty("query_text") private String queryText; - /** Sets the "Run as" role for the object. */ + /** + * Whose credentials the query runs with when it is shared. `VIEWER` uses the credentials of the + * user running the query. `OWNER` uses the owner's credentials where the product supports that, + * such as for legacy alerts and jobs. When omitted on create, the workspace default applies. A + * workspace admin can disallow `OWNER`. + */ @JsonProperty("run_as_mode") private RunAsMode runAsMode; @@ -70,7 +79,7 @@ public class Query { @JsonProperty("schema") private String schema; - /** */ + /** Tags attached to the query. Tags appear in the query list and can be used to filter it. */ @JsonProperty("tags") private Collection tags; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/StatementExecutionAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/StatementExecutionAPI.java index 95b392607..693877e02 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/StatementExecutionAPI.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/StatementExecutionAPI.java @@ -14,6 +14,12 @@ * *

We suggest beginning with the [Databricks SQL Statement Execution API tutorial]. * + *

**Lakehouse//RT warehouses** + * + *

You can run statements on [Lakehouse//RT] warehouses with this API. For lower latency and + * higher concurrency, use version 2 of this API, Statement Execution (Lakehouse//RT), instead. It + * works the same way, except that `warehouse_id` is a path parameter. + * *

**Overview of statement execution and result fetching** * *

Statement execution begins by issuing a :method:statementexecution/executeStatement request @@ -98,6 +104,7 @@ * *

[Apache Arrow Columnar]: https://arrow.apache.org/overview/ [Databricks SQL Statement * Execution API tutorial]: https://docs.databricks.com/sql/api/sql-execution-tutorial.html + * [Lakehouse//RT]: https://docs.databricks.com/compute/sql-warehouse/real-time.html */ @Generated public class StatementExecutionAPI { diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/StatementExecutionService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/StatementExecutionService.java index 9218df67d..ab7ef7619 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/StatementExecutionService.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/StatementExecutionService.java @@ -11,6 +11,12 @@ * *

We suggest beginning with the [Databricks SQL Statement Execution API tutorial]. * + *

**Lakehouse//RT warehouses** + * + *

You can run statements on [Lakehouse//RT] warehouses with this API. For lower latency and + * higher concurrency, use version 2 of this API, Statement Execution (Lakehouse//RT), instead. It + * works the same way, except that `warehouse_id` is a path parameter. + * *

**Overview of statement execution and result fetching** * *

Statement execution begins by issuing a :method:statementexecution/executeStatement request @@ -95,6 +101,7 @@ * *

[Apache Arrow Columnar]: https://arrow.apache.org/overview/ [Databricks SQL Statement * Execution API tutorial]: https://docs.databricks.com/sql/api/sql-execution-tutorial.html + * [Lakehouse//RT]: https://docs.databricks.com/compute/sql-warehouse/real-time.html * *

This is the high-level interface, that contains generated methods. * diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/StatementResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/StatementResponse.java index ec0b18178..de4dffd93 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/StatementResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/StatementResponse.java @@ -7,6 +7,11 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.util.Objects; +/** + * Statement Execution works with all SQL warehouse types, including Lakehouse//RT. Statement + * Execution (Lakehouse//RT) is optimized for Lakehouse//RT warehouses, with lower latency and + * higher concurrency, and takes `warehouse_id` as a path parameter. + */ @Generated public class StatementResponse { /** */ diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/TextValue.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/TextValue.java index d57997e4e..0a2bdbad3 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/TextValue.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/TextValue.java @@ -9,7 +9,10 @@ @Generated public class TextValue { - /** */ + /** + * Text substituted for the parameter marker when the query runs. Quotation marks are added around + * the value automatically. + */ @JsonProperty("value") private String value; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/TrashQueryRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/TrashQueryRequest.java index adb5471e6..0a06f979f 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/TrashQueryRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/TrashQueryRequest.java @@ -9,7 +9,7 @@ @Generated public class TrashQueryRequest { - /** */ + /** UUID of the query to move to the trash. */ @JsonIgnore private String id; public TrashQueryRequest setId(String id) { diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/UpdateQueryRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/UpdateQueryRequest.java index 46be75273..169f5e19a 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/UpdateQueryRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/UpdateQueryRequest.java @@ -11,25 +11,28 @@ @Generated public class UpdateQueryRequest { /** - * If true, automatically resolve alert display name conflicts. Otherwise, fail the request if the - * alert's display name conflicts with an existing alert's display name. + * If true, automatically resolve query display name conflicts. Otherwise, fail the request if the + * query's display name conflicts with an existing query's display name. */ @JsonProperty("auto_resolve_display_name") private Boolean autoResolveDisplayName; - /** */ + /** UUID of the query to update. */ @JsonIgnore private String id; - /** */ + /** Query fields to update. Only the fields named in `update_mask` are changed. */ @JsonProperty("query") private UpdateQueryRequestQuery query; /** - * The field mask must be a single string, with multiple fields separated by commas (no spaces). - * The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields - * (e.g., `author.given_name`). Specification of elements in sequence or map fields is not - * allowed, as only the entire collection field can be specified. Field names must exactly match - * the resource field names. + * Comma-separated list of the query fields to update, such as the display name or query text. + * Fields not listed keep their current values. + * + *

The field mask must be a single string, with multiple fields separated by commas (no + * spaces). The field path is relative to the resource object, using a dot (`.`) to navigate + * sub-fields (e.g., `author.given_name`). Specification of elements in sequence or map fields is + * not allowed, as only the entire collection field can be specified. Field names must exactly + * match the resource field names. * *

A field mask of `*` indicates full replacement. It’s recommended to always explicitly list * the fields being updated and avoid using `*` wildcards, as it can lead to unintended results if diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/UpdateQueryRequestQuery.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/UpdateQueryRequestQuery.java index a0d9ac14e..2c0368ea7 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/UpdateQueryRequestQuery.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/UpdateQueryRequestQuery.java @@ -8,6 +8,10 @@ import java.util.Collection; import java.util.Objects; +/** + * A saved Databricks SQL query. A query stores the SQL text, the SQL warehouse it runs on, its + * parameters, and metadata such as the display name, description, owner, and tags. + */ @Generated public class UpdateQueryRequestQuery { /** Whether to apply a 1000 row limit to the query result. */ @@ -42,7 +46,12 @@ public class UpdateQueryRequestQuery { @JsonProperty("query_text") private String queryText; - /** Sets the "Run as" role for the object. */ + /** + * Whose credentials the query runs with when it is shared. `VIEWER` uses the credentials of the + * user running the query. `OWNER` uses the owner's credentials where the product supports that, + * such as for legacy alerts and jobs. When omitted on create, the workspace default applies. A + * workspace admin can disallow `OWNER`. + */ @JsonProperty("run_as_mode") private RunAsMode runAsMode; @@ -50,7 +59,7 @@ public class UpdateQueryRequestQuery { @JsonProperty("schema") private String schema; - /** */ + /** Tags attached to the query. Tags appear in the query list and can be used to filter it. */ @JsonProperty("tags") private Collection tags; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/BaseChunkInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/BaseChunkInfo.java new file mode 100644 index 000000000..c6d674ac7 --- /dev/null +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/BaseChunkInfo.java @@ -0,0 +1,93 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. + +package com.databricks.sdk.service.statementexecutionv2; + +import com.databricks.sdk.support.Generated; +import com.databricks.sdk.support.ToStringer; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.Objects; + +/** Metadata of one result set chunk, as listed in the result manifest. */ +@Generated +public class BaseChunkInfo { + /** + * The number of bytes in the result chunk. This field is not available when using `INLINE` + * disposition. + */ + @JsonProperty("byte_count") + private Long byteCount; + + /** The position within the sequence of result set chunks. */ + @JsonProperty("chunk_index") + private Long chunkIndex; + + /** The number of rows within the result chunk. */ + @JsonProperty("row_count") + private Long rowCount; + + /** The starting row offset within the result set. */ + @JsonProperty("row_offset") + private Long rowOffset; + + public BaseChunkInfo setByteCount(Long byteCount) { + this.byteCount = byteCount; + return this; + } + + public Long getByteCount() { + return byteCount; + } + + public BaseChunkInfo setChunkIndex(Long chunkIndex) { + this.chunkIndex = chunkIndex; + return this; + } + + public Long getChunkIndex() { + return chunkIndex; + } + + public BaseChunkInfo setRowCount(Long rowCount) { + this.rowCount = rowCount; + return this; + } + + public Long getRowCount() { + return rowCount; + } + + public BaseChunkInfo setRowOffset(Long rowOffset) { + this.rowOffset = rowOffset; + return this; + } + + public Long getRowOffset() { + return rowOffset; + } + + @Override + public boolean equals(Object o) { + if (this == o) return true; + if (o == null || getClass() != o.getClass()) return false; + BaseChunkInfo that = (BaseChunkInfo) o; + return Objects.equals(byteCount, that.byteCount) + && Objects.equals(chunkIndex, that.chunkIndex) + && Objects.equals(rowCount, that.rowCount) + && Objects.equals(rowOffset, that.rowOffset); + } + + @Override + public int hashCode() { + return Objects.hash(byteCount, chunkIndex, rowCount, rowOffset); + } + + @Override + public String toString() { + return new ToStringer(BaseChunkInfo.class) + .add("byteCount", byteCount) + .add("chunkIndex", chunkIndex) + .add("rowCount", rowCount) + .add("rowOffset", rowOffset) + .toString(); + } +} diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/CancelStatementRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/CancelStatementRequest.java new file mode 100644 index 000000000..9176af284 --- /dev/null +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/CancelStatementRequest.java @@ -0,0 +1,61 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. + +package com.databricks.sdk.service.statementexecutionv2; + +import com.databricks.sdk.support.Generated; +import com.databricks.sdk.support.ToStringer; +import com.fasterxml.jackson.annotation.JsonIgnore; +import java.util.Objects; + +/** Request to cancel the statement given in the path on the warehouse given in the path. */ +@Generated +public class CancelStatementRequest { + /** + * The statement ID is returned upon successfully submitting a SQL statement, and is a required + * reference for all subsequent calls. + */ + @JsonIgnore private String statementId; + + /** The ID of the SQL warehouse that ran the statement. */ + @JsonIgnore private String warehouseId; + + public CancelStatementRequest setStatementId(String statementId) { + this.statementId = statementId; + return this; + } + + public String getStatementId() { + return statementId; + } + + public CancelStatementRequest setWarehouseId(String warehouseId) { + this.warehouseId = warehouseId; + return this; + } + + public String getWarehouseId() { + return warehouseId; + } + + @Override + public boolean equals(Object o) { + if (this == o) return true; + if (o == null || getClass() != o.getClass()) return false; + CancelStatementRequest that = (CancelStatementRequest) o; + return Objects.equals(statementId, that.statementId) + && Objects.equals(warehouseId, that.warehouseId); + } + + @Override + public int hashCode() { + return Objects.hash(statementId, warehouseId); + } + + @Override + public String toString() { + return new ToStringer(CancelStatementRequest.class) + .add("statementId", statementId) + .add("warehouseId", warehouseId) + .toString(); + } +} diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/CancelStatementResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/CancelStatementResponse.java new file mode 100644 index 000000000..0521521d0 --- /dev/null +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/CancelStatementResponse.java @@ -0,0 +1,29 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. + +package com.databricks.sdk.service.statementexecutionv2; + +import com.databricks.sdk.support.Generated; +import com.databricks.sdk.support.ToStringer; +import java.util.Objects; + +/** Empty response to a cancel request. Receiving it means the cancel request was accepted. */ +@Generated +public class CancelStatementResponse { + + @Override + public boolean equals(Object o) { + if (this == o) return true; + if (o == null || getClass() != o.getClass()) return false; + return true; + } + + @Override + public int hashCode() { + return Objects.hash(); + } + + @Override + public String toString() { + return new ToStringer(CancelStatementResponse.class).toString(); + } +} diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/ColumnInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/ColumnInfo.java new file mode 100644 index 000000000..b38d85416 --- /dev/null +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/ColumnInfo.java @@ -0,0 +1,142 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. + +package com.databricks.sdk.service.statementexecutionv2; + +import com.databricks.sdk.support.Generated; +import com.databricks.sdk.support.ToStringer; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.Objects; + +/** Describes one column of the result set: its name, SQL type, and position. */ +@Generated +public class ColumnInfo { + /** The name of the column. */ + @JsonProperty("name") + private String name; + + /** The ordinal position of the column (starting at position 0). */ + @JsonProperty("position") + private Long position; + + /** The format of the interval type. */ + @JsonProperty("type_interval_type") + private String typeIntervalType; + + /** + * The name of the base data type. This doesn't include details for complex types such as STRUCT, + * MAP or ARRAY. + */ + @JsonProperty("type_name") + private ColumnTypeName typeName; + + /** Specifies the number of digits in a number. This applies to the DECIMAL type. */ + @JsonProperty("type_precision") + private Long typePrecision; + + /** + * Specifies the number of digits to the right of the decimal point in a number. This applies to + * the DECIMAL type. + */ + @JsonProperty("type_scale") + private Long typeScale; + + /** The full SQL type specification. */ + @JsonProperty("type_text") + private String typeText; + + public ColumnInfo setName(String name) { + this.name = name; + return this; + } + + public String getName() { + return name; + } + + public ColumnInfo setPosition(Long position) { + this.position = position; + return this; + } + + public Long getPosition() { + return position; + } + + public ColumnInfo setTypeIntervalType(String typeIntervalType) { + this.typeIntervalType = typeIntervalType; + return this; + } + + public String getTypeIntervalType() { + return typeIntervalType; + } + + public ColumnInfo setTypeName(ColumnTypeName typeName) { + this.typeName = typeName; + return this; + } + + public ColumnTypeName getTypeName() { + return typeName; + } + + public ColumnInfo setTypePrecision(Long typePrecision) { + this.typePrecision = typePrecision; + return this; + } + + public Long getTypePrecision() { + return typePrecision; + } + + public ColumnInfo setTypeScale(Long typeScale) { + this.typeScale = typeScale; + return this; + } + + public Long getTypeScale() { + return typeScale; + } + + public ColumnInfo setTypeText(String typeText) { + this.typeText = typeText; + return this; + } + + public String getTypeText() { + return typeText; + } + + @Override + public boolean equals(Object o) { + if (this == o) return true; + if (o == null || getClass() != o.getClass()) return false; + ColumnInfo that = (ColumnInfo) o; + return Objects.equals(name, that.name) + && Objects.equals(position, that.position) + && Objects.equals(typeIntervalType, that.typeIntervalType) + && Objects.equals(typeName, that.typeName) + && Objects.equals(typePrecision, that.typePrecision) + && Objects.equals(typeScale, that.typeScale) + && Objects.equals(typeText, that.typeText); + } + + @Override + public int hashCode() { + return Objects.hash( + name, position, typeIntervalType, typeName, typePrecision, typeScale, typeText); + } + + @Override + public String toString() { + return new ToStringer(ColumnInfo.class) + .add("name", name) + .add("position", position) + .add("typeIntervalType", typeIntervalType) + .add("typeName", typeName) + .add("typePrecision", typePrecision) + .add("typeScale", typeScale) + .add("typeText", typeText) + .toString(); + } +} diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/ColumnTypeName.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/ColumnTypeName.java new file mode 100644 index 000000000..24b38ba2b --- /dev/null +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/ColumnTypeName.java @@ -0,0 +1,32 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. + +package com.databricks.sdk.service.statementexecutionv2; + +import com.databricks.sdk.support.Generated; + +/** + * The name of the base data type. This doesn't include details for complex types such as STRUCT, + * MAP or ARRAY. + */ +@Generated +public enum ColumnTypeName { + ARRAY, + BINARY, + BOOLEAN, + BYTE, + CHAR, + DATE, + DECIMAL, + DOUBLE, + FLOAT, + INT, + INTERVAL, + LONG, + MAP, + NULL, + SHORT, + STRING, + STRUCT, + TIMESTAMP, + USER_DEFINED_TYPE, +} diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/ExecuteStatementRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/ExecuteStatementRequest.java new file mode 100644 index 000000000..1737b4e5b --- /dev/null +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/ExecuteStatementRequest.java @@ -0,0 +1,365 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. + +package com.databricks.sdk.service.statementexecutionv2; + +import com.databricks.sdk.support.Generated; +import com.databricks.sdk.support.ToStringer; +import com.fasterxml.jackson.annotation.JsonIgnore; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.Collection; +import java.util.Objects; + +/** Request to execute a SQL statement on the warehouse given in the path. */ +@Generated +public class ExecuteStatementRequest { + /** + * Applies the given byte limit to the statement's result size. Byte counts are based on internal + * data representations and might not match the final size in the requested `format`. If the + * result was truncated due to the byte limit, then `truncated` in the response is set to `true`. + * When using `EXTERNAL_LINKS` disposition, a default `byte_limit` of 100 GiB is applied if + * `byte_limit` is not explicitly set. + */ + @JsonProperty("byte_limit") + private Long byteLimit; + + /** + * Sets default catalog for statement execution, similar to [`USE CATALOG`] in SQL. + * + *

[`USE CATALOG`]: + * https://docs.databricks.com/sql/language-manual/sql-ref-syntax-ddl-use-catalog.html + */ + @JsonProperty("catalog") + private String catalog; + + /** + * The fetch disposition provides two modes of fetching results: `INLINE` and `EXTERNAL_LINKS`. + * + *

Statements executed with `INLINE` disposition will return result data inline, in + * `JSON_ARRAY` format, in a series of chunks. If a given statement produces a result set with a + * size larger than 25 MiB, that statement execution is aborted, and no result set will be + * available. + * + *

**NOTE** Byte limits are computed based upon internal representations of the result set + * data, and might not match the sizes visible in JSON responses. + * + *

Statements executed with `EXTERNAL_LINKS` disposition will return result data as external + * links: URLs that point to cloud storage internal to the workspace. Using `EXTERNAL_LINKS` + * disposition allows statements to generate arbitrarily sized result sets for fetching up to 100 + * GiB. The resulting links have two important properties: + * + *

1. They point to resources _external_ to the Databricks compute; therefore any associated + * authentication information (typically a personal access token, OAuth token, or similar) _must + * be removed_ when fetching from these links. + * + *

2. These are short-lived cloud-storage URLs with a specific expiration, indicated in the + * response. The behavior when attempting to use an expired link is cloud specific. + */ + @JsonProperty("disposition") + private FetchDisposition disposition; + + /** + * Statement execution supports three result formats: `JSON_ARRAY`, `ARROW_STREAM`, and `CSV`. Set + * `format` explicitly: on Lakehouse//RT warehouses, an omitted `format` with the `INLINE` + * disposition currently returns Arrow data rather than `JSON_ARRAY`. + * + *

Important: The formats `ARROW_STREAM` and `CSV` are supported only with `EXTERNAL_LINKS` + * disposition. `JSON_ARRAY` is supported in `INLINE` and `EXTERNAL_LINKS` disposition. + * + *

When specifying `format=JSON_ARRAY`, result data will be formatted as an array of arrays of + * values, where each value is either the *string representation* of a value, or `null`. For + * example, the output of `SELECT concat('id-', id) AS strCol, id AS intCol, null AS nullCol FROM + * range(3)` would look like this: + * + *

``` [ [ "id-1", "1", null ], [ "id-2", "2", null ], [ "id-3", "3", null ], ] ``` + * + *

When specifying `format=JSON_ARRAY` and `disposition=EXTERNAL_LINKS`, each chunk in the + * result contains compact JSON with no indentation or extra whitespace. + * + *

When specifying `format=ARROW_STREAM` and `disposition=EXTERNAL_LINKS`, each chunk in the + * result will be formatted as Apache Arrow Stream. See the [Apache Arrow streaming format]. + * + *

When specifying `format=CSV` and `disposition=EXTERNAL_LINKS`, each chunk in the result will + * be a CSV according to [RFC 4180] standard. All column values will have *string representation* + * similar to the `JSON_ARRAY` format, and `null` values will be encoded as “null”. Only the first + * chunk in the result would contain a header row with column names. For example, the output of + * `SELECT concat('id-', id) AS strCol, id AS intCol, null as nullCol FROM range(3)` would look + * like this: + * + *

``` strCol,intCol,nullCol id-1,1,null id-2,2,null id-3,3,null ``` + * + *

[Apache Arrow streaming format]: + * https://arrow.apache.org/docs/format/Columnar.html#ipc-streaming-format [RFC 4180]: + * https://www.rfc-editor.org/rfc/rfc4180 + */ + @JsonProperty("format") + private Format format; + + /** + * When `wait_timeout > 0s`, the call will block up to the specified time. If the statement + * execution doesn't finish within this time, `on_wait_timeout` determines whether the execution + * should continue or be canceled. When set to `CONTINUE`, the statement execution continues + * asynchronously and the call returns a statement ID which can be used for polling the statement + * status. When set to `CANCEL`, the statement execution is canceled and the call returns with a + * `CANCELED` state. Lakehouse//RT warehouses currently don't support `CANCEL`: the statement + * keeps running as with `CONTINUE`. + */ + @JsonProperty("on_wait_timeout") + private TimeoutAction onWaitTimeout; + + /** + * A list of parameters to pass into a SQL statement containing parameter markers. A parameter + * consists of a name, a value, and optionally a type. To represent a NULL value, the `value` + * field may be omitted or set to `null` explicitly. If the `type` field is omitted, the value is + * interpreted as a string. + * + *

If the type is given, parameters will be checked for type correctness according to the given + * type. A value is correct if the provided string can be converted to the requested type using + * the `cast` function. The exact semantics are described in the section [`cast` function] of the + * SQL language reference. + * + *

For example, the following statement contains two parameters, `my_name` and `my_date`: + * + *

``` SELECT * FROM my_table WHERE name = :my_name AND date = :my_date ``` + * + *

The parameters can be passed in the request body as follows: + * + *

` { ..., "statement": "SELECT * FROM my_table WHERE name = :my_name AND date = :my_date", + * "parameters": [ { "name": "my_name", "value": "the name" }, { "name": "my_date", "value": + * "2020-01-01", "type": "DATE" } ] } ` + * + *

Currently, positional parameters denoted by a `?` marker are not supported by the Databricks + * SQL Statement Execution API. + * + *

Also see the section [Parameter markers] of the SQL language reference. + * + *

[Parameter markers]: + * https://docs.databricks.com/sql/language-manual/sql-ref-parameter-marker.html [`cast` + * function]: https://docs.databricks.com/sql/language-manual/functions/cast.html + */ + @JsonProperty("parameters") + private Collection parameters; + + /** + * An array of query tags to annotate a SQL statement. A query tag consists of a non-empty key + * and, optionally, a value. To represent a NULL value, either omit the `value` field or manually + * set it to `null` or white space. Refer to the SQL language reference for the format + * specification of query tags. There's no significance to the order of tags. Only one value per + * key will be recorded. A sequence in excess of 20 query tags will be coerced to 20. Example: + * + *

{ ..., "query_tags": [ { "key": "team", "value": "eng" }, { "key": "some key only tag" } ] } + */ + @JsonProperty("query_tags") + private Collection queryTags; + + /** + * Applies the given row limit to the statement's result set, but unlike the `LIMIT` clause in + * SQL, it also sets the `truncated` field in the response to indicate whether the result was + * trimmed due to the limit or not. + */ + @JsonProperty("row_limit") + private Long rowLimit; + + /** + * Sets default schema for statement execution, similar to [`USE SCHEMA`] in SQL. + * + *

[`USE SCHEMA`]: + * https://docs.databricks.com/sql/language-manual/sql-ref-syntax-ddl-use-schema.html + */ + @JsonProperty("schema") + private String schema; + + /** + * The SQL statement to execute. The statement can optionally be parameterized, see `parameters`. + * The maximum query text size is 16 MiB. + */ + @JsonProperty("statement") + private String statement; + + /** + * The time in seconds the call will wait for the statement's result set as `Ns`, where `N` can be + * set to 0 or to a value between 5 and 50. + * + *

When set to `0s`, the statement will execute in asynchronous mode and the call will not wait + * for the execution to finish. In this case, the call returns directly with `PENDING` state and a + * statement ID which can be used for polling the statement status. + * + *

When set between 5 and 50 seconds, the call will behave synchronously up to this timeout and + * wait for the statement execution to finish. If the execution finishes within this time, the + * call returns immediately with a manifest and result data (or a `FAILED` state in case of an + * execution error). If the statement takes longer to execute, `on_wait_timeout` determines what + * should happen after the timeout is reached. + */ + @JsonProperty("wait_timeout") + private String waitTimeout; + + /** + * The ID of the SQL warehouse to run the statement on. Currently, only [Lakehouse//RT] warehouses + * are supported. See also [What are SQL warehouses?]. + * + *

[Lakehouse//RT]: https://docs.databricks.com/compute/sql-warehouse/real-time.html [What are + * SQL warehouses?]: https://docs.databricks.com/sql/admin/warehouse-type.html + */ + @JsonIgnore private String warehouseId; + + public ExecuteStatementRequest setByteLimit(Long byteLimit) { + this.byteLimit = byteLimit; + return this; + } + + public Long getByteLimit() { + return byteLimit; + } + + public ExecuteStatementRequest setCatalog(String catalog) { + this.catalog = catalog; + return this; + } + + public String getCatalog() { + return catalog; + } + + public ExecuteStatementRequest setDisposition(FetchDisposition disposition) { + this.disposition = disposition; + return this; + } + + public FetchDisposition getDisposition() { + return disposition; + } + + public ExecuteStatementRequest setFormat(Format format) { + this.format = format; + return this; + } + + public Format getFormat() { + return format; + } + + public ExecuteStatementRequest setOnWaitTimeout(TimeoutAction onWaitTimeout) { + this.onWaitTimeout = onWaitTimeout; + return this; + } + + public TimeoutAction getOnWaitTimeout() { + return onWaitTimeout; + } + + public ExecuteStatementRequest setParameters(Collection parameters) { + this.parameters = parameters; + return this; + } + + public Collection getParameters() { + return parameters; + } + + public ExecuteStatementRequest setQueryTags(Collection queryTags) { + this.queryTags = queryTags; + return this; + } + + public Collection getQueryTags() { + return queryTags; + } + + public ExecuteStatementRequest setRowLimit(Long rowLimit) { + this.rowLimit = rowLimit; + return this; + } + + public Long getRowLimit() { + return rowLimit; + } + + public ExecuteStatementRequest setSchema(String schema) { + this.schema = schema; + return this; + } + + public String getSchema() { + return schema; + } + + public ExecuteStatementRequest setStatement(String statement) { + this.statement = statement; + return this; + } + + public String getStatement() { + return statement; + } + + public ExecuteStatementRequest setWaitTimeout(String waitTimeout) { + this.waitTimeout = waitTimeout; + return this; + } + + public String getWaitTimeout() { + return waitTimeout; + } + + public ExecuteStatementRequest setWarehouseId(String warehouseId) { + this.warehouseId = warehouseId; + return this; + } + + public String getWarehouseId() { + return warehouseId; + } + + @Override + public boolean equals(Object o) { + if (this == o) return true; + if (o == null || getClass() != o.getClass()) return false; + ExecuteStatementRequest that = (ExecuteStatementRequest) o; + return Objects.equals(byteLimit, that.byteLimit) + && Objects.equals(catalog, that.catalog) + && Objects.equals(disposition, that.disposition) + && Objects.equals(format, that.format) + && Objects.equals(onWaitTimeout, that.onWaitTimeout) + && Objects.equals(parameters, that.parameters) + && Objects.equals(queryTags, that.queryTags) + && Objects.equals(rowLimit, that.rowLimit) + && Objects.equals(schema, that.schema) + && Objects.equals(statement, that.statement) + && Objects.equals(waitTimeout, that.waitTimeout) + && Objects.equals(warehouseId, that.warehouseId); + } + + @Override + public int hashCode() { + return Objects.hash( + byteLimit, + catalog, + disposition, + format, + onWaitTimeout, + parameters, + queryTags, + rowLimit, + schema, + statement, + waitTimeout, + warehouseId); + } + + @Override + public String toString() { + return new ToStringer(ExecuteStatementRequest.class) + .add("byteLimit", byteLimit) + .add("catalog", catalog) + .add("disposition", disposition) + .add("format", format) + .add("onWaitTimeout", onWaitTimeout) + .add("parameters", parameters) + .add("queryTags", queryTags) + .add("rowLimit", rowLimit) + .add("schema", schema) + .add("statement", statement) + .add("waitTimeout", waitTimeout) + .add("warehouseId", warehouseId) + .toString(); + } +} diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/ExternalLink.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/ExternalLink.java new file mode 100644 index 000000000..f6a49d873 --- /dev/null +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/ExternalLink.java @@ -0,0 +1,199 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. + +package com.databricks.sdk.service.statementexecutionv2; + +import com.databricks.sdk.support.Generated; +import com.databricks.sdk.support.ToStringer; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.Map; +import java.util.Objects; + +/** A short-lived cloud-storage link to one chunk of result data. */ +@Generated +public class ExternalLink { + /** + * The number of bytes in the result chunk. This field is not available when using `INLINE` + * disposition. + */ + @JsonProperty("byte_count") + private Long byteCount; + + /** The position within the sequence of result set chunks. */ + @JsonProperty("chunk_index") + private Long chunkIndex; + + /** + * Indicates the date-time that the given external link will expire and become invalid, after + * which point a new `external_link` must be requested. + */ + @JsonProperty("expiration") + private String expiration; + + /** + * A short-lived cloud-storage URL pointing to a chunk of result data, hosted by an external + * service, with a short expiration time (<= 15 minutes). As this URL contains a temporary + * credential, it should be considered sensitive and the client should not expose this URL in a + * log. + */ + @JsonProperty("external_link") + private String externalLink; + + /** + * HTTP headers that must be included with a GET request to the `external_link`. Each header is + * provided as a key-value pair. Headers are typically used to pass a decryption key to the + * external service. The values of these headers should be considered sensitive and the client + * should not expose these values in a log. + */ + @JsonProperty("http_headers") + private Map httpHeaders; + + /** + * When fetching, provides the `chunk_index` for the _next_ chunk. If absent, indicates there are + * no more chunks. The next chunk can be fetched with a get-result-chunk request for that index. + */ + @JsonProperty("next_chunk_index") + private Long nextChunkIndex; + + /** + * When fetching, provides a link to fetch the _next_ chunk. If absent, indicates there are no + * more chunks. This link is an absolute `path` to be joined with your `$DATABRICKS_HOST`, and + * should be treated as an opaque link. This is an alternative to using `next_chunk_index`. + * Lakehouse//RT warehouses currently don't return this field; use `next_chunk_index` instead. + */ + @JsonProperty("next_chunk_internal_link") + private String nextChunkInternalLink; + + /** The number of rows within the result chunk. */ + @JsonProperty("row_count") + private Long rowCount; + + /** The starting row offset within the result set. */ + @JsonProperty("row_offset") + private Long rowOffset; + + public ExternalLink setByteCount(Long byteCount) { + this.byteCount = byteCount; + return this; + } + + public Long getByteCount() { + return byteCount; + } + + public ExternalLink setChunkIndex(Long chunkIndex) { + this.chunkIndex = chunkIndex; + return this; + } + + public Long getChunkIndex() { + return chunkIndex; + } + + public ExternalLink setExpiration(String expiration) { + this.expiration = expiration; + return this; + } + + public String getExpiration() { + return expiration; + } + + public ExternalLink setExternalLink(String externalLink) { + this.externalLink = externalLink; + return this; + } + + public String getExternalLink() { + return externalLink; + } + + public ExternalLink setHttpHeaders(Map httpHeaders) { + this.httpHeaders = httpHeaders; + return this; + } + + public Map getHttpHeaders() { + return httpHeaders; + } + + public ExternalLink setNextChunkIndex(Long nextChunkIndex) { + this.nextChunkIndex = nextChunkIndex; + return this; + } + + public Long getNextChunkIndex() { + return nextChunkIndex; + } + + public ExternalLink setNextChunkInternalLink(String nextChunkInternalLink) { + this.nextChunkInternalLink = nextChunkInternalLink; + return this; + } + + public String getNextChunkInternalLink() { + return nextChunkInternalLink; + } + + public ExternalLink setRowCount(Long rowCount) { + this.rowCount = rowCount; + return this; + } + + public Long getRowCount() { + return rowCount; + } + + public ExternalLink setRowOffset(Long rowOffset) { + this.rowOffset = rowOffset; + return this; + } + + public Long getRowOffset() { + return rowOffset; + } + + @Override + public boolean equals(Object o) { + if (this == o) return true; + if (o == null || getClass() != o.getClass()) return false; + ExternalLink that = (ExternalLink) o; + return Objects.equals(byteCount, that.byteCount) + && Objects.equals(chunkIndex, that.chunkIndex) + && Objects.equals(expiration, that.expiration) + && Objects.equals(externalLink, that.externalLink) + && Objects.equals(httpHeaders, that.httpHeaders) + && Objects.equals(nextChunkIndex, that.nextChunkIndex) + && Objects.equals(nextChunkInternalLink, that.nextChunkInternalLink) + && Objects.equals(rowCount, that.rowCount) + && Objects.equals(rowOffset, that.rowOffset); + } + + @Override + public int hashCode() { + return Objects.hash( + byteCount, + chunkIndex, + expiration, + externalLink, + httpHeaders, + nextChunkIndex, + nextChunkInternalLink, + rowCount, + rowOffset); + } + + @Override + public String toString() { + return new ToStringer(ExternalLink.class) + .add("byteCount", byteCount) + .add("chunkIndex", chunkIndex) + .add("expiration", expiration) + .add("externalLink", externalLink) + .add("httpHeaders", httpHeaders) + .add("nextChunkIndex", nextChunkIndex) + .add("nextChunkInternalLink", nextChunkInternalLink) + .add("rowCount", rowCount) + .add("rowOffset", rowOffset) + .toString(); + } +} diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/FetchDisposition.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/FetchDisposition.java new file mode 100644 index 000000000..c02510a82 --- /dev/null +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/FetchDisposition.java @@ -0,0 +1,11 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. + +package com.databricks.sdk.service.statementexecutionv2; + +import com.databricks.sdk.support.Generated; + +@Generated +public enum FetchDisposition { + EXTERNAL_LINKS, + INLINE, +} diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/Format.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/Format.java new file mode 100644 index 000000000..12479ed92 --- /dev/null +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/Format.java @@ -0,0 +1,13 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. + +package com.databricks.sdk.service.statementexecutionv2; + +import com.databricks.sdk.support.Generated; + +/** The format of the result data. */ +@Generated +public enum Format { + ARROW_STREAM, + CSV, + JSON_ARRAY, +} diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/GetResultDataRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/GetResultDataRequest.java new file mode 100644 index 000000000..18a4983b7 --- /dev/null +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/GetResultDataRequest.java @@ -0,0 +1,74 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. + +package com.databricks.sdk.service.statementexecutionv2; + +import com.databricks.sdk.support.Generated; +import com.databricks.sdk.support.ToStringer; +import com.fasterxml.jackson.annotation.JsonIgnore; +import java.util.Objects; + +@Generated +public class GetResultDataRequest { + /** The zero-based index of the result chunk to fetch. */ + @JsonIgnore private Long chunkIndex; + + /** + * The statement ID is returned upon successfully submitting a SQL statement, and is a required + * reference for all subsequent calls. + */ + @JsonIgnore private String statementId; + + /** The ID of the SQL warehouse that ran the statement. */ + @JsonIgnore private String warehouseId; + + public GetResultDataRequest setChunkIndex(Long chunkIndex) { + this.chunkIndex = chunkIndex; + return this; + } + + public Long getChunkIndex() { + return chunkIndex; + } + + public GetResultDataRequest setStatementId(String statementId) { + this.statementId = statementId; + return this; + } + + public String getStatementId() { + return statementId; + } + + public GetResultDataRequest setWarehouseId(String warehouseId) { + this.warehouseId = warehouseId; + return this; + } + + public String getWarehouseId() { + return warehouseId; + } + + @Override + public boolean equals(Object o) { + if (this == o) return true; + if (o == null || getClass() != o.getClass()) return false; + GetResultDataRequest that = (GetResultDataRequest) o; + return Objects.equals(chunkIndex, that.chunkIndex) + && Objects.equals(statementId, that.statementId) + && Objects.equals(warehouseId, that.warehouseId); + } + + @Override + public int hashCode() { + return Objects.hash(chunkIndex, statementId, warehouseId); + } + + @Override + public String toString() { + return new ToStringer(GetResultDataRequest.class) + .add("chunkIndex", chunkIndex) + .add("statementId", statementId) + .add("warehouseId", warehouseId) + .toString(); + } +} diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/GetStatementResultRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/GetStatementResultRequest.java new file mode 100644 index 000000000..c7ad9e15a --- /dev/null +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/GetStatementResultRequest.java @@ -0,0 +1,60 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. + +package com.databricks.sdk.service.statementexecutionv2; + +import com.databricks.sdk.support.Generated; +import com.databricks.sdk.support.ToStringer; +import com.fasterxml.jackson.annotation.JsonIgnore; +import java.util.Objects; + +@Generated +public class GetStatementResultRequest { + /** + * The statement ID is returned upon successfully submitting a SQL statement, and is a required + * reference for all subsequent calls. + */ + @JsonIgnore private String statementId; + + /** The ID of the SQL warehouse that ran the statement. */ + @JsonIgnore private String warehouseId; + + public GetStatementResultRequest setStatementId(String statementId) { + this.statementId = statementId; + return this; + } + + public String getStatementId() { + return statementId; + } + + public GetStatementResultRequest setWarehouseId(String warehouseId) { + this.warehouseId = warehouseId; + return this; + } + + public String getWarehouseId() { + return warehouseId; + } + + @Override + public boolean equals(Object o) { + if (this == o) return true; + if (o == null || getClass() != o.getClass()) return false; + GetStatementResultRequest that = (GetStatementResultRequest) o; + return Objects.equals(statementId, that.statementId) + && Objects.equals(warehouseId, that.warehouseId); + } + + @Override + public int hashCode() { + return Objects.hash(statementId, warehouseId); + } + + @Override + public String toString() { + return new ToStringer(GetStatementResultRequest.class) + .add("statementId", statementId) + .add("warehouseId", warehouseId) + .toString(); + } +} diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/QueryTag.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/QueryTag.java new file mode 100644 index 000000000..b7a0e7a3c --- /dev/null +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/QueryTag.java @@ -0,0 +1,60 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. + +package com.databricks.sdk.service.statementexecutionv2; + +import com.databricks.sdk.support.Generated; +import com.databricks.sdk.support.ToStringer; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.Objects; + +/** + * * A query execution can be annotated with an optional key-value pair to allow users to attribute + * the executions by key and optional value to filter by. QueryTag is the user-facing + * representation. + */ +@Generated +public class QueryTag { + /** */ + @JsonProperty("key") + private String key; + + /** */ + @JsonProperty("value") + private String value; + + public QueryTag setKey(String key) { + this.key = key; + return this; + } + + public String getKey() { + return key; + } + + public QueryTag setValue(String value) { + this.value = value; + return this; + } + + public String getValue() { + return value; + } + + @Override + public boolean equals(Object o) { + if (this == o) return true; + if (o == null || getClass() != o.getClass()) return false; + QueryTag that = (QueryTag) o; + return Objects.equals(key, that.key) && Objects.equals(value, that.value); + } + + @Override + public int hashCode() { + return Objects.hash(key, value); + } + + @Override + public String toString() { + return new ToStringer(QueryTag.class).add("key", key).add("value", value).toString(); + } +} diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/ResultData.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/ResultData.java new file mode 100644 index 000000000..c6b50e8bc --- /dev/null +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/ResultData.java @@ -0,0 +1,182 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. + +package com.databricks.sdk.service.statementexecutionv2; + +import com.databricks.sdk.support.Generated; +import com.databricks.sdk.support.ToStringer; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.databind.JsonNode; +import java.util.Collection; +import java.util.Objects; + +/** + * Contains the result data of a single chunk when using `INLINE` disposition. When using + * `EXTERNAL_LINKS` disposition, the array `external_links` is used instead to provide short-lived + * cloud-storage URLs to the result data in cloud storage. Exactly one of these alternatives is + * used. (While the `external_links` array prepares the API to return multiple links in a single + * response, currently only a single link is returned.) + */ +@Generated +public class ResultData { + /** + * The number of bytes in the result chunk. This field is not available when using `INLINE` + * disposition. + */ + @JsonProperty("byte_count") + private Long byteCount; + + /** The position within the sequence of result set chunks. */ + @JsonProperty("chunk_index") + private Long chunkIndex; + + /** + * The `JSON_ARRAY` format is an array of arrays of values, where each non-null value is formatted + * as a string. Null values are encoded as JSON `null`. + */ + @JsonProperty("data_array") + private Collection> dataArray; + + /** + * Short-lived cloud-storage links to the result data, used with the `EXTERNAL_LINKS` disposition. + */ + @JsonProperty("external_links") + private Collection externalLinks; + + /** + * When fetching, provides the `chunk_index` for the _next_ chunk. If absent, indicates there are + * no more chunks. The next chunk can be fetched with a get-result-chunk request for that index. + */ + @JsonProperty("next_chunk_index") + private Long nextChunkIndex; + + /** + * When fetching, provides a link to fetch the _next_ chunk. If absent, indicates there are no + * more chunks. This link is an absolute `path` to be joined with your `$DATABRICKS_HOST`, and + * should be treated as an opaque link. This is an alternative to using `next_chunk_index`. + * Lakehouse//RT warehouses currently don't return this field; use `next_chunk_index` instead. + */ + @JsonProperty("next_chunk_internal_link") + private String nextChunkInternalLink; + + /** The number of rows within the result chunk. */ + @JsonProperty("row_count") + private Long rowCount; + + /** The starting row offset within the result set. */ + @JsonProperty("row_offset") + private Long rowOffset; + + public ResultData setByteCount(Long byteCount) { + this.byteCount = byteCount; + return this; + } + + public Long getByteCount() { + return byteCount; + } + + public ResultData setChunkIndex(Long chunkIndex) { + this.chunkIndex = chunkIndex; + return this; + } + + public Long getChunkIndex() { + return chunkIndex; + } + + public ResultData setDataArray(Collection> dataArray) { + this.dataArray = dataArray; + return this; + } + + public Collection> getDataArray() { + return dataArray; + } + + public ResultData setExternalLinks(Collection externalLinks) { + this.externalLinks = externalLinks; + return this; + } + + public Collection getExternalLinks() { + return externalLinks; + } + + public ResultData setNextChunkIndex(Long nextChunkIndex) { + this.nextChunkIndex = nextChunkIndex; + return this; + } + + public Long getNextChunkIndex() { + return nextChunkIndex; + } + + public ResultData setNextChunkInternalLink(String nextChunkInternalLink) { + this.nextChunkInternalLink = nextChunkInternalLink; + return this; + } + + public String getNextChunkInternalLink() { + return nextChunkInternalLink; + } + + public ResultData setRowCount(Long rowCount) { + this.rowCount = rowCount; + return this; + } + + public Long getRowCount() { + return rowCount; + } + + public ResultData setRowOffset(Long rowOffset) { + this.rowOffset = rowOffset; + return this; + } + + public Long getRowOffset() { + return rowOffset; + } + + @Override + public boolean equals(Object o) { + if (this == o) return true; + if (o == null || getClass() != o.getClass()) return false; + ResultData that = (ResultData) o; + return Objects.equals(byteCount, that.byteCount) + && Objects.equals(chunkIndex, that.chunkIndex) + && Objects.equals(dataArray, that.dataArray) + && Objects.equals(externalLinks, that.externalLinks) + && Objects.equals(nextChunkIndex, that.nextChunkIndex) + && Objects.equals(nextChunkInternalLink, that.nextChunkInternalLink) + && Objects.equals(rowCount, that.rowCount) + && Objects.equals(rowOffset, that.rowOffset); + } + + @Override + public int hashCode() { + return Objects.hash( + byteCount, + chunkIndex, + dataArray, + externalLinks, + nextChunkIndex, + nextChunkInternalLink, + rowCount, + rowOffset); + } + + @Override + public String toString() { + return new ToStringer(ResultData.class) + .add("byteCount", byteCount) + .add("chunkIndex", chunkIndex) + .add("dataArray", dataArray) + .add("externalLinks", externalLinks) + .add("nextChunkIndex", nextChunkIndex) + .add("nextChunkInternalLink", nextChunkInternalLink) + .add("rowCount", rowCount) + .add("rowOffset", rowOffset) + .toString(); + } +} diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/ResultManifest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/ResultManifest.java new file mode 100644 index 000000000..3c546e9ec --- /dev/null +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/ResultManifest.java @@ -0,0 +1,140 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. + +package com.databricks.sdk.service.statementexecutionv2; + +import com.databricks.sdk.support.Generated; +import com.databricks.sdk.support.ToStringer; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.Collection; +import java.util.Objects; + +/** The result manifest provides schema and metadata for the result set. */ +@Generated +public class ResultManifest { + /** Array of result set chunk metadata. */ + @JsonProperty("chunks") + private Collection chunks; + + /** The format of the result data, as requested with `format`. */ + @JsonProperty("format") + private Format format; + + /** The schema of the result set: the ordered list of column descriptions. */ + @JsonProperty("schema") + private Schema schema; + + /** + * The total number of bytes in the result set. This field is not available when using `INLINE` + * disposition. + */ + @JsonProperty("total_byte_count") + private Long totalByteCount; + + /** The total number of chunks that the result set has been divided into. */ + @JsonProperty("total_chunk_count") + private Long totalChunkCount; + + /** The total number of rows in the result set. */ + @JsonProperty("total_row_count") + private Long totalRowCount; + + /** Indicates whether the result is truncated due to `row_limit` or `byte_limit`. */ + @JsonProperty("truncated") + private Boolean truncated; + + public ResultManifest setChunks(Collection chunks) { + this.chunks = chunks; + return this; + } + + public Collection getChunks() { + return chunks; + } + + public ResultManifest setFormat(Format format) { + this.format = format; + return this; + } + + public Format getFormat() { + return format; + } + + public ResultManifest setSchema(Schema schema) { + this.schema = schema; + return this; + } + + public Schema getSchema() { + return schema; + } + + public ResultManifest setTotalByteCount(Long totalByteCount) { + this.totalByteCount = totalByteCount; + return this; + } + + public Long getTotalByteCount() { + return totalByteCount; + } + + public ResultManifest setTotalChunkCount(Long totalChunkCount) { + this.totalChunkCount = totalChunkCount; + return this; + } + + public Long getTotalChunkCount() { + return totalChunkCount; + } + + public ResultManifest setTotalRowCount(Long totalRowCount) { + this.totalRowCount = totalRowCount; + return this; + } + + public Long getTotalRowCount() { + return totalRowCount; + } + + public ResultManifest setTruncated(Boolean truncated) { + this.truncated = truncated; + return this; + } + + public Boolean getTruncated() { + return truncated; + } + + @Override + public boolean equals(Object o) { + if (this == o) return true; + if (o == null || getClass() != o.getClass()) return false; + ResultManifest that = (ResultManifest) o; + return Objects.equals(chunks, that.chunks) + && Objects.equals(format, that.format) + && Objects.equals(schema, that.schema) + && Objects.equals(totalByteCount, that.totalByteCount) + && Objects.equals(totalChunkCount, that.totalChunkCount) + && Objects.equals(totalRowCount, that.totalRowCount) + && Objects.equals(truncated, that.truncated); + } + + @Override + public int hashCode() { + return Objects.hash( + chunks, format, schema, totalByteCount, totalChunkCount, totalRowCount, truncated); + } + + @Override + public String toString() { + return new ToStringer(ResultManifest.class) + .add("chunks", chunks) + .add("format", format) + .add("schema", schema) + .add("totalByteCount", totalByteCount) + .add("totalChunkCount", totalChunkCount) + .add("totalRowCount", totalRowCount) + .add("truncated", truncated) + .toString(); + } +} diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/Schema.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/Schema.java new file mode 100644 index 000000000..c706dbf00 --- /dev/null +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/Schema.java @@ -0,0 +1,60 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. + +package com.databricks.sdk.service.statementexecutionv2; + +import com.databricks.sdk.support.Generated; +import com.databricks.sdk.support.ToStringer; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.Collection; +import java.util.Objects; + +/** The schema is an ordered list of column descriptions. */ +@Generated +public class Schema { + /** The number of columns in the result set. */ + @JsonProperty("column_count") + private Long columnCount; + + /** The column descriptions, in result set order. */ + @JsonProperty("columns") + private Collection columns; + + public Schema setColumnCount(Long columnCount) { + this.columnCount = columnCount; + return this; + } + + public Long getColumnCount() { + return columnCount; + } + + public Schema setColumns(Collection columns) { + this.columns = columns; + return this; + } + + public Collection getColumns() { + return columns; + } + + @Override + public boolean equals(Object o) { + if (this == o) return true; + if (o == null || getClass() != o.getClass()) return false; + Schema that = (Schema) o; + return Objects.equals(columnCount, that.columnCount) && Objects.equals(columns, that.columns); + } + + @Override + public int hashCode() { + return Objects.hash(columnCount, columns); + } + + @Override + public String toString() { + return new ToStringer(Schema.class) + .add("columnCount", columnCount) + .add("columns", columns) + .toString(); + } +} diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/ServiceError.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/ServiceError.java new file mode 100644 index 000000000..7db965f36 --- /dev/null +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/ServiceError.java @@ -0,0 +1,59 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. + +package com.databricks.sdk.service.statementexecutionv2; + +import com.databricks.sdk.support.Generated; +import com.databricks.sdk.support.ToStringer; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.Objects; + +/** The error that caused a statement execution to fail. */ +@Generated +public class ServiceError { + /** The error code that classifies the failure. */ + @JsonProperty("error_code") + private ServiceErrorCode errorCode; + + /** A brief summary of the error condition. */ + @JsonProperty("message") + private String message; + + public ServiceError setErrorCode(ServiceErrorCode errorCode) { + this.errorCode = errorCode; + return this; + } + + public ServiceErrorCode getErrorCode() { + return errorCode; + } + + public ServiceError setMessage(String message) { + this.message = message; + return this; + } + + public String getMessage() { + return message; + } + + @Override + public boolean equals(Object o) { + if (this == o) return true; + if (o == null || getClass() != o.getClass()) return false; + ServiceError that = (ServiceError) o; + return Objects.equals(errorCode, that.errorCode) && Objects.equals(message, that.message); + } + + @Override + public int hashCode() { + return Objects.hash(errorCode, message); + } + + @Override + public String toString() { + return new ToStringer(ServiceError.class) + .add("errorCode", errorCode) + .add("message", message) + .toString(); + } +} diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/ServiceErrorCode.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/ServiceErrorCode.java new file mode 100644 index 000000000..917f03cff --- /dev/null +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/ServiceErrorCode.java @@ -0,0 +1,24 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. + +package com.databricks.sdk.service.statementexecutionv2; + +import com.databricks.sdk.support.Generated; + +/** Error codes that classify a failed statement execution. */ +@Generated +public enum ServiceErrorCode { + ABORTED, + ALREADY_EXISTS, + BAD_REQUEST, + CANCELLED, + DEADLINE_EXCEEDED, + INTERNAL_ERROR, + IO_ERROR, + NOT_FOUND, + RESOURCE_EXHAUSTED, + SERVICE_UNDER_MAINTENANCE, + TEMPORARILY_UNAVAILABLE, + UNAUTHENTICATED, + UNKNOWN, + WORKSPACE_TEMPORARILY_UNAVAILABLE, +} diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/StatementExecutionV2API.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/StatementExecutionV2API.java new file mode 100644 index 000000000..861eeed04 --- /dev/null +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/StatementExecutionV2API.java @@ -0,0 +1,140 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. +package com.databricks.sdk.service.statementexecutionv2; + +import com.databricks.sdk.core.ApiClient; +import com.databricks.sdk.core.logging.Logger; +import com.databricks.sdk.core.logging.LoggerFactory; +import com.databricks.sdk.support.Generated; + +/** + * The Statement Execution API v2 can be used to execute SQL statements on a SQL warehouse and fetch + * the result. It works the same as the Statement Execution API (v1), except that `warehouse_id` is + * a path parameter on every call, including polling, fetching result chunks, and canceling. Routing + * on the warehouse ID gives lower latency and higher concurrency. + * + *

Version 2 currently supports [Lakehouse//RT] warehouses only. For other warehouse types, use + * the Statement Execution API (v1). You can also run statements on Lakehouse//RT warehouses with + * version 1, but version 2 is optimized for them. + * + *

[Lakehouse//RT]: https://docs.databricks.com/compute/sql-warehouse/real-time.html + */ +@Generated +public class StatementExecutionV2API { + private static final Logger LOG = LoggerFactory.getLogger(StatementExecutionV2API.class); + + private final StatementExecutionV2Service impl; + + /** Regular-use constructor */ + public StatementExecutionV2API(ApiClient apiClient) { + impl = new StatementExecutionV2Impl(apiClient); + } + + /** Constructor for mocks */ + public StatementExecutionV2API(StatementExecutionV2Service mock) { + impl = mock; + } + + /** + * Requests that an executing statement be canceled. Callers must poll for status to see the + * terminal state. The cancel response is empty; receiving a response indicates successful + * receipt. + */ + public CancelStatementResponse cancelStatement(CancelStatementRequest request) { + return impl.cancelStatement(request); + } + + /** + * Execute a SQL statement and optionally await its results for a specified time. + * + *

**Use case: small result sets with INLINE + JSON_ARRAY** + * + *

For flows that generate small and predictable result sets (<= 25 MiB), `INLINE` responses of + * `JSON_ARRAY` result data are typically the simplest way to execute and fetch result data. + * + *

**Use case: large result sets with EXTERNAL_LINKS** + * + *

Using `EXTERNAL_LINKS` to fetch result data allows you to fetch large result sets + * efficiently. The main differences from using `INLINE` disposition are that the result data is + * accessed with short-lived cloud-storage URLs, and that there are 3 supported formats: + * `JSON_ARRAY`, `ARROW_STREAM` and `CSV` compared to only `JSON_ARRAY` with `INLINE`. + * + *

**External-link URLs** + * + *

External links point to data stored within your workspace's internal cloud storage. The URLs + * are valid for only a short period, <= 15 minutes. Alongside each `external_link` is an + * expiration field indicating the time at which the URL is no longer valid. In `EXTERNAL_LINKS` + * mode, chunks can be resolved and fetched multiple times and in parallel. + * + *

---- + * + *

### **Warning: Databricks strongly recommends that you protect the URLs that are returned by + * the `EXTERNAL_LINKS` disposition.** + * + *

When you use the `EXTERNAL_LINKS` disposition, a short-lived cloud-storage URL is generated + * to download the results. The URL contains temporary access credentials, so protect it and do + * not set an `Authorization` header in the download request. + * + *

The `EXTERNAL_LINKS` disposition can be disabled upon request by creating a [support case]. + * + *

See also [Security best practices]. + * + *

---- + * + *

StatementResponse contains `statement_id` and `status`; other fields might be absent or + * present depending on context. If the SQL warehouse fails to execute the provided statement, a + * 200 response is returned with `status.state` set to `FAILED` (in contrast to a failure when + * accepting the request, which results in a non-200 response). Details of the error can be found + * at `status.error` in case of execution failures. + * + *

[Security best practices]: + * https://docs.databricks.com/sql/admin/sql-execution-tutorial.html#security-best-practices + * [support case]: https://docs.databricks.com/resources/support.html + */ + public StatementResponse executeStatement(ExecuteStatementRequest request) { + return impl.executeStatement(request); + } + + public ResultData getResultData(String warehouseId, String statementId, long chunkIndex) { + return getResultData( + new GetResultDataRequest() + .setWarehouseId(warehouseId) + .setStatementId(statementId) + .setChunkIndex(chunkIndex)); + } + + /** + * After the statement execution has `SUCCEEDED`, this request can be used to fetch any chunk by + * index. Whereas the first chunk with `chunk_index=0` is typically fetched with the execute or + * the get-status request, this request can be used to fetch subsequent chunks. The response + * structure is identical to the nested `result` element of those responses, and similarly + * includes the `next_chunk_index` field for simple iteration through the result set. Depending on + * `disposition`, the response returns chunks of data either inline, or as links. + */ + public ResultData getResultData(GetResultDataRequest request) { + return impl.getResultData(request); + } + + public StatementResponse getStatementResult(String warehouseId, String statementId) { + return getStatementResult( + new GetStatementResultRequest().setWarehouseId(warehouseId).setStatementId(statementId)); + } + + /** + * This request can be used to poll for the statement's status. StatementResponse contains + * `statement_id` and `status`; other fields might be absent or present depending on context. When + * the `status.state` field is `SUCCEEDED` it will also return the result manifest and the first + * chunk of the result data. When the statement is in the terminal states `CANCELED`, `CLOSED` or + * `FAILED`, it returns HTTP 200 with the state set. After at least 12 hours in a terminal state, + * the statement is removed from the warehouse and further calls will receive an HTTP 404 + * response. + * + *

**NOTE** This call currently might take up to 5 seconds to get the latest status and result. + */ + public StatementResponse getStatementResult(GetStatementResultRequest request) { + return impl.getStatementResult(request); + } + + public StatementExecutionV2Service impl() { + return impl; + } +} diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/StatementExecutionV2Impl.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/StatementExecutionV2Impl.java new file mode 100644 index 000000000..fc3638391 --- /dev/null +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/StatementExecutionV2Impl.java @@ -0,0 +1,97 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. +package com.databricks.sdk.service.statementexecutionv2; + +import com.databricks.sdk.core.ApiClient; +import com.databricks.sdk.core.DatabricksException; +import com.databricks.sdk.core.http.Request; +import com.databricks.sdk.support.Generated; +import java.io.IOException; + +/** Package-local implementation of StatementExecutionV2 */ +@Generated +class StatementExecutionV2Impl implements StatementExecutionV2Service { + private final ApiClient apiClient; + + public StatementExecutionV2Impl(ApiClient apiClient) { + this.apiClient = apiClient; + } + + @Override + public CancelStatementResponse cancelStatement(CancelStatementRequest request) { + String path = + String.format( + "/api/2.0/sql/warehouses/%s/statements/%s/cancel", + request.getWarehouseId(), request.getStatementId()); + try { + Request req = new Request("POST", path, apiClient.serialize(request)); + + ApiClient.setQuery(req, request); + req.withHeader("Accept", "application/json"); + req.withHeader("Content-Type", "application/json"); + if (apiClient.workspaceId() != null) { + req.withHeader("X-Databricks-Workspace-Id", apiClient.workspaceId()); + } + return apiClient.execute(req, CancelStatementResponse.class); + } catch (IOException e) { + throw new DatabricksException("IO error: " + e.getMessage(), e); + } + } + + @Override + public StatementResponse executeStatement(ExecuteStatementRequest request) { + String path = String.format("/api/2.0/sql/warehouses/%s/statements", request.getWarehouseId()); + try { + Request req = new Request("POST", path, apiClient.serialize(request)); + + ApiClient.setQuery(req, request); + req.withHeader("Accept", "application/json"); + req.withHeader("Content-Type", "application/json"); + if (apiClient.workspaceId() != null) { + req.withHeader("X-Databricks-Workspace-Id", apiClient.workspaceId()); + } + return apiClient.execute(req, StatementResponse.class); + } catch (IOException e) { + throw new DatabricksException("IO error: " + e.getMessage(), e); + } + } + + @Override + public ResultData getResultData(GetResultDataRequest request) { + String path = + String.format( + "/api/2.0/sql/warehouses/%s/statements/%s/result/chunks/%s", + request.getWarehouseId(), request.getStatementId(), request.getChunkIndex()); + try { + Request req = new Request("GET", path); + + ApiClient.setQuery(req, request); + req.withHeader("Accept", "application/json"); + if (apiClient.workspaceId() != null) { + req.withHeader("X-Databricks-Workspace-Id", apiClient.workspaceId()); + } + return apiClient.execute(req, ResultData.class); + } catch (IOException e) { + throw new DatabricksException("IO error: " + e.getMessage(), e); + } + } + + @Override + public StatementResponse getStatementResult(GetStatementResultRequest request) { + String path = + String.format( + "/api/2.0/sql/warehouses/%s/statements/%s", + request.getWarehouseId(), request.getStatementId()); + try { + Request req = new Request("GET", path); + + ApiClient.setQuery(req, request); + req.withHeader("Accept", "application/json"); + if (apiClient.workspaceId() != null) { + req.withHeader("X-Databricks-Workspace-Id", apiClient.workspaceId()); + } + return apiClient.execute(req, StatementResponse.class); + } catch (IOException e) { + throw new DatabricksException("IO error: " + e.getMessage(), e); + } + } +} diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/StatementExecutionV2Service.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/StatementExecutionV2Service.java new file mode 100644 index 000000000..709c600f0 --- /dev/null +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/StatementExecutionV2Service.java @@ -0,0 +1,102 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. +package com.databricks.sdk.service.statementexecutionv2; + +import com.databricks.sdk.support.Generated; + +/** + * The Statement Execution API v2 can be used to execute SQL statements on a SQL warehouse and fetch + * the result. It works the same as the Statement Execution API (v1), except that `warehouse_id` is + * a path parameter on every call, including polling, fetching result chunks, and canceling. Routing + * on the warehouse ID gives lower latency and higher concurrency. + * + *

Version 2 currently supports [Lakehouse//RT] warehouses only. For other warehouse types, use + * the Statement Execution API (v1). You can also run statements on Lakehouse//RT warehouses with + * version 1, but version 2 is optimized for them. + * + *

[Lakehouse//RT]: https://docs.databricks.com/compute/sql-warehouse/real-time.html + * + *

This is the high-level interface, that contains generated methods. + * + *

Evolving: this interface is under development. Method signatures may change. + */ +@Generated +public interface StatementExecutionV2Service { + /** + * Requests that an executing statement be canceled. Callers must poll for status to see the + * terminal state. The cancel response is empty; receiving a response indicates successful + * receipt. + */ + CancelStatementResponse cancelStatement(CancelStatementRequest cancelStatementRequest); + + /** + * Execute a SQL statement and optionally await its results for a specified time. + * + *

**Use case: small result sets with INLINE + JSON_ARRAY** + * + *

For flows that generate small and predictable result sets (<= 25 MiB), `INLINE` responses of + * `JSON_ARRAY` result data are typically the simplest way to execute and fetch result data. + * + *

**Use case: large result sets with EXTERNAL_LINKS** + * + *

Using `EXTERNAL_LINKS` to fetch result data allows you to fetch large result sets + * efficiently. The main differences from using `INLINE` disposition are that the result data is + * accessed with short-lived cloud-storage URLs, and that there are 3 supported formats: + * `JSON_ARRAY`, `ARROW_STREAM` and `CSV` compared to only `JSON_ARRAY` with `INLINE`. + * + *

**External-link URLs** + * + *

External links point to data stored within your workspace's internal cloud storage. The URLs + * are valid for only a short period, <= 15 minutes. Alongside each `external_link` is an + * expiration field indicating the time at which the URL is no longer valid. In `EXTERNAL_LINKS` + * mode, chunks can be resolved and fetched multiple times and in parallel. + * + *

---- + * + *

### **Warning: Databricks strongly recommends that you protect the URLs that are returned by + * the `EXTERNAL_LINKS` disposition.** + * + *

When you use the `EXTERNAL_LINKS` disposition, a short-lived cloud-storage URL is generated + * to download the results. The URL contains temporary access credentials, so protect it and do + * not set an `Authorization` header in the download request. + * + *

The `EXTERNAL_LINKS` disposition can be disabled upon request by creating a [support case]. + * + *

See also [Security best practices]. + * + *

---- + * + *

StatementResponse contains `statement_id` and `status`; other fields might be absent or + * present depending on context. If the SQL warehouse fails to execute the provided statement, a + * 200 response is returned with `status.state` set to `FAILED` (in contrast to a failure when + * accepting the request, which results in a non-200 response). Details of the error can be found + * at `status.error` in case of execution failures. + * + *

[Security best practices]: + * https://docs.databricks.com/sql/admin/sql-execution-tutorial.html#security-best-practices + * [support case]: https://docs.databricks.com/resources/support.html + */ + StatementResponse executeStatement(ExecuteStatementRequest executeStatementRequest); + + /** + * After the statement execution has `SUCCEEDED`, this request can be used to fetch any chunk by + * index. Whereas the first chunk with `chunk_index=0` is typically fetched with the execute or + * the get-status request, this request can be used to fetch subsequent chunks. The response + * structure is identical to the nested `result` element of those responses, and similarly + * includes the `next_chunk_index` field for simple iteration through the result set. Depending on + * `disposition`, the response returns chunks of data either inline, or as links. + */ + ResultData getResultData(GetResultDataRequest getResultDataRequest); + + /** + * This request can be used to poll for the statement's status. StatementResponse contains + * `statement_id` and `status`; other fields might be absent or present depending on context. When + * the `status.state` field is `SUCCEEDED` it will also return the result manifest and the first + * chunk of the result data. When the statement is in the terminal states `CANCELED`, `CLOSED` or + * `FAILED`, it returns HTTP 200 with the state set. After at least 12 hours in a terminal state, + * the statement is removed from the warehouse and further calls will receive an HTTP 404 + * response. + * + *

**NOTE** This call currently might take up to 5 seconds to get the latest status and result. + */ + StatementResponse getStatementResult(GetStatementResultRequest getStatementResultRequest); +} diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/StatementParameter.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/StatementParameter.java new file mode 100644 index 000000000..f5ce2269b --- /dev/null +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/StatementParameter.java @@ -0,0 +1,84 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. + +package com.databricks.sdk.service.statementexecutionv2; + +import com.databricks.sdk.support.Generated; +import com.databricks.sdk.support.ToStringer; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.Objects; + +/** A named parameter to substitute for a parameter marker in the statement. */ +@Generated +public class StatementParameter { + /** The name of a parameter marker to be substituted in the statement. */ + @JsonProperty("name") + private String name; + + /** + * The data type, given as a string. For example: `INT`, `STRING`, `DECIMAL(10,2)`. If no type is + * given the type is assumed to be `STRING`. Complex types, such as `ARRAY`, `MAP`, and `STRUCT` + * are not supported. For valid types, refer to the section [Data types] of the SQL language + * reference. + * + *

[Data types]: https://docs.databricks.com/sql/language-manual/functions/cast.html + */ + @JsonProperty("type") + private String typeValue; + + /** + * The value to substitute, represented as a string. If omitted, the value is interpreted as NULL. + */ + @JsonProperty("value") + private String value; + + public StatementParameter setName(String name) { + this.name = name; + return this; + } + + public String getName() { + return name; + } + + public StatementParameter setType(String typeValue) { + this.typeValue = typeValue; + return this; + } + + public String getType() { + return typeValue; + } + + public StatementParameter setValue(String value) { + this.value = value; + return this; + } + + public String getValue() { + return value; + } + + @Override + public boolean equals(Object o) { + if (this == o) return true; + if (o == null || getClass() != o.getClass()) return false; + StatementParameter that = (StatementParameter) o; + return Objects.equals(name, that.name) + && Objects.equals(typeValue, that.typeValue) + && Objects.equals(value, that.value); + } + + @Override + public int hashCode() { + return Objects.hash(name, typeValue, value); + } + + @Override + public String toString() { + return new ToStringer(StatementParameter.class) + .add("name", name) + .add("typeValue", typeValue) + .add("value", value) + .toString(); + } +} diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/StatementResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/StatementResponse.java new file mode 100644 index 000000000..31693a5c0 --- /dev/null +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/StatementResponse.java @@ -0,0 +1,98 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. + +package com.databricks.sdk.service.statementexecutionv2; + +import com.databricks.sdk.support.Generated; +import com.databricks.sdk.support.ToStringer; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.Objects; + +/** + * Statement Execution (Lakehouse//RT) is version 2 of the Statement Execution API. It is optimized + * for Lakehouse//RT warehouses, with lower latency and higher concurrency, and takes `warehouse_id` + * as a path parameter on every call. It currently supports Lakehouse//RT warehouses only. The + * Statement Execution API (version 1) works with all SQL warehouse types, including Lakehouse//RT. + */ +@Generated +public class StatementResponse { + /** The schema and metadata of the result set. Present when `status.state` is `SUCCEEDED`. */ + @JsonProperty("manifest") + private ResultManifest manifest; + + /** The first chunk of result data. Present when `status.state` is `SUCCEEDED`. */ + @JsonProperty("result") + private ResultData result; + + /** + * The statement ID is returned upon successfully submitting a SQL statement, and is a required + * reference for all subsequent calls. + */ + @JsonProperty("statement_id") + private String statementId; + + /** The execution state of the statement and, if it failed, the error details. */ + @JsonProperty("status") + private StatementStatus status; + + public StatementResponse setManifest(ResultManifest manifest) { + this.manifest = manifest; + return this; + } + + public ResultManifest getManifest() { + return manifest; + } + + public StatementResponse setResult(ResultData result) { + this.result = result; + return this; + } + + public ResultData getResult() { + return result; + } + + public StatementResponse setStatementId(String statementId) { + this.statementId = statementId; + return this; + } + + public String getStatementId() { + return statementId; + } + + public StatementResponse setStatus(StatementStatus status) { + this.status = status; + return this; + } + + public StatementStatus getStatus() { + return status; + } + + @Override + public boolean equals(Object o) { + if (this == o) return true; + if (o == null || getClass() != o.getClass()) return false; + StatementResponse that = (StatementResponse) o; + return Objects.equals(manifest, that.manifest) + && Objects.equals(result, that.result) + && Objects.equals(statementId, that.statementId) + && Objects.equals(status, that.status); + } + + @Override + public int hashCode() { + return Objects.hash(manifest, result, statementId, status); + } + + @Override + public String toString() { + return new ToStringer(StatementResponse.class) + .add("manifest", manifest) + .add("result", result) + .add("statementId", statementId) + .add("status", status) + .toString(); + } +} diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/StatementStatus.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/StatementStatus.java new file mode 100644 index 000000000..9e9b285c8 --- /dev/null +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/StatementStatus.java @@ -0,0 +1,84 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. + +package com.databricks.sdk.service.statementexecutionv2; + +import com.databricks.sdk.support.Generated; +import com.databricks.sdk.support.ToStringer; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.Objects; + +/** The status response includes execution state and if relevant, error information. */ +@Generated +public class StatementStatus { + /** The error details. Only populated when `state` is `FAILED`. */ + @JsonProperty("error") + private ServiceError error; + + /** + * SQLSTATE error code returned when the statement execution fails. Only populated when the + * statement status is `FAILED`. + */ + @JsonProperty("sql_state") + private String sqlState; + + /** + * Statement execution state: - `PENDING`: waiting for warehouse - `RUNNING`: running - + * `SUCCEEDED`: execution was successful, result data available for fetch - `FAILED`: execution + * failed; reason for failure described in accompanying error message - `CANCELED`: user canceled; + * can come from explicit cancel call, or timeout with `on_wait_timeout=CANCEL` - `CLOSED`: + * execution successful, and statement closed; result no longer available for fetch + */ + @JsonProperty("state") + private StatementStatusState state; + + public StatementStatus setError(ServiceError error) { + this.error = error; + return this; + } + + public ServiceError getError() { + return error; + } + + public StatementStatus setSqlState(String sqlState) { + this.sqlState = sqlState; + return this; + } + + public String getSqlState() { + return sqlState; + } + + public StatementStatus setState(StatementStatusState state) { + this.state = state; + return this; + } + + public StatementStatusState getState() { + return state; + } + + @Override + public boolean equals(Object o) { + if (this == o) return true; + if (o == null || getClass() != o.getClass()) return false; + StatementStatus that = (StatementStatus) o; + return Objects.equals(error, that.error) + && Objects.equals(sqlState, that.sqlState) + && Objects.equals(state, that.state); + } + + @Override + public int hashCode() { + return Objects.hash(error, sqlState, state); + } + + @Override + public String toString() { + return new ToStringer(StatementStatus.class) + .add("error", error) + .add("sqlState", sqlState) + .add("state", state) + .toString(); + } +} diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/StatementStatusState.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/StatementStatusState.java new file mode 100644 index 000000000..b1eba7883 --- /dev/null +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/StatementStatusState.java @@ -0,0 +1,16 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. + +package com.databricks.sdk.service.statementexecutionv2; + +import com.databricks.sdk.support.Generated; + +/** Statement execution state. */ +@Generated +public enum StatementStatusState { + CANCELED, + CLOSED, + FAILED, + PENDING, + RUNNING, + SUCCEEDED, +} diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/TimeoutAction.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/TimeoutAction.java new file mode 100644 index 000000000..aad51471b --- /dev/null +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/TimeoutAction.java @@ -0,0 +1,12 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. + +package com.databricks.sdk.service.statementexecutionv2; + +import com.databricks.sdk.support.Generated; + +/** What happens when the statement execution outlives `wait_timeout`. */ +@Generated +public enum TimeoutAction { + CANCEL, + CONTINUE, +} diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/CreateEndpoint.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/CreateEndpoint.java index 8d3786349..44b004be8 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/CreateEndpoint.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/CreateEndpoint.java @@ -9,22 +9,34 @@ @Generated public class CreateEndpoint { - /** The budget policy id to be applied */ + /** + * Budget policy to attribute the endpoint's usage to. If omitted, the default budget policy + * applies. + */ @JsonProperty("budget_policy_id") private String budgetPolicyId; - /** Type of endpoint */ + /** + * Type of endpoint to create. STANDARD endpoints are optimized for low-latency queries and + * support Target QPS scaling. STORAGE_OPTIMIZED endpoints hold much larger indexes and index + * faster, with higher query latency. See + * https://docs.databricks.com/aws/en/ai-search/ai-search#endpoint-options. + */ @JsonProperty("endpoint_type") private EndpointType endpointType; - /** Name of the AI Search endpoint */ + /** + * Name of the AI Search endpoint. The name must be unique within the workspace, have at most 50 + * characters, contain only lowercase letters, digits, hyphens, underscores and periods, and start + * and end with a letter or digit. + */ @JsonProperty("name") private String name; /** - * Target QPS for the endpoint. Mutually exclusive with num_replicas. The actual replica count is - * calculated at index creation/sync time based on this value. Best-effort target; the system does - * not guarantee this QPS will be achieved. + * Target queries per second (QPS) for the endpoint. Supported for STANDARD endpoints only. The + * actual replica count is calculated at index creation/sync time based on this value. Best-effort + * target; the system does not guarantee this QPS will be achieved. */ @JsonProperty("target_qps") private Long targetQps; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/EndpointInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/EndpointInfo.java index 916f576eb..d9fa84eff 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/EndpointInfo.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/EndpointInfo.java @@ -14,11 +14,14 @@ public class EndpointInfo { @JsonProperty("budget_policy_id") private String budgetPolicyId; - /** Timestamp of endpoint creation */ + /** Time at which the endpoint was created, in milliseconds since the Unix epoch. */ @JsonProperty("creation_timestamp") private Long creationTimestamp; - /** Creator of the endpoint */ + /** + * User or service principal that created the endpoint. Users are identified by username and + * service principals by application ID. + */ @JsonProperty("creator") private String creator; @@ -26,7 +29,10 @@ public class EndpointInfo { @JsonProperty("custom_tags") private Collection customTags; - /** The budget policy id applied to the endpoint */ + /** + * Budget policy ID in effect for the endpoint. This is the policy set on the endpoint when one + * was set, and otherwise the default budget policy. + */ @JsonProperty("effective_budget_policy_id") private String effectiveBudgetPolicyId; @@ -34,7 +40,11 @@ public class EndpointInfo { @JsonProperty("endpoint_status") private EndpointStatus endpointStatus; - /** Type of endpoint */ + /** + * Type of the endpoint. See + * https://docs.databricks.com/aws/en/ai-search/ai-search#endpoint-options for how the types + * differ. + */ @JsonProperty("endpoint_type") private EndpointType endpointType; @@ -42,11 +52,11 @@ public class EndpointInfo { @JsonProperty("id") private String id; - /** Timestamp of last update to the endpoint */ + /** Time at which the endpoint was last updated, in milliseconds since the Unix epoch. */ @JsonProperty("last_updated_timestamp") private Long lastUpdatedTimestamp; - /** User who last updated the endpoint */ + /** User or service principal that last updated the endpoint, in the same form as creator. */ @JsonProperty("last_updated_user") private String lastUpdatedUser; @@ -58,7 +68,10 @@ public class EndpointInfo { @JsonProperty("num_indexes") private Long numIndexes; - /** Scaling information for the endpoint */ + /** + * Scaling information for the endpoint. Present only for STANDARD endpoints that have a Target + * QPS set. + */ @JsonProperty("scaling_info") private EndpointScalingInfo scalingInfo; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/EndpointStatus.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/EndpointStatus.java index 7b452f74a..8875fca81 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/EndpointStatus.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/EndpointStatus.java @@ -10,7 +10,10 @@ /** Status information of an endpoint */ @Generated public class EndpointStatus { - /** Additional status message */ + /** + * Additional detail about the state, such as the reason the endpoint is OFFLINE. Absent when + * there is nothing to report. + */ @JsonProperty("message") private String message; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/PatchEndpointBudgetPolicyResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/PatchEndpointBudgetPolicyResponse.java index bb0b20026..3c7da58da 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/PatchEndpointBudgetPolicyResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/PatchEndpointBudgetPolicyResponse.java @@ -9,7 +9,7 @@ @Generated public class PatchEndpointBudgetPolicyResponse { - /** */ + /** The requested budget policy ID, returned when the endpoint was already using it. */ @JsonProperty("budget_policy_id") private String budgetPolicyId; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/PatchEndpointRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/PatchEndpointRequest.java index 771ca493e..d3afbff4b 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/PatchEndpointRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/PatchEndpointRequest.java @@ -15,7 +15,7 @@ public class PatchEndpointRequest { /** * Target QPS for the endpoint. Best-effort; the system does not guarantee this QPS will be - * achieved. + * achieved. Set to -1 to clear the Target QPS, as if it had never been set. */ @JsonProperty("target_qps") private Long targetQps; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/VectorSearchEndpointsAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/VectorSearchEndpointsAPI.java index 2ad7b81bf..0ff454a80 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/VectorSearchEndpointsAPI.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/VectorSearchEndpointsAPI.java @@ -146,7 +146,10 @@ public Iterable listEndpoints(ListEndpointsRequest request) { }); } - /** Update an endpoint */ + /** + * Update the Target QPS of a STANDARD endpoint. The response is the updated endpoint; its + * scaling_info shows whether the resulting scaling change is applied or still in progress. + */ public EndpointInfo patchEndpoint(PatchEndpointRequest request) { return impl.patchEndpoint(request); } @@ -179,7 +182,7 @@ public EndpointInfo stopEndpoint(StopEndpointRequest request) { return impl.stopEndpoint(request); } - /** Update the budget policy of an endpoint */ + /** Update the budget policy that the endpoint's usage is attributed to. */ public PatchEndpointBudgetPolicyResponse updateEndpointBudgetPolicy( PatchEndpointBudgetPolicyRequest request) { return impl.updateEndpointBudgetPolicy(request); diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/VectorSearchEndpointsService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/VectorSearchEndpointsService.java index 719dc7892..13cee06bf 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/VectorSearchEndpointsService.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/VectorSearchEndpointsService.java @@ -36,7 +36,10 @@ VectorSearchEndpointPermissions getPermissions( /** List all AI Search endpoints in the workspace. */ ListEndpointResponse listEndpoints(ListEndpointsRequest listEndpointsRequest); - /** Update an endpoint */ + /** + * Update the Target QPS of a STANDARD endpoint. The response is the updated endpoint; its + * scaling_info shows whether the resulting scaling change is applied or still in progress. + */ EndpointInfo patchEndpoint(PatchEndpointRequest patchEndpointRequest); /** Retrieve user-visible metrics for an endpoint */ @@ -59,7 +62,7 @@ VectorSearchEndpointPermissions setPermissions( */ EndpointInfo stopEndpoint(StopEndpointRequest stopEndpointRequest); - /** Update the budget policy of an endpoint */ + /** Update the budget policy that the endpoint's usage is attributed to. */ PatchEndpointBudgetPolicyResponse updateEndpointBudgetPolicy( PatchEndpointBudgetPolicyRequest patchEndpointBudgetPolicyRequest); diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/CreateRepoRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/CreateRepoRequest.java index d8ba46a8a..d46c2fa27 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/CreateRepoRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/CreateRepoRequest.java @@ -18,7 +18,10 @@ public class CreateRepoRequest { /** * Desired path for the repo in the workspace. Almost any path in the workspace can be chosen. If - * repo is created in `/Repos`, path must be in the format `/Repos/{folder}/{repo-name}`. + * repo is created in `/Repos`, path must be in the format `/Repos/{folder}/{repo-name}`. If + * omitted, the repo is created in the calling user's home folder (`/Users/{user}`, or + * `/Repos/{user}` in workspaces without workspace files). The repo name is the last path segment + * of `url`, for example `cli.git`. */ @JsonProperty("path") private String path; @@ -39,7 +42,7 @@ public class CreateRepoRequest { @JsonProperty("sparse_checkout") private SparseCheckout sparseCheckout; - /** URL of the Git repository to be linked. */ + /** HTTPS URL of the Git repository to be linked. SSH URLs are not supported. */ @JsonProperty("url") private String url; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/CreateRepoResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/CreateRepoResponse.java index 05c419052..de0571dbc 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/CreateRepoResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/CreateRepoResponse.java @@ -26,14 +26,17 @@ public class CreateRepoResponse { private String path; /** - * Git provider of the linked Git repository, e.g. `gitHub`, `azureDevOpsServices`, - * `bitbucketServer` (Bitbucket Data Center), `gitLabEnterpriseEdition` (GitLab Self-Managed), or - * `awsCodeCommit`. + * Git provider of the linked Git repository. Supported providers are `gitHub`, `bitbucketCloud`, + * `gitLab`, `azureDevOpsServices`, `gitHubEnterprise`, `bitbucketServer` (Bitbucket Data Center), + * `gitLabEnterpriseEdition` (GitLab Self-Managed), and `awsCodeCommit`. */ @JsonProperty("provider") private String provider; - /** Sparse checkout settings for the Git folder (repo). */ + /** + * Sparse checkout settings for the Git folder (repo). Only present when sparse checkout is + * enabled for the Git folder. + */ @JsonProperty("sparse_checkout") private SparseCheckout sparseCheckout; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/Delete.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/Delete.java index 8608d5880..14bca4924 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/Delete.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/Delete.java @@ -15,8 +15,8 @@ public class Delete { /** * The flag that specifies whether to delete the object recursively. It is `false` by default. - * Please note this deleting directory is not atomic. If it fails in the middle, some of objects - * under this directory may be deleted and cannot be undone. + * Deleting a directory recursively is not atomic. If the call fails part way, some objects under + * the directory may already be deleted and cannot be restored. */ @JsonProperty("recursive") private Boolean recursive; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/DeleteRepoRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/DeleteRepoRequest.java index 630077ce1..f18b524ed 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/DeleteRepoRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/DeleteRepoRequest.java @@ -9,7 +9,7 @@ @Generated public class DeleteRepoRequest { - /** The ID for the corresponding repo to delete. */ + /** ID of the Git folder (repo) to delete. */ @JsonIgnore private Long repoId; public DeleteRepoRequest setRepoId(Long repoId) { diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/ExportResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/ExportResponse.java index 61360554b..2044b22aa 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/ExportResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/ExportResponse.java @@ -14,13 +14,17 @@ @Generated public class ExportResponse { /** - * The base64-encoded content. If the limit (10MB) is exceeded, exception with error code - * **MAX_NOTEBOOK_SIZE_EXCEEDED** is thrown. + * The base64-encoded content of the exported object. If the content exceeds the size limit (10 + * MB), the call fails with error code `MAX_NOTEBOOK_SIZE_EXCEEDED`. */ @JsonProperty("content") private String content; - /** The file type of the exported file. */ + /** + * The file extension that matches the exported content, for example `py` for a Python notebook + * exported as `SOURCE`, `ipynb` for `JUPYTER`, `html` for `HTML`, `dbc` for `DBC`, and `zip` for + * a directory exported as `SOURCE` or `AUTO`. It is empty for workspace files. + */ @JsonProperty("file_type") private String fileType; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/GetRepoResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/GetRepoResponse.java index 2a81ec912..1f5e142c4 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/GetRepoResponse.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/GetRepoResponse.java @@ -9,7 +9,10 @@ @Generated public class GetRepoResponse { - /** Branch that the local version of the repo is checked out to. */ + /** + * Branch that the local version of the repo is checked out to. Omitted when the Git folder (repo) + * is in a detached HEAD state, for example after checking out a tag. + */ @JsonProperty("branch") private String branch; @@ -33,14 +36,17 @@ public class GetRepoResponse { private String path; /** - * Git provider of the linked Git repository, e.g. `gitHub`, `azureDevOpsServices`, - * `bitbucketServer` (Bitbucket Data Center), `gitLabEnterpriseEdition` (GitLab Self-Managed), or - * `awsCodeCommit`. + * Git provider of the linked Git repository. Supported providers are `gitHub`, `bitbucketCloud`, + * `gitLab`, `azureDevOpsServices`, `gitHubEnterprise`, `bitbucketServer` (Bitbucket Data Center), + * `gitLabEnterpriseEdition` (GitLab Self-Managed), and `awsCodeCommit`. */ @JsonProperty("provider") private String provider; - /** Sparse checkout settings for the Git folder (repo). */ + /** + * Sparse checkout settings for the Git folder (repo). Only present when sparse checkout is + * enabled for the Git folder. + */ @JsonProperty("sparse_checkout") private SparseCheckout sparseCheckout; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/Import.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/Import.java index ee39ba51d..892c7022d 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/Import.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/Import.java @@ -10,10 +10,9 @@ @Generated public class Import { /** - * The base64-encoded content. This has a limit of 10 MB. - * - *

If the limit (10MB) is exceeded, exception with error code **MAX_NOTEBOOK_SIZE_EXCEEDED** is - * thrown. This parameter might be absent, and instead a posted file is used. + * The base64-encoded content to import. The content is limited to 10 MB. If the limit is + * exceeded, the call fails with error code `MAX_NOTEBOOK_SIZE_EXCEEDED`. This parameter might be + * absent, and instead a posted file is used. */ @JsonProperty("content") private String content; @@ -34,13 +33,17 @@ public class Import { @JsonProperty("format") private ImportFormat format; - /** The language of the object. This value is set only if the object type is `NOTEBOOK`. */ + /** + * The language of the notebook. It applies only to the `SOURCE` format: set it to import a single + * notebook, or leave it unset to import a directory. + */ @JsonProperty("language") private Language language; /** * The flag that specifies whether to overwrite existing object. It is `false` by default. For - * `DBC` format, `overwrite` is not supported since it may contain a directory. + * `DBC` format, `overwrite` is not supported since it may contain a directory. Importing a + * directory in `SOURCE` format does not support `overwrite` either. */ @JsonProperty("overwrite") private Boolean overwrite; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/ListWorkspaceRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/ListWorkspaceRequest.java index fdda608ab..3a95fef03 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/ListWorkspaceRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/ListWorkspaceRequest.java @@ -10,7 +10,11 @@ @Generated public class ListWorkspaceRequest { - /** UTC timestamp in milliseconds */ + /** + * A UTC timestamp in milliseconds since the epoch. When it is set and `path` is a directory, the + * response includes only the notebooks that were modified after this time. Objects that are not + * notebooks are always included. + */ @JsonIgnore @QueryParam("notebooks_modified_after") private Long notebooksModifiedAfter; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/ObjectInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/ObjectInfo.java index 8138cb5c8..949396d9d 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/ObjectInfo.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/ObjectInfo.java @@ -12,7 +12,10 @@ */ @Generated public class ObjectInfo { - /** Only applicable to files. The creation UTC timestamp. */ + /** + * The time the object was created, as a UTC timestamp in milliseconds since the epoch. It is + * returned for notebooks and files. + */ @JsonProperty("created_at") private Long createdAt; @@ -27,7 +30,10 @@ public class ObjectInfo { @JsonProperty("language") private Language language; - /** Only applicable to files, the last modified UTC timestamp. */ + /** + * The time the object was last modified, as a UTC timestamp in milliseconds since the epoch. It + * is returned for notebooks and files. + */ @JsonProperty("modified_at") private Long modifiedAt; @@ -53,7 +59,7 @@ public class ObjectInfo { @JsonProperty("resource_id") private String resourceId; - /** Only applicable to files. The file size in bytes can be returned. */ + /** The size of the file in bytes. It is returned only for objects of type ``FILE``. */ @JsonProperty("size") private Long size; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/RepoInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/RepoInfo.java index bdecbf7a1..8b464fd50 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/RepoInfo.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/RepoInfo.java @@ -7,18 +7,24 @@ import com.fasterxml.jackson.annotation.JsonProperty; import java.util.Objects; -/** Git folder (repo) information. */ +/** + * Git folder (repo) information. A Git folder is a workspace folder that is linked to a remote Git + * repository and tracks the branch or commit that is checked out. + */ @Generated public class RepoInfo { - /** Name of the current git branch of the git folder (repo). */ + /** + * Name of the branch that the Git folder (repo) is checked out to. Omitted when the Git folder is + * in a detached HEAD state, for example after checking out a tag. + */ @JsonProperty("branch") private String branch; - /** Current git commit id of the git folder (repo). */ + /** SHA-1 hash of the commit that the Git folder (repo) is currently checked out to. */ @JsonProperty("head_commit_id") private String headCommitId; - /** Id of the git folder (repo) in the Workspace. */ + /** ID of the Git folder (repo) object in the workspace. */ @JsonProperty("id") private Long id; @@ -27,18 +33,21 @@ public class RepoInfo { private String path; /** - * Git provider of the remote git repository, e.g. `gitHub`, `azureDevOpsServices`, - * `bitbucketServer` (Bitbucket Data Center), `gitLabEnterpriseEdition` (GitLab Self-Managed), or - * `awsCodeCommit`. + * Git provider of the remote Git repository. Supported providers are `gitHub`, `bitbucketCloud`, + * `gitLab`, `azureDevOpsServices`, `gitHubEnterprise`, `bitbucketServer` (Bitbucket Data Center), + * `gitLabEnterpriseEdition` (GitLab Self-Managed), and `awsCodeCommit`. */ @JsonProperty("provider") private String provider; - /** Sparse checkout config for the git folder (repo). */ + /** + * Sparse checkout configuration of the Git folder (repo). Only present when sparse checkout is + * enabled for the Git folder. + */ @JsonProperty("sparse_checkout") private SparseCheckout sparseCheckout; - /** URL of the remote git repository. */ + /** HTTPS URL of the remote Git repository. */ @JsonProperty("url") private String url; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/ReposAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/ReposAPI.java index 9baf9aa4e..9c6c94742 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/ReposAPI.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/ReposAPI.java @@ -48,7 +48,10 @@ public void delete(long repoId) { delete(new DeleteRepoRequest().setRepoId(repoId)); } - /** Deletes the specified repo. */ + /** + * Deletes the Git folder (repo) and its contents from the workspace. The remote Git repository is + * not affected. + */ public void delete(DeleteRepoRequest request) { impl.delete(request); } @@ -113,7 +116,7 @@ public RepoPermissions setPermissions(RepoPermissionsRequest request) { /** * Updates the repo to a different branch or tag, or updates the repo to the latest commit on the - * same branch. + * same branch. Exactly one of `branch` or `tag` must be specified. */ public void update(UpdateRepoRequest request) { impl.update(request); diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/ReposService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/ReposService.java index cf4be5a41..e9801e12c 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/ReposService.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/ReposService.java @@ -28,7 +28,10 @@ public interface ReposService { */ CreateRepoResponse create(CreateRepoRequest createRepoRequest); - /** Deletes the specified repo. */ + /** + * Deletes the Git folder (repo) and its contents from the workspace. The remote Git repository is + * not affected. + */ void delete(DeleteRepoRequest deleteRepoRequest); /** Returns the repo with the given repo ID. */ @@ -59,7 +62,7 @@ GetRepoPermissionLevelsResponse getPermissionLevels( /** * Updates the repo to a different branch or tag, or updates the repo to the latest commit on the - * same branch. + * same branch. Exactly one of `branch` or `tag` must be specified. */ void update(UpdateRepoRequest updateRepoRequest); diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/UpdateRepoRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/UpdateRepoRequest.java index 3e382df67..3570e87a4 100644 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/UpdateRepoRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/UpdateRepoRequest.java @@ -10,7 +10,10 @@ @Generated public class UpdateRepoRequest { - /** Branch that the local version of the repo is checked out to. */ + /** + * Branch to check out. The Git folder (repo) is then updated to the latest commit of the branch. + * Mutually exclusive with `tag`. + */ @JsonProperty("branch") private String branch; @@ -41,7 +44,7 @@ public class UpdateRepoRequest { /** * If specified, update the sparse checkout settings. The update will fail if sparse checkout is - * not enabled for the repo. + * not enabled for the repo. Must be sent together with `branch` or `tag`. */ @JsonProperty("sparse_checkout") private SparseCheckoutUpdate sparseCheckout; @@ -49,7 +52,7 @@ public class UpdateRepoRequest { /** * Tag that the local version of the repo is checked out to. Updating the repo to a tag puts the * repo in a detached HEAD state. Before committing new changes, you must update the repo to a - * branch instead of the detached HEAD. + * branch instead of the detached HEAD. Mutually exclusive with `branch`. */ @JsonProperty("tag") private String tag; diff --git a/examples/docs/pom.xml b/examples/docs/pom.xml index 4f0c23cee..d1bc72cc9 100644 --- a/examples/docs/pom.xml +++ b/examples/docs/pom.xml @@ -24,7 +24,7 @@ com.databricks databricks-sdk-java - 0.180.0 + 0.181.0 diff --git a/examples/spring-boot-oauth-u2m-demo/pom.xml b/examples/spring-boot-oauth-u2m-demo/pom.xml index 044045393..d985f933f 100644 --- a/examples/spring-boot-oauth-u2m-demo/pom.xml +++ b/examples/spring-boot-oauth-u2m-demo/pom.xml @@ -40,7 +40,7 @@ com.databricks databricks-sdk-java - 0.180.0 + 0.181.0 diff --git a/lockfile.json b/lockfile.json index a42a58036..b97ec4030 100644 --- a/lockfile.json +++ b/lockfile.json @@ -1,7 +1,7 @@ { "artifactId": "databricks-sdk-parent", "groupId": "com.databricks", - "version": "0.180.0", + "version": "0.181.0", "lockFileVersion": 1, "dependencies": [], "mavenPlugins": [], diff --git a/pom.xml b/pom.xml index d4a2d0cc7..bd7d17cbf 100644 --- a/pom.xml +++ b/pom.xml @@ -4,7 +4,7 @@ 4.0.0 com.databricks databricks-sdk-parent - 0.180.0 + 0.181.0 pom Databricks SDK for Java The Databricks SDK for Java includes functionality to accelerate development with Java for diff --git a/shaded/pom.xml b/shaded/pom.xml index ac8958b17..82ac9c0cd 100644 --- a/shaded/pom.xml +++ b/shaded/pom.xml @@ -4,7 +4,7 @@ 4.0.0 - 0.180.0 + 0.181.0 com.databricks