From d8a954bbf28f8c251781479243ed5c77efac3174 Mon Sep 17 00:00:00 2001 From: "databricks-ci-ghec-2[bot]" <184307802+databricks-ci-ghec-2[bot]@users.noreply.github.com> Date: Thu, 19 Nov 2026 04:09:50 +0000 Subject: [PATCH] Release sdk-go --- .codegen/_last_sha | 2 +- accessmanagement/CHANGELOG.md | 2 + accessmanagement/internal/version.go | 2 +- accessmanagement/v1/client.go | 14 +- accessmanagement/v1/model.go | 77 +++-- agentkit/CHANGELOG.md | 2 + agentkit/internal/version.go | 2 +- agentkit/v1/client.go | 8 +- agentkit/v1/model.go | 28 +- aifunctions/CHANGELOG.md | 2 + aifunctions/internal/version.go | 2 +- aifunctions/v1/client.go | 4 +- aifunctions/v1/model.go | 7 +- cleanrooms/CHANGELOG.md | 2 + cleanrooms/internal/version.go | 2 +- cleanrooms/v1/client.go | 4 +- cleanrooms/v1/model.go | 8 +- dataclassification/CHANGELOG.md | 2 + dataclassification/internal/version.go | 2 +- dataclassification/v1/client.go | 14 +- dataclassification/v1/model.go | 28 +- dataquality/CHANGELOG.md | 2 + dataquality/internal/version.go | 2 +- dataquality/v1/client.go | 15 +- dataquality/v1/model.go | 136 ++++++--- environments/CHANGELOG.md | 2 + environments/internal/version.go | 2 +- environments/v1/client.go | 7 +- environments/v1/model.go | 23 +- genie/CHANGELOG.md | 2 + genie/internal/version.go | 2 +- genie/v1/client.go | 24 +- genie/v1/model.go | 103 +++++-- genieagents/CHANGELOG.md | 2 + genieagents/internal/version.go | 2 +- genieagents/v1/model.go | 4 +- jobs/CHANGELOG.md | 2 + jobs/internal/version.go | 2 +- jobs/v2/model.go | 12 +- lakewatch/CHANGELOG.md | 2 + lakewatch/internal/version.go | 2 +- lakewatch/v1/model.go | 9 +- marketplaces/CHANGELOG.md | 2 + marketplaces/internal/version.go | 2 +- marketplaces/v1/client.go | 62 ++-- marketplaces/v1/model.go | 387 ++++++++++++++++++------- oauth/CHANGELOG.md | 2 + oauth/internal/version.go | 2 +- oauth/v1/client.go | 10 +- oauth/v1/model.go | 57 ++-- pipelines/CHANGELOG.md | 2 + pipelines/internal/version.go | 2 +- pipelines/v2/model.go | 34 ++- postgres/CHANGELOG.md | 2 + postgres/internal/version.go | 2 +- postgres/v1/model.go | 40 ++- secrets/CHANGELOG.md | 2 + secrets/internal/version.go | 2 +- secrets/v1/client.go | 93 +----- secrets/v1/model.go | 28 +- settings/CHANGELOG.md | 2 + settings/internal/version.go | 2 +- settings/v2/client.go | 4 +- settings/v2/model.go | 87 +++++- softwareartifacts/CHANGELOG.md | 2 + softwareartifacts/internal/version.go | 2 +- softwareartifacts/v1/client.go | 114 ++++++++ softwareartifacts/v1/model.go | 18 ++ softwareartifacts/v1/wire.go | 95 ++++++ statementexecution/CHANGELOG.md | 2 + statementexecution/internal/version.go | 2 +- statementexecution/v1/model.go | 41 ++- statementexecution/v2/model.go | 6 +- tagpolicies/CHANGELOG.md | 2 + tagpolicies/internal/version.go | 2 +- tagpolicies/v1/model.go | 27 +- uc/connections/CHANGELOG.md | 2 + uc/connections/internal/version.go | 2 +- uc/connections/v1/client.go | 6 +- uc/connections/v1/model.go | 81 ++++-- uc/credentials/CHANGELOG.md | 2 + uc/credentials/internal/version.go | 2 +- uc/credentials/v1/client.go | 4 +- uc/credentials/v1/model.go | 49 +++- uc/functions/CHANGELOG.md | 2 + uc/functions/internal/version.go | 2 +- uc/functions/v1/model.go | 199 ++++++++----- usagedashboards/CHANGELOG.md | 2 + usagedashboards/internal/version.go | 2 +- usagedashboards/v1/client.go | 12 +- usagedashboards/v1/model.go | 24 +- warehouses/CHANGELOG.md | 2 + warehouses/internal/version.go | 2 +- warehouses/v1/model.go | 156 ++++++---- 94 files changed, 1606 insertions(+), 655 deletions(-) diff --git a/.codegen/_last_sha b/.codegen/_last_sha index 52897a67..ef04310b 100644 --- a/.codegen/_last_sha +++ b/.codegen/_last_sha @@ -1 +1 @@ -afa880889a19caeb0dc0fddeca4613cfd803c334 \ No newline at end of file +ab1d491ca9c49dba4f28497f467b887006f9860f \ No newline at end of file diff --git a/accessmanagement/CHANGELOG.md b/accessmanagement/CHANGELOG.md index 5589e223..17d87bb0 100644 --- a/accessmanagement/CHANGELOG.md +++ b/accessmanagement/CHANGELOG.md @@ -1,5 +1,7 @@ # Version changelog +## Release v0.9.0 (2026-11-19) + ## Release v0.8.0 (2026-11-17) ## Release v0.7.0 (2026-11-12) diff --git a/accessmanagement/internal/version.go b/accessmanagement/internal/version.go index e8f62916..67782f47 100644 --- a/accessmanagement/internal/version.go +++ b/accessmanagement/internal/version.go @@ -2,4 +2,4 @@ package internal const ModuleName = "sdk-go-accessmanagement" -const Version = "0.8.0" +const Version = "0.9.0" diff --git a/accessmanagement/v1/client.go b/accessmanagement/v1/client.go index bb21401b..fb1cc37e 100644 --- a/accessmanagement/v1/client.go +++ b/accessmanagement/v1/client.go @@ -1294,9 +1294,11 @@ func (c *internalClient) ListPermissionLevels(ctx context.Context, req ListPermi return resp, nil } -// Sets permissions on an object, replacing existing permissions if they exist. -// Deletes all direct permissions if none are specified. Objects can inherit -// permissions from their parent objects or root object. +// Sets permissions on an object, replacing all direct permissions with the ones +// in the request. Principals that are not in the request lose their direct +// permissions on the object, and all direct permissions are deleted if none are +// specified. Objects can inherit permissions from their parent objects or root +// object. func (c *internalClient) SetObjectPermissions(ctx context.Context, req SetObjectPermissionsRequest, opts ...call.Option) (*PermissionsResponse, error) { wireReq, err := setObjectPermissionsRequestToWire(&req) if err != nil { @@ -1375,8 +1377,10 @@ func (c *internalClient) SetObjectPermissions(ctx context.Context, req SetObject return resp, nil } -// Updates the permissions on an object. Objects can inherit permissions from -// their parent objects or root object. +// Updates the permissions on an object by adding or changing the permissions of +// the principals in the request. Principals that are not in the request keep +// their existing permissions. Objects can inherit permissions from their parent +// objects or root object. func (c *internalClient) UpdateObjectPermissions(ctx context.Context, req UpdateObjectPermissionsRequest, opts ...call.Option) (*PermissionsResponse, error) { wireReq, err := updateObjectPermissionsRequestToWire(&req) if err != nil { diff --git a/accessmanagement/v1/model.go b/accessmanagement/v1/model.go index 37b6991b..8dfde1da 100644 --- a/accessmanagement/v1/model.go +++ b/accessmanagement/v1/model.go @@ -48,7 +48,8 @@ const ( ) type AccessControlRequest struct { - PrincipalName isAccessControlRequest_PrincipalName + PrincipalName isAccessControlRequest_PrincipalName + // Permission level to grant to the principal. PermissionLevel PermissionLevel } @@ -57,7 +58,7 @@ type isAccessControlRequest_PrincipalName interface { } // AccessControlRequest_PrincipalName_UserName selects UserName for AccessControlRequest.PrincipalName. -// name of the user +// Username of the user, which is the user's email address. type AccessControlRequest_PrincipalName_UserName struct { UserName string } @@ -65,7 +66,7 @@ type AccessControlRequest_PrincipalName_UserName struct { func (*AccessControlRequest_PrincipalName_UserName) isAccessControlRequest_PrincipalName() {} // AccessControlRequest_PrincipalName_GroupName selects GroupName for AccessControlRequest.PrincipalName. -// name of the group +// Display name of the group. type AccessControlRequest_PrincipalName_GroupName struct { GroupName string } @@ -73,7 +74,7 @@ type AccessControlRequest_PrincipalName_GroupName struct { func (*AccessControlRequest_PrincipalName_GroupName) isAccessControlRequest_PrincipalName() {} // AccessControlRequest_PrincipalName_ServicePrincipalName selects ServicePrincipalName for AccessControlRequest.PrincipalName. -// application ID of a service principal +// Application ID of the service principal. type AccessControlRequest_PrincipalName_ServicePrincipalName struct { ServicePrincipalName string } @@ -85,7 +86,8 @@ type AccessControlResponse struct { PrincipalName isAccessControlResponse_PrincipalName // Display name of the user or service principal. DisplayName *string - // All permissions. + // Permission levels the principal holds on the object, both granted directly + // and inherited. AllPermissions []Permission } @@ -94,7 +96,7 @@ type isAccessControlResponse_PrincipalName interface { } // AccessControlResponse_PrincipalName_UserName selects UserName for AccessControlResponse.PrincipalName. -// name of the user +// Username of the user, which is the user's email address. type AccessControlResponse_PrincipalName_UserName struct { UserName string } @@ -102,7 +104,7 @@ type AccessControlResponse_PrincipalName_UserName struct { func (*AccessControlResponse_PrincipalName_UserName) isAccessControlResponse_PrincipalName() {} // AccessControlResponse_PrincipalName_GroupName selects GroupName for AccessControlResponse.PrincipalName. -// name of the group +// Display name of the group. type AccessControlResponse_PrincipalName_GroupName struct { GroupName string } @@ -110,7 +112,7 @@ type AccessControlResponse_PrincipalName_GroupName struct { func (*AccessControlResponse_PrincipalName_GroupName) isAccessControlResponse_PrincipalName() {} // AccessControlResponse_PrincipalName_ServicePrincipalName selects ServicePrincipalName for AccessControlResponse.PrincipalName. -// Name of the service principal. +// Application ID of the service principal. type AccessControlResponse_PrincipalName_ServicePrincipalName struct { ServicePrincipalName string } @@ -195,7 +197,10 @@ type GetObjectPermissionsRequest struct { // registered-models, repos, serving-endpoints, supervisor-agents, // vector-search-endpoints, or warehouses. RequestObjectType *string - // The id of the request object. + // The id of the object. It is the id that the object's own API uses, for + // example the cluster id for clusters, the job id for jobs, and the workspace + // object id for notebooks and directories. For the `authorization` object type, + // use `tokens` to manage token permissions. RequestObjectId *string } @@ -273,11 +278,15 @@ type ListPermissionLevelsRequest struct { // registered-models, repos, serving-endpoints, supervisor-agents, // vector-search-endpoints, or warehouses. RequestObjectType *string - RequestObjectId *string + // The id of the object. It is the id that the object's own API uses, for + // example the cluster id for clusters, the job id for jobs, and the workspace + // object id for notebooks and directories. For the `authorization` object type, + // use `tokens` to manage token permissions. + RequestObjectId *string } type ListPermissionLevelsResponse struct { - // Specific permission levels + // Permission levels that can be granted on objects of the requested type. PermissionLevels []PermissionsDescription } @@ -346,8 +355,13 @@ type MigratePermissionsResponse struct { } type Permission struct { - PermissionLevel PermissionLevel - Inherited *bool + // Permission level the principal holds on the object. + PermissionLevel PermissionLevel + // Whether the permission is inherited from a parent object or the root object + // instead of being granted directly on the object. + Inherited *bool + // Paths of the objects the permission is inherited from. It is only set when + // `inherited` is true. InheritedFromObject []string } @@ -358,13 +372,24 @@ type PermissionOutput struct { } type PermissionsDescription struct { + // Permission level that can be granted on the object. PermissionLevel PermissionLevel - Description *string + // Human-readable description of the permission level. + Description *string } +// The permissions set on an object, with one entry per principal that holds a +// permission on it.. type PermissionsResponse struct { - ObjectId *string - ObjectType *string + // Path that identifies the object in the access control list, built from the + // object type and the object id. + ObjectId *string + // Type of the object, as recorded in the access control list. It can differ + // from the `request_object_type` path segment, for example a request for + // `clusters` returns `cluster`. + ObjectType *string + // Permissions on the object, with one entry per principal. Each entry lists the + // principal's direct and inherited permission levels. AccessControlList []AccessControlResponse } @@ -474,8 +499,14 @@ type SetObjectPermissionsRequest struct { // registered-models, repos, serving-endpoints, supervisor-agents, // vector-search-endpoints, or warehouses. RequestObjectType *string - // The id of the request object. - RequestObjectId *string + // The id of the object. It is the id that the object's own API uses, for + // example the cluster id for clusters, the job id for jobs, and the workspace + // object id for notebooks and directories. For the `authorization` object type, + // use `tokens` to manage token permissions. + RequestObjectId *string + // Permissions to apply to the object, with one entry per principal. Each entry + // names exactly one principal through `user_name`, `group_name` or + // `service_principal_name` and the `permission_level` for that principal. AccessControlList []AccessControlRequest } @@ -487,8 +518,14 @@ type UpdateObjectPermissionsRequest struct { // registered-models, repos, serving-endpoints, supervisor-agents, // vector-search-endpoints, or warehouses. RequestObjectType *string - // The id of the request object. - RequestObjectId *string + // The id of the object. It is the id that the object's own API uses, for + // example the cluster id for clusters, the job id for jobs, and the workspace + // object id for notebooks and directories. For the `authorization` object type, + // use `tokens` to manage token permissions. + RequestObjectId *string + // Permissions to apply to the object, with one entry per principal. Each entry + // names exactly one principal through `user_name`, `group_name` or + // `service_principal_name` and the `permission_level` for that principal. AccessControlList []AccessControlRequest } diff --git a/agentkit/CHANGELOG.md b/agentkit/CHANGELOG.md index 34271e2e..ceee23b7 100644 --- a/agentkit/CHANGELOG.md +++ b/agentkit/CHANGELOG.md @@ -1,5 +1,7 @@ # Version changelog +## Release v0.9.0 (2026-11-19) + ## Release v0.8.0 (2026-11-17) ## Release v0.7.0 (2026-11-12) diff --git a/agentkit/internal/version.go b/agentkit/internal/version.go index 0f06e7c9..771e1df0 100644 --- a/agentkit/internal/version.go +++ b/agentkit/internal/version.go @@ -2,4 +2,4 @@ package internal const ModuleName = "sdk-go-agentkit" -const Version = "0.8.0" +const Version = "0.9.0" diff --git a/agentkit/v1/client.go b/agentkit/v1/client.go index 840e7b64..89522692 100644 --- a/agentkit/v1/client.go +++ b/agentkit/v1/client.go @@ -224,6 +224,8 @@ func (c *internalClient) ClearSessionItems(ctx context.Context, req ClearSession // exists. Omitted `session_id` is its own uniqueness key: two omitted-session // entries with the same actor and path conflict, but an omitted-session entry // does not conflict with a session-scoped entry at the same actor and path. +// `session_id` is deprecated: once it is ignored, the uniqueness key becomes +// actor and path. func (c *internalClient) CreateMemory(ctx context.Context, req CreateManagedMemoryEntryRequest, opts ...call.Option) (*ManagedMemoryEntry, error) { wireReq, err := createManagedMemoryEntryRequestToWire(&req) if err != nil { @@ -1408,9 +1410,9 @@ func (c *internalClient) GrantSessionStorePermission(ctx context.Context, req Gr } // Lists memory entries for one actor. An exact `path` filters entries across -// sessions, ignoring session metadata. Otherwise, `session_id` and -// `path_prefix` restrict the actor partition. `view` controls whether each -// returned entry includes memory content. +// sessions, ignoring session metadata. Otherwise, `path_prefix` and the +// deprecated `session_id` restrict the actor partition. `view` controls whether +// each returned entry includes memory content. func (c *internalClient) ListMemories(ctx context.Context, req ListManagedMemoryEntriesRequest, opts ...call.Option) (*ListManagedMemoryEntriesResponse, error) { wireReq, err := listManagedMemoryEntriesRequestToWire(&req) if err != nil { diff --git a/agentkit/v1/model.go b/agentkit/v1/model.go index 69dbd90c..46c24683 100644 --- a/agentkit/v1/model.go +++ b/agentkit/v1/model.go @@ -286,8 +286,9 @@ type GrantSessionStorePermissionRequest struct { type GrantSessionStorePermissionResponse struct { } -// Request to list memory entries for one actor, optionally restricted by -// session and path prefix, or matched by exact path regardless of session.. +// Request to list memory entries for one actor, optionally restricted by path +// prefix and the deprecated session filter, or matched by exact path regardless +// of session.. type ListManagedMemoryEntriesRequest struct { // Memory store whose entries are listed, in the form // `memory-stores/{managed_memory_store_id}`. @@ -301,9 +302,9 @@ type ListManagedMemoryEntriesRequest struct { ActorId *string // Optional path prefix used to restrict entries within the actor partition. PathPrefix *string - // Optional session identifier. When set, only entries with this exact - // `session_id` are returned. Omitted-session (cross-session) entries are not - // included. Ignored when path is set. + // Deprecated: the service will ignore this filter. Until then, when set, only + // entries with this exact `session_id` are returned, and omitted-session + // (cross-session) entries are not included. Ignored when path is set. SessionId *string // Controls whether each returned entry includes memory content. Defaults to // `FULL`. @@ -458,12 +459,13 @@ type ManagedMemoryEntry struct { // Customer-provided identifier for the actor whose memory this entry // represents. ActorId *string `fieldmask:"actor_id"` - // Optional identifier for the session associated with this memory entry. When - // omitted, the entry applies across the actor's sessions. + // Deprecated: memory entries will be identified by `(actor_id, path)`, and the + // service will ignore this field on writes and omit it from responses. Until + // then, an omitted value means the entry applies across the actor's sessions. SessionId *string `fieldmask:"session_id"` - // Absolute, case-sensitive path identifying the entry within its actor and - // optional session. Paths must begin with `/` and must not contain empty, `.` - // or `..` segments. + // Absolute, case-sensitive path identifying the entry within its actor and, + // until the deprecated `session_id` is ignored, its optional session. Paths + // must begin with `/` and must not contain empty, `.` or `..` segments. Path *string `fieldmask:"path"` // Optional free-form memory content. Content *string `fieldmask:"content"` @@ -585,9 +587,9 @@ type SearchManagedMemoryEntriesRequest struct { // Reserved for pagination compatibility. The server currently ignores this // field because Search returns a ranked top-N result set. PageToken *string - // Optional session identifier. When set, only entries with this exact - // `session_id` are searched. Omitted-session (cross-session) entries are not - // included. + // Deprecated: the service will ignore this filter. Until then, when set, only + // entries with this exact `session_id` are searched, and omitted-session + // (cross-session) entries are not included. SessionId *string // Optional absolute, case-sensitive path prefix used to restrict searched // entries within the actor partition. The prefix must begin with `/` and must diff --git a/aifunctions/CHANGELOG.md b/aifunctions/CHANGELOG.md index 6b381228..6dfec7f2 100644 --- a/aifunctions/CHANGELOG.md +++ b/aifunctions/CHANGELOG.md @@ -1,5 +1,7 @@ # Version changelog +## Release v0.11.0 (2026-11-19) + ## Release v0.10.0 (2026-11-17) ## Release v0.9.0 (2026-11-16) diff --git a/aifunctions/internal/version.go b/aifunctions/internal/version.go index cc0c5b33..cfc8a3eb 100644 --- a/aifunctions/internal/version.go +++ b/aifunctions/internal/version.go @@ -2,4 +2,4 @@ package internal const ModuleName = "sdk-go-aifunctions" -const Version = "0.10.0" +const Version = "0.11.0" diff --git a/aifunctions/v1/client.go b/aifunctions/v1/client.go index 8f110cba..0f48b60a 100644 --- a/aifunctions/v1/client.go +++ b/aifunctions/v1/client.go @@ -453,7 +453,9 @@ func (c *internalClient) AiClassify(ctx context.Context, req AiClassifyRequest, // Turn text and structured data into decisions your application can use. Define // questions and criteria to choose an option, estimate a probability, or assign -// a score given a provided state. +// a score given a provided state. For REST API requests, the default rate limit +// is 1,200 requests per minute per workspace. Contact your account +// team to request a higher limit. func (c *internalClient) AiDecide(ctx context.Context, req AiDecideRequest, opts ...call.Option) (*AiDecideResponse, error) { wireReq, err := aiDecideRequestToWire(&req) if err != nil { diff --git a/aifunctions/v1/model.go b/aifunctions/v1/model.go index 9c6daf61..64ace91d 100644 --- a/aifunctions/v1/model.go +++ b/aifunctions/v1/model.go @@ -56,7 +56,8 @@ type AiClassifyRequest struct { // The label set to classify as. Either a JSON array of label strings (e.g. // ["spam", "not_spam"]), or a JSON object mapping each label to a description // (e.g. {"spam": "unsolicited bulk message", "not_spam": "a legitimate - // message"}). Accepts 2 to 500 labels, each 1 to 100 characters. + // message"}). Accepts 2 to 500 labels, each 1 to 100 characters. When + // multilabel is true, a single label is also accepted. Labels json.RawMessage // Function options. Omitted fields fall back to their documented defaults. Options *AiClassifyOptions @@ -80,8 +81,8 @@ type AiClassifyResponseMetadata struct { // ai_decide. type AiDecideOptions struct { - // The function API version to invoke. Defaults to "1.0". Supported versions: - // ["1.0"]. + // The function API version to invoke. If unset, version 1.0 is used. Supported + // versions: ["1.0"]. Version *string } diff --git a/cleanrooms/CHANGELOG.md b/cleanrooms/CHANGELOG.md index 07b206a9..92bc354d 100644 --- a/cleanrooms/CHANGELOG.md +++ b/cleanrooms/CHANGELOG.md @@ -1,5 +1,7 @@ # Version changelog +## Release v0.8.0 (2026-11-19) + ## Release v0.7.0 (2026-11-17) ## Release v0.6.0 (2026-11-12) diff --git a/cleanrooms/internal/version.go b/cleanrooms/internal/version.go index e16d771f..aeed9e75 100644 --- a/cleanrooms/internal/version.go +++ b/cleanrooms/internal/version.go @@ -2,4 +2,4 @@ package internal const ModuleName = "sdk-go-cleanrooms" -const Version = "0.7.0" +const Version = "0.8.0" diff --git a/cleanrooms/v1/client.go b/cleanrooms/v1/client.go index 656378d1..c198d7e7 100644 --- a/cleanrooms/v1/client.go +++ b/cleanrooms/v1/client.go @@ -1124,7 +1124,9 @@ func (c *internalClient) ListCleanRoomAssetRevisionsIter(ctx context.Context, re } } -// List assets. +// List the assets in a clean room. Listed assets do not include their +// asset-type specific details, such as table columns or notebook content; use +// the get method to retrieve them. func (c *internalClient) ListCleanRoomAssets(ctx context.Context, req ListCleanRoomAssetsRequest, opts ...call.Option) (*ListCleanRoomAssetsResponse, error) { wireReq, err := listCleanRoomAssetsRequestToWire(&req) if err != nil { diff --git a/cleanrooms/v1/model.go b/cleanrooms/v1/model.go index 5e19833f..9c72a27f 100644 --- a/cleanrooms/v1/model.go +++ b/cleanrooms/v1/model.go @@ -345,7 +345,9 @@ type CleanRoomAsset struct { AssetType CleanRoomAsset_AssetType // When the asset is added to the clean room, in epoch milliseconds. AddedAt *int64 - // Status of the asset + // The sharing status of the asset. `PERMISSION_DENIED` means the clean room + // owner no longer has the privileges needed on the underlying Unity Catalog + // object, so the asset is not shared into the clean room. Status CleanRoomAsset_Status_Enum // The alias of the collaborator who owns this asset OwnerCollaboratorAlias *string @@ -387,8 +389,8 @@ type CleanRoomAsset_LocalDetails_ViewLocalDetails struct { func (*CleanRoomAsset_LocalDetails_ViewLocalDetails) isCleanRoomAsset_LocalDetails() {} // CleanRoomAsset_LocalDetails_ForeignTableLocalDetails selects ForeignTableLocalDetails for CleanRoomAsset.LocalDetails. -// Local details for a foreign that are only available to its owner. Present if -// and only if **asset_type** is **FOREIGN_TABLE** +// Local details for a foreign table that are only available to its owner. +// Present if and only if **asset_type** is **FOREIGN_TABLE** type CleanRoomAsset_LocalDetails_ForeignTableLocalDetails struct { ForeignTableLocalDetails CleanRoomAsset_ForeignTableLocalDetails } diff --git a/dataclassification/CHANGELOG.md b/dataclassification/CHANGELOG.md index 343b52e7..7615a4a7 100644 --- a/dataclassification/CHANGELOG.md +++ b/dataclassification/CHANGELOG.md @@ -1,5 +1,7 @@ # Version changelog +## Release v0.7.0 (2026-11-19) + ## Release v0.6.0 (2026-11-12) ### New Features and Improvements diff --git a/dataclassification/internal/version.go b/dataclassification/internal/version.go index 2d5b1c76..47abed52 100644 --- a/dataclassification/internal/version.go +++ b/dataclassification/internal/version.go @@ -2,4 +2,4 @@ package internal const ModuleName = "sdk-go-dataclassification" -const Version = "0.6.0" +const Version = "0.7.0" diff --git a/dataclassification/v1/client.go b/dataclassification/v1/client.go index a4cf82c6..e1d6e7c0 100644 --- a/dataclassification/v1/client.go +++ b/dataclassification/v1/client.go @@ -80,7 +80,8 @@ func NewClient(ctx context.Context, opts ...client.Option) (*Client, error) { // Create Data Classification configuration for a catalog. // // Creates a new config resource, which enables Data Classification for the -// specified catalog. - The config must not already exist for the catalog. +// specified catalog. The catalog must not already have a config. Creating the +// config starts a scan of the selected schemas and schedules recurring scans. func (c *internalClient) CreateCatalogConfig(ctx context.Context, req CreateCatalogConfigRequest, opts ...call.Option) (*CatalogConfig, error) { wireReq, err := createCatalogConfigRequestToWire(&req) if err != nil { @@ -154,6 +155,10 @@ func (c *internalClient) CreateCatalogConfig(ctx context.Context, req CreateCata } // Delete Data Classification configuration for a catalog. +// +// Deleting the config disables Data Classification for the catalog and stops +// its scheduled scans. Tags that auto-tagging already applied to columns are +// not removed. Deleting a config that does not exist succeeds. func (c *internalClient) DeleteCatalogConfig(ctx context.Context, req DeleteCatalogConfigRequest, opts ...call.Option) error { headers := http.Header{} @@ -268,9 +273,10 @@ func (c *internalClient) GetCatalogConfig(ctx context.Context, req GetCatalogCon return resp, nil } -// Update the Data Classification configuration for a catalog. - The config must -// already exist for the catalog. - Updates fields specified in the update_mask. -// Use update_mask field to perform partial updates of the configuration. +// Update the Data Classification configuration for a catalog. +// +// The config must already exist for the catalog. Only the fields named in +// `update_mask` change; the other fields keep their current values. func (c *internalClient) UpdateCatalogConfig(ctx context.Context, req UpdateCatalogConfigRequest, opts ...call.Option) (*CatalogConfig, error) { wireReq, err := updateCatalogConfigRequestToWire(&req) if err != nil { diff --git a/dataclassification/v1/model.go b/dataclassification/v1/model.go index cad4e148..d1224b30 100644 --- a/dataclassification/v1/model.go +++ b/dataclassification/v1/model.go @@ -20,7 +20,8 @@ const ( type AutoTaggingConfig struct { // The Classification Tag. For built-in classes this is a system tag (e.g., // "class.name", "class.location"); for custom classes it is a user-defined - // governance tag key. + // governance tag key. The built-in tags are listed at + // https://docs.databricks.com/aws/en/data-governance/unity-catalog/data-classification-tags. ClassificationTag *string // Whether auto-tagging is enabled or disabled for this classification tag. AutoTaggingMode AutoTaggingConfig_AutoTaggingMode @@ -35,8 +36,9 @@ type CatalogConfig struct { // Resource name in the format: catalogs/{catalog_name}/config. Name *string `fieldmask:"name"` SelectedSchemas isCatalogConfig_SelectedSchemas - // List of auto-tagging configurations for this catalog. Empty list means no - // auto-tagging is enabled. + // Auto-tagging configurations that apply to this catalog. Each entry overrides + // the metastore-level auto-tagging setting for its classification tag; tags + // without an entry inherit the metastore-level setting. AutoTagConfigs []AutoTaggingConfig `fieldmask:"auto_tag_configs"` _ [0]catalogConfigSelectedSchemasFieldMaskMetadata `fieldmask_oneof:"SelectedSchemas"` } @@ -47,7 +49,8 @@ type isCatalogConfig_SelectedSchemas interface { // CatalogConfig_SelectedSchemas_IncludedSchemas selects IncludedSchemas for CatalogConfig.SelectedSchemas. // Schemas to include in the scan, each named relative to the parent catalog. If -// specified, only listed schemas will be scanned. Mutually exclusive with +// specified, only listed schemas will be scanned. Schemas created later are not +// scanned until you add them to the list. Mutually exclusive with // `excluded_schemas`: only one may be set per request. If neither // `included_schemas` nor `excluded_schemas` is set, all schemas are scanned. type CatalogConfig_SelectedSchemas_IncludedSchemas struct { @@ -58,10 +61,10 @@ func (*CatalogConfig_SelectedSchemas_IncludedSchemas) isCatalogConfig_SelectedSc // CatalogConfig_SelectedSchemas_ExcludedSchemas selects ExcludedSchemas for CatalogConfig.SelectedSchemas. // Schemas to exclude from the scan, each named relative to the parent catalog. -// If specified, all schemas except the specified ones will be scanned. Mutually -// exclusive with `included_schemas`: only one may be set per request. If -// neither `included_schemas` nor `excluded_schemas` is set, all schemas are -// scanned. +// If specified, all schemas except the specified ones will be scanned, +// including schemas created later. Mutually exclusive with `included_schemas`: +// only one may be set per request. If neither `included_schemas` nor +// `excluded_schemas` is set, all schemas are scanned. type CatalogConfig_SelectedSchemas_ExcludedSchemas struct { ExcludedSchemas CatalogConfig_SchemaNames `fieldmask:"excluded_schemas"` } @@ -82,7 +85,7 @@ type CatalogConfig_SchemaNames struct { // Create Data Classification configuration for a catalog. Creating a config // enables Data Classification for the catalog.. type CreateCatalogConfigRequest struct { - // Parent resource in the format: catalogs/{catalog_name} + // Name of the catalog to enable, in the format catalogs/{catalog_name}. Parent *string // The configuration to create. CatalogConfig *CatalogConfig @@ -91,13 +94,13 @@ type CreateCatalogConfigRequest struct { // Delete Data Classification configuration for a catalog. Deleting the config // disables Data Classification for the catalog.. type DeleteCatalogConfigRequest struct { - // Resource name in the format: catalogs/{catalog_name}/config + // Resource name of the config, in the format catalogs/{catalog_name}/config. Name *string } // Get Data Classification configuration for a catalog.. type GetCatalogConfigRequest struct { - // Resource name in the format: catalogs/{catalog_name}/config + // Resource name of the config, in the format catalogs/{catalog_name}/config. Name *string } @@ -109,6 +112,7 @@ type UpdateCatalogConfigRequest struct { // The configuration to apply to the catalog. The name field in catalog_config // identifies which resource to update. CatalogConfig *CatalogConfig - // Field mask specifying which fields to update. + // Comma-separated list of the fields of catalog_config to update, for example + // `included_schemas` or `auto_tag_configs`. UpdateMask *types.FieldMask[CatalogConfig] } diff --git a/dataquality/CHANGELOG.md b/dataquality/CHANGELOG.md index 6568eb64..97732f0c 100644 --- a/dataquality/CHANGELOG.md +++ b/dataquality/CHANGELOG.md @@ -1,5 +1,7 @@ # Version changelog +## Release v0.9.0 (2026-11-19) + ## Release v0.8.0 (2026-11-12) ### New Features and Improvements diff --git a/dataquality/internal/version.go b/dataquality/internal/version.go index 4ab11846..37c36ab7 100644 --- a/dataquality/internal/version.go +++ b/dataquality/internal/version.go @@ -2,4 +2,4 @@ package internal const ModuleName = "sdk-go-dataquality" -const Version = "0.8.0" +const Version = "0.9.0" diff --git a/dataquality/v1/client.go b/dataquality/v1/client.go index 4148f04e..e4f80633 100644 --- a/dataquality/v1/client.go +++ b/dataquality/v1/client.go @@ -340,14 +340,14 @@ func (c *internalClient) CreateRefresh(ctx context.Context, req CreateRefreshReq return resp, nil } -// Delete a data quality monitor on Unity Catalog object. +// Delete a data quality monitor on a Unity Catalog object. // // For the `table` `object_type`, the caller must have either of the following -// sets of permissions: **MANAGE** and **USE_CATALOG** on the table's parent -// catalog. **USE_CATALOG** on the table's parent catalog, and **MANAGE** and -// **USE_SCHEMA** on the table's parent schema. **USE_CATALOG** on the table's -// parent catalog, **USE_SCHEMA** on the table's parent schema, and **MANAGE** -// on the table. +// sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the table's parent +// catalog. 2. **USE_CATALOG** on the table's parent catalog, and **MANAGE** and +// **USE_SCHEMA** on the table's parent schema. 3. **USE_CATALOG** on the +// table's parent catalog, **USE_SCHEMA** on the table's parent schema, and +// **MANAGE** on the table. // // Note that the metric tables and dashboard will not be deleted as part of this // call; those assets must be manually cleaned up (if desired). @@ -884,7 +884,8 @@ func (c *internalClient) ListRefreshIter(ctx context.Context, req ListRefreshReq } } -// Update a data quality monitor on Unity Catalog object. +// Update a data quality monitor on a Unity Catalog object. Only the fields +// named in `update_mask` are changed. // // For the `table` `object_type`, the caller must have either of the following // sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the table's parent diff --git a/dataquality/v1/model.go b/dataquality/v1/model.go index 5b1937c7..c4b34691 100644 --- a/dataquality/v1/model.go +++ b/dataquality/v1/model.go @@ -114,6 +114,7 @@ const ( // Anomaly Detection Configurations.. type AnomalyDetectionConfig struct { // List of fully qualified table names to exclude from anomaly detection. + // Format: `catalog.schema.table_name`. ExcludedTableFullNames []string `fieldmask:"excluded_table_full_names"` // Who to alert when anomaly detection finds unhealthy tables in this schema. // Applicable to `schema` monitors only. This is the same schema alert you @@ -179,11 +180,10 @@ type CronSchedule struct { // // [examples]: https://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html QuartzCronExpression *string `fieldmask:"quartz_cron_expression"` - // A Java timezone id. The schedule for a job will be resolved with respect to - // this timezone. See `Java TimeZone - // `_ for - // details. The timezone id (e.g., ``America/Los_Angeles``) in which to evaluate - // the quartz expression. + // The Java timezone ID in which the cron expression is evaluated. See [Java + // TimeZone] for the supported IDs. + // + // [Java TimeZone]: https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html TimezoneId *string `fieldmask:"timezone_id"` // Read only field that indicates whether the schedule is paused or not. PauseStatus CronSchedulePauseStatus `fieldmask:"pause_status"` @@ -191,42 +191,55 @@ type CronSchedule struct { // Data Profiling Configurations.. type DataProfilingConfig struct { - // ID of the schema where output tables are created. + // The UUID of the Unity Catalog schema where the profile and drift metrics + // tables are created. OutputSchemaId *string `fieldmask:"output_schema_id"` - // Field for specifying the absolute path to a custom directory to store - // data-monitoring assets. Normally prepopulated to a default user location via - // UI and Python APIs. + // The absolute workspace path of the directory where the monitor's assets, such + // as the dashboard, are stored. The UI and the Python APIs normally prepopulate + // a default user location. AssetsDir *string `fieldmask:"assets_dir"` // (--[Create:REQ Update:REQ]--) Analysis config which is used to determine // analysis logic. AnalysisConfig isDataProfilingConfig_AnalysisConfig // List of column expressions to slice data with for targeted analysis. The data // is grouped by each expression independently, resulting in a separate slice - // for each predicate and its complements. For example - // `slicing_exprs=[“col_1”, “col_2 > 10”]` will generate the following - // slices: two slices for `col_2 > 10` (True and False), and one slice per - // unique value in `col1`. For high-cardinality columns, only the top 100 unique - // values by frequency will generate slices. + // for each predicate and its complements. For example `slicing_exprs=["col_1", + // "col_2 > 10"]` will generate the following slices: two slices for `col_2 > + // 10` (True and False), and one slice per unique value in `col_1`. For + // high-cardinality columns, only the top 100 unique values by frequency will + // generate slices. SlicingExprs []string `fieldmask:"slicing_exprs"` - // Custom metrics. + // Custom metrics to compute in addition to the built-in ones. See [custom + // metrics]. + // + // [custom metrics]: https://docs.databricks.com/aws/en/data-governance/unity-catalog/data-quality-monitoring/data-profiling/custom-metrics CustomMetrics []DataProfilingCustomMetric `fieldmask:"custom_metrics"` - // Baseline table name. Baseline data is used to compute drift from the data in - // the monitored `table_name`. The baseline table and the monitored table shall - // have the same schema. + // The fully qualified name of a baseline table. Format: + // `catalog.schema.table_name`. Drift metrics compare the monitored table + // against the baseline data, so the two tables must have the same schema. BaselineTableName *string `fieldmask:"baseline_table_name"` - // The cron schedule. + // The schedule on which the monitor refreshes its metrics. Refreshes can also + // be triggered on demand through the Refresh resource. Schedule *CronSchedule `fieldmask:"schedule"` - // Field for specifying notification settings. + // Who to notify about this monitor's refreshes. Only `on_failure` with + // `email_addresses` is supported here. NotificationSettings *NotificationSettings `fieldmask:"notification_settings"` // Whether to skip creating a default dashboard summarizing data quality // metrics. SkipBuiltinDashboard *bool `fieldmask:"skip_builtin_dashboard"` - // Optional argument to specify the warehouse for dashboard creation. If not - // specified, the first running warehouse will be used. + // The ID of the SQL warehouse used to create the dashboard. If not specified, + // the first running warehouse the caller can access is used. WarehouseId *string `fieldmask:"warehouse_id"` - // Unity Catalog table to monitor. Format: `catalog.schema.table_name` + // The fully qualified name of the monitored table. Format: + // `catalog.schema.table_name`. MonitoredTableName *string `fieldmask:"monitored_table_name"` - // The data profiling monitor status. + // The status of the monitor. `DATA_PROFILING_STATUS_PENDING` means the + // monitor's assets are being created or updated. `DATA_PROFILING_STATUS_ACTIVE` + // means the monitor is ready and can be refreshed. + // `DATA_PROFILING_STATUS_FAILED` and `DATA_PROFILING_STATUS_ERROR` mean the + // monitor is not operational, and `latest_monitor_failure_message` describes + // the cause when one was recorded. `DATA_PROFILING_STATUS_DELETE_PENDING` means + // the monitor is being deleted. Status DataProfilingStatus `fieldmask:"status"` // The latest error message for a monitor failure. LatestMonitorFailureMessage *string `fieldmask:"latest_monitor_failure_message"` @@ -234,8 +247,10 @@ type DataProfilingConfig struct { ProfileMetricsTableName *string `fieldmask:"profile_metrics_table_name"` // Table that stores drift metrics data. Format: `catalog.schema.table_name`. DriftMetricsTableName *string `fieldmask:"drift_metrics_table_name"` - // Id of dashboard that visualizes the computed metrics. This can be empty if - // the monitor is in PENDING state. + // The ID of the dashboard that visualizes the computed metrics. It is empty + // while the monitor is pending, when the dashboard was skipped with + // `skip_builtin_dashboard`, or when the caller is in a different workspace from + // the one where the monitor was created. DashboardId *string `fieldmask:"dashboard_id"` // Represents the current monitor configuration version in use. The version will // be represented in a numeric fashion (1,2,3...). The field has flexibility to @@ -252,7 +267,9 @@ type isDataProfilingConfig_AnalysisConfig interface { } // DataProfilingConfig_AnalysisConfig_InferenceLog selects InferenceLog for DataProfilingConfig.AnalysisConfig. -// `Analysis Configuration` for monitoring inference log tables. +// Profiles an inference log table, which stores the requests and predictions of +// a model. Metrics are computed per time window and include model quality +// metrics. type DataProfilingConfig_AnalysisConfig_InferenceLog struct { InferenceLog InferenceLogConfig `fieldmask:"inference_log"` } @@ -260,7 +277,8 @@ type DataProfilingConfig_AnalysisConfig_InferenceLog struct { func (*DataProfilingConfig_AnalysisConfig_InferenceLog) isDataProfilingConfig_AnalysisConfig() {} // DataProfilingConfig_AnalysisConfig_TimeSeries selects TimeSeries for DataProfilingConfig.AnalysisConfig. -// `Analysis Configuration` for monitoring time series tables. +// Profiles a time series table. Metrics are computed per time window, as +// defined by `timestamp_column` and `granularities`. type DataProfilingConfig_AnalysisConfig_TimeSeries struct { TimeSeries TimeSeriesConfig `fieldmask:"time_series"` } @@ -268,7 +286,8 @@ type DataProfilingConfig_AnalysisConfig_TimeSeries struct { func (*DataProfilingConfig_AnalysisConfig_TimeSeries) isDataProfilingConfig_AnalysisConfig() {} // DataProfilingConfig_AnalysisConfig_Snapshot selects Snapshot for DataProfilingConfig.AnalysisConfig. -// `Analysis Configuration` for monitoring snapshot tables. +// Profiles the full contents of the table. Metrics are computed over all rows +// at each refresh. type DataProfilingConfig_AnalysisConfig_Snapshot struct { Snapshot SnapshotConfig `fieldmask:"snapshot"` } @@ -291,12 +310,17 @@ type DataProfilingCustomMetric struct { // [create metric definition]: https://docs.databricks.com/en/lakehouse-monitoring/custom-metrics.html#create-definition Definition *string // A list of column names in the input table the metric should be computed for. - // Can use ``":table"`` to indicate that the metric needs information from + // Can use `":table"` to indicate that the metric needs information from // multiple columns. InputColumns []string - // The output type of the custom metric. + // Specifies the Spark SQL data type of the metric value, either as a plain type + // name or as a JSON-encoded StructField. OutputDataType *string - // The type of the custom metric. + // The type of the custom metric. `DATA_PROFILING_CUSTOM_METRIC_TYPE_AGGREGATE` + // metrics depend only on the columns of the input table, + // `DATA_PROFILING_CUSTOM_METRIC_TYPE_DERIVED` metrics depend only on previously + // computed aggregate metrics, and `DATA_PROFILING_CUSTOM_METRIC_TYPE_DRIFT` + // metrics depend on previously computed aggregate or derived metrics. Type DataProfilingCustomMetricType } @@ -394,30 +418,37 @@ type GetRefreshRequest struct { // Inference log configuration.. type InferenceLogConfig struct { - // Problem type the model aims to solve. + // The type of problem the model solves. It determines which model quality + // metrics are computed. ProblemType InferenceProblemType `fieldmask:"problem_type"` - // Column for the timestamp. + // Column containing the timestamp of each inference request. Its type must be + // TIMESTAMP or convertible to a timestamp. TimestampColumn *string `fieldmask:"timestamp_column"` // List of granularities to use when aggregating data into time windows based on // their timestamp. Granularities []AggregationGranularity `fieldmask:"granularities"` - // Column for the prediction. + // Column containing the model's predicted values. PredictionColumn *string `fieldmask:"prediction_column"` - // Column for the label. + // Column containing the ground truth for the model's predictions. LabelColumn *string `fieldmask:"label_column"` - // Column for the model identifier. + // Column containing the ID of the model that produced each prediction. A slice + // is created automatically for each distinct model ID. ModelIdColumn *string `fieldmask:"model_id_column"` } // Request to list Monitors.. type ListMonitorRequest struct { + // Pagination token from a previous response, used to fetch the next page. PageToken *string - PageSize *int + // The maximum number of monitors to return in one page. + PageSize *int } // Response for listing Monitors.. type ListMonitorResponse struct { - Monitors []Monitor + // The monitors on this page. + Monitors []Monitor + // Pagination token to pass as `page_token` to fetch the next page. NextPageToken *string } @@ -451,8 +482,10 @@ type ListRefreshResponse struct { NextPageToken *string } -// Monitor for the data quality of unity catalog entities such as schema or -// table.. +// A data quality monitor on a Unity Catalog object. A `schema` monitor runs +// anomaly detection on the tables in the schema and is configured through +// `anomaly_detection_config`. A `table` monitor profiles a single table and is +// configured through `data_profiling_config`.. type Monitor struct { // The type of the monitored object. Can be one of the following: `schema` or // `table`. @@ -472,17 +505,20 @@ type Monitor struct { // [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id // [table_id]: https://docs.databricks.com/api/workspace/tables/get#table_id ObjectId *string `fieldmask:"object_id"` - // Anomaly Detection Configuration, applicable to `schema` object types. + // Anomaly detection settings. Required when `object_type` is `schema`. When + // reading a `table` monitor, this holds the settings of the parent schema's + // monitor if the schema has one. AnomalyDetectionConfig *AnomalyDetectionConfig `fieldmask:"anomaly_detection_config"` - // Data Profiling Configuration, applicable to `table` object types. Exactly one - // `Analysis Configuration` must be present. + // Data profiling settings. Required when `object_type` is `table`. Exactly one + // of `inference_log`, `time_series` or `snapshot` must be set. DataProfilingConfig *DataProfilingConfig `fieldmask:"data_profiling_config"` } // Destination of the data quality monitoring notification.. type NotificationDestination struct { // The list of email addresses to send the notification to. A maximum of 5 email - // addresses is supported. + // addresses is supported. Only supported on table monitors, via + // `data_profiling_config`; rejected on schema monitors. EmailAddresses []string `fieldmask:"email_addresses"` // The notification-destination IDs (Slack / Teams / webhook / Asana / // ServiceNow / AWS EventBridge) to send the notification to. The destinations @@ -498,7 +534,9 @@ type NotificationDestination struct { // Settings for sending notifications on the data quality monitoring.. type NotificationSettings struct { - // Destinations to send notifications on failure/timeout. + // Recipients to notify when a refresh of the monitor fails or times out. Only + // supported on table monitors, via `data_profiling_config`, and only + // `email_addresses` is accepted there. OnFailure *NotificationDestination `fieldmask:"on_failure"` // Recipients to notify when anomaly detection finds unhealthy tables in the // schema. Each recipient gets one notification per important unhealthy table. @@ -548,7 +586,8 @@ type SnapshotConfig struct { // Time series analysis configuration.. type TimeSeriesConfig struct { - // Column for the timestamp. + // Column containing the timestamp of each row. Its type must be TIMESTAMP or + // convertible to a timestamp. TimestampColumn *string `fieldmask:"timestamp_column"` // List of granularities to use when aggregating data into time windows based on // their timestamp. @@ -575,7 +614,8 @@ type UpdateMonitorRequest struct { // [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id // [table_id]: https://docs.databricks.com/api/workspace/tables/get#table_id ObjectId *string - // The monitor to update. + // The new values for the monitor. Only the fields named in `update_mask` are + // applied. Monitor *Monitor // The field mask to specify which fields to update as a comma-separated list. // Example value: diff --git a/environments/CHANGELOG.md b/environments/CHANGELOG.md index fbb6e4d6..124b1fe1 100644 --- a/environments/CHANGELOG.md +++ b/environments/CHANGELOG.md @@ -1,5 +1,7 @@ # Version changelog +## Release v0.8.0 (2026-11-19) + ## Release v0.7.0 (2026-11-17) ## Release v0.6.0 (2026-11-12) diff --git a/environments/internal/version.go b/environments/internal/version.go index fb5d8afe..fc5387b3 100644 --- a/environments/internal/version.go +++ b/environments/internal/version.go @@ -2,4 +2,4 @@ package internal const ModuleName = "sdk-go-environments" -const Version = "0.7.0" +const Version = "0.8.0" diff --git a/environments/v1/client.go b/environments/v1/client.go index a6ccbd09..aac9145a 100644 --- a/environments/v1/client.go +++ b/environments/v1/client.go @@ -319,7 +319,8 @@ func (c *internalClient) DeleteWorkspaceBaseEnvironment(ctx context.Context, req // Gets the default WorkspaceBaseEnvironment configuration for the workspace. // Returns the current default base environment settings for both CPU and GPU -// compute. +// compute. An unset CPU or GPU field means that compute type uses the +// Databricks Standard base environment. func (c *internalClient) GetDefaultWorkspaceBaseEnvironment(ctx context.Context, req GetDefaultWorkspaceBaseEnvironmentRequest, opts ...call.Option) (*DefaultWorkspaceBaseEnvironment, error) { headers := http.Header{} @@ -817,7 +818,9 @@ func (o *RefreshWorkspaceBaseEnvironmentOperation) Wait(ctx context.Context, opt // Updates the default WorkspaceBaseEnvironment configuration for the workspace. // Sets the specified base environments as the workspace defaults for CPU and/or -// GPU compute. +// GPU compute. Unsetting a default makes that compute type use the Databricks +// Standard base environment. The Standard base environment has no resource +// name, so unsetting the field is the only way to select it. func (c *internalClient) UpdateDefaultWorkspaceBaseEnvironment(ctx context.Context, req UpdateDefaultWorkspaceBaseEnvironmentRequest, opts ...call.Option) (*DefaultWorkspaceBaseEnvironment, error) { wireReq, err := updateDefaultWorkspaceBaseEnvironmentRequestToWire(&req) if err != nil { diff --git a/environments/v1/model.go b/environments/v1/model.go index 5b9c21e8..5a66fa8d 100644 --- a/environments/v1/model.go +++ b/environments/v1/model.go @@ -458,16 +458,24 @@ type CreateWorkspaceBaseEnvironmentRequest struct { // A singleton resource representing the default workspace base environment // configuration. This resource contains the workspace base environments that // are used as defaults for serverless notebooks and jobs in the workspace, for -// both CPU and GPU compute types.. +// both CPU and GPU compute types. +// +// When cpu_workspace_base_environment or gpu_workspace_base_environment is +// unset, new serverless notebooks for that compute type use the Databricks +// Standard base environment: the latest stable standard environment version +// provided by Databricks, with no workspace base environment applied. The +// workspace settings page shows this as Standard Latest.. type DefaultWorkspaceBaseEnvironment struct { // The resource name of this singleton resource. Format: // default-workspace-base-environment Name *string `fieldmask:"name"` - // The default workspace base environment for CPU compute. Format: - // workspace-base-environments/{workspace_base_environment} + // The default workspace base environment for CPU compute. If unset, CPU compute + // defaults to the Databricks Standard base environment (Standard Latest). + // Format: workspace-base-environments/{workspace_base_environment} CpuWorkspaceBaseEnvironment *string `fieldmask:"cpu_workspace_base_environment"` - // The default workspace base environment for GPU compute. Format: - // workspace-base-environments/{workspace_base_environment} + // The default workspace base environment for GPU compute. If unset, GPU compute + // defaults to the Databricks Standard base environment (Standard Latest). + // Format: workspace-base-environments/{workspace_base_environment} GpuWorkspaceBaseEnvironment *string `fieldmask:"gpu_workspace_base_environment"` } @@ -591,7 +599,10 @@ type UpdateDefaultWorkspaceBaseEnvironmentRequest struct { // // To unset one or both defaults, include the field path(s) in the mask and omit // them from the request body. To unset both, you must list both paths - // explicitly — the wildcard '*' cannot be used to unset fields. + // explicitly — the wildcard '*' cannot be used to unset fields. Unsetting a + // default makes that compute type use the Databricks Standard base environment. + // The Standard base environment has no resource name, so unsetting the field is + // the only way to select it. UpdateMask *types.FieldMask[DefaultWorkspaceBaseEnvironment] } diff --git a/genie/CHANGELOG.md b/genie/CHANGELOG.md index 06989ee3..8d108d13 100644 --- a/genie/CHANGELOG.md +++ b/genie/CHANGELOG.md @@ -1,5 +1,7 @@ # Version changelog +## Release v0.11.0 (2026-11-19) + ## Release v0.10.0 (2026-11-17) ## Release v0.9.0 (2026-11-16) diff --git a/genie/internal/version.go b/genie/internal/version.go index b1804230..cfea58ff 100644 --- a/genie/internal/version.go +++ b/genie/internal/version.go @@ -2,4 +2,4 @@ package internal const ModuleName = "sdk-go-genie" -const Version = "0.10.0" +const Version = "0.11.0" diff --git a/genie/v1/client.go b/genie/v1/client.go index 0a965b49..16f308ba 100644 --- a/genie/v1/client.go +++ b/genie/v1/client.go @@ -490,8 +490,11 @@ func (w *GenieCreateConversationMessageWaiter) Wait(ctx context.Context, opts .. return result, nil } -// Creates and runs chat-mode evaluations for multiple benchmark questions in a -// Genie space. +// Starts a benchmark evaluation run that asks Genie each selected benchmark +// question in a Genie space and compares every response with the benchmark SQL. +// The run executes asynchronously: the response is the new run with its current +// status. If it is still running, poll with the get method until the status is +// terminal. func (c *internalClient) GenieCreateEvalRun(ctx context.Context, req GenieCreateEvalRunRequest, opts ...call.Option) (*GenieEvalRunResponse, error) { wireReq, err := genieCreateEvalRunRequestToWire(&req) if err != nil { @@ -1234,7 +1237,10 @@ func (c *internalClient) GenieGetDownloadFullQueryResult(ctx context.Context, re return resp, nil } -// Get details for evaluation results. +// Gets the full result for one benchmark question in an evaluation run: its +// assessment and the reasons for it, Genie's response with the SQL execution +// result, and the expected response from the benchmark. The result must belong +// to the given run. func (c *internalClient) GenieGetEvalResultDetails(ctx context.Context, req GenieGetEvalResultDetailsRequest, opts ...call.Option) (*GenieEvalResultDetails, error) { headers := http.Header{} @@ -1306,7 +1312,9 @@ func (c *internalClient) GenieGetEvalResultDetails(ctx context.Context, req Geni return resp, nil } -// Get evaluation run details. +// Gets the current status and summary counts of a benchmark evaluation run. +// Poll this method until `eval_run_status` is terminal: DONE, +// EVALUATION_CANCELLED or EVALUATION_TIMEOUT. func (c *internalClient) GenieGetEvalRun(ctx context.Context, req GenieGetEvalRunRequest, opts ...call.Option) (*GenieEvalRunResponse, error) { headers := http.Header{} @@ -1911,7 +1919,10 @@ func (c *internalClient) GenieListConversations(ctx context.Context, req GenieLi return resp, nil } -// List evaluation results for a specific evaluation run. +// Lists the results of a benchmark evaluation run, one per benchmark question. +// Each entry carries the result status and a snapshot of the question and +// benchmark answer; the assessment and Genie's response are available through +// the result details method. func (c *internalClient) GenieListEvalResults(ctx context.Context, req GenieListEvalResultsRequest, opts ...call.Option) (*GenieListEvalResultsResponse, error) { wireReq, err := genieListEvalResultsRequestToWire(&req) if err != nil { @@ -1989,7 +2000,8 @@ func (c *internalClient) GenieListEvalResults(ctx context.Context, req GenieList return resp, nil } -// Lists all evaluation runs in a space. +// Lists the benchmark evaluation runs in a Genie space with the current status +// and summary counts of each run. func (c *internalClient) GenieListEvalRuns(ctx context.Context, req GenieListEvalRunsRequest, opts ...call.Option) (*GenieListEvalRunsResponse, error) { wireReq, err := genieListEvalRunsRequestToWire(&req) if err != nil { diff --git a/genie/v1/model.go b/genie/v1/model.go index c50c8fb7..2a48ee0c 100644 --- a/genie/v1/model.go +++ b/genie/v1/model.go @@ -695,7 +695,7 @@ type ChunkInfo struct { ByteCount *int64 // 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 - // :method:statementexecution/getstatementresultchunkn request. + // :method:statementexecution/getStatementResultChunkN request. NextChunkIndex *int // 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 @@ -799,7 +799,7 @@ type ExternalLink struct { ByteCount *int64 // 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 - // :method:statementexecution/getstatementresultchunkn request. + // :method:statementexecution/getStatementResultChunkN request. NextChunkIndex *int // 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 @@ -966,11 +966,15 @@ type GenieDeleteConversationRequest struct { } type GenieEvalResponse struct { - // The response content (either text or SQL query). + // The content of this entry is the SQL statement when `response_type` is SQL, + // or Genie's text answer when it is TEXT. Response *string - // SQL Statement Execution response. + // Result of executing the SQL statement, only set when `response_type` is SQL. + // The value has the structure of a [Statement Execution API response]. + // + // [Statement Execution API response]: https://docs.databricks.com/api/statement-execution/v1/get-statement-result SqlExecutionResult *StatementResponse - // Type of response + // Whether this entry is a SQL statement or a text answer. ResponseType GenieEvalResponseType } @@ -984,13 +988,19 @@ type GenieEvalResult struct { SpaceId *string // The ID of the benchmark question that was evaluated. BenchmarkQuestionId *string - // Current status of this evaluation result. + // Current status of this result. NOT_STARTED and RUNNING mean the question has + // not finished. DONE means Genie answered and the response was assessed. + // EVALUATION_FAILED means Genie could not answer the question or the benchmark + // SQL could not run. EVALUATION_CANCELLED and EVALUATION_TIMEOUT mean the run + // was cancelled or its background job stopped before this question finished. Status EvaluationStatusType - // Stored snapshot of original benchmark question text. + // Text of the benchmark question as it was when the run started. Later edits to + // the question do not change it. Question *string - // Stored snapshot of original benchmark answer text. + // Benchmark SQL statement that defines the expected answer, as it was when the + // run started. BenchmarkAnswer *string - // User ID who created evaluation result. + // ID of the user who started the evaluation run. CreatedByUser *int64 } @@ -1002,11 +1012,17 @@ type GenieEvalResultDetails struct { SpaceId *string // The ID of the benchmark question that was evaluated. BenchmarkQuestionId *string - // Current status of the evaluation run. + // Current status of this evaluation result, not of the whole run. Once the + // status is DONE, the response and automatic assessment are complete. A user + // can still change the assessment manually. EvalRunStatus EvaluationStatusType - // Assessment of the evaluation result: good, bad, or needs review + // Outcome of comparing Genie's response with the benchmark. GOOD means the + // results matched, BAD means they differed, and NEEDS_REVIEW means the + // comparison was inconclusive and a person should review the result. The value + // is only meaningful once the result status is DONE. Assessment GenieEvalAssessment - // Whether this evaluation was manually assessed. + // Whether a user set the assessment manually after reviewing the result. A + // manual assessment replaces the automatic one and clears `assessment_reasons`. ManualAssessment *bool // Reasons for the assessment score. // @@ -1057,18 +1073,32 @@ type GenieEvalResultDetails struct { // (deprecated) - LLM_JUDGE_SYNTAX_ERROR (deprecated) - LLM_JUDGE_SEMANTIC_ERROR // (deprecated) AssessmentReasons []ScoreReason - // The actual response generated by Genie. + // Genie's response to the benchmark question. A SQL entry carries the generated + // statement and its execution result, and a TEXT entry carries Genie's text + // answer. The list is empty when Genie produced no response. ActualResponse []GenieEvalResponse - // The expected responses from the benchmark. + // The expected answer from the benchmark question: one SQL entry with the + // benchmark SQL statement and its execution result. ExpectedResponse []GenieEvalResponse } -// A benchmark evaluation run. The public benchmark API currently evaluates -// chat-mode responses.. +// A benchmark evaluation run. A run asks Genie each selected benchmark question +// in a Genie space, compares every response with the benchmark SQL, and records +// one evaluation result per question. Runs execute asynchronously; poll the run +// until its status is terminal, then list its results. All evaluation run +// methods require CAN EDIT permission on the space. The public benchmark API +// currently evaluates chat-mode responses.. type GenieEvalRunResponse struct { // The unique identifier for the evaluation run. EvalRunId *string - // Current status of the evaluation run. + // Current status of the run, derived from the statuses of its results. Unless a + // result has timed out or the run has been cancelled, the run is RUNNING while + // any question has not finished. It is DONE once every question has finished, + // whether it was scored or failed. EVALUATION_CANCELLED means the run was + // cancelled before all questions finished, and EVALUATION_TIMEOUT means the + // background evaluation job stopped before they did. DONE, EVALUATION_CANCELLED + // and EVALUATION_TIMEOUT are terminal run statuses. NOT_STARTED and + // EVALUATION_FAILED appear only on individual results. EvalRunStatus EvaluationStatusType // User ID who initiated the evaluation run. RunByUser *int64 @@ -1076,11 +1106,14 @@ type GenieEvalRunResponse struct { CreatedTimestamp *int64 // Total number of questions in the evaluation run. NumQuestions *int64 - // Number of questions answered correctly. + // Number of questions whose result is assessed GOOD, including results assessed + // manually. NumCorrect *int64 - // Number of questions that need manual review. + // Number of finished questions whose result is assessed NEEDS_REVIEW and has + // not been reviewed manually yet. NumNeedsReview *int64 - // Number of questions that have been completed. + // Number of questions that have finished, either scored (DONE) or failed + // (EVALUATION_FAILED). Cancelled and timed-out questions are not counted. NumDone *int64 // Timestamp when the evaluation run was last updated (milliseconds since // epoch). @@ -1177,7 +1210,8 @@ type GenieGetEvalResultDetailsRequest struct { type GenieGetEvalRunRequest struct { // The ID associated with the Genie space where the evaluation run is located. - SpaceId *string + SpaceId *string + // The ID of the evaluation run, as returned when the run was created. EvalRunId *string } @@ -1599,6 +1633,8 @@ type Result struct { // return the link for the requested chunk; `executeStatement` and // `getStatementResult` responses can contain links for multiple chunks.. type ResultData struct { + // Short-lived cloud-storage links to the result data, used with the + // `EXTERNAL_LINKS` disposition. ExternalLinks []ExternalLink // 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`. @@ -1614,7 +1650,7 @@ type ResultData struct { ByteCount *int64 // 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 - // :method:statementexecution/getstatementresultchunkn request. + // :method:statementexecution/getStatementResultChunkN request. NextChunkIndex *int // 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 @@ -1625,7 +1661,9 @@ type ResultData struct { // The result manifest provides schema and metadata for the result set.. type ResultManifest struct { + // The format of the result data, as requested with `format`. Format Format + // The schema of the result set: the ordered list of column descriptions. Schema *Schema // The total number of chunks that the result set has been divided into. TotalChunkCount *int @@ -1641,8 +1679,10 @@ type ResultManifest struct { } type Schema struct { + // The number of columns in the result set. ColumnCount *int - Columns []ColumnInfo + // The column descriptions, in result set order. + Columns []ColumnInfo } // Statement Execution works with all SQL warehouse types, including @@ -1653,9 +1693,18 @@ type StatementResponse struct { // The statement ID is returned upon successfully submitting a SQL statement, // and is a required reference for all subsequent calls. StatementId *string - Status *StatementStatus - Manifest *ResultManifest - Result *ResultData + // The execution state of the statement and, if it failed, the error details. + Status *StatementStatus + // The schema and metadata of the result set. Present when `status.state` is + // `SUCCEEDED`. + Manifest *ResultManifest + // 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. Calls to `getResultData` + // return the link for the requested chunk; `executeStatement` and + // `getStatementResult` responses can contain links for multiple chunks. + Result *ResultData } // The status response includes execution state and if relevant, error @@ -1669,6 +1718,8 @@ type StatementStatus struct { // execution successful, and statement closed; result no longer available for // fetch State StatementStatus_State + // The error that caused the statement to fail. Only populated when `state` is + // `FAILED`. Error *DatabricksServiceExceptionProto // SQLSTATE error code returned when the statement execution fails. Only // populated when the statement status is `FAILED`. diff --git a/genieagents/CHANGELOG.md b/genieagents/CHANGELOG.md index 82349e77..89d28db6 100644 --- a/genieagents/CHANGELOG.md +++ b/genieagents/CHANGELOG.md @@ -1,5 +1,7 @@ # Version changelog +## Release v0.5.0 (2026-11-19) + ## Release v0.4.0 (2026-11-12) ### New Features and Improvements diff --git a/genieagents/internal/version.go b/genieagents/internal/version.go index d46a3ef2..27f6f731 100644 --- a/genieagents/internal/version.go +++ b/genieagents/internal/version.go @@ -2,4 +2,4 @@ package internal const ModuleName = "sdk-go-genieagents" -const Version = "0.4.0" +const Version = "0.5.0" diff --git a/genieagents/v1/model.go b/genieagents/v1/model.go index 40083db8..98093cb3 100644 --- a/genieagents/v1/model.go +++ b/genieagents/v1/model.go @@ -166,9 +166,9 @@ type GenieAgentConfig struct { // The data a Genie Agent can access.. type GenieAgentDataSources struct { - // Unity Catalog tables, views, and metric views, in the order they were added. + // Unity Catalog tables, views, and metric views, sorted by `identifier`. Tables []GenieAgentTable `fieldmask:"tables"` - // Unity Catalog volumes, in the order they were added. + // Unity Catalog volumes, sorted by `path`. Volumes []GenieAgentVolume `fieldmask:"volumes"` // Unity Catalog MCP connections, sorted by `mcp_connection`. McpConnections []GenieAgentMcpConnection `fieldmask:"mcp_connections"` diff --git a/jobs/CHANGELOG.md b/jobs/CHANGELOG.md index 897485fe..e9254890 100644 --- a/jobs/CHANGELOG.md +++ b/jobs/CHANGELOG.md @@ -1,5 +1,7 @@ # Version changelog +## Release v0.17.0 (2026-11-19) + ## Release v0.16.0 (2026-11-18) ## Release v0.15.0 (2026-11-17) diff --git a/jobs/internal/version.go b/jobs/internal/version.go index 91e0435c..bc1ce3c2 100644 --- a/jobs/internal/version.go +++ b/jobs/internal/version.go @@ -2,4 +2,4 @@ package internal const ModuleName = "sdk-go-jobs" -const Version = "0.16.0" +const Version = "0.17.0" diff --git a/jobs/v2/model.go b/jobs/v2/model.go index 29e09876..45f4d0ec 100644 --- a/jobs/v2/model.go +++ b/jobs/v2/model.go @@ -496,10 +496,10 @@ type AiRuntimeTask_PriorityClass string const ( AiRuntimeTask_PriorityClass_Unspecified AiRuntimeTask_PriorityClass = "" - // Lowest priority; preemptable by higher-priority workloads. - AiRuntimeTask_PriorityClass_BestEffort AiRuntimeTask_PriorityClass = "BEST_EFFORT" // Medium priority; not preemptable. AiRuntimeTask_PriorityClass_Normal AiRuntimeTask_PriorityClass = "NORMAL" + // Highest priority; not preemptable. + AiRuntimeTask_PriorityClass_High AiRuntimeTask_PriorityClass = "HIGH" ) // Same alert evaluation state as in redash-v2/api/proto/alertsv2/alerts.proto @@ -2217,7 +2217,9 @@ type CreateJobRequest struct { // performance level without additional cost-saving optimizations. DurationTarget *string // Path of the job parent folder in workspace file tree. If absent, the job - // doesn't have a workspace object. + // doesn't have a parent folder. + // + // Example: /Workspace/Projects/my_project ParentPath *string // List of triggers attached to this job. A run starts when any active trigger // evaluates to true. Cannot be set in the same request as the legacy @@ -3651,7 +3653,9 @@ type JobSettings struct { // performance level without additional cost-saving optimizations. DurationTarget *string // Path of the job parent folder in workspace file tree. If absent, the job - // doesn't have a workspace object. + // doesn't have a parent folder. + // + // Example: /Workspace/Projects/my_project ParentPath *string // List of triggers attached to this job. A run starts when any active trigger // evaluates to true. Cannot be set in the same request as the legacy diff --git a/lakewatch/CHANGELOG.md b/lakewatch/CHANGELOG.md index 39f0daad..6e8aad4a 100644 --- a/lakewatch/CHANGELOG.md +++ b/lakewatch/CHANGELOG.md @@ -1,5 +1,7 @@ # Version changelog +## Release v0.7.0 (2026-11-19) + ## Release v0.6.0 (2026-11-17) ## Release v0.5.0 (2026-11-12) diff --git a/lakewatch/internal/version.go b/lakewatch/internal/version.go index 406df22f..170a9ab1 100644 --- a/lakewatch/internal/version.go +++ b/lakewatch/internal/version.go @@ -2,4 +2,4 @@ package internal const ModuleName = "sdk-go-lakewatch" -const Version = "0.6.0" +const Version = "0.7.0" diff --git a/lakewatch/v1/model.go b/lakewatch/v1/model.go index 686f82ed..e0027a71 100644 --- a/lakewatch/v1/model.go +++ b/lakewatch/v1/model.go @@ -455,7 +455,9 @@ type Datasource struct { // Schedule on which the datasource's ingestion job runs. A datasource cannot be // paused, so a request that sets `schedule.enabled` to `false` is rejected. // Continuous schedules are not supported for Unity Catalog connection - // datasources. + // datasources. For an existing-table datasource, runs must be no further apart + // than the shorter of the source table's `delta.deletedFileRetentionDuration` + // and `delta.logRetentionDuration`. Schedule *Schedule `fieldmask:"schedule"` // Compute mode for the datasource's ingestion job. If unset, the // `default_compute_mode` of the catalog's datasource configuration applies, or @@ -1442,8 +1444,9 @@ type RuleTimeRange struct { // Defines when a recurring job executes. // // Exactly one of the timing modes (`at_least_every`, `cron_expression`, -// `continuous`) must be set; combining them or setting none is rejected by the -// server. `compute_group` and `enabled` are orthogonal to the timing.. +// `continuous`, `file_arrival`) must be set; combining them or setting none is +// rejected by the server. `compute_group` and `enabled` are orthogonal to the +// timing.. type Schedule struct { Timing isSchedule_Timing // `dedicated`, `inherited`, `automatic`, or a custom group name. Reads return diff --git a/marketplaces/CHANGELOG.md b/marketplaces/CHANGELOG.md index 343b52e7..7615a4a7 100644 --- a/marketplaces/CHANGELOG.md +++ b/marketplaces/CHANGELOG.md @@ -1,5 +1,7 @@ # Version changelog +## Release v0.7.0 (2026-11-19) + ## Release v0.6.0 (2026-11-12) ### New Features and Improvements diff --git a/marketplaces/internal/version.go b/marketplaces/internal/version.go index 6ce38f19..971b361d 100644 --- a/marketplaces/internal/version.go +++ b/marketplaces/internal/version.go @@ -2,4 +2,4 @@ package internal const ModuleName = "sdk-go-marketplaces" -const Version = "0.6.0" +const Version = "0.7.0" diff --git a/marketplaces/v1/client.go b/marketplaces/v1/client.go index 7b897a17..91fc01b9 100644 --- a/marketplaces/v1/client.go +++ b/marketplaces/v1/client.go @@ -1809,8 +1809,10 @@ func (c *internalClient) CreateExchangeFilter(ctx context.Context, req CreateExc return resp, nil } -// Create a file. Currently, only provider icons and attached notebooks are -// supported. +// Creates a file and returns a short-lived URL for uploading its content with +// an HTTP PUT request. Only provider icons (PROVIDER_ICON files on a PROVIDER +// parent) and sample notebooks (EMBEDDED_NOTEBOOK files on a LISTING parent) +// are supported. func (c *internalClient) CreateFile(ctx context.Context, req CreateFileRequest, opts ...call.Option) (*CreateFileResponse, error) { wireReq, err := createFileRequestToWire(&req) if err != nil { @@ -1876,7 +1878,10 @@ func (c *internalClient) CreateFile(ctx context.Context, req CreateFileRequest, return resp, nil } -// Create a new listing +// Creates a listing under one of the caller's provider profiles. The listing +// name, provider ID and visibility are required, and the caller must have +// access to any share that the listing references. Returns the ID of the new +// listing. func (c *internalClient) CreateListing(ctx context.Context, req CreateListingRequest, opts ...call.Option) (*CreateListingResponse, error) { wireReq, err := createListingRequestToWire(&req) if err != nil { @@ -1942,7 +1947,8 @@ func (c *internalClient) CreateListing(ctx context.Context, req CreateListingReq return resp, nil } -// Create a provider +// Creates a provider profile in the caller's account. Returns the ID of the new +// profile. func (c *internalClient) CreateProvider(ctx context.Context, req CreateProviderRequest, opts ...call.Option) (*CreateProviderResponse, error) { wireReq, err := createProviderRequestToWire(&req) if err != nil { @@ -2008,8 +2014,10 @@ func (c *internalClient) CreateProvider(ctx context.Context, req CreateProviderR return resp, nil } -// Create provider analytics dashboard. Returns Marketplace specific `id`. Not -// to be confused with the Lakeview dashboard id. +// Creates the Provider Analytics Dashboard in the caller's workspace from the +// latest template. Fails if the dashboard already exists. Returns the +// Marketplace-specific `id` of the dashboard record, which is distinct from the +// AI/BI dashboard ID. func (c *internalClient) CreateProviderAnalyticsDashboard(ctx context.Context, req CreateProviderAnalyticsDashboardRequest, opts ...call.Option) (*CreateProviderAnalyticsDashboardResponse, error) { wireReq, err := createProviderAnalyticsDashboardRequestToWire(&req) if err != nil { @@ -2187,7 +2195,7 @@ func (c *internalClient) DeleteExchangeFilter(ctx context.Context, req DeleteExc return resp, nil } -// Delete a file +// Deletes a file. Fails if the file is still in use. func (c *internalClient) DeleteFile(ctx context.Context, req DeleteFileRequest, opts ...call.Option) (*DeleteFileResponse, error) { headers := http.Header{} @@ -2243,7 +2251,9 @@ func (c *internalClient) DeleteFile(ctx context.Context, req DeleteFileRequest, return resp, nil } -// Delete a listing +// Deletes a listing permanently. The underlying share is not deleted, and +// consumers who already have access to the share keep that access until it is +// revoked in Delta Sharing. func (c *internalClient) DeleteListing(ctx context.Context, req DeleteListingRequest, opts ...call.Option) (*DeleteListingResponse, error) { headers := http.Header{} @@ -2299,7 +2309,7 @@ func (c *internalClient) DeleteListing(ctx context.Context, req DeleteListingReq return resp, nil } -// Delete provider +// Deletes a provider profile and all of the listings that it owns. func (c *internalClient) DeleteProvider(ctx context.Context, req DeleteProviderRequest, opts ...call.Option) (*DeleteProviderResponse, error) { headers := http.Header{} @@ -2417,7 +2427,7 @@ func (c *internalClient) GetExchange(ctx context.Context, req GetExchangeRequest return resp, nil } -// Get a file +// Gets a file's metadata, including a short-lived download URL. func (c *internalClient) GetFile(ctx context.Context, req GetFileRequest, opts ...call.Option) (*GetFileResponse, error) { headers := http.Header{} @@ -2479,7 +2489,8 @@ func (c *internalClient) GetFile(ctx context.Context, req GetFileRequest, opts . return resp, nil } -// Get latest version of provider analytics dashboard. +// Gets the latest available version of the Provider Analytics Dashboard +// template. func (c *internalClient) GetLatestVersionProviderAnalyticsDashboard(ctx context.Context, req GetLatestVersionProviderAnalyticsDashboardRequest, opts ...call.Option) (*GetLatestVersionProviderAnalyticsDashboardResponse, error) { headers := http.Header{} @@ -2535,7 +2546,7 @@ func (c *internalClient) GetLatestVersionProviderAnalyticsDashboard(ctx context. return resp, nil } -// Get a listing +// Gets a listing owned by one of the caller's provider profiles. func (c *internalClient) GetListing(ctx context.Context, req GetListingRequest, opts ...call.Option) (*GetListingResponse, error) { headers := http.Header{} @@ -2705,7 +2716,7 @@ func (c *internalClient) GetPersonalizationRequestsForProviderIter(ctx context.C } } -// Get provider profile +// Gets a provider profile by ID. func (c *internalClient) GetProvider(ctx context.Context, req GetProviderRequest, opts ...call.Option) (*GetProviderResponse, error) { headers := http.Header{} @@ -3094,7 +3105,7 @@ func (c *internalClient) ListExchangesForListingIter(ctx context.Context, req Li } } -// List files attached to a parent entity. +// Lists the files attached to a provider profile or a listing. func (c *internalClient) ListFiles(ctx context.Context, req ListFilesRequest, opts ...call.Option) (*ListFilesResponse, error) { wireReq, err := listFilesRequestToWire(&req) if err != nil { @@ -3204,7 +3215,7 @@ func (c *internalClient) ListFilesIter(ctx context.Context, req ListFilesRequest } } -// List listings owned by this provider +// Lists the listings owned by the provider profiles in the caller's account. func (c *internalClient) ListListings(ctx context.Context, req ListListingsRequest, opts ...call.Option) (*GetListingsResponse, error) { wireReq, err := listListingsRequestToWire(&req) if err != nil { @@ -3421,7 +3432,8 @@ func (c *internalClient) ListListingsForExchangeIter(ctx context.Context, req Li } } -// Get provider analytics dashboard. +// Gets the Provider Analytics Dashboard that was created for the caller's +// account. Returns an empty response if the dashboard has not been created yet. func (c *internalClient) ListProviderAnalyticsDashboard(ctx context.Context, req ListProviderAnalyticsDashboardRequest, opts ...call.Option) (*ListProviderAnalyticsDashboardResponse, error) { headers := http.Header{} @@ -3477,7 +3489,7 @@ func (c *internalClient) ListProviderAnalyticsDashboard(ctx context.Context, req return resp, nil } -// List provider profiles for account. +// Lists the provider profiles in the caller's account. func (c *internalClient) ListProviders(ctx context.Context, req ListProvidersRequest, opts ...call.Option) (*ListProvidersResponse, error) { wireReq, err := listProvidersRequestToWire(&req) if err != nil { @@ -3784,7 +3796,9 @@ func (c *internalClient) UpdateExchangeFilter(ctx context.Context, req UpdateExc return resp, nil } -// Update a listing +// Updates a listing. Send the full listing definition; the listing type cannot +// be changed after the listing is created, and changing the share re-links the +// listing to the new share. func (c *internalClient) UpdateListing(ctx context.Context, req UpdateListingRequest, opts ...call.Option) (*UpdateListingResponse, error) { wireReq, err := updateListingRequestToWire(&req) if err != nil { @@ -3856,8 +3870,10 @@ func (c *internalClient) UpdateListing(ctx context.Context, req UpdateListingReq return resp, nil } -// Update personalization request. This method only permits updating the status -// of the request. +// Updates the status of a personalization request; other properties of the +// request cannot be changed. Fulfilling a request grants the consumer access to +// the share, and denying a fulfilled request revokes that access. The listing +// must be published. func (c *internalClient) UpdatePersonalizationRequestStatus(ctx context.Context, req UpdatePersonalizationRequestStatusRequest, opts ...call.Option) (*UpdatePersonalizationRequestStatusResponse, error) { wireReq, err := updatePersonalizationRequestStatusRequestToWire(&req) if err != nil { @@ -3935,7 +3951,7 @@ func (c *internalClient) UpdatePersonalizationRequestStatus(ctx context.Context, return resp, nil } -// Update provider profile +// Updates a provider profile. Send the full profile definition. func (c *internalClient) UpdateProvider(ctx context.Context, req UpdateProviderRequest, opts ...call.Option) (*UpdateProviderResponse, error) { wireReq, err := updateProviderRequestToWire(&req) if err != nil { @@ -4007,7 +4023,9 @@ func (c *internalClient) UpdateProvider(ctx context.Context, req UpdateProviderR return resp, nil } -// Update provider analytics dashboard. +// Updates the Provider Analytics Dashboard to a newer version of the template. +// The requested version must be newer than the version that the dashboard +// currently uses. func (c *internalClient) UpdateProviderAnalyticsDashboard(ctx context.Context, req UpdateProviderAnalyticsDashboardRequest, opts ...call.Option) (*UpdateProviderAnalyticsDashboardResponse, error) { wireReq, err := updateProviderAnalyticsDashboardRequestToWire(&req) if err != nil { diff --git a/marketplaces/v1/model.go b/marketplaces/v1/model.go index 54361ad5..846bfcc0 100644 --- a/marketplaces/v1/model.go +++ b/marketplaces/v1/model.go @@ -222,10 +222,14 @@ type ConsumerTerms struct { // contact info for the consumer requesting data or performing a listing // installation. type ContactInfo struct { + // First name of the consumer contact. FirstName *string - LastName *string - Email *string - Company *string + // Last name of the consumer contact. + LastName *string + // Email address of the consumer contact. + Email *string + // Company of the consumer contact. + Company *string } type CreateExchangeFilterRequest struct { @@ -245,16 +249,24 @@ type CreateExchangeResponse struct { } type CreateFileRequest struct { - FileParent *FileParent + // Provider profile or listing to attach the file to. + FileParent *FileParent + // Purpose of the file. PROVIDER_ICON requires a PROVIDER parent; + // EMBEDDED_NOTEBOOK requires a LISTING parent. MarketplaceFileType MarketplaceFileType - MimeType *string - DisplayName *string + // MIME type of the file content: text/html for notebooks; image/png, image/jpeg + // or image/svg+xml for icons. + MimeType *string + // Name shown to consumers for the file, for example a notebook title. At most + // 255 characters. + DisplayName *string } type CreateFileResponse struct { - // Pre-signed POST URL to blob storage + // Short-lived URL for uploading the file content with an HTTP PUT request. UploadUrl *string - FileInfo *FileInfo + // Metadata of the created file. + FileInfo *FileInfo } type CreateInstallationRequest struct { @@ -272,10 +284,12 @@ type CreateInstallationResponse struct { } type CreateListingRequest struct { + // Listing to create. Listing *Listing } type CreateListingResponse struct { + // ID of the created listing. ListingId *string } @@ -300,20 +314,26 @@ type CreateProviderAnalyticsDashboardRequest struct { } type CreateProviderAnalyticsDashboardResponse struct { + // Marketplace-specific ID of the dashboard record, distinct from the AI/BI + // dashboard ID. Id *string } type CreateProviderRequest struct { + // Provider profile to create. Provider *ProviderInfo } type CreateProviderResponse struct { + // ID of the created provider profile. Id *string } type DataRefreshInfo struct { + // Number of time units. Must be greater than zero. Interval *int64 - Unit DataRefresh + // Time unit that the interval is expressed in. + Unit DataRefresh } type DeleteExchangeFilterRequest struct { @@ -331,6 +351,7 @@ type DeleteExchangeResponse struct { } type DeleteFileRequest struct { + // ID of the file to delete. FileId *string } @@ -346,6 +367,7 @@ type DeleteInstallationResponse struct { } type DeleteListingRequest struct { + // ID of the listing to delete. Id *string } @@ -353,6 +375,7 @@ type DeleteListingResponse struct { } type DeleteProviderRequest struct { + // ID of the provider profile to delete. Id *string } @@ -394,23 +417,37 @@ type ExchangeListing struct { } type FileInfo struct { - Id *string + // ID of the file. + Id *string + // Purpose of the file, such as a provider icon or a notebook attached to a + // listing. MarketplaceFileType MarketplaceFileType - FileParent *FileParent - MimeType *string - DownloadLink *string - CreatedAt *int64 - UpdatedAt *int64 + // Provider or listing that the file belongs to. + FileParent *FileParent + // MIME type of the file content, for example text/html for notebooks or + // image/png for icons. + MimeType *string + // Short-lived URL for downloading the file content. + DownloadLink *string + // Time the file was created, in epoch milliseconds. + CreatedAt *int64 + // Time the file was last updated, in epoch milliseconds. + UpdatedAt *int64 // Name displayed to users for applicable files, e.g. embedded notebooks DisplayName *string - Status FileStatus + // Processing status of the file. New files start in FILE_STATUS_STAGING and + // become FILE_STATUS_PUBLISHED after Databricks has sanitized them. + Status FileStatus // Populated if status is in a failed state with more information on reason for // the failure. StatusMessage *string } type FileParent struct { - ParentId *string + // ID of the provider or listing that the file belongs to. + ParentId *string + // Type of the parent: PROVIDER for provider icons, LISTING for notebooks + // attached to a listing. FileParentType FileParentType } @@ -428,10 +465,12 @@ type GetExchangeResponse struct { } type GetFileRequest struct { + // ID of the file. FileId *string } type GetFileResponse struct { + // Metadata of the file. FileInfo *FileInfo } @@ -447,7 +486,7 @@ type GetLatestVersionProviderAnalyticsDashboardRequest struct { } type GetLatestVersionProviderAnalyticsDashboardResponse struct { - // version here is latest logical version of the dashboard template + // Latest available version of the dashboard template. Version *int64 } @@ -463,15 +502,19 @@ type GetListingContentMetadataResponse struct { } type GetListingRequest struct { + // ID of the listing. Id *string } type GetListingResponse struct { + // The requested listing. Listing *Listing } type GetListingsResponse struct { - Listings []Listing + // Listings on this page. + Listings []Listing + // Token for the next page. Not set when there are no more results. NextPageToken *string } @@ -484,20 +527,27 @@ type GetPersonalizationRequestsForConsumerResponse struct { } type GetPersonalizationRequestsForProviderRequest struct { + // Token from the next_page_token field of a previous response. Omit to get the + // first page. PageToken *string - PageSize *int + // Maximum number of results to return per page. + PageSize *int } type GetPersonalizationRequestsForProviderResponse struct { + // Personalization requests on this page. PersonalizationRequests []PersonalizationRequest - NextPageToken *string + // Token for the next page. Not set when there are no more results. + NextPageToken *string } type GetProviderRequest struct { + // ID of the provider profile. Id *string } type GetProviderResponse struct { + // The requested provider profile. Provider *ProviderInfo } @@ -576,13 +626,19 @@ type ListExchangesResponse struct { } type ListFilesRequest struct { + // Provider profile or listing whose files to list. FileParent *FileParent - PageToken *string - PageSize *int + // Token from the next_page_token field of a previous response. Omit to get the + // first page. + PageToken *string + // Maximum number of results to return per page. + PageSize *int } type ListFilesResponse struct { - FileInfos []FileInfo + // Files on this page. + FileInfos []FileInfo + // Token for the next page. Not set when there are no more results. NextPageToken *string } @@ -619,8 +675,11 @@ type ListListingsForExchangeResponse struct { } type ListListingsRequest struct { + // Token from the next_page_token field of a previous response. Omit to get the + // first page. PageToken *string - PageSize *int + // Maximum number of results to return per page. + PageSize *int } type ListPersonalizationRequestsForConsumerRequest struct { @@ -632,19 +691,28 @@ type ListProviderAnalyticsDashboardRequest struct { } type ListProviderAnalyticsDashboardResponse struct { - Id *string + // Marketplace-specific ID of the dashboard record. Use it as the `id` when + // updating the dashboard. + Id *string + // Version of the dashboard template that the dashboard was created or last + // updated from. Version *int64 - // dashboard_id will be used to open Lakeview dashboard. + // ID of the AI/BI dashboard in the workspace. Use it to open the dashboard. DashboardId *string } type ListProvidersRequest struct { + // Token from the next_page_token field of a previous response. Omit to get the + // first page. PageToken *string - PageSize *int + // Maximum number of results to return per page. + PageSize *int } type ListProvidersResponse struct { - Providers []ProviderInfo + // Provider profiles on this page. + Providers []ProviderInfo + // Token for the next page. Not set when there are no more results. NextPageToken *string } @@ -679,19 +747,38 @@ type ListPublishedProvidersForConsumerResponse struct { NextPageToken *string } +// A Marketplace listing: a data product that a provider offers to consumers. +// The summary holds the listing's identity, status and sharing configuration, +// and the detail holds the descriptive content that consumers see on the +// listing page.. type Listing struct { - Id *string + // ID of the listing. Assigned by the server; not allowed in create requests. + Id *string + // Identity, status and sharing configuration of the listing. Summary *ListingSummary - Detail *ListingDetail + // Descriptive content shown to consumers on the listing page, such as the + // description, links and data attributes. + Detail *ListingDetail } type ListingDetail struct { - Description *string - TermsOfService *string - DocumentationLink *string - SupportLink *string - FileIds []string - PrivacyPolicyLink *string + // Detailed description of the data product. Supports basic Markdown formatting + // such as bold, italics and lists. + Description *string + // URL of the terms of service for the listing. Defaults to the provider + // profile's terms of service link when empty. + TermsOfService *string + // URL of documentation that helps consumers use the data product. + DocumentationLink *string + // URL where consumers can get support for the listing. + SupportLink *string + FileIds []string + // URL of the privacy policy for the listing. Defaults to the provider profile's + // privacy policy link when empty. + PrivacyPolicyLink *string + // Sample notebooks attached to the listing. Create each notebook with + // createFile, using the EMBEDDED_NOTEBOOK file type and the listing as the + // parent, and reference it here. EmbeddedNotebookFileInfos []FileInfo // Which geo region the listing data is collected from GeographicalCoverage *string @@ -712,19 +799,13 @@ type ListingDetail struct { DataSource *string // size of the dataset in GB Size *float64 - // Type of assets included in the listing. eg. GIT_REPO, DATA_TABLE, MODEL, - // NOTEBOOK + // Types of assets included in the listing. At least one is required unless the + // listing is a DRAFT. Duplicate values are ignored. Assets []AssetType - // ID 20, 21 removed don't use License of the data asset - Required for listings - // with model based assets + // License of the data asset. Required for listings with model-based assets. License *string - // Listing tags - Simple key value pair to annotate listings. When should I use - // tags vs dedicated fields? Using tags avoids the need to add new columns in - // the database for new annotations. However, this should be used sparingly - // since tags are stored as key value pair. Use tags only: 1. If the field is - // optional and won't need to have NOT NULL integrity check 2. The value is - // fairly fixed, static and low cardinality (eg. enums). 3. The value won't be - // used in filters or joins with other tables. + // Tags that annotate the listing with fixed, low-cardinality values, such as + // supported languages or tasks. Tags []ListingTag } @@ -737,30 +818,62 @@ type ListingFulfillment struct { } type ListingSetting struct { + // PUBLIC listings are visible to all consumers in the Marketplace. PRIVATE + // listings are visible only to members of the private exchanges that they are + // shared in. Visibility Visibility } type ListingSummary struct { - Name *string - Subtitle *string - Status ListingStatus - Share *ShareInfo + // Display name of the listing. Must start with a letter or digit and be at most + // 100 characters. + Name *string + // One-line subtitle shown with the listing name. + Subtitle *string + // Publication status of the listing. Only PUBLISHED listings are visible to + // consumers; create a listing as DRAFT and set the status to PUBLISHED when it + // is ready. + Status ListingStatus + // Delta Sharing share that holds the listing's data assets. Required to publish + // a STANDARD listing, except for app and MCP server listings; notebook and Git + // repo listings can use git_repo instead. The caller must have access to the + // share. + Share *ShareInfo + // Cloud and region of the provider's Unity Catalog metastore. Not allowed in + // create requests. ProviderRegion *RegionInfo - Setting *ListingSetting - CreatedAt *int64 - CreatedBy *string - UpdatedAt *int64 - UpdatedBy *string - PublishedAt *int64 - PublishedBy *string - Categories []Category - ListingType ListingType - CreatedById *int64 - UpdatedById *int64 - ProviderId *string - ExchangeIds []string - // if a git repo is being created, a listing will be initialized with this field - // as opposed to a share + // Listing settings, such as whether the listing is visible in the public + // Marketplace or only in private exchanges. + Setting *ListingSetting + // Time the listing was created, in epoch milliseconds. + CreatedAt *int64 + // Name of the user who created the listing. + CreatedBy *string + // Time the listing was last updated, in epoch milliseconds. + UpdatedAt *int64 + // Name of the user who last updated the listing. + UpdatedBy *string + PublishedAt *int64 + PublishedBy *string + // Categories that consumers can use to filter listings. They also appear as + // tags on the listing tile and detail page. + Categories []Category + // How consumers get access to the listing. STANDARD listings are instantly + // available; PERSONALIZED listings require the provider to approve each + // consumer request. Cannot be changed after the listing is created. + ListingType ListingType + // ID of the user who created the listing. + CreatedById *int64 + // ID of the user who last updated the listing. + UpdatedById *int64 + // ID of the provider profile that owns the listing. + ProviderId *string + // IDs of the private exchanges that the listing is shared in. A listing can be + // linked to at most 10 exchanges. + ExchangeIds []string + // Git repository that holds the listing's assets, used instead of a share for + // notebook and Git repo listings. A listing cannot have both a share and a Git + // repo. GitRepo *RepoInfo } @@ -773,47 +886,90 @@ type ListingTag struct { } type PersonalizationRequest struct { - Id *string + // ID of the personalization request. + Id *string + // Cloud and region of the consumer's Unity Catalog metastore. ConsumerRegion *RegionInfo - ContactInfo *ContactInfo - Comment *string - IntendedUse *string - Status PersonalizationRequestStatus - StatusMessage *string + // Contact details that the consumer entered with the request. + ContactInfo *ContactInfo + // Comment that the consumer entered with the request. + Comment *string + // How the consumer intends to use the data product, as entered with the + // request. + IntendedUse *string + // Current status of the request. + Status PersonalizationRequestStatus + // Reason that the provider gave in the most recent status update. + StatusMessage *string // Share information is required for data listings but should be empty/ignored // for non-data listings (MCP and App). - Share *ShareInfo - CreatedAt *int64 - ListingId *string - UpdatedAt *int64 - MetastoreId *string + Share *ShareInfo + // Time the request was created, in epoch milliseconds. + CreatedAt *int64 + // ID of the listing that the request was made for. + ListingId *string + // Time the request was last updated, in epoch milliseconds. + UpdatedAt *int64 + // ID of the consumer's Unity Catalog metastore. + MetastoreId *string + // Name of the listing that the request was made for. ListingName *string IsFromLighthouse *bool - ProviderId *string - RecipientType DeltaSharingRecipientType + // ID of the provider profile that owns the listing. + ProviderId *string + // How the consumer receives the shared data: + // DELTA_SHARING_RECIPIENT_TYPE_DATABRICKS for a consumer on a Databricks + // workspace, DELTA_SHARING_RECIPIENT_TYPE_OPEN for a consumer on another + // platform who uses a credential file. + RecipientType DeltaSharingRecipientType } type ProviderInfo struct { - Id *string - Name *string - Description *string - IconFilePath *string + // ID of the provider profile. Assigned by the server; not allowed in create or + // update requests. + Id *string + // Display name of the provider. Consumers can filter listings by provider name. + Name *string + // Description of the provider organization, shown on the provider profile and + // on all of its listings. + Description *string + // URL for downloading the provider icon. Populated by the server from + // icon_file_id. + IconFilePath *string + // Email address that Databricks uses to contact the provider. Not shown to + // consumers. BusinessContactEmail *string - SupportContactEmail *string - // is_featured is accessible by consumers only + // Email address that consumers can use to request support. Shown on all of the + // provider's listings. + SupportContactEmail *string + // Whether Databricks features the provider in the Marketplace. Set by + // Databricks; not allowed in create or update requests. IsFeatured *bool // published_by is only applicable to data aggregators (e.g. Crux) - PublishedBy *string - CompanyWebsiteLink *string - IconFileId *string - TermOfServiceLink *string - PrivacyPolicyLink *string - DarkModeIconFileId *string + PublishedBy *string + // URL of the provider's website. Shown on all of the provider's listings. + CompanyWebsiteLink *string + // ID of the provider icon file, created with createFile using the PROVIDER_ICON + // file type. + IconFileId *string + // URL of the provider's terms of service. Shown on all of the provider's + // listings unless a listing sets its own terms of service. + TermOfServiceLink *string + // URL of the provider's privacy policy. Shown on all of the provider's listings + // unless a listing sets its own privacy policy. + PrivacyPolicyLink *string + // ID of the provider icon file used in dark mode, created with createFile using + // the PROVIDER_ICON file type. + DarkModeIconFileId *string + // URL for downloading the dark mode provider icon. Populated by the server from + // dark_mode_icon_file_id. DarkModeIconFilePath *string } type RegionInfo struct { - Cloud *string + // Cloud provider: aws, azure or gcp. + Cloud *string + // Cloud region, for example us-west-2. Region *string } @@ -859,6 +1015,7 @@ type SearchPublishedListingsForConsumerResponse struct { } type ShareInfo struct { + // Name of the Delta Sharing share in the provider's Unity Catalog metastore. Name *string Type ListingShareType } @@ -928,48 +1085,68 @@ type UpdateInstallationResponse struct { } type UpdateListingRequest struct { - Id *string + // ID of the listing to update. + Id *string + // Full definition of the listing, including the fields that are not changing. Listing *Listing } type UpdateListingResponse struct { + // The updated listing. Listing *Listing } type UpdatePersonalizationRequestStatusRequest struct { + // ID of the listing that the request was made for. ListingId *string + // ID of the personalization request. RequestId *string - Status PersonalizationRequestStatus - Reason *string - Share *ShareInfo + // New status of the request. Allowed transitions: NEW or REQUEST_PENDING to + // REQUEST_PENDING, FULFILLED or DENIED; FULFILLED to DENIED; DENIED to + // REQUEST_PENDING. + Status PersonalizationRequestStatus + // Message for the consumer that explains the status change, at most 255 + // characters. + Reason *string + // Share to grant the consumer access to. Required when fulfilling a request for + // a listing with data assets and not allowed with other statuses. Ignored for + // app and MCP server listings. + Share *ShareInfo } type UpdatePersonalizationRequestStatusResponse struct { + // The updated personalization request. Request *PersonalizationRequest } type UpdateProviderAnalyticsDashboardRequest struct { - // id is immutable property and can't be updated. + // Marketplace-specific ID of the dashboard record, as returned when the + // dashboard was created or retrieved. Id *string - // this is the version of the dashboard template we want to update our user to - // current expectation is that it should be equal to latest version of the - // dashboard template + // Version of the dashboard template to update to. Must be newer than the + // version that the dashboard currently uses; use the version returned by + // getLatestVersionProviderAnalyticsDashboard. Version *int64 } type UpdateProviderAnalyticsDashboardResponse struct { - // id & version should be the same as the request - Id *string + // Marketplace-specific ID of the dashboard record, the same as in the request. + Id *string + // Version of the dashboard template that the dashboard now uses. Version *int64 - // this is newly created Lakeview dashboard for the user + // ID of the AI/BI dashboard that now contains the updated template. DashboardId *string } type UpdateProviderRequest struct { - Id *string + // ID of the provider profile to update. + Id *string + // Full definition of the provider profile, including the fields that are not + // changing. Provider *ProviderInfo } type UpdateProviderResponse struct { + // The updated provider profile. Provider *ProviderInfo } diff --git a/oauth/CHANGELOG.md b/oauth/CHANGELOG.md index a11456c4..699388ec 100644 --- a/oauth/CHANGELOG.md +++ b/oauth/CHANGELOG.md @@ -1,5 +1,7 @@ # Version changelog +## Release v0.9.0 (2026-11-19) + ## Release v0.8.0 (2026-11-16) ## Release v0.7.0 (2026-11-12) diff --git a/oauth/internal/version.go b/oauth/internal/version.go index 46b632a0..47cd820a 100644 --- a/oauth/internal/version.go +++ b/oauth/internal/version.go @@ -2,4 +2,4 @@ package internal const ModuleName = "sdk-go-oauth" -const Version = "0.8.0" +const Version = "0.9.0" diff --git a/oauth/v1/client.go b/oauth/v1/client.go index a98ed4e9..986187ff 100644 --- a/oauth/v1/client.go +++ b/oauth/v1/client.go @@ -373,10 +373,11 @@ func (c *internalClient) DeleteCustomOAuthAppIntegration(ctx context.Context, re return resp, nil } -// Delete an existing Published OAuth App Integration. You can retrieve the -// published OAuth app integration via [PublishedAppIntegration/get]. +// Delete an existing Published OAuth App Integration. The app can no longer be +// used to sign in to the account until it is enabled again with +// [PublishedAppIntegration/create]. // -// [PublishedAppIntegration/get]: https://docs.databricks.com/api/account/publishedappintegration/get +// [PublishedAppIntegration/create]: https://docs.databricks.com/api/account/publishedappintegration/create // Account-level method. Uses the Client's accountID, overridable per call via req.AccountId. func (c *internalClient) DeletePublishedOAuthAppIntegration(ctx context.Context, req DeletePublishedOAuthAppIntegrationRequest, opts ...call.Option) (*DeletePublishedOAuthAppIntegrationResponse, error) { @@ -688,7 +689,8 @@ func (c *internalClient) ListCustomOAuthAppIntegrationsIter(ctx context.Context, } } -// Get the list of published OAuth app integrations for the specified +// Get the list of published OAuth app integrations for the specified +// account. // Account-level method. Uses the Client's accountID, overridable per call via req.AccountId. func (c *internalClient) ListPublishedOAuthAppIntegrations(ctx context.Context, req ListPublishedOAuthAppIntegrationsRequest, opts ...call.Option) (*ListPublishedOAuthAppIntegrationsResponse, error) { wireReq, err := listPublishedOAuthAppIntegrationsRequestToWire(&req) diff --git a/oauth/v1/model.go b/oauth/v1/model.go index 13e87ca5..89f5d768 100644 --- a/oauth/v1/model.go +++ b/oauth/v1/model.go @@ -49,15 +49,18 @@ type CreateCustomOAuthAppIntegrationRequest struct { type CreatePublishedOAuthAppIntegrationRequest struct { AccountId *string - // App id of the OAuth published app integration. For example power-bi, - // tableau-deskop + // ID of the published OAuth app to enable, as returned in app_id by the list of + // published OAuth apps. The short legacy IDs of the original published apps, + // such as power-bi and tableau-desktop, are also accepted. The request fails if + // the app is already enabled for the account. AppId *string - // Token access policy + // Lifetimes of the tokens issued to the app. If omitted, the app's default + // token lifetimes apply. If set, both TTL fields are required. TokenAccessPolicy *TokenAccessPolicy } type CreatePublishedOAuthAppIntegrationResponse struct { - // Unique integration id for the published OAuth app + // ID of the published OAuth app integration. IntegrationId *string } @@ -118,7 +121,8 @@ type DeleteCustomOAuthAppIntegrationResponse struct { } type DeletePublishedOAuthAppIntegrationRequest struct { - AccountId *string + AccountId *string + // ID of the published OAuth app integration to delete. IntegrationId *string } @@ -163,7 +167,8 @@ type GetCustomOAuthAppIntegrationRequest struct { } type GetPublishedOAuthAppIntegrationRequest struct { - AccountId *string + AccountId *string + // ID of the published OAuth app integration. IntegrationId *string } @@ -188,13 +193,18 @@ type ListCustomOAuthAppIntegrationsResponse struct { type ListPublishedOAuthAppIntegrationsRequest struct { AccountId *string + // Token from the next_page_token field of a previous response. Omit it to + // request the first page. PageToken *string - PageSize *int + // Maximum number of integrations to return in one page, at most 1000. + PageSize *int } type ListPublishedOAuthAppIntegrationsResponse struct { // List of Published OAuth App Integrations defined for the account. - Apps []PublishedOAuthAppIntegration + Apps []PublishedOAuthAppIntegration + // Token for the next page of results. If not present, there are no more results + // to show. NextPageToken *string } @@ -218,7 +228,8 @@ type ListPublishedOAuthAppsResponse struct { type PublishedOAuthApp struct { // Unique ID of the published OAuth app. AppId *string - // Client ID of the published OAuth app. It is the client_id in the OAuth flow + // Client ID of the published OAuth app. The app sends it as client_id in the + // OAuth flow. ClientId *string // The display name of the published OAuth app. Name *string @@ -233,17 +244,26 @@ type PublishedOAuthApp struct { Scopes []string } +// A published OAuth app integration enables an OAuth app published by +// , such as Power BI or Tableau Desktop, for the account. +// manages the app's client ID, redirect URLs and scopes; the +// integration only sets the lifetimes of the tokens issued to the app. To +// register your own application, use a custom OAuth app integration instead. +// See https://docs.databricks.com/aws/en/integrations/enable-disable-oauth.. type PublishedOAuthAppIntegration struct { - // App-id of the published app integration + // ID of the published OAuth app, as returned in app_id by the list of published + // OAuth apps. AppId *string - // Unique integration id for the published OAuth app + // ID of the published OAuth app integration in the account. IntegrationId *string - // Display name of the published OAuth app + // Display name of the published OAuth app. Name *string - // Token access policy + // Lifetimes of the access and refresh tokens issued to the app. TokenAccessPolicy *TokenAccessPolicy - CreatedBy *int64 - CreateTime *string + // ID of the user who created the integration. + CreatedBy *int64 + // Time the integration was created, as an ISO 8601 timestamp. + CreateTime *string } type TokenAccessPolicy struct { @@ -296,9 +316,12 @@ type UpdateCustomOAuthAppIntegrationResponse struct { } type UpdatePublishedOAuthAppIntegrationRequest struct { - AccountId *string + AccountId *string + // ID of the published OAuth app integration to update. IntegrationId *string - // Token access policy to be updated in the published OAuth app integration + // New token lifetimes for the app. Both TTL fields are required when the policy + // is set; the single-use refresh token settings keep their current values when + // omitted. If the policy is omitted, the integration is left unchanged. TokenAccessPolicy *TokenAccessPolicy } diff --git a/pipelines/CHANGELOG.md b/pipelines/CHANGELOG.md index dbf4e451..aba31db2 100644 --- a/pipelines/CHANGELOG.md +++ b/pipelines/CHANGELOG.md @@ -1,5 +1,7 @@ # Version changelog +## Release v0.15.0 (2026-11-19) + ## Release v0.14.0 (2026-11-17) ## Release v0.13.0 (2026-11-16) diff --git a/pipelines/internal/version.go b/pipelines/internal/version.go index c7377d35..9be64f2d 100644 --- a/pipelines/internal/version.go +++ b/pipelines/internal/version.go @@ -2,4 +2,4 @@ package internal const ModuleName = "sdk-go-pipelines" -const Version = "0.14.0" +const Version = "0.15.0" diff --git a/pipelines/v2/model.go b/pipelines/v2/model.go index 951cebf8..454da493 100644 --- a/pipelines/v2/model.go +++ b/pipelines/v2/model.go @@ -573,7 +573,9 @@ type ClonePipelineRequest struct { Environment *PipelinesEnvironment // Path of the pipeline parent folder in workspace file tree. // - // If absent, the pipeline doesn't have a workspace object. + // If absent, the pipeline doesn't have a parent folder. + // + // Example: /Workspace/Projects/my_project ParentPath *string // Usage policy of this pipeline. UsagePolicyId *string @@ -744,6 +746,10 @@ func (*ConnectorOptions_ConnectorOptions_OnedriveOptions) isConnectorOptions_Con type CreatePipelineRequest struct { // If false, deployment will fail if name conflicts with that of another // pipeline. + // + // Ignored when `parent_path` is set. A pipeline in a workspace folder must have + // a name that is unique within that folder, and creation fails if the folder + // already contains an object with the same name. AllowDuplicateNames *bool // 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. @@ -837,7 +843,9 @@ type CreatePipelineRequest struct { Environment *PipelinesEnvironment // Path of the pipeline parent folder in workspace file tree. // - // If absent, the pipeline doesn't have a workspace object. + // If absent, the pipeline doesn't have a parent folder. + // + // Example: /Workspace/Projects/my_project ParentPath *string // Usage policy of this pipeline. UsagePolicyId *string @@ -902,8 +910,12 @@ type DeletePipelineResponse struct { type EditPipelineRequest struct { // Unique identifier for this pipeline. PipelineId *string - // If false, deployment will fail if name has changed and conflicts the name of - // another pipeline. + // If false, deployment will fail if name has changed and conflicts with the + // name of another pipeline. + // + // Ignored when the pipeline is in a workspace folder or the request sets + // `parent_path`. Renaming or moving such a pipeline fails if the target folder + // already contains an object with the same name. AllowDuplicateNames *bool // If present, the last-modified time of the pipeline settings before the edit. // If the settings were modified after that time, then the request will fail @@ -997,7 +1009,9 @@ type EditPipelineRequest struct { Environment *PipelinesEnvironment // Path of the pipeline parent folder in workspace file tree. // - // If absent, the pipeline doesn't have a workspace object. + // If absent, the pipeline doesn't have a parent folder. + // + // Example: /Workspace/Projects/my_project ParentPath *string // Usage policy of this pipeline. UsagePolicyId *string @@ -1241,8 +1255,10 @@ type IngestionGatewayPipelineDefinition struct { } type IngestionPipelineDefinition struct { - // (Required, Mutable) Identifies the data source for the Lakeflow Connect - // Ingestion pipeline. Exactly one option must be specified. + // (Mutable) Identifies the data source for the Lakeflow Connect Ingestion + // pipeline. Exactly one option must be specified, unless the objects ingest + // from cloud object storage via `connector_options.cloud_files_options`, in + // which case none is specified. Source isIngestionPipelineDefinition_Source // Required. Settings specifying tables to replicate and the destination for the // replicated tables. @@ -2239,7 +2255,9 @@ type PipelineSpec struct { Environment *PipelinesEnvironment // Path of the pipeline parent folder in workspace file tree. // - // If absent, the pipeline doesn't have a workspace object. + // If absent, the pipeline doesn't have a parent folder. + // + // Example: /Workspace/Projects/my_project ParentPath *string // Usage policy of this pipeline. UsagePolicyId *string diff --git a/postgres/CHANGELOG.md b/postgres/CHANGELOG.md index fa76fac1..c2273dad 100644 --- a/postgres/CHANGELOG.md +++ b/postgres/CHANGELOG.md @@ -1,5 +1,7 @@ # Version changelog +## Release v0.15.0 (2026-11-19) + ## Release v0.14.0 (2026-11-18) ## Release v0.13.0 (2026-11-17) diff --git a/postgres/internal/version.go b/postgres/internal/version.go index d4561678..c63b84bc 100644 --- a/postgres/internal/version.go +++ b/postgres/internal/version.go @@ -2,4 +2,4 @@ package internal const ModuleName = "sdk-go-postgres" -const Version = "0.14.0" +const Version = "0.15.0" diff --git a/postgres/v1/model.go b/postgres/v1/model.go index 902da522..5bc2ce4e 100644 --- a/postgres/v1/model.go +++ b/postgres/v1/model.go @@ -1238,8 +1238,9 @@ type CreateRoleRequest struct { // The ID used to identify and manage the Role resource through the API. The // Postgres role name is specified in `spec.postgres_role`. // - // This value should be 4-63 characters, and valid characters are lowercase - // letters, numbers, and hyphens, as defined by RFC 1123. + // This value should be 3-63 characters, start with a lowercase letter, end with + // a lowercase letter or digit, and contain only lowercase letters, digits, and + // hyphens. // // If role_id is not specified in the request, it is generated automatically. RoleId *string @@ -1531,7 +1532,8 @@ type DeleteRoleRequest struct { // projects/{project_id}/branches/{branch_id}/roles/{role_id} Name *string // Reassign objects. If this is set, all objects owned by the role are - // reassigned to the role specified in this parameter. + // reassigned to the role specified in this parameter. The role must already + // exist. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id} // // NOTE: setting this requires spinning up a compute to succeed, since it // involves running SQL queries. @@ -2469,8 +2471,10 @@ type Role struct { Name *string `fieldmask:"name"` // The Branch where this Role exists. Format: // projects/{project_id}/branches/{branch_id} - Parent *string `fieldmask:"parent"` + Parent *string `fieldmask:"parent"` + // A timestamp indicating when the role was created. CreateTime *types.Time `fieldmask:"create_time"` + // A timestamp indicating when the role was last updated. UpdateTime *types.Time `fieldmask:"update_time"` // The spec contains the role configuration, including identity type, // authentication method, and role attributes. @@ -2492,9 +2496,14 @@ type Role struct { // Postgres keyword naming e.g. CREATEDB, BYPASSRLS, etc. which is why they // don't include typical underscores between words.. type Role_Attributes struct { - Createdb *bool `fieldmask:"createdb"` + // Whether the role can create databases (the Postgres CREATEDB attribute). + Createdb *bool `fieldmask:"createdb"` + // Whether the role can create, alter and drop other roles (the Postgres + // CREATEROLE attribute). Createrole *bool `fieldmask:"createrole"` - Bypassrls *bool `fieldmask:"bypassrls"` + // Whether the role bypasses every row-level security policy (the Postgres + // BYPASSRLS attribute). + Bypassrls *bool `fieldmask:"bypassrls"` } type Role_RoleSpec struct { @@ -2502,16 +2511,16 @@ type Role_RoleSpec struct { // selected in update_mask, this field replaces all existing memberships. An // empty or omitted list clears all memberships, including DATABRICKS_SUPERUSER. MembershipRoles []Role_MembershipRole `fieldmask:"membership_roles"` - // The type of role. When specifying a managed-identity, the chosen - // postgres_role must be a valid: + // The type of Databricks identity that backs the role. Leave unset to create a + // native Postgres role that is not associated with a Databricks identity. When + // specifying a managed-identity, the chosen postgres_role must be a valid: // // * application ID for SERVICE_PRINCIPAL * user email for USER * group name for // GROUP // // This value cannot be changed after creation. IdentityType Role_IdentityType `fieldmask:"identity_type"` - // The desired API-exposed Postgres role attribute to associate with the role. - // Optional. + // The Postgres role attributes to grant to the role. Attributes *Role_Attributes `fieldmask:"attributes"` // Controls how the Postgres role authenticates when a client opens a database // connection. Supported values: @@ -2547,20 +2556,21 @@ type Role_RoleSpec struct { // identity, then postgres_role must be one of the following: // // 1. user email for IdentityType.USER 2. app ID for - // IdentityType.SERVICE_PRINCIPAL 2. group name for IdentityType.GROUP + // IdentityType.SERVICE_PRINCIPAL 3. group name for IdentityType.GROUP // // This value cannot be changed after creation. PostgresRole *string `fieldmask:"postgres_role"` } type Role_RoleStatus struct { - // An enum value for a standard role that this role is a member of. + // The standard roles that the role is currently a member of. MembershipRoles []Role_MembershipRole `fieldmask:"membership_roles"` - // The type of the role. + // The type of Databricks identity that backs the role, if any. IdentityType Role_IdentityType `fieldmask:"identity_type"` - // The PG role attributes associated with the role. + // The Postgres role attributes currently granted to the role. Attributes *Role_Attributes `fieldmask:"attributes"` - AuthMethod Role_AuthMethod `fieldmask:"auth_method"` + // How the role authenticates when it connects to Postgres. + AuthMethod Role_AuthMethod `fieldmask:"auth_method"` // The name of the Postgres role. PostgresRole *string `fieldmask:"postgres_role"` // Part of the resource name. diff --git a/secrets/CHANGELOG.md b/secrets/CHANGELOG.md index fbb6e4d6..124b1fe1 100644 --- a/secrets/CHANGELOG.md +++ b/secrets/CHANGELOG.md @@ -1,5 +1,7 @@ # Version changelog +## Release v0.8.0 (2026-11-19) + ## Release v0.7.0 (2026-11-17) ## Release v0.6.0 (2026-11-12) diff --git a/secrets/internal/version.go b/secrets/internal/version.go index 4feb74bb..d27b2753 100644 --- a/secrets/internal/version.go +++ b/secrets/internal/version.go @@ -2,4 +2,4 @@ package internal const ModuleName = "sdk-go-secrets" -const Version = "0.7.0" +const Version = "0.8.0" diff --git a/secrets/v1/client.go b/secrets/v1/client.go index fea724af..4c2d6fa8 100644 --- a/secrets/v1/client.go +++ b/secrets/v1/client.go @@ -81,17 +81,6 @@ func NewClient(ctx context.Context, opts ...client.Option) (*Client, error) { // The scope name must consist of alphanumeric characters, dashes, underscores, // and periods, and may not exceed 128 characters. // -// Example request: -// -// .. code:: -// -// { "scope": "my-simple-databricks-scope", "initial_manage_principal": "users" -// "scope_backend_type": "databricks|azure_keyvault", # below is only required -// if scope type is azure_keyvault "backend_azure_keyvault": { "resource_id": -// "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/xxxx/providers/Microsoft.KeyVault/vaults/xxxx", -// "tenant_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "dns_name": -// "https://xxxx.vault.azure.net/", } } -// // If “initial_manage_principal“ is specified, the initial ACL applied to the // scope is applied to the supplied principal (user or group) with “MANAGE“ // permissions. The only supported principal for this option is the group @@ -100,19 +89,19 @@ func NewClient(ctx context.Context, opts ...client.Option) (*Client, error) { // “MANAGE“ permission applied to the scope is assigned to the API request // issuer's user identity. // -// If “scope_backend_type“ is “azure_keyvault“, a secret scope is created -// with secrets from a given Azure KeyVault. The caller must provide the -// keyvault_resource_id and the tenant_id for the key vault. If -// “scope_backend_type“ is “databricks“ or is unspecified, an empty secret -// scope is created and stored in 's own storage. +// If “scope_backend_type“ is “AZURE_KEYVAULT“, a secret scope is created +// with secrets from an existing Azure key vault. The caller must provide the +// key vault's resource ID and DNS name in “backend_azure_keyvault“. If +// “scope_backend_type“ is “DATABRICKS“ or is unspecified, an empty secret +// scope is created and stored in Databricks-managed storage. // // Throws “RESOURCE_ALREADY_EXISTS“ if a scope with the given name already // exists. Throws “RESOURCE_LIMIT_EXCEEDED“ if maximum number of scopes in the // workspace is exceeded. Throws “INVALID_PARAMETER_VALUE“ if the scope name // is invalid. Throws “BAD_REQUEST“ if request violated constraints. Throws -// “CUSTOMER_UNAUTHORIZED“ if normal user attempts to create a scope with name -// reserved for databricks internal usage. Throws “UNAUTHENTICATED“ if unable -// to verify user access permission on Azure KeyVault +// “CUSTOMER_UNAUTHORIZED“ if the scope name is reserved for Databricks +// internal use. Throws “UNAUTHENTICATED“ if Databricks cannot verify the +// caller's access to the Azure key vault. func (c *internalClient) CreateScope(ctx context.Context, req CreateScopeRequest, opts ...call.Option) (*CreateScopeResponse, error) { wireReq, err := createScopeRequestToWire(&req) if err != nil { @@ -176,12 +165,6 @@ func (c *internalClient) CreateScope(ctx context.Context, req CreateScopeRequest // // Users must have the “MANAGE“ permission to invoke this API. // -// Example request: -// -// .. code:: -// -// { "scope": "my-secret-scope", "principal": "data-scientists" } -// // Throws “RESOURCE_DOES_NOT_EXIST“ if no such secret scope, principal, or ACL // exists. Throws “PERMISSION_DENIED“ if the user does not have permission to // make this API call. Throws “INVALID_PARAMETER_VALUE“ if the permission or @@ -247,16 +230,9 @@ func (c *internalClient) DeleteAcl(ctx context.Context, req DeleteAclRequest, op // Deletes a secret scope. // -// Example request: -// -// .. code:: -// -// { "scope": "my-secret-scope" } -// // Throws “RESOURCE_DOES_NOT_EXIST“ if the scope does not exist. Throws // “PERMISSION_DENIED“ if the user does not have permission to make this API -// call. Throws “BAD_REQUEST“ if system user attempts to delete internal -// secret scope. +// call. func (c *internalClient) DeleteScope(ctx context.Context, req DeleteScopeRequest, opts ...call.Option) (*DeleteScopeResponse, error) { wireReq, err := deleteScopeRequestToWire(&req) if err != nil { @@ -321,8 +297,8 @@ func (c *internalClient) DeleteScope(ctx context.Context, req DeleteScopeRequest // // Throws “RESOURCE_DOES_NOT_EXIST“ if no such secret scope or secret exists. // Throws “PERMISSION_DENIED“ if the user does not have permission to make -// this API call. Throws “BAD_REQUEST“ if system user attempts to delete an -// internal secret, or request is made against Azure KeyVault backed scope. +// this API call. Throws “BAD_REQUEST“ if the request is made against an Azure +// Key Vault-backed scope. func (c *internalClient) DeleteSecret(ctx context.Context, req DeleteSecretRequest, opts ...call.Option) (*DeleteSecretResponse, error) { wireReq, err := deleteSecretRequestToWire(&req) if err != nil { @@ -386,12 +362,6 @@ func (c *internalClient) DeleteSecret(ctx context.Context, req DeleteSecretReque // // Users must have the “MANAGE“ permission to invoke this API. // -// Example response: -// -// .. code:: -// -// { "principal": "data-scientists", "permission": "READ" } -// // Throws “RESOURCE_DOES_NOT_EXIST“ if no such secret scope exists. Throws // “PERMISSION_DENIED“ if the user does not have permission to make this API // call. Throws “INVALID_PARAMETER_VALUE“ if the permission or principal is @@ -472,9 +442,9 @@ func (c *internalClient) GetAcl(ctx context.Context, req GetAclRequest, opts ... // Throws “PERMISSION_DENIED“ if the user does not have permission to make // this API call. Azure Key Vault-backed scopes can also return the following // errors: Throws “INVALID_PARAMETER_VALUE“ if the secret name is not -// alphanumeric or is too long. Throws “PERMISSION_DENIED“ if +// alphanumeric or is too long. Throws “PERMISSION_DENIED“ if Databricks // cannot access the key vault (HTTP 403). Throws “MALFORMED_REQUEST“ if -// cannot access the key vault with any other 4xx error. +// Databricks cannot access the key vault with any other 4xx error. func (c *internalClient) GetSecret(ctx context.Context, req GetSecretRequest, opts ...call.Option) (*GetSecretResponse, error) { wireReq, err := getSecretRequestToWire(&req) if err != nil { @@ -544,13 +514,6 @@ func (c *internalClient) GetSecret(ctx context.Context, req GetSecretRequest, op // // Users must have the “MANAGE“ permission to invoke this API. // -// Example response: -// -// .. code:: -// -// { "acls": [{ "principal": "admins", "permission": "MANAGE" },{ "principal": -// "data-scientists", "permission": "READ" }] } -// // Throws “RESOURCE_DOES_NOT_EXIST“ if no such secret scope exists. Throws // “PERMISSION_DENIED“ if the user does not have permission to make this API // call. @@ -618,13 +581,6 @@ func (c *internalClient) ListAcls(ctx context.Context, req ListAclsRequest, opts // Lists all secret scopes available in the workspace. // -// Example response: -// -// .. code:: -// -// { "scopes": [{ "name": "my-databricks-scope", "backend_type": "DATABRICKS" -// },{ "name": "mount-points", "backend_type": "DATABRICKS" }] } -// // Throws “PERMISSION_DENIED“ if the user does not have permission to make // this API call. func (c *internalClient) ListScopes(ctx context.Context, req ListScopesRequest, opts ...call.Option) (*ListScopesResponse, error) { @@ -761,29 +717,12 @@ func (c *internalClient) ListSecrets(ctx context.Context, req ListSecretsRequest // “READ“ - Allowed to read this secret scope and list what secrets are // available. // -// Note that in general, secret values can only be read from within a command on -// a cluster (for example, through a notebook). There is no API to read the -// actual secret value material outside of a cluster. However, the user's -// permission will be applied based on who is executing the command, and they -// must have at least READ permission. -// // Users must have the “MANAGE“ permission to invoke this API. // -// Example request: -// -// .. code:: -// -// { "scope": "my-secret-scope", "principal": "data-scientists", "permission": -// "READ" } -// -// The principal is a user or group name corresponding to an existing -// principal to be granted or revoked access. -// // Throws “RESOURCE_DOES_NOT_EXIST“ if no such secret scope exists. Throws -// “RESOURCE_ALREADY_EXISTS“ if a permission for the principal already exists. -// Throws “INVALID_PARAMETER_VALUE“ if the permission or principal is invalid. -// Throws “PERMISSION_DENIED“ if the user does not have permission to make -// this API call. +// “INVALID_PARAMETER_VALUE“ if the permission or principal is invalid. Throws +// “PERMISSION_DENIED“ if the user does not have permission to make this API +// call. func (c *internalClient) PutAcl(ctx context.Context, req PutAclRequest, opts ...call.Option) (*PutAclResponse, error) { wireReq, err := putAclRequestToWire(&req) if err != nil { diff --git a/secrets/v1/model.go b/secrets/v1/model.go index ba3b7f4e..8f868c8b 100644 --- a/secrets/v1/model.go +++ b/secrets/v1/model.go @@ -15,13 +15,12 @@ const ( AclPermission_Manage AclPermission = "MANAGE" ) -// The types of secret scope backends in the Secret Manager. Azure KeyVault -// backed secret scopes will be supported in a later release. +// The types of secret scope backends in the Secret Manager. type ScopeBackendType string const ( ScopeBackendType_Unspecified ScopeBackendType = "" - // A secret scope in which secrets are stored in Databrick managed storage and + // A secret scope in which secrets are stored in Databricks-managed storage and // encrypted with a cloud-based specific encryption key. ScopeBackendType_Databricks ScopeBackendType = "DATABRICKS" // A customer Azure KeyVault backed secret scope. Reading secrets from this @@ -33,7 +32,8 @@ const ( // An item representing an ACL rule applied to the given principal (user or // group) on the associated scope point.. type AclItem struct { - // The principal in which the permission is applied. + // The user name or group name of an existing Databricks principal that the + // permission applies to. Principal *string // The permission level applied to the principal. Permission AclPermission @@ -42,10 +42,10 @@ type AclItem struct { // The metadata of the Azure KeyVault for a secret scope of type // `AZURE_KEYVAULT`. type AzureKeyVaultSecretScopeMetadata struct { - // The resource id of the azure KeyVault that user wants to associate the scope - // with. + // The Azure resource ID of the key vault to associate with the scope. ResourceId *string - // The DNS of the KeyVault + // The DNS name of the key vault, for example + // ``https://my-key-vault.vault.azure.net/``. DnsName *string } @@ -55,8 +55,7 @@ type CreateScopeRequest struct { // The principal that is initially granted ``MANAGE`` permission to the created // scope. InitialManagePrincipal *string - // The backend type the scope will be created with. If not specified, will - // default to ``DATABRICKS`` + // The backend type of the new scope. Defaults to ``DATABRICKS``. ScopeBackendType ScopeBackendType // The metadata for the secret scope if the type is ``AZURE_KEYVAULT`` BackendAzureKeyvault *AzureKeyVaultSecretScopeMetadata @@ -146,7 +145,8 @@ type ListSecretsResponse struct { type PutAclRequest struct { // The name of the scope to apply permissions to. Scope *string - // The principal in which the permission is applied. + // The user name or group name of an existing Databricks principal that the + // permission applies to. Principal *string // The permission level applied to the principal. Permission AclPermission @@ -197,14 +197,14 @@ type SecretMetadata struct { LastUpdatedTimestamp *int64 } -// An organizational resource for storing secrets. Secret scopes can be -// different types (Databricks-managed, Azure KeyVault backed, etc), and ACLs -// can be applied to control permissions for all secrets within a scope.. +// An organizational resource for storing secrets. A secret scope is either +// Databricks-backed or Azure Key Vault-backed, and ACLs can be applied to +// control permissions for all secrets within a scope.. type SecretScope struct { // A unique name to identify the secret scope. Name *string // The type of secret scope backend. BackendType ScopeBackendType - // The metadata for the secret scope if the type is ``AZURE_KEYVAULT`` + // The metadata for the secret scope if the type is ``AZURE_KEYVAULT``. KeyvaultMetadata *AzureKeyVaultSecretScopeMetadata } diff --git a/settings/CHANGELOG.md b/settings/CHANGELOG.md index 219b3123..6b2095ba 100644 --- a/settings/CHANGELOG.md +++ b/settings/CHANGELOG.md @@ -1,5 +1,7 @@ # Version changelog +## Release v0.8.0 (2026-11-19) + ## Release v0.7.0 (2026-11-12) ### New Features and Improvements diff --git a/settings/internal/version.go b/settings/internal/version.go index d91fe2a0..3fe91890 100644 --- a/settings/internal/version.go +++ b/settings/internal/version.go @@ -2,4 +2,4 @@ package internal const ModuleName = "sdk-go-settings" -const Version = "0.7.0" +const Version = "0.8.0" diff --git a/settings/v2/client.go b/settings/v2/client.go index 2530a378..b23a0037 100644 --- a/settings/v2/client.go +++ b/settings/v2/client.go @@ -221,7 +221,7 @@ func (c *internalClient) GetPublicAccountUserPreference(ctx context.Context, req } // Get a setting value at workspace level. See -// :method:settingsv2/listworkspacesettingsmetadata for list of setting +// :method:settingsv2/listworkspacesettingsmetadata for the list of settings // available via public APIs. func (c *internalClient) GetPublicWorkspaceSetting(ctx context.Context, req GetPublicWorkspaceSettingRequest, opts ...call.Option) (*Setting, error) { @@ -799,7 +799,7 @@ func (c *internalClient) PatchPublicAccountUserPreference(ctx context.Context, r } // Patch a setting value at workspace level. See -// :method:settingsv2/listworkspacesettingsmetadata for list of setting +// :method:settingsv2/listworkspacesettingsmetadata for the list of settings // available via public APIs at workspace level. To determine the correct field // to include in a patch request, refer to the type field of the setting // returned in the :method:settingsv2/listworkspacesettingsmetadata response. diff --git a/settings/v2/model.go b/settings/v2/model.go index 7a1e5d74..3f3bc590 100644 --- a/settings/v2/model.go +++ b/settings/v2/model.go @@ -158,14 +158,25 @@ const ( ) type AibiDashboardEmbeddingAccessPolicy struct { + // Where AI/BI dashboards can be embedded: in any domain (ALLOW_ALL_DOMAINS), + // only in the approved domains configured for the workspace + // (ALLOW_APPROVED_DOMAINS), or nowhere (DENY_ALL_DOMAINS). Defaults to + // ALLOW_APPROVED_DOMAINS. AccessPolicyType AibiDashboardEmbeddingAccessPolicy_AccessPolicyType } type AibiDashboardEmbeddingApprovedDomains struct { + // Domains allowed to host embedded AI/BI dashboards. A leading wildcard allows + // every subdomain of a domain. The list applies, and can only be changed, while + // the embedding access policy is ALLOW_APPROVED_DOMAINS. ApprovedDomains []string } type AllowedAppsUserApiScopesMessage struct { + // OAuth scopes that app developers can request when an app acts on behalf of a + // user. A list with the single entry * allows every supported scope and cannot + // be combined with other scopes. An empty list disables user authorization for + // apps. AllowedScopes []string } @@ -174,10 +185,24 @@ type BooleanMessage struct { } type ClusterAutoRestartMessage struct { - Enabled *bool - CanToggle *bool - MaintenanceWindow *ClusterAutoRestartMessage_MaintenanceWindow - EnablementDetails *ClusterAutoRestartMessage_EnablementDetails + // Whether automatic cluster update is enabled for the workspace. The effective + // value is always true while the compliance security profile is enabled on the + // workspace. + Enabled *bool + // Whether the workspace can change the enabled state. Databricks computes this + // value: it is false when the compliance security profile forces the feature on + // or when the workspace lacks the Enhanced Security and Compliance entitlement. + // A value sent in an update request has no effect. + CanToggle *bool + // When the maintenance window runs. When unset, it defaults to the first Sunday + // of every month at 01:00 UTC. + MaintenanceWindow *ClusterAutoRestartMessage_MaintenanceWindow + // Why the feature is forced on or unavailable. Databricks sets these details + // for information only; they do not determine whether the feature is enabled. + EnablementDetails *ClusterAutoRestartMessage_EnablementDetails + // Whether compute resources restart during every maintenance window even when + // no update is available. When false, they restart only when an update is + // available. RestartEvenIfNoUpdatesAvailable *bool } @@ -190,25 +215,33 @@ type ClusterAutoRestartMessage struct { type ClusterAutoRestartMessage_EnablementDetails struct { // The feature is unavailable if the customer doesn't have enterprise tier UnavailableForNonEnterpriseTier *bool - // The feature is unavailable if the corresponding entitlement disabled (see - // getShieldEntitlementEnable) + // The feature is unavailable because the workspace does not have the Enhanced + // Security and Compliance entitlement. UnavailableForDisabledEntitlement *bool // The feature is force enabled if compliance mode is active ForcedForComplianceMode *bool } type ClusterAutoRestartMessage_MaintenanceWindow struct { + // Schedule anchored to a day of the week, either every week or on given weeks + // of the month. WeekDayBasedSchedule *ClusterAutoRestartMessage_MaintenanceWindow_WeekDayBasedSchedule } type ClusterAutoRestartMessage_MaintenanceWindow_WeekDayBasedSchedule struct { - Frequency ClusterAutoRestartMessage_MaintenanceWindow_WeekDayFrequency - DayOfWeek ClusterAutoRestartMessage_MaintenanceWindow_DayOfWeek + // How often the maintenance window occurs: every week, or only on the listed + // occurrences of the day of the week within each month. + Frequency ClusterAutoRestartMessage_MaintenanceWindow_WeekDayFrequency + // Day of the week on which the maintenance window starts. + DayOfWeek ClusterAutoRestartMessage_MaintenanceWindow_DayOfWeek + // Time of day, in UTC, at which the maintenance window starts. WindowStartTime *ClusterAutoRestartMessage_MaintenanceWindow_WindowStartTime } type ClusterAutoRestartMessage_MaintenanceWindow_WindowStartTime struct { - Hours *int + // Hour of the day on a 24-hour clock. + Hours *int + // Minute of the hour. Minutes *int } @@ -433,7 +466,7 @@ type GetPublicAccountUserPreferenceRequest struct { } type GetPublicWorkspaceSettingRequest struct { - // Name of the setting + // Name of the setting to retrieve. Name *string } @@ -515,6 +548,9 @@ type ListWorkspaceSettingsMetadataResponse struct { } type OperationalEmailCustomRecipientMessage struct { + // Email address that receives this workspace's operational emails in addition + // to the workspace admins. Use a distribution list address to reach several + // people. An empty string clears the additional recipient. Email *string } @@ -535,24 +571,46 @@ type PatchPublicAccountUserPreferenceRequest struct { } type PatchPublicWorkspaceSettingRequest struct { - // Name of the setting + // Name of the setting to update. Name *string Setting *Setting } type PersonalComputeMessage struct { + // ON grants all users in all workspaces of the account access to the Personal + // Compute default policy. DELEGATE moves control to each workspace, where users + // or groups must be added to the policy's permissions before they can create + // compute with it. Value PersonalComputeMessage_PersonalComputeMessageEnum } type RestrictWorkspaceAdminsMessage struct { + // Controls what workspace admins can do with service principal tokens and job + // identities. With ALLOW_ALL, workspace admins can create personal access + // tokens on behalf of any service principal in the workspace, change a job + // owner to any workspace user, and set a job's run_as identity to any workspace + // user or to a service principal they have the Service Principal User role on. + // With RESTRICT_TOKENS_AND_JOB_RUN_AS, they can only create tokens for service + // principals they have the Service Principal User role on, change a job owner + // to themselves, and set run_as to themselves or to a service principal they + // have that role on. Status RestrictWorkspaceAdminsMessage_Status // When true, workspace admins cannot create governance tags. ALLOW_ALL status // does not override this; they are independent. DisableGovTagCreation *bool } +// A setting and its value at the workspace or account scope. Each setting has +// one value type, so one value field applies to it: a primitive wrapper +// (boolean_val, string_val or integer_val) or a setting-specific message. The +// settings metadata endpoint reports the field each setting uses. When updating +// a setting, set only the value field that matches its type. Responses return +// that field with the value configured at this scope, if one is set, together +// with the matching effective_* field, which holds the value in effect after +// Databricks applies account policies and defaults.. type Setting struct { - // Name of the setting. + // Name of the setting. The settings metadata endpoint lists the names available + // at each scope. Name *string // New fields should be added before the oneof below - unless it's a new Setting // value message, in that case it needs to be defined in the oneof below. The @@ -905,6 +963,11 @@ func (*UserPreference_EffectiveValue_EffectiveStringVal) isUserPreference_Effect // Workspace label and color for display (e.g. in account console).. type WorkspaceLabelMessage struct { + // Text of the label shown next to the workspace name in the top navigation bar. + // An empty string means no label is set. Label *string + // Color of the label badge. The supported colors are coral, lemon, lime, + // turquoise, indigo, purple and pink. It is an empty string when no label is + // set. Color *string } diff --git a/softwareartifacts/CHANGELOG.md b/softwareartifacts/CHANGELOG.md index eb5522da..edf0dffc 100644 --- a/softwareartifacts/CHANGELOG.md +++ b/softwareartifacts/CHANGELOG.md @@ -1,5 +1,7 @@ # Version changelog +## Release v0.6.0 (2026-11-19) + ## Release v0.5.0 (2026-11-17) ## Release v0.4.0 (2026-11-12) diff --git a/softwareartifacts/internal/version.go b/softwareartifacts/internal/version.go index a214d4f8..91cd9d3f 100644 --- a/softwareartifacts/internal/version.go +++ b/softwareartifacts/internal/version.go @@ -2,4 +2,4 @@ package internal const ModuleName = "sdk-go-softwareartifacts" -const Version = "0.5.0" +const Version = "0.6.0" diff --git a/softwareartifacts/v1/client.go b/softwareartifacts/v1/client.go index 2125f0e7..6b11c1ef 100644 --- a/softwareartifacts/v1/client.go +++ b/softwareartifacts/v1/client.go @@ -78,6 +78,120 @@ func NewClient(ctx context.Context, opts ...client.Option) (*Client, error) { }, nil } +// Deletes a software artifact. Fails if the artifact still has versions unless +// `force` is set. +func (c *internalClient) DeleteSoftwareArtifact(ctx context.Context, req DeleteSoftwareArtifactRequest, opts ...call.Option) error { + wireReq, err := deleteSoftwareArtifactRequestToWire(&req) + if err != nil { + return err + } + + headers := http.Header{} + if c.workspaceID != "" { + headers.Set("X-Databricks-Workspace-Id", c.workspaceID) + } + + baseURL, err := url.Parse(c.host) + if err != nil { + return err + } + pb := pathBuilder{} + pb.literal("/api/2.1/unity-catalog/") + if req.Name == nil { + return fmt.Errorf("path parameter %q is required", "name") + } + pb.singleSegment(*req.Name) + baseURL.Path, baseURL.RawPath = pb.build() + queryParams := url.Values{} + if err := addQueryValue(queryParams, "force", wireReq.Force); err != nil { + return err + } + baseURL.RawQuery = queryParams.Encode() + urlStr := baseURL.String() + + call := func(ctx context.Context) error { + httpReq, err := newHTTPRequest(ctx, httpRequestOptions{ + Method: "DELETE", + URL: urlStr, + Credentials: c.credentials, + UserAgent: c.userAgent, + Headers: headers, + }) + if err != nil { + return err + } + + respBody, _, err := executeHTTPCall(httpCallOptions{ + req: httpReq, + client: c.httpClient, + logger: c.logger, + }) + if err != nil { + return err + } + _ = respBody + return nil + } + + if err := c.executeCall(ctx, call, opts); err != nil { + return err + } + return nil +} + +// Deletes a software artifact version. +func (c *internalClient) DeleteSoftwareArtifactVersion(ctx context.Context, req DeleteSoftwareArtifactVersionRequest, opts ...call.Option) error { + + headers := http.Header{} + if c.workspaceID != "" { + headers.Set("X-Databricks-Workspace-Id", c.workspaceID) + } + + baseURL, err := url.Parse(c.host) + if err != nil { + return err + } + pb := pathBuilder{} + pb.literal("/api/2.1/unity-catalog/") + if req.Name == nil { + return fmt.Errorf("path parameter %q is required", "name") + } + pb.singleSegment(*req.Name) + baseURL.Path, baseURL.RawPath = pb.build() + queryParams := url.Values{} + baseURL.RawQuery = queryParams.Encode() + urlStr := baseURL.String() + + call := func(ctx context.Context) error { + httpReq, err := newHTTPRequest(ctx, httpRequestOptions{ + Method: "DELETE", + URL: urlStr, + Credentials: c.credentials, + UserAgent: c.userAgent, + Headers: headers, + }) + if err != nil { + return err + } + + respBody, _, err := executeHTTPCall(httpCallOptions{ + req: httpReq, + client: c.httpClient, + logger: c.logger, + }) + if err != nil { + return err + } + _ = respBody + return nil + } + + if err := c.executeCall(ctx, call, opts); err != nil { + return err + } + return nil +} + // Gets a software artifact by its resource name. Returns `NOT_FOUND` if the // artifact does not exist. func (c *internalClient) GetSoftwareArtifact(ctx context.Context, req GetSoftwareArtifactRequest, opts ...call.Option) (*SoftwareArtifact, error) { diff --git a/softwareartifacts/v1/model.go b/softwareartifacts/v1/model.go index 7fe47e19..2062cb18 100644 --- a/softwareartifacts/v1/model.go +++ b/softwareartifacts/v1/model.go @@ -15,6 +15,24 @@ const ( ImageAccelerationDetail_Status_Success ImageAccelerationDetail_Status = "SUCCESS" ) +// Request to delete a software artifact.. +type DeleteSoftwareArtifactRequest struct { + // Resource name of the software artifact, of the form + // `software-artifacts/{catalog}.{schema}.{artifact}`. + Name *string + // Force deletion even if the software artifact has versions, deleting them with + // it. Default is false. + Force *bool +} + +// Request to delete a software artifact version.. +type DeleteSoftwareArtifactVersionRequest struct { + // Resource name of the version, of the form + // `software-artifacts/{catalog}.{schema}.{artifact}/versions/{version}`, where + // `{version}` is the version's content digest, for example `sha256:`. + Name *string +} + // Request to get a software artifact.. type GetSoftwareArtifactRequest struct { // Resource name of the artifact, of the form diff --git a/softwareartifacts/v1/wire.go b/softwareartifacts/v1/wire.go index 9ea09006..f3cbe3a2 100644 --- a/softwareartifacts/v1/wire.go +++ b/softwareartifacts/v1/wire.go @@ -9,6 +9,101 @@ import ( "github.com/databricks/sdk-go/core/types" ) +type deleteSoftwareArtifactRequestWire struct { + Name *string `json:"name,omitempty"` + Force *bool `json:"force,omitempty"` +} + +func deleteSoftwareArtifactRequestToWire(v *DeleteSoftwareArtifactRequest) (*deleteSoftwareArtifactRequestWire, error) { + if v == nil { + return nil, nil + } + return &deleteSoftwareArtifactRequestWire{ + Name: v.Name, + Force: v.Force, + }, nil +} + +func deleteSoftwareArtifactRequestFromWire(w *deleteSoftwareArtifactRequestWire) (*DeleteSoftwareArtifactRequest, error) { + if w == nil { + return nil, nil + } + return &DeleteSoftwareArtifactRequest{ + Name: w.Name, + Force: w.Force, + }, nil +} + +// MarshalJSON returns the JSON form that the API uses for this message, with +// fields that a request sends in the URL path or query as regular fields. +func (v DeleteSoftwareArtifactRequest) MarshalJSON() ([]byte, error) { + w, err := deleteSoftwareArtifactRequestToWire(&v) + if err != nil { + return nil, err + } + return json.Marshal(w) +} + +// UnmarshalJSON sets the message from the JSON that MarshalJSON writes. +func (v *DeleteSoftwareArtifactRequest) UnmarshalJSON(data []byte) error { + var w deleteSoftwareArtifactRequestWire + if err := json.Unmarshal(data, &w); err != nil { + return err + } + decoded, err := deleteSoftwareArtifactRequestFromWire(&w) + if err != nil { + return err + } + *v = *decoded + return nil +} + +type deleteSoftwareArtifactVersionRequestWire struct { + Name *string `json:"name,omitempty"` +} + +func deleteSoftwareArtifactVersionRequestToWire(v *DeleteSoftwareArtifactVersionRequest) (*deleteSoftwareArtifactVersionRequestWire, error) { + if v == nil { + return nil, nil + } + return &deleteSoftwareArtifactVersionRequestWire{ + Name: v.Name, + }, nil +} + +func deleteSoftwareArtifactVersionRequestFromWire(w *deleteSoftwareArtifactVersionRequestWire) (*DeleteSoftwareArtifactVersionRequest, error) { + if w == nil { + return nil, nil + } + return &DeleteSoftwareArtifactVersionRequest{ + Name: w.Name, + }, nil +} + +// MarshalJSON returns the JSON form that the API uses for this message, with +// fields that a request sends in the URL path or query as regular fields. +func (v DeleteSoftwareArtifactVersionRequest) MarshalJSON() ([]byte, error) { + w, err := deleteSoftwareArtifactVersionRequestToWire(&v) + if err != nil { + return nil, err + } + return json.Marshal(w) +} + +// UnmarshalJSON sets the message from the JSON that MarshalJSON writes. +func (v *DeleteSoftwareArtifactVersionRequest) UnmarshalJSON(data []byte) error { + var w deleteSoftwareArtifactVersionRequestWire + if err := json.Unmarshal(data, &w); err != nil { + return err + } + decoded, err := deleteSoftwareArtifactVersionRequestFromWire(&w) + if err != nil { + return err + } + *v = *decoded + return nil +} + type getSoftwareArtifactRequestWire struct { Name *string `json:"name,omitempty"` } diff --git a/statementexecution/CHANGELOG.md b/statementexecution/CHANGELOG.md index c10d8f34..7a9845f0 100644 --- a/statementexecution/CHANGELOG.md +++ b/statementexecution/CHANGELOG.md @@ -1,5 +1,7 @@ # Version changelog +## Release v0.10.0 (2026-11-19) + ## Release v0.9.0 (2026-11-17) ## Release v0.8.0 (2026-11-16) diff --git a/statementexecution/internal/version.go b/statementexecution/internal/version.go index 100c2d7b..2efb1482 100644 --- a/statementexecution/internal/version.go +++ b/statementexecution/internal/version.go @@ -2,4 +2,4 @@ package internal const ModuleName = "sdk-go-statementexecution" -const Version = "0.9.0" +const Version = "0.10.0" diff --git a/statementexecution/v1/model.go b/statementexecution/v1/model.go index 32096f5e..d30d9ba8 100644 --- a/statementexecution/v1/model.go +++ b/statementexecution/v1/model.go @@ -120,7 +120,7 @@ type ChunkInfo struct { ByteCount *int64 // 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 - // :method:statementexecution/getstatementresultchunkn request. + // :method:statementexecution/getStatementResultChunkN request. NextChunkIndex *int // 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 @@ -282,9 +282,9 @@ type ExecuteStatementRequest struct { // // 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" } ] } ` + // ``` { ..., "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. @@ -333,7 +333,7 @@ type ExternalLink struct { ByteCount *int64 // 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 - // :method:statementexecution/getstatementresultchunkn request. + // :method:statementexecution/getStatementResultChunkN request. NextChunkIndex *int // 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 @@ -346,7 +346,8 @@ type GetResultDataRequest struct { // The statement ID is returned upon successfully submitting a SQL statement, // and is a required reference for all subsequent calls. StatementId *string - ChunkIndex *int + // The zero-based index of the result chunk to fetch. + ChunkIndex *int // The ID of the warehouse that ran the statement. The Statement Execution // (Lakehouse//RT) API takes it as a path parameter. The Statement Execution API // doesn't use it. @@ -380,6 +381,8 @@ type QueryTag struct { // `external_links` array prepares the API to return multiple links in a single // response. Currently only a single link is returned.). type ResultData struct { + // Short-lived cloud-storage links to the result data, used with the + // `EXTERNAL_LINKS` disposition. ExternalLinks []ExternalLink // 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`. @@ -395,7 +398,7 @@ type ResultData struct { ByteCount *int64 // 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 - // :method:statementexecution/getstatementresultchunkn request. + // :method:statementexecution/getStatementResultChunkN request. NextChunkIndex *int // 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 @@ -406,7 +409,9 @@ type ResultData struct { // The result manifest provides schema and metadata for the result set.. type ResultManifest struct { + // The format of the result data, as requested with `format`. Format Format + // The schema of the result set: the ordered list of column descriptions. Schema *Schema // The total number of chunks that the result set has been divided into. TotalChunkCount *int @@ -423,11 +428,14 @@ type ResultManifest struct { // The schema is an ordered list of column descriptions.. type Schema struct { + // The number of columns in the result set. ColumnCount *int - Columns []ColumnInfo + // The column descriptions, in result set order. + Columns []ColumnInfo } type ServiceError struct { + // The error code that classifies the failure. ErrorCode ServiceErrorCode // A brief summary of the error condition. Message *string @@ -456,9 +464,18 @@ type StatementResponse struct { // The statement ID is returned upon successfully submitting a SQL statement, // and is a required reference for all subsequent calls. StatementId *string - Status *StatementStatus - Manifest *ResultManifest - Result *ResultData + // The execution state of the statement and, if it failed, the error details. + Status *StatementStatus + // The schema and metadata of the result set. Present when `status.state` is + // `SUCCEEDED`. + Manifest *ResultManifest + // 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. Calls to `getResultData` + // return the link for the requested chunk; `executeStatement` and + // `getStatementResult` responses can contain links for multiple chunks. + Result *ResultData } // The status response includes execution state and if relevant, error @@ -472,6 +489,8 @@ type StatementStatus struct { // execution successful, and statement closed; result no longer available for // fetch State StatementStatus_State + // The error that caused the statement to fail. Only populated when `state` is + // `FAILED`. Error *ServiceError // SQLSTATE error code returned when the statement execution fails. Only // populated when the statement status is `FAILED`. diff --git a/statementexecution/v2/model.go b/statementexecution/v2/model.go index 6151c32d..de03c3cf 100644 --- a/statementexecution/v2/model.go +++ b/statementexecution/v2/model.go @@ -332,9 +332,9 @@ type ExecuteStatementRequest struct { // // 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" } ] } ` + // ``` { ..., "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. diff --git a/tagpolicies/CHANGELOG.md b/tagpolicies/CHANGELOG.md index 343b52e7..7615a4a7 100644 --- a/tagpolicies/CHANGELOG.md +++ b/tagpolicies/CHANGELOG.md @@ -1,5 +1,7 @@ # Version changelog +## Release v0.7.0 (2026-11-19) + ## Release v0.6.0 (2026-11-12) ### New Features and Improvements diff --git a/tagpolicies/internal/version.go b/tagpolicies/internal/version.go index 59b4a0eb..aa762c60 100644 --- a/tagpolicies/internal/version.go +++ b/tagpolicies/internal/version.go @@ -2,4 +2,4 @@ package internal const ModuleName = "sdk-go-tagpolicies" -const Version = "0.6.0" +const Version = "0.7.0" diff --git a/tagpolicies/v1/model.go b/tagpolicies/v1/model.go index e2ec2baf..deae36b5 100644 --- a/tagpolicies/v1/model.go +++ b/tagpolicies/v1/model.go @@ -11,10 +11,12 @@ type CreateTagPolicyRequest struct { } type DeleteTagPolicyRequest struct { + // The key of the governed tag whose policy to delete. TagKey *string } type GetTagPolicyRequest struct { + // The key of the governed tag whose policy to get. TagKey *string } @@ -32,11 +34,23 @@ type ListTagPoliciesResponse struct { NextPageToken *string } +// A tag policy makes a tag key governed and defines the values that can be +// assigned to it. Governed tags are enforced across all workspaces in the +// account, and only users with the ASSIGN permission on the governed tag can +// assign it. See https://docs.databricks.com/aws/en/admin/governed-tags/.. type TagPolicy struct { - TagKey *string `fieldmask:"tag_key"` - Id *string `fieldmask:"id"` + // The tag key that this policy governs. Tag keys are case-sensitive. + TagKey *string `fieldmask:"tag_key"` + // The unique identifier of the tag policy, generated when the policy is + // created. + Id *string `fieldmask:"id"` + // A description of the governed tag, such as its purpose or the meaning of its + // values. Description *string `fieldmask:"description"` - Values []Value `fieldmask:"values"` + // The allowed values of the governed tag. Only these values can be assigned to + // the tag key, and each value must be unique. A policy without values defines a + // key-only governed tag. + Values []Value `fieldmask:"values"` // Timestamp when the tag policy was created CreateTime *types.Time `fieldmask:"create_time"` // Timestamp when the tag policy was last updated @@ -44,10 +58,15 @@ type TagPolicy struct { } type UpdateTagPolicyRequest struct { - TagPolicy *TagPolicy + TagPolicy *TagPolicy + // The comma-separated list of tag policy fields to update. When the mask + // includes `values`, the values in the request replace all existing allowed + // values. UpdateMask *types.FieldMask[TagPolicy] } +// An allowed value of a governed tag.. type Value struct { + // The value that can be assigned to the tag key. Values are case-sensitive. Name *string } diff --git a/uc/connections/CHANGELOG.md b/uc/connections/CHANGELOG.md index 1008e240..0680e992 100644 --- a/uc/connections/CHANGELOG.md +++ b/uc/connections/CHANGELOG.md @@ -1,5 +1,7 @@ # Version changelog +## Release v0.10.0 (2026-11-19) + ## Release v0.9.0 (2026-11-17) ## Release v0.8.0 (2026-11-12) diff --git a/uc/connections/internal/version.go b/uc/connections/internal/version.go index 2e46ef05..95499abb 100644 --- a/uc/connections/internal/version.go +++ b/uc/connections/internal/version.go @@ -2,4 +2,4 @@ package internal const ModuleName = "sdk-go-uc-connections" -const Version = "0.9.0" +const Version = "0.10.0" diff --git a/uc/connections/v1/client.go b/uc/connections/v1/client.go index 323cbdcf..0f81f0cc 100644 --- a/uc/connections/v1/client.go +++ b/uc/connections/v1/client.go @@ -204,7 +204,7 @@ func (c *internalClient) DeleteConnection(ctx context.Context, req DeleteConnect return resp, nil } -// Gets a connection from it's name. +// Gets a connection from its name. func (c *internalClient) GetConnection(ctx context.Context, req GetConnectionRequest, opts ...call.Option) (*ConnectionInfo, error) { headers := http.Header{} @@ -384,7 +384,9 @@ func (c *internalClient) ListConnectionsIter(ctx context.Context, req ListConnec } } -// Updates the connection that matches the supplied name. +// Updates the connection that matches the supplied name. When options are +// provided, they replace the existing options of the connection, so include +// every key that the connection type requires. func (c *internalClient) UpdateConnection(ctx context.Context, req UpdateConnectionRequest, opts ...call.Option) (*ConnectionInfo, error) { wireReq, err := updateConnectionRequestToWire(&req) if err != nil { diff --git a/uc/connections/v1/model.go b/uc/connections/v1/model.go index 5fecf6a8..58f18dda 100644 --- a/uc/connections/v1/model.go +++ b/uc/connections/v1/model.go @@ -111,22 +111,29 @@ const ( type ConnectionInfo struct { // Name of the connection. Name *string - // The type of connection. + // The type of external data source or service that the connection reaches. The + // connection type determines which keys are required in options and cannot be + // changed after creation. ConnectionType ConnectionType - // Username of current owner of the connection. + // Username of the current owner of the connection. The creator becomes the + // owner at creation, and ownership can be transferred on update. Owner *string - // If the connection is read only. + // Whether the connection is read only. All connections are currently read only, + // so a value set on create or update is ignored. ReadOnly *bool // User-provided free-form text description. Comment *string - // [Create,Update:OPT] Connection environment settings as EnvironmentSettings - // object. + // Environment settings for the connection, such as the Java libraries that it + // needs and the environment version. EnvironmentSettings *EnvironmentSettings // Full name of connection. FullName *string - // URL of the remote data source, extracted from options. + // URL of the remote data source. The server derives it from the host, port and + // path options. Url *string - // The type of credential. + // The type of credential that is used to authenticate to the external data + // source. The server derives it from the connection type and the keys present + // in options. CredentialType CredentialType // Unique identifier of the Connection. ConnectionId *string @@ -139,8 +146,10 @@ type ConnectionInfo struct { // Time at which this connection was updated, in epoch milliseconds. UpdatedAt *int64 // Username of user who last modified connection. - UpdatedBy *string - SecurableType SecurableType + UpdatedBy *string + // The type of Unity Catalog securable. This is always CONNECTION. + SecurableType SecurableType + // Provisioning status of the connection. ProvisioningInfo *ProvisioningInfo // A map of key-value properties attached to the securable. Options map[string]string @@ -158,22 +167,29 @@ type CreateConnectionRequest struct { Parent *string // Name of the connection. Name *string - // The type of connection. + // The type of external data source or service that the connection reaches. The + // connection type determines which keys are required in options and cannot be + // changed after creation. ConnectionType ConnectionType - // Username of current owner of the connection. + // Username of the current owner of the connection. The creator becomes the + // owner at creation, and ownership can be transferred on update. Owner *string - // If the connection is read only. + // Whether the connection is read only. All connections are currently read only, + // so a value set on create or update is ignored. ReadOnly *bool // User-provided free-form text description. Comment *string - // [Create,Update:OPT] Connection environment settings as EnvironmentSettings - // object. + // Environment settings for the connection, such as the Java libraries that it + // needs and the environment version. EnvironmentSettings *EnvironmentSettings // Full name of connection. FullName *string - // URL of the remote data source, extracted from options. + // URL of the remote data source. The server derives it from the host, port and + // path options. Url *string - // The type of credential. + // The type of credential that is used to authenticate to the external data + // source. The server derives it from the connection type and the keys present + // in options. CredentialType CredentialType // Unique identifier of the Connection. ConnectionId *string @@ -186,8 +202,10 @@ type CreateConnectionRequest struct { // Time at which this connection was updated, in epoch milliseconds. UpdatedAt *int64 // Username of user who last modified connection. - UpdatedBy *string - SecurableType SecurableType + UpdatedBy *string + // The type of Unity Catalog securable. This is always CONNECTION. + SecurableType SecurableType + // Provisioning status of the connection. ProvisioningInfo *ProvisioningInfo // A map of key-value properties attached to the securable. Options map[string]string @@ -253,22 +271,29 @@ type UpdateConnectionRequest struct { NewName *string // Name of the connection. Name *string - // The type of connection. + // The type of external data source or service that the connection reaches. The + // connection type determines which keys are required in options and cannot be + // changed after creation. ConnectionType ConnectionType - // Username of current owner of the connection. + // Username of the current owner of the connection. The creator becomes the + // owner at creation, and ownership can be transferred on update. Owner *string - // If the connection is read only. + // Whether the connection is read only. All connections are currently read only, + // so a value set on create or update is ignored. ReadOnly *bool // User-provided free-form text description. Comment *string - // [Create,Update:OPT] Connection environment settings as EnvironmentSettings - // object. + // Environment settings for the connection, such as the Java libraries that it + // needs and the environment version. EnvironmentSettings *EnvironmentSettings // Full name of connection. FullName *string - // URL of the remote data source, extracted from options. + // URL of the remote data source. The server derives it from the host, port and + // path options. Url *string - // The type of credential. + // The type of credential that is used to authenticate to the external data + // source. The server derives it from the connection type and the keys present + // in options. CredentialType CredentialType // Unique identifier of the Connection. ConnectionId *string @@ -281,8 +306,10 @@ type UpdateConnectionRequest struct { // Time at which this connection was updated, in epoch milliseconds. UpdatedAt *int64 // Username of user who last modified connection. - UpdatedBy *string - SecurableType SecurableType + UpdatedBy *string + // The type of Unity Catalog securable. This is always CONNECTION. + SecurableType SecurableType + // Provisioning status of the connection. ProvisioningInfo *ProvisioningInfo // A map of key-value properties attached to the securable. Options map[string]string diff --git a/uc/credentials/CHANGELOG.md b/uc/credentials/CHANGELOG.md index 3e123922..759418b1 100644 --- a/uc/credentials/CHANGELOG.md +++ b/uc/credentials/CHANGELOG.md @@ -1,5 +1,7 @@ # Version changelog +## Release v0.9.0 (2026-11-19) + ## Release v0.8.0 (2026-11-16) ## Release v0.7.0 (2026-11-12) diff --git a/uc/credentials/internal/version.go b/uc/credentials/internal/version.go index a1d8634d..4baadd5a 100644 --- a/uc/credentials/internal/version.go +++ b/uc/credentials/internal/version.go @@ -2,4 +2,4 @@ package internal const ModuleName = "sdk-go-uc-credentials" -const Version = "0.8.0" +const Version = "0.9.0" diff --git a/uc/credentials/v1/client.go b/uc/credentials/v1/client.go index 9b103b59..dabf33a2 100644 --- a/uc/credentials/v1/client.go +++ b/uc/credentials/v1/client.go @@ -801,8 +801,8 @@ func (c *internalClient) GenerateTemporaryPathCredential(ctx context.Context, re } // Returns a set of temporary credentials generated using the specified service -// credential. The caller must be a metastore admin or have the metastore -// privilege **ACCESS** on the service credential. +// credential. The caller must be a metastore admin or have the **ACCESS** +// privilege on the service credential. func (c *internalClient) GenerateTemporaryServiceCredential(ctx context.Context, req GenerateTemporaryServiceCredentialRequest, opts ...call.Option) (*TemporaryCredentials, error) { wireReq, err := generateTemporaryServiceCredentialRequestToWire(&req) if err != nil { diff --git a/uc/credentials/v1/model.go b/uc/credentials/v1/model.go index cc0202af..a1e92bc1 100644 --- a/uc/credentials/v1/model.go +++ b/uc/credentials/v1/model.go @@ -734,6 +734,7 @@ type DeleteStorageCredentialResponse struct { // GCP temporary credentials for API authentication. Read more at // https://developers.google.com/identity/protocols/oauth2/service-account. type GcpOauthToken struct { + // The OAuth 2.0 access token to pass as a bearer token to Google Cloud APIs. OauthToken *string } @@ -774,6 +775,7 @@ type isGenerateTemporaryPathCredentialResponse_Credentials interface { } // GenerateTemporaryPathCredentialResponse_Credentials_AwsTempCredentials selects AwsTempCredentials for GenerateTemporaryPathCredentialResponse.Credentials. +// Temporary AWS credentials that can be used to sign AWS API requests. type GenerateTemporaryPathCredentialResponse_Credentials_AwsTempCredentials struct { AwsTempCredentials TemporaryAwsCredentials } @@ -782,6 +784,8 @@ func (*GenerateTemporaryPathCredentialResponse_Credentials_AwsTempCredentials) i } // GenerateTemporaryPathCredentialResponse_Credentials_AzureUserDelegationSas selects AzureUserDelegationSas for GenerateTemporaryPathCredentialResponse.Credentials. +// An Azure user delegation shared access signature (SAS) that grants access to +// the requested storage path. type GenerateTemporaryPathCredentialResponse_Credentials_AzureUserDelegationSas struct { AzureUserDelegationSas AzureUserDelegationSas } @@ -790,6 +794,8 @@ func (*GenerateTemporaryPathCredentialResponse_Credentials_AzureUserDelegationSa } // GenerateTemporaryPathCredentialResponse_Credentials_GcpOauthToken selects GcpOauthToken for GenerateTemporaryPathCredentialResponse.Credentials. +// A GCP OAuth 2.0 access token that is issued for the credential's service +// account. type GenerateTemporaryPathCredentialResponse_Credentials_GcpOauthToken struct { GcpOauthToken GcpOauthToken } @@ -798,6 +804,8 @@ func (*GenerateTemporaryPathCredentialResponse_Credentials_GcpOauthToken) isGene } // GenerateTemporaryPathCredentialResponse_Credentials_AzureAad selects AzureAad for GenerateTemporaryPathCredentialResponse.Credentials. +// A Microsoft Entra ID (formerly Azure Active Directory) token that is issued +// for the credential's identity. type GenerateTemporaryPathCredentialResponse_Credentials_AzureAad struct { AzureAad AzureActiveDirectoryToken } @@ -806,6 +814,8 @@ func (*GenerateTemporaryPathCredentialResponse_Credentials_AzureAad) isGenerateT } // GenerateTemporaryPathCredentialResponse_Credentials_R2TempCredentials selects R2TempCredentials for GenerateTemporaryPathCredentialResponse.Credentials. +// Temporary Cloudflare R2 credentials that can be used with the R2 +// S3-compatible API. type GenerateTemporaryPathCredentialResponse_Credentials_R2TempCredentials struct { R2TempCredentials R2Credentials } @@ -824,6 +834,8 @@ type isGenerateTemporaryServiceCredentialRequest_Options interface { } // GenerateTemporaryServiceCredentialRequest_Options_AzureOptions selects AzureOptions for GenerateTemporaryServiceCredentialRequest.Options. +// Options for an Azure service credential. They are required when the service +// credential uses an Azure managed identity. type GenerateTemporaryServiceCredentialRequest_Options_AzureOptions struct { AzureOptions GenerateTemporaryServiceCredentialRequest_AzureOptions } @@ -832,6 +844,8 @@ func (*GenerateTemporaryServiceCredentialRequest_Options_AzureOptions) isGenerat } // GenerateTemporaryServiceCredentialRequest_Options_GcpOptions selects GcpOptions for GenerateTemporaryServiceCredentialRequest.Options. +// Options for a GCP service credential. They are required when the service +// credential uses a -managed GCP service account. type GenerateTemporaryServiceCredentialRequest_Options_GcpOptions struct { GcpOptions GenerateTemporaryServiceCredentialRequest_GcpOptions } @@ -843,7 +857,9 @@ func (*GenerateTemporaryServiceCredentialRequest_Options_GcpOptions) isGenerateT type GenerateTemporaryServiceCredentialRequest_AzureOptions struct { // The resources to which the temporary Azure credential should apply. These // resources are the scopes that are passed to the token provider (see - // https://learn.microsoft.com/python/api/azure-core/azure.core.credentials.tokencredential?view=azure-python) + // https://learn.microsoft.com/python/api/azure-core/azure.core.credentials.tokencredential?view=azure-python). + // Exactly one resource is supported, and its URL must end with the `.default` + // scope. Resources []string } @@ -851,7 +867,9 @@ type GenerateTemporaryServiceCredentialRequest_AzureOptions struct { type GenerateTemporaryServiceCredentialRequest_GcpOptions struct { // The scopes to which the temporary GCP credential should apply. These // resources are the scopes that are passed to the token provider (see - // https://google-auth.readthedocs.io/en/latest/reference/google.auth.html#google.auth.credentials.Credentials) + // https://google-auth.readthedocs.io/en/latest/reference/google.auth.html#google.auth.credentials.Credentials). + // Each scope must be a Google OAuth 2.0 scope URL on the `googleapis.com` or + // `www.googleapis.com` host. Scopes []string } @@ -879,6 +897,7 @@ type isGenerateTemporaryTableCredentialResponse_Credentials interface { } // GenerateTemporaryTableCredentialResponse_Credentials_AwsTempCredentials selects AwsTempCredentials for GenerateTemporaryTableCredentialResponse.Credentials. +// Temporary AWS credentials that can be used to sign AWS API requests. type GenerateTemporaryTableCredentialResponse_Credentials_AwsTempCredentials struct { AwsTempCredentials TemporaryAwsCredentials } @@ -887,6 +906,8 @@ func (*GenerateTemporaryTableCredentialResponse_Credentials_AwsTempCredentials) } // GenerateTemporaryTableCredentialResponse_Credentials_AzureUserDelegationSas selects AzureUserDelegationSas for GenerateTemporaryTableCredentialResponse.Credentials. +// An Azure user delegation shared access signature (SAS) that grants access to +// the requested storage path. type GenerateTemporaryTableCredentialResponse_Credentials_AzureUserDelegationSas struct { AzureUserDelegationSas AzureUserDelegationSas } @@ -895,6 +916,8 @@ func (*GenerateTemporaryTableCredentialResponse_Credentials_AzureUserDelegationS } // GenerateTemporaryTableCredentialResponse_Credentials_GcpOauthToken selects GcpOauthToken for GenerateTemporaryTableCredentialResponse.Credentials. +// A GCP OAuth 2.0 access token that is issued for the credential's service +// account. type GenerateTemporaryTableCredentialResponse_Credentials_GcpOauthToken struct { GcpOauthToken GcpOauthToken } @@ -903,6 +926,8 @@ func (*GenerateTemporaryTableCredentialResponse_Credentials_GcpOauthToken) isGen } // GenerateTemporaryTableCredentialResponse_Credentials_AzureAad selects AzureAad for GenerateTemporaryTableCredentialResponse.Credentials. +// A Microsoft Entra ID (formerly Azure Active Directory) token that is issued +// for the credential's identity. type GenerateTemporaryTableCredentialResponse_Credentials_AzureAad struct { AzureAad AzureActiveDirectoryToken } @@ -911,6 +936,8 @@ func (*GenerateTemporaryTableCredentialResponse_Credentials_AzureAad) isGenerate } // GenerateTemporaryTableCredentialResponse_Credentials_R2TempCredentials selects R2TempCredentials for GenerateTemporaryTableCredentialResponse.Credentials. +// Temporary Cloudflare R2 credentials that can be used with the R2 +// S3-compatible API. type GenerateTemporaryTableCredentialResponse_Credentials_R2TempCredentials struct { R2TempCredentials R2Credentials } @@ -943,6 +970,7 @@ type isGenerateTemporaryVolumeCredentialResponse_Credentials interface { } // GenerateTemporaryVolumeCredentialResponse_Credentials_AwsTempCredentials selects AwsTempCredentials for GenerateTemporaryVolumeCredentialResponse.Credentials. +// Temporary AWS credentials that can be used to sign AWS API requests. type GenerateTemporaryVolumeCredentialResponse_Credentials_AwsTempCredentials struct { AwsTempCredentials TemporaryAwsCredentials } @@ -951,6 +979,8 @@ func (*GenerateTemporaryVolumeCredentialResponse_Credentials_AwsTempCredentials) } // GenerateTemporaryVolumeCredentialResponse_Credentials_AzureUserDelegationSas selects AzureUserDelegationSas for GenerateTemporaryVolumeCredentialResponse.Credentials. +// An Azure user delegation shared access signature (SAS) that grants access to +// the requested storage path. type GenerateTemporaryVolumeCredentialResponse_Credentials_AzureUserDelegationSas struct { AzureUserDelegationSas AzureUserDelegationSas } @@ -959,6 +989,8 @@ func (*GenerateTemporaryVolumeCredentialResponse_Credentials_AzureUserDelegation } // GenerateTemporaryVolumeCredentialResponse_Credentials_GcpOauthToken selects GcpOauthToken for GenerateTemporaryVolumeCredentialResponse.Credentials. +// A GCP OAuth 2.0 access token that is issued for the credential's service +// account. type GenerateTemporaryVolumeCredentialResponse_Credentials_GcpOauthToken struct { GcpOauthToken GcpOauthToken } @@ -967,6 +999,8 @@ func (*GenerateTemporaryVolumeCredentialResponse_Credentials_GcpOauthToken) isGe } // GenerateTemporaryVolumeCredentialResponse_Credentials_AzureAad selects AzureAad for GenerateTemporaryVolumeCredentialResponse.Credentials. +// A Microsoft Entra ID (formerly Azure Active Directory) token that is issued +// for the credential's identity. type GenerateTemporaryVolumeCredentialResponse_Credentials_AzureAad struct { AzureAad AzureActiveDirectoryToken } @@ -975,6 +1009,8 @@ func (*GenerateTemporaryVolumeCredentialResponse_Credentials_AzureAad) isGenerat } // GenerateTemporaryVolumeCredentialResponse_Credentials_R2TempCredentials selects R2TempCredentials for GenerateTemporaryVolumeCredentialResponse.Credentials. +// Temporary Cloudflare R2 credentials that can be used with the R2 +// S3-compatible API. type GenerateTemporaryVolumeCredentialResponse_Credentials_R2TempCredentials struct { R2TempCredentials R2Credentials } @@ -1194,6 +1230,7 @@ type isTemporaryCredentials_Credentials interface { } // TemporaryCredentials_Credentials_AwsTempCredentials selects AwsTempCredentials for TemporaryCredentials.Credentials. +// Temporary AWS credentials that can be used to sign AWS API requests. type TemporaryCredentials_Credentials_AwsTempCredentials struct { AwsTempCredentials TemporaryAwsCredentials } @@ -1201,6 +1238,8 @@ type TemporaryCredentials_Credentials_AwsTempCredentials struct { func (*TemporaryCredentials_Credentials_AwsTempCredentials) isTemporaryCredentials_Credentials() {} // TemporaryCredentials_Credentials_AzureUserDelegationSas selects AzureUserDelegationSas for TemporaryCredentials.Credentials. +// An Azure user delegation shared access signature (SAS) that grants access to +// the requested storage path. type TemporaryCredentials_Credentials_AzureUserDelegationSas struct { AzureUserDelegationSas AzureUserDelegationSas } @@ -1209,6 +1248,8 @@ func (*TemporaryCredentials_Credentials_AzureUserDelegationSas) isTemporaryCrede } // TemporaryCredentials_Credentials_GcpOauthToken selects GcpOauthToken for TemporaryCredentials.Credentials. +// A GCP OAuth 2.0 access token that is issued for the credential's service +// account. type TemporaryCredentials_Credentials_GcpOauthToken struct { GcpOauthToken GcpOauthToken } @@ -1216,6 +1257,8 @@ type TemporaryCredentials_Credentials_GcpOauthToken struct { func (*TemporaryCredentials_Credentials_GcpOauthToken) isTemporaryCredentials_Credentials() {} // TemporaryCredentials_Credentials_AzureAad selects AzureAad for TemporaryCredentials.Credentials. +// A Microsoft Entra ID (formerly Azure Active Directory) token that is issued +// for the credential's identity. type TemporaryCredentials_Credentials_AzureAad struct { AzureAad AzureActiveDirectoryToken } @@ -1223,6 +1266,8 @@ type TemporaryCredentials_Credentials_AzureAad struct { func (*TemporaryCredentials_Credentials_AzureAad) isTemporaryCredentials_Credentials() {} // TemporaryCredentials_Credentials_R2TempCredentials selects R2TempCredentials for TemporaryCredentials.Credentials. +// Temporary Cloudflare R2 credentials that can be used with the R2 +// S3-compatible API. type TemporaryCredentials_Credentials_R2TempCredentials struct { R2TempCredentials R2Credentials } diff --git a/uc/functions/CHANGELOG.md b/uc/functions/CHANGELOG.md index 343b52e7..7615a4a7 100644 --- a/uc/functions/CHANGELOG.md +++ b/uc/functions/CHANGELOG.md @@ -1,5 +1,7 @@ # Version changelog +## Release v0.7.0 (2026-11-19) + ## Release v0.6.0 (2026-11-12) ### New Features and Improvements diff --git a/uc/functions/internal/version.go b/uc/functions/internal/version.go index 4567cff6..99fa52ea 100644 --- a/uc/functions/internal/version.go +++ b/uc/functions/internal/version.go @@ -2,4 +2,4 @@ package internal const ModuleName = "sdk-go-uc-functions" -const Version = "0.6.0" +const Version = "0.7.0" diff --git a/uc/functions/v1/model.go b/uc/functions/v1/model.go index 8cd41cf4..78105f1a 100644 --- a/uc/functions/v1/model.go +++ b/uc/functions/v1/model.go @@ -60,9 +60,9 @@ const ( FunctionInfo_RoutineBody_Unspecified FunctionInfo_RoutineBody = "" FunctionInfo_RoutineBody_Sql FunctionInfo_RoutineBody = "SQL" // When `EXTERNAL` is used, * The language of the routine function should be - // specified in the `external_language` field. * The returnParams of the - // function cannot be used as TABLE return type is not supported. * The - // getSqlDataAccess must be NO_SQL. + // specified in the `external_language` field. * The TABLE return type, and so + // return_params, is supported only when external_language is Python. * The + // `sql_data_access` field must be `NO_SQL`. FunctionInfo_RoutineBody_External FunctionInfo_RoutineBody = "EXTERNAL" ) @@ -88,6 +88,11 @@ type ConnectionDependency struct { ConnectionName *string } +// A user-defined function (UDF) registered in Unity Catalog. A function belongs +// to a schema and is referenced as catalog_name.schema_name.function_name. Its +// body is either a SQL expression or query, or source code in an external +// language such as Python. See +// https://docs.databricks.com/aws/en/udf/unity-catalog for an overview.. type CreateFunction struct { // Name of function, relative to parent schema. Name *string @@ -95,38 +100,53 @@ type CreateFunction struct { CatalogName *string // Name of parent Schema relative to its parent Catalog. SchemaName *string - // Function input parameters. + // Input parameters of the function. When it is set, parameters must contain at + // least one entry. A function that takes no arguments omits input_params, even + // though the Create request schema marks it as required. InputParams *FunctionParameterInfos - // Scalar function return data type. + // Data type of the value the function returns. A table function uses TABLE_TYPE + // and describes its result columns in return_params, except for a polymorphic + // Python UDTF, which omits them. DataType ColumnTypeName - // Pretty printed function data type. + // Return data type of the function in SQL syntax, including any type parameters + // such as precision and scale. FullDataType *string - // Function language. When **EXTERNAL** is used, the language of the routine - // function should be specified in the **external_language** field, and the - // **return_params** of the function cannot be used (as **TABLE** return type is - // not supported), and the **sql_data_access** field must be **NO_SQL**. + // Language of the function body. SQL means that routine_definition holds a SQL + // expression or query. EXTERNAL means that it holds source code in the language + // named by external_language, and sql_data_access must then be NO_SQL. RoutineBody FunctionInfo_RoutineBody - // Function body. + // Body of the function. For a SQL function it is the expression or query that + // computes the result; for an EXTERNAL function it is the source code of the + // function. It is omitted when the caller can only browse the function. RoutineDefinition *string - // Function parameter style. **S** is the value for SQL. + // How arguments are passed to the function body. S means that each argument is + // passed as a single scalar value. ParameterStyle FunctionInfo_ParameterStyle - // Whether the function is deterministic. + // Whether the function returns the same result for the same arguments. It + // corresponds to the DETERMINISTIC characteristic of CREATE FUNCTION. IsDeterministic *bool - // Function SQL data access. + // How the function body interacts with SQL data. CONTAINS_SQL means that the + // body contains SQL but reads no table or view, READS_SQL_DATA means that it + // reads a table or view, and NO_SQL is required for EXTERNAL functions. SqlDataAccess FunctionInfo_SqlDataAccess - // Function null call. + // Whether the function is a null-call function in the sense of the SQL + // standard, which returns NULL whenever any argument is NULL. IsNullCall *bool - // Function security type. + // Whose privileges the function body runs with. DEFINER runs it with the + // privileges of the function owner. SecurityType FunctionInfo_SecurityType - // Specific name of the function; Reserved for future use. + // Specific name of the function. Set it to the same value as name. SpecificName *string - // Table function return parameters. + // Result columns of a table function. Set it when data_type is TABLE_TYPE, + // except for a polymorphic Python UDTF (an EXTERNAL Python function with + // full_data_type "()"), which must not set it. ReturnParams *FunctionParameterInfos - // External function name. + // Name of the function in its external language. It is reserved for future use. ExternalName *string - // External function language. + // Language of the function body for an EXTERNAL function. It is required when + // routine_body is EXTERNAL. ExternalLanguage *string - // List of schemes whose objects can be referenced without qualification. + // List of schemas whose objects can be referenced without qualification. SqlPath *string // Username of current owner of the function. Owner *string @@ -171,9 +191,9 @@ type CredentialDependency struct { type DeleteFunctionRequest struct { // The fully-qualified name of the function (of the form - // __catalog_name__.__schema_name__.__function__name__) . + // __catalog_name__.__schema_name__.__function_name__). FullNameArg *string - // Force deletion even if the function is notempty. + // Force deletion even if the function is not empty. Force *bool } @@ -232,6 +252,11 @@ type FunctionDependency struct { FunctionFullName *string } +// A user-defined function (UDF) registered in Unity Catalog. A function belongs +// to a schema and is referenced as catalog_name.schema_name.function_name. Its +// body is either a SQL expression or query, or source code in an external +// language such as Python. See +// https://docs.databricks.com/aws/en/udf/unity-catalog for an overview.. type FunctionInfo struct { // Name of function, relative to parent schema. Name *string @@ -239,38 +264,53 @@ type FunctionInfo struct { CatalogName *string // Name of parent Schema relative to its parent Catalog. SchemaName *string - // Function input parameters. + // Input parameters of the function. When it is set, parameters must contain at + // least one entry. A function that takes no arguments omits input_params, even + // though the Create request schema marks it as required. InputParams *FunctionParameterInfos - // Scalar function return data type. + // Data type of the value the function returns. A table function uses TABLE_TYPE + // and describes its result columns in return_params, except for a polymorphic + // Python UDTF, which omits them. DataType ColumnTypeName - // Pretty printed function data type. + // Return data type of the function in SQL syntax, including any type parameters + // such as precision and scale. FullDataType *string - // Function language. When **EXTERNAL** is used, the language of the routine - // function should be specified in the **external_language** field, and the - // **return_params** of the function cannot be used (as **TABLE** return type is - // not supported), and the **sql_data_access** field must be **NO_SQL**. + // Language of the function body. SQL means that routine_definition holds a SQL + // expression or query. EXTERNAL means that it holds source code in the language + // named by external_language, and sql_data_access must then be NO_SQL. RoutineBody FunctionInfo_RoutineBody - // Function body. + // Body of the function. For a SQL function it is the expression or query that + // computes the result; for an EXTERNAL function it is the source code of the + // function. It is omitted when the caller can only browse the function. RoutineDefinition *string - // Function parameter style. **S** is the value for SQL. + // How arguments are passed to the function body. S means that each argument is + // passed as a single scalar value. ParameterStyle FunctionInfo_ParameterStyle - // Whether the function is deterministic. + // Whether the function returns the same result for the same arguments. It + // corresponds to the DETERMINISTIC characteristic of CREATE FUNCTION. IsDeterministic *bool - // Function SQL data access. + // How the function body interacts with SQL data. CONTAINS_SQL means that the + // body contains SQL but reads no table or view, READS_SQL_DATA means that it + // reads a table or view, and NO_SQL is required for EXTERNAL functions. SqlDataAccess FunctionInfo_SqlDataAccess - // Function null call. + // Whether the function is a null-call function in the sense of the SQL + // standard, which returns NULL whenever any argument is NULL. IsNullCall *bool - // Function security type. + // Whose privileges the function body runs with. DEFINER runs it with the + // privileges of the function owner. SecurityType FunctionInfo_SecurityType - // Specific name of the function; Reserved for future use. + // Specific name of the function. Set it to the same value as name. SpecificName *string - // Table function return parameters. + // Result columns of a table function. Set it when data_type is TABLE_TYPE, + // except for a polymorphic Python UDTF (an EXTERNAL Python function with + // full_data_type "()"), which must not set it. ReturnParams *FunctionParameterInfos - // External function name. + // Name of the function in its external language. It is reserved for future use. ExternalName *string - // External function language. + // Language of the function body for an EXTERNAL function. It is required when + // routine_body is EXTERNAL. ExternalLanguage *string - // List of schemes whose objects can be referenced without qualification. + // List of schemas whose objects can be referenced without qualification. SqlPath *string // Username of current owner of the function. Owner *string @@ -305,9 +345,11 @@ type FunctionInfo struct { type FunctionParameterInfo struct { // Name of Parameter. Name *string - // Full data type spec, SQL/catalogString text. + // Data type of the parameter in SQL syntax, including any type parameters such + // as precision and scale. TypeText *string - // Full data type spec, JSON-serialized. + // Data type of the parameter as the JSON representation of a Spark SQL struct + // field, with name, type, nullable and metadata keys. TypeJson *string // Name of type (INT, STRUCT, MAP, etc.) TypeName ColumnTypeName @@ -315,27 +357,33 @@ type FunctionParameterInfo struct { TypePrecision *int // Digits to right of decimal; Required on Create for DecimalTypes. TypeScale *int - // Format of IntervalType. + // Unit range of the data type for INTERVAL parameters. It is unset for other + // types. TypeIntervalType *string - // Ordinal position of column (starting at position 0). + // Zero-based position of the parameter in the parameter list. Positions must be + // unique and consecutive. Position *int - // Function parameter mode. + // Direction of the parameter. Only IN parameters, which pass a value into the + // function, are supported. ParameterMode FunctionParameterMode - // Function parameter type. + // Whether the entry is an input parameter (PARAM) or a result column of a table + // function (COLUMN). ParameterType FunctionParameterType - // Default value of the parameter. + // Default value of the parameter as a SQL expression, used when a call omits + // the argument. ParameterDefault *string // User-provided free-form text description. Comment *string } type FunctionParameterInfos struct { + // The parameters that make up the list, ordered by position. Parameters []FunctionParameterInfo } type GetFunctionRequest struct { // The fully-qualified name of the function (of the form - // __catalog_name__.__schema_name__.__function__name__). + // __catalog_name__.__schema_name__.__function_name__). FullNameArg *string // Whether to include functions in the response for which the principal can only // access selective metadata for @@ -378,7 +426,7 @@ type TableDependency struct { type UpdateFunctionRequest struct { // The fully-qualified name of the function (of the form - // __catalog_name__.__schema_name__.__function__name__). + // __catalog_name__.__schema_name__.__function_name__). FullNameArg *string // Name of function, relative to parent schema. Name *string @@ -386,38 +434,53 @@ type UpdateFunctionRequest struct { CatalogName *string // Name of parent Schema relative to its parent Catalog. SchemaName *string - // Function input parameters. + // Input parameters of the function. When it is set, parameters must contain at + // least one entry. A function that takes no arguments omits input_params, even + // though the Create request schema marks it as required. InputParams *FunctionParameterInfos - // Scalar function return data type. + // Data type of the value the function returns. A table function uses TABLE_TYPE + // and describes its result columns in return_params, except for a polymorphic + // Python UDTF, which omits them. DataType ColumnTypeName - // Pretty printed function data type. + // Return data type of the function in SQL syntax, including any type parameters + // such as precision and scale. FullDataType *string - // Function language. When **EXTERNAL** is used, the language of the routine - // function should be specified in the **external_language** field, and the - // **return_params** of the function cannot be used (as **TABLE** return type is - // not supported), and the **sql_data_access** field must be **NO_SQL**. + // Language of the function body. SQL means that routine_definition holds a SQL + // expression or query. EXTERNAL means that it holds source code in the language + // named by external_language, and sql_data_access must then be NO_SQL. RoutineBody FunctionInfo_RoutineBody - // Function body. + // Body of the function. For a SQL function it is the expression or query that + // computes the result; for an EXTERNAL function it is the source code of the + // function. It is omitted when the caller can only browse the function. RoutineDefinition *string - // Function parameter style. **S** is the value for SQL. + // How arguments are passed to the function body. S means that each argument is + // passed as a single scalar value. ParameterStyle FunctionInfo_ParameterStyle - // Whether the function is deterministic. + // Whether the function returns the same result for the same arguments. It + // corresponds to the DETERMINISTIC characteristic of CREATE FUNCTION. IsDeterministic *bool - // Function SQL data access. + // How the function body interacts with SQL data. CONTAINS_SQL means that the + // body contains SQL but reads no table or view, READS_SQL_DATA means that it + // reads a table or view, and NO_SQL is required for EXTERNAL functions. SqlDataAccess FunctionInfo_SqlDataAccess - // Function null call. + // Whether the function is a null-call function in the sense of the SQL + // standard, which returns NULL whenever any argument is NULL. IsNullCall *bool - // Function security type. + // Whose privileges the function body runs with. DEFINER runs it with the + // privileges of the function owner. SecurityType FunctionInfo_SecurityType - // Specific name of the function; Reserved for future use. + // Specific name of the function. Set it to the same value as name. SpecificName *string - // Table function return parameters. + // Result columns of a table function. Set it when data_type is TABLE_TYPE, + // except for a polymorphic Python UDTF (an EXTERNAL Python function with + // full_data_type "()"), which must not set it. ReturnParams *FunctionParameterInfos - // External function name. + // Name of the function in its external language. It is reserved for future use. ExternalName *string - // External function language. + // Language of the function body for an EXTERNAL function. It is required when + // routine_body is EXTERNAL. ExternalLanguage *string - // List of schemes whose objects can be referenced without qualification. + // List of schemas whose objects can be referenced without qualification. SqlPath *string // Username of current owner of the function. Owner *string diff --git a/usagedashboards/CHANGELOG.md b/usagedashboards/CHANGELOG.md index 343b52e7..7615a4a7 100644 --- a/usagedashboards/CHANGELOG.md +++ b/usagedashboards/CHANGELOG.md @@ -1,5 +1,7 @@ # Version changelog +## Release v0.7.0 (2026-11-19) + ## Release v0.6.0 (2026-11-12) ### New Features and Improvements diff --git a/usagedashboards/internal/version.go b/usagedashboards/internal/version.go index 6ab431dc..0d34d5f7 100644 --- a/usagedashboards/internal/version.go +++ b/usagedashboards/internal/version.go @@ -2,4 +2,4 @@ package internal const ModuleName = "sdk-go-usagedashboards" -const Version = "0.6.0" +const Version = "0.7.0" diff --git a/usagedashboards/v1/client.go b/usagedashboards/v1/client.go index ebb5df6d..2190bcad 100644 --- a/usagedashboards/v1/client.go +++ b/usagedashboards/v1/client.go @@ -76,8 +76,11 @@ func NewClient(ctx context.Context, opts ...client.Option) (*Client, error) { }, nil } -// Create a usage dashboard specified by workspaceId, accountId, and dashboard -// type. +// Imports a pre-built usage dashboard of the given type into a workspace. Each +// call imports a new dashboard, even if the caller already created one of the +// same type in that workspace. The caller must be an account admin and a user +// of the target workspace. See +// https://docs.databricks.com/admin/account-settings/usage.html. // Account-level method. Uses the Client's accountID, overridable per call via req.AccountId. func (c *internalClient) CreateBillingUsageDashboard(ctx context.Context, req CreateBillingUsageDashboardRequest, opts ...call.Option) (*CreateBillingUsageDashboardResponse, error) { wireReq, err := createBillingUsageDashboardRequestToWire(&req) @@ -149,8 +152,9 @@ func (c *internalClient) CreateBillingUsageDashboard(ctx context.Context, req Cr return resp, nil } -// Get a usage dashboard specified by workspaceId, accountId, and dashboard -// type. +// Gets the most recent usage dashboard of the given type that the caller +// created. The response is empty if no such dashboard exists, if it has been +// deleted, or if the caller can no longer access its workspace. // Account-level method. Uses the Client's accountID, overridable per call via req.AccountId. func (c *internalClient) GetBillingUsageDashboard(ctx context.Context, req GetBillingUsageDashboardRequest, opts ...call.Option) (*GetBillingUsageDashboardResponse, error) { wireReq, err := getBillingUsageDashboardRequestToWire(&req) diff --git a/usagedashboards/v1/model.go b/usagedashboards/v1/model.go index 76fbb337..b95823ae 100644 --- a/usagedashboards/v1/model.go +++ b/usagedashboards/v1/model.go @@ -19,38 +19,44 @@ const ( ) type CreateBillingUsageDashboardRequest struct { - // The workspace ID of the workspace in which the usage dashboard is created. + // The ID of the workspace to import the usage dashboard into. The workspace + // must be running, belong to the account, and not be a disaster recovery + // secondary. WorkspaceId *int64 // account ID. AccountId *string // Workspace level usage dashboard shows usage data for the specified workspace // ID. Global level usage dashboard shows usage data for all workspaces in the - // account. + // account. The request fails if the type is not set. DashboardType UsageDashboardType - // The major version of the usage dashboard template to use. Defaults to - // VERSION_1. + // The major version of the usage dashboard template to import. Version 2 adds + // cost forecasting and object-level cost drill-down. MajorVersion UsageDashboardMajorVersion } type CreateBillingUsageDashboardResponse struct { - // The unique id of the usage dashboard. + // The ID of the AI/BI dashboard that was created. DashboardId *string } type GetBillingUsageDashboardRequest struct { - // The workspace ID of the workspace in which the usage dashboard is created. + // The ID of the workspace that contains the usage dashboard. If omitted, the + // most recently created dashboard of the given type across all workspaces in + // the account is returned. WorkspaceId *int64 // account ID. AccountId *string // Workspace level usage dashboard shows usage data for the specified workspace // ID. Global level usage dashboard shows usage data for all workspaces in the - // account. + // account. The request fails if the type is not set. DashboardType UsageDashboardType } type GetBillingUsageDashboardResponse struct { - // The unique id of the usage dashboard. + // The ID of the AI/BI dashboard. The ID is empty if no matching dashboard is + // found. DashboardId *string - // The URL of the usage dashboard. + // The URL of the dashboard in its workspace. The URL is empty if no matching + // dashboard is found. DashboardUrl *string } diff --git a/warehouses/CHANGELOG.md b/warehouses/CHANGELOG.md index 917e4106..94d265cb 100644 --- a/warehouses/CHANGELOG.md +++ b/warehouses/CHANGELOG.md @@ -1,5 +1,7 @@ # Version changelog +## Release v0.12.0 (2026-11-19) + ## Release v0.11.0 (2026-11-17) ## Release v0.10.0 (2026-11-12) diff --git a/warehouses/internal/version.go b/warehouses/internal/version.go index 2f3d0df7..a51ff3b6 100644 --- a/warehouses/internal/version.go +++ b/warehouses/internal/version.go @@ -2,4 +2,4 @@ package internal const ModuleName = "sdk-go-warehouses" -const Version = "0.11.0" +const Version = "0.12.0" diff --git a/warehouses/v1/model.go b/warehouses/v1/model.go index 998125ab..4e960ed0 100644 --- a/warehouses/v1/model.go +++ b/warehouses/v1/model.go @@ -636,7 +636,11 @@ const ( // Configures the channel name and DBSQL version of the warehouse. // CHANNEL_NAME_CUSTOM should be chosen only when `dbsql_version` is specified.. type Channel struct { - Name ChannelName + // Channel to follow. CHANNEL_NAME_CURRENT is the default, and + // CHANNEL_NAME_PREVIEW carries the upcoming Databricks SQL release for testing. + Name ChannelName + // Databricks SQL version to pin to. Set it if and only if name is + // CHANNEL_NAME_CUSTOM. DbsqlVersion *string } @@ -652,9 +656,9 @@ type CreateDefaultWarehouseOverrideRequest struct { // Creates a new SQL warehouse.. type CreateWarehouseRequest struct { - // Logical name for the cluster. + // Logical name for the warehouse. // - // Supported values: - Must be unique within an org. - Must be less than 100 + // Supported values: - Must be unique within an org. - Must be 1 to 100 // characters. Name *string // Size of the clusters allocated for this warehouse. Increasing the size of a @@ -689,7 +693,8 @@ type CreateWarehouseRequest struct { // // Defaults to 120 mins AutoStopMins *int - // warehouse creator name + // Name of the user who created the warehouse. Set by the server and ignored in + // requests. CreatorName *string // Deprecated. Instance profile used to pass IAM role to the cluster InstanceProfileArn *string @@ -698,13 +703,15 @@ type CreateWarehouseRequest struct { // // Supported values: - Number of tags < 45. Tags *EndpointTags - // Configurations whether the endpoint should use spot instances. + // Configures whether the warehouse should use spot instances. COST_OPTIMIZED + // uses spot instances where the cloud provider supports them, and + // RELIABILITY_OPTIMIZED uses on-demand instances only. SpotInstancePolicy EndpointSpotInstancePolicy // Configures whether the warehouse should use Photon optimized clusters. // // Defaults to true. EnablePhoton *bool - // Channel Details + // Channel that determines which Databricks SQL version the warehouse runs. Channel *Channel // Configures whether the warehouse should use serverless compute EnableServerlessCompute *bool @@ -712,7 +719,10 @@ type CreateWarehouseRequest struct { // you must set to `PRO` and also set the field `enable_serverless_compute` to // `true`. WarehouseType WarehouseType - // Warehouse statement timeout in seconds. + // Maximum time in seconds that a statement can run on this warehouse before it + // is cancelled. Set to 0 to remove the warehouse-level timeout. Changing the + // value of a running warehouse restarts it. See + // https://docs.databricks.com/aws/en/sql/language-manual/parameters/statement_timeout. StatementTimeout *int // Cluster size multiplier for Reyden warehouses. Scales the effective compute // capacity relative to the nominal virtual cluster size. Only meaningful when @@ -772,9 +782,9 @@ type DeleteWarehouseResponse struct { type EditWarehouseRequest struct { // Required. Id of the warehouse to configure. Id *string - // Logical name for the cluster. + // Logical name for the warehouse. // - // Supported values: - Must be unique within an org. - Must be less than 100 + // Supported values: - Must be unique within an org. - Must be 1 to 100 // characters. Name *string // Size of the clusters allocated for this warehouse. Increasing the size of a @@ -809,7 +819,8 @@ type EditWarehouseRequest struct { // // Defaults to 120 mins AutoStopMins *int - // warehouse creator name + // Name of the user who created the warehouse. Set by the server and ignored in + // requests. CreatorName *string // Deprecated. Instance profile used to pass IAM role to the cluster InstanceProfileArn *string @@ -818,13 +829,15 @@ type EditWarehouseRequest struct { // // Supported values: - Number of tags < 45. Tags *EndpointTags - // Configurations whether the endpoint should use spot instances. + // Configures whether the warehouse should use spot instances. COST_OPTIMIZED + // uses spot instances where the cloud provider supports them, and + // RELIABILITY_OPTIMIZED uses on-demand instances only. SpotInstancePolicy EndpointSpotInstancePolicy // Configures whether the warehouse should use Photon optimized clusters. // // Defaults to true. EnablePhoton *bool - // Channel Details + // Channel that determines which Databricks SQL version the warehouse runs. Channel *Channel // Configures whether the warehouse should use serverless compute EnableServerlessCompute *bool @@ -832,7 +845,10 @@ type EditWarehouseRequest struct { // you must set to `PRO` and also set the field `enable_serverless_compute` to // `true`. WarehouseType WarehouseType - // Warehouse statement timeout in seconds. + // Maximum time in seconds that a statement can run on this warehouse before it + // is cancelled. Set to 0 to remove the warehouse-level timeout. Changing the + // value of a running warehouse restarts it. See + // https://docs.databricks.com/aws/en/sql/language-manual/parameters/statement_timeout. StatementTimeout *int // Cluster size multiplier for Reyden warehouses. Scales the effective compute // capacity relative to the nominal virtual cluster size. Only meaningful when @@ -855,7 +871,9 @@ type EditWarehouseResponse struct { } type EndpointConfPair struct { - Key *string + // Name of the configuration parameter. + Key *string + // Value of the configuration parameter. Value *string } @@ -874,11 +892,11 @@ type EndpointHealth struct { } type EndpointInfo struct { - // unique identifier for warehouse + // Unique identifier of the warehouse. Id *string - // Logical name for the cluster. + // Logical name for the warehouse. // - // Supported values: - Must be unique within an org. - Must be less than 100 + // Supported values: - Must be unique within an org. - Must be 1 to 100 // characters. Name *string // Size of the clusters allocated for this warehouse. Increasing the size of a @@ -913,7 +931,8 @@ type EndpointInfo struct { // // Defaults to 120 mins AutoStopMins *int - // warehouse creator name + // Name of the user who created the warehouse. Set by the server and ignored in + // requests. CreatorName *string // Deprecated. Instance profile used to pass IAM role to the cluster InstanceProfileArn *string @@ -922,13 +941,15 @@ type EndpointInfo struct { // // Supported values: - Number of tags < 45. Tags *EndpointTags - // Configurations whether the endpoint should use spot instances. + // Configures whether the warehouse should use spot instances. COST_OPTIMIZED + // uses spot instances where the cloud provider supports them, and + // RELIABILITY_OPTIMIZED uses on-demand instances only. SpotInstancePolicy EndpointSpotInstancePolicy // Configures whether the warehouse should use Photon optimized clusters. // // Defaults to true. EnablePhoton *bool - // Channel Details + // Channel that determines which Databricks SQL version the warehouse runs. Channel *Channel // Configures whether the warehouse should use serverless compute EnableServerlessCompute *bool @@ -936,7 +957,10 @@ type EndpointInfo struct { // you must set to `PRO` and also set the field `enable_serverless_compute` to // `true`. WarehouseType WarehouseType - // Warehouse statement timeout in seconds. + // Maximum time in seconds that a statement can run on this warehouse before it + // is cancelled. Set to 0 to remove the warehouse-level timeout. Changing the + // value of a running warehouse restarts it. See + // https://docs.databricks.com/aws/en/sql/language-manual/parameters/statement_timeout. StatementTimeout *int // Cluster size multiplier for Reyden warehouses. Scales the effective compute // capacity relative to the nominal virtual cluster size. Only meaningful when @@ -953,13 +977,14 @@ type EndpointInfo struct { // be at least the minimum DBU for the selected warehouse size and no greater // than the configured DBU limit. Actual capacity may be below this ceiling. MaxDbu *int - // current number of clusters running for the service + // Number of clusters currently allocated to the warehouse, including clusters + // that are still starting. NumClusters *int // Deprecated. current number of active sessions for the warehouse NumActiveSessions *int64 - // state of the endpoint + // Current state of the warehouse. State EndpointState - // the jdbc connection string for this warehouse + // JDBC connection string for the warehouse. JdbcUrl *string // ODBC parameters for the SQL warehouse OdbcParams *OdbcParams @@ -969,11 +994,17 @@ type EndpointInfo struct { } type EndpointTagPair struct { - Key *string + // Tag key. Keys must be unique within the warehouse and cannot use the keys + // that Databricks reserves for the tags it sets automatically. + Key *string + // Tag value. Keys and values must follow the tagging rules of the cloud + // provider. Value *string } type EndpointTags struct { + // User-defined tags, applied in addition to the tags Databricks sets + // automatically. CustomTags []EndpointTagPair } @@ -993,11 +1024,11 @@ type GetWarehouseRequest struct { } type GetWarehouseResponse struct { - // unique identifier for warehouse + // Unique identifier of the warehouse. Id *string - // Logical name for the cluster. + // Logical name for the warehouse. // - // Supported values: - Must be unique within an org. - Must be less than 100 + // Supported values: - Must be unique within an org. - Must be 1 to 100 // characters. Name *string // Size of the clusters allocated for this warehouse. Increasing the size of a @@ -1032,7 +1063,8 @@ type GetWarehouseResponse struct { // // Defaults to 120 mins AutoStopMins *int - // warehouse creator name + // Name of the user who created the warehouse. Set by the server and ignored in + // requests. CreatorName *string // Deprecated. Instance profile used to pass IAM role to the cluster InstanceProfileArn *string @@ -1041,13 +1073,15 @@ type GetWarehouseResponse struct { // // Supported values: - Number of tags < 45. Tags *EndpointTags - // Configurations whether the endpoint should use spot instances. + // Configures whether the warehouse should use spot instances. COST_OPTIMIZED + // uses spot instances where the cloud provider supports them, and + // RELIABILITY_OPTIMIZED uses on-demand instances only. SpotInstancePolicy EndpointSpotInstancePolicy // Configures whether the warehouse should use Photon optimized clusters. // // Defaults to true. EnablePhoton *bool - // Channel Details + // Channel that determines which Databricks SQL version the warehouse runs. Channel *Channel // Configures whether the warehouse should use serverless compute EnableServerlessCompute *bool @@ -1055,7 +1089,10 @@ type GetWarehouseResponse struct { // you must set to `PRO` and also set the field `enable_serverless_compute` to // `true`. WarehouseType WarehouseType - // Warehouse statement timeout in seconds. + // Maximum time in seconds that a statement can run on this warehouse before it + // is cancelled. Set to 0 to remove the warehouse-level timeout. Changing the + // value of a running warehouse restarts it. See + // https://docs.databricks.com/aws/en/sql/language-manual/parameters/statement_timeout. StatementTimeout *int // Cluster size multiplier for Reyden warehouses. Scales the effective compute // capacity relative to the nominal virtual cluster size. Only meaningful when @@ -1072,13 +1109,14 @@ type GetWarehouseResponse struct { // be at least the minimum DBU for the selected warehouse size and no greater // than the configured DBU limit. Actual capacity may be below this ceiling. MaxDbu *int - // current number of clusters running for the service + // Number of clusters currently allocated to the warehouse, including clusters + // that are still starting. NumClusters *int // Deprecated. current number of active sessions for the warehouse NumActiveSessions *int64 - // state of the endpoint + // Current state of the warehouse. State EndpointState - // the jdbc connection string for this warehouse + // JDBC connection string for the warehouse. JdbcUrl *string // ODBC parameters for the SQL warehouse OdbcParams *OdbcParams @@ -1096,8 +1134,11 @@ type GetWorkspaceWarehouseConfigRequest struct { type GetWorkspaceWarehouseConfigResponse struct { // Security policy for warehouses SecurityPolicy EndpointSecurityPolicy - // Spark confs for external hive metastore configuration JSON serialized size - // must be less than <= 512K + // Spark configuration applied to every warehouse in the workspace, for example + // to connect to an external Hive metastore or to configure access to cloud + // storage. Only allowlisted keys are accepted, and the JSON-serialized size + // must be at most 512 KB. See + // https://docs.databricks.com/aws/en/admin/sql/data-access-configuration. DataAccessConfig []EndpointConfPair // AWS Only: The instance profile used to pass an IAM role to the SQL // warehouses. This configuration is also applied to the workspace's serverless @@ -1111,17 +1152,18 @@ type GetWorkspaceWarehouseConfigResponse struct { GlobalParam *RepeatedEndpointConfPairs // Deprecated: Use sql_configuration_parameters ConfigParam *RepeatedEndpointConfPairs - // SQL configuration parameters + // SQL configuration parameters applied to every warehouse in the workspace. + // Only parameters that can be set at the workspace scope are accepted. See + // https://docs.databricks.com/aws/en/sql/language-manual/sql-ref-parameters. SqlConfigurationParameters *RepeatedEndpointConfPairs - // GCP only: Google Service Account used to pass to cluster to access Google - // Cloud Storage + // GCP only: Google service account that the warehouse clusters use to access + // Google Cloud Storage. GoogleServiceAccount *string // List of Warehouse Types allowed in this workspace (limits allowed value of // the type field in CreateWarehouse and EditWarehouse). Note: Some types cannot // be disabled, they don't need to be specified in SetWorkspaceWarehouseConfig. // Note: Disabling a type may cause existing warehouses to be converted to - // another type. Used by frontend to save specific type availability in the - // warehouse create and edit form UI. + // another type. EnabledWarehouseTypes []WarehouseTypePair } @@ -1158,15 +1200,20 @@ type ListWarehousesResponse struct { } type OdbcParams struct { + // Hostname of the workspace to connect to. Hostname *string - Path *string + // HTTP path of the warehouse. + Path *string + // The transport protocol is always https. Protocol *string - Port *int + // The connection port is always 443. + Port *int } type RepeatedEndpointConfPairs struct { // Deprecated: Use configuration_pairs - ConfigPair []EndpointConfPair + ConfigPair []EndpointConfPair + // Configuration parameters, each a key-value pair. ConfigurationPairs []EndpointConfPair } @@ -1177,8 +1224,11 @@ type RepeatedEndpointConfPairs struct { type SetWorkspaceWarehouseConfigRequest struct { // Security policy for warehouses SecurityPolicy EndpointSecurityPolicy - // Spark confs for external hive metastore configuration JSON serialized size - // must be less than <= 512K + // Spark configuration applied to every warehouse in the workspace, for example + // to connect to an external Hive metastore or to configure access to cloud + // storage. Only allowlisted keys are accepted, and the JSON-serialized size + // must be at most 512 KB. See + // https://docs.databricks.com/aws/en/admin/sql/data-access-configuration. DataAccessConfig []EndpointConfPair // AWS Only: The instance profile used to pass an IAM role to the SQL // warehouses. This configuration is also applied to the workspace's serverless @@ -1192,17 +1242,18 @@ type SetWorkspaceWarehouseConfigRequest struct { GlobalParam *RepeatedEndpointConfPairs // Deprecated: Use sql_configuration_parameters ConfigParam *RepeatedEndpointConfPairs - // SQL configuration parameters + // SQL configuration parameters applied to every warehouse in the workspace. + // Only parameters that can be set at the workspace scope are accepted. See + // https://docs.databricks.com/aws/en/sql/language-manual/sql-ref-parameters. SqlConfigurationParameters *RepeatedEndpointConfPairs - // GCP only: Google Service Account used to pass to cluster to access Google - // Cloud Storage + // GCP only: Google service account that the warehouse clusters use to access + // Google Cloud Storage. GoogleServiceAccount *string // List of Warehouse Types allowed in this workspace (limits allowed value of // the type field in CreateWarehouse and EditWarehouse). Note: Some types cannot // be disabled, they don't need to be specified in SetWorkspaceWarehouseConfig. // Note: Disabling a type may cause existing warehouses to be converted to - // another type. Used by frontend to save specific type availability in the - // warehouse create and edit form UI. + // another type. EnabledWarehouseTypes []WarehouseTypePair } @@ -1246,6 +1297,7 @@ type UpdateDefaultWarehouseOverrideRequest struct { // * Configuration values to enable or disable the access to specific warehouse // types in the workspace.. type WarehouseTypePair struct { + // Warehouse type that this entry enables or disables. WarehouseType WarehouseType // If set to false the specific warehouse type will not be allowed as a value // for warehouse_type in CreateWarehouse and EditWarehouse