diff --git a/account_client.go b/account_client.go index 6182a005b..65d337624 100755 --- a/account_client.go +++ b/account_client.go @@ -62,10 +62,11 @@ type AccountClient struct { // and some information about how the key configuration can be used. There // are two possible uses for key configurations: // - // * Managed services: A key configuration can be used to encrypt a - // workspace's notebook and secret data in the control plane, as well as - // Databricks SQL queries and query history. * Storage: A key configuration - // can be used to encrypt a workspace's DBFS and EBS data in the data plane. + // - Managed services: A key configuration can be used to encrypt a + // workspace's notebook and secret data in the control plane, as well as + // Databricks SQL queries and query history. + // - Storage: A key configuration can be used to encrypt a workspace's + // DBFS and EBS data in the data plane. // // In both of these cases, the key configuration's ID is used when creating // a new workspace. This Preview feature is available if your account is on @@ -94,34 +95,45 @@ type AccountClient struct { // into your Databricks account. // // Token federation is configured in your Databricks account using an - // account federation policy. An account federation policy specifies: * - // which IdP, or issuer, your Databricks account should accept tokens from * - // how to determine which Databricks user, or subject, a token is issued for - // - // To configure a federation policy, you provide the following: * The - // required token __issuer__, as specified in the “iss” claim of your - // tokens. The issuer is an https URL that identifies your IdP. * The - // allowed token __audiences__, as specified in the “aud” claim of your - // tokens. This identifier is intended to represent the recipient of the - // token. As long as the audience in the token matches at least one audience - // in the policy, the token is considered a match. If unspecified, the - // default value is your Databricks account id. * The __subject claim__, - // which indicates which token claim contains the Databricks username of the - // user the token was issued for. If unspecified, the default value is - // “sub”. * Optionally, the public keys used to validate the signature - // of your tokens, in JWKS format. If unspecified (recommended), Databricks - // automatically fetches the public keys from your issuer’s well known - // endpoint. Databricks strongly recommends relying on your issuer’s well - // known endpoint for discovering public keys. - // - // An example federation policy is: ``` issuer: - // "https://idp.mycompany.com/oidc" audiences: ["databricks"] subject_claim: - // "sub" ``` + // account federation policy. An account federation policy specifies: + // + // - which IdP, or issuer, your Databricks account should accept tokens + // from + // - how to determine which Databricks user, or subject, a token is issued + // for + // + // To configure a federation policy, you provide the following: + // + // - The required token **issuer**, as specified in the “iss” claim of + // your tokens. The issuer is an https URL that identifies your IdP. + // - The allowed token **audiences**, as specified in the “aud” claim + // of your tokens. This identifier is intended to represent the + // recipient of the token. As long as the audience in the token matches + // at least one audience in the policy, the token is considered a match. + // If unspecified, the default value is your Databricks account id. + // - The **subject claim**, which indicates which token claim contains the + // Databricks username of the user the token was issued for. If + // unspecified, the default value is “sub”. + // - Optionally, the public keys used to validate the signature of your + // tokens, in JWKS format. If unspecified (recommended), Databricks + // automatically fetches the public keys from your issuer’s well known + // endpoint. Databricks strongly recommends relying on your issuer’s + // well known endpoint for discovering public keys. + // + // An example federation policy is: + // + // issuer: "https://idp.mycompany.com/oidc" + // audiences: ["databricks"] + // subject_claim: "sub" // // An example JWT token body that matches this policy and could be used to - // authenticate to Databricks as user `username@mycompany.com` is: ``` { - // "iss": "https://idp.mycompany.com/oidc", "aud": "databricks", "sub": - // "username@mycompany.com" } ``` + // authenticate to Databricks as user `username@mycompany.com` is: + // + // { + // "iss": "https://idp.mycompany.com/oidc", + // "aud": "databricks", + // "sub": "username@mycompany.com" + // } // // You may also need to configure your IdP to generate tokens for your users // to exchange with Databricks, if your users do not already have the @@ -155,10 +167,12 @@ type AccountClient struct { // the account, all access is allowed for this account. There is support for // allow lists (inclusion) and block lists (exclusion). // - // When a connection is attempted: 1. **First, all block lists are - // checked.** If the connection IP address matches any block list, the - // connection is rejected. 2. **If the connection was not rejected by block - // lists**, the IP address is compared with the allow lists. + // When a connection is attempted: + // + // 1. **First, all block lists are checked.** If the connection IP address + // matches any block list, the connection is rejected. + // 2. **If the connection was not rejected by block lists**, the IP address + // is compared with the allow lists. // // If there is at least one allow list for the account, the connection is // allowed only if the IP address matches an allow list. If there are no @@ -172,8 +186,8 @@ type AccountClient struct { IpAccessLists settings.AccountIpAccessListsInterface // These APIs manage log delivery configurations for this account. The two - // supported log types for this API are _billable usage logs_ (AWS only) and - // _audit logs_ (AWS and GCP). This feature is in Public Preview. This + // supported log types for this API are *billable usage logs* (AWS only) and + // *audit logs* (AWS and GCP). This feature is in Public Preview. This // feature works with all account ID types. // // Log delivery works with all account types. However, if your account is on @@ -184,55 +198,58 @@ type AccountClient struct { // // The high-level flow of billable usage delivery (AWS only): // - // 1. **Create storage**: In AWS, [create a new AWS S3 bucket] with a - // specific bucket policy. Using Databricks APIs, call the Account API to - // create a [storage configuration object](:method:Storage/Create) that uses - // the bucket name. - // - // 2. **Create credentials**: In AWS, create the appropriate AWS IAM role. - // For full details, including the required IAM role policies and trust - // relationship, see [Billable usage log delivery]. Using Databricks APIs, - // call the Account API to create a [credential configuration - // object](:method:Credentials/Create) that uses the IAM role's ARN. - // - // 3. **Create log delivery configuration**: Using Databricks APIs, call the - // Account API to [create a log delivery - // configuration](:method:LogDelivery/Create) that uses the credential and - // storage configuration objects from previous steps. You can specify if the - // logs should include all events of that log type in your account (_Account - // level_ delivery) or only events for a specific set of workspaces - // (_workspace level_ delivery). Account level log delivery applies to all - // current and future workspaces plus account level logs, while workspace - // level log delivery solely delivers logs related to the specified - // workspaces. You can create multiple types of delivery configurations per - // account. - // - // For billable usage delivery (AWS only): * For more information about - // billable usage logs, see [Billable usage log delivery]. For the CSV - // schema, see the [Usage page]. * The delivery location is - // `//billable-usage/csv/`, where `` is the - // name of the optional delivery path prefix you set up during log delivery - // configuration. Files are named - // `workspaceId=-usageMonth=.csv`. * All billable usage - // logs apply to specific workspaces (_workspace level_ logs). You can - // aggregate usage for your entire account by creating an _account level_ - // delivery configuration that delivers logs for all current and future - // workspaces in your account. * The files are delivered daily by - // overwriting the month's CSV file for each workspace. - // - // For audit log delivery (AWS and GCP): * For more information about about - // audit log delivery, see Audit log delivery [AWS] or [GCP], which includes - // information about the used JSON schema. * The delivery location is - // `//workspaceId=/date=/auditlogs_.json`. - // Files may get overwritten with the same content multiple times to achieve - // exactly-once delivery. * If the audit log delivery configuration included - // specific workspace IDs, only _workspace-level_ audit logs for those - // workspaces are delivered. If the log delivery configuration applies to - // the entire account (_account level_ delivery configuration), the audit - // log delivery includes workspace-level audit logs for all workspaces in - // the account as well as account-level audit logs. See Audit log delivery - // [AWS] or [GCP] for details. * Auditable events are typically available in - // logs within 15 minutes. + // 1. **Create storage**: In AWS, [create a new AWS S3 bucket] with a + // specific bucket policy. Using Databricks APIs, call the Account API + // to create a storage configuration object that uses the bucket name. + // 2. **Create credentials**: In AWS, create the appropriate AWS IAM role. + // For full details, including the required IAM role policies and trust + // relationship, see [Billable usage log delivery]. Using Databricks + // APIs, call the Account API to create a credential configuration + // object that uses the IAM role's ARN. + // 3. **Create log delivery configuration**: Using Databricks APIs, call + // the Account API to create a log delivery configuration that uses the + // credential and storage configuration objects from previous steps. You + // can specify if the logs should include all events of that log type in + // your account (*Account level* delivery) or only events for a specific + // set of workspaces (*workspace level* delivery). Account level log + // delivery applies to all current and future workspaces plus account + // level logs, while workspace level log delivery solely delivers logs + // related to the specified workspaces. You can create multiple types of + // delivery configurations per account. + // + // For billable usage delivery (AWS only): + // + // - For more information about billable usage logs, see [Billable usage + // log delivery]. For the CSV schema, see the [Usage page]. + // - The delivery location is + // `//billable-usage/csv/`, where `` is the + // name of the optional delivery path prefix you set up during log + // delivery configuration. Files are named + // `workspaceId=-usageMonth=.csv`. + // - All billable usage logs apply to specific workspaces (*workspace + // level* logs). You can aggregate usage for your entire account by + // creating an *account level* delivery configuration that delivers logs + // for all current and future workspaces in your account. + // - The files are delivered daily by overwriting the month's CSV file for + // each workspace. + // + // For audit log delivery (AWS and GCP): + // + // - For more information about about audit log delivery, see Audit log + // delivery [AWS] or [GCP], which includes information about the used + // JSON schema. + // - The delivery location is + // `//workspaceId=/date=/auditlogs_.json`. + // Files may get overwritten with the same content multiple times to + // achieve exactly-once delivery. + // - If the audit log delivery configuration included specific workspace + // IDs, only *workspace-level* audit logs for those workspaces are + // delivered. If the log delivery configuration applies to the entire + // account (*account level* delivery configuration), the audit log + // delivery includes workspace-level audit logs for all workspaces in + // the account as well as account-level audit logs. See Audit log + // delivery [AWS] or [GCP] for details. + // - Auditable events are typically available in logs within 15 minutes. // // [AWS]: https://docs.databricks.com/administration-guide/account-settings/audit-logs.html // [Billable usage log delivery]: https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html @@ -306,37 +323,49 @@ type AccountClient struct { // // Workload identity federation is configured in your Databricks account // using a service principal federation policy. A service principal - // federation policy specifies: * which IdP, or issuer, the service - // principal is allowed to authenticate from * which workload identity, or - // subject, is allowed to authenticate as the Databricks service principal - // - // To configure a federation policy, you provide the following: * The - // required token __issuer__, as specified in the “iss” claim of - // workload identity tokens. The issuer is an https URL that identifies the - // workload identity provider. * The required token __subject__, as - // specified in the “sub” claim of workload identity tokens. The subject - // uniquely identifies the workload in the workload runtime environment. * - // The allowed token __audiences__, as specified in the “aud” claim of - // workload identity tokens. The audience is intended to represent the - // recipient of the token. As long as the audience in the token matches at - // least one audience in the policy, the token is considered a match. If - // unspecified, the default value is your Databricks account id. * - // Optionally, the public keys used to validate the signature of the - // workload identity tokens, in JWKS format. If unspecified (recommended), - // Databricks automatically fetches the public keys from the issuer’s well - // known endpoint. Databricks strongly recommends relying on the issuer’s - // well known endpoint for discovering public keys. + // federation policy specifies: + // + // - which IdP, or issuer, the service principal is allowed to + // authenticate from + // - which workload identity, or subject, is allowed to authenticate as + // the Databricks service principal + // + // To configure a federation policy, you provide the following: + // + // - The required token **issuer**, as specified in the “iss” claim of + // workload identity tokens. The issuer is an https URL that identifies + // the workload identity provider. + // - The required token **subject**, as specified in the “sub” claim + // of workload identity tokens. The subject uniquely identifies the + // workload in the workload runtime environment. + // - The allowed token **audiences**, as specified in the “aud” claim + // of workload identity tokens. The audience is intended to represent + // the recipient of the token. As long as the audience in the token + // matches at least one audience in the policy, the token is considered + // a match. If unspecified, the default value is your Databricks account + // id. + // - Optionally, the public keys used to validate the signature of the + // workload identity tokens, in JWKS format. If unspecified + // (recommended), Databricks automatically fetches the public keys from + // the issuer’s well known endpoint. Databricks strongly recommends + // relying on the issuer’s well known endpoint for discovering public + // keys. // // An example service principal federation policy, for a Github Actions - // workload, is: ``` issuer: "https://token.actions.githubusercontent.com" - // audiences: ["https://github.com/my-github-org"] subject: - // "repo:my-github-org/my-repo:environment:prod" ``` + // workload, is: + // + // issuer: "https://token.actions.githubusercontent.com" + // audiences: ["https://github.com/my-github-org"] + // subject: "repo:my-github-org/my-repo:environment:prod" // // An example JWT token body that matches this policy and could be used to - // authenticate to Databricks is: ``` { "iss": - // "https://token.actions.githubusercontent.com", "aud": - // "https://github.com/my-github-org", "sub": - // "repo:my-github-org/my-repo:environment:prod" } ``` + // authenticate to Databricks is: + // + // { + // "iss": "https://token.actions.githubusercontent.com", + // "aud": "https://github.com/my-github-org", + // "sub": "repo:my-github-org/my-repo:environment:prod" + // } // // You may also need to configure the workload runtime to generate tokens // for your workloads. diff --git a/service/aisearch/model.go b/service/aisearch/model.go index 540f41fc3..ee9ef0415 100755 --- a/service/aisearch/model.go +++ b/service/aisearch/model.go @@ -591,12 +591,16 @@ func (s IndexStatus) MarshalJSON() ([]byte, error) { } // The subtype of the AI Search index, determining the indexing and retrieval -// strategy. - `VECTOR`: Not a supported create value — do not select it. Use -// `HYBRID` (vector + hybrid search) or `FULL_TEXT` (full-text only). It is the -// proto2 default (`= 0`) solely to mirror the legacy `index_v2.proto` enum -// value-for-value; it is not an offered index subtype. - `FULL_TEXT`: An index -// that uses full-text search without vector embeddings. - `HYBRID`: An index -// that uses vector embeddings for similarity search and hybrid search. +// strategy. +// +// - `VECTOR`: Not a supported create value — do not select it. Use `HYBRID` +// (vector + hybrid search) or `FULL_TEXT` (full-text only). It is the +// proto2 default (`= 0`) solely to mirror the legacy `index_v2.proto` enum +// value-for-value; it is not an offered index subtype. +// - `FULL_TEXT`: An index that uses full-text search without vector +// embeddings. +// - `HYBRID`: An index that uses vector embeddings for similarity search and +// hybrid search. type IndexSubtype string // An index that uses full-text search without vector embeddings. @@ -641,12 +645,14 @@ func (f *IndexSubtype) Type() string { return "IndexSubtype" } -// There are 2 types of AI Search indexes: - `DELTA_SYNC`: An index that -// automatically syncs with a source Delta Table, automatically and -// incrementally updating the index as the underlying data in the Delta Table -// changes. - `DIRECT_ACCESS`: An index that supports direct read and write of -// vectors and metadata through our REST and SDK APIs. With this model, the user -// manages index updates. +// There are 2 types of AI Search indexes: +// +// - `DELTA_SYNC`: An index that automatically syncs with a source Delta +// Table, automatically and incrementally updating the index as the +// underlying data in the Delta Table changes. +// - `DIRECT_ACCESS`: An index that supports direct read and write of vectors +// and metadata through our REST and SDK APIs. With this model, the user +// manages index updates. type IndexType string // An index that automatically syncs with a source Delta Table, @@ -781,10 +787,12 @@ func (s ListIndexesResponse) MarshalJSON() ([]byte, error) { // Pipeline execution mode for a Delta Sync index. Required on create for Delta // Sync indexes; the legacy backend rejects an unset value with -// INVALID_PARAMETER_VALUE. - `TRIGGERED`: the pipeline stops after refreshing -// the source table once, using the data available when the update started. - -// `CONTINUOUS`: the pipeline processes new data as it arrives in the source -// table to keep the index fresh. +// INVALID_PARAMETER_VALUE. +// +// - `TRIGGERED`: the pipeline stops after refreshing the source table once, +// using the data available when the update started. +// - `CONTINUOUS`: the pipeline processes new data as it arrives in the source +// table to keep the index fresh. type PipelineType string // the pipeline processes new data as it arrives in the source table to diff --git a/service/billing/api.go b/service/billing/api.go index 464ea519b..1f85e0374 100755 --- a/service/billing/api.go +++ b/service/billing/api.go @@ -17,7 +17,8 @@ type BillableUsageInterface interface { // Returns billable usage logs in CSV format for the specified account and date // range. For the data schema, see: // - // - AWS: [CSV file schema]. - GCP: [CSV file schema]. + // - AWS: [CSV file schema]. + // - GCP: [CSV file schema]. // // Note that this method might take multiple minutes to complete. // @@ -177,9 +178,9 @@ type LogDeliveryInterface interface { // Creates a new Databricks log delivery configuration to enable delivery of the // specified type of logs to your storage location. This requires that you - // already created a [credential object](:method:Credentials/Create) (which - // encapsulates a cross-account service IAM role) and a [storage configuration - // object](:method:Storage/Create) (which encapsulates an S3 bucket). + // already created a credential object (which encapsulates a cross-account + // service IAM role) and a storage configuration object (which encapsulates an + // S3 bucket). // // For full details, including the required IAM role policies and bucket // policies, see [Deliver and access billable usage logs] or [Configure audit @@ -195,8 +196,7 @@ type LogDeliveryInterface interface { // no more than two delivery configurations per log type. // // You cannot delete a log delivery configuration, but you can disable it (see - // [Enable or disable log delivery - // configuration](:method:LogDelivery/PatchStatus)). + // Enable or disable log delivery configuration). // // [Configure audit logging]: https://docs.databricks.com/administration-guide/account-settings/audit-logs.html // [Deliver and access billable usage logs]: https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html @@ -244,7 +244,7 @@ type LogDeliveryInterface interface { // configurations is not supported, so disable log delivery configurations that // are no longer needed. Note that you can't re-enable a delivery configuration // if this would violate the delivery configuration limits described under - // [Create log delivery](:method:LogDelivery/Create). + // Create log delivery. PatchStatus(ctx context.Context, request UpdateLogDeliveryConfigurationStatusRequest) error } @@ -257,8 +257,8 @@ func NewLogDelivery(client *client.DatabricksClient) *LogDeliveryAPI { } // These APIs manage log delivery configurations for this account. The two -// supported log types for this API are _billable usage logs_ (AWS only) and -// _audit logs_ (AWS and GCP). This feature is in Public Preview. This feature +// supported log types for this API are *billable usage logs* (AWS only) and +// *audit logs* (AWS and GCP). This feature is in Public Preview. This feature // works with all account ID types. // // Log delivery works with all account types. However, if your account is on the @@ -269,54 +269,57 @@ func NewLogDelivery(client *client.DatabricksClient) *LogDeliveryAPI { // // The high-level flow of billable usage delivery (AWS only): // -// 1. **Create storage**: In AWS, [create a new AWS S3 bucket] with a specific -// bucket policy. Using Databricks APIs, call the Account API to create a -// [storage configuration object](:method:Storage/Create) that uses the bucket -// name. +// 1. **Create storage**: In AWS, [create a new AWS S3 bucket] with a specific +// bucket policy. Using Databricks APIs, call the Account API to create a +// storage configuration object that uses the bucket name. +// 2. **Create credentials**: In AWS, create the appropriate AWS IAM role. For +// full details, including the required IAM role policies and trust +// relationship, see [Billable usage log delivery]. Using Databricks APIs, +// call the Account API to create a credential configuration object that +// uses the IAM role's ARN. +// 3. **Create log delivery configuration**: Using Databricks APIs, call the +// Account API to create a log delivery configuration that uses the +// credential and storage configuration objects from previous steps. You can +// specify if the logs should include all events of that log type in your +// account (*Account level* delivery) or only events for a specific set of +// workspaces (*workspace level* delivery). Account level log delivery +// applies to all current and future workspaces plus account level logs, +// while workspace level log delivery solely delivers logs related to the +// specified workspaces. You can create multiple types of delivery +// configurations per account. // -// 2. **Create credentials**: In AWS, create the appropriate AWS IAM role. For -// full details, including the required IAM role policies and trust -// relationship, see [Billable usage log delivery]. Using Databricks APIs, call -// the Account API to create a [credential configuration -// object](:method:Credentials/Create) that uses the IAM role's ARN. +// For billable usage delivery (AWS only): // -// 3. **Create log delivery configuration**: Using Databricks APIs, call the -// Account API to [create a log delivery -// configuration](:method:LogDelivery/Create) that uses the credential and -// storage configuration objects from previous steps. You can specify if the -// logs should include all events of that log type in your account (_Account -// level_ delivery) or only events for a specific set of workspaces (_workspace -// level_ delivery). Account level log delivery applies to all current and -// future workspaces plus account level logs, while workspace level log delivery -// solely delivers logs related to the specified workspaces. You can create -// multiple types of delivery configurations per account. +// - For more information about billable usage logs, see [Billable usage log +// delivery]. For the CSV schema, see the [Usage page]. +// - The delivery location is `//billable-usage/csv/`, +// where `` is the name of the optional delivery path prefix you set +// up during log delivery configuration. Files are named +// `workspaceId=-usageMonth=.csv`. +// - All billable usage logs apply to specific workspaces (*workspace level* +// logs). You can aggregate usage for your entire account by creating an +// *account level* delivery configuration that delivers logs for all current +// and future workspaces in your account. +// - The files are delivered daily by overwriting the month's CSV file for +// each workspace. // -// For billable usage delivery (AWS only): * For more information about billable -// usage logs, see [Billable usage log delivery]. For the CSV schema, see the -// [Usage page]. * The delivery location is -// `//billable-usage/csv/`, where `` is the name of -// the optional delivery path prefix you set up during log delivery -// configuration. Files are named -// `workspaceId=-usageMonth=.csv`. * All billable usage -// logs apply to specific workspaces (_workspace level_ logs). You can aggregate -// usage for your entire account by creating an _account level_ delivery -// configuration that delivers logs for all current and future workspaces in -// your account. * The files are delivered daily by overwriting the month's CSV -// file for each workspace. +// For audit log delivery (AWS and GCP): // -// For audit log delivery (AWS and GCP): * For more information about about -// audit log delivery, see Audit log delivery [AWS] or [GCP], which includes -// information about the used JSON schema. * The delivery location is -// `//workspaceId=/date=/auditlogs_.json`. -// Files may get overwritten with the same content multiple times to achieve -// exactly-once delivery. * If the audit log delivery configuration included -// specific workspace IDs, only _workspace-level_ audit logs for those -// workspaces are delivered. If the log delivery configuration applies to the -// entire account (_account level_ delivery configuration), the audit log -// delivery includes workspace-level audit logs for all workspaces in the -// account as well as account-level audit logs. See Audit log delivery [AWS] or -// [GCP] for details. * Auditable events are typically available in logs within -// 15 minutes. +// - For more information about about audit log delivery, see Audit log +// delivery [AWS] or [GCP], which includes information about the used JSON +// schema. +// - The delivery location is +// `//workspaceId=/date=/auditlogs_.json`. +// Files may get overwritten with the same content multiple times to achieve +// exactly-once delivery. +// - If the audit log delivery configuration included specific workspace IDs, +// only *workspace-level* audit logs for those workspaces are delivered. If +// the log delivery configuration applies to the entire account (*account +// level* delivery configuration), the audit log delivery includes +// workspace-level audit logs for all workspaces in the account as well as +// account-level audit logs. See Audit log delivery [AWS] or [GCP] for +// details. +// - Auditable events are typically available in logs within 15 minutes. // // [AWS]: https://docs.databricks.com/administration-guide/account-settings/audit-logs.html // [Billable usage log delivery]: https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html diff --git a/service/billing/interface.go b/service/billing/interface.go index 5b5e76ae7..76c951b5e 100755 --- a/service/billing/interface.go +++ b/service/billing/interface.go @@ -15,7 +15,8 @@ type BillableUsageService interface { // Returns billable usage logs in CSV format for the specified account and // date range. For the data schema, see: // - // - AWS: [CSV file schema]. - GCP: [CSV file schema]. + // - AWS: [CSV file schema]. + // - GCP: [CSV file schema]. // // Note that this method might take multiple minutes to complete. // @@ -80,8 +81,8 @@ type BudgetsService interface { } // These APIs manage log delivery configurations for this account. The two -// supported log types for this API are _billable usage logs_ (AWS only) and -// _audit logs_ (AWS and GCP). This feature is in Public Preview. This feature +// supported log types for this API are *billable usage logs* (AWS only) and +// *audit logs* (AWS and GCP). This feature is in Public Preview. This feature // works with all account ID types. // // Log delivery works with all account types. However, if your account is on the @@ -92,54 +93,57 @@ type BudgetsService interface { // // The high-level flow of billable usage delivery (AWS only): // -// 1. **Create storage**: In AWS, [create a new AWS S3 bucket] with a specific -// bucket policy. Using Databricks APIs, call the Account API to create a -// [storage configuration object](:method:Storage/Create) that uses the bucket -// name. +// 1. **Create storage**: In AWS, [create a new AWS S3 bucket] with a specific +// bucket policy. Using Databricks APIs, call the Account API to create a +// storage configuration object that uses the bucket name. +// 2. **Create credentials**: In AWS, create the appropriate AWS IAM role. For +// full details, including the required IAM role policies and trust +// relationship, see [Billable usage log delivery]. Using Databricks APIs, +// call the Account API to create a credential configuration object that +// uses the IAM role's ARN. +// 3. **Create log delivery configuration**: Using Databricks APIs, call the +// Account API to create a log delivery configuration that uses the +// credential and storage configuration objects from previous steps. You can +// specify if the logs should include all events of that log type in your +// account (*Account level* delivery) or only events for a specific set of +// workspaces (*workspace level* delivery). Account level log delivery +// applies to all current and future workspaces plus account level logs, +// while workspace level log delivery solely delivers logs related to the +// specified workspaces. You can create multiple types of delivery +// configurations per account. // -// 2. **Create credentials**: In AWS, create the appropriate AWS IAM role. For -// full details, including the required IAM role policies and trust -// relationship, see [Billable usage log delivery]. Using Databricks APIs, call -// the Account API to create a [credential configuration -// object](:method:Credentials/Create) that uses the IAM role's ARN. +// For billable usage delivery (AWS only): // -// 3. **Create log delivery configuration**: Using Databricks APIs, call the -// Account API to [create a log delivery -// configuration](:method:LogDelivery/Create) that uses the credential and -// storage configuration objects from previous steps. You can specify if the -// logs should include all events of that log type in your account (_Account -// level_ delivery) or only events for a specific set of workspaces (_workspace -// level_ delivery). Account level log delivery applies to all current and -// future workspaces plus account level logs, while workspace level log delivery -// solely delivers logs related to the specified workspaces. You can create -// multiple types of delivery configurations per account. +// - For more information about billable usage logs, see [Billable usage log +// delivery]. For the CSV schema, see the [Usage page]. +// - The delivery location is `//billable-usage/csv/`, +// where `` is the name of the optional delivery path prefix you set +// up during log delivery configuration. Files are named +// `workspaceId=-usageMonth=.csv`. +// - All billable usage logs apply to specific workspaces (*workspace level* +// logs). You can aggregate usage for your entire account by creating an +// *account level* delivery configuration that delivers logs for all current +// and future workspaces in your account. +// - The files are delivered daily by overwriting the month's CSV file for +// each workspace. // -// For billable usage delivery (AWS only): * For more information about billable -// usage logs, see [Billable usage log delivery]. For the CSV schema, see the -// [Usage page]. * The delivery location is -// `//billable-usage/csv/`, where `` is the name of -// the optional delivery path prefix you set up during log delivery -// configuration. Files are named -// `workspaceId=-usageMonth=.csv`. * All billable usage -// logs apply to specific workspaces (_workspace level_ logs). You can aggregate -// usage for your entire account by creating an _account level_ delivery -// configuration that delivers logs for all current and future workspaces in -// your account. * The files are delivered daily by overwriting the month's CSV -// file for each workspace. +// For audit log delivery (AWS and GCP): // -// For audit log delivery (AWS and GCP): * For more information about about -// audit log delivery, see Audit log delivery [AWS] or [GCP], which includes -// information about the used JSON schema. * The delivery location is -// `//workspaceId=/date=/auditlogs_.json`. -// Files may get overwritten with the same content multiple times to achieve -// exactly-once delivery. * If the audit log delivery configuration included -// specific workspace IDs, only _workspace-level_ audit logs for those -// workspaces are delivered. If the log delivery configuration applies to the -// entire account (_account level_ delivery configuration), the audit log -// delivery includes workspace-level audit logs for all workspaces in the -// account as well as account-level audit logs. See Audit log delivery [AWS] or -// [GCP] for details. * Auditable events are typically available in logs within -// 15 minutes. +// - For more information about about audit log delivery, see Audit log +// delivery [AWS] or [GCP], which includes information about the used JSON +// schema. +// - The delivery location is +// `//workspaceId=/date=/auditlogs_.json`. +// Files may get overwritten with the same content multiple times to achieve +// exactly-once delivery. +// - If the audit log delivery configuration included specific workspace IDs, +// only *workspace-level* audit logs for those workspaces are delivered. If +// the log delivery configuration applies to the entire account (*account +// level* delivery configuration), the audit log delivery includes +// workspace-level audit logs for all workspaces in the account as well as +// account-level audit logs. See Audit log delivery [AWS] or [GCP] for +// details. +// - Auditable events are typically available in logs within 15 minutes. // // Deprecated: Do not use this interface, it will be removed in a future version of the SDK. // @@ -152,10 +156,9 @@ type LogDeliveryService interface { // Creates a new Databricks log delivery configuration to enable delivery of // the specified type of logs to your storage location. This requires that - // you already created a [credential object](:method:Credentials/Create) - // (which encapsulates a cross-account service IAM role) and a [storage - // configuration object](:method:Storage/Create) (which encapsulates an S3 - // bucket). + // you already created a credential object (which encapsulates a + // cross-account service IAM role) and a storage configuration object (which + // encapsulates an S3 bucket). // // For full details, including the required IAM role policies and bucket // policies, see [Deliver and access billable usage logs] or [Configure @@ -171,8 +174,7 @@ type LogDeliveryService interface { // for no more than two delivery configurations per log type. // // You cannot delete a log delivery configuration, but you can disable it - // (see [Enable or disable log delivery - // configuration](:method:LogDelivery/PatchStatus)). + // (see Enable or disable log delivery configuration). // // [Configure audit logging]: https://docs.databricks.com/administration-guide/account-settings/audit-logs.html // [Deliver and access billable usage logs]: https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html @@ -190,7 +192,7 @@ type LogDeliveryService interface { // configurations is not supported, so disable log delivery configurations // that are no longer needed. Note that you can't re-enable a delivery // configuration if this would violate the delivery configuration limits - // described under [Create log delivery](:method:LogDelivery/Create). + // described under Create log delivery. PatchStatus(ctx context.Context, request UpdateLogDeliveryConfigurationStatusRequest) error } diff --git a/service/billing/model.go b/service/billing/model.go index 21550d267..0b01fc7e6 100755 --- a/service/billing/model.go +++ b/service/billing/model.go @@ -309,9 +309,12 @@ type BudgetPolicy struct { // The Id of the policy. This field is generated by Databricks and globally // unique. PolicyId string `json:"policy_id,omitempty"` - // The name of the policy. - Must be unique among active policies. - Can - // contain only characters from the ISO 8859-1 (latin1) set. - Can't start - // with reserved keywords such as `databricks:default-policy`. + // The name of the policy. + // + // - Must be unique among active policies. + // - Can contain only characters from the ISO 8859-1 (latin1) set. + // - Can't start with reserved keywords such as + // `databricks:default-policy`. PolicyName string `json:"policy_name,omitempty"` ForceSendFields []string `json:"-" url:"-"` @@ -464,7 +467,7 @@ func (s CreateBudgetPolicyRequest) MarshalJSON() ([]byte, error) { return marshal.Marshal(s) } -// * Log Delivery Configuration +// Log Delivery Configuration type CreateLogDeliveryConfigurationParams struct { // The optional human-readable name of the log delivery configuration. // Defaults to empty. @@ -485,31 +488,34 @@ type CreateLogDeliveryConfigurationParams struct { // Defaults to current year and month. BILLABLE_USAGE logs are not available // for usage before March 2019 (2019-03). DeliveryStartTime string `json:"delivery_start_time,omitempty"` - // Log delivery type. Supported values are: * `BILLABLE_USAGE` — Configure - // [billable usage log delivery]. For the CSV schema, see the [View billable - // usage]. * `AUDIT_LOGS` — Configure [audit log delivery]. For the JSON - // schema, see [Configure audit logging] + // Log delivery type. Supported values are: + // + // - `BILLABLE_USAGE` — Configure [billable usage log delivery]. For the + // CSV schema, see the [View billable usage]. + // - `AUDIT_LOGS` — Configure [audit log delivery]. For the JSON schema, + // see [Configure audit logging] // // [Configure audit logging]: https://docs.databricks.com/administration-guide/account-settings/audit-logs.html // [View billable usage]: https://docs.databricks.com/administration-guide/account-settings/usage.html // [audit log delivery]: https://docs.databricks.com/administration-guide/account-settings/audit-logs.html // [billable usage log delivery]: https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html LogType LogType `json:"log_type"` - // The file type of log delivery. * If `log_type` is `BILLABLE_USAGE`, this - // value must be `CSV`. Only the CSV (comma-separated values) format is - // supported. For the schema, see the [View billable usage] * If `log_type` - // is `AUDIT_LOGS`, this value must be `JSON`. Only the JSON (JavaScript - // Object Notation) format is supported. For the schema, see the - // [Configuring audit logs]. + // The file type of log delivery. + // + // - If `log_type` is `BILLABLE_USAGE`, this value must be `CSV`. Only the + // CSV (comma-separated values) format is supported. For the schema, see + // the [View billable usage] + // - If `log_type` is `AUDIT_LOGS`, this value must be `JSON`. Only the + // JSON (JavaScript Object Notation) format is supported. For the + // schema, see the [Configuring audit logs]. // // [Configuring audit logs]: https://docs.databricks.com/administration-guide/account-settings/audit-logs.html // [View billable usage]: https://docs.databricks.com/administration-guide/account-settings/usage.html OutputFormat OutputFormat `json:"output_format"` // Status of log delivery configuration. Set to `ENABLED` (enabled) or - // `DISABLED` (disabled). Defaults to `ENABLED`. You can [enable or disable - // the configuration](#operation/patch-log-delivery-config-status) later. - // Deletion of a configuration is not supported, so disable a log delivery - // configuration that is no longer needed. + // `DISABLED` (disabled). Defaults to `ENABLED`. You can enable or disable + // the configuration later. Deletion of a configuration is not supported, so + // disable a log delivery configuration that is no longer needed. Status LogDeliveryConfigStatus `json:"status,omitempty"` // The ID for a method:storage/create that represents the S3 bucket with // bucket policy as described in the main billable usage documentation page. @@ -553,7 +559,7 @@ type DeleteBudgetPolicyRequest struct { PolicyId string `json:"-" url:"-"` } -// * The status string for log delivery. Possible values are: `CREATED`: There +// The status string for log delivery. Possible values are: `CREATED`: There // were no log delivery attempts since the config was created. `SUCCEEDED`: The // latest attempt of log delivery has succeeded completely. `USER_FAILURE`: The // latest attempt of log delivery failed because of misconfiguration of customer @@ -835,7 +841,7 @@ func (s ListLogDeliveryRequest) MarshalJSON() ([]byte, error) { return marshal.Marshal(s) } -// * Log Delivery Status +// Log Delivery Status // // `ENABLED`: All dependencies have executed and succeeded `DISABLED`: At least // one dependency has succeeded @@ -876,7 +882,7 @@ func (f *LogDeliveryConfigStatus) Type() string { return "LogDeliveryConfigStatus" } -// * Log Delivery Configuration +// Log Delivery Configuration type LogDeliveryConfiguration struct { // Databricks account ID. AccountId string `json:"account_id"` @@ -906,31 +912,34 @@ type LogDeliveryConfiguration struct { DeliveryStartTime string `json:"delivery_start_time,omitempty"` // The LogDeliveryStatus of this log delivery configuration LogDeliveryStatus *LogDeliveryStatus `json:"log_delivery_status,omitempty"` - // Log delivery type. Supported values are: * `BILLABLE_USAGE` — Configure - // [billable usage log delivery]. For the CSV schema, see the [View billable - // usage]. * `AUDIT_LOGS` — Configure [audit log delivery]. For the JSON - // schema, see [Configure audit logging] + // Log delivery type. Supported values are: + // + // - `BILLABLE_USAGE` — Configure [billable usage log delivery]. For the + // CSV schema, see the [View billable usage]. + // - `AUDIT_LOGS` — Configure [audit log delivery]. For the JSON schema, + // see [Configure audit logging] // // [Configure audit logging]: https://docs.databricks.com/administration-guide/account-settings/audit-logs.html // [View billable usage]: https://docs.databricks.com/administration-guide/account-settings/usage.html // [audit log delivery]: https://docs.databricks.com/administration-guide/account-settings/audit-logs.html // [billable usage log delivery]: https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html LogType LogType `json:"log_type"` - // The file type of log delivery. * If `log_type` is `BILLABLE_USAGE`, this - // value must be `CSV`. Only the CSV (comma-separated values) format is - // supported. For the schema, see the [View billable usage] * If `log_type` - // is `AUDIT_LOGS`, this value must be `JSON`. Only the JSON (JavaScript - // Object Notation) format is supported. For the schema, see the - // [Configuring audit logs]. + // The file type of log delivery. + // + // - If `log_type` is `BILLABLE_USAGE`, this value must be `CSV`. Only the + // CSV (comma-separated values) format is supported. For the schema, see + // the [View billable usage] + // - If `log_type` is `AUDIT_LOGS`, this value must be `JSON`. Only the + // JSON (JavaScript Object Notation) format is supported. For the + // schema, see the [Configuring audit logs]. // // [Configuring audit logs]: https://docs.databricks.com/administration-guide/account-settings/audit-logs.html // [View billable usage]: https://docs.databricks.com/administration-guide/account-settings/usage.html OutputFormat OutputFormat `json:"output_format"` // Status of log delivery configuration. Set to `ENABLED` (enabled) or - // `DISABLED` (disabled). Defaults to `ENABLED`. You can [enable or disable - // the configuration](#operation/patch-log-delivery-config-status) later. - // Deletion of a configuration is not supported, so disable a log delivery - // configuration that is no longer needed. + // `DISABLED` (disabled). Defaults to `ENABLED`. You can enable or disable + // the configuration later. Deletion of a configuration is not supported, so + // disable a log delivery configuration that is no longer needed. Status LogDeliveryConfigStatus `json:"status,omitempty"` // The ID for a method:storage/create that represents the S3 bucket with // bucket policy as described in the main billable usage documentation page. @@ -976,16 +985,20 @@ type LogDeliveryStatus struct { // delivery fails with USER_FAILURE, error details will be provided for // fixing misconfigurations in cloud permissions. Message string `json:"message"` - // Enum that describes the status. Possible values are: * `CREATED`: There - // were no log delivery attempts since the config was created. * - // `SUCCEEDED`: The latest attempt of log delivery has succeeded completely. - // * `USER_FAILURE`: The latest attempt of log delivery failed because of - // misconfiguration of customer provided permissions on role or storage. * - // `SYSTEM_FAILURE`: The latest attempt of log delivery failed because of an - // Databricks internal error. Contact support if it doesn't go away soon. * - // `NOT_FOUND`: The log delivery status as the configuration has been - // disabled since the release of this feature or there are no workspaces in - // the account. + // Enum that describes the status. Possible values are: + // + // - `CREATED`: There were no log delivery attempts since the config was + // created. + // - `SUCCEEDED`: The latest attempt of log delivery has succeeded + // completely. + // - `USER_FAILURE`: The latest attempt of log delivery failed because of + // misconfiguration of customer provided permissions on role or storage. + // - `SYSTEM_FAILURE`: The latest attempt of log delivery failed because + // of an Databricks internal error. Contact support if it doesn't go + // away soon. + // - `NOT_FOUND`: The log delivery status as the configuration has been + // disabled since the release of this feature or there are no workspaces + // in the account. Status DeliveryStatus `json:"status"` ForceSendFields []string `json:"-" url:"-"` @@ -999,7 +1012,7 @@ func (s LogDeliveryStatus) MarshalJSON() ([]byte, error) { return marshal.Marshal(s) } -// * Log Delivery Type +// Log Delivery Type type LogType string const LogTypeAuditLogs LogType = `AUDIT_LOGS` @@ -1037,7 +1050,7 @@ func (f *LogType) Type() string { return "LogType" } -// * Log Delivery Output Format +// Log Delivery Output Format type OutputFormat string const OutputFormatCsv OutputFormat = `CSV` @@ -1179,15 +1192,14 @@ type UpdateBudgetPolicyRequest struct { PolicyId string `json:"-" url:"-"` } -// * Update Log Delivery Configuration +// Update Log Delivery Configuration type UpdateLogDeliveryConfigurationStatusRequest struct { // The log delivery configuration id of customer LogDeliveryConfigurationId string `json:"-" url:"-"` // Status of log delivery configuration. Set to `ENABLED` (enabled) or - // `DISABLED` (disabled). Defaults to `ENABLED`. You can [enable or disable - // the configuration](#operation/patch-log-delivery-config-status) later. - // Deletion of a configuration is not supported, so disable a log delivery - // configuration that is no longer needed. + // `DISABLED` (disabled). Defaults to `ENABLED`. You can enable or disable + // the configuration later. Deletion of a configuration is not supported, so + // disable a log delivery configuration that is no longer needed. Status LogDeliveryConfigStatus `json:"status"` } @@ -1265,7 +1277,7 @@ func (f *UsageDashboardType) Type() string { return "UsageDashboardType" } -// * Properties of the new log delivery configuration. +// Properties of the new log delivery configuration. type WrappedCreateLogDeliveryConfiguration struct { LogDeliveryConfiguration CreateLogDeliveryConfigurationParams `json:"log_delivery_configuration"` } diff --git a/service/bundledeployments/api.go b/service/bundledeployments/api.go index bcda60a42..db692d557 100755 --- a/service/bundledeployments/api.go +++ b/service/bundledeployments/api.go @@ -14,10 +14,12 @@ type BundleDeploymentsInterface interface { // Marks a version as complete and releases the deployment lock. // - // The server atomically: 1. Sets the version status to the provided terminal - // status. 2. Sets `complete_time` to the current server timestamp. 3. Releases - // the lock on the parent deployment. 4. Updates the parent deployment's - // `status` and `last_version_id`. + // The server atomically: + // + // 1. Sets the version status to the provided terminal status. + // 2. Sets `complete_time` to the current server timestamp. + // 3. Releases the lock on the parent deployment. + // 4. Updates the parent deployment's `status` and `last_version_id`. CompleteVersion(ctx context.Context, request CompleteVersionRequest) (*Version, error) // Creates a new deployment in the workspace. diff --git a/service/bundledeployments/interface.go b/service/bundledeployments/interface.go index da91663dd..9578b9217 100755 --- a/service/bundledeployments/interface.go +++ b/service/bundledeployments/interface.go @@ -13,10 +13,12 @@ type BundleDeploymentsService interface { // Marks a version as complete and releases the deployment lock. // - // The server atomically: 1. Sets the version status to the provided - // terminal status. 2. Sets `complete_time` to the current server timestamp. - // 3. Releases the lock on the parent deployment. 4. Updates the parent - // deployment's `status` and `last_version_id`. + // The server atomically: + // + // 1. Sets the version status to the provided terminal status. + // 2. Sets `complete_time` to the current server timestamp. + // 3. Releases the lock on the parent deployment. + // 4. Updates the parent deployment's `status` and `last_version_id`. CompleteVersion(ctx context.Context, request CompleteVersionRequest) (*Version, error) // Creates a new deployment in the workspace. diff --git a/service/catalog/api.go b/service/catalog/api.go index 70bf6209b..93ef4877c 100755 --- a/service/catalog/api.go +++ b/service/catalog/api.go @@ -162,8 +162,11 @@ func (a *AccountMetastoresAPI) GetByMetastoreId(ctx context.Context, metastoreId type AccountStorageCredentialsInterface interface { // Creates a new storage credential. The request object is specific to the - // cloud: - **AwsIamRole** for AWS credentials - **AzureServicePrincipal** for - // Azure credentials - **GcpServiceAccountKey** for GCP credentials + // cloud: + // + // - **AwsIamRole** for AWS credentials + // - **AzureServicePrincipal** for Azure credentials + // - **GcpServiceAccountKey** for GCP credentials // // The caller must be a metastore admin and have the `CREATE_STORAGE_CREDENTIAL` // privilege on the metastore. @@ -544,7 +547,7 @@ type CredentialsInterface interface { // credential. GetCredentialByNameArg(ctx context.Context, nameArg string) (*CredentialInfo, error) - // Gets an array of credentials (as __CredentialInfo__ objects). + // Gets an array of credentials (as **CredentialInfo** objects). // // The array is limited to only the credentials that the caller has permission // to access. If the caller is a metastore admin, retrieval of credentials is @@ -559,7 +562,7 @@ type CredentialsInterface interface { // This method is generated by Databricks SDK Code Generator. ListCredentials(ctx context.Context, request ListCredentialsRequest) listing.Iterator[CredentialInfo] - // Gets an array of credentials (as __CredentialInfo__ objects). + // Gets an array of credentials (as **CredentialInfo** objects). // // The array is limited to only the credentials that the caller has permission // to access. If the caller is a metastore admin, retrieval of credentials is @@ -578,19 +581,19 @@ type CredentialsInterface interface { // // The caller must be the owner of the credential or a metastore admin or have // the `MANAGE` permission. If the caller is a metastore admin, only the - // __owner__ field can be changed. + // **owner** field can be changed. UpdateCredential(ctx context.Context, request UpdateCredentialRequest) (*CredentialInfo, error) // Validates a credential. // // For service credentials (purpose is **SERVICE**), either the - // __credential_name__ or the cloud-specific credential must be provided. + // **credential_name** or the cloud-specific credential must be provided. // // For storage credentials (purpose is **STORAGE**), at least one of - // __external_location_name__ and __url__ need to be provided. If only one of + // **external_location_name** and **url** need to be provided. If only one of // them is provided, it will be used for validation. And if both are provided, - // the __url__ will be used for validation, and __external_location_name__ will - // be ignored when checking overlapping urls. Either the __credential_name__ or + // the **url** will be used for validation, and **external_location_name** will + // be ignored when checking overlapping urls. Either the **credential_name** or // the cloud-specific credential must be provided. // // The caller must be a metastore admin or the credential owner or have the @@ -641,8 +644,11 @@ type EntityTagAssignmentsInterface interface { // Creates a tag assignment for an Unity Catalog entity. // // To add tags to Unity Catalog entities, you must own the entity or have the - // following privileges: - **APPLY TAG** on the entity - **USE SCHEMA** on the - // entity's parent schema - **USE CATALOG** on the entity's parent catalog + // following privileges: + // + // - **APPLY TAG** on the entity + // - **USE SCHEMA** on the entity's parent schema + // - **USE CATALOG** on the entity's parent catalog // // To add a governed tag to Unity Catalog entities, you must also have the // **ASSIGN** or **MANAGE** permission on the tag policy. See [Manage tag policy @@ -654,8 +660,11 @@ type EntityTagAssignmentsInterface interface { // Deletes a tag assignment for an Unity Catalog entity by its key. // // To delete tags from Unity Catalog entities, you must own the entity or have - // the following privileges: - **APPLY TAG** on the entity - **USE_SCHEMA** on - // the entity's parent schema - **USE_CATALOG** on the entity's parent catalog + // the following privileges: + // + // - **APPLY TAG** on the entity + // - **USE_SCHEMA** on the entity's parent schema + // - **USE_CATALOG** on the entity's parent catalog // // To delete a governed tag from Unity Catalog entities, you must also have the // **ASSIGN** or **MANAGE** permission on the tag policy. See [Manage tag policy @@ -690,8 +699,11 @@ type EntityTagAssignmentsInterface interface { // Updates an existing tag assignment for an Unity Catalog entity. // // To update tags to Unity Catalog entities, you must own the entity or have the - // following privileges: - **APPLY TAG** on the entity - **USE SCHEMA** on the - // entity's parent schema - **USE CATALOG** on the entity's parent catalog + // following privileges: + // + // - **APPLY TAG** on the entity + // - **USE SCHEMA** on the entity's parent schema + // - **USE CATALOG** on the entity's parent catalog // // To update a governed tag to Unity Catalog entities, you must also have the // **ASSIGN** or **MANAGE** permission on the tag policy. See [Manage tag policy @@ -789,7 +801,7 @@ type ExternalLocationsInterface interface { // privilege on the external location. GetByName(ctx context.Context, name string) (*ExternalLocationInfo, error) - // Gets an array of external locations (__ExternalLocationInfo__ objects) from + // Gets an array of external locations (**ExternalLocationInfo** objects) from // the metastore. The caller must be a metastore admin, the owner of the // external location, or a user that has some privilege on the external // location. There is no guarantee of a specific ordering of the elements in the @@ -806,7 +818,7 @@ type ExternalLocationsInterface interface { // This method is generated by Databricks SDK Code Generator. List(ctx context.Context, request ListExternalLocationsRequest) listing.Iterator[ExternalLocationInfo] - // Gets an array of external locations (__ExternalLocationInfo__ objects) from + // Gets an array of external locations (**ExternalLocationInfo** objects) from // the metastore. The caller must be a metastore admin, the owner of the // external location, or a user that has some privilege on the external // location. There is no guarantee of a specific ordering of the elements in the @@ -968,44 +980,56 @@ type FunctionsInterface interface { // Creates a new function // // The user must have the following permissions in order for the function to be - // created: - **USE_CATALOG** on the function's parent catalog - **USE_SCHEMA** - // and **CREATE_FUNCTION** on the function's parent schema + // created: + // + // - **USE_CATALOG** on the function's parent catalog + // - **USE_SCHEMA** and **CREATE_FUNCTION** on the function's parent schema Create(ctx context.Context, request CreateFunctionRequest) (*FunctionInfo, error) // Deletes the function that matches the supplied name. For the deletion to - // succeed, the user must satisfy one of the following conditions: - Is the - // owner of the function's parent catalog - Is the owner of the function's - // parent schema and have the **USE_CATALOG** privilege on its parent catalog - - // Is the owner of the function itself and have both the **USE_CATALOG** - // privilege on its parent catalog and the **USE_SCHEMA** privilege on its - // parent schema + // succeed, the user must satisfy one of the following conditions: + // + // - Is the owner of the function's parent catalog + // - Is the owner of the function's parent schema and have the **USE_CATALOG** + // privilege on its parent catalog + // - Is the owner of the function itself and have both the **USE_CATALOG** + // privilege on its parent catalog and the **USE_SCHEMA** privilege on its + // parent schema Delete(ctx context.Context, request DeleteFunctionRequest) error // Deletes the function that matches the supplied name. For the deletion to - // succeed, the user must satisfy one of the following conditions: - Is the - // owner of the function's parent catalog - Is the owner of the function's - // parent schema and have the **USE_CATALOG** privilege on its parent catalog - - // Is the owner of the function itself and have both the **USE_CATALOG** - // privilege on its parent catalog and the **USE_SCHEMA** privilege on its - // parent schema + // succeed, the user must satisfy one of the following conditions: + // + // - Is the owner of the function's parent catalog + // - Is the owner of the function's parent schema and have the **USE_CATALOG** + // privilege on its parent catalog + // - Is the owner of the function itself and have both the **USE_CATALOG** + // privilege on its parent catalog and the **USE_SCHEMA** privilege on its + // parent schema DeleteByName(ctx context.Context, name string) error // Gets a function from within a parent catalog and schema. For the fetch to - // succeed, the user must satisfy one of the following requirements: - Is a - // metastore admin - Is an owner of the function's parent catalog - Have the - // **USE_CATALOG** privilege on the function's parent catalog and be the owner - // of the function - Have the **USE_CATALOG** privilege on the function's parent - // catalog, the **USE_SCHEMA** privilege on the function's parent schema, and - // the **EXECUTE** privilege on the function itself + // succeed, the user must satisfy one of the following requirements: + // + // - Is a metastore admin + // - Is an owner of the function's parent catalog + // - Have the **USE_CATALOG** privilege on the function's parent catalog and + // be the owner of the function + // - Have the **USE_CATALOG** privilege on the function's parent catalog, the + // **USE_SCHEMA** privilege on the function's parent schema, and the + // **EXECUTE** privilege on the function itself Get(ctx context.Context, request GetFunctionRequest) (*FunctionInfo, error) // Gets a function from within a parent catalog and schema. For the fetch to - // succeed, the user must satisfy one of the following requirements: - Is a - // metastore admin - Is an owner of the function's parent catalog - Have the - // **USE_CATALOG** privilege on the function's parent catalog and be the owner - // of the function - Have the **USE_CATALOG** privilege on the function's parent - // catalog, the **USE_SCHEMA** privilege on the function's parent schema, and - // the **EXECUTE** privilege on the function itself + // succeed, the user must satisfy one of the following requirements: + // + // - Is a metastore admin + // - Is an owner of the function's parent catalog + // - Have the **USE_CATALOG** privilege on the function's parent catalog and + // be the owner of the function + // - Have the **USE_CATALOG** privilege on the function's parent catalog, the + // **USE_SCHEMA** privilege on the function's parent schema, and the + // **EXECUTE** privilege on the function itself GetByName(ctx context.Context, name string) (*FunctionInfo, error) // List functions within the specified parent catalog and schema. If the user is @@ -1057,12 +1081,15 @@ type FunctionsInterface interface { // Updates the function that matches the supplied name. Only the owner of the // function can be updated. If the user is not a metastore admin, the user must - // be a member of the group that is the new function owner. - Is a metastore - // admin - Is the owner of the function's parent catalog - Is the owner of the - // function's parent schema and has the **USE_CATALOG** privilege on its parent - // catalog - Is the owner of the function itself and has the **USE_CATALOG** - // privilege on its parent catalog as well as the **USE_SCHEMA** privilege on - // the function's parent schema. + // be a member of the group that is the new function owner. + // + // - Is a metastore admin + // - Is the owner of the function's parent catalog + // - Is the owner of the function's parent schema and has the **USE_CATALOG** + // privilege on its parent catalog + // - Is the owner of the function itself and has the **USE_CATALOG** privilege + // on its parent catalog as well as the **USE_SCHEMA** privilege on the + // function's parent schema. Update(ctx context.Context, request UpdateFunction) (*FunctionInfo, error) } @@ -1079,18 +1106,20 @@ func NewFunctions(client *client.DatabricksClient) *FunctionsAPI { // The function implementation can be any SQL expression or Query, and it can be // invoked wherever a table reference is allowed in a query. In Unity Catalog, a // function resides at the same level as a table, so it can be referenced with -// the form __catalog_name__.__schema_name__.__function_name__. +// the form **catalog_name**.**schema_name**.**function_name**. type FunctionsAPI struct { functionsImpl } // Deletes the function that matches the supplied name. For the deletion to -// succeed, the user must satisfy one of the following conditions: - Is the -// owner of the function's parent catalog - Is the owner of the function's -// parent schema and have the **USE_CATALOG** privilege on its parent catalog - -// Is the owner of the function itself and have both the **USE_CATALOG** -// privilege on its parent catalog and the **USE_SCHEMA** privilege on its -// parent schema +// succeed, the user must satisfy one of the following conditions: +// +// - Is the owner of the function's parent catalog +// - Is the owner of the function's parent schema and have the **USE_CATALOG** +// privilege on its parent catalog +// - Is the owner of the function itself and have both the **USE_CATALOG** +// privilege on its parent catalog and the **USE_SCHEMA** privilege on its +// parent schema func (a *FunctionsAPI) DeleteByName(ctx context.Context, name string) error { return a.functionsImpl.Delete(ctx, DeleteFunctionRequest{ Name: name, @@ -1098,12 +1127,15 @@ func (a *FunctionsAPI) DeleteByName(ctx context.Context, name string) error { } // Gets a function from within a parent catalog and schema. For the fetch to -// succeed, the user must satisfy one of the following requirements: - Is a -// metastore admin - Is an owner of the function's parent catalog - Have the -// **USE_CATALOG** privilege on the function's parent catalog and be the owner -// of the function - Have the **USE_CATALOG** privilege on the function's parent -// catalog, the **USE_SCHEMA** privilege on the function's parent schema, and -// the **EXECUTE** privilege on the function itself +// succeed, the user must satisfy one of the following requirements: +// +// - Is a metastore admin +// - Is an owner of the function's parent catalog +// - Have the **USE_CATALOG** privilege on the function's parent catalog and +// be the owner of the function +// - Have the **USE_CATALOG** privilege on the function's parent catalog, the +// **USE_SCHEMA** privilege on the function's parent schema, and the +// **EXECUTE** privilege on the function itself func (a *FunctionsAPI) GetByName(ctx context.Context, name string) (*FunctionInfo, error) { return a.functionsImpl.Get(ctx, GetFunctionRequest{ Name: name, @@ -1246,13 +1278,13 @@ func (a *GrantsAPI) GetEffectiveBySecurableTypeAndFullName(ctx context.Context, type MetastoresInterface interface { // Creates a new metastore assignment. If an assignment for the same - // __workspace_id__ exists, it will be overwritten by the new __metastore_id__ - // and __default_catalog_name__. The caller must be an account admin. + // **workspace_id** exists, it will be overwritten by the new **metastore_id** + // and **default_catalog_name**. The caller must be an account admin. Assign(ctx context.Context, request CreateMetastoreAssignment) error // Creates a new metastore based on a provided name and optional storage root - // path. By default (if the __owner__ field is not set), the owner of the new - // metastore is the user calling the __createMetastore__ API. If the __owner__ + // path. By default (if the **owner** field is not set), the owner of the new + // metastore is the user calling the **createMetastore** API. If the **owner** // field is set to the empty string (**""**), the ownership is assigned to the // System User instead. Create(ctx context.Context, request CreateMetastore) (*MetastoreInfo, error) @@ -1274,7 +1306,7 @@ type MetastoresInterface interface { // admin to retrieve this info. GetById(ctx context.Context, id string) (*MetastoreInfo, error) - // Gets an array of the available metastores (as __MetastoreInfo__ objects). The + // Gets an array of the available metastores (as **MetastoreInfo** objects). The // caller must be an admin to retrieve this info. There is no guarantee of a // specific ordering of the elements in the array. // @@ -1289,7 +1321,7 @@ type MetastoresInterface interface { // This method is generated by Databricks SDK Code Generator. List(ctx context.Context, request ListMetastoresRequest) listing.Iterator[MetastoreInfo] - // Gets an array of the available metastores (as __MetastoreInfo__ objects). The + // Gets an array of the available metastores (as **MetastoreInfo** objects). The // caller must be an admin to retrieve this info. There is no guarantee of a // specific ordering of the elements in the array. // @@ -1315,14 +1347,14 @@ type MetastoresInterface interface { UnassignByWorkspaceId(ctx context.Context, workspaceId int64) error // Updates information for a specific metastore. The caller must be a metastore - // admin. If the __owner__ field is set to the empty string (**""**), the + // admin. If the **owner** field is set to the empty string (**""**), the // ownership is updated to the System User. Update(ctx context.Context, request UpdateMetastore) (*MetastoreInfo, error) // Updates a metastore assignment. This operation can be used to update - // __metastore_id__ or __default_catalog_name__ for a specified Workspace, if + // **metastore_id** or **default_catalog_name** for a specified Workspace, if // the Workspace is already assigned a metastore. The caller must be an account - // admin to update __metastore_id__; otherwise, the caller can be a Workspace + // admin to update **metastore_id**; otherwise, the caller can be a Workspace // admin. UpdateAssignment(ctx context.Context, request UpdateMetastoreAssignment) error } @@ -1515,8 +1547,7 @@ func NewModelVersions(client *client.DatabricksClient) *ModelVersionsAPI { // auditing, lineage, and discovery of ML models across Databricks workspaces. // // This API reference documents the REST endpoints for managing model versions -// in Unity Catalog. For more details, see the [registered models API -// docs](/api/workspace/registeredmodels). +// in Unity Catalog. For more details, see the registered models API docs. type ModelVersionsAPI struct { modelVersionsImpl } @@ -1815,13 +1846,17 @@ type QualityMonitorsInterface interface { // (/api/data-quality/v1/monitors). Creates a new monitor for the specified // table. // - // The caller must either: 1. be an owner of the table's parent catalog, have - // **USE_SCHEMA** on the table's parent schema, and have **SELECT** access on - // the table 2. have **USE_CATALOG** on the table's parent catalog, be an owner - // of the table's parent schema, and have **SELECT** access on the table. 3. - // have the following permissions: - **USE_CATALOG** on the table's parent - // catalog - **USE_SCHEMA** on the table's parent schema - be an owner of the - // table. + // The caller must either: + // + // 1. be an owner of the table's parent catalog, have **USE_SCHEMA** on the + // table's parent schema, and have **SELECT** access on the table + // 2. have **USE_CATALOG** on the table's parent catalog, be an owner of the + // table's parent schema, and have **SELECT** access on the table. + // 3. have the following permissions: + // + // - **USE_CATALOG** on the table's parent catalog + // - **USE_SCHEMA** on the table's parent schema + // - be an owner of the table. // // Workspace assets, such as the dashboard, will be created in the workspace // where this call was made. @@ -1830,11 +1865,16 @@ type QualityMonitorsInterface interface { // Deprecated: Use Data Quality Monitors API instead // (/api/data-quality/v1/monitors). Deletes a monitor for the specified table. // - // The caller must either: 1. be an owner of the table's parent catalog 2. have - // **USE_CATALOG** on the table's parent catalog and be an owner of the table's - // parent schema 3. have the following permissions: - **USE_CATALOG** on the - // table's parent catalog - **USE_SCHEMA** on the table's parent schema - be an - // owner of the table. + // The caller must either: + // + // 1. be an owner of the table's parent catalog + // 2. have **USE_CATALOG** on the table's parent catalog and be an owner of the + // table's parent schema + // 3. have the following permissions: + // + // - **USE_CATALOG** on the table's parent catalog + // - **USE_SCHEMA** on the table's parent schema + // - be an owner of the table. // // Additionally, the call must be made from the workspace where the monitor was // created. @@ -1846,11 +1886,16 @@ type QualityMonitorsInterface interface { // Deprecated: Use Data Quality Monitors API instead // (/api/data-quality/v1/monitors). Gets a monitor for the specified table. // - // The caller must either: 1. be an owner of the table's parent catalog 2. have - // **USE_CATALOG** on the table's parent catalog and be an owner of the table's - // parent schema. 3. have the following permissions: - **USE_CATALOG** on the - // table's parent catalog - **USE_SCHEMA** on the table's parent schema - - // **SELECT** privilege on the table. + // The caller must either: + // + // 1. be an owner of the table's parent catalog + // 2. have **USE_CATALOG** on the table's parent catalog and be an owner of the + // table's parent schema. + // 3. have the following permissions: + // + // - **USE_CATALOG** on the table's parent catalog + // - **USE_SCHEMA** on the table's parent schema + // - **SELECT** privilege on the table. // // The returned information includes configuration values, as well as // information on assets created by the monitor. Some information (e.g., @@ -1862,11 +1907,16 @@ type QualityMonitorsInterface interface { // (/api/data-quality/v1/monitors). Gets info about a specific monitor refresh // using the given refresh ID. // - // The caller must either: 1. be an owner of the table's parent catalog 2. have - // **USE_CATALOG** on the table's parent catalog and be an owner of the table's - // parent schema 3. have the following permissions: - **USE_CATALOG** on the - // table's parent catalog - **USE_SCHEMA** on the table's parent schema - - // **SELECT** privilege on the table. + // The caller must either: + // + // 1. be an owner of the table's parent catalog + // 2. have **USE_CATALOG** on the table's parent catalog and be an owner of the + // table's parent schema + // 3. have the following permissions: + // + // - **USE_CATALOG** on the table's parent catalog + // - **USE_SCHEMA** on the table's parent schema + // - **SELECT** privilege on the table. // // Additionally, the call must be made from the workspace where the monitor was // created. @@ -1876,11 +1926,16 @@ type QualityMonitorsInterface interface { // (/api/data-quality/v1/monitors). Gets an array containing the history of the // most recent refreshes (up to 25) for this table. // - // The caller must either: 1. be an owner of the table's parent catalog 2. have - // **USE_CATALOG** on the table's parent catalog and be an owner of the table's - // parent schema 3. have the following permissions: - **USE_CATALOG** on the - // table's parent catalog - **USE_SCHEMA** on the table's parent schema - - // **SELECT** privilege on the table. + // The caller must either: + // + // 1. be an owner of the table's parent catalog + // 2. have **USE_CATALOG** on the table's parent catalog and be an owner of the + // table's parent schema + // 3. have the following permissions: + // + // - **USE_CATALOG** on the table's parent catalog + // - **USE_SCHEMA** on the table's parent schema + // - **SELECT** privilege on the table. // // Additionally, the call must be made from the workspace where the monitor was // created. @@ -1890,11 +1945,16 @@ type QualityMonitorsInterface interface { // (/api/data-quality/v1/monitors). Regenerates the monitoring dashboard for the // specified table. // - // The caller must either: 1. be an owner of the table's parent catalog 2. have - // **USE_CATALOG** on the table's parent catalog and be an owner of the table's - // parent schema 3. have the following permissions: - **USE_CATALOG** on the - // table's parent catalog - **USE_SCHEMA** on the table's parent schema - be an - // owner of the table + // The caller must either: + // + // 1. be an owner of the table's parent catalog + // 2. have **USE_CATALOG** on the table's parent catalog and be an owner of the + // table's parent schema + // 3. have the following permissions: + // + // - **USE_CATALOG** on the table's parent catalog + // - **USE_SCHEMA** on the table's parent schema + // - be an owner of the table // // The call must be made from the workspace where the monitor was created. The // dashboard will be regenerated in the assets directory that was specified when @@ -1905,11 +1965,16 @@ type QualityMonitorsInterface interface { // (/api/data-quality/v1/monitors). Queues a metric refresh on the monitor for // the specified table. The refresh will execute in the background. // - // The caller must either: 1. be an owner of the table's parent catalog 2. have - // **USE_CATALOG** on the table's parent catalog and be an owner of the table's - // parent schema 3. have the following permissions: - **USE_CATALOG** on the - // table's parent catalog - **USE_SCHEMA** on the table's parent schema - be an - // owner of the table + // The caller must either: + // + // 1. be an owner of the table's parent catalog + // 2. have **USE_CATALOG** on the table's parent catalog and be an owner of the + // table's parent schema + // 3. have the following permissions: + // + // - **USE_CATALOG** on the table's parent catalog + // - **USE_SCHEMA** on the table's parent schema + // - be an owner of the table // // Additionally, the call must be made from the workspace where the monitor was // created. @@ -1918,11 +1983,16 @@ type QualityMonitorsInterface interface { // Deprecated: Use Data Quality Monitors API instead // (/api/data-quality/v1/monitors). Updates a monitor for the specified table. // - // The caller must either: 1. be an owner of the table's parent catalog 2. have - // **USE_CATALOG** on the table's parent catalog and be an owner of the table's - // parent schema 3. have the following permissions: - **USE_CATALOG** on the - // table's parent catalog - **USE_SCHEMA** on the table's parent schema - be an - // owner of the table. + // The caller must either: + // + // 1. be an owner of the table's parent catalog + // 2. have **USE_CATALOG** on the table's parent catalog and be an owner of the + // table's parent schema + // 3. have the following permissions: + // + // - **USE_CATALOG** on the table's parent catalog + // - **USE_SCHEMA** on the table's parent schema + // - be an owner of the table. // // Additionally, the call must be made from the workspace where the monitor was // created, and the caller must be the original creator of the monitor. @@ -1964,11 +2034,13 @@ type RegisteredModelsInterface interface { // catalog, or the Metastore. // // For registered model creation to succeed, the user must satisfy the following - // conditions: - The caller must be a metastore admin, or be the owner of the - // parent catalog and schema, or have the **USE_CATALOG** privilege on the - // parent catalog and the **USE_SCHEMA** privilege on the parent schema. - The - // caller must have the **CREATE MODEL** or **CREATE FUNCTION** privilege on the - // parent schema. + // conditions: + // + // - The caller must be a metastore admin, or be the owner of the parent + // catalog and schema, or have the **USE_CATALOG** privilege on the parent + // catalog and the **USE_SCHEMA** privilege on the parent schema. + // - The caller must have the **CREATE MODEL** or **CREATE FUNCTION** + // privilege on the parent schema. Create(ctx context.Context, request CreateRegisteredModelRequest) (*RegisteredModelInfo, error) // Deletes a registered model and all its model versions from the specified @@ -2125,15 +2197,16 @@ func NewRegisteredModels(client *client.DatabricksClient) *RegisteredModelsAPI { // enclosing schema. In addition, the following additional privileges are // required for various operations: // -// * To create a registered model, users must additionally have the CREATE_MODEL -// permission on the target schema. * To view registered model or model version -// metadata, model version data files, or invoke a model version, users must -// additionally have the EXECUTE permission on the registered model * To update -// registered model or model version tags, users must additionally have APPLY -// TAG permissions on the registered model * To update other registered model or -// model version metadata (comments, aliases) create a new model version, or -// update permissions on the registered model, users must be owners of the -// registered model. +// - To create a registered model, users must additionally have the +// CREATE_MODEL permission on the target schema. +// - To view registered model or model version metadata, model version data +// files, or invoke a model version, users must additionally have the +// EXECUTE permission on the registered model +// - To update registered model or model version tags, users must additionally +// have APPLY TAG permissions on the registered model +// - To update other registered model or model version metadata (comments, +// aliases) create a new model version, or update permissions on the +// registered model, users must be owners of the registered model. // // Note: The securable type for models is FUNCTION. When using REST APIs (e.g. // tagging, grants) that specify a securable type, use FUNCTION as the securable @@ -2402,8 +2475,8 @@ type SchemasInterface interface { ListAll(ctx context.Context, request ListSchemasRequest) ([]SchemaInfo, error) // Updates a schema for a catalog. The caller must be the owner of the schema or - // a metastore admin. If the caller is a metastore admin, only the __owner__ - // field can be changed in the update. If the __name__ field must be updated, + // a metastore admin. If the caller is a metastore admin, only the **owner** + // field can be changed in the update. If the **name** field must be updated, // the caller must be a metastore admin or have the **CREATE_SCHEMA** privilege // on the parent catalog. Update(ctx context.Context, request UpdateSchema) (*SchemaInfo, error) @@ -2549,7 +2622,7 @@ type StorageCredentialsInterface interface { // storage credential. GetByName(ctx context.Context, name string) (*StorageCredentialInfo, error) - // Gets an array of storage credentials (as __StorageCredentialInfo__ objects). + // Gets an array of storage credentials (as **StorageCredentialInfo** objects). // The array is limited to only those storage credentials the caller has // permission to access. If the caller is a metastore admin, retrieval of // credentials is unrestricted. There is no guarantee of a specific ordering of @@ -2566,7 +2639,7 @@ type StorageCredentialsInterface interface { // This method is generated by Databricks SDK Code Generator. List(ctx context.Context, request ListStorageCredentialsRequest) listing.Iterator[StorageCredentialInfo] - // Gets an array of storage credentials (as __StorageCredentialInfo__ objects). + // Gets an array of storage credentials (as **StorageCredentialInfo** objects). // The array is limited to only those storage credentials the caller has // permission to access. If the caller is a metastore admin, retrieval of // credentials is unrestricted. There is no guarantee of a specific ordering of @@ -2589,13 +2662,13 @@ type StorageCredentialsInterface interface { // If the caller is a metastore admin, only the **owner** field can be changed. Update(ctx context.Context, request UpdateStorageCredential) (*StorageCredentialInfo, error) - // Validates a storage credential. At least one of __external_location_name__ - // and __url__ need to be provided. If only one of them is provided, it will be - // used for validation. And if both are provided, the __url__ will be used for - // validation, and __external_location_name__ will be ignored when checking + // Validates a storage credential. At least one of **external_location_name** + // and **url** need to be provided. If only one of them is provided, it will be + // used for validation. And if both are provided, the **url** will be used for + // validation, and **external_location_name** will be ignored when checking // overlapping urls. // - // Either the __storage_credential_name__ or the cloud-specific credential must + // Either the **storage_credential_name** or the cloud-specific credential must // be provided. // // The caller must be a metastore admin or the storage credential owner or have @@ -2746,35 +2819,43 @@ type TableConstraintsInterface interface { // Creates a new table constraint. // // For the table constraint creation to succeed, the user must satisfy both of - // these conditions: - the user must have the **USE_CATALOG** privilege on the - // table's parent catalog, the **USE_SCHEMA** privilege on the table's parent - // schema, and be the owner of the table. - if the new constraint is a - // __ForeignKeyConstraint__, the user must have the **USE_CATALOG** privilege on - // the referenced parent table's catalog, the **USE_SCHEMA** privilege on the - // referenced parent table's schema, and be the owner of the referenced parent - // table. + // these conditions: + // + // - the user must have the **USE_CATALOG** privilege on the table's parent + // catalog, the **USE_SCHEMA** privilege on the table's parent schema, and + // be the owner of the table. + // - if the new constraint is a **ForeignKeyConstraint**, the user must have + // the **USE_CATALOG** privilege on the referenced parent table's catalog, + // the **USE_SCHEMA** privilege on the referenced parent table's schema, and + // be the owner of the referenced parent table. Create(ctx context.Context, request CreateTableConstraint) (*TableConstraint, error) // Deletes a table constraint. // // For the table constraint deletion to succeed, the user must satisfy both of - // these conditions: - the user must have the **USE_CATALOG** privilege on the - // table's parent catalog, the **USE_SCHEMA** privilege on the table's parent - // schema, and be the owner of the table. - if __cascade__ argument is **true**, - // the user must have the following permissions on all of the child tables: the - // **USE_CATALOG** privilege on the table's catalog, the **USE_SCHEMA** - // privilege on the table's schema, and be the owner of the table. + // these conditions: + // + // - the user must have the **USE_CATALOG** privilege on the table's parent + // catalog, the **USE_SCHEMA** privilege on the table's parent schema, and + // be the owner of the table. + // - if **cascade** argument is **true**, the user must have the following + // permissions on all of the child tables: the **USE_CATALOG** privilege on + // the table's catalog, the **USE_SCHEMA** privilege on the table's schema, + // and be the owner of the table. Delete(ctx context.Context, request DeleteTableConstraintRequest) error // Deletes a table constraint. // // For the table constraint deletion to succeed, the user must satisfy both of - // these conditions: - the user must have the **USE_CATALOG** privilege on the - // table's parent catalog, the **USE_SCHEMA** privilege on the table's parent - // schema, and be the owner of the table. - if __cascade__ argument is **true**, - // the user must have the following permissions on all of the child tables: the - // **USE_CATALOG** privilege on the table's catalog, the **USE_SCHEMA** - // privilege on the table's schema, and be the owner of the table. + // these conditions: + // + // - the user must have the **USE_CATALOG** privilege on the table's parent + // catalog, the **USE_SCHEMA** privilege on the table's parent schema, and + // be the owner of the table. + // - if **cascade** argument is **true**, the user must have the following + // permissions on all of the child tables: the **USE_CATALOG** privilege on + // the table's catalog, the **USE_SCHEMA** privilege on the table's schema, + // and be the owner of the table. DeleteByFullName(ctx context.Context, fullName string) error } @@ -2806,12 +2887,15 @@ type TableConstraintsAPI struct { // Deletes a table constraint. // // For the table constraint deletion to succeed, the user must satisfy both of -// these conditions: - the user must have the **USE_CATALOG** privilege on the -// table's parent catalog, the **USE_SCHEMA** privilege on the table's parent -// schema, and be the owner of the table. - if __cascade__ argument is **true**, -// the user must have the following permissions on all of the child tables: the -// **USE_CATALOG** privilege on the table's catalog, the **USE_SCHEMA** -// privilege on the table's schema, and be the owner of the table. +// these conditions: +// +// - the user must have the **USE_CATALOG** privilege on the table's parent +// catalog, the **USE_SCHEMA** privilege on the table's parent schema, and +// be the owner of the table. +// - if **cascade** argument is **true**, the user must have the following +// permissions on all of the child tables: the **USE_CATALOG** privilege on +// the table's catalog, the **USE_SCHEMA** privilege on the table's schema, +// and be the owner of the table. func (a *TableConstraintsAPI) DeleteByFullName(ctx context.Context, fullName string) error { return a.tableConstraintsImpl.Delete(ctx, DeleteTableConstraintRequest{ FullName: fullName, @@ -2861,41 +2945,55 @@ type TablesInterface interface { DeleteByFullName(ctx context.Context, fullName string) error // Gets if a table exists in the metastore for a specific catalog and schema. - // The caller must satisfy one of the following requirements: * Be a metastore - // admin * Be the owner of the parent catalog * Be the owner of the parent - // schema and have the **USE_CATALOG** privilege on the parent catalog * Have - // the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** - // privilege on the parent schema, and either be the table owner or have the - // **SELECT** privilege on the table. * Have **BROWSE** privilege on the parent - // catalog * Have **BROWSE** privilege on the parent schema + // The caller must satisfy one of the following requirements: + // + // - Be a metastore admin + // - Be the owner of the parent catalog + // - Be the owner of the parent schema and have the **USE_CATALOG** privilege + // on the parent catalog + // - Have the **USE_CATALOG** privilege on the parent catalog and the + // **USE_SCHEMA** privilege on the parent schema, and either be the table + // owner or have the **SELECT** privilege on the table. + // - Have **BROWSE** privilege on the parent catalog + // - Have **BROWSE** privilege on the parent schema Exists(ctx context.Context, request ExistsRequest) (*TableExistsResponse, error) // Gets if a table exists in the metastore for a specific catalog and schema. - // The caller must satisfy one of the following requirements: * Be a metastore - // admin * Be the owner of the parent catalog * Be the owner of the parent - // schema and have the **USE_CATALOG** privilege on the parent catalog * Have - // the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** - // privilege on the parent schema, and either be the table owner or have the - // **SELECT** privilege on the table. * Have **BROWSE** privilege on the parent - // catalog * Have **BROWSE** privilege on the parent schema + // The caller must satisfy one of the following requirements: + // + // - Be a metastore admin + // - Be the owner of the parent catalog + // - Be the owner of the parent schema and have the **USE_CATALOG** privilege + // on the parent catalog + // - Have the **USE_CATALOG** privilege on the parent catalog and the + // **USE_SCHEMA** privilege on the parent schema, and either be the table + // owner or have the **SELECT** privilege on the table. + // - Have **BROWSE** privilege on the parent catalog + // - Have **BROWSE** privilege on the parent schema ExistsByFullName(ctx context.Context, fullName string) (*TableExistsResponse, error) // Gets a table from the metastore for a specific catalog and schema. The caller - // must satisfy one of the following requirements: * Be a metastore admin * Be - // the owner of the parent catalog * Be the owner of the parent schema and have - // the **USE_CATALOG** privilege on the parent catalog * Have the - // **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** - // privilege on the parent schema, and either be the table owner or have the - // **SELECT** privilege on the table. + // must satisfy one of the following requirements: + // + // - Be a metastore admin + // - Be the owner of the parent catalog + // - Be the owner of the parent schema and have the **USE_CATALOG** privilege + // on the parent catalog + // - Have the **USE_CATALOG** privilege on the parent catalog and the + // **USE_SCHEMA** privilege on the parent schema, and either be the table + // owner or have the **SELECT** privilege on the table. Get(ctx context.Context, request GetTableRequest) (*TableInfo, error) // Gets a table from the metastore for a specific catalog and schema. The caller - // must satisfy one of the following requirements: * Be a metastore admin * Be - // the owner of the parent catalog * Be the owner of the parent schema and have - // the **USE_CATALOG** privilege on the parent catalog * Have the - // **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** - // privilege on the parent schema, and either be the table owner or have the - // **SELECT** privilege on the table. + // must satisfy one of the following requirements: + // + // - Be a metastore admin + // - Be the owner of the parent catalog + // - Be the owner of the parent schema and have the **USE_CATALOG** privilege + // on the parent catalog + // - Have the **USE_CATALOG** privilege on the parent catalog and the + // **USE_SCHEMA** privilege on the parent schema, and either be the table + // owner or have the **SELECT** privilege on the table. GetByFullName(ctx context.Context, fullName string) (*TableInfo, error) // Gets an array of all tables for the current metastore under the parent @@ -2943,12 +3041,13 @@ type TablesInterface interface { // Gets an array of summaries for tables for a schema and catalog within the // metastore. The table summaries returned are either: // - // * summaries for tables (within the current metastore and parent catalog and - // schema), when the user is a metastore admin, or: * summaries for tables and - // schemas (within the current metastore and parent catalog) for which the user - // has ownership or the **SELECT** privilege on the table and ownership or - // **USE_SCHEMA** privilege on the schema, provided that the user also has - // ownership or the **USE_CATALOG** privilege on the parent catalog. + // - summaries for tables (within the current metastore and parent catalog and + // schema), when the user is a metastore admin, or: + // - summaries for tables and schemas (within the current metastore and parent + // catalog) for which the user has ownership or the **SELECT** privilege on + // the table and ownership or **USE_SCHEMA** privilege on the schema, + // provided that the user also has ownership or the **USE_CATALOG** + // privilege on the parent catalog. // // There is no guarantee of a specific ordering of the elements in the array. // @@ -2963,12 +3062,13 @@ type TablesInterface interface { // Gets an array of summaries for tables for a schema and catalog within the // metastore. The table summaries returned are either: // - // * summaries for tables (within the current metastore and parent catalog and - // schema), when the user is a metastore admin, or: * summaries for tables and - // schemas (within the current metastore and parent catalog) for which the user - // has ownership or the **SELECT** privilege on the table and ownership or - // **USE_SCHEMA** privilege on the schema, provided that the user also has - // ownership or the **USE_CATALOG** privilege on the parent catalog. + // - summaries for tables (within the current metastore and parent catalog and + // schema), when the user is a metastore admin, or: + // - summaries for tables and schemas (within the current metastore and parent + // catalog) for which the user has ownership or the **SELECT** privilege on + // the table and ownership or **USE_SCHEMA** privilege on the schema, + // provided that the user also has ownership or the **USE_CATALOG** + // privilege on the parent catalog. // // There is no guarantee of a specific ordering of the elements in the array. // @@ -3004,7 +3104,7 @@ func NewTables(client *client.DatabricksClient) *TablesAPI { // permission on its parent catalog and the USE_SCHEMA permission on its parent // schema. // -// A table can be managed or external. From an API perspective, a __VIEW__ is a +// A table can be managed or external. From an API perspective, a **VIEW** is a // particular kind of table (rather than a managed or external table). type TablesAPI struct { tablesImpl @@ -3022,13 +3122,17 @@ func (a *TablesAPI) DeleteByFullName(ctx context.Context, fullName string) error } // Gets if a table exists in the metastore for a specific catalog and schema. -// The caller must satisfy one of the following requirements: * Be a metastore -// admin * Be the owner of the parent catalog * Be the owner of the parent -// schema and have the **USE_CATALOG** privilege on the parent catalog * Have -// the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** -// privilege on the parent schema, and either be the table owner or have the -// **SELECT** privilege on the table. * Have **BROWSE** privilege on the parent -// catalog * Have **BROWSE** privilege on the parent schema +// The caller must satisfy one of the following requirements: +// +// - Be a metastore admin +// - Be the owner of the parent catalog +// - Be the owner of the parent schema and have the **USE_CATALOG** privilege +// on the parent catalog +// - Have the **USE_CATALOG** privilege on the parent catalog and the +// **USE_SCHEMA** privilege on the parent schema, and either be the table +// owner or have the **SELECT** privilege on the table. +// - Have **BROWSE** privilege on the parent catalog +// - Have **BROWSE** privilege on the parent schema func (a *TablesAPI) ExistsByFullName(ctx context.Context, fullName string) (*TableExistsResponse, error) { return a.tablesImpl.Exists(ctx, ExistsRequest{ FullName: fullName, @@ -3036,12 +3140,15 @@ func (a *TablesAPI) ExistsByFullName(ctx context.Context, fullName string) (*Tab } // Gets a table from the metastore for a specific catalog and schema. The caller -// must satisfy one of the following requirements: * Be a metastore admin * Be -// the owner of the parent catalog * Be the owner of the parent schema and have -// the **USE_CATALOG** privilege on the parent catalog * Have the -// **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** -// privilege on the parent schema, and either be the table owner or have the -// **SELECT** privilege on the table. +// must satisfy one of the following requirements: +// +// - Be a metastore admin +// - Be the owner of the parent catalog +// - Be the owner of the parent schema and have the **USE_CATALOG** privilege +// on the parent catalog +// - Have the **USE_CATALOG** privilege on the parent catalog and the +// **USE_SCHEMA** privilege on the parent schema, and either be the table +// owner or have the **SELECT** privilege on the table. func (a *TablesAPI) GetByFullName(ctx context.Context, fullName string) (*TableInfo, error) { return a.tablesImpl.Get(ctx, GetTableRequest{ FullName: fullName, @@ -3189,16 +3296,21 @@ type VolumesInterface interface { // the parent schema, or the parent catalog, or the Metastore. // // For the volume creation to succeed, the user must satisfy following - // conditions: - The caller must be a metastore admin, or be the owner of the - // parent catalog and schema, or have the **USE_CATALOG** privilege on the - // parent catalog and the **USE_SCHEMA** privilege on the parent schema. - The - // caller must have **CREATE VOLUME** privilege on the parent schema. - // - // For an external volume, following conditions also need to satisfy - The - // caller must have **CREATE EXTERNAL VOLUME** privilege on the external - // location. - There are no other tables, nor volumes existing in the specified - // storage location. - The specified storage location is not under the location - // of other tables, nor volumes, or catalogs or schemas. + // conditions: + // + // - The caller must be a metastore admin, or be the owner of the parent + // catalog and schema, or have the **USE_CATALOG** privilege on the parent + // catalog and the **USE_SCHEMA** privilege on the parent schema. + // - The caller must have **CREATE VOLUME** privilege on the parent schema. + // + // For an external volume, following conditions also need to satisfy + // + // - The caller must have **CREATE EXTERNAL VOLUME** privilege on the external + // location. + // - There are no other tables, nor volumes existing in the specified storage + // location. + // - The specified storage location is not under the location of other tables, + // nor volumes, or catalogs or schemas. Create(ctx context.Context, request CreateVolumeRequestContent) (*VolumeInfo, error) // Deletes a volume from the specified parent catalog and schema. @@ -3467,14 +3579,14 @@ func NewWorkspaceBindings(client *client.DatabricksClient) *WorkspaceBindingsAPI } } -// A securable in Databricks can be configured as __OPEN__ or __ISOLATED__. An -// __OPEN__ securable can be accessed from any workspace, while an __ISOLATED__ +// A securable in Databricks can be configured as **OPEN** or **ISOLATED**. An +// **OPEN** securable can be accessed from any workspace, while an **ISOLATED** // securable can only be accessed from a configured list of workspaces. This API // allows you to configure (bind) securables to workspaces. // -// NOTE: The __isolation_mode__ is configured for the securable itself (using +// NOTE: The **isolation_mode** is configured for the securable itself (using // its Update method) and the workspace bindings are only consulted when the -// securable's __isolation_mode__ is set to __ISOLATED__. +// securable's **isolation_mode** is set to **ISOLATED**. // // A securable's workspace bindings can be configured by a metastore admin or // the owner of the securable. @@ -3484,8 +3596,12 @@ func NewWorkspaceBindings(client *client.DatabricksClient) *WorkspaceBindingsAPI // (/api/2.1/unity-catalog/bindings/{securable_type}/{securable_name}) which // introduces the ability to bind a securable in READ_ONLY mode (catalogs only). // -// Securable types that support binding: - catalog - storage_credential - -// credential - external_location +// Securable types that support binding: +// +// - catalog +// - storage_credential +// - credential +// - external_location type WorkspaceBindingsAPI struct { workspaceBindingsImpl } diff --git a/service/catalog/impl.go b/service/catalog/impl.go index 16e5d1d89..07c55005f 100755 --- a/service/catalog/impl.go +++ b/service/catalog/impl.go @@ -635,7 +635,7 @@ func (a *credentialsImpl) GetCredential(ctx context.Context, request GetCredenti return &credentialInfo, err } -// Gets an array of credentials (as __CredentialInfo__ objects). +// Gets an array of credentials (as **CredentialInfo** objects). // // The array is limited to only the credentials that the caller has permission // to access. If the caller is a metastore admin, retrieval of credentials is @@ -670,7 +670,7 @@ func (a *credentialsImpl) ListCredentials(ctx context.Context, request ListCrede return iterator } -// Gets an array of credentials (as __CredentialInfo__ objects). +// Gets an array of credentials (as **CredentialInfo** objects). // // The array is limited to only the credentials that the caller has permission // to access. If the caller is a metastore admin, retrieval of credentials is @@ -997,7 +997,7 @@ func (a *externalLocationsImpl) Get(ctx context.Context, request GetExternalLoca return &externalLocationInfo, err } -// Gets an array of external locations (__ExternalLocationInfo__ objects) from +// Gets an array of external locations (**ExternalLocationInfo** objects) from // the metastore. The caller must be a metastore admin, the owner of the // external location, or a user that has some privilege on the external // location. There is no guarantee of a specific ordering of the elements in the @@ -1036,7 +1036,7 @@ func (a *externalLocationsImpl) List(ctx context.Context, request ListExternalLo return iterator } -// Gets an array of external locations (__ExternalLocationInfo__ objects) from +// Gets an array of external locations (**ExternalLocationInfo** objects) from // the metastore. The caller must be a metastore admin, the owner of the // external location, or a user that has some privilege on the external // location. There is no guarantee of a specific ordering of the elements in the @@ -1461,7 +1461,7 @@ func (a *metastoresImpl) Get(ctx context.Context, request GetMetastoreRequest) ( return &metastoreInfo, err } -// Gets an array of the available metastores (as __MetastoreInfo__ objects). The +// Gets an array of the available metastores (as **MetastoreInfo** objects). The // caller must be an admin to retrieve this info. There is no guarantee of a // specific ordering of the elements in the array. // @@ -1498,7 +1498,7 @@ func (a *metastoresImpl) List(ctx context.Context, request ListMetastoresRequest return iterator } -// Gets an array of the available metastores (as __MetastoreInfo__ objects). The +// Gets an array of the available metastores (as **MetastoreInfo** objects). The // caller must be an admin to retrieve this info. There is no guarantee of a // specific ordering of the elements in the array. // @@ -2633,7 +2633,7 @@ func (a *storageCredentialsImpl) Get(ctx context.Context, request GetStorageCred return &storageCredentialInfo, err } -// Gets an array of storage credentials (as __StorageCredentialInfo__ objects). +// Gets an array of storage credentials (as **StorageCredentialInfo** objects). // The array is limited to only those storage credentials the caller has // permission to access. If the caller is a metastore admin, retrieval of // credentials is unrestricted. There is no guarantee of a specific ordering of @@ -2672,7 +2672,7 @@ func (a *storageCredentialsImpl) List(ctx context.Context, request ListStorageCr return iterator } -// Gets an array of storage credentials (as __StorageCredentialInfo__ objects). +// Gets an array of storage credentials (as **StorageCredentialInfo** objects). // The array is limited to only those storage credentials the caller has // permission to access. If the caller is a metastore admin, retrieval of // credentials is unrestricted. There is no guarantee of a specific ordering of @@ -3007,12 +3007,13 @@ func (a *tablesImpl) internalList(ctx context.Context, request ListTablesRequest // Gets an array of summaries for tables for a schema and catalog within the // metastore. The table summaries returned are either: // -// * summaries for tables (within the current metastore and parent catalog and -// schema), when the user is a metastore admin, or: * summaries for tables and -// schemas (within the current metastore and parent catalog) for which the user -// has ownership or the **SELECT** privilege on the table and ownership or -// **USE_SCHEMA** privilege on the schema, provided that the user also has -// ownership or the **USE_CATALOG** privilege on the parent catalog. +// - summaries for tables (within the current metastore and parent catalog and +// schema), when the user is a metastore admin, or: +// - summaries for tables and schemas (within the current metastore and parent +// catalog) for which the user has ownership or the **SELECT** privilege on +// the table and ownership or **USE_SCHEMA** privilege on the schema, +// provided that the user also has ownership or the **USE_CATALOG** +// privilege on the parent catalog. // // There is no guarantee of a specific ordering of the elements in the array. // @@ -3047,12 +3048,13 @@ func (a *tablesImpl) ListSummaries(ctx context.Context, request ListSummariesReq // Gets an array of summaries for tables for a schema and catalog within the // metastore. The table summaries returned are either: // -// * summaries for tables (within the current metastore and parent catalog and -// schema), when the user is a metastore admin, or: * summaries for tables and -// schemas (within the current metastore and parent catalog) for which the user -// has ownership or the **SELECT** privilege on the table and ownership or -// **USE_SCHEMA** privilege on the schema, provided that the user also has -// ownership or the **USE_CATALOG** privilege on the parent catalog. +// - summaries for tables (within the current metastore and parent catalog and +// schema), when the user is a metastore admin, or: +// - summaries for tables and schemas (within the current metastore and parent +// catalog) for which the user has ownership or the **SELECT** privilege on +// the table and ownership or **USE_SCHEMA** privilege on the schema, +// provided that the user also has ownership or the **USE_CATALOG** +// privilege on the parent catalog. // // There is no guarantee of a specific ordering of the elements in the array. // diff --git a/service/catalog/interface.go b/service/catalog/interface.go index 0c27459a7..d9e24da8c 100755 --- a/service/catalog/interface.go +++ b/service/catalog/interface.go @@ -62,8 +62,11 @@ type AccountMetastoresService interface { type AccountStorageCredentialsService interface { // Creates a new storage credential. The request object is specific to the - // cloud: - **AwsIamRole** for AWS credentials - **AzureServicePrincipal** - // for Azure credentials - **GcpServiceAccountKey** for GCP credentials + // cloud: + // + // - **AwsIamRole** for AWS credentials + // - **AzureServicePrincipal** for Azure credentials + // - **GcpServiceAccountKey** for GCP credentials // // The caller must be a metastore admin and have the // `CREATE_STORAGE_CREDENTIAL` privilege on the metastore. @@ -231,7 +234,7 @@ type CredentialsService interface { // on the credential. GetCredential(ctx context.Context, request GetCredentialRequest) (*CredentialInfo, error) - // Gets an array of credentials (as __CredentialInfo__ objects). + // Gets an array of credentials (as **CredentialInfo** objects). // // The array is limited to only the credentials that the caller has // permission to access. If the caller is a metastore admin, retrieval of @@ -248,20 +251,20 @@ type CredentialsService interface { // // The caller must be the owner of the credential or a metastore admin or // have the `MANAGE` permission. If the caller is a metastore admin, only - // the __owner__ field can be changed. + // the **owner** field can be changed. UpdateCredential(ctx context.Context, request UpdateCredentialRequest) (*CredentialInfo, error) // Validates a credential. // // For service credentials (purpose is **SERVICE**), either the - // __credential_name__ or the cloud-specific credential must be provided. + // **credential_name** or the cloud-specific credential must be provided. // // For storage credentials (purpose is **STORAGE**), at least one of - // __external_location_name__ and __url__ need to be provided. If only one + // **external_location_name** and **url** need to be provided. If only one // of them is provided, it will be used for validation. And if both are - // provided, the __url__ will be used for validation, and - // __external_location_name__ will be ignored when checking overlapping - // urls. Either the __credential_name__ or the cloud-specific credential + // provided, the **url** will be used for validation, and + // **external_location_name** will be ignored when checking overlapping + // urls. Either the **credential_name** or the cloud-specific credential // must be provided. // // The caller must be a metastore admin or the credential owner or have the @@ -282,9 +285,11 @@ type EntityTagAssignmentsService interface { // Creates a tag assignment for an Unity Catalog entity. // // To add tags to Unity Catalog entities, you must own the entity or have - // the following privileges: - **APPLY TAG** on the entity - **USE SCHEMA** - // on the entity's parent schema - **USE CATALOG** on the entity's parent - // catalog + // the following privileges: + // + // - **APPLY TAG** on the entity + // - **USE SCHEMA** on the entity's parent schema + // - **USE CATALOG** on the entity's parent catalog // // To add a governed tag to Unity Catalog entities, you must also have the // **ASSIGN** or **MANAGE** permission on the tag policy. See [Manage tag @@ -296,9 +301,11 @@ type EntityTagAssignmentsService interface { // Deletes a tag assignment for an Unity Catalog entity by its key. // // To delete tags from Unity Catalog entities, you must own the entity or - // have the following privileges: - **APPLY TAG** on the entity - - // **USE_SCHEMA** on the entity's parent schema - **USE_CATALOG** on the - // entity's parent catalog + // have the following privileges: + // + // - **APPLY TAG** on the entity + // - **USE_SCHEMA** on the entity's parent schema + // - **USE_CATALOG** on the entity's parent catalog // // To delete a governed tag from Unity Catalog entities, you must also have // the **ASSIGN** or **MANAGE** permission on the tag policy. See [Manage @@ -321,9 +328,11 @@ type EntityTagAssignmentsService interface { // Updates an existing tag assignment for an Unity Catalog entity. // // To update tags to Unity Catalog entities, you must own the entity or have - // the following privileges: - **APPLY TAG** on the entity - **USE SCHEMA** - // on the entity's parent schema - **USE CATALOG** on the entity's parent - // catalog + // the following privileges: + // + // - **APPLY TAG** on the entity + // - **USE SCHEMA** on the entity's parent schema + // - **USE CATALOG** on the entity's parent catalog // // To update a governed tag to Unity Catalog entities, you must also have // the **ASSIGN** or **MANAGE** permission on the tag policy. See [Manage @@ -392,7 +401,7 @@ type ExternalLocationsService interface { // some privilege on the external location. Get(ctx context.Context, request GetExternalLocationRequest) (*ExternalLocationInfo, error) - // Gets an array of external locations (__ExternalLocationInfo__ objects) + // Gets an array of external locations (**ExternalLocationInfo** objects) // from the metastore. The caller must be a metastore admin, the owner of // the external location, or a user that has some privilege on the external // location. There is no guarantee of a specific ordering of the elements in @@ -461,7 +470,7 @@ type ExternalMetadataService interface { // The function implementation can be any SQL expression or Query, and it can be // invoked wherever a table reference is allowed in a query. In Unity Catalog, a // function resides at the same level as a table, so it can be referenced with -// the form __catalog_name__.__schema_name__.__function_name__. +// the form **catalog_name**.**schema_name**.**function_name**. // // Deprecated: Do not use this interface, it will be removed in a future version of the SDK. type FunctionsService interface { @@ -471,26 +480,34 @@ type FunctionsService interface { // Creates a new function // // The user must have the following permissions in order for the function to - // be created: - **USE_CATALOG** on the function's parent catalog - - // **USE_SCHEMA** and **CREATE_FUNCTION** on the function's parent schema + // be created: + // + // - **USE_CATALOG** on the function's parent catalog + // - **USE_SCHEMA** and **CREATE_FUNCTION** on the function's parent + // schema Create(ctx context.Context, request CreateFunctionRequest) (*FunctionInfo, error) // Deletes the function that matches the supplied name. For the deletion to - // succeed, the user must satisfy one of the following conditions: - Is the - // owner of the function's parent catalog - Is the owner of the function's - // parent schema and have the **USE_CATALOG** privilege on its parent - // catalog - Is the owner of the function itself and have both the - // **USE_CATALOG** privilege on its parent catalog and the **USE_SCHEMA** - // privilege on its parent schema + // succeed, the user must satisfy one of the following conditions: + // + // - Is the owner of the function's parent catalog + // - Is the owner of the function's parent schema and have the + // **USE_CATALOG** privilege on its parent catalog + // - Is the owner of the function itself and have both the **USE_CATALOG** + // privilege on its parent catalog and the **USE_SCHEMA** privilege on + // its parent schema Delete(ctx context.Context, request DeleteFunctionRequest) error // Gets a function from within a parent catalog and schema. For the fetch to - // succeed, the user must satisfy one of the following requirements: - Is a - // metastore admin - Is an owner of the function's parent catalog - Have the - // **USE_CATALOG** privilege on the function's parent catalog and be the - // owner of the function - Have the **USE_CATALOG** privilege on the - // function's parent catalog, the **USE_SCHEMA** privilege on the function's - // parent schema, and the **EXECUTE** privilege on the function itself + // succeed, the user must satisfy one of the following requirements: + // + // - Is a metastore admin + // - Is an owner of the function's parent catalog + // - Have the **USE_CATALOG** privilege on the function's parent catalog + // and be the owner of the function + // - Have the **USE_CATALOG** privilege on the function's parent catalog, + // the **USE_SCHEMA** privilege on the function's parent schema, and the + // **EXECUTE** privilege on the function itself Get(ctx context.Context, request GetFunctionRequest) (*FunctionInfo, error) // List functions within the specified parent catalog and schema. If the @@ -512,12 +529,15 @@ type FunctionsService interface { // Updates the function that matches the supplied name. Only the owner of // the function can be updated. If the user is not a metastore admin, the - // user must be a member of the group that is the new function owner. - Is a - // metastore admin - Is the owner of the function's parent catalog - Is the - // owner of the function's parent schema and has the **USE_CATALOG** - // privilege on its parent catalog - Is the owner of the function itself and - // has the **USE_CATALOG** privilege on its parent catalog as well as the - // **USE_SCHEMA** privilege on the function's parent schema. + // user must be a member of the group that is the new function owner. + // + // - Is a metastore admin + // - Is the owner of the function's parent catalog + // - Is the owner of the function's parent schema and has the + // **USE_CATALOG** privilege on its parent catalog + // - Is the owner of the function itself and has the **USE_CATALOG** + // privilege on its parent catalog as well as the **USE_SCHEMA** + // privilege on the function's parent schema. Update(ctx context.Context, request UpdateFunction) (*FunctionInfo, error) } @@ -583,15 +603,15 @@ type GrantsService interface { type MetastoresService interface { // Creates a new metastore assignment. If an assignment for the same - // __workspace_id__ exists, it will be overwritten by the new - // __metastore_id__ and __default_catalog_name__. The caller must be an + // **workspace_id** exists, it will be overwritten by the new + // **metastore_id** and **default_catalog_name**. The caller must be an // account admin. Assign(ctx context.Context, request CreateMetastoreAssignment) error // Creates a new metastore based on a provided name and optional storage - // root path. By default (if the __owner__ field is not set), the owner of - // the new metastore is the user calling the __createMetastore__ API. If the - // __owner__ field is set to the empty string (**""**), the ownership is + // root path. By default (if the **owner** field is not set), the owner of + // the new metastore is the user calling the **createMetastore** API. If the + // **owner** field is set to the empty string (**""**), the ownership is // assigned to the System User instead. Create(ctx context.Context, request CreateMetastore) (*MetastoreInfo, error) @@ -605,7 +625,7 @@ type MetastoresService interface { // metastore admin to retrieve this info. Get(ctx context.Context, request GetMetastoreRequest) (*MetastoreInfo, error) - // Gets an array of the available metastores (as __MetastoreInfo__ objects). + // Gets an array of the available metastores (as **MetastoreInfo** objects). // The caller must be an admin to retrieve this info. There is no guarantee // of a specific ordering of the elements in the array. // @@ -628,14 +648,14 @@ type MetastoresService interface { Unassign(ctx context.Context, request UnassignRequest) error // Updates information for a specific metastore. The caller must be a - // metastore admin. If the __owner__ field is set to the empty string + // metastore admin. If the **owner** field is set to the empty string // (**""**), the ownership is updated to the System User. Update(ctx context.Context, request UpdateMetastore) (*MetastoreInfo, error) // Updates a metastore assignment. This operation can be used to update - // __metastore_id__ or __default_catalog_name__ for a specified Workspace, + // **metastore_id** or **default_catalog_name** for a specified Workspace, // if the Workspace is already assigned a metastore. The caller must be an - // account admin to update __metastore_id__; otherwise, the caller can be a + // account admin to update **metastore_id**; otherwise, the caller can be a // Workspace admin. UpdateAssignment(ctx context.Context, request UpdateMetastoreAssignment) error } @@ -645,8 +665,7 @@ type MetastoresService interface { // auditing, lineage, and discovery of ML models across Databricks workspaces. // // This API reference documents the REST endpoints for managing model versions -// in Unity Catalog. For more details, see the [registered models API -// docs](/api/workspace/registeredmodels). +// in Unity Catalog. For more details, see the registered models API docs. // // Deprecated: Do not use this interface, it will be removed in a future version of the SDK. type ModelVersionsService interface { @@ -787,13 +806,17 @@ type QualityMonitorsService interface { // (/api/data-quality/v1/monitors). Creates a new monitor for the specified // table. // - // The caller must either: 1. be an owner of the table's parent catalog, - // have **USE_SCHEMA** on the table's parent schema, and have **SELECT** - // access on the table 2. have **USE_CATALOG** on the table's parent - // catalog, be an owner of the table's parent schema, and have **SELECT** - // access on the table. 3. have the following permissions: - **USE_CATALOG** - // on the table's parent catalog - **USE_SCHEMA** on the table's parent - // schema - be an owner of the table. + // The caller must either: + // + // 1. be an owner of the table's parent catalog, have **USE_SCHEMA** on the + // table's parent schema, and have **SELECT** access on the table + // 2. have **USE_CATALOG** on the table's parent catalog, be an owner of + // the table's parent schema, and have **SELECT** access on the table. + // 3. have the following permissions: + // + // - **USE_CATALOG** on the table's parent catalog + // - **USE_SCHEMA** on the table's parent schema + // - be an owner of the table. // // Workspace assets, such as the dashboard, will be created in the workspace // where this call was made. @@ -803,11 +826,16 @@ type QualityMonitorsService interface { // (/api/data-quality/v1/monitors). Deletes a monitor for the specified // table. // - // The caller must either: 1. be an owner of the table's parent catalog 2. - // have **USE_CATALOG** on the table's parent catalog and be an owner of the - // table's parent schema 3. have the following permissions: - - // **USE_CATALOG** on the table's parent catalog - **USE_SCHEMA** on the - // table's parent schema - be an owner of the table. + // The caller must either: + // + // 1. be an owner of the table's parent catalog + // 2. have **USE_CATALOG** on the table's parent catalog and be an owner of + // the table's parent schema + // 3. have the following permissions: + // + // - **USE_CATALOG** on the table's parent catalog + // - **USE_SCHEMA** on the table's parent schema + // - be an owner of the table. // // Additionally, the call must be made from the workspace where the monitor // was created. @@ -819,11 +847,16 @@ type QualityMonitorsService interface { // Deprecated: Use Data Quality Monitors API instead // (/api/data-quality/v1/monitors). Gets a monitor for the specified table. // - // The caller must either: 1. be an owner of the table's parent catalog 2. - // have **USE_CATALOG** on the table's parent catalog and be an owner of the - // table's parent schema. 3. have the following permissions: - - // **USE_CATALOG** on the table's parent catalog - **USE_SCHEMA** on the - // table's parent schema - **SELECT** privilege on the table. + // The caller must either: + // + // 1. be an owner of the table's parent catalog + // 2. have **USE_CATALOG** on the table's parent catalog and be an owner of + // the table's parent schema. + // 3. have the following permissions: + // + // - **USE_CATALOG** on the table's parent catalog + // - **USE_SCHEMA** on the table's parent schema + // - **SELECT** privilege on the table. // // The returned information includes configuration values, as well as // information on assets created by the monitor. Some information (e.g., @@ -835,11 +868,16 @@ type QualityMonitorsService interface { // (/api/data-quality/v1/monitors). Gets info about a specific monitor // refresh using the given refresh ID. // - // The caller must either: 1. be an owner of the table's parent catalog 2. - // have **USE_CATALOG** on the table's parent catalog and be an owner of the - // table's parent schema 3. have the following permissions: - - // **USE_CATALOG** on the table's parent catalog - **USE_SCHEMA** on the - // table's parent schema - **SELECT** privilege on the table. + // The caller must either: + // + // 1. be an owner of the table's parent catalog + // 2. have **USE_CATALOG** on the table's parent catalog and be an owner of + // the table's parent schema + // 3. have the following permissions: + // + // - **USE_CATALOG** on the table's parent catalog + // - **USE_SCHEMA** on the table's parent schema + // - **SELECT** privilege on the table. // // Additionally, the call must be made from the workspace where the monitor // was created. @@ -849,11 +887,16 @@ type QualityMonitorsService interface { // (/api/data-quality/v1/monitors). Gets an array containing the history of // the most recent refreshes (up to 25) for this table. // - // The caller must either: 1. be an owner of the table's parent catalog 2. - // have **USE_CATALOG** on the table's parent catalog and be an owner of the - // table's parent schema 3. have the following permissions: - - // **USE_CATALOG** on the table's parent catalog - **USE_SCHEMA** on the - // table's parent schema - **SELECT** privilege on the table. + // The caller must either: + // + // 1. be an owner of the table's parent catalog + // 2. have **USE_CATALOG** on the table's parent catalog and be an owner of + // the table's parent schema + // 3. have the following permissions: + // + // - **USE_CATALOG** on the table's parent catalog + // - **USE_SCHEMA** on the table's parent schema + // - **SELECT** privilege on the table. // // Additionally, the call must be made from the workspace where the monitor // was created. @@ -863,11 +906,16 @@ type QualityMonitorsService interface { // (/api/data-quality/v1/monitors). Regenerates the monitoring dashboard for // the specified table. // - // The caller must either: 1. be an owner of the table's parent catalog 2. - // have **USE_CATALOG** on the table's parent catalog and be an owner of the - // table's parent schema 3. have the following permissions: - - // **USE_CATALOG** on the table's parent catalog - **USE_SCHEMA** on the - // table's parent schema - be an owner of the table + // The caller must either: + // + // 1. be an owner of the table's parent catalog + // 2. have **USE_CATALOG** on the table's parent catalog and be an owner of + // the table's parent schema + // 3. have the following permissions: + // + // - **USE_CATALOG** on the table's parent catalog + // - **USE_SCHEMA** on the table's parent schema + // - be an owner of the table // // The call must be made from the workspace where the monitor was created. // The dashboard will be regenerated in the assets directory that was @@ -878,11 +926,16 @@ type QualityMonitorsService interface { // (/api/data-quality/v1/monitors). Queues a metric refresh on the monitor // for the specified table. The refresh will execute in the background. // - // The caller must either: 1. be an owner of the table's parent catalog 2. - // have **USE_CATALOG** on the table's parent catalog and be an owner of the - // table's parent schema 3. have the following permissions: - - // **USE_CATALOG** on the table's parent catalog - **USE_SCHEMA** on the - // table's parent schema - be an owner of the table + // The caller must either: + // + // 1. be an owner of the table's parent catalog + // 2. have **USE_CATALOG** on the table's parent catalog and be an owner of + // the table's parent schema + // 3. have the following permissions: + // + // - **USE_CATALOG** on the table's parent catalog + // - **USE_SCHEMA** on the table's parent schema + // - be an owner of the table // // Additionally, the call must be made from the workspace where the monitor // was created. @@ -892,11 +945,16 @@ type QualityMonitorsService interface { // (/api/data-quality/v1/monitors). Updates a monitor for the specified // table. // - // The caller must either: 1. be an owner of the table's parent catalog 2. - // have **USE_CATALOG** on the table's parent catalog and be an owner of the - // table's parent schema 3. have the following permissions: - - // **USE_CATALOG** on the table's parent catalog - **USE_SCHEMA** on the - // table's parent schema - be an owner of the table. + // The caller must either: + // + // 1. be an owner of the table's parent catalog + // 2. have **USE_CATALOG** on the table's parent catalog and be an owner of + // the table's parent schema + // 3. have the following permissions: + // + // - **USE_CATALOG** on the table's parent catalog + // - **USE_SCHEMA** on the table's parent schema + // - be an owner of the table. // // Additionally, the call must be made from the workspace where the monitor // was created, and the caller must be the original creator of the monitor. @@ -922,15 +980,16 @@ type QualityMonitorsService interface { // enclosing schema. In addition, the following additional privileges are // required for various operations: // -// * To create a registered model, users must additionally have the CREATE_MODEL -// permission on the target schema. * To view registered model or model version -// metadata, model version data files, or invoke a model version, users must -// additionally have the EXECUTE permission on the registered model * To update -// registered model or model version tags, users must additionally have APPLY -// TAG permissions on the registered model * To update other registered model or -// model version metadata (comments, aliases) create a new model version, or -// update permissions on the registered model, users must be owners of the -// registered model. +// - To create a registered model, users must additionally have the +// CREATE_MODEL permission on the target schema. +// - To view registered model or model version metadata, model version data +// files, or invoke a model version, users must additionally have the +// EXECUTE permission on the registered model +// - To update registered model or model version tags, users must additionally +// have APPLY TAG permissions on the registered model +// - To update other registered model or model version metadata (comments, +// aliases) create a new model version, or update permissions on the +// registered model, users must be owners of the registered model. // // Note: The securable type for models is FUNCTION. When using REST APIs (e.g. // tagging, grants) that specify a securable type, use FUNCTION as the securable @@ -946,11 +1005,13 @@ type RegisteredModelsService interface { // parent catalog, or the Metastore. // // For registered model creation to succeed, the user must satisfy the - // following conditions: - The caller must be a metastore admin, or be the - // owner of the parent catalog and schema, or have the **USE_CATALOG** - // privilege on the parent catalog and the **USE_SCHEMA** privilege on the - // parent schema. - The caller must have the **CREATE MODEL** or **CREATE - // FUNCTION** privilege on the parent schema. + // following conditions: + // + // - The caller must be a metastore admin, or be the owner of the parent + // catalog and schema, or have the **USE_CATALOG** privilege on the + // parent catalog and the **USE_SCHEMA** privilege on the parent schema. + // - The caller must have the **CREATE MODEL** or **CREATE FUNCTION** + // privilege on the parent schema. Create(ctx context.Context, request CreateRegisteredModelRequest) (*RegisteredModelInfo, error) // Deletes a registered model and all its model versions from the specified @@ -1134,7 +1195,7 @@ type SchemasService interface { // Updates a schema for a catalog. The caller must be the owner of the // schema or a metastore admin. If the caller is a metastore admin, only the - // __owner__ field can be changed in the update. If the __name__ field must + // **owner** field can be changed in the update. If the **name** field must // be updated, the caller must be a metastore admin or have the // **CREATE_SCHEMA** privilege on the parent catalog. Update(ctx context.Context, request UpdateSchema) (*SchemaInfo, error) @@ -1228,7 +1289,7 @@ type StorageCredentialsService interface { // permission on the storage credential. Get(ctx context.Context, request GetStorageCredentialRequest) (*StorageCredentialInfo, error) - // Gets an array of storage credentials (as __StorageCredentialInfo__ + // Gets an array of storage credentials (as **StorageCredentialInfo** // objects). The array is limited to only those storage credentials the // caller has permission to access. If the caller is a metastore admin, // retrieval of credentials is unrestricted. There is no guarantee of a @@ -1251,13 +1312,13 @@ type StorageCredentialsService interface { Update(ctx context.Context, request UpdateStorageCredential) (*StorageCredentialInfo, error) // Validates a storage credential. At least one of - // __external_location_name__ and __url__ need to be provided. If only one + // **external_location_name** and **url** need to be provided. If only one // of them is provided, it will be used for validation. And if both are - // provided, the __url__ will be used for validation, and - // __external_location_name__ will be ignored when checking overlapping + // provided, the **url** will be used for validation, and + // **external_location_name** will be ignored when checking overlapping // urls. // - // Either the __storage_credential_name__ or the cloud-specific credential + // Either the **storage_credential_name** or the cloud-specific credential // must be provided. // // The caller must be a metastore admin or the storage credential owner or @@ -1314,25 +1375,29 @@ type TableConstraintsService interface { // Creates a new table constraint. // // For the table constraint creation to succeed, the user must satisfy both - // of these conditions: - the user must have the **USE_CATALOG** privilege - // on the table's parent catalog, the **USE_SCHEMA** privilege on the - // table's parent schema, and be the owner of the table. - if the new - // constraint is a __ForeignKeyConstraint__, the user must have the - // **USE_CATALOG** privilege on the referenced parent table's catalog, the - // **USE_SCHEMA** privilege on the referenced parent table's schema, and be - // the owner of the referenced parent table. + // of these conditions: + // + // - the user must have the **USE_CATALOG** privilege on the table's + // parent catalog, the **USE_SCHEMA** privilege on the table's parent + // schema, and be the owner of the table. + // - if the new constraint is a **ForeignKeyConstraint**, the user must + // have the **USE_CATALOG** privilege on the referenced parent table's + // catalog, the **USE_SCHEMA** privilege on the referenced parent + // table's schema, and be the owner of the referenced parent table. Create(ctx context.Context, request CreateTableConstraint) (*TableConstraint, error) // Deletes a table constraint. // // For the table constraint deletion to succeed, the user must satisfy both - // of these conditions: - the user must have the **USE_CATALOG** privilege - // on the table's parent catalog, the **USE_SCHEMA** privilege on the - // table's parent schema, and be the owner of the table. - if __cascade__ - // argument is **true**, the user must have the following permissions on all - // of the child tables: the **USE_CATALOG** privilege on the table's - // catalog, the **USE_SCHEMA** privilege on the table's schema, and be the - // owner of the table. + // of these conditions: + // + // - the user must have the **USE_CATALOG** privilege on the table's + // parent catalog, the **USE_SCHEMA** privilege on the table's parent + // schema, and be the owner of the table. + // - if **cascade** argument is **true**, the user must have the following + // permissions on all of the child tables: the **USE_CATALOG** privilege + // on the table's catalog, the **USE_SCHEMA** privilege on the table's + // schema, and be the owner of the table. Delete(ctx context.Context, request DeleteTableConstraintRequest) error } @@ -1344,7 +1409,7 @@ type TableConstraintsService interface { // permission on its parent catalog and the USE_SCHEMA permission on its parent // schema. // -// A table can be managed or external. From an API perspective, a __VIEW__ is a +// A table can be managed or external. From an API perspective, a **VIEW** is a // particular kind of table (rather than a managed or external table). // // Deprecated: Do not use this interface, it will be removed in a future version of the SDK. @@ -1385,23 +1450,29 @@ type TablesService interface { Delete(ctx context.Context, request DeleteTableRequest) error // Gets if a table exists in the metastore for a specific catalog and - // schema. The caller must satisfy one of the following requirements: * Be a - // metastore admin * Be the owner of the parent catalog * Be the owner of - // the parent schema and have the **USE_CATALOG** privilege on the parent - // catalog * Have the **USE_CATALOG** privilege on the parent catalog and - // the **USE_SCHEMA** privilege on the parent schema, and either be the - // table owner or have the **SELECT** privilege on the table. * Have - // **BROWSE** privilege on the parent catalog * Have **BROWSE** privilege on - // the parent schema + // schema. The caller must satisfy one of the following requirements: + // + // - Be a metastore admin + // - Be the owner of the parent catalog + // - Be the owner of the parent schema and have the **USE_CATALOG** + // privilege on the parent catalog + // - Have the **USE_CATALOG** privilege on the parent catalog and the + // **USE_SCHEMA** privilege on the parent schema, and either be the + // table owner or have the **SELECT** privilege on the table. + // - Have **BROWSE** privilege on the parent catalog + // - Have **BROWSE** privilege on the parent schema Exists(ctx context.Context, request ExistsRequest) (*TableExistsResponse, error) // Gets a table from the metastore for a specific catalog and schema. The - // caller must satisfy one of the following requirements: * Be a metastore - // admin * Be the owner of the parent catalog * Be the owner of the parent - // schema and have the **USE_CATALOG** privilege on the parent catalog * - // Have the **USE_CATALOG** privilege on the parent catalog and the - // **USE_SCHEMA** privilege on the parent schema, and either be the table - // owner or have the **SELECT** privilege on the table. + // caller must satisfy one of the following requirements: + // + // - Be a metastore admin + // - Be the owner of the parent catalog + // - Be the owner of the parent schema and have the **USE_CATALOG** + // privilege on the parent catalog + // - Have the **USE_CATALOG** privilege on the parent catalog and the + // **USE_SCHEMA** privilege on the parent schema, and either be the + // table owner or have the **SELECT** privilege on the table. Get(ctx context.Context, request GetTableRequest) (*TableInfo, error) // Gets an array of all tables for the current metastore under the parent @@ -1427,13 +1498,13 @@ type TablesService interface { // Gets an array of summaries for tables for a schema and catalog within the // metastore. The table summaries returned are either: // - // * summaries for tables (within the current metastore and parent catalog - // and schema), when the user is a metastore admin, or: * summaries for - // tables and schemas (within the current metastore and parent catalog) for - // which the user has ownership or the **SELECT** privilege on the table and - // ownership or **USE_SCHEMA** privilege on the schema, provided that the - // user also has ownership or the **USE_CATALOG** privilege on the parent - // catalog. + // - summaries for tables (within the current metastore and parent catalog + // and schema), when the user is a metastore admin, or: + // - summaries for tables and schemas (within the current metastore and + // parent catalog) for which the user has ownership or the **SELECT** + // privilege on the table and ownership or **USE_SCHEMA** privilege on + // the schema, provided that the user also has ownership or the + // **USE_CATALOG** privilege on the parent catalog. // // There is no guarantee of a specific ordering of the elements in the // array. @@ -1574,16 +1645,22 @@ type VolumesService interface { // specified by the parent schema, or the parent catalog, or the Metastore. // // For the volume creation to succeed, the user must satisfy following - // conditions: - The caller must be a metastore admin, or be the owner of - // the parent catalog and schema, or have the **USE_CATALOG** privilege on - // the parent catalog and the **USE_SCHEMA** privilege on the parent schema. - // - The caller must have **CREATE VOLUME** privilege on the parent schema. - // - // For an external volume, following conditions also need to satisfy - The - // caller must have **CREATE EXTERNAL VOLUME** privilege on the external - // location. - There are no other tables, nor volumes existing in the - // specified storage location. - The specified storage location is not under - // the location of other tables, nor volumes, or catalogs or schemas. + // conditions: + // + // - The caller must be a metastore admin, or be the owner of the parent + // catalog and schema, or have the **USE_CATALOG** privilege on the + // parent catalog and the **USE_SCHEMA** privilege on the parent schema. + // - The caller must have **CREATE VOLUME** privilege on the parent + // schema. + // + // For an external volume, following conditions also need to satisfy + // + // - The caller must have **CREATE EXTERNAL VOLUME** privilege on the + // external location. + // - There are no other tables, nor volumes existing in the specified + // storage location. + // - The specified storage location is not under the location of other + // tables, nor volumes, or catalogs or schemas. Create(ctx context.Context, request CreateVolumeRequestContent) (*VolumeInfo, error) // Deletes a volume from the specified parent catalog and schema. @@ -1635,14 +1712,14 @@ type VolumesService interface { Update(ctx context.Context, request UpdateVolumeRequestContent) (*VolumeInfo, error) } -// A securable in Databricks can be configured as __OPEN__ or __ISOLATED__. An -// __OPEN__ securable can be accessed from any workspace, while an __ISOLATED__ +// A securable in Databricks can be configured as **OPEN** or **ISOLATED**. An +// **OPEN** securable can be accessed from any workspace, while an **ISOLATED** // securable can only be accessed from a configured list of workspaces. This API // allows you to configure (bind) securables to workspaces. // -// NOTE: The __isolation_mode__ is configured for the securable itself (using +// NOTE: The **isolation_mode** is configured for the securable itself (using // its Update method) and the workspace bindings are only consulted when the -// securable's __isolation_mode__ is set to __ISOLATED__. +// securable's **isolation_mode** is set to **ISOLATED**. // // A securable's workspace bindings can be configured by a metastore admin or // the owner of the securable. @@ -1652,8 +1729,12 @@ type VolumesService interface { // (/api/2.1/unity-catalog/bindings/{securable_type}/{securable_name}) which // introduces the ability to bind a securable in READ_ONLY mode (catalogs only). // -// Securable types that support binding: - catalog - storage_credential - -// credential - external_location +// Securable types that support binding: +// +// - catalog +// - storage_credential +// - credential +// - external_location // // Deprecated: Do not use this interface, it will be removed in a future version of the SDK. type WorkspaceBindingsService interface { diff --git a/service/catalog/model.go b/service/catalog/model.go index b37bde606..e21a3988d 100755 --- a/service/catalog/model.go +++ b/service/catalog/model.go @@ -904,7 +904,7 @@ func (f *ColumnTypeName) Type() string { // A connection that is dependent on a SQL object. type ConnectionDependency struct { // Full name of the dependent connection, in the form of - // __connection_name__. + // **connection_name**. ConnectionName string `json:"connection_name,omitempty"` ForceSendFields []string `json:"-" url:"-"` @@ -1448,7 +1448,7 @@ func (f *CreateFunctionParameterStyle) Type() string { } type CreateFunctionRequest struct { - // Partial __FunctionInfo__ specifying the function to be created. + // Partial **FunctionInfo** specifying the function to be created. FunctionInfo CreateFunction `json:"function_info"` } @@ -1806,7 +1806,7 @@ type CreateTableConstraint struct { type CreateTableRequest struct { // Name of parent catalog. CatalogName string `json:"catalog_name"` - // The array of __ColumnInfo__ definitions of the table's columns. + // The array of **ColumnInfo** definitions of the table's columns. Columns []ColumnInfo `json:"columns,omitempty"` DataSourceFormat DataSourceFormat `json:"data_source_format"` @@ -1855,7 +1855,7 @@ func (s CreateVolumeRequestContent) MarshalJSON() ([]byte, error) { // A credential that is dependent on a SQL object. type CredentialDependency struct { // Full name of the dependent credential, in the form of - // __credential_name__. + // **credential_name**. CredentialName string `json:"credential_name,omitempty"` ForceSendFields []string `json:"-" url:"-"` @@ -2353,7 +2353,7 @@ type DeleteFunctionRequest struct { // Force deletion even if the function is notempty. Force bool `json:"-" url:"force,omitempty"` // The fully-qualified name of the function (of the form - // __catalog_name__.__schema_name__.__function__name__) . + // **catalog_name**.**schema_name**.**function__name**) . Name string `json:"-" url:"-"` ForceSendFields []string `json:"-" url:"-"` @@ -2507,7 +2507,7 @@ type DeleteVolumeRequest struct { // Properties pertaining to the current state of the delta table as given by the // commit server. This does not contain **delta.*** (input) properties in -// __TableInfo.properties__. +// **TableInfo.properties**. type DeltaRuntimePropertiesKvPairs struct { // A map of key-value properties attached to the securable. DeltaRuntimeProperties map[string]string `json:"delta_runtime_properties"` @@ -2551,8 +2551,8 @@ func (f *DeltaSharingScopeEnum) Type() string { } // A dependency of a SQL object. One of the following fields must be defined: -// __table__, __function__, __connection__, __credential__, __volume__, or -// __secret__. +// **table**, **function**, **connection**, **credential**, **volume**, or +// **secret**. type Dependency struct { Connection *ConnectionDependency `json:"connection,omitempty"` @@ -2624,7 +2624,7 @@ type DisableRequest struct { type EffectivePermissionsList struct { // Opaque token to retrieve the next page of results. Absent if there are no - // more pages. __page_token__ should be set to this value for the next + // more pages. **page_token** should be set to this value for the next // request (for the next page of results). NextPageToken string `json:"next_page_token,omitempty"` // The privileges conveyed to each principal (either directly or via @@ -3283,7 +3283,7 @@ func (s FunctionArgument) MarshalJSON() ([]byte, error) { // A function that is dependent on a SQL object. type FunctionDependency struct { // Full name of the dependent function, in the form of - // __catalog_name__.__schema_name__.__function_name__. + // **catalog_name**.**schema_name**.**function_name**. FunctionFullName string `json:"function_full_name"` } @@ -3857,12 +3857,16 @@ type GetArtifactAllowlistRequest struct { } type GetBindingsRequest struct { - // Maximum number of workspace bindings to return. - When set to 0, the page - // length is set to a server configured value (recommended); - When set to a - // value greater than 0, the page length is the minimum of this value and a - // server configured value; - When set to a value less than 0, an invalid - // parameter error is returned; - If not set, all the workspace bindings are - // returned (not recommended). + // Maximum number of workspace bindings to return. + // + // - When set to 0, the page length is set to a server configured value + // (recommended); + // - When set to a value greater than 0, the page length is the minimum of + // this value and a server configured value; + // - When set to a value less than 0, an invalid parameter error is + // returned; + // - If not set, all the workspace bindings are returned (not + // recommended). MaxResults int `json:"-" url:"max_results,omitempty"` // Opaque pagination token to go to next page based on previous query. PageToken string `json:"-" url:"page_token,omitempty"` @@ -3944,13 +3948,15 @@ type GetEffectiveRequest struct { // guaranteed to contain all the effective privileges granted on (or // inherited by) the requested Securable for the respective principal. // - // If not set, all the effective permissions are returned. If set to - - // lesser than 0: invalid parameter error - 0: page length is set to a - // server configured value - lesser than 150 but greater than 0: invalid - // parameter error (this is to ensure that server is able to return at least - // one complete EffectivePrivilegeAssignment in a single page response) - - // greater than (or equal to) 150: page length is the minimum of this value - // and a server configured value + // If not set, all the effective permissions are returned. If set to + // + // - lesser than 0: invalid parameter error + // - 0: page length is set to a server configured value + // - lesser than 150 but greater than 0: invalid parameter error (this is + // to ensure that server is able to return at least one complete + // EffectivePrivilegeAssignment in a single page response) + // - greater than (or equal to) 150: page length is the minimum of this + // value and a server configured value MaxResults int `json:"-" url:"max_results,omitempty"` // Opaque token for the next page of results (pagination). PageToken string `json:"-" url:"page_token,omitempty"` @@ -4007,7 +4013,7 @@ type GetFunctionRequest struct { // only access selective metadata for IncludeBrowse bool `json:"-" url:"include_browse,omitempty"` // The fully-qualified name of the function (of the form - // __catalog_name__.__schema_name__.__function__name__). + // **catalog_name**.**schema_name**.**function__name**). Name string `json:"-" url:"-"` ForceSendFields []string `json:"-" url:"-"` @@ -4029,13 +4035,15 @@ type GetGrantRequest struct { // contain all the privileges granted on the requested Securable for the // respective principal. // - // If not set, all the permissions are returned. If set to - lesser than 0: - // invalid parameter error - 0: page length is set to a server configured - // value - lesser than 150 but greater than 0: invalid parameter error (this - // is to ensure that server is able to return at least one complete - // PrivilegeAssignment in a single page response) - greater than (or equal - // to) 150: page length is the minimum of this value and a server configured - // value + // If not set, all the permissions are returned. If set to + // + // - lesser than 0: invalid parameter error + // - 0: page length is set to a server configured value + // - lesser than 150 but greater than 0: invalid parameter error (this is + // to ensure that server is able to return at least one complete + // PrivilegeAssignment in a single page response) + // - greater than (or equal to) 150: page length is the minimum of this + // value and a server configured value MaxResults int `json:"-" url:"max_results,omitempty"` // Opaque pagination token to go to next page based on previous query. PageToken string `json:"-" url:"page_token,omitempty"` @@ -4146,7 +4154,7 @@ type GetOnlineTableRequest struct { type GetPermissionsResponse struct { // Opaque token to retrieve the next page of results. Absent if there are no - // more pages. __page_token__ should be set to this value for the next + // more pages. **page_token** should be set to this value for the next // request (for the next page of results). NextPageToken string `json:"next_page_token,omitempty"` // The privileges assigned to each principal @@ -4295,7 +4303,7 @@ type GetWorkspaceBindingsResponse struct { // List of workspace bindings Bindings []WorkspaceBinding `json:"bindings,omitempty"` // Opaque token to retrieve the next page of results. Absent if there are no - // more pages. __page_token__ should be set to this value for the next + // more pages. **page_token** should be set to this value for the next // request (for the next page of results). NextPageToken string `json:"next_page_token,omitempty"` @@ -4412,15 +4420,19 @@ type ListCatalogsRequest struct { // Whether to include catalogs not bound to the workspace. Effective only if // the user has permission to update the catalog–workspace binding. IncludeUnbound bool `json:"-" url:"include_unbound,omitempty"` - // Maximum number of catalogs to return. - when set to 0, the page length is - // set to a server configured value (recommended); - when set to a value - // greater than 0, the page length is the minimum of this value and a server - // configured value; - when set to a value less than 0, an invalid parameter - // error is returned; - If not set, all valid catalogs are returned (not - // recommended). - Note: The number of returned catalogs might be less than - // the specified max_results size, even zero. The only definitive indication - // that no further catalogs can be fetched is when the next_page_token is - // unset from the response. + // Maximum number of catalogs to return. + // + // - when set to 0, the page length is set to a server configured value + // (recommended); + // - when set to a value greater than 0, the page length is the minimum of + // this value and a server configured value; + // - when set to a value less than 0, an invalid parameter error is + // returned; + // - If not set, all valid catalogs are returned (not recommended). + // - Note: The number of returned catalogs might be less than the + // specified max_results size, even zero. The only definitive indication + // that no further catalogs can be fetched is when the next_page_token + // is unset from the response. MaxResults int `json:"-" url:"max_results,omitempty"` // Opaque pagination token to go to next page based on previous query. PageToken string `json:"-" url:"page_token,omitempty"` @@ -4440,7 +4452,7 @@ type ListCatalogsResponse struct { // An array of catalog information objects. Catalogs []CatalogInfo `json:"catalogs,omitempty"` // Opaque token to retrieve the next page of results. Absent if there are no - // more pages. __page_token__ should be set to this value for the next + // more pages. **page_token** should be set to this value for the next // request (for the next page of results). NextPageToken string `json:"next_page_token,omitempty"` @@ -4456,12 +4468,15 @@ func (s ListCatalogsResponse) MarshalJSON() ([]byte, error) { } type ListConnectionsRequest struct { - // Maximum number of connections to return. - If not set, all connections - // are returned (not recommended). - when set to a value greater than 0, the - // page length is the minimum of this value and a server configured value; - - // when set to 0, the page length is set to a server configured value - // (recommended); - when set to a value less than 0, an invalid parameter - // error is returned; + // Maximum number of connections to return. + // + // - If not set, all connections are returned (not recommended). + // - when set to a value greater than 0, the page length is the minimum of + // this value and a server configured value; + // - when set to 0, the page length is set to a server configured value + // (recommended); + // - when set to a value less than 0, an invalid parameter error is + // returned; MaxResults int `json:"-" url:"max_results,omitempty"` // Opaque pagination token to go to next page based on previous query. PageToken string `json:"-" url:"page_token,omitempty"` @@ -4481,7 +4496,7 @@ type ListConnectionsResponse struct { // An array of connection information objects. Connections []ConnectionInfo `json:"connections,omitempty"` // Opaque token to retrieve the next page of results. Absent if there are no - // more pages. __page_token__ should be set to this value for the next + // more pages. **page_token** should be set to this value for the next // request (for the next page of results). NextPageToken string `json:"next_page_token,omitempty"` @@ -4500,11 +4515,15 @@ type ListCredentialsRequest struct { // Whether to include credentials not bound to the workspace. Effective only // if the user has permission to update the credential–workspace binding. IncludeUnbound bool `json:"-" url:"include_unbound,omitempty"` - // Maximum number of credentials to return. - If not set, the default max - // page size is used. - When set to a value greater than 0, the page length - // is the minimum of this value and a server-configured value. - When set to - // 0, the page length is set to a server-configured value (recommended). - - // When set to a value less than 0, an invalid parameter error is returned. + // Maximum number of credentials to return. + // + // - If not set, the default max page size is used. + // - When set to a value greater than 0, the page length is the minimum of + // this value and a server-configured value. + // - When set to 0, the page length is set to a server-configured value + // (recommended). + // - When set to a value less than 0, an invalid parameter error is + // returned. MaxResults int `json:"-" url:"max_results,omitempty"` // Opaque token to retrieve the next page of results. PageToken string `json:"-" url:"page_token,omitempty"` @@ -4525,7 +4544,7 @@ func (s ListCredentialsRequest) MarshalJSON() ([]byte, error) { type ListCredentialsResponse struct { Credentials []CredentialInfo `json:"credentials,omitempty"` // Opaque token to retrieve the next page of results. Absent if there are no - // more pages. __page_token__ should be set to this value for the next + // more pages. **page_token** should be set to this value for the next // request (for the next page of results). NextPageToken string `json:"next_page_token,omitempty"` @@ -4628,11 +4647,14 @@ type ListExternalLocationsRequest struct { // location–workspace binding. IncludeUnbound bool `json:"-" url:"include_unbound,omitempty"` // Maximum number of external locations to return. If not set, all the - // external locations are returned (not recommended). - when set to a value - // greater than 0, the page length is the minimum of this value and a server - // configured value; - when set to 0, the page length is set to a server - // configured value (recommended); - when set to a value less than 0, an - // invalid parameter error is returned; + // external locations are returned (not recommended). + // + // - when set to a value greater than 0, the page length is the minimum of + // this value and a server configured value; + // - when set to 0, the page length is set to a server configured value + // (recommended); + // - when set to a value less than 0, an invalid parameter error is + // returned; MaxResults int `json:"-" url:"max_results,omitempty"` // Opaque pagination token to go to next page based on previous query. PageToken string `json:"-" url:"page_token,omitempty"` @@ -4652,7 +4674,7 @@ type ListExternalLocationsResponse struct { // An array of external locations. ExternalLocations []ExternalLocationInfo `json:"external_locations,omitempty"` // Opaque token to retrieve the next page of results. Absent if there are no - // more pages. __page_token__ should be set to this value for the next + // more pages. **page_token** should be set to this value for the next // request (for the next page of results). NextPageToken string `json:"next_page_token,omitempty"` @@ -4708,11 +4730,14 @@ type ListFunctionsRequest struct { // only access selective metadata for IncludeBrowse bool `json:"-" url:"include_browse,omitempty"` // Maximum number of functions to return. If not set, all the functions are - // returned (not recommended). - when set to a value greater than 0, the - // page length is the minimum of this value and a server configured value; - - // when set to 0, the page length is set to a server configured value - // (recommended); - when set to a value less than 0, an invalid parameter - // error is returned; + // returned (not recommended). + // + // - when set to a value greater than 0, the page length is the minimum of + // this value and a server configured value; + // - when set to 0, the page length is set to a server configured value + // (recommended); + // - when set to a value less than 0, an invalid parameter error is + // returned; MaxResults int `json:"-" url:"max_results,omitempty"` // Opaque pagination token to go to next page based on previous query. PageToken string `json:"-" url:"page_token,omitempty"` @@ -4734,7 +4759,7 @@ type ListFunctionsResponse struct { // An array of function information objects. Functions []FunctionInfo `json:"functions,omitempty"` // Opaque token to retrieve the next page of results. Absent if there are no - // more pages. __page_token__ should be set to this value for the next + // more pages. **page_token** should be set to this value for the next // request (for the next page of results). NextPageToken string `json:"next_page_token,omitempty"` @@ -4750,15 +4775,19 @@ func (s ListFunctionsResponse) MarshalJSON() ([]byte, error) { } type ListMetastoresRequest struct { - // Maximum number of metastores to return. - when set to a value greater - // than 0, the page length is the minimum of this value and a server - // configured value; - when set to 0, the page length is set to a server - // configured value (recommended); - when set to a value less than 0, an - // invalid parameter error is returned; - If not set, all the metastores are - // returned (not recommended). - Note: The number of returned metastores - // might be less than the specified max_results size, even zero. The only - // definitive indication that no further metastores can be fetched is when - // the next_page_token is unset from the response. + // Maximum number of metastores to return. + // + // - when set to a value greater than 0, the page length is the minimum of + // this value and a server configured value; + // - when set to 0, the page length is set to a server configured value + // (recommended); + // - when set to a value less than 0, an invalid parameter error is + // returned; + // - If not set, all the metastores are returned (not recommended). + // - Note: The number of returned metastores might be less than the + // specified max_results size, even zero. The only definitive indication + // that no further metastores can be fetched is when the next_page_token + // is unset from the response. MaxResults int `json:"-" url:"max_results,omitempty"` // Opaque pagination token to go to next page based on previous query. PageToken string `json:"-" url:"page_token,omitempty"` @@ -4778,7 +4807,7 @@ type ListMetastoresResponse struct { // An array of metastore information objects. Metastores []MetastoreInfo `json:"metastores,omitempty"` // Opaque token to retrieve the next page of results. Absent if there are no - // more pages. __page_token__ should be set to this value for the next + // more pages. **page_token** should be set to this value for the next // request (for the next page of results). NextPageToken string `json:"next_page_token,omitempty"` @@ -4801,12 +4830,14 @@ type ListModelVersionsRequest struct { // can only access selective metadata for IncludeBrowse bool `json:"-" url:"include_browse,omitempty"` // Maximum number of model versions to return. If not set, the page length - // is set to a server configured value (100, as of 1/3/2024). - when set to - // a value greater than 0, the page length is the minimum of this value and - // a server configured value(1000, as of 1/3/2024); - when set to 0, the - // page length is set to a server configured value (100, as of 1/3/2024) - // (recommended); - when set to a value less than 0, an invalid parameter - // error is returned; + // is set to a server configured value (100, as of 1/3/2024). + // + // - when set to a value greater than 0, the page length is the minimum of + // this value and a server configured value(1000, as of 1/3/2024); + // - when set to 0, the page length is set to a server configured value + // (100, as of 1/3/2024) (recommended); + // - when set to a value less than 0, an invalid parameter error is + // returned; MaxResults int `json:"-" url:"max_results,omitempty"` // Opaque pagination token to go to next page based on previous query. PageToken string `json:"-" url:"page_token,omitempty"` @@ -4825,7 +4856,7 @@ func (s ListModelVersionsRequest) MarshalJSON() ([]byte, error) { type ListModelVersionsResponse struct { ModelVersions []ModelVersionInfo `json:"model_versions,omitempty"` // Opaque token to retrieve the next page of results. Absent if there are no - // more pages. __page_token__ should be set to this value for the next + // more pages. **page_token** should be set to this value for the next // request (for the next page of results). NextPageToken string `json:"next_page_token,omitempty"` @@ -4845,9 +4876,12 @@ type ListPoliciesRequest struct { // default, the inherited policies are not included. IncludeInherited bool `json:"-" url:"include_inherited,omitempty"` // Optional. Maximum number of policies to return on a single page (page - // length). - When not set or set to 0, the page length is set to a server - // configured value (recommended); - When set to a value greater than 0, the - // page length is the minimum of this value and a server configured value; + // length). + // + // - When not set or set to 0, the page length is set to a server + // configured value (recommended); + // - When set to a value greater than 0, the page length is the minimum of + // this value and a server configured value; MaxResults int `json:"-" url:"max_results,omitempty"` // Required. The fully qualified name of securable to list policies for. OnSecurableFullname string `json:"-" url:"-"` @@ -4906,7 +4940,7 @@ func (s ListQuotasRequest) MarshalJSON() ([]byte, error) { type ListQuotasResponse struct { // Opaque token to retrieve the next page of results. Absent if there are no - // more pages. __page_token__ should be set to this value for the next + // more pages. **page_token** should be set to this value for the next // request. NextPageToken string `json:"next_page_token,omitempty"` // An array of returned QuotaInfos. @@ -4938,21 +4972,27 @@ type ListRegisteredModelsRequest struct { IncludeBrowse bool `json:"-" url:"include_browse,omitempty"` // Max number of registered models to return. // - // If both catalog and schema are specified: - when max_results is not - // specified, the page length is set to a server configured value (10000, as - // of 4/2/2024). - when set to a value greater than 0, the page length is - // the minimum of this value and a server configured value (10000, as of - // 4/2/2024); - when set to 0, the page length is set to a server configured - // value (10000, as of 4/2/2024); - when set to a value less than 0, an - // invalid parameter error is returned; + // If both catalog and schema are specified: + // + // - when max_results is not specified, the page length is set to a server + // configured value (10000, as of 4/2/2024). + // - when set to a value greater than 0, the page length is the minimum of + // this value and a server configured value (10000, as of 4/2/2024); + // - when set to 0, the page length is set to a server configured value + // (10000, as of 4/2/2024); + // - when set to a value less than 0, an invalid parameter error is + // returned; // - // If neither schema nor catalog is specified: - when max_results is not - // specified, the page length is set to a server configured value (100, as - // of 4/2/2024). - when set to a value greater than 0, the page length is - // the minimum of this value and a server configured value (1000, as of - // 4/2/2024); - when set to 0, the page length is set to a server configured - // value (100, as of 4/2/2024); - when set to a value less than 0, an - // invalid parameter error is returned; + // If neither schema nor catalog is specified: + // + // - when max_results is not specified, the page length is set to a server + // configured value (100, as of 4/2/2024). + // - when set to a value greater than 0, the page length is the minimum of + // this value and a server configured value (1000, as of 4/2/2024); + // - when set to 0, the page length is set to a server configured value + // (100, as of 4/2/2024); + // - when set to a value less than 0, an invalid parameter error is + // returned; MaxResults int `json:"-" url:"max_results,omitempty"` // Opaque token to send for the next page of results (pagination). PageToken string `json:"-" url:"page_token,omitempty"` @@ -4996,11 +5036,14 @@ type ListSchemasRequest struct { // only access selective metadata for IncludeBrowse bool `json:"-" url:"include_browse,omitempty"` // Maximum number of schemas to return. If not set, all the schemas are - // returned (not recommended). - when set to a value greater than 0, the - // page length is the minimum of this value and a server configured value; - - // when set to 0, the page length is set to a server configured value - // (recommended); - when set to a value less than 0, an invalid parameter - // error is returned; + // returned (not recommended). + // + // - when set to a value greater than 0, the page length is the minimum of + // this value and a server configured value; + // - when set to 0, the page length is set to a server configured value + // (recommended); + // - when set to a value less than 0, an invalid parameter error is + // returned; MaxResults int `json:"-" url:"max_results,omitempty"` // Opaque pagination token to go to next page based on previous query. PageToken string `json:"-" url:"page_token,omitempty"` @@ -5018,7 +5061,7 @@ func (s ListSchemasRequest) MarshalJSON() ([]byte, error) { type ListSchemasResponse struct { // Opaque token to retrieve the next page of results. Absent if there are no - // more pages. __page_token__ should be set to this value for the next + // more pages. **page_token** should be set to this value for the next // request (for the next page of results). NextPageToken string `json:"next_page_token,omitempty"` // An array of schema information objects. @@ -5044,10 +5087,12 @@ type ListSecretsRequest struct { IncludeBrowse bool `json:"-" url:"include_browse,omitempty"` // Maximum number of secrets to return. // - // - If not specified, at most 10000 secrets are returned. - If set to a - // value greater than 0, the page length is the minimum of this value and - // 10000. - If set to 0, the page length is set to 10000. - If set to a - // value less than 0, an invalid parameter error is returned. + // - If not specified, at most 10000 secrets are returned. + // - If set to a value greater than 0, the page length is the minimum of + // this value and 10000. + // - If set to 0, the page length is set to 10000. + // - If set to a value less than 0, an invalid parameter error is + // returned. PageSize int `json:"-" url:"page_size,omitempty"` // Opaque pagination token to go to the next page based on previous query. // The maximum page length is determined by a server configured value. @@ -5092,11 +5137,14 @@ type ListStorageCredentialsRequest struct { // if the user has permission to update the credential–workspace binding. IncludeUnbound bool `json:"-" url:"include_unbound,omitempty"` // Maximum number of storage credentials to return. If not set, all the - // storage credentials are returned (not recommended). - when set to a value - // greater than 0, the page length is the minimum of this value and a server - // configured value; - when set to 0, the page length is set to a server - // configured value (recommended); - when set to a value less than 0, an - // invalid parameter error is returned; + // storage credentials are returned (not recommended). + // + // - when set to a value greater than 0, the page length is the minimum of + // this value and a server configured value; + // - when set to 0, the page length is set to a server configured value + // (recommended); + // - when set to a value less than 0, an invalid parameter error is + // returned; MaxResults int `json:"-" url:"max_results,omitempty"` // Opaque pagination token to go to next page based on previous query. PageToken string `json:"-" url:"page_token,omitempty"` @@ -5114,7 +5162,7 @@ func (s ListStorageCredentialsRequest) MarshalJSON() ([]byte, error) { type ListStorageCredentialsResponse struct { // Opaque token to retrieve the next page of results. Absent if there are no - // more pages. __page_token__ should be set to this value for the next + // more pages. **page_token** should be set to this value for the next // request (for the next page of results). NextPageToken string `json:"next_page_token,omitempty"` @@ -5138,12 +5186,14 @@ type ListSummariesRequest struct { // response. IncludeManifestCapabilities bool `json:"-" url:"include_manifest_capabilities,omitempty"` // Maximum number of summaries for tables to return. If not set, the page - // length is set to a server configured value (10000, as of 1/5/2024). - - // when set to a value greater than 0, the page length is the minimum of - // this value and a server configured value (10000, as of 1/5/2024); - when - // set to 0, the page length is set to a server configured value (10000, as - // of 1/5/2024) (recommended); - when set to a value less than 0, an invalid - // parameter error is returned; + // length is set to a server configured value (10000, as of 1/5/2024). + // + // - when set to a value greater than 0, the page length is the minimum of + // this value and a server configured value (10000, as of 1/5/2024); + // - when set to 0, the page length is set to a server configured value + // (10000, as of 1/5/2024) (recommended); + // - when set to a value less than 0, an invalid parameter error is + // returned; MaxResults int `json:"-" url:"max_results,omitempty"` // Opaque pagination token to go to next page based on previous query. PageToken string `json:"-" url:"page_token,omitempty"` @@ -5166,12 +5216,15 @@ func (s ListSummariesRequest) MarshalJSON() ([]byte, error) { } type ListSystemSchemasRequest struct { - // Maximum number of schemas to return. - When set to 0, the page length is - // set to a server configured value (recommended); - When set to a value - // greater than 0, the page length is the minimum of this value and a server - // configured value; - When set to a value less than 0, an invalid parameter - // error is returned; - If not set, all the schemas are returned (not - // recommended). + // Maximum number of schemas to return. + // + // - When set to 0, the page length is set to a server configured value + // (recommended); + // - When set to a value greater than 0, the page length is the minimum of + // this value and a server configured value; + // - When set to a value less than 0, an invalid parameter error is + // returned; + // - If not set, all the schemas are returned (not recommended). MaxResults int `json:"-" url:"max_results,omitempty"` // The ID for the metastore in which the system schema resides. MetastoreId string `json:"-" url:"-"` @@ -5191,7 +5244,7 @@ func (s ListSystemSchemasRequest) MarshalJSON() ([]byte, error) { type ListSystemSchemasResponse struct { // Opaque token to retrieve the next page of results. Absent if there are no - // more pages. __page_token__ should be set to this value for the next + // more pages. **page_token** should be set to this value for the next // request (for the next page of results). NextPageToken string `json:"next_page_token,omitempty"` // An array of system schema information objects. @@ -5210,7 +5263,7 @@ func (s ListSystemSchemasResponse) MarshalJSON() ([]byte, error) { type ListTableSummariesResponse struct { // Opaque token to retrieve the next page of results. Absent if there are no - // more pages. __page_token__ should be set to this value for the next + // more pages. **page_token** should be set to this value for the next // request (for the next page of results). NextPageToken string `json:"next_page_token,omitempty"` // List of table summaries. @@ -5237,11 +5290,14 @@ type ListTablesRequest struct { // response. IncludeManifestCapabilities bool `json:"-" url:"include_manifest_capabilities,omitempty"` // Maximum number of tables to return. If not set, all the tables are - // returned (not recommended). - when set to a value greater than 0, the - // page length is the minimum of this value and a server configured value; - - // when set to 0, the page length is set to a server configured value - // (recommended); - when set to a value less than 0, an invalid parameter - // error is returned; + // returned (not recommended). + // + // - when set to a value greater than 0, the page length is the minimum of + // this value and a server configured value; + // - when set to 0, the page length is set to a server configured value + // (recommended); + // - when set to a value less than 0, an invalid parameter error is + // returned; MaxResults int `json:"-" url:"max_results,omitempty"` // Whether to omit the columns of the table from the response or not. OmitColumns bool `json:"-" url:"omit_columns,omitempty"` @@ -5268,7 +5324,7 @@ func (s ListTablesRequest) MarshalJSON() ([]byte, error) { type ListTablesResponse struct { // Opaque token to retrieve the next page of results. Absent if there are no - // more pages. __page_token__ should be set to this value for the next + // more pages. **page_token** should be set to this value for the next // request (for the next page of results). NextPageToken string `json:"next_page_token,omitempty"` // An array of table information objects. @@ -5294,11 +5350,14 @@ type ListVolumesRequest struct { // Maximum number of volumes to return (page length). // // If not set, the page length is set to a server configured value (10000, - // as of 1/29/2024). - when set to a value greater than 0, the page length - // is the minimum of this value and a server configured value (10000, as of - // 1/29/2024); - when set to 0, the page length is set to a server - // configured value (10000, as of 1/29/2024) (recommended); - when set to a - // value less than 0, an invalid parameter error is returned; + // as of 1/29/2024). + // + // - when set to a value greater than 0, the page length is the minimum of + // this value and a server configured value (10000, as of 1/29/2024); + // - when set to 0, the page length is set to a server configured value + // (10000, as of 1/29/2024) (recommended); + // - when set to a value less than 0, an invalid parameter error is + // returned; // // Note: this parameter controls only the maximum number of volumes to // return. The actual number of volumes returned in a page may be smaller @@ -5323,7 +5382,7 @@ func (s ListVolumesRequest) MarshalJSON() ([]byte, error) { type ListVolumesResponseContent struct { // Opaque token to retrieve the next page of results. Absent if there are no - // more pages. __page_token__ should be set to this value for the next + // more pages. **page_token** should be set to this value for the next // request to retrieve the next page of results. NextPageToken string `json:"next_page_token,omitempty"` @@ -5488,7 +5547,7 @@ type ModelVersionInfo struct { ModelName string `json:"model_name,omitempty"` // Model version dependencies, for feature-store packaged models ModelVersionDependencies *DependencyList `json:"model_version_dependencies,omitempty"` - // MLflow run ID used when creating the model version, if ``source`` was + // MLflow run ID used when creating the model version, if `source` was // generated by an experiment run stored in an MLflow tracking server RunId string `json:"run_id,omitempty"` // ID of the Databricks workspace containing the MLflow run that generated @@ -5577,8 +5636,7 @@ type MonitorCronSchedule struct { // // [examples]: https://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html QuartzCronExpression string `json:"quartz_cron_expression"` - // The timezone id (e.g., ``PST``) in which to evaluate the quartz - // expression. + // The timezone id (e.g., `PST`) in which to evaluate the quartz expression. TimezoneId string `json:"timezone_id"` } @@ -5833,36 +5891,42 @@ type MonitorMetric struct { // [create metric definition]: https://docs.databricks.com/en/lakehouse-monitoring/custom-metrics.html#create-definition Definition string `json:"definition"` // 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 + // for. Can use `":table"` to indicate that the metric needs information // from multiple columns. InputColumns []string `json:"input_columns"` // Name of the metric in the output tables. Name string `json:"name"` // The output type of the custom metric. OutputDataType string `json:"output_data_type"` - // Can only be one of ``"CUSTOM_METRIC_TYPE_AGGREGATE"``, - // ``"CUSTOM_METRIC_TYPE_DERIVED"``, or ``"CUSTOM_METRIC_TYPE_DRIFT"``. The - // ``"CUSTOM_METRIC_TYPE_AGGREGATE"`` and ``"CUSTOM_METRIC_TYPE_DERIVED"`` + // Can only be one of `"CUSTOM_METRIC_TYPE_AGGREGATE"`, + // `"CUSTOM_METRIC_TYPE_DERIVED"`, or `"CUSTOM_METRIC_TYPE_DRIFT"`. The + // `"CUSTOM_METRIC_TYPE_AGGREGATE"` and `"CUSTOM_METRIC_TYPE_DERIVED"` // metrics are computed on a single table, whereas the - // ``"CUSTOM_METRIC_TYPE_DRIFT"`` compare metrics across baseline and input - // table, or across the two consecutive time windows. - - // CUSTOM_METRIC_TYPE_AGGREGATE: only depend on the existing columns in your - // table - CUSTOM_METRIC_TYPE_DERIVED: depend on previously computed - // aggregate metrics - CUSTOM_METRIC_TYPE_DRIFT: depend on previously - // computed aggregate or derived metrics + // `"CUSTOM_METRIC_TYPE_DRIFT"` compare metrics across baseline and input + // table, or across the two consecutive time windows. + // + // - CUSTOM_METRIC_TYPE_AGGREGATE: only depend on the existing columns in + // your table + // - CUSTOM_METRIC_TYPE_DERIVED: depend on previously computed aggregate + // metrics + // - CUSTOM_METRIC_TYPE_DRIFT: depend on previously computed aggregate or + // derived metrics Type MonitorMetricType `json:"type"` } -// Can only be one of “\"CUSTOM_METRIC_TYPE_AGGREGATE\"“, -// “\"CUSTOM_METRIC_TYPE_DERIVED\"“, or “\"CUSTOM_METRIC_TYPE_DRIFT\"“. The -// “\"CUSTOM_METRIC_TYPE_AGGREGATE\"“ and “\"CUSTOM_METRIC_TYPE_DERIVED\"“ +// Can only be one of `\"CUSTOM_METRIC_TYPE_AGGREGATE\"`, +// `\"CUSTOM_METRIC_TYPE_DERIVED\"`, or `\"CUSTOM_METRIC_TYPE_DRIFT\"`. The +// `\"CUSTOM_METRIC_TYPE_AGGREGATE\"` and `\"CUSTOM_METRIC_TYPE_DERIVED\"` // metrics are computed on a single table, whereas the -// “\"CUSTOM_METRIC_TYPE_DRIFT\"“ compare metrics across baseline and input -// table, or across the two consecutive time windows. - -// CUSTOM_METRIC_TYPE_AGGREGATE: only depend on the existing columns in your -// table - CUSTOM_METRIC_TYPE_DERIVED: depend on previously computed aggregate -// metrics - CUSTOM_METRIC_TYPE_DRIFT: depend on previously computed aggregate -// or derived metrics +// `\"CUSTOM_METRIC_TYPE_DRIFT\"` compare metrics across baseline and input +// table, or across the two consecutive time windows. +// +// - CUSTOM_METRIC_TYPE_AGGREGATE: only depend on the existing columns in your +// table +// - CUSTOM_METRIC_TYPE_DERIVED: depend on previously computed aggregate +// metrics +// - CUSTOM_METRIC_TYPE_DRIFT: depend on previously computed aggregate or +// derived metrics type MonitorMetricType string const MonitorMetricTypeCustomMetricTypeAggregate MonitorMetricType = `CUSTOM_METRIC_TYPE_AGGREGATE` @@ -6041,8 +6105,8 @@ type MonitorSnapshot struct { type MonitorTimeSeries struct { // Granularities for aggregating data into time windows based on their // timestamp. Currently the following static granularities are supported: - // {``\"5 minutes\"``, ``\"30 minutes\"``, ``\"1 hour\"``, ``\"1 day\"``, - // ``\"\u003cn\u003e week(s)\"``, ``\"1 month\"``, ``\"1 year\"``}. + // {`\"5 minutes\"`, `\"30 minutes\"`, `\"1 hour\"`, `\"1 day\"`, + // `\"\u003cn\u003e week(s)\"`, `\"1 month\"`, `\"1 year\"`}. Granularities []string `json:"granularities"` // Column for the timestamp. TimestampCol string `json:"timestamp_col"` @@ -7151,7 +7215,7 @@ type SchemaInfo struct { // Whether predictive optimization should be enabled for this object and // objects under it. EnablePredictiveOptimization EnablePredictiveOptimization `json:"enable_predictive_optimization,omitempty"` - // Full name of schema, in form of __catalog_name__.__schema_name__. + // Full name of schema, in form of **catalog_name**.**schema_name**. FullName string `json:"full_name,omitempty"` // Unique identifier of parent metastore. MetastoreId string `json:"metastore_id,omitempty"` @@ -7903,8 +7967,8 @@ func (f *SystemType) Type() string { } // A table constraint, as defined by *one* of the following fields being set: -// __primary_key_constraint__, __foreign_key_constraint__, -// __named_table_constraint__. +// **primary_key_constraint**, **foreign_key_constraint**, +// **named_table_constraint**. type TableConstraint struct { ForeignKeyConstraint *ForeignKeyConstraint `json:"foreign_key_constraint,omitempty"` @@ -7916,7 +7980,7 @@ type TableConstraint struct { // A table that is dependent on a SQL object. type TableDependency struct { // Full name of the dependent table, in the form of - // __catalog_name__.__schema_name__.__table_name__. + // **catalog_name**.**schema_name**.**table_name**. TableFullName string `json:"table_full_name"` } @@ -7944,7 +8008,7 @@ type TableInfo struct { BrowseOnly bool `json:"browse_only,omitempty"` // Name of parent catalog. CatalogName string `json:"catalog_name,omitempty"` - // The array of __ColumnInfo__ definitions of the table's columns. + // The array of **ColumnInfo** definitions of the table's columns. Columns []ColumnInfo `json:"columns,omitempty"` // User-provided free-form text description. Comment string `json:"comment,omitempty"` @@ -7968,7 +8032,7 @@ type TableInfo struct { EncryptionDetails *EncryptionDetails `json:"encryption_details,omitempty"` // Full name of table, in form of - // __catalog_name__.__schema_name__.__table_name__ + // **catalog_name**.**schema_name**.**table_name** FullName string `json:"full_name,omitempty"` // Unique identifier of parent metastore. MetastoreId string `json:"metastore_id,omitempty"` @@ -7995,7 +8059,7 @@ type TableInfo struct { // Storage root URL for table (for **MANAGED**, **EXTERNAL** tables). StorageLocation string `json:"storage_location,omitempty"` // List of table constraints. Note: this field is not set in the output of - // the __listTables__ API. + // the **listTables** API. TableConstraints []TableConstraint `json:"table_constraints,omitempty"` // The unique identifier of the table. TableId string `json:"table_id,omitempty"` @@ -8005,15 +8069,18 @@ type TableInfo struct { UpdatedAt int64 `json:"updated_at,omitempty"` // Username of user who last modified the table. UpdatedBy string `json:"updated_by,omitempty"` - // View definition SQL (when __table_type__ is **VIEW**, + // View definition SQL (when **table_type** is **VIEW**, // **MATERIALIZED_VIEW**, or **STREAMING_TABLE**) ViewDefinition string `json:"view_definition,omitempty"` // View dependencies (when table_type == **VIEW** or **MATERIALIZED_VIEW**, - // **STREAMING_TABLE**) - when DependencyList is None, the dependency is not - // provided; - when DependencyList is an empty list, the dependency is - // provided but is empty; - when DependencyList is not an empty list, - // dependencies are provided and recorded. Note: this field is not set in - // the output of the __listTables__ API. + // **STREAMING_TABLE**) + // + // - when DependencyList is None, the dependency is not provided; + // - when DependencyList is an empty list, the dependency is provided but + // is empty; + // - when DependencyList is not an empty list, dependencies are provided + // and recorded. Note: this field is not set in the output of the + // **listTables** API. ViewDependencies *DependencyList `json:"view_dependencies,omitempty"` ForceSendFields []string `json:"-" url:"-"` @@ -8565,7 +8632,7 @@ type UpdateExternalMetadataRequest struct { type UpdateFunction struct { // The fully-qualified name of the function (of the form - // __catalog_name__.__schema_name__.__function__name__). + // **catalog_name**.**schema_name**.**function__name**). Name string `json:"-" url:"-"` // Username of current owner of the function. Owner string `json:"owner,omitempty"` @@ -8658,7 +8725,7 @@ type UpdateModelVersionRequest struct { ModelName string `json:"model_name,omitempty"` // Model version dependencies, for feature-store packaged models ModelVersionDependencies *DependencyList `json:"model_version_dependencies,omitempty"` - // MLflow run ID used when creating the model version, if ``source`` was + // MLflow run ID used when creating the model version, if `source` was // generated by an experiment run stored in an MLflow tracking server RunId string `json:"run_id,omitempty"` // ID of the Databricks workspace containing the MLflow run that generated @@ -8770,12 +8837,15 @@ type UpdatePolicyRequest struct { OnSecurableType string `json:"-" url:"-"` // Optional fields to update. This is the request body for updating a // policy. Use `update_mask` field to specify which fields in the request is - // to be updated. - If `update_mask` is empty or "*", all specified fields - // will be updated. - If `update_mask` is specified, only the fields - // specified in the `update_mask` will be updated. If a field is specified - // in `update_mask` and not set in the request, the field will be cleared. - // Users can use the update mask to explicitly unset optional fields such as - // `exception_principals` and `when_condition`. + // to be updated. + // + // - If `update_mask` is empty or "*", all specified fields will be + // updated. + // - If `update_mask` is specified, only the fields specified in the + // `update_mask` will be updated. If a field is specified in + // `update_mask` and not set in the request, the field will be cleared. + // Users can use the update mask to explicitly unset optional fields + // such as `exception_principals` and `when_condition`. PolicyInfo PolicyInfo `json:"policy_info"` // Optional. The update mask field for specifying user intentions on which // fields to update in the request. diff --git a/service/cleanrooms/api.go b/service/cleanrooms/api.go index bcd89dd40..42a9024e0 100755 --- a/service/cleanrooms/api.go +++ b/service/cleanrooms/api.go @@ -262,7 +262,7 @@ type CleanRoomsInterface interface { // Update a clean room. The caller must be the owner of the clean room, have // **MODIFY_CLEAN_ROOM** privilege, or be metastore admin. // - // When the caller is a metastore admin, only the __owner__ field can be + // When the caller is a metastore admin, only the **owner** field can be // updated. Update(ctx context.Context, request UpdateCleanRoomRequest) (*CleanRoom, error) } diff --git a/service/cleanrooms/interface.go b/service/cleanrooms/interface.go index 8373ea2ce..8e962b400 100755 --- a/service/cleanrooms/interface.go +++ b/service/cleanrooms/interface.go @@ -120,7 +120,7 @@ type CleanRoomsService interface { // Update a clean room. The caller must be the owner of the clean room, have // **MODIFY_CLEAN_ROOM** privilege, or be metastore admin. // - // When the caller is a metastore admin, only the __owner__ field can be + // When the caller is a metastore admin, only the **owner** field can be // updated. Update(ctx context.Context, request UpdateCleanRoomRequest) (*CleanRoom, error) } diff --git a/service/cleanrooms/model.go b/service/cleanrooms/model.go index 37030e213..ddd2e966a 100755 --- a/service/cleanrooms/model.go +++ b/service/cleanrooms/model.go @@ -391,9 +391,7 @@ type CleanRoomCollaborator struct { // Must be specified if invite_recipient_email is specified. It should be // empty when the collaborator is the creator of the clean room. InviteRecipientWorkspaceId int64 `json:"invite_recipient_workspace_id,omitempty"` - // [Organization - // name](:method:metastores/list#metastores-delta_sharing_organization_name) - // configured in the metastore + // Organization name configured in the metastore OrganizationName string `json:"organization_name,omitempty"` ForceSendFields []string `json:"-" url:"-"` @@ -614,10 +612,9 @@ type CleanRoomRemoteDetail struct { // Collaborators in the central clean room. There should one and only one // collaborator in the list that satisfies the owner condition: // - // 1. It has the creator's global_metastore_id (determined by caller of - // CreateCleanRoom). - // - // 2. Its invite_recipient_email is empty. + // 1. It has the creator's global_metastore_id (determined by caller of + // CreateCleanRoom). + // 2. Its invite_recipient_email is empty. Collaborators []CleanRoomCollaborator `json:"collaborators,omitempty"` ComplianceSecurityProfile *ComplianceSecurityProfile `json:"compliance_security_profile,omitempty"` diff --git a/service/compute/api.go b/service/compute/api.go index 95a4070d1..514e147df 100755 --- a/service/compute/api.go +++ b/service/compute/api.go @@ -104,20 +104,25 @@ func NewClusterPolicies(client *client.DatabricksClient) *ClusterPoliciesAPI { // values can be used during cluster creation. Cluster policies have ACLs that // limit their use to specific users and groups. // -// With cluster policies, you can: - Auto-install cluster libraries on the next -// restart by listing them in the policy's "libraries" field (Public Preview). - -// Limit users to creating clusters with the prescribed settings. - Simplify the -// user interface, enabling more users to create clusters, by fixing and hiding -// some fields. - Manage costs by setting limits on attributes that impact the -// hourly rate. +// With cluster policies, you can: +// +// - Auto-install cluster libraries on the next restart by listing them in the +// policy's "libraries" field (Public Preview). +// - Limit users to creating clusters with the prescribed settings. +// - Simplify the user interface, enabling more users to create clusters, by +// fixing and hiding some fields. +// - Manage costs by setting limits on attributes that impact the hourly rate. // // Cluster policy permissions limit which policies a user can select in the -// Policy drop-down when the user creates a cluster: - A user who has -// unrestricted cluster create permission can select the Unrestricted policy and -// create fully-configurable clusters. - A user who has both unrestricted -// cluster create permission and access to cluster policies can select the -// Unrestricted policy and policies they have access to. - A user that has -// access to only cluster policies, can select the policies they have access to. +// Policy drop-down when the user creates a cluster: +// +// - A user who has unrestricted cluster create permission can select the +// Unrestricted policy and create fully-configurable clusters. +// - A user who has both unrestricted cluster create permission and access to +// cluster policies can select the Unrestricted policy and policies they +// have access to. +// - A user that has access to only cluster policies, can select the policies +// they have access to. // // If no policies exist in the workspace, the Policy drop-down doesn't appear. // Only admin users can create, edit, and delete policies. Admin users also have @@ -228,11 +233,11 @@ type ClustersInterface interface { // Creates a new Spark cluster. This method will acquire new instances from the // cloud provider if necessary. This method is asynchronous; the returned - // ``cluster_id`` can be used to poll the cluster status. When this method - // returns, the cluster will be in a ``PENDING`` state. The cluster will be - // usable once it enters a ``RUNNING`` state. Note: Databricks may not be able - // to acquire some of the requested nodes, due to cloud provider limitations - // (account limits, spot price, etc.) or transient network issues. + // `cluster_id` can be used to poll the cluster status. When this method + // returns, the cluster will be in a `PENDING` state. The cluster will be usable + // once it enters a `RUNNING` state. Note: Databricks may not be able to acquire + // some of the requested nodes, due to cloud provider limitations (account + // limits, spot price, etc.) or transient network issues. // // If Databricks acquires at least 85% of the requested on-demand nodes, cluster // creation will succeed. Otherwise the cluster will terminate with an @@ -433,12 +438,15 @@ type ClustersInterface interface { SparkVersions(ctx context.Context) (*GetSparkVersionsResponse, error) // Starts a terminated Spark cluster with the supplied ID. This works similar to - // `createCluster` except: - The previous cluster id and attributes are - // preserved. - The cluster starts with the last specified cluster size. - If - // the previous cluster was an autoscaling cluster, the current cluster starts - // with the minimum number of nodes. - If the cluster is not currently in a - // ``TERMINATED`` state, nothing will happen. - Clusters launched to run a job - // cannot be started. + // `createCluster` except: + // + // - The previous cluster id and attributes are preserved. + // - The cluster starts with the last specified cluster size. + // - If the previous cluster was an autoscaling cluster, the current cluster + // starts with the minimum number of nodes. + // - If the cluster is not currently in a `TERMINATED` state, nothing will + // happen. + // - Clusters launched to run a job cannot be started. Start(ctx context.Context, startCluster StartCluster) (*WaitGetClusterRunning[struct{}], error) // Calls [ClustersAPIInterface.Start] and waits to reach RUNNING state @@ -450,12 +458,15 @@ type ClustersInterface interface { StartAndWait(ctx context.Context, startCluster StartCluster, options ...retries.Option[ClusterDetails]) (*ClusterDetails, error) // Starts a terminated Spark cluster with the supplied ID. This works similar to - // `createCluster` except: - The previous cluster id and attributes are - // preserved. - The cluster starts with the last specified cluster size. - If - // the previous cluster was an autoscaling cluster, the current cluster starts - // with the minimum number of nodes. - If the cluster is not currently in a - // ``TERMINATED`` state, nothing will happen. - Clusters launched to run a job - // cannot be started. + // `createCluster` except: + // + // - The previous cluster id and attributes are preserved. + // - The cluster starts with the last specified cluster size. + // - If the previous cluster was an autoscaling cluster, the current cluster + // starts with the minimum number of nodes. + // - If the cluster is not currently in a `TERMINATED` state, nothing will + // happen. + // - Clusters launched to run a job cannot be started. StartByClusterId(ctx context.Context, clusterId string) error StartByClusterIdAndWait(ctx context.Context, clusterId string, options ...retries.Option[ClusterDetails]) (*ClusterDetails, error) @@ -643,11 +654,11 @@ func (w *WaitGetClusterTerminated[R]) GetWithTimeout(timeout time.Duration) (*Cl // Creates a new Spark cluster. This method will acquire new instances from the // cloud provider if necessary. This method is asynchronous; the returned -// “cluster_id“ can be used to poll the cluster status. When this method -// returns, the cluster will be in a “PENDING“ state. The cluster will be -// usable once it enters a “RUNNING“ state. Note: Databricks may not be able -// to acquire some of the requested nodes, due to cloud provider limitations -// (account limits, spot price, etc.) or transient network issues. +// `cluster_id` can be used to poll the cluster status. When this method +// returns, the cluster will be in a `PENDING` state. The cluster will be usable +// once it enters a `RUNNING` state. Note: Databricks may not be able to acquire +// some of the requested nodes, due to cloud provider limitations (account +// limits, spot price, etc.) or transient network issues. // // If Databricks acquires at least 85% of the requested on-demand nodes, cluster // creation will succeed. Otherwise the cluster will terminate with an @@ -1007,12 +1018,15 @@ func (a *ClustersAPI) RestartAndWait(ctx context.Context, restartCluster Restart } // Starts a terminated Spark cluster with the supplied ID. This works similar to -// `createCluster` except: - The previous cluster id and attributes are -// preserved. - The cluster starts with the last specified cluster size. - If -// the previous cluster was an autoscaling cluster, the current cluster starts -// with the minimum number of nodes. - If the cluster is not currently in a -// “TERMINATED“ state, nothing will happen. - Clusters launched to run a job -// cannot be started. +// `createCluster` except: +// +// - The previous cluster id and attributes are preserved. +// - The cluster starts with the last specified cluster size. +// - If the previous cluster was an autoscaling cluster, the current cluster +// starts with the minimum number of nodes. +// - If the cluster is not currently in a `TERMINATED` state, nothing will +// happen. +// - Clusters launched to run a job cannot be started. func (a *ClustersAPI) Start(ctx context.Context, startCluster StartCluster) (*WaitGetClusterRunning[struct{}], error) { err := a.clustersImpl.Start(ctx, startCluster) if err != nil { @@ -1057,12 +1071,15 @@ func (a *ClustersAPI) StartAndWait(ctx context.Context, startCluster StartCluste } // Starts a terminated Spark cluster with the supplied ID. This works similar to -// `createCluster` except: - The previous cluster id and attributes are -// preserved. - The cluster starts with the last specified cluster size. - If -// the previous cluster was an autoscaling cluster, the current cluster starts -// with the minimum number of nodes. - If the cluster is not currently in a -// “TERMINATED“ state, nothing will happen. - Clusters launched to run a job -// cannot be started. +// `createCluster` except: +// +// - The previous cluster id and attributes are preserved. +// - The cluster starts with the last specified cluster size. +// - If the previous cluster was an autoscaling cluster, the current cluster +// starts with the minimum number of nodes. +// - If the cluster is not currently in a `TERMINATED` state, nothing will +// happen. +// - Clusters launched to run a job cannot be started. func (a *ClustersAPI) StartByClusterId(ctx context.Context, clusterId string) error { return a.clustersImpl.Start(ctx, StartCluster{ ClusterId: clusterId, @@ -1154,7 +1171,7 @@ type CommandExecutionInterface interface { // Cancels a currently running command within an execution context. // - // The command ID is obtained from a prior successful call to __execute__. + // The command ID is obtained from a prior successful call to **execute**. Cancel(ctx context.Context, cancelCommand CancelCommand) (*WaitCommandStatusCommandExecutionCancelled[struct{}], error) // Calls [CommandExecutionAPIInterface.Cancel] and waits to reach Cancelled state @@ -1168,7 +1185,7 @@ type CommandExecutionInterface interface { // Gets the status of and, if available, the results from a currently executing // command. // - // The command ID is obtained from a prior successful call to __execute__. + // The command ID is obtained from a prior successful call to **execute**. CommandStatus(ctx context.Context, request CommandStatusRequest) (*CommandStatusResponse, error) // Gets the status for an execution context. @@ -1398,7 +1415,7 @@ func (w *WaitCommandStatusCommandExecutionFinishedOrError[R]) GetWithTimeout(tim // Cancels a currently running command within an execution context. // -// The command ID is obtained from a prior successful call to __execute__. +// The command ID is obtained from a prior successful call to **execute**. func (a *CommandExecutionAPI) Cancel(ctx context.Context, cancelCommand CancelCommand) (*WaitCommandStatusCommandExecutionCancelled[struct{}], error) { err := a.commandExecutionImpl.Cancel(ctx, cancelCommand) if err != nil { @@ -1560,16 +1577,14 @@ type GlobalInitScriptsInterface interface { // Get a list of all global init scripts for this workspace. This returns all // properties for each script but **not** the script contents. To retrieve the - // contents of a script, use the [get a global init - // script](:method:globalinitscripts/get) operation. + // contents of a script, use the get a global init script operation. // // This method is generated by Databricks SDK Code Generator. List(ctx context.Context) listing.Iterator[GlobalInitScriptDetails] // Get a list of all global init scripts for this workspace. This returns all // properties for each script but **not** the script contents. To retrieve the - // contents of a script, use the [get a global init - // script](:method:globalinitscripts/get) operation. + // contents of a script, use the get a global init script operation. // // This method is generated by Databricks SDK Code Generator. ListAll(ctx context.Context) ([]GlobalInitScriptDetails, error) @@ -1885,9 +1900,9 @@ type InstanceProfilesInterface interface { // with the instance profile. It is required to specify the IAM role ARN if both // of the following are true: // - // * Your role name and instance profile name do not match. The name is the part - // after the last slash in each ARN. * You want to use the instance profile with - // [Databricks SQL Serverless]. + // - Your role name and instance profile name do not match. The name is the + // part after the last slash in each ARN. + // - You want to use the instance profile with [Databricks SQL Serverless]. // // To understand where these fields are in the AWS console, see [Enable // serverless SQL warehouses]. @@ -1970,33 +1985,39 @@ type LibrariesInterface interface { // Get the status of libraries on a cluster. A status is returned for all // libraries installed on this cluster via the API or the libraries UI. The - // order of returned libraries is as follows: 1. Libraries set to be installed - // on this cluster, in the order that the libraries were added to the cluster, - // are returned first. 2. Libraries that were previously requested to be - // installed on this cluster or, but are now marked for removal, in no - // particular order, are returned last. + // order of returned libraries is as follows: + // + // 1. Libraries set to be installed on this cluster, in the order that the + // libraries were added to the cluster, are returned first. + // 2. Libraries that were previously requested to be installed on this cluster + // or, but are now marked for removal, in no particular order, are returned + // last. // // This method is generated by Databricks SDK Code Generator. ClusterStatus(ctx context.Context, request ClusterStatus) listing.Iterator[LibraryFullStatus] // Get the status of libraries on a cluster. A status is returned for all // libraries installed on this cluster via the API or the libraries UI. The - // order of returned libraries is as follows: 1. Libraries set to be installed - // on this cluster, in the order that the libraries were added to the cluster, - // are returned first. 2. Libraries that were previously requested to be - // installed on this cluster or, but are now marked for removal, in no - // particular order, are returned last. + // order of returned libraries is as follows: + // + // 1. Libraries set to be installed on this cluster, in the order that the + // libraries were added to the cluster, are returned first. + // 2. Libraries that were previously requested to be installed on this cluster + // or, but are now marked for removal, in no particular order, are returned + // last. // // This method is generated by Databricks SDK Code Generator. ClusterStatusAll(ctx context.Context, request ClusterStatus) ([]LibraryFullStatus, error) // Get the status of libraries on a cluster. A status is returned for all // libraries installed on this cluster via the API or the libraries UI. The - // order of returned libraries is as follows: 1. Libraries set to be installed - // on this cluster, in the order that the libraries were added to the cluster, - // are returned first. 2. Libraries that were previously requested to be - // installed on this cluster or, but are now marked for removal, in no - // particular order, are returned last. + // order of returned libraries is as follows: + // + // 1. Libraries set to be installed on this cluster, in the order that the + // libraries were added to the cluster, are returned first. + // 2. Libraries that were previously requested to be installed on this cluster + // or, but are now marked for removal, in no particular order, are returned + // last. ClusterStatusByClusterId(ctx context.Context, clusterId string) (*ClusterLibraryStatuses, error) // Add libraries to install on a cluster. The installation is asynchronous; it @@ -2039,11 +2060,13 @@ type LibrariesAPI struct { // Get the status of libraries on a cluster. A status is returned for all // libraries installed on this cluster via the API or the libraries UI. The -// order of returned libraries is as follows: 1. Libraries set to be installed -// on this cluster, in the order that the libraries were added to the cluster, -// are returned first. 2. Libraries that were previously requested to be -// installed on this cluster or, but are now marked for removal, in no -// particular order, are returned last. +// order of returned libraries is as follows: +// +// 1. Libraries set to be installed on this cluster, in the order that the +// libraries were added to the cluster, are returned first. +// 2. Libraries that were previously requested to be installed on this cluster +// or, but are now marked for removal, in no particular order, are returned +// last. func (a *LibrariesAPI) ClusterStatusByClusterId(ctx context.Context, clusterId string) (*ClusterLibraryStatuses, error) { return a.librariesImpl.internalClusterStatus(ctx, ClusterStatus{ ClusterId: clusterId, diff --git a/service/compute/impl.go b/service/compute/impl.go index d1f30e1b1..d09ae43df 100755 --- a/service/compute/impl.go +++ b/service/compute/impl.go @@ -686,8 +686,7 @@ func (a *globalInitScriptsImpl) Get(ctx context.Context, request GetGlobalInitSc // Get a list of all global init scripts for this workspace. This returns all // properties for each script but **not** the script contents. To retrieve the -// contents of a script, use the [get a global init -// script](:method:globalinitscripts/get) operation. +// contents of a script, use the get a global init script operation. func (a *globalInitScriptsImpl) List(ctx context.Context) listing.Iterator[GlobalInitScriptDetails] { request := struct{}{} @@ -709,8 +708,7 @@ func (a *globalInitScriptsImpl) List(ctx context.Context) listing.Iterator[Globa // Get a list of all global init scripts for this workspace. This returns all // properties for each script but **not** the script contents. To retrieve the -// contents of a script, use the [get a global init -// script](:method:globalinitscripts/get) operation. +// contents of a script, use the get a global init script operation. func (a *globalInitScriptsImpl) ListAll(ctx context.Context) ([]GlobalInitScriptDetails, error) { iterator := a.List(ctx) return listing.ToSlice[GlobalInitScriptDetails](ctx, iterator) @@ -1044,11 +1042,13 @@ func (a *librariesImpl) internalAllClusterStatuses(ctx context.Context) (*ListAl // Get the status of libraries on a cluster. A status is returned for all // libraries installed on this cluster via the API or the libraries UI. The -// order of returned libraries is as follows: 1. Libraries set to be installed -// on this cluster, in the order that the libraries were added to the cluster, -// are returned first. 2. Libraries that were previously requested to be -// installed on this cluster or, but are now marked for removal, in no -// particular order, are returned last. +// order of returned libraries is as follows: +// +// 1. Libraries set to be installed on this cluster, in the order that the +// libraries were added to the cluster, are returned first. +// 2. Libraries that were previously requested to be installed on this cluster +// or, but are now marked for removal, in no particular order, are returned +// last. func (a *librariesImpl) ClusterStatus(ctx context.Context, request ClusterStatus) listing.Iterator[LibraryFullStatus] { getNextPage := func(ctx context.Context, req ClusterStatus) (*ClusterLibraryStatuses, error) { @@ -1069,11 +1069,13 @@ func (a *librariesImpl) ClusterStatus(ctx context.Context, request ClusterStatus // Get the status of libraries on a cluster. A status is returned for all // libraries installed on this cluster via the API or the libraries UI. The -// order of returned libraries is as follows: 1. Libraries set to be installed -// on this cluster, in the order that the libraries were added to the cluster, -// are returned first. 2. Libraries that were previously requested to be -// installed on this cluster or, but are now marked for removal, in no -// particular order, are returned last. +// order of returned libraries is as follows: +// +// 1. Libraries set to be installed on this cluster, in the order that the +// libraries were added to the cluster, are returned first. +// 2. Libraries that were previously requested to be installed on this cluster +// or, but are now marked for removal, in no particular order, are returned +// last. func (a *librariesImpl) ClusterStatusAll(ctx context.Context, request ClusterStatus) ([]LibraryFullStatus, error) { iterator := a.ClusterStatus(ctx, request) return listing.ToSlice[LibraryFullStatus](ctx, iterator) diff --git a/service/compute/interface.go b/service/compute/interface.go index 0fe4e2ea1..eea2b76a9 100755 --- a/service/compute/interface.go +++ b/service/compute/interface.go @@ -11,20 +11,25 @@ import ( // values can be used during cluster creation. Cluster policies have ACLs that // limit their use to specific users and groups. // -// With cluster policies, you can: - Auto-install cluster libraries on the next -// restart by listing them in the policy's "libraries" field (Public Preview). - -// Limit users to creating clusters with the prescribed settings. - Simplify the -// user interface, enabling more users to create clusters, by fixing and hiding -// some fields. - Manage costs by setting limits on attributes that impact the -// hourly rate. +// With cluster policies, you can: +// +// - Auto-install cluster libraries on the next restart by listing them in the +// policy's "libraries" field (Public Preview). +// - Limit users to creating clusters with the prescribed settings. +// - Simplify the user interface, enabling more users to create clusters, by +// fixing and hiding some fields. +// - Manage costs by setting limits on attributes that impact the hourly rate. // // Cluster policy permissions limit which policies a user can select in the -// Policy drop-down when the user creates a cluster: - A user who has -// unrestricted cluster create permission can select the Unrestricted policy and -// create fully-configurable clusters. - A user who has both unrestricted -// cluster create permission and access to cluster policies can select the -// Unrestricted policy and policies they have access to. - A user that has -// access to only cluster policies, can select the policies they have access to. +// Policy drop-down when the user creates a cluster: +// +// - A user who has unrestricted cluster create permission can select the +// Unrestricted policy and create fully-configurable clusters. +// - A user who has both unrestricted cluster create permission and access to +// cluster policies can select the Unrestricted policy and policies they +// have access to. +// - A user that has access to only cluster policies, can select the policies +// they have access to. // // If no policies exist in the workspace, the Policy drop-down doesn't appear. // Only admin users can create, edit, and delete policies. Admin users also have @@ -105,10 +110,10 @@ type ClustersService interface { // Creates a new Spark cluster. This method will acquire new instances from // the cloud provider if necessary. This method is asynchronous; the - // returned ``cluster_id`` can be used to poll the cluster status. When this - // method returns, the cluster will be in a ``PENDING`` state. The cluster - // will be usable once it enters a ``RUNNING`` state. Note: Databricks may - // not be able to acquire some of the requested nodes, due to cloud provider + // returned `cluster_id` can be used to poll the cluster status. When this + // method returns, the cluster will be in a `PENDING` state. The cluster + // will be usable once it enters a `RUNNING` state. Note: Databricks may not + // be able to acquire some of the requested nodes, due to cloud provider // limitations (account limits, spot price, etc.) or transient network // issues. // @@ -205,12 +210,15 @@ type ClustersService interface { SparkVersions(ctx context.Context) (*GetSparkVersionsResponse, error) // Starts a terminated Spark cluster with the supplied ID. This works - // similar to `createCluster` except: - The previous cluster id and - // attributes are preserved. - The cluster starts with the last specified - // cluster size. - If the previous cluster was an autoscaling cluster, the - // current cluster starts with the minimum number of nodes. - If the cluster - // is not currently in a ``TERMINATED`` state, nothing will happen. - - // Clusters launched to run a job cannot be started. + // similar to `createCluster` except: + // + // - The previous cluster id and attributes are preserved. + // - The cluster starts with the last specified cluster size. + // - If the previous cluster was an autoscaling cluster, the current + // cluster starts with the minimum number of nodes. + // - If the cluster is not currently in a `TERMINATED` state, nothing will + // happen. + // - Clusters launched to run a job cannot be started. Start(ctx context.Context, request StartCluster) error // Unpinning a cluster will allow the cluster to eventually be removed from @@ -245,13 +253,13 @@ type CommandExecutionService interface { // Cancels a currently running command within an execution context. // - // The command ID is obtained from a prior successful call to __execute__. + // The command ID is obtained from a prior successful call to **execute**. Cancel(ctx context.Context, request CancelCommand) error // Gets the status of and, if available, the results from a currently // executing command. // - // The command ID is obtained from a prior successful call to __execute__. + // The command ID is obtained from a prior successful call to **execute**. CommandStatus(ctx context.Context, request CommandStatusRequest) (*CommandStatusResponse, error) // Gets the status for an execution context. @@ -298,8 +306,8 @@ type GlobalInitScriptsService interface { // Get a list of all global init scripts for this workspace. This returns // all properties for each script but **not** the script contents. To - // retrieve the contents of a script, use the [get a global init - // script](:method:globalinitscripts/get) operation. + // retrieve the contents of a script, use the get a global init script + // operation. List(ctx context.Context) (*ListGlobalInitScriptsResponse, error) // Updates a global init script, specifying only the fields to change. All @@ -383,9 +391,10 @@ type InstanceProfilesService interface { // associated with the instance profile. It is required to specify the IAM // role ARN if both of the following are true: // - // * Your role name and instance profile name do not match. The name is the - // part after the last slash in each ARN. * You want to use the instance - // profile with [Databricks SQL Serverless]. + // - Your role name and instance profile name do not match. The name is + // the part after the last slash in each ARN. + // - You want to use the instance profile with [Databricks SQL + // Serverless]. // // To understand where these fields are in the AWS console, see [Enable // serverless SQL warehouses]. @@ -435,11 +444,13 @@ type LibrariesService interface { // Get the status of libraries on a cluster. A status is returned for all // libraries installed on this cluster via the API or the libraries UI. The - // order of returned libraries is as follows: 1. Libraries set to be - // installed on this cluster, in the order that the libraries were added to - // the cluster, are returned first. 2. Libraries that were previously - // requested to be installed on this cluster or, but are now marked for - // removal, in no particular order, are returned last. + // order of returned libraries is as follows: + // + // 1. Libraries set to be installed on this cluster, in the order that the + // libraries were added to the cluster, are returned first. + // 2. Libraries that were previously requested to be installed on this + // cluster or, but are now marked for removal, in no particular order, + // are returned last. ClusterStatus(ctx context.Context, request ClusterStatus) (*ClusterLibraryStatuses, error) // Add libraries to install on a cluster. The installation is asynchronous; diff --git a/service/compute/model.go b/service/compute/model.go index 478bf21eb..8212ace88 100755 --- a/service/compute/model.go +++ b/service/compute/model.go @@ -451,10 +451,9 @@ type ClusterAttributes struct { // resources (e.g., AWS instances and EBS volumes) with these tags in // addition to `default_tags`. Notes: // - // - Currently, Databricks allows at most 45 custom tags - // - // - Clusters can only reuse cloud resources if the resources' tags are a - // subset of the cluster tags + // - Currently, Databricks allows at most 45 custom tags + // - Clusters can only reuse cloud resources if the resources' tags are a + // subset of the cluster tags CustomTags map[string]string `json:"custom_tags,omitempty"` DataSecurityMode DataSecurityMode `json:"data_security_mode,omitempty"` @@ -648,25 +647,20 @@ type ClusterDetails struct { // resources (e.g., AWS instances and EBS volumes) with these tags in // addition to `default_tags`. Notes: // - // - Currently, Databricks allows at most 45 custom tags - // - // - Clusters can only reuse cloud resources if the resources' tags are a - // subset of the cluster tags + // - Currently, Databricks allows at most 45 custom tags + // - Clusters can only reuse cloud resources if the resources' tags are a + // subset of the cluster tags CustomTags map[string]string `json:"custom_tags,omitempty"` DataSecurityMode DataSecurityMode `json:"data_security_mode,omitempty"` // Tags that are added by Databricks regardless of any `custom_tags`, // including: // - // - Vendor: Databricks - // - // - Creator: - // - // - ClusterName: - // - // - ClusterId: - // - // - Name: + // - Vendor: Databricks + // - Creator: + // - ClusterName: + // - ClusterId: + // - Name: DefaultTags map[string]string `json:"default_tags,omitempty"` // Custom docker image BYOC DockerImage *DockerImage `json:"docker_image,omitempty"` @@ -1273,10 +1267,9 @@ type ClusterSpec struct { // resources (e.g., AWS instances and EBS volumes) with these tags in // addition to `default_tags`. Notes: // - // - Currently, Databricks allows at most 45 custom tags - // - // - Clusters can only reuse cloud resources if the resources' tags are a - // subset of the cluster tags + // - Currently, Databricks allows at most 45 custom tags + // - Clusters can only reuse cloud resources if the resources' tags are a + // subset of the cluster tags CustomTags map[string]string `json:"custom_tags,omitempty"` DataSecurityMode DataSecurityMode `json:"data_security_mode,omitempty"` @@ -1651,10 +1644,9 @@ type CreateCluster struct { // resources (e.g., AWS instances and EBS volumes) with these tags in // addition to `default_tags`. Notes: // - // - Currently, Databricks allows at most 45 custom tags - // - // - Clusters can only reuse cloud resources if the resources' tags are a - // subset of the cluster tags + // - Currently, Databricks allows at most 45 custom tags + // - Clusters can only reuse cloud resources if the resources' tags are a + // subset of the cluster tags CustomTags map[string]string `json:"custom_tags,omitempty"` DataSecurityMode DataSecurityMode `json:"data_security_mode,omitempty"` @@ -1826,7 +1818,7 @@ type CreateInstancePool struct { // resources (e.g., AWS instances and EBS volumes) with these tags in // addition to `default_tags`. Notes: // - // - Currently, Databricks allows at most 45 custom tags + // - Currently, Databricks allows at most 45 custom tags CustomTags map[string]string `json:"custom_tags,omitempty"` // Defines the specification of the disks that will be attached to all spark // containers. @@ -1996,9 +1988,11 @@ func (s Created) MarshalJSON() ([]byte, error) { } type CustomPolicyTag struct { - // The key of the tag. - Must be unique among all custom tags of the same - // policy - Cannot be “budget-policy-name”, “budget-policy-id” or - // "budget-policy-resolution-result" - these tags are preserved. + // The key of the tag. + // + // - Must be unique among all custom tags of the same policy + // - Cannot be “budget-policy-name”, “budget-policy-id” or + // "budget-policy-resolution-result" - these tags are preserved. Key string `json:"key"` // The value of the tag. Value string `json:"value,omitempty"` @@ -2074,31 +2068,34 @@ func (f *DataPlaneEventDetailsEventType) Type() string { // Data security mode decides what data governance model to use when accessing // data from a cluster. // -// * `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate -// access mode depending on your compute configuration. * -// `DATA_SECURITY_MODE_STANDARD`: A secure cluster that can be shared by -// multiple users. Cluster users are fully isolated so that they cannot see each -// other’s data and credentials. Most data governance features are supported -// in this mode. But programming languages and cluster features might be -// limited. * `DATA_SECURITY_MODE_DEDICATED`: A secure cluster that can only be -// exclusively used by a single user specified in `single_user_name`. Most -// programming languages, cluster features and data governance features are -// available in this mode. +// - `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate +// access mode depending on your compute configuration. +// - `DATA_SECURITY_MODE_STANDARD`: A secure cluster that can be shared by +// multiple users. Cluster users are fully isolated so that they cannot see +// each other’s data and credentials. Most data governance features are +// supported in this mode. But programming languages and cluster features +// might be limited. +// - `DATA_SECURITY_MODE_DEDICATED`: A secure cluster that can only be +// exclusively used by a single user specified in `single_user_name`. Most +// programming languages, cluster features and data governance features are +// available in this mode. // // The following modes are legacy aliases for the above modes: // -// * `USER_ISOLATION`: Legacy alias for `DATA_SECURITY_MODE_STANDARD`. * -// `SINGLE_USER`: Legacy alias for `DATA_SECURITY_MODE_DEDICATED`. +// - `USER_ISOLATION`: Legacy alias for `DATA_SECURITY_MODE_STANDARD`. +// - `SINGLE_USER`: Legacy alias for `DATA_SECURITY_MODE_DEDICATED`. // // The following modes are deprecated starting with Databricks Runtime 15.0 and // will be removed for future Databricks Runtime versions: // -// * `LEGACY_TABLE_ACL`: This mode is for users migrating from legacy Table ACL -// clusters. * `LEGACY_PASSTHROUGH`: This mode is for users migrating from -// legacy Passthrough on high concurrency clusters. * `LEGACY_SINGLE_USER`: This -// mode is for users migrating from legacy Passthrough on standard clusters. * -// `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way that doesn’t have -// UC nor passthrough enabled. +// - `LEGACY_TABLE_ACL`: This mode is for users migrating from legacy Table +// ACL clusters. +// - `LEGACY_PASSTHROUGH`: This mode is for users migrating from legacy +// Passthrough on high concurrency clusters. +// - `LEGACY_SINGLE_USER`: This mode is for users migrating from legacy +// Passthrough on standard clusters. +// - `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way that doesn’t +// have UC nor passthrough enabled. type DataSecurityMode string // will choose the most appropriate access mode depending on your @@ -2214,11 +2211,13 @@ type DestroyContext struct { // launch 2 disks, 100 GiB each, then Databricks will launch a total of 6 disks, // 100 GiB each, for this cluster. type DiskSpec struct { - // The number of disks launched for each instance: - This feature is only - // enabled for supported node types. - Users can choose up to the limit of - // the disks supported by the node type. - For node types with no OS disk, - // at least one disk must be specified; otherwise, cluster creation will - // fail. + // The number of disks launched for each instance: + // + // - This feature is only enabled for supported node types. + // - Users can choose up to the limit of the disks supported by the node + // type. + // - For node types with no OS disk, at least one disk must be specified; + // otherwise, cluster creation will fail. // // If disks are attached, Databricks will configure Spark to use only the // disks for scratch storage, because heterogenously sized scratch devices @@ -2228,19 +2227,25 @@ type DiskSpec struct { // Note: If disks are specified, then the Spark configuration // `spark.local.dir` will be overridden. // - // Disks will be mounted at: - For AWS: `/ebs0`, `/ebs1`, and etc. - For - // Azure: `/remote_volume0`, `/remote_volume1`, and etc. + // Disks will be mounted at: + // + // - For AWS: `/ebs0`, `/ebs1`, and etc. + // - For Azure: `/remote_volume0`, `/remote_volume1`, and etc. DiskCount int `json:"disk_count,omitempty"` DiskIops int `json:"disk_iops,omitempty"` // The size of each disk (in GiB) launched for each instance. Values must // fall into the supported range for a particular instance type. // - // For AWS: - General Purpose SSD: 100 - 4096 GiB - Throughput Optimized - // HDD: 500 - 4096 GiB + // For AWS: + // + // - General Purpose SSD: 100 - 4096 GiB + // - Throughput Optimized HDD: 500 - 4096 GiB // - // For Azure: - Premium LRS (SSD): 1 - 1023 GiB - Standard LRS (HDD): 1- - // 1023 GiB + // For Azure: + // + // - Premium LRS (SSD): 1 - 1023 GiB + // - Standard LRS (HDD): 1- 1023 GiB DiskSize int `json:"disk_size,omitempty"` DiskThroughput int `json:"disk_throughput,omitempty"` @@ -2456,10 +2461,9 @@ type EditCluster struct { // resources (e.g., AWS instances and EBS volumes) with these tags in // addition to `default_tags`. Notes: // - // - Currently, Databricks allows at most 45 custom tags - // - // - Clusters can only reuse cloud resources if the resources' tags are a - // subset of the cluster tags + // - Currently, Databricks allows at most 45 custom tags + // - Clusters can only reuse cloud resources if the resources' tags are a + // subset of the cluster tags CustomTags map[string]string `json:"custom_tags,omitempty"` DataSecurityMode DataSecurityMode `json:"data_security_mode,omitempty"` @@ -2594,7 +2598,7 @@ type EditInstancePool struct { // resources (e.g., AWS instances and EBS volumes) with these tags in // addition to `default_tags`. Notes: // - // - Currently, Databricks allows at most 45 custom tags + // - Currently, Databricks allows at most 45 custom tags CustomTags map[string]string `json:"custom_tags,omitempty"` // Automatically terminates the extra instances in the pool cache after they // are inactive for this time in minutes if min_idle_instances requirement @@ -2739,9 +2743,8 @@ type Environment struct { // `workspace-base-environments/dbe_b849b66e-b31a-4cb5-b161-1f2b10877fb7`) // is in Beta. Either `environment_version` or `base_environment` can be // provided. For more information about Databricks-provided base - // environments, see the [list workspace base - // environments](:method:Environments/ListWorkspaceBaseEnvironments) API. - // For more information, see + // environments, see the list workspace base environments API. For more + // information, see BaseEnvironment string `json:"base_environment,omitempty"` // Use `environment_version` instead. Client string `json:"client,omitempty"` @@ -2773,8 +2776,8 @@ func (s Environment) MarshalJSON() ([]byte, error) { } type EventDetails struct { - // * For created clusters, the attributes of the cluster. * For edited - // clusters, the new attributes of the cluster. + // - For created clusters, the attributes of the cluster. + // - For edited clusters, the new attributes of the cluster. Attributes *ClusterAttributes `json:"attributes,omitempty"` // The cause of a change in target size. Cause EventDetailsCause `json:"cause,omitempty"` @@ -2801,8 +2804,10 @@ type EventDetails struct { // Instance Id where the event originated from InstanceId string `json:"instance_id,omitempty"` // Unique identifier of the specific job run associated with this cluster - // event * For clusters created for jobs, this will be the same as the - // cluster name + // event + // + // - For clusters created for jobs, this will be the same as the cluster + // name JobRunName string `json:"job_run_name,omitempty"` // The cluster attributes before a cluster was edited. PreviousAttributes *ClusterAttributes `json:"previous_attributes,omitempty"` @@ -2810,9 +2815,11 @@ type EventDetails struct { PreviousClusterSize *ClusterSize `json:"previous_cluster_size,omitempty"` // Previous disk size in bytes PreviousDiskSize int64 `json:"previous_disk_size,omitempty"` - // A termination reason: * On a TERMINATED event, this is the reason of the - // termination. * On a RESIZE_COMPLETE event, this indicates the reason that - // we failed to acquire some nodes. + // A termination reason: + // + // - On a TERMINATED event, this is the reason of the termination. + // - On a RESIZE_COMPLETE event, this indicates the reason that we failed + // to acquire some nodes. Reason *TerminationReason `json:"reason,omitempty"` // The targeted number of vCPUs in the cluster. TargetNumVcpus int `json:"target_num_vcpus,omitempty"` @@ -3053,12 +3060,15 @@ type GcpAttributes struct { // 'availability' field instead. UsePreemptibleExecutors bool `json:"use_preemptible_executors,omitempty"` // Identifier for the availability zone in which the cluster resides. This - // can be one of the following: - "HA" => High availability, spread nodes - // across availability zones for a Databricks deployment region [default]. - - // "AUTO" => Databricks picks an availability zone to schedule the cluster - // on. - A GCP availability zone => Pick One of the available zones for - // (machine type + region) from - // https://cloud.google.com/compute/docs/regions-zones. + // can be one of the following: + // + // - "HA" => High availability, spread nodes across availability zones for + // a Databricks deployment region [default]. + // - "AUTO" => Databricks picks an availability zone to schedule the + // cluster on. + // - A GCP availability zone => Pick One of the available zones for + // (machine type + region) from + // https://cloud.google.com/compute/docs/regions-zones. ZoneId string `json:"zone_id,omitempty"` ForceSendFields []string `json:"-" url:"-"` @@ -3320,18 +3330,15 @@ type GetInstancePool struct { // resources (e.g., AWS instances and EBS volumes) with these tags in // addition to `default_tags`. Notes: // - // - Currently, Databricks allows at most 45 custom tags + // - Currently, Databricks allows at most 45 custom tags CustomTags map[string]string `json:"custom_tags,omitempty"` - // Tags that are added by Databricks regardless of any ``custom_tags``, + // Tags that are added by Databricks regardless of any `custom_tags`, // including: // - // - Vendor: Databricks - // - // - InstancePoolCreator: - // - // - InstancePoolName: - // - // - InstancePoolId: + // - Vendor: Databricks + // - InstancePoolCreator: + // - InstancePoolName: + // - InstancePoolId: DefaultTags map[string]string `json:"default_tags,omitempty"` // Defines the specification of the disks that will be attached to all spark // containers. @@ -3833,18 +3840,15 @@ type InstancePoolAndStats struct { // resources (e.g., AWS instances and EBS volumes) with these tags in // addition to `default_tags`. Notes: // - // - Currently, Databricks allows at most 45 custom tags + // - Currently, Databricks allows at most 45 custom tags CustomTags map[string]string `json:"custom_tags,omitempty"` - // Tags that are added by Databricks regardless of any ``custom_tags``, + // Tags that are added by Databricks regardless of any `custom_tags`, // including: // - // - Vendor: Databricks - // - // - InstancePoolCreator: - // - // - InstancePoolName: - // - // - InstancePoolId: + // - Vendor: Databricks + // - InstancePoolCreator: + // - InstancePoolName: + // - InstancePoolId: DefaultTags map[string]string `json:"default_tags,omitempty"` // Defines the specification of the disks that will be attached to all spark // containers. @@ -4083,11 +4087,14 @@ type InstancePoolGcpAttributes struct { // instance pool creation, and if not specified, a default zone will be // used. // - // This field can be one of the following: - "HA" => High availability, - // spread nodes across availability zones for a Databricks deployment region - // - A GCP availability zone => Pick One of the available zones for (machine - // type + region) from https://cloud.google.com/compute/docs/regions-zones - // (e.g. "us-west1-a"). + // This field can be one of the following: + // + // - "HA" => High availability, spread nodes across availability zones for + // a Databricks deployment region + // - A GCP availability zone => Pick One of the available zones for + // (machine type + region) from + // https://cloud.google.com/compute/docs/regions-zones (e.g. + // "us-west1-a"). // // If empty, Databricks picks an availability zone to schedule the cluster // on. @@ -4203,8 +4210,10 @@ type InstancePoolPermissionsRequest struct { // The state of a Cluster. The current allowable state transitions are as // follows: // -// - “ACTIVE“ -> “STOPPED“ - “ACTIVE“ -> “DELETED“ - “STOPPED“ -> -// “ACTIVE“ - “STOPPED“ -> “DELETED“ +// - `ACTIVE` -> `STOPPED` +// - `ACTIVE` -> `DELETED` +// - `STOPPED` -> `ACTIVE` +// - `STOPPED` -> `DELETED` type InstancePoolState string const InstancePoolStateActive InstancePoolState = `ACTIVE` @@ -4311,9 +4320,10 @@ func (s InstanceProfile) MarshalJSON() ([]byte, error) { // applied. // // Clusters with `kind = CLASSIC_PREVIEW` support the following fields, whereas -// clusters with no specified `kind` do not. * -// [is_single_node](/api/workspace/clusters/create#is_single_node) * -// [use_ml_runtime](/api/workspace/clusters/create#use_ml_runtime) +// clusters with no specified `kind` do not. +// +// - is_single_node +// - use_ml_runtime // // By using the [simple form], your clusters are automatically using `kind = // CLASSIC_PREVIEW`. @@ -4528,8 +4538,8 @@ type ListAllClusterLibraryStatusesResponse struct { } type ListAvailableZonesResponse struct { - // The availability zone if no ``zone_id`` is provided in the cluster - // creation request. + // The availability zone if no `zone_id` is provided in the cluster creation + // request. DefaultZone string `json:"default_zone,omitempty"` // The list of available zones (e.g., ['us-west-2c', 'us-east-2']). Zones []string `json:"zones,omitempty"` @@ -4590,12 +4600,15 @@ func (s ListClusterCompliancesResponse) MarshalJSON() ([]byte, error) { } type ListClusterPoliciesRequest struct { - // The cluster policy attribute to sort by. * `POLICY_CREATION_TIME` - Sort - // result list by policy creation time. * `POLICY_NAME` - Sort result list - // by policy name. + // The cluster policy attribute to sort by. + // + // - `POLICY_CREATION_TIME` - Sort result list by policy creation time. + // - `POLICY_NAME` - Sort result list by policy name. SortColumn ListSortColumn `json:"-" url:"sort_column,omitempty"` - // The order in which the policies get listed. * `DESC` - Sort result list - // in descending order. * `ASC` - Sort result list in ascending order. + // The order in which the policies get listed. + // + // - `DESC` - Sort result list in descending order. + // - `ASC` - Sort result list in ascending order. SortOrder ListSortOrder `json:"-" url:"sort_order,omitempty"` } @@ -5299,12 +5312,11 @@ type Results struct { Data any `json:"data,omitempty"` // The image data in one of the following formats: // - // 1. A Data URL with base64-encoded image data: - // `data:image/{type};base64,{base64-data}`. Example: - // `data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA...` - // - // 2. A FileStore file path for large images: `/plots/{filename}.png`. - // Example: `/plots/b6a7ad70-fb2c-4353-8aed-3f1e015174a4.png` + // 1. A Data URL with base64-encoded image data: + // `data:image/{type};base64,{base64-data}`. Example: + // `data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA...` + // 2. A FileStore file path for large images: `/plots/{filename}.png`. + // Example: `/plots/b6a7ad70-fb2c-4353-8aed-3f1e015174a4.png` FileName string `json:"fileName,omitempty"` // List of image data for multiple images. Each element follows the same // format as file_name. @@ -5495,10 +5507,16 @@ type StartCluster struct { // The state of a Cluster. The current allowable state transitions are as // follows: // -// - `PENDING` -> `RUNNING` - `PENDING` -> `TERMINATING` - `RUNNING` -> -// `RESIZING` - `RUNNING` -> `RESTARTING` - `RUNNING` -> `TERMINATING` - -// `RESTARTING` -> `RUNNING` - `RESTARTING` -> `TERMINATING` - `RESIZING` -> -// `RUNNING` - `RESIZING` -> `TERMINATING` - `TERMINATING` -> `TERMINATED` +// - `PENDING` -> `RUNNING` +// - `PENDING` -> `TERMINATING` +// - `RUNNING` -> `RESIZING` +// - `RUNNING` -> `RESTARTING` +// - `RUNNING` -> `TERMINATING` +// - `RESTARTING` -> `RUNNING` +// - `RESTARTING` -> `TERMINATING` +// - `RESIZING` -> `RUNNING` +// - `RESIZING` -> `TERMINATING` +// - `TERMINATING` -> `TERMINATED` type State string const StateError State = `ERROR` @@ -6268,10 +6286,9 @@ type UpdateClusterResource struct { // resources (e.g., AWS instances and EBS volumes) with these tags in // addition to `default_tags`. Notes: // - // - Currently, Databricks allows at most 45 custom tags - // - // - Clusters can only reuse cloud resources if the resources' tags are a - // subset of the cluster tags + // - Currently, Databricks allows at most 45 custom tags + // - Clusters can only reuse cloud resources if the resources' tags are a + // subset of the cluster tags CustomTags map[string]string `json:"custom_tags,omitempty"` DataSecurityMode DataSecurityMode `json:"data_security_mode,omitempty"` diff --git a/service/dashboards/api.go b/service/dashboards/api.go index 75064adf7..55611519d 100755 --- a/service/dashboards/api.go +++ b/service/dashboards/api.go @@ -20,9 +20,8 @@ type GenieInterface interface { WaitGetMessageGenieCompleted(ctx context.Context, conversationId string, messageId string, spaceId string, timeout time.Duration, callback func(*GenieMessage)) (*GenieMessage, error) - // Create new message in a [conversation](:method:genie/startconversation). The - // AI response uses all previously created messages in the conversation to - // respond. + // Create new message in a conversation. The AI response uses all previously + // created messages in the conversation to respond. CreateMessage(ctx context.Context, genieCreateConversationMessageRequest GenieCreateConversationMessageRequest) (*WaitGetMessageGenieCompleted[GenieMessage], error) // Calls [GenieAPIInterface.CreateMessage] and waits to reach COMPLETED state @@ -52,21 +51,16 @@ type GenieInterface interface { // attachment has expired and needs to be re-executed. ExecuteMessageAttachmentQuery(ctx context.Context, request GenieExecuteMessageAttachmentQueryRequest) (*GenieGetMessageQueryResultResponse, error) - // DEPRECATED: Use [Execute Message Attachment - // Query](:method:genie/executemessageattachmentquery) instead. + // DEPRECATED: Use Execute Message Attachment Query instead. ExecuteMessageQuery(ctx context.Context, request GenieExecuteMessageQueryRequest) (*GenieGetMessageQueryResultResponse, error) // Initiates a new SQL execution and returns a `download_id` and // `download_id_signature` that you can use to track the progress of the // download. The query result is stored in an external link and can be retrieved - // using the [Get Download Full Query - // Result](:method:genie/getdownloadfullqueryresult) API. Both `download_id` and + // using the Get Download Full Query Result API. Both `download_id` and // `download_id_signature` must be provided when calling the Get endpoint. // - // ---- - // - // ### **Warning: Databricks strongly recommends that you protect the URLs that - // are returned by the `EXTERNAL_LINKS` disposition.** + // # **Warning: Databricks strongly recommends that you protect the URLs that are returned by the `EXTERNAL_LINKS` disposition.** // // When you use the `EXTERNAL_LINKS` disposition, a short-lived, URL is // generated, which can be used to download the results directly from . As a @@ -75,10 +69,7 @@ type GenieInterface interface { // Because URLs are already generated with embedded temporary s, you must not // set an `Authorization` header in the download requests. // - // See [Execute Statement](:method:statementexecution/executestatement) for more - // details. - // - // ---- + // See Execute Statement for more details. GenerateDownloadFullQueryResult(ctx context.Context, request GenieGenerateDownloadFullQueryResultRequest) (*GenieGenerateDownloadFullQueryResultResponse, error) // Create and run evaluations for multiple benchmark questions in a Genie space. @@ -96,18 +87,14 @@ type GenieInterface interface { // Lists all evaluation runs in a space. GenieListEvalRuns(ctx context.Context, request GenieListEvalRunsRequest) (*GenieListEvalRunsResponse, error) - // After [Generating a Full Query Result - // Download](:method:genie/generatedownloadfullqueryresult) and successfully - // receiving a `download_id` and `download_id_signature`, use this API to poll - // the download progress. Both `download_id` and `download_id_signature` are - // required to call this endpoint. When the download is complete, the API - // returns the result in the `EXTERNAL_LINKS` disposition, containing one or - // more external links to the query result files. + // After Generating a Full Query Result Download and successfully receiving a + // `download_id` and `download_id_signature`, use this API to poll the download + // progress. Both `download_id` and `download_id_signature` are required to call + // this endpoint. When the download is complete, the API returns the result in + // the `EXTERNAL_LINKS` disposition, containing one or more external links to + // the query result files. // - // ---- - // - // ### **Warning: Databricks strongly recommends that you protect the URLs that - // are returned by the `EXTERNAL_LINKS` disposition.** + // # **Warning: Databricks strongly recommends that you protect the URLs that are returned by the `EXTERNAL_LINKS` disposition.** // // When you use the `EXTERNAL_LINKS` disposition, a short-lived, URL is // generated, which can be used to download the results directly from . As a @@ -116,24 +103,17 @@ type GenieInterface interface { // Because URLs are already generated with embedded temporary s, you must not // set an `Authorization` header in the download requests. // - // See [Execute Statement](:method:statementexecution/executestatement) for more - // details. - // - // ---- + // See Execute Statement for more details. GetDownloadFullQueryResult(ctx context.Context, request GenieGetDownloadFullQueryResultRequest) (*GenieGetDownloadFullQueryResultResponse, error) - // After [Generating a Full Query Result - // Download](:method:genie/generatedownloadfullqueryresult) and successfully - // receiving a `download_id` and `download_id_signature`, use this API to poll - // the download progress. Both `download_id` and `download_id_signature` are - // required to call this endpoint. When the download is complete, the API - // returns the result in the `EXTERNAL_LINKS` disposition, containing one or - // more external links to the query result files. + // After Generating a Full Query Result Download and successfully receiving a + // `download_id` and `download_id_signature`, use this API to poll the download + // progress. Both `download_id` and `download_id_signature` are required to call + // this endpoint. When the download is complete, the API returns the result in + // the `EXTERNAL_LINKS` disposition, containing one or more external links to + // the query result files. // - // ---- - // - // ### **Warning: Databricks strongly recommends that you protect the URLs that - // are returned by the `EXTERNAL_LINKS` disposition.** + // # **Warning: Databricks strongly recommends that you protect the URLs that are returned by the `EXTERNAL_LINKS` disposition.** // // When you use the `EXTERNAL_LINKS` disposition, a short-lived, URL is // generated, which can be used to download the results directly from . As a @@ -142,10 +122,7 @@ type GenieInterface interface { // Because URLs are already generated with embedded temporary s, you must not // set an `Authorization` header in the download requests. // - // See [Execute Statement](:method:statementexecution/executestatement) for more - // details. - // - // ---- + // See Execute Statement for more details. GetDownloadFullQueryResultBySpaceIdAndConversationIdAndMessageIdAndAttachmentIdAndDownloadId(ctx context.Context, spaceId string, conversationId string, messageId string, attachmentId string, downloadId string) (*GenieGetDownloadFullQueryResultResponse, error) // Get message from conversation. @@ -164,20 +141,16 @@ type GenieInterface interface { // `EXECUTING_QUERY` OR `COMPLETED`. GetMessageAttachmentQueryResultBySpaceIdAndConversationIdAndMessageIdAndAttachmentId(ctx context.Context, spaceId string, conversationId string, messageId string, attachmentId string) (*GenieGetMessageQueryResultResponse, error) - // DEPRECATED: Use [Get Message Attachment Query - // Result](:method:genie/getmessageattachmentqueryresult) instead. + // DEPRECATED: Use Get Message Attachment Query Result instead. GetMessageQueryResult(ctx context.Context, request GenieGetMessageQueryResultRequest) (*GenieGetMessageQueryResultResponse, error) - // DEPRECATED: Use [Get Message Attachment Query - // Result](:method:genie/getmessageattachmentqueryresult) instead. + // DEPRECATED: Use Get Message Attachment Query Result instead. GetMessageQueryResultBySpaceIdAndConversationIdAndMessageId(ctx context.Context, spaceId string, conversationId string, messageId string) (*GenieGetMessageQueryResultResponse, error) - // DEPRECATED: Use [Get Message Attachment Query - // Result](:method:genie/getmessageattachmentqueryresult) instead. + // DEPRECATED: Use Get Message Attachment Query Result instead. GetMessageQueryResultByAttachment(ctx context.Context, request GenieGetQueryResultByAttachmentRequest) (*GenieGetMessageQueryResultResponse, error) - // DEPRECATED: Use [Get Message Attachment Query - // Result](:method:genie/getmessageattachmentqueryresult) instead. + // DEPRECATED: Use Get Message Attachment Query Result instead. GetMessageQueryResultByAttachmentBySpaceIdAndConversationIdAndMessageIdAndAttachmentId(ctx context.Context, spaceId string, conversationId string, messageId string, attachmentId string) (*GenieGetMessageQueryResultResponse, error) // Get details of a Genie Space. @@ -303,9 +276,8 @@ func (w *WaitGetMessageGenieCompleted[R]) GetWithTimeout(timeout time.Duration) return w.Poll(timeout, w.callback) } -// Create new message in a [conversation](:method:genie/startconversation). The -// AI response uses all previously created messages in the conversation to -// respond. +// Create new message in a conversation. The AI response uses all previously +// created messages in the conversation to respond. func (a *GenieAPI) CreateMessage(ctx context.Context, genieCreateConversationMessageRequest GenieCreateConversationMessageRequest) (*WaitGetMessageGenieCompleted[GenieMessage], error) { genieMessage, err := a.genieImpl.CreateMessage(ctx, genieCreateConversationMessageRequest) if err != nil { @@ -359,18 +331,14 @@ func (a *GenieAPI) DeleteConversationBySpaceIdAndConversationId(ctx context.Cont }) } -// After [Generating a Full Query Result -// Download](:method:genie/generatedownloadfullqueryresult) and successfully -// receiving a `download_id` and `download_id_signature`, use this API to poll -// the download progress. Both `download_id` and `download_id_signature` are -// required to call this endpoint. When the download is complete, the API -// returns the result in the `EXTERNAL_LINKS` disposition, containing one or -// more external links to the query result files. +// After Generating a Full Query Result Download and successfully receiving a +// `download_id` and `download_id_signature`, use this API to poll the download +// progress. Both `download_id` and `download_id_signature` are required to call +// this endpoint. When the download is complete, the API returns the result in +// the `EXTERNAL_LINKS` disposition, containing one or more external links to +// the query result files. // -// ---- -// -// ### **Warning: Databricks strongly recommends that you protect the URLs that -// are returned by the `EXTERNAL_LINKS` disposition.** +// # **Warning: Databricks strongly recommends that you protect the URLs that are returned by the `EXTERNAL_LINKS` disposition.** // // When you use the `EXTERNAL_LINKS` disposition, a short-lived, URL is // generated, which can be used to download the results directly from . As a @@ -379,10 +347,7 @@ func (a *GenieAPI) DeleteConversationBySpaceIdAndConversationId(ctx context.Cont // Because URLs are already generated with embedded temporary s, you must not // set an `Authorization` header in the download requests. // -// See [Execute Statement](:method:statementexecution/executestatement) for more -// details. -// -// ---- +// See Execute Statement for more details. func (a *GenieAPI) GetDownloadFullQueryResultBySpaceIdAndConversationIdAndMessageIdAndAttachmentIdAndDownloadId(ctx context.Context, spaceId string, conversationId string, messageId string, attachmentId string, downloadId string) (*GenieGetDownloadFullQueryResultResponse, error) { return a.genieImpl.GetDownloadFullQueryResult(ctx, GenieGetDownloadFullQueryResultRequest{ SpaceId: spaceId, @@ -414,8 +379,7 @@ func (a *GenieAPI) GetMessageAttachmentQueryResultBySpaceIdAndConversationIdAndM }) } -// DEPRECATED: Use [Get Message Attachment Query -// Result](:method:genie/getmessageattachmentqueryresult) instead. +// DEPRECATED: Use Get Message Attachment Query Result instead. func (a *GenieAPI) GetMessageQueryResultBySpaceIdAndConversationIdAndMessageId(ctx context.Context, spaceId string, conversationId string, messageId string) (*GenieGetMessageQueryResultResponse, error) { return a.genieImpl.GetMessageQueryResult(ctx, GenieGetMessageQueryResultRequest{ SpaceId: spaceId, @@ -424,8 +388,7 @@ func (a *GenieAPI) GetMessageQueryResultBySpaceIdAndConversationIdAndMessageId(c }) } -// DEPRECATED: Use [Get Message Attachment Query -// Result](:method:genie/getmessageattachmentqueryresult) instead. +// DEPRECATED: Use Get Message Attachment Query Result instead. func (a *GenieAPI) GetMessageQueryResultByAttachmentBySpaceIdAndConversationIdAndMessageIdAndAttachmentId(ctx context.Context, spaceId string, conversationId string, messageId string, attachmentId string) (*GenieGetMessageQueryResultResponse, error) { return a.genieImpl.GetMessageQueryResultByAttachment(ctx, GenieGetQueryResultByAttachmentRequest{ SpaceId: spaceId, diff --git a/service/dashboards/interface.go b/service/dashboards/interface.go index 1401fe758..45b97fa06 100755 --- a/service/dashboards/interface.go +++ b/service/dashboards/interface.go @@ -15,9 +15,8 @@ import ( // Deprecated: Do not use this interface, it will be removed in a future version of the SDK. type GenieService interface { - // Create new message in a [conversation](:method:genie/startconversation). - // The AI response uses all previously created messages in the conversation - // to respond. + // Create new message in a conversation. The AI response uses all previously + // created messages in the conversation to respond. CreateMessage(ctx context.Context, request GenieCreateConversationMessageRequest) (*GenieMessage, error) // Create a comment on a conversation message. @@ -36,22 +35,17 @@ type GenieService interface { // query attachment has expired and needs to be re-executed. ExecuteMessageAttachmentQuery(ctx context.Context, request GenieExecuteMessageAttachmentQueryRequest) (*GenieGetMessageQueryResultResponse, error) - // DEPRECATED: Use [Execute Message Attachment - // Query](:method:genie/executemessageattachmentquery) instead. + // DEPRECATED: Use Execute Message Attachment Query instead. ExecuteMessageQuery(ctx context.Context, request GenieExecuteMessageQueryRequest) (*GenieGetMessageQueryResultResponse, error) // Initiates a new SQL execution and returns a `download_id` and // `download_id_signature` that you can use to track the progress of the // download. The query result is stored in an external link and can be - // retrieved using the [Get Download Full Query - // Result](:method:genie/getdownloadfullqueryresult) API. Both `download_id` - // and `download_id_signature` must be provided when calling the Get - // endpoint. + // retrieved using the Get Download Full Query Result API. Both + // `download_id` and `download_id_signature` must be provided when calling + // the Get endpoint. // - // ---- - // - // ### **Warning: Databricks strongly recommends that you protect the URLs - // that are returned by the `EXTERNAL_LINKS` disposition.** + // # **Warning: Databricks strongly recommends that you protect the URLs that are returned by the `EXTERNAL_LINKS` disposition.** // // When you use the `EXTERNAL_LINKS` disposition, a short-lived, URL is // generated, which can be used to download the results directly from . As a @@ -60,10 +54,7 @@ type GenieService interface { // Because URLs are already generated with embedded temporary s, you must // not set an `Authorization` header in the download requests. // - // See [Execute Statement](:method:statementexecution/executestatement) for - // more details. - // - // ---- + // See Execute Statement for more details. GenerateDownloadFullQueryResult(ctx context.Context, request GenieGenerateDownloadFullQueryResultRequest) (*GenieGenerateDownloadFullQueryResultResponse, error) // Create and run evaluations for multiple benchmark questions in a Genie @@ -82,19 +73,14 @@ type GenieService interface { // Lists all evaluation runs in a space. GenieListEvalRuns(ctx context.Context, request GenieListEvalRunsRequest) (*GenieListEvalRunsResponse, error) - // After [Generating a Full Query Result - // Download](:method:genie/generatedownloadfullqueryresult) and successfully - // receiving a `download_id` and `download_id_signature`, use this API to - // poll the download progress. Both `download_id` and - // `download_id_signature` are required to call this endpoint. When the - // download is complete, the API returns the result in the `EXTERNAL_LINKS` - // disposition, containing one or more external links to the query result - // files. + // After Generating a Full Query Result Download and successfully receiving + // a `download_id` and `download_id_signature`, use this API to poll the + // download progress. Both `download_id` and `download_id_signature` are + // required to call this endpoint. When the download is complete, the API + // returns the result in the `EXTERNAL_LINKS` disposition, containing one or + // more external links to the query result files. // - // ---- - // - // ### **Warning: Databricks strongly recommends that you protect the URLs - // that are returned by the `EXTERNAL_LINKS` disposition.** + // # **Warning: Databricks strongly recommends that you protect the URLs that are returned by the `EXTERNAL_LINKS` disposition.** // // When you use the `EXTERNAL_LINKS` disposition, a short-lived, URL is // generated, which can be used to download the results directly from . As a @@ -103,10 +89,7 @@ type GenieService interface { // Because URLs are already generated with embedded temporary s, you must // not set an `Authorization` header in the download requests. // - // See [Execute Statement](:method:statementexecution/executestatement) for - // more details. - // - // ---- + // See Execute Statement for more details. GetDownloadFullQueryResult(ctx context.Context, request GenieGetDownloadFullQueryResultRequest) (*GenieGetDownloadFullQueryResultResponse, error) // Get message from conversation. @@ -117,12 +100,10 @@ type GenieService interface { // status is `EXECUTING_QUERY` OR `COMPLETED`. GetMessageAttachmentQueryResult(ctx context.Context, request GenieGetMessageAttachmentQueryResultRequest) (*GenieGetMessageQueryResultResponse, error) - // DEPRECATED: Use [Get Message Attachment Query - // Result](:method:genie/getmessageattachmentqueryresult) instead. + // DEPRECATED: Use Get Message Attachment Query Result instead. GetMessageQueryResult(ctx context.Context, request GenieGetMessageQueryResultRequest) (*GenieGetMessageQueryResultResponse, error) - // DEPRECATED: Use [Get Message Attachment Query - // Result](:method:genie/getmessageattachmentqueryresult) instead. + // DEPRECATED: Use Get Message Attachment Query Result instead. GetMessageQueryResultByAttachment(ctx context.Context, request GenieGetQueryResultByAttachmentRequest) (*GenieGetMessageQueryResultResponse, error) // Get details of a Genie Space. diff --git a/service/dashboards/model.go b/service/dashboards/model.go index 03227aee1..6324f0089 100755 --- a/service/dashboards/model.go +++ b/service/dashboards/model.go @@ -378,11 +378,10 @@ type GenieCreateSpaceRequest struct { Description string `json:"description,omitempty"` // Parent folder path where the space will be registered ParentPath string `json:"parent_path,omitempty"` - // The contents of the Genie Space in serialized string form. Use the [Get - // Genie Space](:method:genie/getspace) API to retrieve an example response, - // which includes the `serialized_space` field. This field provides the - // structure of the JSON string that represents the space's layout and - // components. + // The contents of the Genie Space in serialized string form. Use the Get + // Genie Space API to retrieve an example response, which includes the + // `serialized_space` field. This field provides the structure of the JSON + // string that represents the space's layout and components. SerializedSpace string `json:"serialized_space"` // Optional title override Title string `json:"title,omitempty"` @@ -552,53 +551,67 @@ type GenieEvalResultDetails struct { // // Assessment reasons describe why a Genie response was scored as BAD. // - // Deterministic values (compared against the ground truth result): - - // EMPTY_RESULT: Genie's generated SQL results were empty for this benchmark - // question. - RESULT_MISSING_ROWS: Genie's generated SQL response is - // missing rows from the provided ground truth SQL. - RESULT_EXTRA_ROWS: - // Genie's generated SQL response has more rows than the provided ground - // truth SQL. - RESULT_MISSING_COLUMNS: Genie's generated SQL response is - // missing columns from the provided ground truth SQL. - - // RESULT_EXTRA_COLUMNS: Genie's generated SQL response has more columns - // than the provided ground truth SQL. - SINGLE_CELL_DIFFERENCE: Single - // value result was produced but differs from ground truth result. - - // EMPTY_GOOD_SQL: The benchmark SQL returned an empty result. - - // COLUMN_TYPE_DIFFERENCE: The values between the results match but the - // column type is different. + // Deterministic values (compared against the ground truth result): // - // LLM judge ratings explain the factors driving BAD results: - - // LLM_JUDGE_MISSING_OR_INCORRECT_FILTER: Genie's generated SQL is missing a - // WHERE clause condition or has incorrect filter logic that - // excludes/includes wrong data. - LLM_JUDGE_INCOMPLETE_OR_PARTIAL_OUTPUT: - // Genie's generated SQL returns only some of the requested data or columns, - // missing parts of what the ground truth SQL returns. - - // LLM_JUDGE_MISINTERPRETATION_OF_USER_REQUEST: Genie's generated SQL - // fundamentally misunderstands what the user is asking for, addressing the - // wrong question or goal. - - // LLM_JUDGE_INSTRUCTION_COMPLIANCE_OR_MISSING_BUSINESS_LOGIC: Genie's - // generated SQL fails to apply specified instructions or business logic - // that should be followed. - LLM_JUDGE_INCORRECT_METRIC_CALCULATION: - // Genie's generated SQL uses incorrect logic or makes wrong assumptions - // when calculating metrics. - LLM_JUDGE_INCORRECT_TABLE_OR_FIELD_USAGE: - // Genie's generated SQL references wrong tables, columns, or uses fields - // that don't match the ground truth SQL's intent. - - // LLM_JUDGE_INCORRECT_FUNCTION_USAGE: Genie's generated SQL uses SQL - // functions incorrectly or inappropriately (wrong parameters, wrong - // function for the task, etc.). - LLM_JUDGE_MISSING_OR_INCORRECT_JOIN: - // Genie's generated SQL is missing necessary joins between tables or has - // incorrect join conditions/types that produce wrong results. - - // LLM_JUDGE_MISSING_OR_INCORRECT_AGGREGATION: Genie's generated SQL is - // missing GROUP BY clauses or has incorrect grouping that doesn't match the - // requested aggregation level. - LLM_JUDGE_FORMATTING_ERROR: Genie's - // generated SQL output has incorrect formatting, ordering (ORDER BY), or - // presentation issues that don't match expectations. - LLM_JUDGE_OTHER: LLM - // judge identified an error that doesn't fall into other categories. + // - EMPTY_RESULT: Genie's generated SQL results were empty for this + // benchmark question. + // - RESULT_MISSING_ROWS: Genie's generated SQL response is missing rows + // from the provided ground truth SQL. + // - RESULT_EXTRA_ROWS: Genie's generated SQL response has more rows than + // the provided ground truth SQL. + // - RESULT_MISSING_COLUMNS: Genie's generated SQL response is missing + // columns from the provided ground truth SQL. + // - RESULT_EXTRA_COLUMNS: Genie's generated SQL response has more columns + // than the provided ground truth SQL. + // - SINGLE_CELL_DIFFERENCE: Single value result was produced but differs + // from ground truth result. + // - EMPTY_GOOD_SQL: The benchmark SQL returned an empty result. + // - COLUMN_TYPE_DIFFERENCE: The values between the results match but the + // column type is different. + // + // LLM judge ratings explain the factors driving BAD results: + // + // - LLM_JUDGE_MISSING_OR_INCORRECT_FILTER: Genie's generated SQL is + // missing a WHERE clause condition or has incorrect filter logic that + // excludes/includes wrong data. + // - LLM_JUDGE_INCOMPLETE_OR_PARTIAL_OUTPUT: Genie's generated SQL returns + // only some of the requested data or columns, missing parts of what the + // ground truth SQL returns. + // - LLM_JUDGE_MISINTERPRETATION_OF_USER_REQUEST: Genie's generated SQL + // fundamentally misunderstands what the user is asking for, addressing + // the wrong question or goal. + // - LLM_JUDGE_INSTRUCTION_COMPLIANCE_OR_MISSING_BUSINESS_LOGIC: Genie's + // generated SQL fails to apply specified instructions or business logic + // that should be followed. + // - LLM_JUDGE_INCORRECT_METRIC_CALCULATION: Genie's generated SQL uses + // incorrect logic or makes wrong assumptions when calculating metrics. + // - LLM_JUDGE_INCORRECT_TABLE_OR_FIELD_USAGE: Genie's generated SQL + // references wrong tables, columns, or uses fields that don't match the + // ground truth SQL's intent. + // - LLM_JUDGE_INCORRECT_FUNCTION_USAGE: Genie's generated SQL uses SQL + // functions incorrectly or inappropriately (wrong parameters, wrong + // function for the task, etc.). + // - LLM_JUDGE_MISSING_OR_INCORRECT_JOIN: Genie's generated SQL is missing + // necessary joins between tables or has incorrect join conditions/types + // that produce wrong results. + // - LLM_JUDGE_MISSING_OR_INCORRECT_AGGREGATION: Genie's generated SQL is + // missing GROUP BY clauses or has incorrect grouping that doesn't match + // the requested aggregation level. + // - LLM_JUDGE_FORMATTING_ERROR: Genie's generated SQL output has + // incorrect formatting, ordering (ORDER BY), or presentation issues + // that don't match expectations. + // - LLM_JUDGE_OTHER: LLM judge identified an error that doesn't fall into + // other categories. // // Deprecated LLM judge values (kept for backward compatibility, do not - // use): - LLM_JUDGE_MISSING_JOIN (deprecated) - LLM_JUDGE_WRONG_FILTER - // (deprecated) - LLM_JUDGE_WRONG_AGGREGATION (deprecated) - - // LLM_JUDGE_WRONG_COLUMNS (deprecated) - LLM_JUDGE_SYNTAX_ERROR - // (deprecated) - LLM_JUDGE_SEMANTIC_ERROR (deprecated) + // use): + // + // - LLM_JUDGE_MISSING_JOIN (deprecated) + // - LLM_JUDGE_WRONG_FILTER (deprecated) + // - LLM_JUDGE_WRONG_AGGREGATION (deprecated) + // - LLM_JUDGE_WRONG_COLUMNS (deprecated) + // - LLM_JUDGE_SYNTAX_ERROR (deprecated) + // - LLM_JUDGE_SEMANTIC_ERROR (deprecated) AssessmentReasons []ScoreReason `json:"assessment_reasons,omitempty"` // The ID of the benchmark question that was evaluated. BenchmarkQuestionId string `json:"benchmark_question_id"` @@ -781,8 +794,7 @@ type GenieGetDownloadFullQueryResultRequest struct { AttachmentId string `json:"-" url:"-"` // Conversation ID ConversationId string `json:"-" url:"-"` - // Download ID. This ID is provided by the [Generate Download - // endpoint](:method:genie/generateDownloadFullQueryResult) + // Download ID. This ID is provided by the Generate Download endpoint DownloadId string `json:"-" url:"-"` // JWT signature for the download_id to ensure secure access to query // results @@ -794,8 +806,8 @@ type GenieGetDownloadFullQueryResultRequest struct { } type GenieGetDownloadFullQueryResultResponse struct { - // SQL Statement Execution response. See [Get status, manifest, and result - // first chunk](:method:statementexecution/getstatement) for more details. + // SQL Statement Execution response. See Get status, manifest, and result + // first chunk for more details. StatementResponse *sql.StatementResponse `json:"statement_response,omitempty"` } @@ -837,8 +849,8 @@ type GenieGetMessageQueryResultRequest struct { } type GenieGetMessageQueryResultResponse struct { - // SQL Statement Execution response. See [Get status, manifest, and result - // first chunk](:method:statementexecution/getstatement) for more details. + // SQL Statement Execution response. See Get status, manifest, and result + // first chunk for more details. StatementResponse *sql.StatementResponse `json:"statement_response,omitempty"` } @@ -1218,9 +1230,8 @@ type GenieQueryAttachment struct { Query string `json:"query,omitempty"` // Metadata associated with the query result. QueryResultMetadata *GenieResultMetadata `json:"query_result_metadata,omitempty"` - // Statement Execution API statement id. Use [Get status, manifest, and - // result first chunk](:method:statementexecution/getstatement) to get the - // full result data. + // Statement Execution API statement id. Use Get status, manifest, and + // result first chunk to get the full result data. StatementId string `json:"statement_id,omitempty"` // Insights into how Genie came to generate the SQL. Thoughts []Thought `json:"thoughts,omitempty"` @@ -1287,10 +1298,10 @@ type GenieSpace struct { // Parent folder path of the Genie Space ParentPath string `json:"parent_path,omitempty"` // The contents of the Genie Space in serialized string form. This field is - // excluded in List Genie spaces responses. Use the [Get Genie - // Space](:method:genie/getspace) API to retrieve an example response, which - // includes the `serialized_space` field. This field provides the structure - // of the JSON string that represents the space's layout and components. + // excluded in List Genie spaces responses. Use the Get Genie Space API to + // retrieve an example response, which includes the `serialized_space` + // field. This field provides the structure of the JSON string that + // represents the space's layout and components. SerializedSpace string `json:"serialized_space,omitempty"` // Genie space ID SpaceId string `json:"space_id"` @@ -1349,10 +1360,10 @@ type GenieUpdateSpaceRequest struct { // Parent workspace folder path to move this Genie space under. ParentPath string `json:"parent_path,omitempty"` // The contents of the Genie Space in serialized string form (full - // replacement). Use the [Get Genie Space](:method:genie/getspace) API to - // retrieve an example response, which includes the `serialized_space` - // field. This field provides the structure of the JSON string that - // represents the space's layout and components. + // replacement). Use the Get Genie Space API to retrieve an example + // response, which includes the `serialized_space` field. This field + // provides the structure of the JSON string that represents the space's + // layout and components. SerializedSpace string `json:"serialized_space,omitempty"` // Genie space ID SpaceId string `json:"-" url:"-"` @@ -1827,22 +1838,26 @@ func (f *MessageErrorType) Type() string { return "MessageErrorType" } -// MessageStatus. The possible values are: * `FETCHING_METADATA`: Fetching -// metadata from the data sources. * `FILTERING_CONTEXT`: Running smart context -// step to determine relevant context. * `ASKING_AI`: Waiting for the LLM to -// respond to the user's question. * `PENDING_WAREHOUSE`: Waiting for warehouse -// before the SQL query can start executing. * `EXECUTING_QUERY`: Executing a -// generated SQL query. Get the SQL query result by calling -// [getMessageAttachmentQueryResult](:method:genie/getMessageAttachmentQueryResult) -// API. * `FAILED`: The response generation or query execution failed. See -// `error` field. * `COMPLETED`: Message processing is completed. Results are in -// the `attachments` field. Get the SQL query result by calling -// [getMessageAttachmentQueryResult](:method:genie/getMessageAttachmentQueryResult) -// API. * `SUBMITTED`: Message has been submitted. * `QUERY_RESULT_EXPIRED`: SQL -// result is not available anymore. The user needs to rerun the query. Rerun the -// SQL query result by calling -// [executeMessageAttachmentQuery](:method:genie/executeMessageAttachmentQuery) -// API. * `CANCELLED`: Message has been cancelled. +// MessageStatus. The possible values are: +// +// - `FETCHING_METADATA`: Fetching metadata from the data sources. +// - `FILTERING_CONTEXT`: Running smart context step to determine relevant +// context. +// - `ASKING_AI`: Waiting for the LLM to respond to the user's question. +// - `PENDING_WAREHOUSE`: Waiting for warehouse before the SQL query can start +// executing. +// - `EXECUTING_QUERY`: Executing a generated SQL query. Get the SQL query +// result by calling getMessageAttachmentQueryResult API. +// - `FAILED`: The response generation or query execution failed. See `error` +// field. +// - `COMPLETED`: Message processing is completed. Results are in the +// `attachments` field. Get the SQL query result by calling +// getMessageAttachmentQueryResult API. +// - `SUBMITTED`: Message has been submitted. +// - `QUERY_RESULT_EXPIRED`: SQL result is not available anymore. The user +// needs to rerun the query. Rerun the SQL query result by calling +// executeMessageAttachmentQuery API. +// - `CANCELLED`: Message has been cancelled. type MessageStatus string // Waiting for the LLM to respond to the user's question. @@ -1852,14 +1867,11 @@ const MessageStatusAskingAi MessageStatus = `ASKING_AI` const MessageStatusCancelled MessageStatus = `CANCELLED` // Message processing is completed. Results are in the `attachments` field. Get -// the SQL query result by calling -// [getMessageAttachmentQueryResult](:method:genie/getMessageAttachmentQueryResult) -// API. +// the SQL query result by calling getMessageAttachmentQueryResult API. const MessageStatusCompleted MessageStatus = `COMPLETED` // Executing a generated SQL query. Get the SQL query result by calling -// [getMessageAttachmentQueryResult](:method:genie/getMessageAttachmentQueryResult) -// API. +// getMessageAttachmentQueryResult API. const MessageStatusExecutingQuery MessageStatus = `EXECUTING_QUERY` // The response generation or query execution failed. See `error` field. @@ -1875,9 +1887,7 @@ const MessageStatusFilteringContext MessageStatus = `FILTERING_CONTEXT` const MessageStatusPendingWarehouse MessageStatus = `PENDING_WAREHOUSE` // SQL result is not available anymore. The user needs to rerun the query. Rerun -// the SQL query result by calling -// [executeMessageAttachmentQuery](:method:genie/executeMessageAttachmentQuery) -// API. +// the SQL query result by calling executeMessageAttachmentQuery API. const MessageStatusQueryResultExpired MessageStatus = `QUERY_RESULT_EXPIRED` // Message has been submitted. @@ -2012,9 +2022,8 @@ type Result struct { IsTruncated bool `json:"is_truncated,omitempty"` // Row count of the result RowCount int64 `json:"row_count,omitempty"` - // Statement Execution API statement id. Use [Get status, manifest, and - // result first chunk](:method:statementexecution/getstatement) to get the - // full result data. + // Statement Execution API statement id. Use Get status, manifest, and + // result first chunk to get the full result data. StatementId string `json:"statement_id,omitempty"` // JWT corresponding to the statement contained in this result StatementIdSignature string `json:"statement_id_signature,omitempty"` @@ -2347,13 +2356,17 @@ func (f *TextAttachmentPurpose) Type() string { type Thought struct { // The md formatted content for this thought. Content string `json:"content,omitempty"` - // The category of this thought. The possible values are: * - // `THOUGHT_TYPE_DESCRIPTION`: A high-level description of how the question - // was interpreted. * `THOUGHT_TYPE_UNDERSTANDING`: How ambiguous parts of - // the question were resolved. * `THOUGHT_TYPE_DATA_SOURCING`: Which tables - // or datasets were identified as relevant. * `THOUGHT_TYPE_INSTRUCTIONS`: - // Which author-defined instructions were referenced. * - // `THOUGHT_TYPE_STEPS`: The logical steps taken to compute the answer. + // The category of this thought. The possible values are: + // + // - `THOUGHT_TYPE_DESCRIPTION`: A high-level description of how the + // question was interpreted. + // - `THOUGHT_TYPE_UNDERSTANDING`: How ambiguous parts of the question + // were resolved. + // - `THOUGHT_TYPE_DATA_SOURCING`: Which tables or datasets were + // identified as relevant. + // - `THOUGHT_TYPE_INSTRUCTIONS`: Which author-defined instructions were + // referenced. + // - `THOUGHT_TYPE_STEPS`: The logical steps taken to compute the answer. ThoughtType ThoughtType `json:"thought_type,omitempty"` ForceSendFields []string `json:"-" url:"-"` @@ -2367,15 +2380,19 @@ func (s Thought) MarshalJSON() ([]byte, error) { return marshal.Marshal(s) } -// ThoughtType. The possible values are: * `THOUGHT_TYPE_UNSPECIFIED`: Default -// value that should not be used. * `THOUGHT_TYPE_DESCRIPTION`: A high-level -// description of how the question was interpreted. * -// `THOUGHT_TYPE_UNDERSTANDING`: How ambiguous parts of the question were -// resolved. * `THOUGHT_TYPE_DATA_SOURCING`: Which tables or datasets were -// identified as relevant. * `THOUGHT_TYPE_INSTRUCTIONS`: Which author-defined -// instructions were referenced. * `THOUGHT_TYPE_STEPS`: The logical steps taken -// to compute the answer. The category of a Thought. Additional values may be -// added in the future. +// ThoughtType. The possible values are: +// +// - `THOUGHT_TYPE_UNSPECIFIED`: Default value that should not be used. +// - `THOUGHT_TYPE_DESCRIPTION`: A high-level description of how the question +// was interpreted. +// - `THOUGHT_TYPE_UNDERSTANDING`: How ambiguous parts of the question were +// resolved. +// - `THOUGHT_TYPE_DATA_SOURCING`: Which tables or datasets were identified as +// relevant. +// - `THOUGHT_TYPE_INSTRUCTIONS`: Which author-defined instructions were +// referenced. +// - `THOUGHT_TYPE_STEPS`: The logical steps taken to compute the answer. The +// category of a Thought. Additional values may be added in the future. type ThoughtType string // Which tables or datasets were identified as relevant. diff --git a/service/dataclassification/api.go b/service/dataclassification/api.go index f4e8dad5b..a57306b56 100755 --- a/service/dataclassification/api.go +++ b/service/dataclassification/api.go @@ -17,7 +17,9 @@ type DataClassificationInterface interface { // 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 config must not already exist for the catalog. CreateCatalogConfig(ctx context.Context, request CreateCatalogConfigRequest) (*CatalogConfig, error) // Delete Data Classification configuration for a catalog. @@ -26,9 +28,11 @@ type DataClassificationInterface interface { // Get the Data Classification configuration for a catalog. GetCatalogConfig(ctx context.Context, request GetCatalogConfigRequest) (*CatalogConfig, error) - // 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. + // - Updates fields specified in the update_mask. Use update_mask field to + // perform partial updates of the configuration. UpdateCatalogConfig(ctx context.Context, request UpdateCatalogConfigRequest) (*CatalogConfig, error) } diff --git a/service/dataclassification/interface.go b/service/dataclassification/interface.go index 877f83ef1..9410b5ecd 100755 --- a/service/dataclassification/interface.go +++ b/service/dataclassification/interface.go @@ -17,7 +17,9 @@ type DataClassificationService interface { // 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 config must not already exist for the catalog. CreateCatalogConfig(ctx context.Context, request CreateCatalogConfigRequest) (*CatalogConfig, error) // Delete Data Classification configuration for a catalog. @@ -26,9 +28,10 @@ type DataClassificationService interface { // Get the Data Classification configuration for a catalog. GetCatalogConfig(ctx context.Context, request GetCatalogConfigRequest) (*CatalogConfig, error) - // 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. + // - Updates fields specified in the update_mask. Use update_mask field to + // perform partial updates of the configuration. UpdateCatalogConfig(ctx context.Context, request UpdateCatalogConfigRequest) (*CatalogConfig, error) } diff --git a/service/dataclassification/model.go b/service/dataclassification/model.go index ae0794844..b0522ad00 100755 --- a/service/dataclassification/model.go +++ b/service/dataclassification/model.go @@ -60,9 +60,12 @@ func (f *AutoTaggingConfigAutoTaggingMode) Type() string { // Data Classification configuration for a Unity Catalog catalog. This message // follows the "At Most One Resource" pattern: at most one CatalogConfig exists -// per catalog. - Full CRUD operations are supported: Create enables Data -// Classification, Delete disables it - It has no unique identifier of its own -// and uses its parent catalog's identifier (catalog_name) +// per catalog. +// +// - Full CRUD operations are supported: Create enables Data Classification, +// Delete disables it +// - It has no unique identifier of its own and uses its parent catalog's +// identifier (catalog_name) type CatalogConfig struct { // List of auto-tagging configurations for this catalog. Empty list means no // auto-tagging is enabled. diff --git a/service/dataquality/api.go b/service/dataquality/api.go index 4f3f5675b..7efb6e7d1 100755 --- a/service/dataquality/api.go +++ b/service/dataquality/api.go @@ -17,12 +17,13 @@ type DataQualityInterface interface { // `table` `object_type`. The call must be made in the same workspace as where // the monitor was created. // - // The caller must have either of the following 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. + // The caller must have either of the following 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. CancelRefresh(ctx context.Context, request CancelRefreshRequest) (*CancelRefreshResponse, error) // Create a data quality monitor on a Unity Catalog object. The caller must @@ -30,31 +31,36 @@ type DataQualityInterface interface { // `data_profiling_config` for a table monitor. // // 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 - // catalog, **USE_SCHEMA** on the table's parent schema, and **SELECT** on the - // table 2. **USE_CATALOG** on the table's parent catalog, **MANAGE** and - // **USE_SCHEMA** on the table's parent schema, and **SELECT** on the table. 3. - // **USE_CATALOG** on the table's parent catalog, **USE_SCHEMA** on the table's - // parent schema, and **MANAGE** and **SELECT** on the table. + // sets of permissions: + // + // 1. **MANAGE** and **USE_CATALOG** on the table's parent catalog, + // **USE_SCHEMA** on the table's parent schema, and **SELECT** on the table + // 2. **USE_CATALOG** on the table's parent catalog, **MANAGE** and + // **USE_SCHEMA** on the table's parent schema, and **SELECT** on the table. + // 3. **USE_CATALOG** on the table's parent catalog, **USE_SCHEMA** on the + // table's parent schema, and **MANAGE** and **SELECT** on the table. // // Workspace assets, such as the dashboard, will be created in the workspace // where this call was made. // // For the `schema` `object_type`, the caller must have either of the following - // sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the schema's parent - // catalog. 2. **USE_CATALOG** on the schema's parent catalog, and **MANAGE** - // and **USE_SCHEMA** on the schema. + // sets of permissions: + // + // 1. **MANAGE** and **USE_CATALOG** on the schema's parent catalog. + // 2. **USE_CATALOG** on the schema's parent catalog, and **MANAGE** and + // **USE_SCHEMA** on the schema. CreateMonitor(ctx context.Context, request CreateMonitorRequest) (*Monitor, error) // Creates a refresh. Currently only supported for the `table` `object_type`. // The call must be made in the same workspace as where the monitor was created. // - // The caller must have either of the following 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. + // The caller must have either of the following 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. CreateRefresh(ctx context.Context, request CreateRefreshRequest) (*Refresh, error) // Delete a data quality monitor on Unity Catalog object. @@ -70,9 +76,11 @@ type DataQualityInterface interface { // call; those assets must be manually cleaned up (if desired). // // For the `schema` `object_type`, the caller must have either of the following - // sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the schema's parent - // catalog. 2. **USE_CATALOG** on the schema's parent catalog, and **MANAGE** - // and **USE_SCHEMA** on the schema. + // sets of permissions: + // + // 1. **MANAGE** and **USE_CATALOG** on the schema's parent catalog. + // 2. **USE_CATALOG** on the schema's parent catalog, and **MANAGE** and + // **USE_SCHEMA** on the schema. DeleteMonitor(ctx context.Context, request DeleteMonitorRequest) error // (Unimplemented) Delete a refresh @@ -81,16 +89,20 @@ type DataQualityInterface interface { // Read 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: 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 - // **SELECT** 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 **SELECT** on the table. // // For the `schema` `object_type`, the caller must have either of the following - // sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the schema's parent - // catalog. 2. **USE_CATALOG** on the schema's parent catalog, and - // **USE_SCHEMA** on the schema. + // sets of permissions: + // + // 1. **MANAGE** and **USE_CATALOG** on the schema's parent catalog. + // 2. **USE_CATALOG** on the schema's parent catalog, and **USE_SCHEMA** on the + // schema. // // The returned information includes configuration values on the entity and // parent entity as well as information on assets created by the monitor. Some @@ -102,16 +114,20 @@ type DataQualityInterface interface { // as where the monitor was created. // // 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 - // 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 - // **SELECT** 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 **SELECT** on the table. // // For the `schema` `object_type`, the caller must have either of the following - // sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the schema's parent - // catalog. 2. **USE_CATALOG** on the schema's parent catalog, and - // **USE_SCHEMA** on the schema. + // sets of permissions: + // + // 1. **MANAGE** and **USE_CATALOG** on the schema's parent catalog. + // 2. **USE_CATALOG** on the schema's parent catalog, and **USE_SCHEMA** on the + // schema. GetRefresh(ctx context.Context, request GetRefreshRequest) (*Refresh, error) // (Unimplemented) List data quality monitors. @@ -128,16 +144,20 @@ type DataQualityInterface interface { // workspace as where the monitor was created. // // 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 - // 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 - // **SELECT** 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 **SELECT** on the table. // // For the `schema` `object_type`, the caller must have either of the following - // sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the schema's parent - // catalog. 2. **USE_CATALOG** on the schema's parent catalog, and - // **USE_SCHEMA** on the schema. + // sets of permissions: + // + // 1. **MANAGE** and **USE_CATALOG** on the schema's parent catalog. + // 2. **USE_CATALOG** on the schema's parent catalog, and **USE_SCHEMA** on the + // schema. // // This method is generated by Databricks SDK Code Generator. ListRefresh(ctx context.Context, request ListRefreshRequest) listing.Iterator[Refresh] @@ -146,16 +166,20 @@ type DataQualityInterface interface { // workspace as where the monitor was created. // // 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 - // 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 - // **SELECT** 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 **SELECT** on the table. // // For the `schema` `object_type`, the caller must have either of the following - // sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the schema's parent - // catalog. 2. **USE_CATALOG** on the schema's parent catalog, and - // **USE_SCHEMA** on the schema. + // sets of permissions: + // + // 1. **MANAGE** and **USE_CATALOG** on the schema's parent catalog. + // 2. **USE_CATALOG** on the schema's parent catalog, and **USE_SCHEMA** on the + // schema. // // This method is generated by Databricks SDK Code Generator. ListRefreshAll(ctx context.Context, request ListRefreshRequest) ([]Refresh, error) @@ -163,16 +187,20 @@ type DataQualityInterface interface { // Update a data quality monitor on Unity Catalog object. // // 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 - // 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. + // 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. // // For the `schema` `object_type`, the caller must have either of the following - // sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the schema's parent - // catalog. 2. **USE_CATALOG** on the schema's parent catalog, and **MANAGE** - // and **USE_SCHEMA** on the schema. + // sets of permissions: + // + // 1. **MANAGE** and **USE_CATALOG** on the schema's parent catalog. + // 2. **USE_CATALOG** on the schema's parent catalog, and **MANAGE** and + // **USE_SCHEMA** on the schema. UpdateMonitor(ctx context.Context, request UpdateMonitorRequest) (*Monitor, error) // (Unimplemented) Update a refresh diff --git a/service/dataquality/impl.go b/service/dataquality/impl.go index 21c0335ac..e3617cd5d 100755 --- a/service/dataquality/impl.go +++ b/service/dataquality/impl.go @@ -165,16 +165,20 @@ func (a *dataQualityImpl) internalListMonitor(ctx context.Context, request ListM // workspace as where the monitor was created. // // 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 -// 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 -// **SELECT** 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 **SELECT** on the table. // // For the `schema` `object_type`, the caller must have either of the following -// sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the schema's parent -// catalog. 2. **USE_CATALOG** on the schema's parent catalog, and -// **USE_SCHEMA** on the schema. +// sets of permissions: +// +// 1. **MANAGE** and **USE_CATALOG** on the schema's parent catalog. +// 2. **USE_CATALOG** on the schema's parent catalog, and **USE_SCHEMA** on the +// schema. func (a *dataQualityImpl) ListRefresh(ctx context.Context, request ListRefreshRequest) listing.Iterator[Refresh] { getNextPage := func(ctx context.Context, req ListRefreshRequest) (*ListRefreshResponse, error) { @@ -203,16 +207,20 @@ func (a *dataQualityImpl) ListRefresh(ctx context.Context, request ListRefreshRe // workspace as where the monitor was created. // // 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 -// 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 -// **SELECT** 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 **SELECT** on the table. // // For the `schema` `object_type`, the caller must have either of the following -// sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the schema's parent -// catalog. 2. **USE_CATALOG** on the schema's parent catalog, and -// **USE_SCHEMA** on the schema. +// sets of permissions: +// +// 1. **MANAGE** and **USE_CATALOG** on the schema's parent catalog. +// 2. **USE_CATALOG** on the schema's parent catalog, and **USE_SCHEMA** on the +// schema. func (a *dataQualityImpl) ListRefreshAll(ctx context.Context, request ListRefreshRequest) ([]Refresh, error) { iterator := a.ListRefresh(ctx, request) return listing.ToSlice[Refresh](ctx, iterator) diff --git a/service/dataquality/interface.go b/service/dataquality/interface.go index 3167b4a83..6550c1223 100755 --- a/service/dataquality/interface.go +++ b/service/dataquality/interface.go @@ -16,12 +16,13 @@ type DataQualityService interface { // `table` `object_type`. The call must be made in the same workspace as // where the monitor was created. // - // The caller must have either of the following 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. + // The caller must have either of the following 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. CancelRefresh(ctx context.Context, request CancelRefreshRequest) (*CancelRefreshResponse, error) // Create a data quality monitor on a Unity Catalog object. The caller must @@ -29,33 +30,39 @@ type DataQualityService interface { // `data_profiling_config` for a table monitor. // // 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 catalog, **USE_SCHEMA** on the table's parent schema, and - // **SELECT** on the table 2. **USE_CATALOG** on the table's parent catalog, - // **MANAGE** and **USE_SCHEMA** on the table's parent schema, and - // **SELECT** on the table. 3. **USE_CATALOG** on the table's parent - // catalog, **USE_SCHEMA** on the table's parent schema, and **MANAGE** and - // **SELECT** on the table. + // following sets of permissions: + // + // 1. **MANAGE** and **USE_CATALOG** on the table's parent catalog, + // **USE_SCHEMA** on the table's parent schema, and **SELECT** on the + // table + // 2. **USE_CATALOG** on the table's parent catalog, **MANAGE** and + // **USE_SCHEMA** on the table's parent schema, and **SELECT** on the + // table. + // 3. **USE_CATALOG** on the table's parent catalog, **USE_SCHEMA** on the + // table's parent schema, and **MANAGE** and **SELECT** on the table. // // Workspace assets, such as the dashboard, will be created in the workspace // where this call was made. // // For the `schema` `object_type`, the caller must have either of the - // following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the - // schema's parent catalog. 2. **USE_CATALOG** on the schema's parent - // catalog, and **MANAGE** and **USE_SCHEMA** on the schema. + // following sets of permissions: + // + // 1. **MANAGE** and **USE_CATALOG** on the schema's parent catalog. + // 2. **USE_CATALOG** on the schema's parent catalog, and **MANAGE** and + // **USE_SCHEMA** on the schema. CreateMonitor(ctx context.Context, request CreateMonitorRequest) (*Monitor, error) // Creates a refresh. Currently only supported for the `table` // `object_type`. The call must be made in the same workspace as where the // monitor was created. // - // The caller must have either of the following 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. + // The caller must have either of the following 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. CreateRefresh(ctx context.Context, request CreateRefreshRequest) (*Refresh, error) // Delete a data quality monitor on Unity Catalog object. @@ -71,9 +78,11 @@ type DataQualityService interface { // this call; those assets must be manually cleaned up (if desired). // // For the `schema` `object_type`, the caller must have either of the - // following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the - // schema's parent catalog. 2. **USE_CATALOG** on the schema's parent - // catalog, and **MANAGE** and **USE_SCHEMA** on the schema. + // following sets of permissions: + // + // 1. **MANAGE** and **USE_CATALOG** on the schema's parent catalog. + // 2. **USE_CATALOG** on the schema's parent catalog, and **MANAGE** and + // **USE_SCHEMA** on the schema. DeleteMonitor(ctx context.Context, request DeleteMonitorRequest) error // (Unimplemented) Delete a refresh @@ -82,16 +91,20 @@ type DataQualityService interface { // Read 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: 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 **SELECT** on the table. + // following 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 **SELECT** on the table. // // For the `schema` `object_type`, the caller must have either of the - // following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the - // schema's parent catalog. 2. **USE_CATALOG** on the schema's parent - // catalog, and **USE_SCHEMA** on the schema. + // following sets of permissions: + // + // 1. **MANAGE** and **USE_CATALOG** on the schema's parent catalog. + // 2. **USE_CATALOG** on the schema's parent catalog, and **USE_SCHEMA** on + // the schema. // // The returned information includes configuration values on the entity and // parent entity as well as information on assets created by the monitor. @@ -103,16 +116,20 @@ type DataQualityService interface { // workspace as where the monitor was created. // // 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 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 **SELECT** on the table. + // following 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 **SELECT** on the table. // // For the `schema` `object_type`, the caller must have either of the - // following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the - // schema's parent catalog. 2. **USE_CATALOG** on the schema's parent - // catalog, and **USE_SCHEMA** on the schema. + // following sets of permissions: + // + // 1. **MANAGE** and **USE_CATALOG** on the schema's parent catalog. + // 2. **USE_CATALOG** on the schema's parent catalog, and **USE_SCHEMA** on + // the schema. GetRefresh(ctx context.Context, request GetRefreshRequest) (*Refresh, error) // (Unimplemented) List data quality monitors. @@ -122,31 +139,39 @@ type DataQualityService interface { // workspace as where the monitor was created. // // 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 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 **SELECT** on the table. + // following 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 **SELECT** on the table. // // For the `schema` `object_type`, the caller must have either of the - // following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the - // schema's parent catalog. 2. **USE_CATALOG** on the schema's parent - // catalog, and **USE_SCHEMA** on the schema. + // following sets of permissions: + // + // 1. **MANAGE** and **USE_CATALOG** on the schema's parent catalog. + // 2. **USE_CATALOG** on the schema's parent catalog, and **USE_SCHEMA** on + // the schema. ListRefresh(ctx context.Context, request ListRefreshRequest) (*ListRefreshResponse, error) // Update a data quality monitor on Unity Catalog object. // // 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 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. + // following 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. // // For the `schema` `object_type`, the caller must have either of the - // following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the - // schema's parent catalog. 2. **USE_CATALOG** on the schema's parent - // catalog, and **MANAGE** and **USE_SCHEMA** on the schema. + // following sets of permissions: + // + // 1. **MANAGE** and **USE_CATALOG** on the schema's parent catalog. + // 2. **USE_CATALOG** on the schema's parent catalog, and **MANAGE** and + // **USE_SCHEMA** on the schema. UpdateMonitor(ctx context.Context, request UpdateMonitorRequest) (*Monitor, error) // (Unimplemented) Update a refresh diff --git a/service/dataquality/model.go b/service/dataquality/model.go index 37bfb8442..0398fbabf 100644 --- a/service/dataquality/model.go +++ b/service/dataquality/model.go @@ -82,13 +82,17 @@ type CancelRefreshRequest struct { // The UUID of the request object. It is `schema_id` for `schema`, and // `table_id` for `table`. // - // Find the `schema_id` from either: 1. The [schema_id] of the `Schemas` - // resource. 2. In [Catalog Explorer] > select the `schema` > go to the - // `Details` tab > the `Schema ID` field. + // Find the `schema_id` from either: // - // Find the `table_id` from either: 1. The [table_id] of the `Tables` - // resource. 2. In [Catalog Explorer] > select the `table` > go to the - // `Details` tab > the `Table ID` field. + // 1. The [schema_id] of the `Schemas` resource. + // 2. In [Catalog Explorer] > select the `schema` > go to the `Details` tab + // > the `Schema ID` field. + // + // Find the `table_id` from either: + // + // 1. The [table_id] of the `Tables` resource. + // 2. In [Catalog Explorer] > select the `table` > go to the `Details` tab + // > the `Table ID` field. // // [Catalog Explorer]: https://docs.databricks.com/aws/en/catalog-explorer/ // [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id @@ -116,13 +120,17 @@ type CreateRefreshRequest struct { // The UUID of the request object. It is `schema_id` for `schema`, and // `table_id` for `table`. // - // Find the `schema_id` from either: 1. The [schema_id] of the `Schemas` - // resource. 2. In [Catalog Explorer] > select the `schema` > go to the - // `Details` tab > the `Schema ID` field. + // Find the `schema_id` from either: + // + // 1. The [schema_id] of the `Schemas` resource. + // 2. In [Catalog Explorer] > select the `schema` > go to the `Details` tab + // > the `Schema ID` field. // - // Find the `table_id` from either: 1. The [table_id] of the `Tables` - // resource. 2. In [Catalog Explorer] > select the `table` > go to the - // `Details` tab > the `Table ID` field. + // Find the `table_id` from either: + // + // 1. The [table_id] of the `Tables` resource. + // 2. In [Catalog Explorer] > select the `table` > go to the `Details` tab + // > the `Table ID` field. // // [Catalog Explorer]: https://docs.databricks.com/aws/en/catalog-explorer/ // [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id @@ -146,7 +154,7 @@ type CronSchedule struct { // 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 + // details. The timezone id (e.g., `America/Los_Angeles`) in which to // evaluate the quartz expression. TimezoneId string `json:"timezone_id"` } @@ -269,7 +277,7 @@ type DataProfilingCustomMetric struct { // [create metric definition]: https://docs.databricks.com/en/lakehouse-monitoring/custom-metrics.html#create-definition Definition string `json:"definition"` // 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 + // for. Can use `":table"` to indicate that the metric needs information // from multiple columns. InputColumns []string `json:"input_columns"` // Name of the metric in the output tables. @@ -372,13 +380,17 @@ type DeleteMonitorRequest struct { // The UUID of the request object. It is `schema_id` for `schema`, and // `table_id` for `table`. // - // Find the `schema_id` from either: 1. The [schema_id] of the `Schemas` - // resource. 2. In [Catalog Explorer] > select the `schema` > go to the - // `Details` tab > the `Schema ID` field. + // Find the `schema_id` from either: + // + // 1. The [schema_id] of the `Schemas` resource. + // 2. In [Catalog Explorer] > select the `schema` > go to the `Details` tab + // > the `Schema ID` field. + // + // Find the `table_id` from either: // - // Find the `table_id` from either: 1. The [table_id] of the `Tables` - // resource. 2. In [Catalog Explorer] > select the `table` > go to the - // `Details` tab > the `Table ID` field. + // 1. The [table_id] of the `Tables` resource. + // 2. In [Catalog Explorer] > select the `table` > go to the `Details` tab + // > the `Table ID` field. // // [Catalog Explorer]: https://docs.databricks.com/aws/en/catalog-explorer/ // [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id @@ -393,13 +405,17 @@ type DeleteRefreshRequest struct { // The UUID of the request object. It is `schema_id` for `schema`, and // `table_id` for `table`. // - // Find the `schema_id` from either: 1. The [schema_id] of the `Schemas` - // resource. 2. In [Catalog Explorer] > select the `schema` > go to the - // `Details` tab > the `Schema ID` field. + // Find the `schema_id` from either: // - // Find the `table_id` from either: 1. The [table_id] of the `Tables` - // resource. 2. In [Catalog Explorer] > select the `table` > go to the - // `Details` tab > the `Table ID` field. + // 1. The [schema_id] of the `Schemas` resource. + // 2. In [Catalog Explorer] > select the `schema` > go to the `Details` tab + // > the `Schema ID` field. + // + // Find the `table_id` from either: + // + // 1. The [table_id] of the `Tables` resource. + // 2. In [Catalog Explorer] > select the `table` > go to the `Details` tab + // > the `Table ID` field. // // [Catalog Explorer]: https://docs.databricks.com/aws/en/catalog-explorer/ // [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id @@ -416,13 +432,17 @@ type GetMonitorRequest struct { // The UUID of the request object. It is `schema_id` for `schema`, and // `table_id` for `table`. // - // Find the `schema_id` from either: 1. The [schema_id] of the `Schemas` - // resource. 2. In [Catalog Explorer] > select the `schema` > go to the - // `Details` tab > the `Schema ID` field. + // Find the `schema_id` from either: + // + // 1. The [schema_id] of the `Schemas` resource. + // 2. In [Catalog Explorer] > select the `schema` > go to the `Details` tab + // > the `Schema ID` field. // - // Find the `table_id` from either: 1. The [table_id] of the `Tables` - // resource. 2. In [Catalog Explorer] > select the `table` > go to the - // `Details` tab > the `Table ID` field. + // Find the `table_id` from either: + // + // 1. The [table_id] of the `Tables` resource. + // 2. In [Catalog Explorer] > select the `table` > go to the `Details` tab + // > the `Table ID` field. // // [Catalog Explorer]: https://docs.databricks.com/aws/en/catalog-explorer/ // [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id @@ -437,13 +457,17 @@ type GetRefreshRequest struct { // The UUID of the request object. It is `schema_id` for `schema`, and // `table_id` for `table`. // - // Find the `schema_id` from either: 1. The [schema_id] of the `Schemas` - // resource. 2. In [Catalog Explorer] > select the `schema` > go to the - // `Details` tab > the `Schema ID` field. + // Find the `schema_id` from either: + // + // 1. The [schema_id] of the `Schemas` resource. + // 2. In [Catalog Explorer] > select the `schema` > go to the `Details` tab + // > the `Schema ID` field. // - // Find the `table_id` from either: 1. The [table_id] of the `Tables` - // resource. 2. In [Catalog Explorer] > select the `table` > go to the - // `Details` tab > the `Table ID` field. + // Find the `table_id` from either: + // + // 1. The [table_id] of the `Tables` resource. + // 2. In [Catalog Explorer] > select the `table` > go to the `Details` tab + // > the `Table ID` field. // // [Catalog Explorer]: https://docs.databricks.com/aws/en/catalog-explorer/ // [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id @@ -558,13 +582,17 @@ type ListRefreshRequest struct { // The UUID of the request object. It is `schema_id` for `schema`, and // `table_id` for `table`. // - // Find the `schema_id` from either: 1. The [schema_id] of the `Schemas` - // resource. 2. In [Catalog Explorer] > select the `schema` > go to the - // `Details` tab > the `Schema ID` field. + // Find the `schema_id` from either: + // + // 1. The [schema_id] of the `Schemas` resource. + // 2. In [Catalog Explorer] > select the `schema` > go to the `Details` tab + // > the `Schema ID` field. + // + // Find the `table_id` from either: // - // Find the `table_id` from either: 1. The [table_id] of the `Tables` - // resource. 2. In [Catalog Explorer] > select the `table` > go to the - // `Details` tab > the `Table ID` field. + // 1. The [table_id] of the `Tables` resource. + // 2. In [Catalog Explorer] > select the `table` > go to the `Details` tab + // > the `Table ID` field. // // [Catalog Explorer]: https://docs.databricks.com/aws/en/catalog-explorer/ // [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id @@ -617,13 +645,17 @@ type Monitor struct { // The UUID of the request object. It is `schema_id` for `schema`, and // `table_id` for `table`. // - // Find the `schema_id` from either: 1. The [schema_id] of the `Schemas` - // resource. 2. In [Catalog Explorer] > select the `schema` > go to the - // `Details` tab > the `Schema ID` field. + // Find the `schema_id` from either: // - // Find the `table_id` from either: 1. The [table_id] of the `Tables` - // resource. 2. In [Catalog Explorer] > select the `table` > go to the - // `Details` tab > the `Table ID` field. + // 1. The [schema_id] of the `Schemas` resource. + // 2. In [Catalog Explorer] > select the `schema` > go to the `Details` tab + // > the `Schema ID` field. + // + // Find the `table_id` from either: + // + // 1. The [table_id] of the `Tables` resource. + // 2. In [Catalog Explorer] > select the `table` > go to the `Details` tab + // > the `Table ID` field. // // [Catalog Explorer]: https://docs.databricks.com/aws/en/catalog-explorer/ // [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id @@ -658,13 +690,17 @@ type Refresh struct { // The UUID of the request object. It is `schema_id` for `schema`, and // `table_id` for `table`. // - // Find the `schema_id` from either: 1. The [schema_id] of the `Schemas` - // resource. 2. In [Catalog Explorer] > select the `schema` > go to the - // `Details` tab > the `Schema ID` field. + // Find the `schema_id` from either: + // + // 1. The [schema_id] of the `Schemas` resource. + // 2. In [Catalog Explorer] > select the `schema` > go to the `Details` tab + // > the `Schema ID` field. // - // Find the `table_id` from either: 1. The [table_id] of the `Tables` - // resource. 2. In [Catalog Explorer] > select the `table` > go to the - // `Details` tab > the `Table ID` field. + // Find the `table_id` from either: + // + // 1. The [table_id] of the `Tables` resource. + // 2. In [Catalog Explorer] > select the `table` > go to the `Details` tab + // > the `Table ID` field. // // [Catalog Explorer]: https://docs.databricks.com/aws/en/catalog-explorer/ // [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id @@ -806,13 +842,17 @@ type UpdateMonitorRequest struct { // The UUID of the request object. It is `schema_id` for `schema`, and // `table_id` for `table`. // - // Find the `schema_id` from either: 1. The [schema_id] of the `Schemas` - // resource. 2. In [Catalog Explorer] > select the `schema` > go to the - // `Details` tab > the `Schema ID` field. + // Find the `schema_id` from either: + // + // 1. The [schema_id] of the `Schemas` resource. + // 2. In [Catalog Explorer] > select the `schema` > go to the `Details` tab + // > the `Schema ID` field. + // + // Find the `table_id` from either: // - // Find the `table_id` from either: 1. The [table_id] of the `Tables` - // resource. 2. In [Catalog Explorer] > select the `table` > go to the - // `Details` tab > the `Table ID` field. + // 1. The [table_id] of the `Tables` resource. + // 2. In [Catalog Explorer] > select the `table` > go to the `Details` tab + // > the `Table ID` field. // // [Catalog Explorer]: https://docs.databricks.com/aws/en/catalog-explorer/ // [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id @@ -831,13 +871,17 @@ type UpdateRefreshRequest struct { // The UUID of the request object. It is `schema_id` for `schema`, and // `table_id` for `table`. // - // Find the `schema_id` from either: 1. The [schema_id] of the `Schemas` - // resource. 2. In [Catalog Explorer] > select the `schema` > go to the - // `Details` tab > the `Schema ID` field. + // Find the `schema_id` from either: + // + // 1. The [schema_id] of the `Schemas` resource. + // 2. In [Catalog Explorer] > select the `schema` > go to the `Details` tab + // > the `Schema ID` field. + // + // Find the `table_id` from either: // - // Find the `table_id` from either: 1. The [table_id] of the `Tables` - // resource. 2. In [Catalog Explorer] > select the `table` > go to the - // `Details` tab > the `Table ID` field. + // 1. The [table_id] of the `Tables` resource. + // 2. In [Catalog Explorer] > select the `table` > go to the `Details` tab + // > the `Table ID` field. // // [Catalog Explorer]: https://docs.databricks.com/aws/en/catalog-explorer/ // [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id diff --git a/service/disasterrecovery/model.go b/service/disasterrecovery/model.go index 6078a0bb2..e29c638c7 100755 --- a/service/disasterrecovery/model.go +++ b/service/disasterrecovery/model.go @@ -252,11 +252,14 @@ type GetStableUrlRequest struct { } type ListFailoverGroupsRequest struct { - // Maximum number of failover groups to return per page: - when set to a - // value greater than 0, the page length is the minimum of this value and a - // server configured value; - when set to 0 or unset, the page length is set - // to a server configured value (recommended); - when set to a value less - // than 0, an invalid parameter error is returned. + // Maximum number of failover groups to return per page: + // + // - when set to a value greater than 0, the page length is the minimum of + // this value and a server configured value; + // - when set to 0 or unset, the page length is set to a server configured + // value (recommended); + // - when set to a value less than 0, an invalid parameter error is + // returned. PageSize int `json:"-" url:"page_size,omitempty"` // Page token received from a previous ListFailoverGroups call. Provide this // to retrieve the subsequent page. @@ -295,11 +298,14 @@ func (s ListFailoverGroupsResponse) MarshalJSON() ([]byte, error) { } type ListStableUrlsRequest struct { - // Maximum number of stable URLs to return per page: - when set to a value - // greater than 0, the page length is the minimum of this value and a server - // configured value; - when set to 0 or unset, the page length is set to a - // server configured value (recommended); - when set to a value less than 0, - // an invalid parameter error is returned. + // Maximum number of stable URLs to return per page: + // + // - when set to a value greater than 0, the page length is the minimum of + // this value and a server configured value; + // - when set to 0 or unset, the page length is set to a server configured + // value (recommended); + // - when set to a value less than 0, an invalid parameter error is + // returned. PageSize int `json:"-" url:"page_size,omitempty"` // Page token received from a previous ListStableUrls call. Provide this to // retrieve the subsequent page. diff --git a/service/environments/api.go b/service/environments/api.go index f002c2d5c..a59c62901 100755 --- a/service/environments/api.go +++ b/service/environments/api.go @@ -44,11 +44,10 @@ type EnvironmentsInterface interface { // // Databricks provides the following base environments: // - // - `workspace-base-environments/databricks_ai_...`: includes popular AI and - // deep learning packages for serverless GPU compute. - // - // - `workspace-base-environments/databricks_ml_...`: includes popular ML - // packages for serverless compute. + // - `workspace-base-environments/databricks_ai_...`: includes popular AI and + // deep learning packages for serverless GPU compute. + // - `workspace-base-environments/databricks_ml_...`: includes popular ML + // packages for serverless compute. // // Databricks-provided base environments are versioned. For example, // `workspace-base-environments/databricks_ml_v5` corresponds to the ML @@ -61,11 +60,10 @@ type EnvironmentsInterface interface { // // Databricks provides the following base environments: // - // - `workspace-base-environments/databricks_ai_...`: includes popular AI and - // deep learning packages for serverless GPU compute. - // - // - `workspace-base-environments/databricks_ml_...`: includes popular ML - // packages for serverless compute. + // - `workspace-base-environments/databricks_ai_...`: includes popular AI and + // deep learning packages for serverless GPU compute. + // - `workspace-base-environments/databricks_ml_...`: includes popular ML + // packages for serverless compute. // // Databricks-provided base environments are versioned. For example, // `workspace-base-environments/databricks_ml_v5` corresponds to the ML diff --git a/service/environments/impl.go b/service/environments/impl.go index 284cfcd51..2f63565c5 100755 --- a/service/environments/impl.go +++ b/service/environments/impl.go @@ -106,11 +106,10 @@ func (a *environmentsImpl) GetWorkspaceBaseEnvironment(ctx context.Context, requ // // Databricks provides the following base environments: // -// - `workspace-base-environments/databricks_ai_...`: includes popular AI and -// deep learning packages for serverless GPU compute. -// -// - `workspace-base-environments/databricks_ml_...`: includes popular ML -// packages for serverless compute. +// - `workspace-base-environments/databricks_ai_...`: includes popular AI and +// deep learning packages for serverless GPU compute. +// - `workspace-base-environments/databricks_ml_...`: includes popular ML +// packages for serverless compute. // // Databricks-provided base environments are versioned. For example, // `workspace-base-environments/databricks_ml_v5` corresponds to the ML @@ -143,11 +142,10 @@ func (a *environmentsImpl) ListWorkspaceBaseEnvironments(ctx context.Context, re // // Databricks provides the following base environments: // -// - `workspace-base-environments/databricks_ai_...`: includes popular AI and -// deep learning packages for serverless GPU compute. -// -// - `workspace-base-environments/databricks_ml_...`: includes popular ML -// packages for serverless compute. +// - `workspace-base-environments/databricks_ai_...`: includes popular AI and +// deep learning packages for serverless GPU compute. +// - `workspace-base-environments/databricks_ml_...`: includes popular ML +// packages for serverless compute. // // Databricks-provided base environments are versioned. For example, // `workspace-base-environments/databricks_ml_v5` corresponds to the ML diff --git a/service/environments/interface.go b/service/environments/interface.go index 81b36036e..d1c7f2232 100755 --- a/service/environments/interface.go +++ b/service/environments/interface.go @@ -44,11 +44,10 @@ type EnvironmentsService interface { // // Databricks provides the following base environments: // - // - `workspace-base-environments/databricks_ai_...`: includes popular AI - // and deep learning packages for serverless GPU compute. - // - // - `workspace-base-environments/databricks_ml_...`: includes popular ML - // packages for serverless compute. + // - `workspace-base-environments/databricks_ai_...`: includes popular AI + // and deep learning packages for serverless GPU compute. + // - `workspace-base-environments/databricks_ml_...`: includes popular ML + // packages for serverless compute. // // Databricks-provided base environments are versioned. For example, // `workspace-base-environments/databricks_ml_v5` corresponds to the ML diff --git a/service/files/api.go b/service/files/api.go index 432828c39..e0b9605e2 100755 --- a/service/files/api.go +++ b/service/files/api.go @@ -15,30 +15,30 @@ type DbfsInterface interface { // Appends a block of data to the stream specified by the input handle. If the // handle does not exist, this call will throw an exception with - // ``RESOURCE_DOES_NOT_EXIST``. + // `RESOURCE_DOES_NOT_EXIST`. // // If the block of data exceeds 1 MB, this call will throw an exception with - // ``MAX_BLOCK_SIZE_EXCEEDED``. + // `MAX_BLOCK_SIZE_EXCEEDED`. AddBlock(ctx context.Context, request AddBlock) error // Closes the stream specified by the input handle. If the handle does not - // exist, this call throws an exception with ``RESOURCE_DOES_NOT_EXIST``. + // exist, this call throws an exception with `RESOURCE_DOES_NOT_EXIST`. Close(ctx context.Context, request Close) error // Closes the stream specified by the input handle. If the handle does not - // exist, this call throws an exception with ``RESOURCE_DOES_NOT_EXIST``. + // exist, this call throws an exception with `RESOURCE_DOES_NOT_EXIST`. CloseByHandle(ctx context.Context, handle int64) error // Opens a stream to write to a file and returns a handle to this stream. There // is a 10 minute idle timeout on this handle. If a file or directory already - // exists on the given path and __overwrite__ is set to false, this call will - // throw an exception with ``RESOURCE_ALREADY_EXISTS``. + // exists on the given path and **overwrite** is set to false, this call will + // throw an exception with `RESOURCE_ALREADY_EXISTS`. // // A typical workflow for file upload would be: // - // 1. Issue a ``create`` call and get a handle. 2. Issue one or more - // ``add-block`` calls with the handle you have. 3. Issue a ``close`` call with - // the handle you have. + // 1. Issue a `create` call and get a handle. + // 2. Issue one or more `add-block` calls with the handle you have. + // 3. Issue a `close` call with the handle you have. Create(ctx context.Context, request Create) (*CreateResponse, error) // Delete the file or directory (optionally recursively delete all files in the @@ -53,12 +53,10 @@ type DbfsInterface interface { // // For operations that delete more than 10K files, we discourage using the DBFS // REST API, but advise you to perform such operations in the context of a - // cluster, using the [File system utility - // (dbutils.fs)](/dev-tools/databricks-utils.html#dbutils-fs). `dbutils.fs` - // covers the functional scope of the DBFS REST API, but from notebooks. Running - // such operations using notebooks provides better control and manageability, - // such as selective deletes, and the possibility to automate periodic delete - // jobs. + // cluster, using the File system utility (dbutils.fs). `dbutils.fs` covers the + // functional scope of the DBFS REST API, but from notebooks. Running such + // operations using notebooks provides better control and manageability, such as + // selective deletes, and the possibility to automate periodic delete jobs. Delete(ctx context.Context, request Delete) error // Gets the file information for a file or directory. If the file or directory @@ -77,9 +75,9 @@ type DbfsInterface interface { // after approximately 60 seconds. We strongly recommend using list only on // directories containing less than 10K files and discourage using the DBFS REST // API for operations that list more than 10K files. Instead, we recommend that - // you perform such operations in the context of a cluster, using the [File - // system utility (dbutils.fs)](/dev-tools/databricks-utils.html#dbutils-fs), - // which provides the same functionality without timing out. + // you perform such operations in the context of a cluster, using the File + // system utility (dbutils.fs), which provides the same functionality without + // timing out. // // This method is generated by Databricks SDK Code Generator. List(ctx context.Context, request ListDbfsRequest) listing.Iterator[FileInfo] @@ -92,9 +90,9 @@ type DbfsInterface interface { // after approximately 60 seconds. We strongly recommend using list only on // directories containing less than 10K files and discourage using the DBFS REST // API for operations that list more than 10K files. Instead, we recommend that - // you perform such operations in the context of a cluster, using the [File - // system utility (dbutils.fs)](/dev-tools/databricks-utils.html#dbutils-fs), - // which provides the same functionality without timing out. + // you perform such operations in the context of a cluster, using the File + // system utility (dbutils.fs), which provides the same functionality without + // timing out. // // This method is generated by Databricks SDK Code Generator. ListAll(ctx context.Context, request ListDbfsRequest) ([]FileInfo, error) @@ -107,9 +105,9 @@ type DbfsInterface interface { // after approximately 60 seconds. We strongly recommend using list only on // directories containing less than 10K files and discourage using the DBFS REST // API for operations that list more than 10K files. Instead, we recommend that - // you perform such operations in the context of a cluster, using the [File - // system utility (dbutils.fs)](/dev-tools/databricks-utils.html#dbutils-fs), - // which provides the same functionality without timing out. + // you perform such operations in the context of a cluster, using the File + // system utility (dbutils.fs), which provides the same functionality without + // timing out. ListByPath(ctx context.Context, path string) (*ListStatusResponse, error) // Creates the given directory and necessary parent directories if they do not @@ -140,7 +138,7 @@ type DbfsInterface interface { // Alternatively you can pass contents as base64 string. // // The amount of data that can be passed (when not streaming) using the - // __contents__ parameter is limited to 1 MB. `MAX_BLOCK_SIZE_EXCEEDED` will be + // **contents** parameter is limited to 1 MB. `MAX_BLOCK_SIZE_EXCEEDED` will be // thrown if this limit is exceeded. // // If you want to upload large files, use the streaming upload. For details, see @@ -173,7 +171,7 @@ type DbfsAPI struct { } // Closes the stream specified by the input handle. If the handle does not -// exist, this call throws an exception with “RESOURCE_DOES_NOT_EXIST“. +// exist, this call throws an exception with `RESOURCE_DOES_NOT_EXIST`. func (a *DbfsAPI) CloseByHandle(ctx context.Context, handle int64) error { return a.dbfsImpl.Close(ctx, Close{ Handle: handle, @@ -196,9 +194,9 @@ func (a *DbfsAPI) GetStatusByPath(ctx context.Context, path string) (*FileInfo, // after approximately 60 seconds. We strongly recommend using list only on // directories containing less than 10K files and discourage using the DBFS REST // API for operations that list more than 10K files. Instead, we recommend that -// you perform such operations in the context of a cluster, using the [File -// system utility (dbutils.fs)](/dev-tools/databricks-utils.html#dbutils-fs), -// which provides the same functionality without timing out. +// you perform such operations in the context of a cluster, using the File +// system utility (dbutils.fs), which provides the same functionality without +// timing out. func (a *DbfsAPI) ListByPath(ctx context.Context, path string) (*ListStatusResponse, error) { return a.dbfsImpl.internalList(ctx, ListDbfsRequest{ Path: path, diff --git a/service/files/impl.go b/service/files/impl.go index d413a2430..a95f9cf04 100755 --- a/service/files/impl.go +++ b/service/files/impl.go @@ -98,9 +98,9 @@ func (a *dbfsImpl) GetStatus(ctx context.Context, request GetStatusRequest) (*Fi // after approximately 60 seconds. We strongly recommend using list only on // directories containing less than 10K files and discourage using the DBFS REST // API for operations that list more than 10K files. Instead, we recommend that -// you perform such operations in the context of a cluster, using the [File -// system utility (dbutils.fs)](/dev-tools/databricks-utils.html#dbutils-fs), -// which provides the same functionality without timing out. +// you perform such operations in the context of a cluster, using the File +// system utility (dbutils.fs), which provides the same functionality without +// timing out. func (a *dbfsImpl) List(ctx context.Context, request ListDbfsRequest) listing.Iterator[FileInfo] { getNextPage := func(ctx context.Context, req ListDbfsRequest) (*ListStatusResponse, error) { @@ -127,9 +127,9 @@ func (a *dbfsImpl) List(ctx context.Context, request ListDbfsRequest) listing.It // after approximately 60 seconds. We strongly recommend using list only on // directories containing less than 10K files and discourage using the DBFS REST // API for operations that list more than 10K files. Instead, we recommend that -// you perform such operations in the context of a cluster, using the [File -// system utility (dbutils.fs)](/dev-tools/databricks-utils.html#dbutils-fs), -// which provides the same functionality without timing out. +// you perform such operations in the context of a cluster, using the File +// system utility (dbutils.fs), which provides the same functionality without +// timing out. func (a *dbfsImpl) ListAll(ctx context.Context, request ListDbfsRequest) ([]FileInfo, error) { iterator := a.List(ctx, request) return listing.ToSlice[FileInfo](ctx, iterator) diff --git a/service/files/interface.go b/service/files/interface.go index b9ab2cac3..d17f84cd8 100755 --- a/service/files/interface.go +++ b/service/files/interface.go @@ -14,26 +14,26 @@ type DbfsService interface { // Appends a block of data to the stream specified by the input handle. If // the handle does not exist, this call will throw an exception with - // ``RESOURCE_DOES_NOT_EXIST``. + // `RESOURCE_DOES_NOT_EXIST`. // // If the block of data exceeds 1 MB, this call will throw an exception with - // ``MAX_BLOCK_SIZE_EXCEEDED``. + // `MAX_BLOCK_SIZE_EXCEEDED`. AddBlock(ctx context.Context, request AddBlock) error // Closes the stream specified by the input handle. If the handle does not - // exist, this call throws an exception with ``RESOURCE_DOES_NOT_EXIST``. + // exist, this call throws an exception with `RESOURCE_DOES_NOT_EXIST`. Close(ctx context.Context, request Close) error // Opens a stream to write to a file and returns a handle to this stream. // There is a 10 minute idle timeout on this handle. If a file or directory - // already exists on the given path and __overwrite__ is set to false, this - // call will throw an exception with ``RESOURCE_ALREADY_EXISTS``. + // already exists on the given path and **overwrite** is set to false, this + // call will throw an exception with `RESOURCE_ALREADY_EXISTS`. // // A typical workflow for file upload would be: // - // 1. Issue a ``create`` call and get a handle. 2. Issue one or more - // ``add-block`` calls with the handle you have. 3. Issue a ``close`` call - // with the handle you have. + // 1. Issue a `create` call and get a handle. + // 2. Issue one or more `add-block` calls with the handle you have. + // 3. Issue a `close` call with the handle you have. Create(ctx context.Context, request Create) (*CreateResponse, error) // Delete the file or directory (optionally recursively delete all files in @@ -48,8 +48,7 @@ type DbfsService interface { // // For operations that delete more than 10K files, we discourage using the // DBFS REST API, but advise you to perform such operations in the context - // of a cluster, using the [File system utility - // (dbutils.fs)](/dev-tools/databricks-utils.html#dbutils-fs). `dbutils.fs` + // of a cluster, using the File system utility (dbutils.fs). `dbutils.fs` // covers the functional scope of the DBFS REST API, but from notebooks. // Running such operations using notebooks provides better control and // manageability, such as selective deletes, and the possibility to automate @@ -70,9 +69,8 @@ type DbfsService interface { // directories containing less than 10K files and discourage using the DBFS // REST API for operations that list more than 10K files. Instead, we // recommend that you perform such operations in the context of a cluster, - // using the [File system utility - // (dbutils.fs)](/dev-tools/databricks-utils.html#dbutils-fs), which - // provides the same functionality without timing out. + // using the File system utility (dbutils.fs), which provides the same + // functionality without timing out. List(ctx context.Context, request ListDbfsRequest) (*ListStatusResponse, error) // Creates the given directory and necessary parent directories if they do @@ -97,7 +95,7 @@ type DbfsService interface { // Alternatively you can pass contents as base64 string. // // The amount of data that can be passed (when not streaming) using the - // __contents__ parameter is limited to 1 MB. `MAX_BLOCK_SIZE_EXCEEDED` will + // **contents** parameter is limited to 1 MB. `MAX_BLOCK_SIZE_EXCEEDED` will // be thrown if this limit is exceeded. // // If you want to upload large files, use the streaming upload. For details, diff --git a/service/files/model.go b/service/files/model.go index 351201244..11686a648 100755 --- a/service/files/model.go +++ b/service/files/model.go @@ -312,7 +312,7 @@ func (s ReadDbfsRequest) MarshalJSON() ([]byte, error) { } type ReadResponse struct { - // The number of bytes read (could be less than ``length`` if we hit end of + // The number of bytes read (could be less than `length` if we hit end of // file). This refers to number of bytes read in unencoded version (response // data is base64-encoded). BytesRead int64 `json:"bytes_read,omitempty"` diff --git a/service/iam/api.go b/service/iam/api.go index ea2f89799..22056c2e9 100755 --- a/service/iam/api.go +++ b/service/iam/api.go @@ -379,34 +379,36 @@ func NewPermissions(client *client.DatabricksClient) *PermissionsAPI { } // Permissions API are used to create read, write, edit, update and manage -// access for various users on different objects and endpoints. * **[Apps -// permissions](:service:apps)** — Manage which users can manage or use apps. -// * **[Cluster permissions](:service:clusters)** — Manage which users can -// manage, restart, or attach to clusters. * **[Cluster policy -// permissions](:service:clusterpolicies)** — Manage which users can use -// cluster policies. * **[Spark Declarative Pipelines -// permissions](:service:pipelines)** — Manage which users can view, manage, -// run, cancel, or own a Spark Declarative Pipeline. * **[Job -// permissions](:service:jobs)** — Manage which users can view, manage, -// trigger, cancel, or own a job. * **[MLflow experiment -// permissions](:service:experiments)** — Manage which users can read, edit, -// or manage MLflow experiments. * **[MLflow registered model -// permissions](:service:modelregistry)** — Manage which users can read, edit, -// or manage MLflow registered models. * **[Instance Pool -// permissions](:service:instancepools)** — Manage which users can manage or -// attach to pools. * **[Repo permissions](repos)** — Manage which users can -// read, run, edit, or manage a repo. * **[Serving endpoint -// permissions](:service:servingendpoints)** — Manage which users can view, -// query, or manage a serving endpoint. * **[SQL warehouse -// permissions](:service:warehouses)** — Manage which users can use or manage -// SQL warehouses. * **[Token permissions](:service:tokenmanagement)** — -// Manage which users can create or use tokens. * **[Workspace object -// permissions](:service:workspace)** — Manage which users can read, run, -// edit, or manage alerts, dbsql-dashboards, directories, files, notebooks and -// queries. For the mapping of the required permissions for specific actions or -// abilities and other important information, see [Access Control]. Note that to -// manage access control on service principals, use **[Account Access Control -// Proxy](:service:accountaccesscontrolproxy)**. +// access for various users on different objects and endpoints. +// +// - **Apps permissions** — Manage which users can manage or use apps. +// - **Cluster permissions** — Manage which users can manage, restart, or +// attach to clusters. +// - **Cluster policy permissions** — Manage which users can use cluster +// policies. +// - **Spark Declarative Pipelines permissions** — Manage which users can +// view, manage, run, cancel, or own a Spark Declarative Pipeline. +// - **Job permissions** — Manage which users can view, manage, trigger, +// cancel, or own a job. +// - **MLflow experiment permissions** — Manage which users can read, edit, +// or manage MLflow experiments. +// - **MLflow registered model permissions** — Manage which users can read, +// edit, or manage MLflow registered models. +// - **Instance Pool permissions** — Manage which users can manage or attach +// to pools. +// - **Repo permissions** — Manage which users can read, run, edit, or +// manage a repo. +// - **Serving endpoint permissions** — Manage which users can view, query, +// or manage a serving endpoint. +// - **SQL warehouse permissions** — Manage which users can use or manage +// SQL warehouses. +// - **Token permissions** — Manage which users can create or use tokens. +// - **Workspace object permissions** — Manage which users can read, run, +// edit, or manage alerts, dbsql-dashboards, directories, files, notebooks +// and queries. For the mapping of the required permissions for specific +// actions or abilities and other important information, see [Access +// Control]. Note that to manage access control on service principals, use +// **Account Access Control Proxy**. // // [Access Control]: https://docs.databricks.com/security/auth-authz/access-control/index.html type PermissionsAPI struct { diff --git a/service/iam/interface.go b/service/iam/interface.go index 5673c2a4e..9d612a3c0 100755 --- a/service/iam/interface.go +++ b/service/iam/interface.go @@ -219,34 +219,36 @@ type PermissionMigrationService interface { } // Permissions API are used to create read, write, edit, update and manage -// access for various users on different objects and endpoints. * **[Apps -// permissions](:service:apps)** — Manage which users can manage or use apps. -// * **[Cluster permissions](:service:clusters)** — Manage which users can -// manage, restart, or attach to clusters. * **[Cluster policy -// permissions](:service:clusterpolicies)** — Manage which users can use -// cluster policies. * **[Spark Declarative Pipelines -// permissions](:service:pipelines)** — Manage which users can view, manage, -// run, cancel, or own a Spark Declarative Pipeline. * **[Job -// permissions](:service:jobs)** — Manage which users can view, manage, -// trigger, cancel, or own a job. * **[MLflow experiment -// permissions](:service:experiments)** — Manage which users can read, edit, -// or manage MLflow experiments. * **[MLflow registered model -// permissions](:service:modelregistry)** — Manage which users can read, edit, -// or manage MLflow registered models. * **[Instance Pool -// permissions](:service:instancepools)** — Manage which users can manage or -// attach to pools. * **[Repo permissions](repos)** — Manage which users can -// read, run, edit, or manage a repo. * **[Serving endpoint -// permissions](:service:servingendpoints)** — Manage which users can view, -// query, or manage a serving endpoint. * **[SQL warehouse -// permissions](:service:warehouses)** — Manage which users can use or manage -// SQL warehouses. * **[Token permissions](:service:tokenmanagement)** — -// Manage which users can create or use tokens. * **[Workspace object -// permissions](:service:workspace)** — Manage which users can read, run, -// edit, or manage alerts, dbsql-dashboards, directories, files, notebooks and -// queries. For the mapping of the required permissions for specific actions or -// abilities and other important information, see [Access Control]. Note that to -// manage access control on service principals, use **[Account Access Control -// Proxy](:service:accountaccesscontrolproxy)**. +// access for various users on different objects and endpoints. +// +// - **Apps permissions** — Manage which users can manage or use apps. +// - **Cluster permissions** — Manage which users can manage, restart, or +// attach to clusters. +// - **Cluster policy permissions** — Manage which users can use cluster +// policies. +// - **Spark Declarative Pipelines permissions** — Manage which users can +// view, manage, run, cancel, or own a Spark Declarative Pipeline. +// - **Job permissions** — Manage which users can view, manage, trigger, +// cancel, or own a job. +// - **MLflow experiment permissions** — Manage which users can read, edit, +// or manage MLflow experiments. +// - **MLflow registered model permissions** — Manage which users can read, +// edit, or manage MLflow registered models. +// - **Instance Pool permissions** — Manage which users can manage or attach +// to pools. +// - **Repo permissions** — Manage which users can read, run, edit, or +// manage a repo. +// - **Serving endpoint permissions** — Manage which users can view, query, +// or manage a serving endpoint. +// - **SQL warehouse permissions** — Manage which users can use or manage +// SQL warehouses. +// - **Token permissions** — Manage which users can create or use tokens. +// - **Workspace object permissions** — Manage which users can read, run, +// edit, or manage alerts, dbsql-dashboards, directories, files, notebooks +// and queries. For the mapping of the required permissions for specific +// actions or abilities and other important information, see [Access +// Control]. Note that to manage access control on service principals, use +// **Account Access Control Proxy**. // // Deprecated: Do not use this interface, it will be removed in a future version of the SDK. // diff --git a/service/iam/model.go b/service/iam/model.go index ed6c257f1..0ea453e1a 100755 --- a/service/iam/model.go +++ b/service/iam/model.go @@ -719,9 +719,11 @@ type GetWorkspaceAssignmentRequest struct { type GrantRule struct { // Principals this grant rule applies to. A principal can be a user (for end // users), a service principal (for applications and compute workloads), or - // an account group. Each principal has its own identifier format: * - // users/ * groups/ * - // servicePrincipals/ + // an account group. Each principal has its own identifier format: + // + // - users/ + // - groups/ + // - servicePrincipals/ Principals []string `json:"principals,omitempty"` // Role that is assigned to the list of principals. Role string `json:"role"` diff --git a/service/iamv2/api.go b/service/iamv2/api.go index cd1defeb4..c6d465a90 100755 --- a/service/iamv2/api.go +++ b/service/iamv2/api.go @@ -27,10 +27,12 @@ type AccountIamV2Interface interface { // Returns the access details for a principal in a workspace. Allows for // checking access details for any provisioned principal (user, service - // principal, or group) in a workspace. * Provisioned principal here refers to - // one that has been synced into Databricks from the customer's IdP or added - // explicitly to Databricks via SCIM/UI. Allows for passing in a "view" - // parameter to control what fields are returned (BASIC by default or FULL). + // principal, or group) in a workspace. + // + // - Provisioned principal here refers to one that has been synced into + // Databricks from the customer's IdP or added explicitly to Databricks via + // SCIM/UI. Allows for passing in a "view" parameter to control what fields + // are returned (BASIC by default or FULL). GetWorkspaceAccessDetail(ctx context.Context, request GetWorkspaceAccessDetailRequest) (*WorkspaceAccessDetail, error) // Returns the assignment details for a principal in a workspace. @@ -96,10 +98,12 @@ type WorkspaceIamV2Interface interface { // Returns the access details for a principal in the current workspace. Allows // for checking access details for any provisioned principal (user, service - // principal, or group) in the current workspace. * Provisioned principal here - // refers to one that has been synced into Databricks from the customer's IdP or - // added explicitly to Databricks via SCIM/UI. Allows for passing in a "view" - // parameter to control what fields are returned (BASIC by default or FULL). + // principal, or group) in the current workspace. + // + // - Provisioned principal here refers to one that has been synced into + // Databricks from the customer's IdP or added explicitly to Databricks via + // SCIM/UI. Allows for passing in a "view" parameter to control what fields + // are returned (BASIC by default or FULL). GetWorkspaceAccessDetailLocal(ctx context.Context, request GetWorkspaceAccessDetailLocalRequest) (*WorkspaceAccessDetail, error) // Returns the assignment details for a principal in a workspace diff --git a/service/iamv2/interface.go b/service/iamv2/interface.go index fd152b5ea..1949ec5bf 100755 --- a/service/iamv2/interface.go +++ b/service/iamv2/interface.go @@ -29,11 +29,12 @@ type AccountIamV2Service interface { // Returns the access details for a principal in a workspace. Allows for // checking access details for any provisioned principal (user, service - // principal, or group) in a workspace. * Provisioned principal here refers - // to one that has been synced into Databricks from the customer's IdP or - // added explicitly to Databricks via SCIM/UI. Allows for passing in a - // "view" parameter to control what fields are returned (BASIC by default or - // FULL). + // principal, or group) in a workspace. + // + // - Provisioned principal here refers to one that has been synced into + // Databricks from the customer's IdP or added explicitly to Databricks + // via SCIM/UI. Allows for passing in a "view" parameter to control what + // fields are returned (BASIC by default or FULL). GetWorkspaceAccessDetail(ctx context.Context, request GetWorkspaceAccessDetailRequest) (*WorkspaceAccessDetail, error) // Returns the assignment details for a principal in a workspace. @@ -90,11 +91,12 @@ type WorkspaceIamV2Service interface { // Returns the access details for a principal in the current workspace. // Allows for checking access details for any provisioned principal (user, - // service principal, or group) in the current workspace. * Provisioned - // principal here refers to one that has been synced into Databricks from - // the customer's IdP or added explicitly to Databricks via SCIM/UI. Allows - // for passing in a "view" parameter to control what fields are returned - // (BASIC by default or FULL). + // service principal, or group) in the current workspace. + // + // - Provisioned principal here refers to one that has been synced into + // Databricks from the customer's IdP or added explicitly to Databricks + // via SCIM/UI. Allows for passing in a "view" parameter to control what + // fields are returned (BASIC by default or FULL). GetWorkspaceAccessDetailLocal(ctx context.Context, request GetWorkspaceAccessDetailLocalRequest) (*WorkspaceAccessDetail, error) // Returns the assignment details for a principal in a workspace diff --git a/service/jobs/api.go b/service/jobs/api.go index 3756edce9..00e78a6cc 100644 --- a/service/jobs/api.go +++ b/service/jobs/api.go @@ -116,8 +116,8 @@ type JobsInterface interface { // the first 5 MB of the output. To return a larger result, you can store job // results in a cloud storage service. // - // This endpoint validates that the __run_id__ parameter is valid and returns an - // HTTP status code 400 if the __run_id__ parameter is invalid. Runs are + // This endpoint validates that the **run_id** parameter is valid and returns an + // HTTP status code 400 if the **run_id** parameter is invalid. Runs are // automatically removed after 60 days. If you to want to reference them beyond // 60 days, you must save old run results before they expire. GetRunOutput(ctx context.Context, request GetRunOutputRequest) (*RunOutput, error) @@ -128,8 +128,8 @@ type JobsInterface interface { // the first 5 MB of the output. To return a larger result, you can store job // results in a cloud storage service. // - // This endpoint validates that the __run_id__ parameter is valid and returns an - // HTTP status code 400 if the __run_id__ parameter is invalid. Runs are + // This endpoint validates that the **run_id** parameter is valid and returns an + // HTTP status code 400 if the **run_id** parameter is invalid. Runs are // automatically removed after 60 days. If you to want to reference them beyond // 60 days, you must save old run results before they expire. GetRunOutputByRunId(ctx context.Context, runId int64) (*RunOutput, error) @@ -185,8 +185,8 @@ type JobsInterface interface { // Deprecated: use [JobsAPIInterface.RepairRun].Get() or [JobsAPIInterface.WaitGetRunJobTerminatedOrSkipped] RepairRunAndWait(ctx context.Context, repairRun RepairRun, options ...retries.Option[Run]) (*Run, error) - // Overwrite all settings for the given job. Use the [_Update_ - // endpoint](:method:jobs/update) to update job settings partially. + // Overwrite all settings for the given job. Use the *Update* endpoint to update + // job settings partially. Reset(ctx context.Context, request ResetJob) error // Run a job and return the `run_id` of the triggered run. @@ -227,8 +227,8 @@ type JobsInterface interface { // Deprecated: use [JobsAPIInterface.Submit].Get() or [JobsAPIInterface.WaitGetRunJobTerminatedOrSkipped] SubmitAndWait(ctx context.Context, submitRun SubmitRun, options ...retries.Option[Run]) (*Run, error) - // Add, update, or remove specific settings of an existing job. Use the [_Reset_ - // endpoint](:method:jobs/reset) to overwrite all job settings. + // Add, update, or remove specific settings of an existing job. Use the *Reset* + // endpoint to overwrite all job settings. Update(ctx context.Context, request UpdateJob) error // Updates the permissions on a job. Jobs can inherit permissions from their @@ -433,8 +433,8 @@ func (a *JobsAPI) GetPermissionsByJobId(ctx context.Context, jobId string) (*Job // the first 5 MB of the output. To return a larger result, you can store job // results in a cloud storage service. // -// This endpoint validates that the __run_id__ parameter is valid and returns an -// HTTP status code 400 if the __run_id__ parameter is invalid. Runs are +// This endpoint validates that the **run_id** parameter is valid and returns an +// HTTP status code 400 if the **run_id** parameter is invalid. Runs are // automatically removed after 60 days. If you to want to reference them beyond // 60 days, you must save old run results before they expire. func (a *JobsAPI) GetRunOutputByRunId(ctx context.Context, runId int64) (*RunOutput, error) { diff --git a/service/jobs/interface.go b/service/jobs/interface.go index 3bf8fff7e..51b6f4364 100644 --- a/service/jobs/interface.go +++ b/service/jobs/interface.go @@ -85,8 +85,8 @@ type JobsService interface { // to returning the first 5 MB of the output. To return a larger result, you // can store job results in a cloud storage service. // - // This endpoint validates that the __run_id__ parameter is valid and - // returns an HTTP status code 400 if the __run_id__ parameter is invalid. + // This endpoint validates that the **run_id** parameter is valid and + // returns an HTTP status code 400 if the **run_id** parameter is invalid. // Runs are automatically removed after 60 days. If you to want to reference // them beyond 60 days, you must save old run results before they expire. GetRunOutput(ctx context.Context, request GetRunOutputRequest) (*RunOutput, error) @@ -102,8 +102,8 @@ type JobsService interface { // history for the original job run. RepairRun(ctx context.Context, request RepairRun) (*RepairRunResponse, error) - // Overwrite all settings for the given job. Use the [_Update_ - // endpoint](:method:jobs/update) to update job settings partially. + // Overwrite all settings for the given job. Use the *Update* endpoint to + // update job settings partially. Reset(ctx context.Context, request ResetJob) error // Run a job and return the `run_id` of the triggered run. @@ -129,7 +129,7 @@ type JobsService interface { Submit(ctx context.Context, request SubmitRun) (*SubmitRunResponse, error) // Add, update, or remove specific settings of an existing job. Use the - // [_Reset_ endpoint](:method:jobs/reset) to overwrite all job settings. + // *Reset* endpoint to overwrite all job settings. Update(ctx context.Context, request UpdateJob) error // Updates the permissions on a job. Jobs can inherit permissions from their diff --git a/service/jobs/model.go b/service/jobs/model.go index 43f33306b..1ea707c46 100755 --- a/service/jobs/model.go +++ b/service/jobs/model.go @@ -63,9 +63,11 @@ type AlertTask struct { // task. WarehouseId string `json:"warehouse_id,omitempty"` // The workspace_path is the path to the alert file in the workspace. The - // path: * must start with "/Workspace" * must be a normalized path. User - // has to select only one of alert_id or workspace_path to identify the - // alert. + // path: + // + // - must start with "/Workspace" + // - must be a normalized path. User has to select only one of alert_id or + // workspace_path to identify the alert. WorkspacePath string `json:"workspace_path,omitempty"` ForceSendFields []string `json:"-" url:"-"` @@ -147,11 +149,12 @@ type BaseJob struct { // the user has already been deleted. CreatorUserName string `json:"creator_user_name,omitempty"` // The id of the budget policy used by this job for cost attribution - // purposes. This may be set through (in order of precedence): 1. Budget - // admins through the account or workspace console 2. Jobs UI in the job - // details page and Jobs API using `budget_policy_id` 3. Inferred default - // based on accessible budget policies of the run_as identity on job - // creation or modification. + // purposes. This may be set through (in order of precedence): + // + // 1. Budget admins through the account or workspace console + // 2. Jobs UI in the job details page and Jobs API using `budget_policy_id` + // 3. Inferred default based on accessible budget policies of the run_as + // identity on job creation or modification. EffectiveBudgetPolicyId string `json:"effective_budget_policy_id,omitempty"` // The id of the usage policy used by this job for cost attribution // purposes. @@ -212,9 +215,9 @@ type BaseRun struct { // request depending on whether the performance mode is supported by the job // type. // - // * `STANDARD`: Enables cost-efficient execution of serverless workloads. * - // `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times - // through rapid scaling and optimized cluster performance. + // - `STANDARD`: Enables cost-efficient execution of serverless workloads. + // - `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times + // through rapid scaling and optimized cluster performance. EffectivePerformanceTarget PerformanceTarget `json:"effective_performance_target,omitempty"` // The id of the usage policy used by this run for cost attribution // purposes. @@ -655,12 +658,13 @@ type ConditionTask struct { // The left operand of the condition task. Can be either a string value or a // job state or parameter reference. Left string `json:"left"` - // * `EQUAL_TO`, `NOT_EQUAL` operators perform string comparison of their - // operands. This means that `“12.0” == “12”` will evaluate to - // `false`. * `GREATER_THAN`, `GREATER_THAN_OR_EQUAL`, `LESS_THAN`, - // `LESS_THAN_OR_EQUAL` operators perform numeric comparison of their - // operands. `“12.0” >= “12”` will evaluate to `true`, `“10.0” - // >= “12”` will evaluate to `false`. + // - `EQUAL_TO`, `NOT_EQUAL` operators perform string comparison of their + // operands. This means that `“12.0” == “12”` will evaluate to + // `false`. + // - `GREATER_THAN`, `GREATER_THAN_OR_EQUAL`, `LESS_THAN`, + // `LESS_THAN_OR_EQUAL` operators perform numeric comparison of their + // operands. `“12.0” >= “12”` will evaluate to `true`, + // `“10.0” >= “12”` will evaluate to `false`. // // The boolean comparison to task values can be implemented with operators // `EQUAL_TO`, `NOT_EQUAL`. If a task value was set to a boolean value, it @@ -671,12 +675,13 @@ type ConditionTask struct { Right string `json:"right"` } -// * `EQUAL_TO`, `NOT_EQUAL` operators perform string comparison of their -// operands. This means that `“12.0” == “12”` will evaluate to `false`. -// * `GREATER_THAN`, `GREATER_THAN_OR_EQUAL`, `LESS_THAN`, `LESS_THAN_OR_EQUAL` -// operators perform numeric comparison of their operands. `“12.0” >= -// “12”` will evaluate to `true`, `“10.0” >= “12”` will evaluate to -// `false`. +// - `EQUAL_TO`, `NOT_EQUAL` operators perform string comparison of their +// operands. This means that `“12.0” == “12”` will evaluate to +// `false`. +// - `GREATER_THAN`, `GREATER_THAN_OR_EQUAL`, `LESS_THAN`, +// `LESS_THAN_OR_EQUAL` operators perform numeric comparison of their +// operands. `“12.0” >= “12”` will evaluate to `true`, `“10.0” +// >= “12”` will evaluate to `false`. // // The boolean comparison to task values can be implemented with operators // `EQUAL_TO`, `NOT_EQUAL`. If a task value was set to a boolean value, it will @@ -758,8 +763,8 @@ type CreateJob struct { Description string `json:"description,omitempty"` // Edit mode of the job. // - // * `UI_LOCKED`: The job is in a locked UI state and cannot be modified. * - // `EDITABLE`: The job is in an editable state and can be modified. + // - `UI_LOCKED`: The job is in a locked UI state and cannot be modified. + // - `EDITABLE`: The job is in an editable state and can be modified. EditMode JobEditMode `json:"edit_mode,omitempty"` // An optional set of email addresses that is notified when runs of this job // begin or complete as well as when this job is deleted. @@ -818,9 +823,9 @@ type CreateJob struct { // of compute performance or cost-efficiency for the run. The performance // target does not apply to tasks that run on Serverless GPU compute. // - // * `STANDARD`: Enables cost-efficient execution of serverless workloads. * - // `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times - // through rapid scaling and optimized cluster performance. + // - `STANDARD`: Enables cost-efficient execution of serverless workloads. + // - `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times + // through rapid scaling and optimized cluster performance. PerformanceTarget PerformanceTarget `json:"performance_target,omitempty"` // The queue settings of the job. Queue *QueueSettings `json:"queue,omitempty"` @@ -927,13 +932,16 @@ type DashboardTask struct { // Dashboard task parameters. Used to apply dashboard filter values during // dashboard task execution. Parameter values get applied to any dashboard // filters that have a matching URL identifier as the parameter key. The - // parameter value format is dependent on the filter type: - For text and - // single-select filters, provide a single value (e.g. `"value"`) - For date - // and datetime filters, provide the value in ISO 8601 format (e.g. - // `"2000-01-01T00:00:00"`) - For multi-select filters, provide a JSON array - // of values (e.g. `"[\"value1\",\"value2\"]"`) - For range and date range - // filters, provide a JSON object with `start` and `end` (e.g. - // `"{\"start\":\"1\",\"end\":\"10\"}"`) + // parameter value format is dependent on the filter type: + // + // - For text and single-select filters, provide a single value (e.g. + // `"value"`) + // - For date and datetime filters, provide the value in ISO 8601 format + // (e.g. `"2000-01-01T00:00:00"`) + // - For multi-select filters, provide a JSON array of values (e.g. + // `"[\"value1\",\"value2\"]"`) + // - For range and date range filters, provide a JSON object with `start` + // and `end` (e.g. `"{\"start\":\"1\",\"end\":\"10\"}"`) Filters map[string]string `json:"filters,omitempty"` // Optional: subscription configuration for sending the dashboard snapshot. Subscription *Subscription `json:"subscription,omitempty"` @@ -1188,8 +1196,8 @@ type DbtTask struct { // in `git_source`. If the value is empty, the task will use `GIT` if // `git_source` is defined and `WORKSPACE` otherwise. // - // * `WORKSPACE`: Project is located in Databricks workspace. * `GIT`: - // Project is located in cloud Git provider. + // - `WORKSPACE`: Project is located in Databricks workspace. + // - `GIT`: Project is located in cloud Git provider. Source Source `json:"source,omitempty"` // ID of the SQL warehouse to connect to. If provided, we automatically // generate and provide the profile and connection details to dbt. It can be @@ -1294,8 +1302,8 @@ func (s EnforcePolicyComplianceResponse) MarshalJSON() ([]byte, error) { // Run was exported successfully. type ExportRunOutput struct { // The exported content in HTML format (one for every view item). To extract - // the HTML notebook from the JSON response, download and run this [Python - // script](/_static/examples/extract.py). + // the HTML notebook from the JSON response, download and run this Python + // script. Views []ViewItem `json:"views,omitempty"` } @@ -1479,9 +1487,10 @@ type GenAiComputeTask struct { // the script will be retrieved from the local Databricks workspace. When // set to `GIT`, the script will be retrieved from a Git repository defined // in `git_source`. If the value is empty, the task will use `GIT` if - // `git_source` is defined and `WORKSPACE` otherwise. * `WORKSPACE`: Script - // is located in Databricks workspace. * `GIT`: Script is located in cloud - // Git provider. + // `git_source` is defined and `WORKSPACE` otherwise. + // + // - `WORKSPACE`: Script is located in Databricks workspace. + // - `GIT`: Script is located in cloud Git provider. Source Source `json:"source,omitempty"` // The training script file path to be executed. Cloud file URIs (such as // dbfs:/, s3:/, adls:/, gcs:/) and workspace paths are supported. For @@ -1729,11 +1738,12 @@ type Job struct { // the user has already been deleted. CreatorUserName string `json:"creator_user_name,omitempty"` // The id of the budget policy used by this job for cost attribution - // purposes. This may be set through (in order of precedence): 1. Budget - // admins through the account or workspace console 2. Jobs UI in the job - // details page and Jobs API using `budget_policy_id` 3. Inferred default - // based on accessible budget policies of the run_as identity on job - // creation or modification. + // purposes. This may be set through (in order of precedence): + // + // 1. Budget admins through the account or workspace console + // 2. Jobs UI in the job details page and Jobs API using `budget_policy_id` + // 3. Inferred default based on accessible budget policies of the run_as + // identity on job creation or modification. EffectiveBudgetPolicyId string `json:"effective_budget_policy_id,omitempty"` // The id of the usage policy used by this job for cost attribution // purposes. @@ -1855,8 +1865,8 @@ type JobDeployment struct { DeploymentId string `json:"deployment_id,omitempty"` // The kind of deployment that manages the job. // - // * `BUNDLE`: The job is managed by Databricks Asset Bundle. * - // `SYSTEM_MANAGED`: The job is managed by Databricks and is read-only. + // - `BUNDLE`: The job is managed by Databricks Asset Bundle. + // - `SYSTEM_MANAGED`: The job is managed by Databricks and is read-only. Kind JobDeploymentKind `json:"kind"` // Path of the file that contains deployment metadata. MetadataFilePath string `json:"metadata_file_path,omitempty"` @@ -1876,8 +1886,8 @@ func (s JobDeployment) MarshalJSON() ([]byte, error) { return marshal.Marshal(s) } -// * `BUNDLE`: The job is managed by Databricks Asset Bundle. * -// `SYSTEM_MANAGED`: The job is managed by Databricks and is read-only. +// - `BUNDLE`: The job is managed by Databricks Asset Bundle. +// - `SYSTEM_MANAGED`: The job is managed by Databricks and is read-only. type JobDeploymentKind string // The job is managed by Databricks Asset Bundle. @@ -1919,8 +1929,8 @@ func (f *JobDeploymentKind) Type() string { // Edit mode of the job. // -// * `UI_LOCKED`: The job is in a locked UI state and cannot be modified. * -// `EDITABLE`: The job is in an editable state and can be modified. +// - `UI_LOCKED`: The job is in a locked UI state and cannot be modified. +// - `EDITABLE`: The job is in an editable state and can be modified. type JobEditMode string // The job is in an editable state and can be modified. @@ -2205,8 +2215,8 @@ type JobSettings struct { Description string `json:"description,omitempty"` // Edit mode of the job. // - // * `UI_LOCKED`: The job is in a locked UI state and cannot be modified. * - // `EDITABLE`: The job is in an editable state and can be modified. + // - `UI_LOCKED`: The job is in a locked UI state and cannot be modified. + // - `EDITABLE`: The job is in an editable state and can be modified. EditMode JobEditMode `json:"edit_mode,omitempty"` // An optional set of email addresses that is notified when runs of this job // begin or complete as well as when this job is deleted. @@ -2265,9 +2275,9 @@ type JobSettings struct { // of compute performance or cost-efficiency for the run. The performance // target does not apply to tasks that run on Serverless GPU compute. // - // * `STANDARD`: Enables cost-efficient execution of serverless workloads. * - // `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times - // through rapid scaling and optimized cluster performance. + // - `STANDARD`: Enables cost-efficient execution of serverless workloads. + // - `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times + // through rapid scaling and optimized cluster performance. PerformanceTarget PerformanceTarget `json:"performance_target,omitempty"` // The queue settings of the job. Queue *QueueSettings `json:"queue,omitempty"` @@ -2326,12 +2336,14 @@ type JobSource struct { // Dirty state indicates the job is not fully synced with the job // specification in the remote repository. // - // Possible values are: * `NOT_SYNCED`: The job is not yet synced with the - // remote job specification. Import the remote job specification from UI to - // make the job fully synced. * `DISCONNECTED`: The job is temporary - // disconnected from the remote job specification and is allowed for live - // edit. Import the remote job specification again from UI to make the job - // fully synced. + // Possible values are: + // + // - `NOT_SYNCED`: The job is not yet synced with the remote job + // specification. Import the remote job specification from UI to make + // the job fully synced. + // - `DISCONNECTED`: The job is temporary disconnected from the remote job + // specification and is allowed for live edit. Import the remote job + // specification again from UI to make the job fully synced. DirtyState JobSourceDirtyState `json:"dirty_state,omitempty"` // Name of the branch which the job is imported from. ImportFromGitBranch string `json:"import_from_git_branch"` @@ -2342,11 +2354,14 @@ type JobSource struct { // Dirty state indicates the job is not fully synced with the job specification // in the remote repository. // -// Possible values are: * `NOT_SYNCED`: The job is not yet synced with the -// remote job specification. Import the remote job specification from UI to make -// the job fully synced. * `DISCONNECTED`: The job is temporary disconnected -// from the remote job specification and is allowed for live edit. Import the -// remote job specification again from UI to make the job fully synced. +// Possible values are: +// +// - `NOT_SYNCED`: The job is not yet synced with the remote job +// specification. Import the remote job specification from UI to make the +// job fully synced. +// - `DISCONNECTED`: The job is temporary disconnected from the remote job +// specification and is allowed for live edit. Import the remote job +// specification again from UI to make the job fully synced. type JobSourceDirtyState string // The job is temporary disconnected from the remote job specification and is @@ -2392,15 +2407,16 @@ func (f *JobSourceDirtyState) Type() string { // Specifies the health metric that is being evaluated for a particular health // rule. // -// * `RUN_DURATION_SECONDS`: Expected total time for a run in seconds. * -// `STREAMING_BACKLOG_BYTES`: An estimate of the maximum bytes of data waiting -// to be consumed across all streams. This metric is in Public Preview. * -// `STREAMING_BACKLOG_RECORDS`: An estimate of the maximum offset lag across all -// streams. This metric is in Public Preview. * `STREAMING_BACKLOG_SECONDS`: An -// estimate of the maximum consumer delay across all streams. This metric is in -// Public Preview. * `STREAMING_BACKLOG_FILES`: An estimate of the maximum -// number of outstanding files across all streams. This metric is in Public -// Preview. +// - `RUN_DURATION_SECONDS`: Expected total time for a run in seconds. +// - `STREAMING_BACKLOG_BYTES`: An estimate of the maximum bytes of data +// waiting to be consumed across all streams. This metric is in Public +// Preview. +// - `STREAMING_BACKLOG_RECORDS`: An estimate of the maximum offset lag across +// all streams. This metric is in Public Preview. +// - `STREAMING_BACKLOG_SECONDS`: An estimate of the maximum consumer delay +// across all streams. This metric is in Public Preview. +// - `STREAMING_BACKLOG_FILES`: An estimate of the maximum number of +// outstanding files across all streams. This metric is in Public Preview. type JobsHealthMetric string // Expected total time for a run in seconds. @@ -2636,12 +2652,12 @@ type ListRunsRequest struct { // The type of runs to return. For a description of run types, see // :method:jobs/getRun. RunType RunType `json:"-" url:"run_type,omitempty"` - // Show runs that started _at or after_ this value. The value must be a UTC - // timestamp in milliseconds. Can be combined with _start_time_to_ to filter + // Show runs that started *at or after* this value. The value must be a UTC + // timestamp in milliseconds. Can be combined with *start_time_to* to filter // by a time range. StartTimeFrom int64 `json:"-" url:"start_time_from,omitempty"` - // Show runs that started _at or before_ this value. The value must be a UTC - // timestamp in milliseconds. Can be combined with _start_time_from_ to + // Show runs that started *at or before* this value. The value must be a UTC + // timestamp in milliseconds. Can be combined with *start_time_from* to // filter by a time range. StartTimeTo int64 `json:"-" url:"start_time_to,omitempty"` @@ -2753,12 +2769,10 @@ func (f *ModelTriggerConfigurationCondition) Type() string { } type NotebookOutput struct { - // The value passed to - // [dbutils.notebook.exit()](/notebooks/notebook-workflows.html#notebook-workflows-exit). - // Databricks restricts this API to return the first 5 MB of the value. For - // a larger result, your job can store the results in a cloud storage - // service. This field is absent if `dbutils.notebook.exit()` was never - // called. + // The value passed to dbutils.notebook.exit(). Databricks restricts this + // API to return the first 5 MB of the value. For a larger result, your job + // can store the results in a cloud storage service. This field is absent if + // `dbutils.notebook.exit()` was never called. Result string `json:"result,omitempty"` // Whether or not the result was truncated. Truncated bool `json:"truncated,omitempty"` @@ -2802,9 +2816,10 @@ type NotebookTask struct { // notebook will be retrieved from the local Databricks workspace. When set // to `GIT`, the notebook will be retrieved from a Git repository defined in // `git_source`. If the value is empty, the task will use `GIT` if - // `git_source` is defined and `WORKSPACE` otherwise. * `WORKSPACE`: - // Notebook is located in Databricks workspace. * `GIT`: Notebook is located - // in cloud Git provider. + // `git_source` is defined and `WORKSPACE` otherwise. + // + // - `WORKSPACE`: Notebook is located in Databricks workspace. + // - `GIT`: Notebook is located in cloud Git provider. Source Source `json:"source,omitempty"` // Optional `warehouse_id` to run the notebook on a SQL warehouse. Classic // SQL warehouses are NOT supported, please use serverless or pro SQL @@ -3162,11 +3177,14 @@ func (s QueueDetails) MarshalJSON() ([]byte, error) { return marshal.Marshal(s) } -// The reason for queuing the run. * `ACTIVE_RUNS_LIMIT_REACHED`: The run was -// queued due to reaching the workspace limit of active task runs. * -// `MAX_CONCURRENT_RUNS_REACHED`: The run was queued due to reaching the per-job -// limit of concurrent job runs. * `ACTIVE_RUN_JOB_TASKS_LIMIT_REACHED`: The run -// was queued due to reaching the workspace limit of active run job tasks. +// The reason for queuing the run. +// +// - `ACTIVE_RUNS_LIMIT_REACHED`: The run was queued due to reaching the +// workspace limit of active task runs. +// - `MAX_CONCURRENT_RUNS_REACHED`: The run was queued due to reaching the +// per-job limit of concurrent job runs. +// - `ACTIVE_RUN_JOB_TASKS_LIMIT_REACHED`: The run was queued due to reaching +// the workspace limit of active run job tasks. type QueueDetailsCodeCode string // The run was queued due to reaching the workspace limit of active task runs. @@ -3222,9 +3240,9 @@ type RepairHistoryItem struct { // request depending on whether the performance mode is supported by the job // type. // - // * `STANDARD`: Enables cost-efficient execution of serverless workloads. * - // `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times - // through rapid scaling and optimized cluster performance. + // - `STANDARD`: Enables cost-efficient execution of serverless workloads. + // - `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times + // through rapid scaling and optimized cluster performance. EffectivePerformanceTarget PerformanceTarget `json:"effective_performance_target,omitempty"` // The end time of the (repaired) run. EndTime int64 `json:"end_time,omitempty"` @@ -3349,9 +3367,9 @@ type RepairRun struct { // run. This field overrides the performance target defined on the job // level. // - // * `STANDARD`: Enables cost-efficient execution of serverless workloads. * - // `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times - // through rapid scaling and optimized cluster performance. + // - `STANDARD`: Enables cost-efficient execution of serverless workloads. + // - `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times + // through rapid scaling and optimized cluster performance. PerformanceTarget PerformanceTarget `json:"performance_target,omitempty"` // Controls whether the pipeline should perform a full refresh PipelineParams *PipelineParams `json:"pipeline_params,omitempty"` @@ -3561,9 +3579,9 @@ type Run struct { // request depending on whether the performance mode is supported by the job // type. // - // * `STANDARD`: Enables cost-efficient execution of serverless workloads. * - // `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times - // through rapid scaling and optimized cluster performance. + // - `STANDARD`: Enables cost-efficient execution of serverless workloads. + // - `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times + // through rapid scaling and optimized cluster performance. EffectivePerformanceTarget PerformanceTarget `json:"effective_performance_target,omitempty"` // The id of the usage policy used by this run for cost attribution // purposes. @@ -3686,12 +3704,13 @@ type RunConditionTask struct { // The left operand of the condition task. Can be either a string value or a // job state or parameter reference. Left string `json:"left"` - // * `EQUAL_TO`, `NOT_EQUAL` operators perform string comparison of their - // operands. This means that `“12.0” == “12”` will evaluate to - // `false`. * `GREATER_THAN`, `GREATER_THAN_OR_EQUAL`, `LESS_THAN`, - // `LESS_THAN_OR_EQUAL` operators perform numeric comparison of their - // operands. `“12.0” >= “12”` will evaluate to `true`, `“10.0” - // >= “12”` will evaluate to `false`. + // - `EQUAL_TO`, `NOT_EQUAL` operators perform string comparison of their + // operands. This means that `“12.0” == “12”` will evaluate to + // `false`. + // - `GREATER_THAN`, `GREATER_THAN_OR_EQUAL`, `LESS_THAN`, + // `LESS_THAN_OR_EQUAL` operators perform numeric comparison of their + // operands. `“12.0” >= “12”` will evaluate to `true`, + // `“10.0” >= “12”` will evaluate to `false`. // // The boolean comparison to task values can be implemented with operators // `EQUAL_TO`, `NOT_EQUAL`. If a task value was set to a boolean value, it @@ -3744,12 +3763,15 @@ func (s RunForEachTask) MarshalJSON() ([]byte, error) { // should be run once its dependencies have been completed. When omitted, // defaults to `ALL_SUCCESS`. // -// Possible values are: * `ALL_SUCCESS`: All dependencies have executed and -// succeeded * `AT_LEAST_ONE_SUCCESS`: At least one dependency has succeeded * -// `NONE_FAILED`: None of the dependencies have failed and at least one was -// executed * `ALL_DONE`: All dependencies have been completed * -// `AT_LEAST_ONE_FAILED`: At least one dependency failed * `ALL_FAILED`: ALl -// dependencies have failed +// Possible values are: +// +// - `ALL_SUCCESS`: All dependencies have executed and succeeded +// - `AT_LEAST_ONE_SUCCESS`: At least one dependency has succeeded +// - `NONE_FAILED`: None of the dependencies have failed and at least one was +// executed +// - `ALL_DONE`: All dependencies have been completed +// - `AT_LEAST_ONE_FAILED`: At least one dependency failed +// - `ALL_FAILED`: ALl dependencies have failed type RunIf string // All dependencies have been completed @@ -3919,20 +3941,24 @@ type RunJobTask struct { SqlParams map[string]string `json:"sql_params,omitempty"` } -// A value indicating the run's lifecycle state. The possible values are: * -// `QUEUED`: The run is queued. * `PENDING`: The run is waiting to be executed -// while the cluster and execution context are being prepared. * `RUNNING`: The -// task of this run is being executed. * `TERMINATING`: The task of this run has -// completed, and the cluster and execution context are being cleaned up. * -// `TERMINATED`: The task of this run has completed, and the cluster and -// execution context have been cleaned up. This state is terminal. * `SKIPPED`: -// This run was aborted because a previous run of the same job was already -// active. This state is terminal. * `INTERNAL_ERROR`: An exceptional state that -// indicates a failure in the Jobs service, such as network failure over a long -// period. If a run on a new cluster ends in the `INTERNAL_ERROR` state, the -// Jobs service terminates the cluster as soon as possible. This state is -// terminal. * `BLOCKED`: The run is blocked on an upstream dependency. * -// `WAITING_FOR_RETRY`: The run is waiting for a retry. +// A value indicating the run's lifecycle state. The possible values are: +// +// - `QUEUED`: The run is queued. +// - `PENDING`: The run is waiting to be executed while the cluster and +// execution context are being prepared. +// - `RUNNING`: The task of this run is being executed. +// - `TERMINATING`: The task of this run has completed, and the cluster and +// execution context are being cleaned up. +// - `TERMINATED`: The task of this run has completed, and the cluster and +// execution context have been cleaned up. This state is terminal. +// - `SKIPPED`: This run was aborted because a previous run of the same job +// was already active. This state is terminal. +// - `INTERNAL_ERROR`: An exceptional state that indicates a failure in the +// Jobs service, such as network failure over a long period. If a run on a +// new cluster ends in the `INTERNAL_ERROR` state, the Jobs service +// terminates the cluster as soon as possible. This state is terminal. +// - `BLOCKED`: The run is blocked on an upstream dependency. +// - `WAITING_FOR_RETRY`: The run is waiting for a retry. type RunLifeCycleState string // The run is blocked on an upstream dependency. @@ -4131,9 +4157,9 @@ type RunNow struct { // run. This field overrides the performance target defined on the job // level. // - // * `STANDARD`: Enables cost-efficient execution of serverless workloads. * - // `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times - // through rapid scaling and optimized cluster performance. + // - `STANDARD`: Enables cost-efficient execution of serverless workloads. + // - `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times + // through rapid scaling and optimized cluster performance. PerformanceTarget PerformanceTarget `json:"performance_target,omitempty"` // Controls whether the pipeline should perform a full refresh PipelineParams *PipelineParams `json:"pipeline_params,omitempty"` @@ -4373,18 +4399,23 @@ type RunParameters struct { SqlParams map[string]string `json:"sql_params,omitempty"` } -// A value indicating the run's result. The possible values are: * `SUCCESS`: -// The task completed successfully. * `FAILED`: The task completed with an -// error. * `TIMEDOUT`: The run was stopped after reaching the timeout. * -// `CANCELED`: The run was canceled at user request. * -// `MAXIMUM_CONCURRENT_RUNS_REACHED`: The run was skipped because the maximum -// concurrent runs were reached. * `EXCLUDED`: The run was skipped because the -// necessary conditions were not met. * `SUCCESS_WITH_FAILURES`: The job run -// completed successfully with some failures; leaf tasks were successful. * -// `UPSTREAM_FAILED`: The run was skipped because of an upstream failure. * -// `UPSTREAM_CANCELED`: The run was skipped because an upstream task was -// canceled. * `DISABLED`: The run was skipped because it was disabled -// explicitly by the user. +// A value indicating the run's result. The possible values are: +// +// - `SUCCESS`: The task completed successfully. +// - `FAILED`: The task completed with an error. +// - `TIMEDOUT`: The run was stopped after reaching the timeout. +// - `CANCELED`: The run was canceled at user request. +// - `MAXIMUM_CONCURRENT_RUNS_REACHED`: The run was skipped because the +// maximum concurrent runs were reached. +// - `EXCLUDED`: The run was skipped because the necessary conditions were not +// met. +// - `SUCCESS_WITH_FAILURES`: The job run completed successfully with some +// failures; leaf tasks were successful. +// - `UPSTREAM_FAILED`: The run was skipped because of an upstream failure. +// - `UPSTREAM_CANCELED`: The run was skipped because an upstream task was +// canceled. +// - `DISABLED`: The run was skipped because it was disabled explicitly by the +// user. type RunResultState string // The run was canceled at user request. @@ -4561,9 +4592,9 @@ type RunTask struct { // request depending on whether the performance mode is supported by the job // type. // - // * `STANDARD`: Enables cost-efficient execution of serverless workloads. * - // `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times - // through rapid scaling and optimized cluster performance. + // - `STANDARD`: Enables cost-efficient execution of serverless workloads. + // - `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times + // through rapid scaling and optimized cluster performance. EffectivePerformanceTarget PerformanceTarget `json:"effective_performance_target,omitempty"` // An optional set of email addresses notified when the task run begins or // completes. The default behavior is to not send any emails. @@ -4673,7 +4704,7 @@ type RunTask struct { SparkPythonTask *SparkPythonTask `json:"spark_python_task,omitempty"` // (Legacy) The task runs the spark-submit script when the spark_submit_task // field is present. Databricks recommends using the spark_jar_task instead; - // see [Spark Submit task for jobs](/jobs/spark-submit). + // see Spark Submit task for jobs. SparkSubmitTask *SparkSubmitTask `json:"spark_submit_task,omitempty"` // The task runs a SQL query or file, or it refreshes a SQL alert or a // legacy SQL dashboard when the `sql_task` field is present. @@ -4711,10 +4742,11 @@ func (s RunTask) MarshalJSON() ([]byte, error) { return marshal.Marshal(s) } -// The type of a run. * `JOB_RUN`: Normal job run. A run created with -// :method:jobs/runNow. * `WORKFLOW_RUN`: Workflow run. A run created with -// [dbutils.notebook.run]. * `SUBMIT_RUN`: Submit run. A run created with -// :method:jobs/submit. +// The type of a run. +// +// - `JOB_RUN`: Normal job run. A run created with :method:jobs/runNow. +// - `WORKFLOW_RUN`: Workflow run. A run created with [dbutils.notebook.run]. +// - `SUBMIT_RUN`: Submit run. A run created with :method:jobs/submit. // // [dbutils.notebook.run]: https://docs.databricks.com/dev-tools/databricks-utils.html#dbutils-workflow type RunType string @@ -4725,8 +4757,7 @@ const RunTypeJobRun RunType = `JOB_RUN` // Submit run. A run created with :method:jobs/submit. const RunTypeSubmitRun RunType = `SUBMIT_RUN` -// Workflow run. A run created with -// [dbutils.notebook.run](/dev-tools/databricks-utils.html#dbutils-workflow). +// Workflow run. A run created with dbutils.notebook.run. const RunTypeWorkflowRun RunType = `WORKFLOW_RUN` // String representation for [fmt.Print] @@ -4762,13 +4793,13 @@ func (f *RunType) Type() string { } // Optional location type of the SQL file. When set to `WORKSPACE`, the SQL file -// will be retrieved\ from the local Databricks workspace. When set to `GIT`, -// the SQL file will be retrieved from a Git repository defined in `git_source`. -// If the value is empty, the task will use `GIT` if `git_source` is defined and +// will be retrieved from the local Databricks workspace. When set to `GIT`, the +// SQL file will be retrieved from a Git repository defined in `git_source`. If +// the value is empty, the task will use `GIT` if `git_source` is defined and // `WORKSPACE` otherwise. // -// * `WORKSPACE`: SQL file is located in Databricks workspace. * `GIT`: SQL file -// is located in cloud Git provider. +// - `WORKSPACE`: SQL file is located in Databricks workspace. +// - `GIT`: SQL file is located in cloud Git provider. type Source string // SQL file is located in cloud Git provider. @@ -4863,9 +4894,9 @@ type SparkPythonTask struct { // `GIT`, the Python file will be retrieved from a Git repository defined in // `git_source`. // - // * `WORKSPACE`: The Python file is located in a Databricks workspace or at - // a cloud filesystem URI. * `GIT`: The Python file is located in a remote - // Git repository. + // - `WORKSPACE`: The Python file is located in a Databricks workspace or + // at a cloud filesystem URI. + // - `GIT`: The Python file is located in a remote Git repository. Source Source `json:"source,omitempty"` } @@ -4909,9 +4940,9 @@ func (s SqlAlertOutput) MarshalJSON() ([]byte, error) { // The state of the SQL alert. // -// * UNKNOWN: alert yet to be evaluated * OK: alert evaluated and did not -// fulfill trigger conditions * TRIGGERED: alert evaluated and fulfilled trigger -// conditions +// - UNKNOWN: alert yet to be evaluated +// - OK: alert evaluated and did not fulfill trigger conditions +// - TRIGGERED: alert evaluated and fulfilled trigger conditions type SqlAlertState string const SqlAlertStateOk SqlAlertState = `OK` @@ -5175,8 +5206,8 @@ type SqlTaskFile struct { // `git_source`. If the value is empty, the task will use `GIT` if // `git_source` is defined and `WORKSPACE` otherwise. // - // * `WORKSPACE`: SQL file is located in Databricks workspace. * `GIT`: SQL - // file is located in cloud Git provider. + // - `WORKSPACE`: SQL file is located in Databricks workspace. + // - `GIT`: SQL file is located in cloud Git provider. Source Source `json:"source,omitempty"` } @@ -5446,7 +5477,7 @@ type SubmitTask struct { SparkPythonTask *SparkPythonTask `json:"spark_python_task,omitempty"` // (Legacy) The task runs the spark-submit script when the spark_submit_task // field is present. Databricks recommends using the spark_jar_task instead; - // see [Spark Submit task for jobs](/jobs/spark-submit). + // see Spark Submit task for jobs. SparkSubmitTask *SparkSubmitTask `json:"spark_submit_task,omitempty"` // The task runs a SQL query or file, or it refreshes a SQL alert or a // legacy SQL dashboard when the `sql_task` field is present. @@ -5676,12 +5707,13 @@ type Task struct { // An optional value specifying the condition determining whether the task // is run once its dependencies have been completed. // - // * `ALL_SUCCESS`: All dependencies have executed and succeeded * - // `AT_LEAST_ONE_SUCCESS`: At least one dependency has succeeded * - // `NONE_FAILED`: None of the dependencies have failed and at least one was - // executed * `ALL_DONE`: All dependencies have been completed * - // `AT_LEAST_ONE_FAILED`: At least one dependency failed * `ALL_FAILED`: ALl - // dependencies have failed + // - `ALL_SUCCESS`: All dependencies have executed and succeeded + // - `AT_LEAST_ONE_SUCCESS`: At least one dependency has succeeded + // - `NONE_FAILED`: None of the dependencies have failed and at least one + // was executed + // - `ALL_DONE`: All dependencies have been completed + // - `AT_LEAST_ONE_FAILED`: At least one dependency failed + // - `ALL_FAILED`: ALl dependencies have failed RunIf RunIf `json:"run_if,omitempty"` // The task triggers another job when the `run_job_task` field is present. RunJobTask *RunJobTask `json:"run_job_task,omitempty"` @@ -5692,7 +5724,7 @@ type Task struct { SparkPythonTask *SparkPythonTask `json:"spark_python_task,omitempty"` // (Legacy) The task runs the spark-submit script when the spark_submit_task // field is present. Databricks recommends using the spark_jar_task instead; - // see [Spark Submit task for jobs](/jobs/spark-submit). + // see Spark Submit task for jobs. SparkSubmitTask *SparkSubmitTask `json:"spark_submit_task,omitempty"` // The task runs a SQL query or file, or it refreshes a SQL alert or a // legacy SQL dashboard when the `sql_task` field is present. @@ -5808,11 +5840,13 @@ func (s TaskNotificationSettings) MarshalJSON() ([]byte, error) { return marshal.Marshal(s) } -// task retry mode of the continuous job * NEVER: The failed task will not be -// retried. * ON_FAILURE: Retry a failed task if at least one other task in the -// job is still running its first attempt. When this condition is no longer met -// or the retry limit is reached, the job run is cancelled and a new run is -// started. +// task retry mode of the continuous job +// +// - NEVER: The failed task will not be retried. +// - ON_FAILURE: Retry a failed task if at least one other task in the job is +// still running its first attempt. When this condition is no longer met or +// the retry limit is reached, the job run is cancelled and a new run is +// started. type TaskRetryMode string const TaskRetryModeNever TaskRetryMode = `NEVER` @@ -5851,53 +5885,67 @@ func (f *TaskRetryMode) Type() string { } // The code indicates why the run was terminated. Additional codes might be -// introduced in future releases. * `SUCCESS`: The run was completed -// successfully. * `SUCCESS_WITH_FAILURES`: The run was completed successfully -// but some child runs failed. * `USER_CANCELED`: The run was successfully -// canceled during execution by a user. * `CANCELED`: The run was canceled -// during execution by the Databricks platform; for example, if the maximum run -// duration was exceeded. * `SKIPPED`: Run was never executed, for example, if -// the upstream task run failed, the dependency type condition was not met, or -// there were no material tasks to execute. * `INTERNAL_ERROR`: The run -// encountered an unexpected error. Refer to the state message for further -// details. * `DRIVER_ERROR`: The run encountered an error while communicating -// with the Spark Driver. * `CLUSTER_ERROR`: The run failed due to a cluster -// error. Refer to the state message for further details. * -// `REPOSITORY_CHECKOUT_FAILED`: Failed to complete the checkout due to an error -// when communicating with the third party service. * `INVALID_CLUSTER_REQUEST`: -// The run failed because it issued an invalid request to start the cluster. * -// `WORKSPACE_RUN_LIMIT_EXCEEDED`: The workspace has reached the quota for the -// maximum number of concurrent active runs. Consider scheduling the runs over a -// larger time frame. * `FEATURE_DISABLED`: The run failed because it tried to -// access a feature unavailable for the workspace. * -// `CLUSTER_REQUEST_LIMIT_EXCEEDED`: The number of cluster creation, start, and -// upsize requests have exceeded the allotted rate limit. Consider spreading the -// run execution over a larger time frame. * `STORAGE_ACCESS_ERROR`: The run -// failed due to an error when accessing the customer blob storage. Refer to the -// state message for further details. * `RUN_EXECUTION_ERROR`: The run was -// completed with task failures. For more details, refer to the state message or -// run output. * `UNAUTHORIZED_ERROR`: The run failed due to a permission issue -// while accessing a resource. Refer to the state message for further details. * -// `LIBRARY_INSTALLATION_ERROR`: The run failed while installing the -// user-requested library. Refer to the state message for further details. The -// causes might include, but are not limited to: The provided library is -// invalid, there are insufficient permissions to install the library, and so -// forth. * `MAX_CONCURRENT_RUNS_EXCEEDED`: The scheduled run exceeds the limit -// of maximum concurrent runs set for the job. * `MAX_SPARK_CONTEXTS_EXCEEDED`: -// The run is scheduled on a cluster that has already reached the maximum number -// of contexts it is configured to create. See: [Link]. * `RESOURCE_NOT_FOUND`: -// A resource necessary for run execution does not exist. Refer to the state -// message for further details. * `INVALID_RUN_CONFIGURATION`: The run failed -// due to an invalid configuration. Refer to the state message for further -// details. * `CLOUD_FAILURE`: The run failed due to a cloud provider issue. -// Refer to the state message for further details. * -// `MAX_JOB_QUEUE_SIZE_EXCEEDED`: The run was skipped due to reaching the job -// level queue size limit. * `DISABLED`: The run was never executed because it -// was disabled explicitly by the user. * `BREAKING_CHANGE`: Run failed because -// of an intentional breaking change in Spark, but it will be retried with a -// mitigation config. * `CLUSTER_TERMINATED_BY_USER`: The run failed because the -// externally managed cluster entered an unusable state, likely due to the user -// terminating or restarting it outside the jobs service. +// introduced in future releases. +// +// - `SUCCESS`: The run was completed successfully. +// - `SUCCESS_WITH_FAILURES`: The run was completed successfully but some +// child runs failed. +// - `USER_CANCELED`: The run was successfully canceled during execution by a +// user. +// - `CANCELED`: The run was canceled during execution by the Databricks +// platform; for example, if the maximum run duration was exceeded. +// - `SKIPPED`: Run was never executed, for example, if the upstream task run +// failed, the dependency type condition was not met, or there were no +// material tasks to execute. +// - `INTERNAL_ERROR`: The run encountered an unexpected error. Refer to the +// state message for further details. +// - `DRIVER_ERROR`: The run encountered an error while communicating with the +// Spark Driver. +// - `CLUSTER_ERROR`: The run failed due to a cluster error. Refer to the +// state message for further details. +// - `REPOSITORY_CHECKOUT_FAILED`: Failed to complete the checkout due to an +// error when communicating with the third party service. +// - `INVALID_CLUSTER_REQUEST`: The run failed because it issued an invalid +// request to start the cluster. +// - `WORKSPACE_RUN_LIMIT_EXCEEDED`: The workspace has reached the quota for +// the maximum number of concurrent active runs. Consider scheduling the +// runs over a larger time frame. +// - `FEATURE_DISABLED`: The run failed because it tried to access a feature +// unavailable for the workspace. +// - `CLUSTER_REQUEST_LIMIT_EXCEEDED`: The number of cluster creation, start, +// and upsize requests have exceeded the allotted rate limit. Consider +// spreading the run execution over a larger time frame. +// - `STORAGE_ACCESS_ERROR`: The run failed due to an error when accessing the +// customer blob storage. Refer to the state message for further details. +// - `RUN_EXECUTION_ERROR`: The run was completed with task failures. For more +// details, refer to the state message or run output. +// - `UNAUTHORIZED_ERROR`: The run failed due to a permission issue while +// accessing a resource. Refer to the state message for further details. +// - `LIBRARY_INSTALLATION_ERROR`: The run failed while installing the +// user-requested library. Refer to the state message for further details. +// The causes might include, but are not limited to: The provided library is +// invalid, there are insufficient permissions to install the library, and +// so forth. +// - `MAX_CONCURRENT_RUNS_EXCEEDED`: The scheduled run exceeds the limit of +// maximum concurrent runs set for the job. +// - `MAX_SPARK_CONTEXTS_EXCEEDED`: The run is scheduled on a cluster that has +// already reached the maximum number of contexts it is configured to +// create. See: [Link]. +// - `RESOURCE_NOT_FOUND`: A resource necessary for run execution does not +// exist. Refer to the state message for further details. +// - `INVALID_RUN_CONFIGURATION`: The run failed due to an invalid +// configuration. Refer to the state message for further details. +// - `CLOUD_FAILURE`: The run failed due to a cloud provider issue. Refer to +// the state message for further details. +// - `MAX_JOB_QUEUE_SIZE_EXCEEDED`: The run was skipped due to reaching the +// job level queue size limit. +// - `DISABLED`: The run was never executed because it was disabled explicitly +// by the user. +// - `BREAKING_CHANGE`: Run failed because of an intentional breaking change +// in Spark, but it will be retried with a mitigation config. +// - `CLUSTER_TERMINATED_BY_USER`: The run failed because the externally +// managed cluster entered an unusable state, likely due to the user +// terminating or restarting it outside the jobs service. // // [Link]: https://kb.databricks.com/en_US/notebooks/too-many-execution-contexts-are-open-right-now type TerminationCodeCode string @@ -6077,12 +6125,13 @@ func (s TerminationDetails) MarshalJSON() ([]byte, error) { return marshal.Marshal(s) } -// * `SUCCESS`: The run terminated without any issues * `INTERNAL_ERROR`: An -// error occurred in the Databricks platform. Please look at the [status page] -// or contact support if the issue persists. * `CLIENT_ERROR`: The run was -// terminated because of an error caused by user input or the job configuration. -// * `CLOUD_FAILURE`: The run was terminated because of an issue with your cloud -// provider. +// - `SUCCESS`: The run terminated without any issues +// - `INTERNAL_ERROR`: An error occurred in the Databricks platform. Please +// look at the [status page] or contact support if the issue persists. +// - `CLIENT_ERROR`: The run was terminated because of an error caused by user +// input or the job configuration. +// - `CLOUD_FAILURE`: The run was terminated because of an issue with your +// cloud provider. // // [status page]: https://status.databricks.com/ type TerminationTypeType string @@ -6173,18 +6222,20 @@ type TriggerStateProto struct { // The type of trigger that fired this run. // -// * `PERIODIC`: Schedules that periodically trigger runs, such as a cron -// scheduler. * `ONE_TIME`: One time triggers that fire a single run. This -// occurs you triggered a single run on demand through the UI or the API. * -// `RETRY`: Indicates a run that is triggered as a retry of a previously failed -// run. This occurs when you request to re-run the job in case of failures. * -// `RUN_JOB_TASK`: Indicates a run that is triggered using a Run Job task. * -// `FILE_ARRIVAL`: Indicates a run that is triggered by a file arrival. * -// `CONTINUOUS`: Indicates a run that is triggered by a continuous job. * -// `TABLE`: Indicates a run that is triggered by a table update. * -// `CONTINUOUS_RESTART`: Indicates a run created by user to manually restart a -// continuous job run. * `MODEL`: Indicates a run that is triggered by a model -// update. +// - `PERIODIC`: Schedules that periodically trigger runs, such as a cron +// scheduler. +// - `ONE_TIME`: One time triggers that fire a single run. This occurs you +// triggered a single run on demand through the UI or the API. +// - `RETRY`: Indicates a run that is triggered as a retry of a previously +// failed run. This occurs when you request to re-run the job in case of +// failures. +// - `RUN_JOB_TASK`: Indicates a run that is triggered using a Run Job task. +// - `FILE_ARRIVAL`: Indicates a run that is triggered by a file arrival. +// - `CONTINUOUS`: Indicates a run that is triggered by a continuous job. +// - `TABLE`: Indicates a run that is triggered by a table update. +// - `CONTINUOUS_RESTART`: Indicates a run created by user to manually restart +// a continuous job run. +// - `MODEL`: Indicates a run that is triggered by a model update. type TriggerType string // Indicates a run that is triggered by a continuous job. @@ -6292,7 +6343,8 @@ func (s ViewItem) MarshalJSON() ([]byte, error) { return marshal.Marshal(s) } -// * `NOTEBOOK`: Notebook view item. * `DASHBOARD`: Dashboard view item. +// - `NOTEBOOK`: Notebook view item. +// - `DASHBOARD`: Dashboard view item. type ViewType string // Dashboard view item. @@ -6332,8 +6384,9 @@ func (f *ViewType) Type() string { return "ViewType" } -// * `CODE`: Code view of the notebook. * `DASHBOARDS`: All dashboard views of -// the notebook. * `ALL`: All views of the notebook. +// - `CODE`: Code view of the notebook. +// - `DASHBOARDS`: All dashboard views of the notebook. +// - `ALL`: All views of the notebook. type ViewsToExport string // All views of the notebook. diff --git a/service/knowledgeassistants/model.go b/service/knowledgeassistants/model.go index 90d0a7eed..af2819922 100755 --- a/service/knowledgeassistants/model.go +++ b/service/knowledgeassistants/model.go @@ -577,7 +577,10 @@ type UpdateExampleRequest struct { // knowledge-assistants/{knowledge_assistant_id}/examples/{example_id} Name string `json:"-" url:"-"` // Comma-delimited list of fields to update on the example. Allowed values: - // `question`, `guidelines`. Examples: - `question` - `question,guidelines` + // `question`, `guidelines`. Examples: + // + // - `question` + // - `question,guidelines` UpdateMask fieldmask.FieldMask `json:"-" url:"update_mask"` } @@ -592,7 +595,9 @@ type UpdateKnowledgeAssistantRequest struct { Name string `json:"-" url:"-"` // Comma-delimited list of fields to update on the Knowledge Assistant. // Allowed values: `display_name`, `description`, `instructions`. Examples: - // - `display_name` - `description,instructions` + // + // - `display_name` + // - `description,instructions` UpdateMask fieldmask.FieldMask `json:"-" url:"update_mask"` } @@ -606,7 +611,9 @@ type UpdateKnowledgeSourceRequest struct { // knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id} Name string `json:"-" url:"-"` // Comma-delimited list of fields to update on the Knowledge Source. Allowed - // values: `display_name`, `description`. Examples: - `display_name` - - // `display_name,description` + // values: `display_name`, `description`. Examples: + // + // - `display_name` + // - `display_name,description` UpdateMask fieldmask.FieldMask `json:"-" url:"update_mask"` } diff --git a/service/marketplace/api.go b/service/marketplace/api.go index a6c8b1342..a76842a6c 100755 --- a/service/marketplace/api.go +++ b/service/marketplace/api.go @@ -27,7 +27,7 @@ type ConsumerFulfillmentsInterface interface { // Get a high level preview of the metadata of listing installable content. GetByListingId(ctx context.Context, listingId string) (*GetListingContentMetadataResponse, error) - // Get all listings fulfillments associated with a listing. A _fulfillment_ is a + // Get all listings fulfillments associated with a listing. A *fulfillment* is a // potential installation. Standard installations contain metadata about the // attached share or git repo. Only one of these fields will be present. // Personalized installations contain metadata about the attached share or git @@ -36,7 +36,7 @@ type ConsumerFulfillmentsInterface interface { // This method is generated by Databricks SDK Code Generator. List(ctx context.Context, request ListFulfillmentsRequest) listing.Iterator[ListingFulfillment] - // Get all listings fulfillments associated with a listing. A _fulfillment_ is a + // Get all listings fulfillments associated with a listing. A *fulfillment* is a // potential installation. Standard installations contain metadata about the // attached share or git repo. Only one of these fields will be present. // Personalized installations contain metadata about the attached share or git @@ -45,7 +45,7 @@ type ConsumerFulfillmentsInterface interface { // This method is generated by Databricks SDK Code Generator. ListAll(ctx context.Context, request ListFulfillmentsRequest) ([]ListingFulfillment, error) - // Get all listings fulfillments associated with a listing. A _fulfillment_ is a + // Get all listings fulfillments associated with a listing. A *fulfillment* is a // potential installation. Standard installations contain metadata about the // attached share or git repo. Only one of these fields will be present. // Personalized installations contain metadata about the attached share or git @@ -73,7 +73,7 @@ func (a *ConsumerFulfillmentsAPI) GetByListingId(ctx context.Context, listingId }) } -// Get all listings fulfillments associated with a listing. A _fulfillment_ is a +// Get all listings fulfillments associated with a listing. A *fulfillment* is a // potential installation. Standard installations contain metadata about the // attached share or git repo. Only one of these fields will be present. // Personalized installations contain metadata about the attached share or git @@ -120,9 +120,11 @@ type ConsumerInstallationsInterface interface { // This is a update API that will update the part of the fields defined in the // installation table as well as interact with external services according to - // the fields not included in the installation table 1. the token will be rotate - // if the rotateToken flag is true 2. the token will be forcibly rotate if the - // rotateToken flag is true and the tokenInfo field is empty + // the fields not included in the installation table + // + // 1. the token will be rotate if the rotateToken flag is true + // 2. the token will be forcibly rotate if the rotateToken flag is true and the + // tokenInfo field is empty Update(ctx context.Context, request UpdateInstallationRequest) (*UpdateInstallationResponse, error) } diff --git a/service/marketplace/impl.go b/service/marketplace/impl.go index 8784a4970..17a992c72 100755 --- a/service/marketplace/impl.go +++ b/service/marketplace/impl.go @@ -62,7 +62,7 @@ func (a *consumerFulfillmentsImpl) internalGet(ctx context.Context, request GetL return &getListingContentMetadataResponse, err } -// Get all listings fulfillments associated with a listing. A _fulfillment_ is a +// Get all listings fulfillments associated with a listing. A *fulfillment* is a // potential installation. Standard installations contain metadata about the // attached share or git repo. Only one of these fields will be present. // Personalized installations contain metadata about the attached share or git @@ -91,7 +91,7 @@ func (a *consumerFulfillmentsImpl) List(ctx context.Context, request ListFulfill return iterator } -// Get all listings fulfillments associated with a listing. A _fulfillment_ is a +// Get all listings fulfillments associated with a listing. A *fulfillment* is a // potential installation. Standard installations contain metadata about the // attached share or git repo. Only one of these fields will be present. // Personalized installations contain metadata about the attached share or git diff --git a/service/marketplace/interface.go b/service/marketplace/interface.go index 48610cdf1..050b0e63a 100755 --- a/service/marketplace/interface.go +++ b/service/marketplace/interface.go @@ -14,7 +14,7 @@ type ConsumerFulfillmentsService interface { // Get a high level preview of the metadata of listing installable content. Get(ctx context.Context, request GetListingContentMetadataRequest) (*GetListingContentMetadataResponse, error) - // Get all listings fulfillments associated with a listing. A _fulfillment_ + // Get all listings fulfillments associated with a listing. A *fulfillment* // is a potential installation. Standard installations contain metadata // about the attached share or git repo. Only one of these fields will be // present. Personalized installations contain metadata about the attached @@ -43,10 +43,11 @@ type ConsumerInstallationsService interface { // This is a update API that will update the part of the fields defined in // the installation table as well as interact with external services - // according to the fields not included in the installation table 1. the - // token will be rotate if the rotateToken flag is true 2. the token will be - // forcibly rotate if the rotateToken flag is true and the tokenInfo field - // is empty + // according to the fields not included in the installation table + // + // 1. the token will be rotate if the rotateToken flag is true + // 2. the token will be forcibly rotate if the rotateToken flag is true and + // the tokenInfo field is empty Update(ctx context.Context, request UpdateInstallationRequest) (*UpdateInstallationResponse, error) } diff --git a/service/marketplace/model.go b/service/marketplace/model.go index 8c1db1fad..d817d5227 100755 --- a/service/marketplace/model.go +++ b/service/marketplace/model.go @@ -1515,10 +1515,12 @@ type ListingDetail struct { // 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. + // 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 []ListingTag `json:"tags,omitempty"` TermsOfService string `json:"terms_of_service,omitempty"` diff --git a/service/ml/api.go b/service/ml/api.go index 3e26199e2..956b0d6c4 100755 --- a/service/ml/api.go +++ b/service/ml/api.go @@ -123,8 +123,7 @@ type ExperimentsInterface interface { // specified, the response contains only artifacts with the specified prefix. A // maximum of 1000 artifacts will be retrieved for UC Volumes. Please call // `/api/2.0/fs/directories{directory_path}` for listing artifacts in UC - // Volumes, which supports pagination. See [List directory contents | Files - // API](/api/workspace/files/listdirectorycontents). + // Volumes, which supports pagination. See List directory contents | Files API. // // This method is generated by Databricks SDK Code Generator. ListArtifacts(ctx context.Context, request ListArtifactsRequest) listing.Iterator[FileInfo] @@ -133,8 +132,7 @@ type ExperimentsInterface interface { // specified, the response contains only artifacts with the specified prefix. A // maximum of 1000 artifacts will be retrieved for UC Volumes. Please call // `/api/2.0/fs/directories{directory_path}` for listing artifacts in UC - // Volumes, which supports pagination. See [List directory contents | Files - // API](/api/workspace/files/listdirectorycontents). + // Volumes, which supports pagination. See List directory contents | Files API. // // This method is generated by Databricks SDK Code Generator. ListArtifactsAll(ctx context.Context, request ListArtifactsRequest) ([]FileInfo, error) @@ -161,37 +159,36 @@ type ExperimentsInterface interface { // // The overwrite behavior for metrics, params, and tags is as follows: // - // * Metrics: metric values are never overwritten. Logging a metric (key, value, - // timestamp) appends to the set of values for the metric with the provided key. + // - Metrics: metric values are never overwritten. Logging a metric (key, + // value, timestamp) appends to the set of values for the metric with the + // provided key. + // - Tags: tag values can be overwritten by successive writes to the same tag + // key. That is, if multiple tag values with the same key are provided in + // the same API request, the last-provided tag value is written. Logging the + // same tag (key, value) is permitted. Specifically, logging a tag is + // idempotent. + // - Parameters: once written, param values cannot be changed (attempting to + // overwrite a param value will result in an error). However, logging the + // same param (key, value) is permitted. Specifically, logging a param is + // idempotent. // - // * Tags: tag values can be overwritten by successive writes to the same tag - // key. That is, if multiple tag values with the same key are provided in the - // same API request, the last-provided tag value is written. Logging the same - // tag (key, value) is permitted. Specifically, logging a tag is idempotent. + // # Request Limits // - // * Parameters: once written, param values cannot be changed (attempting to - // overwrite a param value will result in an error). However, logging the same - // param (key, value) is permitted. Specifically, logging a param is idempotent. + // A single JSON-serialized API request may be up to 1 MB in size and contain: // - // Request Limits ------------------------------- A single JSON-serialized API - // request may be up to 1 MB in size and contain: - // - // * No more than 1000 metrics, params, and tags in total - // - // * Up to 1000 metrics - // - // * Up to 100 params - // - // * Up to 100 tags + // - No more than 1000 metrics, params, and tags in total + // - Up to 1000 metrics + // - Up to 100 params + // - Up to 100 tags // // For example, a valid request might contain 900 metrics, 50 params, and 50 // tags, but logging 900 metrics, 50 params, and 51 tags is invalid. // // The following limits also apply to metric, param, and tag keys and values: // - // * Metric keys, param keys, and tag keys can be up to 250 characters in length - // - // * Parameter and tag values can be up to 250 characters in length + // - Metric keys, param keys, and tag keys can be up to 250 characters in + // length + // - Parameter and tag values can be up to 250 characters in length LogBatch(ctx context.Context, request LogBatch) error // Logs inputs, such as datasets and models, to an MLflow Run. @@ -208,9 +205,7 @@ type ExperimentsInterface interface { // that represent ML model accuracy. A metric can be logged multiple times. LogMetric(ctx context.Context, request LogMetric) error - // **Note:** the [Create a logged - // model](/api/workspace/experiments/createloggedmodel) API replaces this - // endpoint. + // **Note:** the Create a logged model API replaces this endpoint. // // Log a model to an MLflow Run. LogModel(ctx context.Context, request LogModel) error @@ -860,13 +855,13 @@ type ModelRegistryInterface interface { GetPermissionsByRegisteredModelId(ctx context.Context, registeredModelId string) (*RegisteredModelPermissions, error) // Lists all available registered models, up to the limit specified in - // __max_results__. + // **max_results**. // // This method is generated by Databricks SDK Code Generator. ListModels(ctx context.Context, request ListModelsRequest) listing.Iterator[Model] // Lists all available registered models, up to the limit specified in - // __max_results__. + // **max_results**. // // This method is generated by Databricks SDK Code Generator. ListModelsAll(ctx context.Context, request ListModelsRequest) ([]Model, error) @@ -897,22 +892,22 @@ type ModelRegistryInterface interface { // Renames a registered model. RenameModel(ctx context.Context, request RenameModelRequest) (*RenameModelResponse, error) - // Searches for specific model versions based on the supplied __filter__. + // Searches for specific model versions based on the supplied **filter**. // // This method is generated by Databricks SDK Code Generator. SearchModelVersions(ctx context.Context, request SearchModelVersionsRequest) listing.Iterator[ModelVersion] - // Searches for specific model versions based on the supplied __filter__. + // Searches for specific model versions based on the supplied **filter**. // // This method is generated by Databricks SDK Code Generator. SearchModelVersionsAll(ctx context.Context, request SearchModelVersionsRequest) ([]ModelVersion, error) - // Search for registered models based on the specified __filter__. + // Search for registered models based on the specified **filter**. // // This method is generated by Databricks SDK Code Generator. SearchModels(ctx context.Context, request SearchModelsRequest) listing.Iterator[Model] - // Search for registered models based on the specified __filter__. + // Search for registered models based on the specified **filter**. // // This method is generated by Databricks SDK Code Generator. SearchModelsAll(ctx context.Context, request SearchModelsRequest) ([]Model, error) @@ -964,10 +959,10 @@ func NewModelRegistry(client *client.DatabricksClient) *ModelRegistryAPI { } // Note: This API reference documents APIs for the Workspace Model Registry. -// Databricks recommends using [Models in Unity -// Catalog](/api/workspace/registeredmodels) instead. Models in Unity Catalog -// provides centralized model governance, cross-workspace access, lineage, and -// deployment. Workspace Model Registry will be deprecated in the future. +// Databricks recommends using Models in Unity Catalog instead. Models in Unity +// Catalog provides centralized model governance, cross-workspace access, +// lineage, and deployment. Workspace Model Registry will be deprecated in the +// future. // // The Workspace Model Registry is a centralized model repository and a UI and // set of APIs that enable you to manage the full lifecycle of MLflow Models. diff --git a/service/ml/impl.go b/service/ml/impl.go index 23f688b1a..aa1321197 100755 --- a/service/ml/impl.go +++ b/service/ml/impl.go @@ -296,8 +296,7 @@ func (a *experimentsImpl) GetRun(ctx context.Context, request GetRunRequest) (*G // specified, the response contains only artifacts with the specified prefix. A // maximum of 1000 artifacts will be retrieved for UC Volumes. Please call // `/api/2.0/fs/directories{directory_path}` for listing artifacts in UC -// Volumes, which supports pagination. See [List directory contents | Files -// API](/api/workspace/files/listdirectorycontents). +// Volumes, which supports pagination. See List directory contents | Files API. func (a *experimentsImpl) ListArtifacts(ctx context.Context, request ListArtifactsRequest) listing.Iterator[FileInfo] { getNextPage := func(ctx context.Context, req ListArtifactsRequest) (*ListArtifactsResponse, error) { @@ -326,8 +325,7 @@ func (a *experimentsImpl) ListArtifacts(ctx context.Context, request ListArtifac // specified, the response contains only artifacts with the specified prefix. A // maximum of 1000 artifacts will be retrieved for UC Volumes. Please call // `/api/2.0/fs/directories{directory_path}` for listing artifacts in UC -// Volumes, which supports pagination. See [List directory contents | Files -// API](/api/workspace/files/listdirectorycontents). +// Volumes, which supports pagination. See List directory contents | Files API. func (a *experimentsImpl) ListArtifactsAll(ctx context.Context, request ListArtifactsRequest) ([]FileInfo, error) { iterator := a.ListArtifacts(ctx, request) return listing.ToSlice[FileInfo](ctx, iterator) @@ -1795,7 +1793,7 @@ func (a *modelRegistryImpl) GetPermissions(ctx context.Context, request GetRegis } // Lists all available registered models, up to the limit specified in -// __max_results__. +// **max_results**. func (a *modelRegistryImpl) ListModels(ctx context.Context, request ListModelsRequest) listing.Iterator[Model] { getNextPage := func(ctx context.Context, req ListModelsRequest) (*ListModelsResponse, error) { @@ -1821,7 +1819,7 @@ func (a *modelRegistryImpl) ListModels(ctx context.Context, request ListModelsRe } // Lists all available registered models, up to the limit specified in -// __max_results__. +// **max_results**. func (a *modelRegistryImpl) ListModelsAll(ctx context.Context, request ListModelsRequest) ([]Model, error) { iterator := a.ListModels(ctx, request) return listing.ToSlice[Model](ctx, iterator) @@ -1955,7 +1953,7 @@ func (a *modelRegistryImpl) RenameModel(ctx context.Context, request RenameModel return &renameModelResponse, err } -// Searches for specific model versions based on the supplied __filter__. +// Searches for specific model versions based on the supplied **filter**. func (a *modelRegistryImpl) SearchModelVersions(ctx context.Context, request SearchModelVersionsRequest) listing.Iterator[ModelVersion] { getNextPage := func(ctx context.Context, req SearchModelVersionsRequest) (*SearchModelVersionsResponse, error) { @@ -1980,7 +1978,7 @@ func (a *modelRegistryImpl) SearchModelVersions(ctx context.Context, request Sea return iterator } -// Searches for specific model versions based on the supplied __filter__. +// Searches for specific model versions based on the supplied **filter**. func (a *modelRegistryImpl) SearchModelVersionsAll(ctx context.Context, request SearchModelVersionsRequest) ([]ModelVersion, error) { iterator := a.SearchModelVersions(ctx, request) return listing.ToSlice[ModelVersion](ctx, iterator) @@ -2000,7 +1998,7 @@ func (a *modelRegistryImpl) internalSearchModelVersions(ctx context.Context, req return &searchModelVersionsResponse, err } -// Search for registered models based on the specified __filter__. +// Search for registered models based on the specified **filter**. func (a *modelRegistryImpl) SearchModels(ctx context.Context, request SearchModelsRequest) listing.Iterator[Model] { getNextPage := func(ctx context.Context, req SearchModelsRequest) (*SearchModelsResponse, error) { @@ -2025,7 +2023,7 @@ func (a *modelRegistryImpl) SearchModels(ctx context.Context, request SearchMode return iterator } -// Search for registered models based on the specified __filter__. +// Search for registered models based on the specified **filter**. func (a *modelRegistryImpl) SearchModelsAll(ctx context.Context, request SearchModelsRequest) ([]Model, error) { iterator := a.SearchModels(ctx, request) return listing.ToSlice[Model](ctx, iterator) diff --git a/service/ml/interface.go b/service/ml/interface.go index 11f2f3e4c..7e04950c5 100755 --- a/service/ml/interface.go +++ b/service/ml/interface.go @@ -105,8 +105,8 @@ type ExperimentsService interface { // if specified, the response contains only artifacts with the specified // prefix. A maximum of 1000 artifacts will be retrieved for UC Volumes. // Please call `/api/2.0/fs/directories{directory_path}` for listing - // artifacts in UC Volumes, which supports pagination. See [List directory - // contents | Files API](/api/workspace/files/listdirectorycontents). + // artifacts in UC Volumes, which supports pagination. See List directory + // contents | Files API. ListArtifacts(ctx context.Context, request ListArtifactsRequest) (*ListArtifactsResponse, error) // Gets a list of all experiments. @@ -125,31 +125,28 @@ type ExperimentsService interface { // // The overwrite behavior for metrics, params, and tags is as follows: // - // * Metrics: metric values are never overwritten. Logging a metric (key, - // value, timestamp) appends to the set of values for the metric with the - // provided key. + // - Metrics: metric values are never overwritten. Logging a metric (key, + // value, timestamp) appends to the set of values for the metric with + // the provided key. + // - Tags: tag values can be overwritten by successive writes to the same + // tag key. That is, if multiple tag values with the same key are + // provided in the same API request, the last-provided tag value is + // written. Logging the same tag (key, value) is permitted. + // Specifically, logging a tag is idempotent. + // - Parameters: once written, param values cannot be changed (attempting + // to overwrite a param value will result in an error). However, logging + // the same param (key, value) is permitted. Specifically, logging a + // param is idempotent. // - // * Tags: tag values can be overwritten by successive writes to the same - // tag key. That is, if multiple tag values with the same key are provided - // in the same API request, the last-provided tag value is written. Logging - // the same tag (key, value) is permitted. Specifically, logging a tag is - // idempotent. + // # Request Limits // - // * Parameters: once written, param values cannot be changed (attempting to - // overwrite a param value will result in an error). However, logging the - // same param (key, value) is permitted. Specifically, logging a param is - // idempotent. + // A single JSON-serialized API request may be up to 1 MB in size and + // contain: // - // Request Limits ------------------------------- A single JSON-serialized - // API request may be up to 1 MB in size and contain: - // - // * No more than 1000 metrics, params, and tags in total - // - // * Up to 1000 metrics - // - // * Up to 100 params - // - // * Up to 100 tags + // - No more than 1000 metrics, params, and tags in total + // - Up to 1000 metrics + // - Up to 100 params + // - Up to 100 tags // // For example, a valid request might contain 900 metrics, 50 params, and 50 // tags, but logging 900 metrics, 50 params, and 51 tags is invalid. @@ -157,10 +154,9 @@ type ExperimentsService interface { // The following limits also apply to metric, param, and tag keys and // values: // - // * Metric keys, param keys, and tag keys can be up to 250 characters in - // length - // - // * Parameter and tag values can be up to 250 characters in length + // - Metric keys, param keys, and tag keys can be up to 250 characters in + // length + // - Parameter and tag values can be up to 250 characters in length LogBatch(ctx context.Context, request LogBatch) error // Logs inputs, such as datasets and models, to an MLflow Run. @@ -178,9 +174,7 @@ type ExperimentsService interface { // that represent ML model accuracy. A metric can be logged multiple times. LogMetric(ctx context.Context, request LogMetric) error - // **Note:** the [Create a logged - // model](/api/workspace/experiments/createloggedmodel) API replaces this - // endpoint. + // **Note:** the Create a logged model API replaces this endpoint. // // Log a model to an MLflow Run. LogModel(ctx context.Context, request LogModel) error @@ -405,10 +399,10 @@ type MaterializedFeaturesService interface { } // Note: This API reference documents APIs for the Workspace Model Registry. -// Databricks recommends using [Models in Unity -// Catalog](/api/workspace/registeredmodels) instead. Models in Unity Catalog -// provides centralized model governance, cross-workspace access, lineage, and -// deployment. Workspace Model Registry will be deprecated in the future. +// Databricks recommends using Models in Unity Catalog instead. Models in Unity +// Catalog provides centralized model governance, cross-workspace access, +// lineage, and deployment. Workspace Model Registry will be deprecated in the +// future. // // The Workspace Model Registry is a centralized model repository and a UI and // set of APIs that enable you to manage the full lifecycle of MLflow Models. @@ -483,7 +477,7 @@ type ModelRegistryService interface { GetPermissions(ctx context.Context, request GetRegisteredModelPermissionsRequest) (*RegisteredModelPermissions, error) // Lists all available registered models, up to the limit specified in - // __max_results__. + // **max_results**. ListModels(ctx context.Context, request ListModelsRequest) (*ListModelsResponse, error) // Gets a list of all open stage transition requests for the model version. @@ -499,10 +493,10 @@ type ModelRegistryService interface { // Renames a registered model. RenameModel(ctx context.Context, request RenameModelRequest) (*RenameModelResponse, error) - // Searches for specific model versions based on the supplied __filter__. + // Searches for specific model versions based on the supplied **filter**. SearchModelVersions(ctx context.Context, request SearchModelVersionsRequest) (*SearchModelVersionsResponse, error) - // Search for registered models based on the specified __filter__. + // Search for registered models based on the specified **filter**. SearchModels(ctx context.Context, request SearchModelsRequest) (*SearchModelsResponse, error) // Sets a tag on a registered model. diff --git a/service/ml/model.go b/service/ml/model.go index 86aa0e6ae..750c72487 100755 --- a/service/ml/model.go +++ b/service/ml/model.go @@ -24,13 +24,10 @@ type Activity struct { // Source stage of the transition (if the activity is stage transition // related). Valid values are: // - // * `None`: The initial stage of a model version. - // - // * `Staging`: Staging or pre-production stage. - // - // * `Production`: Production stage. - // - // * `Archived`: Archived stage. + // - `None`: The initial stage of a model version. + // - `Staging`: Staging or pre-production stage. + // - `Production`: Production stage. + // - `Archived`: Archived stage. FromStage string `json:"from_stage,omitempty"` // Unique identifier for the object. Id string `json:"id,omitempty"` @@ -44,13 +41,10 @@ type Activity struct { // Target stage of the transition (if the activity is stage transition // related). Valid values are: // - // * `None`: The initial stage of a model version. - // - // * `Staging`: Staging or pre-production stage. - // - // * `Production`: Production stage. - // - // * `Archived`: Archived stage. + // - `None`: The initial stage of a model version. + // - `Staging`: Staging or pre-production stage. + // - `Production`: Production stage. + // - `Archived`: Archived stage. ToStage string `json:"to_stage,omitempty"` // The username of the user that created the object. UserId string `json:"user_id,omitempty"` @@ -69,16 +63,16 @@ func (s Activity) MarshalJSON() ([]byte, error) { // An action that a user (with sufficient permissions) could take on an activity // or comment. // -// For activities, valid values are: * `APPROVE_TRANSITION_REQUEST`: Approve a -// transition request +// For activities, valid values are: // -// * `REJECT_TRANSITION_REQUEST`: Reject a transition request +// - `APPROVE_TRANSITION_REQUEST`: Approve a transition request +// - `REJECT_TRANSITION_REQUEST`: Reject a transition request +// - `CANCEL_TRANSITION_REQUEST`: Cancel (delete) a transition request // -// * `CANCEL_TRANSITION_REQUEST`: Cancel (delete) a transition request +// For comments, valid values are: // -// For comments, valid values are: * `EDIT_COMMENT`: Edit the comment -// -// * `DELETE_COMMENT`: Delete the comment +// - `EDIT_COMMENT`: Edit the comment +// - `DELETE_COMMENT`: Delete the comment type ActivityAction string // Approve a transition request @@ -130,19 +124,16 @@ func (f *ActivityAction) Type() string { return "ActivityAction" } -// Type of activity. Valid values are: * `APPLIED_TRANSITION`: User applied the -// corresponding stage transition. -// -// * `REQUESTED_TRANSITION`: User requested the corresponding stage transition. -// -// * `CANCELLED_REQUEST`: User cancelled an existing transition request. -// -// * `APPROVED_REQUEST`: User approved the corresponding stage transition. -// -// * `REJECTED_REQUEST`: User rejected the coressponding stage transition. +// Type of activity. Valid values are: // -// * `SYSTEM_TRANSITION`: For events performed as a side effect, such as -// archiving existing model versions in a stage. +// - `APPLIED_TRANSITION`: User applied the corresponding stage transition. +// - `REQUESTED_TRANSITION`: User requested the corresponding stage +// transition. +// - `CANCELLED_REQUEST`: User cancelled an existing transition request. +// - `APPROVED_REQUEST`: User approved the corresponding stage transition. +// - `REJECTED_REQUEST`: User rejected the coressponding stage transition. +// - `SYSTEM_TRANSITION`: For events performed as a side effect, such as +// archiving existing model versions in a stage. type ActivityType string // User applied the corresponding stage transition. @@ -245,13 +236,10 @@ type ApproveTransitionRequest struct { Name string `json:"name"` // Target stage of the transition. Valid values are: // - // * `None`: The initial stage of a model version. - // - // * `Staging`: Staging or pre-production stage. - // - // * `Production`: Production stage. - // - // * `Archived`: Archived stage. + // - `None`: The initial stage of a model version. + // - `Staging`: Staging or pre-production stage. + // - `Production`: Production stage. + // - `Archived`: Archived stage. Stage string `json:"stage"` // Version of the model. Version string `json:"version"` @@ -390,16 +378,16 @@ type ColumnSelection struct { // An action that a user (with sufficient permissions) could take on an activity // or comment. // -// For activities, valid values are: * `APPROVE_TRANSITION_REQUEST`: Approve a -// transition request +// For activities, valid values are: // -// * `REJECT_TRANSITION_REQUEST`: Reject a transition request +// - `APPROVE_TRANSITION_REQUEST`: Approve a transition request +// - `REJECT_TRANSITION_REQUEST`: Reject a transition request +// - `CANCEL_TRANSITION_REQUEST`: Cancel (delete) a transition request // -// * `CANCEL_TRANSITION_REQUEST`: Cancel (delete) a transition request +// For comments, valid values are: // -// For comments, valid values are: * `EDIT_COMMENT`: Edit the comment -// -// * `DELETE_COMMENT`: Delete the comment +// - `EDIT_COMMENT`: Edit the comment +// - `DELETE_COMMENT`: Delete the comment type CommentActivityAction string // Approve a transition request @@ -600,9 +588,11 @@ type CreateForecastingExperimentRequest struct { // Specifies the list of feature columns to include in model training. These // columns must exist in the training data and be of type string, numerical, // or boolean. If not specified, no additional features will be included. - // Note: Certain columns are automatically handled: - Automatically - // excluded: split_column, target_column, custom_weights_column. - - // Automatically included: time_column. + // Note: Certain columns are automatically handled: + // + // - Automatically excluded: split_column, target_column, + // custom_weights_column. + // - Automatically included: time_column. IncludeFeatures []string `json:"include_features,omitempty"` // The maximum duration for the experiment in minutes. The experiment stops // automatically if it exceeds this limit. @@ -670,7 +660,7 @@ type CreateKafkaConfigRequest struct { type CreateLoggedModelRequest struct { // The ID of the experiment that owns the model. ExperimentId string `json:"experiment_id"` - // The type of the model, such as ``"Agent"``, ``"Classifier"``, ``"LLM"``. + // The type of the model, such as `"Agent"`, `"Classifier"`, `"LLM"`. ModelType string `json:"model_type,omitempty"` // The name of the model (optional). If not specified one will be generated. Name string `json:"name,omitempty"` @@ -766,39 +756,31 @@ type CreateOnlineStoreRequest struct { type CreateRegistryWebhook struct { // User-specified description for the webhook. Description string `json:"description,omitempty"` - // Events that can trigger a registry webhook: * `MODEL_VERSION_CREATED`: A - // new model version was created for the associated model. - // - // * `MODEL_VERSION_TRANSITIONED_STAGE`: A model version’s stage was - // changed. - // - // * `TRANSITION_REQUEST_CREATED`: A user requested a model version’s - // stage be transitioned. - // - // * `COMMENT_CREATED`: A user wrote a comment on a registered model. - // - // * `REGISTERED_MODEL_CREATED`: A new registered model was created. This - // event type can only be specified for a registry-wide webhook, which can - // be created by not specifying a model name in the create request. - // - // * `MODEL_VERSION_TAG_SET`: A user set a tag on the model version. + // Events that can trigger a registry webhook: // - // * `MODEL_VERSION_TRANSITIONED_TO_STAGING`: A model version was - // transitioned to staging. - // - // * `MODEL_VERSION_TRANSITIONED_TO_PRODUCTION`: A model version was - // transitioned to production. - // - // * `MODEL_VERSION_TRANSITIONED_TO_ARCHIVED`: A model version was archived. - // - // * `TRANSITION_REQUEST_TO_STAGING_CREATED`: A user requested a model - // version be transitioned to staging. - // - // * `TRANSITION_REQUEST_TO_PRODUCTION_CREATED`: A user requested a model - // version be transitioned to production. - // - // * `TRANSITION_REQUEST_TO_ARCHIVED_CREATED`: A user requested a model - // version be archived. + // - `MODEL_VERSION_CREATED`: A new model version was created for the + // associated model. + // - `MODEL_VERSION_TRANSITIONED_STAGE`: A model version’s stage was + // changed. + // - `TRANSITION_REQUEST_CREATED`: A user requested a model version’s + // stage be transitioned. + // - `COMMENT_CREATED`: A user wrote a comment on a registered model. + // - `REGISTERED_MODEL_CREATED`: A new registered model was created. This + // event type can only be specified for a registry-wide webhook, which + // can be created by not specifying a model name in the create request. + // - `MODEL_VERSION_TAG_SET`: A user set a tag on the model version. + // - `MODEL_VERSION_TRANSITIONED_TO_STAGING`: A model version was + // transitioned to staging. + // - `MODEL_VERSION_TRANSITIONED_TO_PRODUCTION`: A model version was + // transitioned to production. + // - `MODEL_VERSION_TRANSITIONED_TO_ARCHIVED`: A model version was + // archived. + // - `TRANSITION_REQUEST_TO_STAGING_CREATED`: A user requested a model + // version be transitioned to staging. + // - `TRANSITION_REQUEST_TO_PRODUCTION_CREATED`: A user requested a model + // version be transitioned to production. + // - `TRANSITION_REQUEST_TO_ARCHIVED_CREATED`: A user requested a model + // version be archived. Events []RegistryWebhookEvent `json:"events"` // External HTTPS URL called on event trigger (by using a POST request). HttpUrlSpec *HttpUrlSpec `json:"http_url_spec,omitempty"` @@ -809,13 +791,12 @@ type CreateRegistryWebhook struct { // models. ModelName string `json:"model_name,omitempty"` // Enable or disable triggering the webhook, or put the webhook into test - // mode. The default is `ACTIVE`: * `ACTIVE`: Webhook is triggered when an - // associated event happens. + // mode. The default is `ACTIVE`: // - // * `DISABLED`: Webhook is not triggered. - // - // * `TEST_MODE`: Webhook can be triggered through the test endpoint, but is - // not triggered on a real event. + // - `ACTIVE`: Webhook is triggered when an associated event happens. + // - `DISABLED`: Webhook is not triggered. + // - `TEST_MODE`: Webhook can be triggered through the test endpoint, but + // is not triggered on a real event. Status RegistryWebhookStatus `json:"status,omitempty"` ForceSendFields []string `json:"-" url:"-"` @@ -872,13 +853,10 @@ type CreateTransitionRequest struct { Name string `json:"name"` // Target stage of the transition. Valid values are: // - // * `None`: The initial stage of a model version. - // - // * `Staging`: Staging or pre-production stage. - // - // * `Production`: Production stage. - // - // * `Archived`: Archived stage. + // - `None`: The initial stage of a model version. + // - `Staging`: Staging or pre-production stage. + // - `Production`: Production stage. + // - `Archived`: Archived stage. Stage string `json:"stage"` // Version of the model. Version string `json:"version"` @@ -1128,13 +1106,10 @@ type DeleteTransitionRequestRequest struct { Name string `json:"-" url:"name"` // Target stage of the transition request. Valid values are: // - // * `None`: The initial stage of a model version. - // - // * `Staging`: Staging or pre-production stage. - // - // * `Production`: Production stage. - // - // * `Archived`: Archived stage. + // - `None`: The initial stage of a model version. + // - `Staging`: Staging or pre-production stage. + // - `Production`: Production stage. + // - `Archived`: Archived stage. Stage string `json:"-" url:"stage"` // Version of the model. Version string `json:"-" url:"version"` @@ -1592,9 +1567,9 @@ func (s FileInfo) MarshalJSON() ([]byte, error) { type FinalizeLoggedModelRequest struct { // The ID of the logged model to finalize. ModelId string `json:"-" url:"-"` - // Whether or not the model is ready for use. - // ``"LOGGED_MODEL_UPLOAD_FAILED"`` indicates that something went wrong when - // logging the model weights / agent code. + // Whether or not the model is ready for use. `"LOGGED_MODEL_UPLOAD_FAILED"` + // indicates that something went wrong when logging the model weights / + // agent code. Status LoggedModelStatus `json:"status"` } @@ -2335,8 +2310,8 @@ type ListArtifactsRequest struct { // is not supported when listing artifacts in UC Volumes. A maximum of 1000 // artifacts will be retrieved for UC Volumes. Please call // `/api/2.0/fs/directories{directory_path}` for listing artifacts in UC - // Volumes, which supports pagination. See [List directory contents | Files - // API](/api/workspace/files/listdirectorycontents). + // Volumes, which supports pagination. See List directory contents | Files + // API. PageToken string `json:"-" url:"page_token,omitempty"` // Filter artifacts matching this path (a relative path from the root // artifact directory). @@ -2675,11 +2650,12 @@ func (s ListStreamsRequest) MarshalJSON() ([]byte, error) { // Response to a ListStreamsRequest. // // NOTE: Results are post-filtered by access permission on each stream's -// ingestion table. This means: - Returned results may be fewer than page_size -// (including zero) - Page token points to next unfiltered batch, not next -// filtered batch, and may point to an item that will be filtered out Callers -// should paginate until next_page_token is empty to retrieve all accessible -// streams. +// ingestion table. This means: +// +// - Returned results may be fewer than page_size (including zero) +// - Page token points to next unfiltered batch, not next filtered batch, and +// may point to an item that will be filtered out Callers should paginate +// until next_page_token is empty to retrieve all accessible streams. type ListStreamsResponse struct { // Pagination token to request the next page of results for this query. NextPageToken string `json:"next_page_token,omitempty"` @@ -2710,39 +2686,31 @@ type ListTransitionRequestsResponse struct { } type ListWebhooksRequest struct { - // Events that trigger the webhook. * `MODEL_VERSION_CREATED`: A new model - // version was created for the associated model. - // - // * `MODEL_VERSION_TRANSITIONED_STAGE`: A model version’s stage was - // changed. - // - // * `TRANSITION_REQUEST_CREATED`: A user requested a model version’s - // stage be transitioned. - // - // * `COMMENT_CREATED`: A user wrote a comment on a registered model. - // - // * `REGISTERED_MODEL_CREATED`: A new registered model was created. This - // event type can only be specified for a registry-wide webhook, which can - // be created by not specifying a model name in the create request. - // - // * `MODEL_VERSION_TAG_SET`: A user set a tag on the model version. - // - // * `MODEL_VERSION_TRANSITIONED_TO_STAGING`: A model version was - // transitioned to staging. - // - // * `MODEL_VERSION_TRANSITIONED_TO_PRODUCTION`: A model version was - // transitioned to production. + // Events that trigger the webhook. // - // * `MODEL_VERSION_TRANSITIONED_TO_ARCHIVED`: A model version was archived. - // - // * `TRANSITION_REQUEST_TO_STAGING_CREATED`: A user requested a model - // version be transitioned to staging. - // - // * `TRANSITION_REQUEST_TO_PRODUCTION_CREATED`: A user requested a model - // version be transitioned to production. - // - // * `TRANSITION_REQUEST_TO_ARCHIVED_CREATED`: A user requested a model - // version be archived. + // - `MODEL_VERSION_CREATED`: A new model version was created for the + // associated model. + // - `MODEL_VERSION_TRANSITIONED_STAGE`: A model version’s stage was + // changed. + // - `TRANSITION_REQUEST_CREATED`: A user requested a model version’s + // stage be transitioned. + // - `COMMENT_CREATED`: A user wrote a comment on a registered model. + // - `REGISTERED_MODEL_CREATED`: A new registered model was created. This + // event type can only be specified for a registry-wide webhook, which + // can be created by not specifying a model name in the create request. + // - `MODEL_VERSION_TAG_SET`: A user set a tag on the model version. + // - `MODEL_VERSION_TRANSITIONED_TO_STAGING`: A model version was + // transitioned to staging. + // - `MODEL_VERSION_TRANSITIONED_TO_PRODUCTION`: A model version was + // transitioned to production. + // - `MODEL_VERSION_TRANSITIONED_TO_ARCHIVED`: A model version was + // archived. + // - `TRANSITION_REQUEST_TO_STAGING_CREATED`: A user requested a model + // version be transitioned to staging. + // - `TRANSITION_REQUEST_TO_PRODUCTION_CREATED`: A user requested a model + // version be transitioned to production. + // - `TRANSITION_REQUEST_TO_ARCHIVED_CREATED`: A user requested a model + // version be archived. // // If `events` is specified, any webhook with one or more of the specified // trigger events is included in the output. If `events` is not specified, @@ -2922,7 +2890,7 @@ type LoggedModelInfo struct { LastUpdatedTimestampMs int64 `json:"last_updated_timestamp_ms,omitempty"` // The unique identifier for the logged model. ModelId string `json:"model_id,omitempty"` - // The type of model, such as ``"Agent"``, ``"Classifier"``, ``"LLM"``. + // The type of model, such as `"Agent"`, `"Classifier"`, `"LLM"`. ModelType string `json:"model_type,omitempty"` // The name of the model. Name string `json:"name,omitempty"` @@ -3347,13 +3315,13 @@ func (s ModelVersionDatabricks) MarshalJSON() ([]byte, error) { return marshal.Marshal(s) } -// The status of the model version. Valid values are: * `PENDING_REGISTRATION`: -// Request to register a new model version is pending as server performs -// background tasks. -// -// * `FAILED_REGISTRATION`: Request to register a new model version has failed. +// The status of the model version. Valid values are: // -// * `READY`: Model version is ready for use. +// - `PENDING_REGISTRATION`: Request to register a new model version is +// pending as server performs background tasks. +// - `FAILED_REGISTRATION`: Request to register a new model version has +// failed. +// - `READY`: Model version is ready for use. type ModelVersionStatus string // Request to register a new model version has failed. @@ -3596,7 +3564,7 @@ func (s Param) MarshalJSON() ([]byte, error) { } // Permission level of the requesting user on the object. For what is allowed at -// each level, see [MLflow Model permissions](..). +// each level, see MLflow Model permissions. type PermissionLevel string const PermissionLevelCanCreateRegisteredModel PermissionLevel = `CAN_CREATE_REGISTERED_MODEL` @@ -3871,9 +3839,11 @@ type RegisteredModelPermissionsRequest struct { // .. note:: Experimental: This entity may change or be removed in a future // release without warning. Email subscription types for registry notifications: -// - `ALL_EVENTS`: Subscribed to all events. - `DEFAULT`: Default subscription -// type. - `SUBSCRIBED`: Subscribed to notifications. - `UNSUBSCRIBED`: Not -// subscribed to notifications. +// +// - `ALL_EVENTS`: Subscribed to all events. +// - `DEFAULT`: Default subscription type. +// - `SUBSCRIBED`: Subscribed to notifications. +// - `UNSUBSCRIBED`: Not subscribed to notifications. type RegistryEmailSubscriptionType string // Subscribed to all events. @@ -3926,39 +3896,31 @@ type RegistryWebhook struct { CreationTimestamp int64 `json:"creation_timestamp,omitempty"` // User-specified description for the webhook. Description string `json:"description,omitempty"` - // Events that can trigger a registry webhook: * `MODEL_VERSION_CREATED`: A - // new model version was created for the associated model. - // - // * `MODEL_VERSION_TRANSITIONED_STAGE`: A model version’s stage was - // changed. - // - // * `TRANSITION_REQUEST_CREATED`: A user requested a model version’s - // stage be transitioned. - // - // * `COMMENT_CREATED`: A user wrote a comment on a registered model. - // - // * `REGISTERED_MODEL_CREATED`: A new registered model was created. This - // event type can only be specified for a registry-wide webhook, which can - // be created by not specifying a model name in the create request. + // Events that can trigger a registry webhook: // - // * `MODEL_VERSION_TAG_SET`: A user set a tag on the model version. - // - // * `MODEL_VERSION_TRANSITIONED_TO_STAGING`: A model version was - // transitioned to staging. - // - // * `MODEL_VERSION_TRANSITIONED_TO_PRODUCTION`: A model version was - // transitioned to production. - // - // * `MODEL_VERSION_TRANSITIONED_TO_ARCHIVED`: A model version was archived. - // - // * `TRANSITION_REQUEST_TO_STAGING_CREATED`: A user requested a model - // version be transitioned to staging. - // - // * `TRANSITION_REQUEST_TO_PRODUCTION_CREATED`: A user requested a model - // version be transitioned to production. - // - // * `TRANSITION_REQUEST_TO_ARCHIVED_CREATED`: A user requested a model - // version be archived. + // - `MODEL_VERSION_CREATED`: A new model version was created for the + // associated model. + // - `MODEL_VERSION_TRANSITIONED_STAGE`: A model version’s stage was + // changed. + // - `TRANSITION_REQUEST_CREATED`: A user requested a model version’s + // stage be transitioned. + // - `COMMENT_CREATED`: A user wrote a comment on a registered model. + // - `REGISTERED_MODEL_CREATED`: A new registered model was created. This + // event type can only be specified for a registry-wide webhook, which + // can be created by not specifying a model name in the create request. + // - `MODEL_VERSION_TAG_SET`: A user set a tag on the model version. + // - `MODEL_VERSION_TRANSITIONED_TO_STAGING`: A model version was + // transitioned to staging. + // - `MODEL_VERSION_TRANSITIONED_TO_PRODUCTION`: A model version was + // transitioned to production. + // - `MODEL_VERSION_TRANSITIONED_TO_ARCHIVED`: A model version was + // archived. + // - `TRANSITION_REQUEST_TO_STAGING_CREATED`: A user requested a model + // version be transitioned to staging. + // - `TRANSITION_REQUEST_TO_PRODUCTION_CREATED`: A user requested a model + // version be transitioned to production. + // - `TRANSITION_REQUEST_TO_ARCHIVED_CREATED`: A user requested a model + // version be archived. Events []RegistryWebhookEvent `json:"events,omitempty"` HttpUrlSpec *HttpUrlSpecWithoutSecret `json:"http_url_spec,omitempty"` @@ -4052,13 +4014,12 @@ func (f *RegistryWebhookEvent) Type() string { } // Enable or disable triggering the webhook, or put the webhook into test mode. -// The default is `ACTIVE`: * `ACTIVE`: Webhook is triggered when an associated -// event happens. -// -// * `DISABLED`: Webhook is not triggered. +// The default is `ACTIVE`: // -// * `TEST_MODE`: Webhook can be triggered through the test endpoint, but is not -// triggered on a real event. +// - `ACTIVE`: Webhook is triggered when an associated event happens. +// - `DISABLED`: Webhook is not triggered. +// - `TEST_MODE`: Webhook can be triggered through the test endpoint, but is +// not triggered on a real event. type RegistryWebhookStatus string // Webhook is triggered when an associated event happens. @@ -4112,13 +4073,10 @@ type RejectTransitionRequest struct { Name string `json:"name"` // Target stage of the transition. Valid values are: // - // * `None`: The initial stage of a model version. - // - // * `Staging`: Staging or pre-production stage. - // - // * `Production`: Production stage. - // - // * `Archived`: Archived stage. + // - `None`: The initial stage of a model version. + // - `Staging`: Staging or pre-production stage. + // - `Production`: Production stage. + // - `Archived`: Archived stage. Stage string `json:"stage"` // Version of the model. Version string `json:"version"` @@ -4260,8 +4218,8 @@ type RunData struct { type RunInfo struct { // URI of the directory where artifacts should be uploaded. This can be a // local path (starting with "/"), or a distributed file system (DFS) path, - // like ``s3://bucket/directory`` or ``dbfs:/my/directory``. If not set, the - // local ``./mlruns`` directory is chosen. + // like `s3://bucket/directory` or `dbfs:/my/directory`. If not set, the + // local `./mlruns` directory is chosen. ArtifactUri string `json:"artifact_uri,omitempty"` // Unix timestamp of when the run ended in milliseconds. EndTime int64 `json:"end_time,omitempty"` @@ -4517,15 +4475,15 @@ func (s SearchLoggedModelsDataset) MarshalJSON() ([]byte, error) { type SearchLoggedModelsOrderBy struct { // Whether the search results order is ascending or not. Ascending bool `json:"ascending,omitempty"` - // If ``field_name`` refers to a metric, this field specifies the digest of + // If `field_name` refers to a metric, this field specifies the digest of // the dataset associated with the metric. Only metrics associated with the // specified dataset name and digest will be considered for ordering. This - // field may only be set if ``dataset_name`` is also set. + // field may only be set if `dataset_name` is also set. DatasetDigest string `json:"dataset_digest,omitempty"` - // If ``field_name`` refers to a metric, this field specifies the name of - // the dataset associated with the metric. Only metrics associated with the + // If `field_name` refers to a metric, this field specifies the name of the + // dataset associated with the metric. Only metrics associated with the // specified dataset name will be considered for ordering. This field may - // only be set if ``field_name`` refers to a metric. + // only be set if `field_name` refers to a metric. DatasetName string `json:"dataset_name,omitempty"` // The name of the field to order by, e.g. "metrics.accuracy". FieldName string `json:"field_name"` @@ -4555,7 +4513,7 @@ type SearchLoggedModelsRequest struct { // a subset of logged models. The syntax is a subset of SQL that supports // AND'ing together binary operations. // - // Example: ``params.alpha < 0.3 AND metrics.accuracy > 0.9``. + // Example: `params.alpha < 0.3 AND metrics.accuracy > 0.9`. Filter string `json:"filter,omitempty"` // The maximum number of Logged Models to return. The maximum limit is 50. MaxResults int `json:"max_results,omitempty"` @@ -4825,13 +4783,13 @@ type SlidingWindow struct { WindowDuration string `json:"window_duration"` } -// The status of the model version. Valid values are: * `PENDING_REGISTRATION`: -// Request to register a new model version is pending as server performs -// background tasks. +// The status of the model version. Valid values are: // -// * `FAILED_REGISTRATION`: Request to register a new model version has failed. -// -// * `READY`: Model version is ready for use. +// - `PENDING_REGISTRATION`: Request to register a new model version is +// pending as server performs background tasks. +// - `FAILED_REGISTRATION`: Request to register a new model version has +// failed. +// - `READY`: Model version is ready for use. type Status string // Request to register a new model version has failed. @@ -5130,13 +5088,10 @@ type TransitionModelVersionStageDatabricks struct { Name string `json:"name"` // Target stage of the transition. Valid values are: // - // * `None`: The initial stage of a model version. - // - // * `Staging`: Staging or pre-production stage. - // - // * `Production`: Production stage. - // - // * `Archived`: Archived stage. + // - `None`: The initial stage of a model version. + // - `Staging`: Staging or pre-production stage. + // - `Production`: Production stage. + // - `Archived`: Archived stage. Stage string `json:"stage"` // Version of the model. Version string `json:"version"` @@ -5166,13 +5121,10 @@ type TransitionRequest struct { // Target stage of the transition (if the activity is stage transition // related). Valid values are: // - // * `None`: The initial stage of a model version. - // - // * `Staging`: Staging or pre-production stage. - // - // * `Production`: Production stage. - // - // * `Archived`: Archived stage. + // - `None`: The initial stage of a model version. + // - `Staging`: Staging or pre-production stage. + // - `Production`: Production stage. + // - `Archived`: Archived stage. ToStage string `json:"to_stage,omitempty"` // The username of the user that created the object. UserId string `json:"user_id,omitempty"` @@ -5345,39 +5297,31 @@ type UpdateOnlineStoreRequest struct { type UpdateRegistryWebhook struct { // User-specified description for the webhook. Description string `json:"description,omitempty"` - // Events that can trigger a registry webhook: * `MODEL_VERSION_CREATED`: A - // new model version was created for the associated model. - // - // * `MODEL_VERSION_TRANSITIONED_STAGE`: A model version’s stage was - // changed. - // - // * `TRANSITION_REQUEST_CREATED`: A user requested a model version’s - // stage be transitioned. - // - // * `COMMENT_CREATED`: A user wrote a comment on a registered model. - // - // * `REGISTERED_MODEL_CREATED`: A new registered model was created. This - // event type can only be specified for a registry-wide webhook, which can - // be created by not specifying a model name in the create request. - // - // * `MODEL_VERSION_TAG_SET`: A user set a tag on the model version. - // - // * `MODEL_VERSION_TRANSITIONED_TO_STAGING`: A model version was - // transitioned to staging. - // - // * `MODEL_VERSION_TRANSITIONED_TO_PRODUCTION`: A model version was - // transitioned to production. - // - // * `MODEL_VERSION_TRANSITIONED_TO_ARCHIVED`: A model version was archived. - // - // * `TRANSITION_REQUEST_TO_STAGING_CREATED`: A user requested a model - // version be transitioned to staging. - // - // * `TRANSITION_REQUEST_TO_PRODUCTION_CREATED`: A user requested a model - // version be transitioned to production. + // Events that can trigger a registry webhook: // - // * `TRANSITION_REQUEST_TO_ARCHIVED_CREATED`: A user requested a model - // version be archived. + // - `MODEL_VERSION_CREATED`: A new model version was created for the + // associated model. + // - `MODEL_VERSION_TRANSITIONED_STAGE`: A model version’s stage was + // changed. + // - `TRANSITION_REQUEST_CREATED`: A user requested a model version’s + // stage be transitioned. + // - `COMMENT_CREATED`: A user wrote a comment on a registered model. + // - `REGISTERED_MODEL_CREATED`: A new registered model was created. This + // event type can only be specified for a registry-wide webhook, which + // can be created by not specifying a model name in the create request. + // - `MODEL_VERSION_TAG_SET`: A user set a tag on the model version. + // - `MODEL_VERSION_TRANSITIONED_TO_STAGING`: A model version was + // transitioned to staging. + // - `MODEL_VERSION_TRANSITIONED_TO_PRODUCTION`: A model version was + // transitioned to production. + // - `MODEL_VERSION_TRANSITIONED_TO_ARCHIVED`: A model version was + // archived. + // - `TRANSITION_REQUEST_TO_STAGING_CREATED`: A user requested a model + // version be transitioned to staging. + // - `TRANSITION_REQUEST_TO_PRODUCTION_CREATED`: A user requested a model + // version be transitioned to production. + // - `TRANSITION_REQUEST_TO_ARCHIVED_CREATED`: A user requested a model + // version be archived. Events []RegistryWebhookEvent `json:"events,omitempty"` HttpUrlSpec *HttpUrlSpec `json:"http_url_spec,omitempty"` diff --git a/service/oauth2/api.go b/service/oauth2/api.go index 79685232b..ae74525ef 100755 --- a/service/oauth2/api.go +++ b/service/oauth2/api.go @@ -64,32 +64,43 @@ func NewAccountFederationPolicy(client *client.DatabricksClient) *AccountFederat // account. // // Token federation is configured in your Databricks account using an account -// federation policy. An account federation policy specifies: * which IdP, or -// issuer, your Databricks account should accept tokens from * how to determine -// which Databricks user, or subject, a token is issued for +// federation policy. An account federation policy specifies: // -// To configure a federation policy, you provide the following: * The required -// token __issuer__, as specified in the “iss” claim of your tokens. The -// issuer is an https URL that identifies your IdP. * The allowed token -// __audiences__, as specified in the “aud” claim of your tokens. This -// identifier is intended to represent the recipient of the token. As long as -// the audience in the token matches at least one audience in the policy, the -// token is considered a match. If unspecified, the default value is your -// Databricks account id. * The __subject claim__, which indicates which token -// claim contains the Databricks username of the user the token was issued for. -// If unspecified, the default value is “sub”. * Optionally, the public keys -// used to validate the signature of your tokens, in JWKS format. If unspecified -// (recommended), Databricks automatically fetches the public keys from your -// issuer’s well known endpoint. Databricks strongly recommends relying on -// your issuer’s well known endpoint for discovering public keys. +// - which IdP, or issuer, your Databricks account should accept tokens from +// - how to determine which Databricks user, or subject, a token is issued for // -// An example federation policy is: ``` issuer: "https://idp.mycompany.com/oidc" -// audiences: ["databricks"] subject_claim: "sub" ``` +// To configure a federation policy, you provide the following: +// +// - The required token **issuer**, as specified in the “iss” claim of +// your tokens. The issuer is an https URL that identifies your IdP. +// - The allowed token **audiences**, as specified in the “aud” claim of +// your tokens. This identifier is intended to represent the recipient of +// the token. As long as the audience in the token matches at least one +// audience in the policy, the token is considered a match. If unspecified, +// the default value is your Databricks account id. +// - The **subject claim**, which indicates which token claim contains the +// Databricks username of the user the token was issued for. If unspecified, +// the default value is “sub”. +// - Optionally, the public keys used to validate the signature of your +// tokens, in JWKS format. If unspecified (recommended), Databricks +// automatically fetches the public keys from your issuer’s well known +// endpoint. Databricks strongly recommends relying on your issuer’s well +// known endpoint for discovering public keys. +// +// An example federation policy is: +// +// issuer: "https://idp.mycompany.com/oidc" +// audiences: ["databricks"] +// subject_claim: "sub" // // An example JWT token body that matches this policy and could be used to -// authenticate to Databricks as user `username@mycompany.com` is: ``` { "iss": -// "https://idp.mycompany.com/oidc", "aud": "databricks", "sub": -// "username@mycompany.com" } ``` +// authenticate to Databricks as user `username@mycompany.com` is: +// +// { +// "iss": "https://idp.mycompany.com/oidc", +// "aud": "databricks", +// "sub": "username@mycompany.com" +// } // // You may also need to configure your IdP to generate tokens for your users to // exchange with Databricks, if your users do not already have the ability to @@ -344,36 +355,47 @@ func NewServicePrincipalFederationPolicy(client *client.DatabricksClient) *Servi // // Workload identity federation is configured in your Databricks account using a // service principal federation policy. A service principal federation policy -// specifies: * which IdP, or issuer, the service principal is allowed to -// authenticate from * which workload identity, or subject, is allowed to -// authenticate as the Databricks service principal +// specifies: // -// To configure a federation policy, you provide the following: * The required -// token __issuer__, as specified in the “iss” claim of workload identity -// tokens. The issuer is an https URL that identifies the workload identity -// provider. * The required token __subject__, as specified in the “sub” -// claim of workload identity tokens. The subject uniquely identifies the -// workload in the workload runtime environment. * The allowed token -// __audiences__, as specified in the “aud” claim of workload identity -// tokens. The audience is intended to represent the recipient of the token. As -// long as the audience in the token matches at least one audience in the -// policy, the token is considered a match. If unspecified, the default value is -// your Databricks account id. * Optionally, the public keys used to validate -// the signature of the workload identity tokens, in JWKS format. If unspecified -// (recommended), Databricks automatically fetches the public keys from the -// issuer’s well known endpoint. Databricks strongly recommends relying on the -// issuer’s well known endpoint for discovering public keys. +// - which IdP, or issuer, the service principal is allowed to authenticate +// from +// - which workload identity, or subject, is allowed to authenticate as the +// Databricks service principal +// +// To configure a federation policy, you provide the following: +// +// - The required token **issuer**, as specified in the “iss” claim of +// workload identity tokens. The issuer is an https URL that identifies the +// workload identity provider. +// - The required token **subject**, as specified in the “sub” claim of +// workload identity tokens. The subject uniquely identifies the workload in +// the workload runtime environment. +// - The allowed token **audiences**, as specified in the “aud” claim of +// workload identity tokens. The audience is intended to represent the +// recipient of the token. As long as the audience in the token matches at +// least one audience in the policy, the token is considered a match. If +// unspecified, the default value is your Databricks account id. +// - Optionally, the public keys used to validate the signature of the +// workload identity tokens, in JWKS format. If unspecified (recommended), +// Databricks automatically fetches the public keys from the issuer’s well +// known endpoint. Databricks strongly recommends relying on the issuer’s +// well known endpoint for discovering public keys. // // An example service principal federation policy, for a Github Actions -// workload, is: ``` issuer: "https://token.actions.githubusercontent.com" -// audiences: ["https://github.com/my-github-org"] subject: -// "repo:my-github-org/my-repo:environment:prod" ``` +// workload, is: +// +// issuer: "https://token.actions.githubusercontent.com" +// audiences: ["https://github.com/my-github-org"] +// subject: "repo:my-github-org/my-repo:environment:prod" // // An example JWT token body that matches this policy and could be used to -// authenticate to Databricks is: ``` { "iss": -// "https://token.actions.githubusercontent.com", "aud": -// "https://github.com/my-github-org", "sub": -// "repo:my-github-org/my-repo:environment:prod" } ``` +// authenticate to Databricks is: +// +// { +// "iss": "https://token.actions.githubusercontent.com", +// "aud": "https://github.com/my-github-org", +// "sub": "repo:my-github-org/my-repo:environment:prod" +// } // // You may also need to configure the workload runtime to generate tokens for // your workloads. diff --git a/service/oauth2/interface.go b/service/oauth2/interface.go index dd27b4797..198d810b3 100755 --- a/service/oauth2/interface.go +++ b/service/oauth2/interface.go @@ -21,32 +21,43 @@ import ( // account. // // Token federation is configured in your Databricks account using an account -// federation policy. An account federation policy specifies: * which IdP, or -// issuer, your Databricks account should accept tokens from * how to determine -// which Databricks user, or subject, a token is issued for -// -// To configure a federation policy, you provide the following: * The required -// token __issuer__, as specified in the “iss” claim of your tokens. The -// issuer is an https URL that identifies your IdP. * The allowed token -// __audiences__, as specified in the “aud” claim of your tokens. This -// identifier is intended to represent the recipient of the token. As long as -// the audience in the token matches at least one audience in the policy, the -// token is considered a match. If unspecified, the default value is your -// Databricks account id. * The __subject claim__, which indicates which token -// claim contains the Databricks username of the user the token was issued for. -// If unspecified, the default value is “sub”. * Optionally, the public keys -// used to validate the signature of your tokens, in JWKS format. If unspecified -// (recommended), Databricks automatically fetches the public keys from your -// issuer’s well known endpoint. Databricks strongly recommends relying on -// your issuer’s well known endpoint for discovering public keys. -// -// An example federation policy is: ``` issuer: "https://idp.mycompany.com/oidc" -// audiences: ["databricks"] subject_claim: "sub" ``` +// federation policy. An account federation policy specifies: +// +// - which IdP, or issuer, your Databricks account should accept tokens from +// - how to determine which Databricks user, or subject, a token is issued for +// +// To configure a federation policy, you provide the following: +// +// - The required token **issuer**, as specified in the “iss” claim of +// your tokens. The issuer is an https URL that identifies your IdP. +// - The allowed token **audiences**, as specified in the “aud” claim of +// your tokens. This identifier is intended to represent the recipient of +// the token. As long as the audience in the token matches at least one +// audience in the policy, the token is considered a match. If unspecified, +// the default value is your Databricks account id. +// - The **subject claim**, which indicates which token claim contains the +// Databricks username of the user the token was issued for. If unspecified, +// the default value is “sub”. +// - Optionally, the public keys used to validate the signature of your +// tokens, in JWKS format. If unspecified (recommended), Databricks +// automatically fetches the public keys from your issuer’s well known +// endpoint. Databricks strongly recommends relying on your issuer’s well +// known endpoint for discovering public keys. +// +// An example federation policy is: +// +// issuer: "https://idp.mycompany.com/oidc" +// audiences: ["databricks"] +// subject_claim: "sub" // // An example JWT token body that matches this policy and could be used to -// authenticate to Databricks as user `username@mycompany.com` is: ``` { "iss": -// "https://idp.mycompany.com/oidc", "aud": "databricks", "sub": -// "username@mycompany.com" } ``` +// authenticate to Databricks as user `username@mycompany.com` is: +// +// { +// "iss": "https://idp.mycompany.com/oidc", +// "aud": "databricks", +// "sub": "username@mycompany.com" +// } // // You may also need to configure your IdP to generate tokens for your users to // exchange with Databricks, if your users do not already have the ability to @@ -164,36 +175,47 @@ type PublishedAppIntegrationService interface { // // Workload identity federation is configured in your Databricks account using a // service principal federation policy. A service principal federation policy -// specifies: * which IdP, or issuer, the service principal is allowed to -// authenticate from * which workload identity, or subject, is allowed to -// authenticate as the Databricks service principal -// -// To configure a federation policy, you provide the following: * The required -// token __issuer__, as specified in the “iss” claim of workload identity -// tokens. The issuer is an https URL that identifies the workload identity -// provider. * The required token __subject__, as specified in the “sub” -// claim of workload identity tokens. The subject uniquely identifies the -// workload in the workload runtime environment. * The allowed token -// __audiences__, as specified in the “aud” claim of workload identity -// tokens. The audience is intended to represent the recipient of the token. As -// long as the audience in the token matches at least one audience in the -// policy, the token is considered a match. If unspecified, the default value is -// your Databricks account id. * Optionally, the public keys used to validate -// the signature of the workload identity tokens, in JWKS format. If unspecified -// (recommended), Databricks automatically fetches the public keys from the -// issuer’s well known endpoint. Databricks strongly recommends relying on the -// issuer’s well known endpoint for discovering public keys. +// specifies: +// +// - which IdP, or issuer, the service principal is allowed to authenticate +// from +// - which workload identity, or subject, is allowed to authenticate as the +// Databricks service principal +// +// To configure a federation policy, you provide the following: +// +// - The required token **issuer**, as specified in the “iss” claim of +// workload identity tokens. The issuer is an https URL that identifies the +// workload identity provider. +// - The required token **subject**, as specified in the “sub” claim of +// workload identity tokens. The subject uniquely identifies the workload in +// the workload runtime environment. +// - The allowed token **audiences**, as specified in the “aud” claim of +// workload identity tokens. The audience is intended to represent the +// recipient of the token. As long as the audience in the token matches at +// least one audience in the policy, the token is considered a match. If +// unspecified, the default value is your Databricks account id. +// - Optionally, the public keys used to validate the signature of the +// workload identity tokens, in JWKS format. If unspecified (recommended), +// Databricks automatically fetches the public keys from the issuer’s well +// known endpoint. Databricks strongly recommends relying on the issuer’s +// well known endpoint for discovering public keys. // // An example service principal federation policy, for a Github Actions -// workload, is: ``` issuer: "https://token.actions.githubusercontent.com" -// audiences: ["https://github.com/my-github-org"] subject: -// "repo:my-github-org/my-repo:environment:prod" ``` +// workload, is: +// +// issuer: "https://token.actions.githubusercontent.com" +// audiences: ["https://github.com/my-github-org"] +// subject: "repo:my-github-org/my-repo:environment:prod" // // An example JWT token body that matches this policy and could be used to -// authenticate to Databricks is: ``` { "iss": -// "https://token.actions.githubusercontent.com", "aud": -// "https://github.com/my-github-org", "sub": -// "repo:my-github-org/my-repo:environment:prod" } ``` +// authenticate to Databricks is: +// +// { +// "iss": "https://token.actions.githubusercontent.com", +// "aud": "https://github.com/my-github-org", +// "sub": "repo:my-github-org/my-repo:environment:prod" +// } // // You may also need to configure the workload runtime to generate tokens for // your workloads. diff --git a/service/pipelines/api.go b/service/pipelines/api.go index 25754e9af..e4135ab40 100755 --- a/service/pipelines/api.go +++ b/service/pipelines/api.go @@ -34,7 +34,7 @@ type PipelinesInterface interface { WaitGetPipelineIdle(ctx context.Context, pipelineId string, timeout time.Duration, callback func(*GetPipelineResponse)) (*GetPipelineResponse, error) - // * Applies the current pipeline environment onto the pipeline compute. The + // Applies the current pipeline environment onto the pipeline compute. The // environment applied can be used by subsequent dev-mode updates. ApplyEnvironment(ctx context.Context, request ApplyEnvironmentRequest) (*ApplyEnvironmentRequestResponse, error) diff --git a/service/pipelines/interface.go b/service/pipelines/interface.go index 09f28ad7c..f5497cb42 100755 --- a/service/pipelines/interface.go +++ b/service/pipelines/interface.go @@ -25,7 +25,7 @@ import ( // Deprecated: Do not use this interface, it will be removed in a future version of the SDK. type PipelinesService interface { - // * Applies the current pipeline environment onto the pipeline compute. The + // Applies the current pipeline environment onto the pipeline compute. The // environment applied can be used by subsequent dev-mode updates. ApplyEnvironment(ctx context.Context, request ApplyEnvironmentRequest) (*ApplyEnvironmentRequestResponse, error) diff --git a/service/pipelines/model.go b/service/pipelines/model.go index 6a689d0a1..47d09a313 100755 --- a/service/pipelines/model.go +++ b/service/pipelines/model.go @@ -515,8 +515,9 @@ func (s DeletePipelineRequest) MarshalJSON() ([]byte, error) { return marshal.Marshal(s) } -// The deployment method that manages the pipeline: - BUNDLE: The pipeline is -// managed by a Databricks Asset Bundle. +// The deployment method that manages the pipeline: +// +// - BUNDLE: The pipeline is managed by a Databricks Asset Bundle. type DeploymentKind string const DeploymentKindBundle DeploymentKind = `BUNDLE` @@ -1314,10 +1315,13 @@ type IngestionPipelineDefinitionWorkdayReportParametersQueryKeyValue struct { // Key for the report parameter, can be a column name or other metadata Key string `json:"key,omitempty"` // Value for the report parameter. Possible values it can take are these sql - // functions: 1. coalesce(current_offset(), date("YYYY-MM-DD")) -> if - // current_offset() is null, then the passed date, else current_offset() 2. - // current_date() 3. date_sub(current_date(), x) -> subtract x (some - // non-negative integer) days from current date + // functions: + // + // 1. coalesce(current_offset(), date("YYYY-MM-DD")) -> if current_offset() + // is null, then the passed date, else current_offset() + // 2. current_date() + // 3. date_sub(current_date(), x) -> subtract x (some non-negative integer) + // days from current date Value string `json:"value,omitempty"` ForceSendFields []string `json:"-" url:"-"` @@ -1488,9 +1492,12 @@ func (s KafkaOptions) MarshalJSON() ([]byte, error) { type ListPipelineEventsRequest struct { // Criteria to select a subset of results, expressed using a SQL-like - // syntax. The supported filters are: 1. level='INFO' (or WARN or ERROR) 2. - // level in ('INFO', 'WARN') 3. id='[event-id]' 4. timestamp > 'TIMESTAMP' - // (or >=,<,<=,=) + // syntax. The supported filters are: + // + // 1. level='INFO' (or WARN or ERROR) + // 2. level in ('INFO', 'WARN') + // 3. id='[event-id]' + // 4. timestamp > 'TIMESTAMP' (or >=,<,<=,=) // // Composite expressions are supported, for example: level in ('ERROR', // 'WARN') AND timestamp> '2021-07-22T06:37:33.083Z' @@ -1545,10 +1552,11 @@ type ListPipelinesRequest struct { // Select a subset of results based on the specified criteria. The supported // filters are: // - // * `notebook=''` to select pipelines that reference the provided - // notebook path. * `name LIKE '[pattern]'` to select pipelines with a name - // that matches pattern. Wildcards are supported, for example: `name LIKE - // '%shopping%'` + // - `notebook=''` to select pipelines that reference the provided + // notebook path. + // - `name LIKE '[pattern]'` to select pipelines with a name that matches + // pattern. Wildcards are supported, for example: `name LIKE + // '%shopping%'` // // Composite filters are not supported. This field is optional. Filter string `json:"-" url:"filter,omitempty"` @@ -1738,10 +1746,11 @@ type Notifications struct { // A list of alerts that trigger the sending of notifications to the // configured destinations. The supported alerts are: // - // * `on-update-success`: A pipeline update completes successfully. * - // `on-update-failure`: Each time a pipeline update fails. * - // `on-update-fatal-failure`: A pipeline update fails with a non-retryable - // (fatal) error. * `on-flow-failure`: A single data flow fails. + // - `on-update-success`: A pipeline update completes successfully. + // - `on-update-failure`: Each time a pipeline update fails. + // - `on-update-fatal-failure`: A pipeline update fails with a + // non-retryable (fatal) error. + // - `on-flow-failure`: A single data flow fails. Alerts []string `json:"alerts,omitempty"` // A list of email addresses notified when a configured alert is triggered. EmailRecipients []string `json:"email_recipients,omitempty"` @@ -2053,10 +2062,9 @@ type PipelineCluster struct { // resources (e.g., AWS instances and EBS volumes) with these tags in // addition to `default_tags`. Notes: // - // - Currently, Databricks allows at most 45 custom tags - // - // - Clusters can only reuse cloud resources if the resources' tags are a - // subset of the cluster tags + // - Currently, Databricks allows at most 45 custom tags + // - Clusters can only reuse cloud resources if the resources' tags are a + // subset of the cluster tags CustomTags map[string]string `json:"custom_tags,omitempty"` // The optional ID of the instance pool for the driver of the cluster // belongs. The pool cluster uses the instance pool with id diff --git a/service/postgres/model.go b/service/postgres/model.go index 5a277a647..f591d9fe7 100755 --- a/service/postgres/model.go +++ b/service/postgres/model.go @@ -425,9 +425,10 @@ type CreateSyncedTableRequest struct { // // synced_table_id represents both of the following: // - // 1. An online VIEW virtual table in the Unity Catalog accessible via the - // Lakehouse Federation. 2. Postgres table named "{table}" in schema - // "{schema}" in the connected Postgres database + // 1. An online VIEW virtual table in the Unity Catalog accessible via the + // Lakehouse Federation. + // 2. Postgres table named "{table}" in schema "{schema}" in the connected + // Postgres database SyncedTableId string `json:"-" url:"synced_table_id"` } @@ -2029,21 +2030,24 @@ type RoleRoleSpec struct { // Controls how the Postgres role authenticates when a client opens a // database connection. Supported values: // - // * LAKEBASE_OAUTH_V1: the role authenticates by presenting a Databricks - // OAuth access token derived from the backing managed identity (the - // Databricks user, service principal, or group named by the role's - // `postgres_role`). No static password exists for roles using this method. - // * PG_PASSWORD_SCRAM_SHA_256: the role authenticates with a Postgres - // password verified server-side using the SCRAM-SHA-256 mechanism. Lakebase - // generates a password for the role. * NO_LOGIN: the role cannot open a - // Postgres session at all. Useful for roles that exist only to own objects - // or to aggregate privileges that are then granted to other, loginable - // roles. + // - LAKEBASE_OAUTH_V1: the role authenticates by presenting a Databricks + // OAuth access token derived from the backing managed identity (the + // Databricks user, service principal, or group named by the role's + // `postgres_role`). No static password exists for roles using this + // method. + // - PG_PASSWORD_SCRAM_SHA_256: the role authenticates with a Postgres + // password verified server-side using the SCRAM-SHA-256 mechanism. + // Lakebase generates a password for the role. + // - NO_LOGIN: the role cannot open a Postgres session at all. Useful for + // roles that exist only to own objects or to aggregate privileges that + // are then granted to other, loginable roles. // // If auth_method is left unspecified, a meaningful authentication method is - // derived from the identity_type: * For the managed identities, OAUTH is - // used. * For the regular postgres roles, authentication based on postgres - // passwords is used. + // derived from the identity_type: + // + // - For the managed identities, OAUTH is used. + // - For the regular postgres roles, authentication based on postgres + // passwords is used. // // NOTE: for the Databricks identity type GROUP, LAKEBASE_OAUTH_V1 is the // default auth method (group can login as well). @@ -2051,8 +2055,9 @@ type RoleRoleSpec struct { // The type of role. When specifying a managed-identity, the chosen role_id // must be a valid: // - // * application ID for SERVICE_PRINCIPAL * user email for USER * group name - // for GROUP + // - application ID for SERVICE_PRINCIPAL + // - user email for USER + // - group name for GROUP IdentityType RoleIdentityType `json:"identity_type,omitempty"` // An enum value for a standard role that this role is a member of. MembershipRoles []RoleMembershipRole `json:"membership_roles,omitempty"` @@ -2066,8 +2071,9 @@ type RoleRoleSpec struct { // If you wish to create a Postgres Role backed by a managed Databricks // 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 + // 1. user email for IdentityType.USER + // 2. app ID for IdentityType.SERVICE_PRINCIPAL + // 3. group name for IdentityType.GROUP PostgresRole string `json:"postgres_role,omitempty"` ForceSendFields []string `json:"-" url:"-"` @@ -2300,9 +2306,9 @@ type SyncedTableSyncedTableSpec struct { // // For the corresponding destination table, use any of the two: // - // * synced_table_id used at the creation of the SyncedTable * "name" - // consisting of "synced_tables/" prefix and the full name of the - // destination table. + // - synced_table_id used at the creation of the SyncedTable + // - "name" consisting of "synced_tables/" prefix and the full name of the + // destination table. SourceTableFullName string `json:"source_table_full_name,omitempty"` // Time series key to deduplicate (tie-break) rows with the same primary // key. diff --git a/service/provisioning/api.go b/service/provisioning/api.go index 85fb40103..28580186c 100755 --- a/service/provisioning/api.go +++ b/service/provisioning/api.go @@ -249,10 +249,11 @@ func NewEncryptionKeys(client *client.DatabricksClient) *EncryptionKeysAPI { // some information about how the key configuration can be used. There are two // possible uses for key configurations: // -// * Managed services: A key configuration can be used to encrypt a workspace's -// notebook and secret data in the control plane, as well as Databricks SQL -// queries and query history. * Storage: A key configuration can be used to -// encrypt a workspace's DBFS and EBS data in the data plane. +// - Managed services: A key configuration can be used to encrypt a +// workspace's notebook and secret data in the control plane, as well as +// Databricks SQL queries and query history. +// - Storage: A key configuration can be used to encrypt a workspace's DBFS +// and EBS data in the data plane. // // In both of these cases, the key configuration's ID is used when creating a // new workspace. This Preview feature is available if your account is on the E2 diff --git a/service/provisioning/interface.go b/service/provisioning/interface.go index 053f4ce7c..286ccd40c 100755 --- a/service/provisioning/interface.go +++ b/service/provisioning/interface.go @@ -50,10 +50,11 @@ type CredentialsService interface { // some information about how the key configuration can be used. There are two // possible uses for key configurations: // -// * Managed services: A key configuration can be used to encrypt a workspace's -// notebook and secret data in the control plane, as well as Databricks SQL -// queries and query history. * Storage: A key configuration can be used to -// encrypt a workspace's DBFS and EBS data in the data plane. +// - Managed services: A key configuration can be used to encrypt a +// workspace's notebook and secret data in the control plane, as well as +// Databricks SQL queries and query history. +// - Storage: A key configuration can be used to encrypt a workspace's DBFS +// and EBS data in the data plane. // // In both of these cases, the key configuration's ID is used when creating a // new workspace. This Preview feature is available if your account is on the E2 diff --git a/service/provisioning/model.go b/service/provisioning/model.go index b781e2b38..250392140 100755 --- a/service/provisioning/model.go +++ b/service/provisioning/model.go @@ -1105,7 +1105,6 @@ func (f *PrivateAccessLevel) Type() string { return "PrivateAccessLevel" } -// * type PrivateAccessSettings struct { // The Databricks account ID that hosts the private access settings. AccountId string `json:"account_id,omitempty"` @@ -1246,7 +1245,6 @@ func (s UpdateWorkspaceRequest) MarshalJSON() ([]byte, error) { return marshal.Marshal(s) } -// * type VpcEndpoint struct { // The Databricks account ID that hosts the VPC endpoint configuration. AccountId string `json:"account_id,omitempty"` diff --git a/service/serving/model.go b/service/serving/model.go index 12d44c9e8..ef457f8e4 100755 --- a/service/serving/model.go +++ b/service/serving/model.go @@ -1258,8 +1258,7 @@ type GoogleCloudVertexAiConfig struct { // key using one of the following fields: `private_key` or // `private_key_plaintext` // - // [Best practices for managing service account keys]: - // https://cloud.google.com/iam/docs/best-practices-for-managing-service-account-keys + // [Best practices for managing service account keys]: https://cloud.google.com/iam/docs/best-practices-for-managing-service-account-keys PrivateKey string `json:"private_key,omitempty"` // The private key for the service account which has access to the Google // Cloud Vertex AI Service provided as a plaintext secret. See [Best @@ -1268,8 +1267,7 @@ type GoogleCloudVertexAiConfig struct { // API key using one of the following fields: `private_key` or // `private_key_plaintext`. // - // [Best practices for managing service account keys]: - // https://cloud.google.com/iam/docs/best-practices-for-managing-service-account-keys + // [Best practices for managing service account keys]: https://cloud.google.com/iam/docs/best-practices-for-managing-service-account-keys PrivateKeyPlaintext string `json:"private_key_plaintext,omitempty"` // This is the Google Cloud project id that the service account is // associated with. @@ -1278,8 +1276,7 @@ type GoogleCloudVertexAiConfig struct { // regions] for more details. Some models are only available in specific // regions. // - // [supported regions]: - // https://cloud.google.com/vertex-ai/docs/general/locations + // [supported regions]: https://cloud.google.com/vertex-ai/docs/general/locations Region string `json:"region"` ForceSendFields []string `json:"-" url:"-"` @@ -1539,49 +1536,49 @@ type QueryEndpointInput struct { DataframeRecords []any `json:"dataframe_records,omitempty"` // Pandas Dataframe input in the split orientation. DataframeSplit *DataframeSplitInput `json:"dataframe_split,omitempty"` - // The extra parameters field used ONLY for __completions, chat,__ and - // __embeddings external & foundation model__ serving endpoints. This is a + // The extra parameters field used ONLY for **completions, chat,** and + // **embeddings external & foundation model** serving endpoints. This is a // map of strings and should only be used with other external/foundation // model query fields. ExtraParams map[string]string `json:"extra_params,omitempty"` - // The input string (or array of strings) field used ONLY for __embeddings - // external & foundation model__ serving endpoints and is the only field + // The input string (or array of strings) field used ONLY for **embeddings + // external & foundation model** serving endpoints and is the only field // (along with extra_params if needed) used by embeddings queries. Input any `json:"input,omitempty"` // Tensor-based input in columnar format. Inputs any `json:"inputs,omitempty"` // Tensor-based input in row format. Instances []any `json:"instances,omitempty"` - // The max tokens field used ONLY for __completions__ and __chat external & - // foundation model__ serving endpoints. This is an integer and should only + // The max tokens field used ONLY for **completions** and **chat external & + // foundation model** serving endpoints. This is an integer and should only // be used with other chat/completions query fields. MaxTokens int `json:"max_tokens,omitempty"` - // The messages field used ONLY for __chat external & foundation model__ + // The messages field used ONLY for **chat external & foundation model** // serving endpoints. This is an array of ChatMessage objects and should // only be used with other chat query fields. Messages []ChatMessage `json:"messages,omitempty"` - // The n (number of candidates) field used ONLY for __completions__ and - // __chat external & foundation model__ serving endpoints. This is an + // The n (number of candidates) field used ONLY for **completions** and + // **chat external & foundation model** serving endpoints. This is an // integer between 1 and 5 with a default of 1 and should only be used with // other chat/completions query fields. N int `json:"n,omitempty"` // The name of the serving endpoint. This field is required and is provided // via the path parameter. Name string `json:"-" url:"-"` - // The prompt string (or array of strings) field used ONLY for __completions - // external & foundation model__ serving endpoints and should only be used + // The prompt string (or array of strings) field used ONLY for **completions + // external & foundation model** serving endpoints and should only be used // with other completions query fields. Prompt any `json:"prompt,omitempty"` - // The stop sequences field used ONLY for __completions__ and __chat - // external & foundation model__ serving endpoints. This is a list of + // The stop sequences field used ONLY for **completions** and **chat + // external & foundation model** serving endpoints. This is a list of // strings and should only be used with other chat/completions query fields. Stop []string `json:"stop,omitempty"` - // The stream field used ONLY for __completions__ and __chat external & - // foundation model__ serving endpoints. This is a boolean defaulting to + // The stream field used ONLY for **completions** and **chat external & + // foundation model** serving endpoints. This is a boolean defaulting to // false and should only be used with other chat/completions query fields. Stream bool `json:"stream,omitempty"` - // The temperature field used ONLY for __completions__ and __chat external & - // foundation model__ serving endpoints. This is a float between 0.0 and 2.0 + // The temperature field used ONLY for **completions** and **chat external & + // foundation model** serving endpoints. This is a float between 0.0 and 2.0 // with a default of 1.0 and should only be used with other chat/completions // query fields. Temperature float64 `json:"temperature,omitempty"` @@ -1601,22 +1598,22 @@ func (s QueryEndpointInput) MarshalJSON() ([]byte, error) { } type QueryEndpointResponse struct { - // The list of choices returned by the __chat or completions - // external/foundation model__ serving endpoint. + // The list of choices returned by the **chat or completions + // external/foundation model** serving endpoint. Choices []V1ResponseChoiceElement `json:"choices,omitempty"` // The timestamp in seconds when the query was created in Unix time returned - // by a __completions or chat external/foundation model__ serving endpoint. + // by a **completions or chat external/foundation model** serving endpoint. Created int64 `json:"created,omitempty"` - // The list of the embeddings returned by the __embeddings - // external/foundation model__ serving endpoint. + // The list of the embeddings returned by the **embeddings + // external/foundation model** serving endpoint. Data []EmbeddingsV1ResponseEmbeddingElement `json:"data,omitempty"` - // The ID of the query that may be returned by a __completions or chat - // external/foundation model__ serving endpoint. + // The ID of the query that may be returned by a **completions or chat + // external/foundation model** serving endpoint. Id string `json:"id,omitempty"` - // The name of the __external/foundation model__ used for querying. This is + // The name of the **external/foundation model** used for querying. This is // the name of the model that was specified in the endpoint config. Model string `json:"model,omitempty"` - // The type of object returned by the __external/foundation model__ serving + // The type of object returned by the **external/foundation model** serving // endpoint, one of [text_completion, chat.completion, list (of // embeddings)]. Object QueryEndpointResponseObject `json:"object,omitempty"` @@ -1627,8 +1624,8 @@ type QueryEndpointResponse struct { // The name of the served model that served the request. This is useful when // there are multiple models behind the same endpoint with traffic split. ServedModelName string `json:"-" url:"-" header:"served-model-name,omitempty"` - // The usage object that may be returned by the __external/foundation - // model__ serving endpoint. This contains information about the number of + // The usage object that may be returned by the **external/foundation + // model** serving endpoint. This contains information about the number of // tokens used in the prompt and response. Usage *ExternalModelUsageElement `json:"usage,omitempty"` @@ -1643,7 +1640,7 @@ func (s QueryEndpointResponse) MarshalJSON() ([]byte, error) { return marshal.Marshal(s) } -// The type of object returned by the __external/foundation model__ serving +// The type of object returned by the **external/foundation model** serving // endpoint, one of [text_completion, chat.completion, list (of embeddings)]. type QueryEndpointResponseObject string @@ -2640,13 +2637,13 @@ type UpdateProvisionedThroughputEndpointConfigRequest struct { type V1ResponseChoiceElement struct { // The finish reason returned by the endpoint. FinishReason string `json:"finishReason,omitempty"` - // The index of the choice in the __chat or completions__ response. + // The index of the choice in the **chat or completions** response. Index int `json:"index,omitempty"` - // The logprobs returned only by the __completions__ endpoint. + // The logprobs returned only by the **completions** endpoint. Logprobs int `json:"logprobs,omitempty"` - // The message response from the __chat__ endpoint. + // The message response from the **chat** endpoint. Message *ChatMessage `json:"message,omitempty"` - // The text response from the __completions__ endpoint. + // The text response from the **completions** endpoint. Text string `json:"text,omitempty"` ForceSendFields []string `json:"-" url:"-"` diff --git a/service/settings/api.go b/service/settings/api.go index cdb963c6c..d95e1487d 100755 --- a/service/settings/api.go +++ b/service/settings/api.go @@ -21,11 +21,12 @@ type AccountIpAccessListsInterface interface { // // When creating or updating an IP access list: // - // * For all allow lists and block lists combined, the API supports a maximum of - // 1000 IP/CIDR values, where one CIDR counts as a single value. Attempts to - // exceed that number return error 400 with `error_code` value `QUOTA_EXCEEDED`. - // * If the new list would block the calling user's current IP, error 400 is - // returned with `error_code` value `INVALID_STATE`. + // - For all allow lists and block lists combined, the API supports a maximum + // of 1000 IP/CIDR values, where one CIDR counts as a single value. Attempts + // to exceed that number return error 400 with `error_code` value + // `QUOTA_EXCEEDED`. + // - If the new list would block the calling user's current IP, error 400 is + // returned with `error_code` value `INVALID_STATE`. // // It can take a few minutes for the changes to take effect. Create(ctx context.Context, request CreateIpAccessList) (*CreateIpAccessListResponse, error) @@ -74,12 +75,15 @@ type AccountIpAccessListsInterface interface { // // A list can include allow lists and block lists. See the top of this file for // a description of how the server treats allow lists and block lists at run - // time. When replacing an IP access list: * For all allow lists and block lists - // combined, the API supports a maximum of 1000 IP/CIDR values, where one CIDR - // counts as a single value. Attempts to exceed that number return error 400 - // with `error_code` value `QUOTA_EXCEEDED`. * If the resulting list would block - // the calling user's current IP, error 400 is returned with `error_code` value - // `INVALID_STATE`. It can take a few minutes for the changes to take effect. + // time. When replacing an IP access list: + // + // - For all allow lists and block lists combined, the API supports a maximum + // of 1000 IP/CIDR values, where one CIDR counts as a single value. Attempts + // to exceed that number return error 400 with `error_code` value + // `QUOTA_EXCEEDED`. + // - If the resulting list would block the calling user's current IP, error + // 400 is returned with `error_code` value `INVALID_STATE`. It can take a + // few minutes for the changes to take effect. Replace(ctx context.Context, request ReplaceIpAccessList) error // Updates an existing IP access list, specified by its ID. @@ -90,11 +94,12 @@ type AccountIpAccessListsInterface interface { // // When updating an IP access list: // - // * For all allow lists and block lists combined, the API supports a maximum of - // 1000 IP/CIDR values, where one CIDR counts as a single value. Attempts to - // exceed that number return error 400 with `error_code` value `QUOTA_EXCEEDED`. - // * If the updated list would block the calling user's current IP, error 400 is - // returned with `error_code` value `INVALID_STATE`. + // - For all allow lists and block lists combined, the API supports a maximum + // of 1000 IP/CIDR values, where one CIDR counts as a single value. Attempts + // to exceed that number return error 400 with `error_code` value + // `QUOTA_EXCEEDED`. + // - If the updated list would block the calling user's current IP, error 400 + // is returned with `error_code` value `INVALID_STATE`. // // It can take a few minutes for the changes to take effect. Update(ctx context.Context, request UpdateIpAccessList) error @@ -116,10 +121,12 @@ func NewAccountIpAccessLists(client *client.DatabricksClient) *AccountIpAccessLi // account, all access is allowed for this account. There is support for allow // lists (inclusion) and block lists (exclusion). // -// When a connection is attempted: 1. **First, all block lists are checked.** If -// the connection IP address matches any block list, the connection is rejected. -// 2. **If the connection was not rejected by block lists**, the IP address is -// compared with the allow lists. +// When a connection is attempted: +// +// 1. **First, all block lists are checked.** If the connection IP address +// matches any block list, the connection is rejected. +// 2. **If the connection was not rejected by block lists**, the IP address is +// compared with the allow lists. // // If there is at least one allow list for the account, the connection is // allowed only if the IP address matches an allow list. If there are no allow @@ -215,10 +222,12 @@ type AccountSettingsInterface interface { // Disable legacy features for new Databricks workspaces. // - // For newly created workspaces: 1. Disables the use of DBFS root and - // mounts. 2. Hive Metastore will not be provisioned. 3. Disables the use of - // ‘No-isolation clusters’. 4. Disables Databricks Runtime versions - // prior to 13.3LTS. + // For newly created workspaces: + // + // 1. Disables the use of DBFS root and mounts. + // 2. Hive Metastore will not be provisioned. + // 3. Disables the use of ‘No-isolation clusters’. + // 4. Disables Databricks Runtime versions prior to 13.3LTS. DisableLegacyFeatures() DisableLegacyFeaturesInterface // Controls the enforcement of IP access lists for accessing the account @@ -292,10 +301,12 @@ type AccountSettingsAPI struct { // Disable legacy features for new Databricks workspaces. // - // For newly created workspaces: 1. Disables the use of DBFS root and - // mounts. 2. Hive Metastore will not be provisioned. 3. Disables the use of - // ‘No-isolation clusters’. 4. Disables Databricks Runtime versions - // prior to 13.3LTS. + // For newly created workspaces: + // + // 1. Disables the use of DBFS root and mounts. + // 2. Hive Metastore will not be provisioned. + // 3. Disables the use of ‘No-isolation clusters’. + // 4. Disables Databricks Runtime versions prior to 13.3LTS. disableLegacyFeatures DisableLegacyFeaturesInterface // Controls the enforcement of IP access lists for accessing the account @@ -658,10 +669,10 @@ func NewDisableLegacyAccess(client *client.DatabricksClient) *DisableLegacyAcces // 'Disabling legacy access' has the following impacts: // -// 1. Disables direct access to Hive Metastores from the workspace. However, you -// can still access a Hive Metastore through Hive Metastore federation. 2. -// Disables fallback mode on external location access from the workspace. 3. -// Disables Databricks Runtime versions prior to 13.3LTS. +// 1. Disables direct access to Hive Metastores from the workspace. However, +// you can still access a Hive Metastore through Hive Metastore federation. +// 2. Disables fallback mode on external location access from the workspace. +// 3. Disables Databricks Runtime versions prior to 13.3LTS. type DisableLegacyAccessAPI struct { disableLegacyAccessImpl } @@ -689,8 +700,9 @@ func NewDisableLegacyDbfs(client *client.DatabricksClient) *DisableLegacyDbfsAPI // Disabling legacy DBFS has the following implications: // -// 1. Access to DBFS root and DBFS mounts is disallowed (as well as the creation -// of new mounts). 2. Disables Databricks Runtime versions prior to 13.3LTS. +// 1. Access to DBFS root and DBFS mounts is disallowed (as well as the +// creation of new mounts). +// 2. Disables Databricks Runtime versions prior to 13.3LTS. // // When the setting is off, all DBFS functionality is enabled and no // restrictions are imposed on Databricks Runtime versions. This setting can @@ -722,10 +734,12 @@ func NewDisableLegacyFeatures(client *client.DatabricksClient) *DisableLegacyFea // Disable legacy features for new Databricks workspaces. // -// For newly created workspaces: 1. Disables the use of DBFS root and mounts. 2. -// Hive Metastore will not be provisioned. 3. Disables the use of -// ‘No-isolation clusters’. 4. Disables Databricks Runtime versions prior to -// 13.3LTS. +// For newly created workspaces: +// +// 1. Disables the use of DBFS root and mounts. +// 2. Hive Metastore will not be provisioned. +// 3. Disables the use of ‘No-isolation clusters’. +// 4. Disables Databricks Runtime versions prior to 13.3LTS. type DisableLegacyFeaturesAPI struct { disableLegacyFeaturesImpl } @@ -900,11 +914,12 @@ type IpAccessListsInterface interface { // // When creating or updating an IP access list: // - // * For all allow lists and block lists combined, the API supports a maximum of - // 1000 IP/CIDR values, where one CIDR counts as a single value. Attempts to - // exceed that number return error 400 with `error_code` value `QUOTA_EXCEEDED`. - // * If the new list would block the calling user's current IP, error 400 is - // returned with `error_code` value `INVALID_STATE`. + // - For all allow lists and block lists combined, the API supports a maximum + // of 1000 IP/CIDR values, where one CIDR counts as a single value. Attempts + // to exceed that number return error 400 with `error_code` value + // `QUOTA_EXCEEDED`. + // - If the new list would block the calling user's current IP, error 400 is + // returned with `error_code` value `INVALID_STATE`. // // It can take a few minutes for the changes to take effect. **Note**: Your new // IP access list has no effect until you enable the feature. See @@ -955,14 +970,17 @@ type IpAccessListsInterface interface { // // A list can include allow lists and block lists. See the top of this file for // a description of how the server treats allow lists and block lists at run - // time. When replacing an IP access list: * For all allow lists and block lists - // combined, the API supports a maximum of 1000 IP/CIDR values, where one CIDR - // counts as a single value. Attempts to exceed that number return error 400 - // with `error_code` value `QUOTA_EXCEEDED`. * If the resulting list would block - // the calling user's current IP, error 400 is returned with `error_code` value - // `INVALID_STATE`. It can take a few minutes for the changes to take effect. - // Note that your resulting IP access list has no effect until you enable the - // feature. See :method:workspaceconf/setStatus. + // time. When replacing an IP access list: + // + // - For all allow lists and block lists combined, the API supports a maximum + // of 1000 IP/CIDR values, where one CIDR counts as a single value. Attempts + // to exceed that number return error 400 with `error_code` value + // `QUOTA_EXCEEDED`. + // - If the resulting list would block the calling user's current IP, error + // 400 is returned with `error_code` value `INVALID_STATE`. It can take a + // few minutes for the changes to take effect. Note that your resulting IP + // access list has no effect until you enable the feature. See + // :method:workspaceconf/setStatus. Replace(ctx context.Context, request ReplaceIpAccessList) error // Updates an existing IP access list, specified by its ID. @@ -973,11 +991,12 @@ type IpAccessListsInterface interface { // // When updating an IP access list: // - // * For all allow lists and block lists combined, the API supports a maximum of - // 1000 IP/CIDR values, where one CIDR counts as a single value. Attempts to - // exceed that number return error 400 with `error_code` value `QUOTA_EXCEEDED`. - // * If the updated list would block the calling user's current IP, error 400 is - // returned with `error_code` value `INVALID_STATE`. + // - For all allow lists and block lists combined, the API supports a maximum + // of 1000 IP/CIDR values, where one CIDR counts as a single value. Attempts + // to exceed that number return error 400 with `error_code` value + // `QUOTA_EXCEEDED`. + // - If the updated list would block the calling user's current IP, error 400 + // is returned with `error_code` value `INVALID_STATE`. // // It can take a few minutes for the changes to take effect. Note that your // resulting IP access list has no effect until you enable the feature. See @@ -1000,10 +1019,12 @@ func NewIpAccessLists(client *client.DatabricksClient) *IpAccessListsAPI { // allowed for this workspace. There is support for allow lists (inclusion) and // block lists (exclusion). // -// When a connection is attempted: 1. **First, all block lists are checked.** If -// the connection IP address matches any block list, the connection is rejected. -// 2. **If the connection was not rejected by block lists**, the IP address is -// compared with the allow lists. +// When a connection is attempted: +// +// 1. **First, all block lists are checked.** If the connection IP address +// matches any block list, the connection is rejected. +// 2. **If the connection was not rejected by block lists**, the IP address is +// compared with the allow lists. // // If there is at least one allow list for the workspace, the connection is // allowed only if the IP address matches an allow list. If there are no allow @@ -1570,17 +1591,19 @@ type SettingsInterface interface { // 'Disabling legacy access' has the following impacts: // - // 1. Disables direct access to Hive Metastores from the workspace. However, - // you can still access a Hive Metastore through Hive Metastore federation. - // 2. Disables fallback mode on external location access from the workspace. - // 3. Disables Databricks Runtime versions prior to 13.3LTS. + // 1. Disables direct access to Hive Metastores from the workspace. + // However, you can still access a Hive Metastore through Hive Metastore + // federation. + // 2. Disables fallback mode on external location access from the + // workspace. + // 3. Disables Databricks Runtime versions prior to 13.3LTS. DisableLegacyAccess() DisableLegacyAccessInterface // Disabling legacy DBFS has the following implications: // - // 1. Access to DBFS root and DBFS mounts is disallowed (as well as the - // creation of new mounts). 2. Disables Databricks Runtime versions prior to - // 13.3LTS. + // 1. Access to DBFS root and DBFS mounts is disallowed (as well as the + // creation of new mounts). + // 2. Disables Databricks Runtime versions prior to 13.3LTS. // // When the setting is off, all DBFS functionality is enabled and no // restrictions are imposed on Databricks Runtime versions. This setting can @@ -1727,17 +1750,19 @@ type SettingsAPI struct { // 'Disabling legacy access' has the following impacts: // - // 1. Disables direct access to Hive Metastores from the workspace. However, - // you can still access a Hive Metastore through Hive Metastore federation. - // 2. Disables fallback mode on external location access from the workspace. - // 3. Disables Databricks Runtime versions prior to 13.3LTS. + // 1. Disables direct access to Hive Metastores from the workspace. + // However, you can still access a Hive Metastore through Hive Metastore + // federation. + // 2. Disables fallback mode on external location access from the + // workspace. + // 3. Disables Databricks Runtime versions prior to 13.3LTS. disableLegacyAccess DisableLegacyAccessInterface // Disabling legacy DBFS has the following implications: // - // 1. Access to DBFS root and DBFS mounts is disallowed (as well as the - // creation of new mounts). 2. Disables Databricks Runtime versions prior to - // 13.3LTS. + // 1. Access to DBFS root and DBFS mounts is disallowed (as well as the + // creation of new mounts). + // 2. Disables Databricks Runtime versions prior to 13.3LTS. // // When the setting is off, all DBFS functionality is enabled and no // restrictions are imposed on Databricks Runtime versions. This setting can diff --git a/service/settings/interface.go b/service/settings/interface.go index 7df6cd29e..7749bdaa0 100755 --- a/service/settings/interface.go +++ b/service/settings/interface.go @@ -14,10 +14,12 @@ import ( // account, all access is allowed for this account. There is support for allow // lists (inclusion) and block lists (exclusion). // -// When a connection is attempted: 1. **First, all block lists are checked.** If -// the connection IP address matches any block list, the connection is rejected. -// 2. **If the connection was not rejected by block lists**, the IP address is -// compared with the allow lists. +// When a connection is attempted: +// +// 1. **First, all block lists are checked.** If the connection IP address +// matches any block list, the connection is rejected. +// 2. **If the connection was not rejected by block lists**, the IP address is +// compared with the allow lists. // // If there is at least one allow list for the account, the connection is // allowed only if the IP address matches an allow list. If there are no allow @@ -40,12 +42,12 @@ type AccountIpAccessListsService interface { // // When creating or updating an IP access list: // - // * For all allow lists and block lists combined, the API supports a - // maximum of 1000 IP/CIDR values, where one CIDR counts as a single value. - // Attempts to exceed that number return error 400 with `error_code` value - // `QUOTA_EXCEEDED`. * If the new list would block the calling user's - // current IP, error 400 is returned with `error_code` value - // `INVALID_STATE`. + // - For all allow lists and block lists combined, the API supports a + // maximum of 1000 IP/CIDR values, where one CIDR counts as a single + // value. Attempts to exceed that number return error 400 with + // `error_code` value `QUOTA_EXCEEDED`. + // - If the new list would block the calling user's current IP, error 400 + // is returned with `error_code` value `INVALID_STATE`. // // It can take a few minutes for the changes to take effect. Create(ctx context.Context, request CreateIpAccessList) (*CreateIpAccessListResponse, error) @@ -63,13 +65,15 @@ type AccountIpAccessListsService interface { // // A list can include allow lists and block lists. See the top of this file // for a description of how the server treats allow lists and block lists at - // run time. When replacing an IP access list: * For all allow lists and - // block lists combined, the API supports a maximum of 1000 IP/CIDR values, - // where one CIDR counts as a single value. Attempts to exceed that number - // return error 400 with `error_code` value `QUOTA_EXCEEDED`. * If the - // resulting list would block the calling user's current IP, error 400 is - // returned with `error_code` value `INVALID_STATE`. It can take a few - // minutes for the changes to take effect. + // run time. When replacing an IP access list: + // + // - For all allow lists and block lists combined, the API supports a + // maximum of 1000 IP/CIDR values, where one CIDR counts as a single + // value. Attempts to exceed that number return error 400 with + // `error_code` value `QUOTA_EXCEEDED`. + // - If the resulting list would block the calling user's current IP, + // error 400 is returned with `error_code` value `INVALID_STATE`. It can + // take a few minutes for the changes to take effect. Replace(ctx context.Context, request ReplaceIpAccessList) error // Updates an existing IP access list, specified by its ID. @@ -80,12 +84,12 @@ type AccountIpAccessListsService interface { // // When updating an IP access list: // - // * For all allow lists and block lists combined, the API supports a - // maximum of 1000 IP/CIDR values, where one CIDR counts as a single value. - // Attempts to exceed that number return error 400 with `error_code` value - // `QUOTA_EXCEEDED`. * If the updated list would block the calling user's - // current IP, error 400 is returned with `error_code` value - // `INVALID_STATE`. + // - For all allow lists and block lists combined, the API supports a + // maximum of 1000 IP/CIDR values, where one CIDR counts as a single + // value. Attempts to exceed that number return error 400 with + // `error_code` value `QUOTA_EXCEEDED`. + // - If the updated list would block the calling user's current IP, error + // 400 is returned with `error_code` value `INVALID_STATE`. // // It can take a few minutes for the changes to take effect. Update(ctx context.Context, request UpdateIpAccessList) error @@ -291,10 +295,10 @@ type DefaultWarehouseIdService interface { // 'Disabling legacy access' has the following impacts: // -// 1. Disables direct access to Hive Metastores from the workspace. However, you -// can still access a Hive Metastore through Hive Metastore federation. 2. -// Disables fallback mode on external location access from the workspace. 3. -// Disables Databricks Runtime versions prior to 13.3LTS. +// 1. Disables direct access to Hive Metastores from the workspace. However, +// you can still access a Hive Metastore through Hive Metastore federation. +// 2. Disables fallback mode on external location access from the workspace. +// 3. Disables Databricks Runtime versions prior to 13.3LTS. // // Deprecated: Do not use this interface, it will be removed in a future version of the SDK. type DisableLegacyAccessService interface { @@ -311,8 +315,9 @@ type DisableLegacyAccessService interface { // Disabling legacy DBFS has the following implications: // -// 1. Access to DBFS root and DBFS mounts is disallowed (as well as the creation -// of new mounts). 2. Disables Databricks Runtime versions prior to 13.3LTS. +// 1. Access to DBFS root and DBFS mounts is disallowed (as well as the +// creation of new mounts). +// 2. Disables Databricks Runtime versions prior to 13.3LTS. // // When the setting is off, all DBFS functionality is enabled and no // restrictions are imposed on Databricks Runtime versions. This setting can @@ -335,10 +340,12 @@ type DisableLegacyDbfsService interface { // Disable legacy features for new Databricks workspaces. // -// For newly created workspaces: 1. Disables the use of DBFS root and mounts. 2. -// Hive Metastore will not be provisioned. 3. Disables the use of -// ‘No-isolation clusters’. 4. Disables Databricks Runtime versions prior to -// 13.3LTS. +// For newly created workspaces: +// +// 1. Disables the use of DBFS root and mounts. +// 2. Hive Metastore will not be provisioned. +// 3. Disables the use of ‘No-isolation clusters’. +// 4. Disables Databricks Runtime versions prior to 13.3LTS. // // Deprecated: Do not use this interface, it will be removed in a future version of the SDK. type DisableLegacyFeaturesService interface { @@ -462,10 +469,12 @@ type EsmEnablementAccountService interface { // allowed for this workspace. There is support for allow lists (inclusion) and // block lists (exclusion). // -// When a connection is attempted: 1. **First, all block lists are checked.** If -// the connection IP address matches any block list, the connection is rejected. -// 2. **If the connection was not rejected by block lists**, the IP address is -// compared with the allow lists. +// When a connection is attempted: +// +// 1. **First, all block lists are checked.** If the connection IP address +// matches any block list, the connection is rejected. +// 2. **If the connection was not rejected by block lists**, the IP address is +// compared with the allow lists. // // If there is at least one allow list for the workspace, the connection is // allowed only if the IP address matches an allow list. If there are no allow @@ -488,12 +497,12 @@ type IpAccessListsService interface { // // When creating or updating an IP access list: // - // * For all allow lists and block lists combined, the API supports a - // maximum of 1000 IP/CIDR values, where one CIDR counts as a single value. - // Attempts to exceed that number return error 400 with `error_code` value - // `QUOTA_EXCEEDED`. * If the new list would block the calling user's - // current IP, error 400 is returned with `error_code` value - // `INVALID_STATE`. + // - For all allow lists and block lists combined, the API supports a + // maximum of 1000 IP/CIDR values, where one CIDR counts as a single + // value. Attempts to exceed that number return error 400 with + // `error_code` value `QUOTA_EXCEEDED`. + // - If the new list would block the calling user's current IP, error 400 + // is returned with `error_code` value `INVALID_STATE`. // // It can take a few minutes for the changes to take effect. **Note**: Your // new IP access list has no effect until you enable the feature. See @@ -513,15 +522,17 @@ type IpAccessListsService interface { // // A list can include allow lists and block lists. See the top of this file // for a description of how the server treats allow lists and block lists at - // run time. When replacing an IP access list: * For all allow lists and - // block lists combined, the API supports a maximum of 1000 IP/CIDR values, - // where one CIDR counts as a single value. Attempts to exceed that number - // return error 400 with `error_code` value `QUOTA_EXCEEDED`. * If the - // resulting list would block the calling user's current IP, error 400 is - // returned with `error_code` value `INVALID_STATE`. It can take a few - // minutes for the changes to take effect. Note that your resulting IP - // access list has no effect until you enable the feature. See - // :method:workspaceconf/setStatus. + // run time. When replacing an IP access list: + // + // - For all allow lists and block lists combined, the API supports a + // maximum of 1000 IP/CIDR values, where one CIDR counts as a single + // value. Attempts to exceed that number return error 400 with + // `error_code` value `QUOTA_EXCEEDED`. + // - If the resulting list would block the calling user's current IP, + // error 400 is returned with `error_code` value `INVALID_STATE`. It can + // take a few minutes for the changes to take effect. Note that your + // resulting IP access list has no effect until you enable the feature. + // See :method:workspaceconf/setStatus. Replace(ctx context.Context, request ReplaceIpAccessList) error // Updates an existing IP access list, specified by its ID. @@ -532,12 +543,12 @@ type IpAccessListsService interface { // // When updating an IP access list: // - // * For all allow lists and block lists combined, the API supports a - // maximum of 1000 IP/CIDR values, where one CIDR counts as a single value. - // Attempts to exceed that number return error 400 with `error_code` value - // `QUOTA_EXCEEDED`. * If the updated list would block the calling user's - // current IP, error 400 is returned with `error_code` value - // `INVALID_STATE`. + // - For all allow lists and block lists combined, the API supports a + // maximum of 1000 IP/CIDR values, where one CIDR counts as a single + // value. Attempts to exceed that number return error 400 with + // `error_code` value `QUOTA_EXCEEDED`. + // - If the updated list would block the calling user's current IP, error + // 400 is returned with `error_code` value `INVALID_STATE`. // // It can take a few minutes for the changes to take effect. Note that your // resulting IP access list has no effect until you enable the feature. See diff --git a/service/settings/model.go b/service/settings/model.go index 7604ad1aa..272494458 100755 --- a/service/settings/model.go +++ b/service/settings/model.go @@ -1312,14 +1312,17 @@ type CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRule struct { // The current status of this private endpoint. The private endpoint rules // are effective only if the connection state is ESTABLISHED. Remember that // you must approve new endpoints on your resources in the AWS console - // before they take effect. The possible values are: - PENDING: The endpoint - // has been created and pending approval. - ESTABLISHED: The endpoint has - // been approved and is ready to use in your serverless compute resources. - - // REJECTED: Connection was rejected by the private link resource owner. - - // DISCONNECTED: Connection was removed by the private link resource owner, - // the private endpoint becomes informative and should be deleted for - // clean-up. - EXPIRED: If the endpoint is created but not approved in 14 - // days, it is EXPIRED. + // before they take effect. The possible values are: + // + // - PENDING: The endpoint has been created and pending approval. + // - ESTABLISHED: The endpoint has been approved and is ready to use in + // your serverless compute resources. + // - REJECTED: Connection was rejected by the private link resource owner. + // - DISCONNECTED: Connection was removed by the private link resource + // owner, the private endpoint becomes informative and should be deleted + // for clean-up. + // - EXPIRED: If the endpoint is created but not approved in 14 days, it + // is EXPIRED. ConnectionState CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRulePrivateLinkConnectionState `json:"connection_state,omitempty"` // Time in epoch milliseconds when this object was created. CreationTime int64 `json:"creation_time,omitempty"` @@ -3688,9 +3691,9 @@ type ListTokensResponse struct { // Type of IP access list. Valid values are as follows and are case-sensitive: // -// * `ALLOW`: An allow list. Include this IP or range. * `BLOCK`: A block list. -// Exclude this IP or range. IP addresses in the block list are excluded even if -// they are included in an allow list. +// - `ALLOW`: An allow list. Include this IP or range. +// - `BLOCK`: A block list. Exclude this IP or range. IP addresses in the +// block list are excluded even if they are included in an allow list. type ListType string // An allow list. Include this IP or range. @@ -3862,15 +3865,19 @@ type NccAzurePrivateEndpointRule struct { // The current status of this private endpoint. The private endpoint rules // are effective only if the connection state is ESTABLISHED. Remember that // you must approve new endpoints on your resources in the Azure portal - // before they take effect. The possible values are: - INIT: (deprecated) - // The endpoint has been created and pending approval. - PENDING: The - // endpoint has been created and pending approval. - ESTABLISHED: The - // endpoint has been approved and is ready to use in your serverless compute - // resources. - REJECTED: Connection was rejected by the private link - // resource owner. - DISCONNECTED: Connection was removed by the private - // link resource owner, the private endpoint becomes informative and should - // be deleted for clean-up. - EXPIRED: If the endpoint was created but not - // approved in 14 days, it will be EXPIRED. + // before they take effect. The possible values are: + // + // - INIT: (deprecated) The endpoint has been created and pending + // approval. + // - PENDING: The endpoint has been created and pending approval. + // - ESTABLISHED: The endpoint has been approved and is ready to use in + // your serverless compute resources. + // - REJECTED: Connection was rejected by the private link resource owner. + // - DISCONNECTED: Connection was removed by the private link resource + // owner, the private endpoint becomes informative and should be deleted + // for clean-up. + // - EXPIRED: If the endpoint was created but not approved in 14 days, it + // will be EXPIRED. ConnectionState NccAzurePrivateEndpointRuleConnectionState `json:"connection_state,omitempty"` // Time in epoch milliseconds when this object was created. CreationTime int64 `json:"creation_time,omitempty"` @@ -4028,17 +4035,21 @@ type NccPrivateEndpointRule struct { // The current status of this private endpoint. The private endpoint rules // are effective only if the connection state is ESTABLISHED. Remember that // you must approve new endpoints on your resources in the Cloud console - // before they take effect. The possible values are: - PENDING: The endpoint - // has been created and pending approval. - ESTABLISHED: The endpoint has - // been approved and is ready to use in your serverless compute resources. - - // REJECTED: Connection was rejected by the private link resource owner. - - // DISCONNECTED: Connection was removed by the private link resource owner, - // the private endpoint becomes informative and should be deleted for - // clean-up. - EXPIRED: If the endpoint was created but not approved in 14 - // days, it will be EXPIRED. - CREATING: The endpoint creation is in - // progress. Once successfully created, the state will transition to - // PENDING. - CREATE_FAILED: The endpoint creation failed. You can check the - // error_message field for more details. + // before they take effect. The possible values are: + // + // - PENDING: The endpoint has been created and pending approval. + // - ESTABLISHED: The endpoint has been approved and is ready to use in + // your serverless compute resources. + // - REJECTED: Connection was rejected by the private link resource owner. + // - DISCONNECTED: Connection was removed by the private link resource + // owner, the private endpoint becomes informative and should be deleted + // for clean-up. + // - EXPIRED: If the endpoint was created but not approved in 14 days, it + // will be EXPIRED. + // - CREATING: The endpoint creation is in progress. Once successfully + // created, the state will transition to PENDING. + // - CREATE_FAILED: The endpoint creation failed. You can check the + // error_message field for more details. ConnectionState NccPrivateEndpointRulePrivateLinkConnectionState `json:"connection_state,omitempty"` // Time in epoch milliseconds when this object was created. CreationTime int64 `json:"creation_time,omitempty"` diff --git a/service/sharing/api.go b/service/sharing/api.go index 1c495bc82..7a7940b86 100644 --- a/service/sharing/api.go +++ b/service/sharing/api.go @@ -75,21 +75,24 @@ type ProvidersInterface interface { // Gets an array of a specified provider's shares within the metastore where: // - // * the caller is a metastore admin, or * the caller is the owner. + // - the caller is a metastore admin, or + // - the caller is the owner. // // This method is generated by Databricks SDK Code Generator. ListShares(ctx context.Context, request ListSharesRequest) listing.Iterator[ProviderShare] // Gets an array of a specified provider's shares within the metastore where: // - // * the caller is a metastore admin, or * the caller is the owner. + // - the caller is a metastore admin, or + // - the caller is the owner. // // This method is generated by Databricks SDK Code Generator. ListSharesAll(ctx context.Context, request ListSharesRequest) ([]ProviderShare, error) // Gets an array of a specified provider's shares within the metastore where: // - // * the caller is a metastore admin, or * the caller is the owner. + // - the caller is a metastore admin, or + // - the caller is the owner. ListSharesByName(ctx context.Context, name string) (*ListProviderSharesResponse, error) // Updates the information for an authentication provider, if the caller is a @@ -167,7 +170,8 @@ func (a *ProvidersAPI) ListProviderShareAssetsByProviderNameAndShareName(ctx con // Gets an array of a specified provider's shares within the metastore where: // -// * the caller is a metastore admin, or * the caller is the owner. +// - the caller is a metastore admin, or +// - the caller is the owner. func (a *ProvidersAPI) ListSharesByName(ctx context.Context, name string) (*ListProviderSharesResponse, error) { return a.providersImpl.internalListShares(ctx, ListSharesRequest{ Name: name, @@ -238,24 +242,29 @@ type RecipientFederationPoliciesInterface interface { // defined at the recipient level. This enables secretless sharing clients to // authenticate using OIDC tokens. // - // Supported scenarios for federation policies: 1. **User-to-Machine (U2M) - // flow** (e.g., PowerBI): A user accesses a resource using their own identity. - // 2. **Machine-to-Machine (M2M) flow** (e.g., OAuth App): An OAuth App accesses - // a resource using its own identity, typically for tasks like running nightly - // jobs. - // - // For an overview, refer to: - Blog post: Overview of feature: - // https://www.databricks.com/blog/announcing-oidc-token-federation-enhanced-delta-sharing-security - // - // For detailed configuration guides based on your use case: - Creating a - // Federation Policy as a provider: - // https://docs.databricks.com/en/delta-sharing/create-recipient-oidc-fed - - // Configuration and usage for Machine-to-Machine (M2M) applications (e.g., - // Python Delta Sharing Client): - // https://docs.databricks.com/aws/en/delta-sharing/sharing-over-oidc-m2m - - // Configuration and usage for User-to-Machine (U2M) applications (e.g., - // PowerBI): - // https://docs.databricks.com/aws/en/delta-sharing/sharing-over-oidc-u2m + // Supported scenarios for federation policies: + // + // 1. **User-to-Machine (U2M) flow** (e.g., PowerBI): A user accesses a + // resource using their own identity. + // 2. **Machine-to-Machine (M2M) flow** (e.g., OAuth App): An OAuth App + // accesses a resource using its own identity, typically for tasks like + // running nightly jobs. + // + // For an overview, refer to: + // + // - Blog post: Overview of feature: + // https://www.databricks.com/blog/announcing-oidc-token-federation-enhanced-delta-sharing-security + // + // For detailed configuration guides based on your use case: + // + // - Creating a Federation Policy as a provider: + // https://docs.databricks.com/en/delta-sharing/create-recipient-oidc-fed + // - Configuration and usage for Machine-to-Machine (M2M) applications (e.g., + // Python Delta Sharing Client): + // https://docs.databricks.com/aws/en/delta-sharing/sharing-over-oidc-m2m + // - Configuration and usage for User-to-Machine (U2M) applications (e.g., + // PowerBI): + // https://docs.databricks.com/aws/en/delta-sharing/sharing-over-oidc-u2m Create(ctx context.Context, request CreateFederationPolicyRequest) (*FederationPolicy, error) // Deletes an existing federation policy for an OIDC_FEDERATION recipient. The @@ -315,16 +324,18 @@ func NewRecipientFederationPolicies(client *client.DatabricksClient) *RecipientF // recipients authenticate using OIDC tokens. It validates the OIDC claims in // federated tokens and is set at the recipient level. The caller must be the // owner of the recipient to create or manage a federation policy. Federation -// policies support the following scenarios: - User-to-Machine (U2M) flow: A -// user accesses Delta Shares using their own identity, such as connecting -// through PowerBI Delta Sharing Client. - Machine-to-Machine (M2M) flow: An -// application accesses Delta Shares using its own identity, typically for -// automation tasks like nightly jobs through Python Delta Sharing Client. OIDC -// Token Federation enables fine-grained access control, supports Multi-Factor -// Authentication (MFA), and enhances security by minimizing the risk of -// credential leakage through the use of short-lived, expiring tokens. It is -// designed for strong identity governance, secure cross-platform data sharing, -// and reduced operational overhead for credential management. +// policies support the following scenarios: +// +// - User-to-Machine (U2M) flow: A user accesses Delta Shares using their own +// identity, such as connecting through PowerBI Delta Sharing Client. +// - Machine-to-Machine (M2M) flow: An application accesses Delta Shares using +// its own identity, typically for automation tasks like nightly jobs +// through Python Delta Sharing Client. OIDC Token Federation enables +// fine-grained access control, supports Multi-Factor Authentication (MFA), +// and enhances security by minimizing the risk of credential leakage +// through the use of short-lived, expiring tokens. It is designed for +// strong identity governance, secure cross-platform data sharing, and +// reduced operational overhead for credential management. // // For more information, see // https://www.databricks.com/blog/announcing-oidc-token-federation-enhanced-delta-sharing-security @@ -376,28 +387,34 @@ type RecipientsInterface interface { // owner of the recipient. DeleteByName(ctx context.Context, name string) error - // Gets a share recipient from the metastore. The caller must be one of: * A - // user with **USE_RECIPIENT** privilege on the metastore * The owner of the - // share recipient * A metastore admin + // Gets a share recipient from the metastore. The caller must be one of: + // + // - A user with **USE_RECIPIENT** privilege on the metastore + // - The owner of the share recipient + // - A metastore admin Get(ctx context.Context, request GetRecipientRequest) (*RecipientInfo, error) - // Gets a share recipient from the metastore. The caller must be one of: * A - // user with **USE_RECIPIENT** privilege on the metastore * The owner of the - // share recipient * A metastore admin + // Gets a share recipient from the metastore. The caller must be one of: + // + // - A user with **USE_RECIPIENT** privilege on the metastore + // - The owner of the share recipient + // - A metastore admin GetByName(ctx context.Context, name string) (*RecipientInfo, error) // Gets an array of all share recipients within the current metastore where: // - // * the caller is a metastore admin, or * the caller is the owner. There is no - // guarantee of a specific ordering of the elements in the array. + // - the caller is a metastore admin, or + // - the caller is the owner. There is no guarantee of a specific ordering of + // the elements in the array. // // This method is generated by Databricks SDK Code Generator. List(ctx context.Context, request ListRecipientsRequest) listing.Iterator[RecipientInfo] // Gets an array of all share recipients within the current metastore where: // - // * the caller is a metastore admin, or * the caller is the owner. There is no - // guarantee of a specific ordering of the elements in the array. + // - the caller is a metastore admin, or + // - the caller is the owner. There is no guarantee of a specific ordering of + // the elements in the array. // // This method is generated by Databricks SDK Code Generator. ListAll(ctx context.Context, request ListRecipientsRequest) ([]RecipientInfo, error) @@ -436,18 +453,17 @@ func NewRecipients(client *client.DatabricksClient) *RecipientsAPI { // sharing works differs depending on whether or not your recipient has access // to a Databricks workspace that is enabled for Unity Catalog: // -// - For recipients with access to a Databricks workspace that is enabled for -// Unity Catalog, you can create a recipient object along with a unique sharing -// identifier you get from the recipient. The sharing identifier is the key -// identifier that enables the secure connection. This sharing mode is called -// **Databricks-to-Databricks sharing**. -// -// - For recipients without access to a Databricks workspace that is enabled for -// Unity Catalog, when you create a recipient object, Databricks generates an -// activation link you can send to the recipient. The recipient follows the -// activation link to download the credential file, and then uses the credential -// file to establish a secure connection to receive the shared data. This -// sharing mode is called **open sharing**. +// - For recipients with access to a Databricks workspace that is enabled for +// Unity Catalog, you can create a recipient object along with a unique +// sharing identifier you get from the recipient. The sharing identifier is +// the key identifier that enables the secure connection. This sharing mode +// is called **Databricks-to-Databricks sharing**. +// - For recipients without access to a Databricks workspace that is enabled +// for Unity Catalog, when you create a recipient object, Databricks +// generates an activation link you can send to the recipient. The recipient +// follows the activation link to download the credential file, and then +// uses the credential file to establish a secure connection to receive the +// shared data. This sharing mode is called **open sharing**. type RecipientsAPI struct { recipientsImpl } @@ -460,9 +476,11 @@ func (a *RecipientsAPI) DeleteByName(ctx context.Context, name string) error { }) } -// Gets a share recipient from the metastore. The caller must be one of: * A -// user with **USE_RECIPIENT** privilege on the metastore * The owner of the -// share recipient * A metastore admin +// Gets a share recipient from the metastore. The caller must be one of: +// +// - A user with **USE_RECIPIENT** privilege on the metastore +// - The owner of the share recipient +// - A metastore admin func (a *RecipientsAPI) GetByName(ctx context.Context, name string) (*RecipientInfo, error) { return a.recipientsImpl.Get(ctx, GetRecipientRequest{ Name: name, @@ -529,13 +547,13 @@ type SharesInterface interface { // Updates the share with the changes and data objects in the request. The // caller must be the owner of the share or a metastore admin. // - // When the caller is a metastore admin, only the __owner__ field can be + // When the caller is a metastore admin, only the **owner** field can be // updated. // // In the case the share name is changed, **updateShare** requires that the // caller is the owner of the share and has the CREATE_SHARE privilege. // - // If there are notebook files in the share, the __storage_root__ field cannot + // If there are notebook files in the share, the **storage_root** field cannot // be updated. // // For each table that is added through this method, the share owner must also diff --git a/service/sharing/impl.go b/service/sharing/impl.go index 4734bc2ac..c0d981237 100644 --- a/service/sharing/impl.go +++ b/service/sharing/impl.go @@ -131,7 +131,8 @@ func (a *providersImpl) ListProviderShareAssets(ctx context.Context, request Lis // Gets an array of a specified provider's shares within the metastore where: // -// * the caller is a metastore admin, or * the caller is the owner. +// - the caller is a metastore admin, or +// - the caller is the owner. func (a *providersImpl) ListShares(ctx context.Context, request ListSharesRequest) listing.Iterator[ProviderShare] { request.ForceSendFields = append(request.ForceSendFields, "MaxResults") @@ -160,7 +161,8 @@ func (a *providersImpl) ListShares(ctx context.Context, request ListSharesReques // Gets an array of a specified provider's shares within the metastore where: // -// * the caller is a metastore admin, or * the caller is the owner. +// - the caller is a metastore admin, or +// - the caller is the owner. func (a *providersImpl) ListSharesAll(ctx context.Context, request ListSharesRequest) ([]ProviderShare, error) { iterator := a.ListShares(ctx, request) return listing.ToSlice[ProviderShare](ctx, iterator) @@ -371,8 +373,9 @@ func (a *recipientsImpl) Get(ctx context.Context, request GetRecipientRequest) ( // Gets an array of all share recipients within the current metastore where: // -// * the caller is a metastore admin, or * the caller is the owner. There is no -// guarantee of a specific ordering of the elements in the array. +// - the caller is a metastore admin, or +// - the caller is the owner. There is no guarantee of a specific ordering of +// the elements in the array. func (a *recipientsImpl) List(ctx context.Context, request ListRecipientsRequest) listing.Iterator[RecipientInfo] { request.ForceSendFields = append(request.ForceSendFields, "MaxResults") @@ -401,8 +404,9 @@ func (a *recipientsImpl) List(ctx context.Context, request ListRecipientsRequest // Gets an array of all share recipients within the current metastore where: // -// * the caller is a metastore admin, or * the caller is the owner. There is no -// guarantee of a specific ordering of the elements in the array. +// - the caller is a metastore admin, or +// - the caller is the owner. There is no guarantee of a specific ordering of +// the elements in the array. func (a *recipientsImpl) ListAll(ctx context.Context, request ListRecipientsRequest) ([]RecipientInfo, error) { iterator := a.List(ctx, request) return listing.ToSlice[RecipientInfo](ctx, iterator) diff --git a/service/sharing/interface.go b/service/sharing/interface.go index 29d872b30..8883fb3a0 100644 --- a/service/sharing/interface.go +++ b/service/sharing/interface.go @@ -41,7 +41,8 @@ type ProvidersService interface { // Gets an array of a specified provider's shares within the metastore // where: // - // * the caller is a metastore admin, or * the caller is the owner. + // - the caller is a metastore admin, or + // - the caller is the owner. ListShares(ctx context.Context, request ListSharesRequest) (*ListProviderSharesResponse, error) // Updates the information for an authentication provider, if the caller is @@ -84,16 +85,18 @@ type RecipientActivationService interface { // recipients authenticate using OIDC tokens. It validates the OIDC claims in // federated tokens and is set at the recipient level. The caller must be the // owner of the recipient to create or manage a federation policy. Federation -// policies support the following scenarios: - User-to-Machine (U2M) flow: A -// user accesses Delta Shares using their own identity, such as connecting -// through PowerBI Delta Sharing Client. - Machine-to-Machine (M2M) flow: An -// application accesses Delta Shares using its own identity, typically for -// automation tasks like nightly jobs through Python Delta Sharing Client. OIDC -// Token Federation enables fine-grained access control, supports Multi-Factor -// Authentication (MFA), and enhances security by minimizing the risk of -// credential leakage through the use of short-lived, expiring tokens. It is -// designed for strong identity governance, secure cross-platform data sharing, -// and reduced operational overhead for credential management. +// policies support the following scenarios: +// +// - User-to-Machine (U2M) flow: A user accesses Delta Shares using their own +// identity, such as connecting through PowerBI Delta Sharing Client. +// - Machine-to-Machine (M2M) flow: An application accesses Delta Shares using +// its own identity, typically for automation tasks like nightly jobs +// through Python Delta Sharing Client. OIDC Token Federation enables +// fine-grained access control, supports Multi-Factor Authentication (MFA), +// and enhances security by minimizing the risk of credential leakage +// through the use of short-lived, expiring tokens. It is designed for +// strong identity governance, secure cross-platform data sharing, and +// reduced operational overhead for credential management. // // For more information, see // https://www.databricks.com/blog/announcing-oidc-token-federation-enhanced-delta-sharing-security @@ -111,24 +114,29 @@ type RecipientFederationPoliciesService interface { // This enables secretless sharing clients to authenticate using OIDC // tokens. // - // Supported scenarios for federation policies: 1. **User-to-Machine (U2M) - // flow** (e.g., PowerBI): A user accesses a resource using their own - // identity. 2. **Machine-to-Machine (M2M) flow** (e.g., OAuth App): An - // OAuth App accesses a resource using its own identity, typically for tasks - // like running nightly jobs. + // Supported scenarios for federation policies: + // + // 1. **User-to-Machine (U2M) flow** (e.g., PowerBI): A user accesses a + // resource using their own identity. + // 2. **Machine-to-Machine (M2M) flow** (e.g., OAuth App): An OAuth App + // accesses a resource using its own identity, typically for tasks like + // running nightly jobs. + // + // For an overview, refer to: // - // For an overview, refer to: - Blog post: Overview of feature: - // https://www.databricks.com/blog/announcing-oidc-token-federation-enhanced-delta-sharing-security + // - Blog post: Overview of feature: + // https://www.databricks.com/blog/announcing-oidc-token-federation-enhanced-delta-sharing-security // - // For detailed configuration guides based on your use case: - Creating a - // Federation Policy as a provider: - // https://docs.databricks.com/en/delta-sharing/create-recipient-oidc-fed - - // Configuration and usage for Machine-to-Machine (M2M) applications (e.g., - // Python Delta Sharing Client): - // https://docs.databricks.com/aws/en/delta-sharing/sharing-over-oidc-m2m - - // Configuration and usage for User-to-Machine (U2M) applications (e.g., - // PowerBI): - // https://docs.databricks.com/aws/en/delta-sharing/sharing-over-oidc-u2m + // For detailed configuration guides based on your use case: + // + // - Creating a Federation Policy as a provider: + // https://docs.databricks.com/en/delta-sharing/create-recipient-oidc-fed + // - Configuration and usage for Machine-to-Machine (M2M) applications + // (e.g., Python Delta Sharing Client): + // https://docs.databricks.com/aws/en/delta-sharing/sharing-over-oidc-m2m + // - Configuration and usage for User-to-Machine (U2M) applications (e.g., + // PowerBI): + // https://docs.databricks.com/aws/en/delta-sharing/sharing-over-oidc-u2m Create(ctx context.Context, request CreateFederationPolicyRequest) (*FederationPolicy, error) // Deletes an existing federation policy for an OIDC_FEDERATION recipient. @@ -151,18 +159,17 @@ type RecipientFederationPoliciesService interface { // sharing works differs depending on whether or not your recipient has access // to a Databricks workspace that is enabled for Unity Catalog: // -// - For recipients with access to a Databricks workspace that is enabled for -// Unity Catalog, you can create a recipient object along with a unique sharing -// identifier you get from the recipient. The sharing identifier is the key -// identifier that enables the secure connection. This sharing mode is called -// **Databricks-to-Databricks sharing**. -// -// - For recipients without access to a Databricks workspace that is enabled for -// Unity Catalog, when you create a recipient object, Databricks generates an -// activation link you can send to the recipient. The recipient follows the -// activation link to download the credential file, and then uses the credential -// file to establish a secure connection to receive the shared data. This -// sharing mode is called **open sharing**. +// - For recipients with access to a Databricks workspace that is enabled for +// Unity Catalog, you can create a recipient object along with a unique +// sharing identifier you get from the recipient. The sharing identifier is +// the key identifier that enables the secure connection. This sharing mode +// is called **Databricks-to-Databricks sharing**. +// - For recipients without access to a Databricks workspace that is enabled +// for Unity Catalog, when you create a recipient object, Databricks +// generates an activation link you can send to the recipient. The recipient +// follows the activation link to download the credential file, and then +// uses the credential file to establish a secure connection to receive the +// shared data. This sharing mode is called **open sharing**. // // Deprecated: Do not use this interface, it will be removed in a future version of the SDK. type RecipientsService interface { @@ -176,15 +183,18 @@ type RecipientsService interface { // the owner of the recipient. Delete(ctx context.Context, request DeleteRecipientRequest) error - // Gets a share recipient from the metastore. The caller must be one of: * A - // user with **USE_RECIPIENT** privilege on the metastore * The owner of the - // share recipient * A metastore admin + // Gets a share recipient from the metastore. The caller must be one of: + // + // - A user with **USE_RECIPIENT** privilege on the metastore + // - The owner of the share recipient + // - A metastore admin Get(ctx context.Context, request GetRecipientRequest) (*RecipientInfo, error) // Gets an array of all share recipients within the current metastore where: // - // * the caller is a metastore admin, or * the caller is the owner. There is - // no guarantee of a specific ordering of the elements in the array. + // - the caller is a metastore admin, or + // - the caller is the owner. There is no guarantee of a specific ordering + // of the elements in the array. List(ctx context.Context, request ListRecipientsRequest) (*ListRecipientsResponse, error) // Refreshes the specified recipient's delta sharing authentication token @@ -240,13 +250,13 @@ type SharesService interface { // Updates the share with the changes and data objects in the request. The // caller must be the owner of the share or a metastore admin. // - // When the caller is a metastore admin, only the __owner__ field can be + // When the caller is a metastore admin, only the **owner** field can be // updated. // // In the case the share name is changed, **updateShare** requires that the // caller is the owner of the share and has the CREATE_SHARE privilege. // - // If there are notebook files in the share, the __storage_root__ field + // If there are notebook files in the share, the **storage_root** field // cannot be updated. // // For each table that is added through this method, the share owner must diff --git a/service/sharing/model.go b/service/sharing/model.go index 8b8bde784..26db009bb 100755 --- a/service/sharing/model.go +++ b/service/sharing/model.go @@ -166,7 +166,7 @@ type CreateProvider struct { Comment string `json:"comment,omitempty"` // The name of the Provider. Name string `json:"name"` - // This field is required when the __authentication_type__ is **TOKEN**, + // This field is required when the **authentication_type** is **TOKEN**, // **OAUTH_CLIENT_CREDENTIALS** or not provided. RecipientProfileStr string `json:"recipient_profile_str,omitempty"` @@ -186,9 +186,9 @@ type CreateRecipient struct { // Description about the recipient. Comment string `json:"comment,omitempty"` // The global Unity Catalog metastore id provided by the data recipient. - // This field is only present when the __authentication_type__ is + // This field is only present when the **authentication_type** is // **DATABRICKS**. The identifier is of format - // __cloud__:__region__:__metastore-uuid__. + // **cloud**:**region**:**metastore-uuid**. DataRecipientGlobalMetastoreId string `json:"data_recipient_global_metastore_id,omitempty"` // Expiration timestamp of the token, in epoch milliseconds. ExpirationTime int64 `json:"expiration_time,omitempty"` @@ -206,7 +206,7 @@ type CreateRecipient struct { // read-modify-write. PropertiesKvpairs *SecurablePropertiesKvPairs `json:"properties_kvpairs,omitempty"` // The one-time sharing code provided by the data recipient. This field is - // only present when the __authentication_type__ is **DATABRICKS**. + // only present when the **authentication_type** is **DATABRICKS**. SharingCode string `json:"sharing_code,omitempty"` ForceSendFields []string `json:"-" url:"-"` @@ -528,7 +528,7 @@ type GetRecipientRequest struct { type GetRecipientSharePermissionsResponse struct { // Opaque token to retrieve the next page of results. Absent if there are no - // more pages. __page_token__ should be set to this value for the next + // more pages. **page_token** should be set to this value for the next // request (for the next page of results). NextPageToken string `json:"next_page_token,omitempty"` // An array of data share permissions for a recipient. @@ -547,7 +547,7 @@ func (s GetRecipientSharePermissionsResponse) MarshalJSON() ([]byte, error) { type GetSharePermissionsResponse struct { // Opaque token to retrieve the next page of results. Absent if there are no - // more pages. __page_token__ should be set to this value for the next + // more pages. **page_token** should be set to this value for the next // request (for the next page of results). NextPageToken string `json:"next_page_token,omitempty"` // The privileges assigned to each principal @@ -663,7 +663,7 @@ type ListProviderShareAssetsResponse struct { type ListProviderSharesResponse struct { // Opaque token to retrieve the next page of results. Absent if there are no - // more pages. __page_token__ should be set to this value for the next + // more pages. **page_token** should be set to this value for the next // request (for the next page of results). NextPageToken string `json:"next_page_token,omitempty"` // An array of provider shares. @@ -684,15 +684,19 @@ type ListProvidersRequest struct { // If not provided, all providers will be returned. If no providers exist // with this ID, no results will be returned. DataProviderGlobalMetastoreId string `json:"-" url:"data_provider_global_metastore_id,omitempty"` - // Maximum number of providers to return. - when set to 0, the page length - // is set to a server configured value (recommended); - when set to a value - // greater than 0, the page length is the minimum of this value and a server - // configured value; - when set to a value less than 0, an invalid parameter - // error is returned; - If not set, all valid providers are returned (not - // recommended). - Note: The number of returned providers might be less than - // the specified max_results size, even zero. The only definitive indication - // that no further providers can be fetched is when the next_page_token is - // unset from the response. + // Maximum number of providers to return. + // + // - when set to 0, the page length is set to a server configured value + // (recommended); + // - when set to a value greater than 0, the page length is the minimum of + // this value and a server configured value; + // - when set to a value less than 0, an invalid parameter error is + // returned; + // - If not set, all valid providers are returned (not recommended). + // - Note: The number of returned providers might be less than the + // specified max_results size, even zero. The only definitive indication + // that no further providers can be fetched is when the next_page_token + // is unset from the response. MaxResults int `json:"-" url:"max_results,omitempty"` // Opaque pagination token to go to next page based on previous query. PageToken string `json:"-" url:"page_token,omitempty"` @@ -710,7 +714,7 @@ func (s ListProvidersRequest) MarshalJSON() ([]byte, error) { type ListProvidersResponse struct { // Opaque token to retrieve the next page of results. Absent if there are no - // more pages. __page_token__ should be set to this value for the next + // more pages. **page_token** should be set to this value for the next // request (for the next page of results). NextPageToken string `json:"next_page_token,omitempty"` // An array of provider information objects. @@ -731,15 +735,19 @@ type ListRecipientsRequest struct { // If not provided, all recipients will be returned. If no recipients exist // with this ID, no results will be returned. DataRecipientGlobalMetastoreId string `json:"-" url:"data_recipient_global_metastore_id,omitempty"` - // Maximum number of recipients to return. - when set to 0, the page length - // is set to a server configured value (recommended); - when set to a value - // greater than 0, the page length is the minimum of this value and a server - // configured value; - when set to a value less than 0, an invalid parameter - // error is returned; - If not set, all valid recipients are returned (not - // recommended). - Note: The number of returned recipients might be less - // than the specified max_results size, even zero. The only definitive - // indication that no further recipients can be fetched is when the - // next_page_token is unset from the response. + // Maximum number of recipients to return. + // + // - when set to 0, the page length is set to a server configured value + // (recommended); + // - when set to a value greater than 0, the page length is the minimum of + // this value and a server configured value; + // - when set to a value less than 0, an invalid parameter error is + // returned; + // - If not set, all valid recipients are returned (not recommended). + // - Note: The number of returned recipients might be less than the + // specified max_results size, even zero. The only definitive indication + // that no further recipients can be fetched is when the next_page_token + // is unset from the response. MaxResults int `json:"-" url:"max_results,omitempty"` // Opaque pagination token to go to next page based on previous query. PageToken string `json:"-" url:"page_token,omitempty"` @@ -757,7 +765,7 @@ func (s ListRecipientsRequest) MarshalJSON() ([]byte, error) { type ListRecipientsResponse struct { // Opaque token to retrieve the next page of results. Absent if there are no - // more pages. __page_token__ should be set to this value for the next + // more pages. **page_token** should be set to this value for the next // request (for the next page of results). NextPageToken string `json:"next_page_token,omitempty"` // An array of recipient information objects. @@ -775,15 +783,19 @@ func (s ListRecipientsResponse) MarshalJSON() ([]byte, error) { } type ListSharesRequest struct { - // Maximum number of shares to return. - when set to 0, the page length is - // set to a server configured value (recommended); - when set to a value - // greater than 0, the page length is the minimum of this value and a server - // configured value; - when set to a value less than 0, an invalid parameter - // error is returned; - If not set, all valid shares are returned (not - // recommended). - Note: The number of returned shares might be less than - // the specified max_results size, even zero. The only definitive indication - // that no further shares can be fetched is when the next_page_token is - // unset from the response. + // Maximum number of shares to return. + // + // - when set to 0, the page length is set to a server configured value + // (recommended); + // - when set to a value greater than 0, the page length is the minimum of + // this value and a server configured value; + // - when set to a value less than 0, an invalid parameter error is + // returned; + // - If not set, all valid shares are returned (not recommended). + // - Note: The number of returned shares might be less than the specified + // max_results size, even zero. The only definitive indication that no + // further shares can be fetched is when the next_page_token is unset + // from the response. MaxResults int `json:"-" url:"max_results,omitempty"` // Name of the provider in which to list shares. Name string `json:"-" url:"-"` @@ -803,7 +815,7 @@ func (s ListSharesRequest) MarshalJSON() ([]byte, error) { type ListSharesResponse struct { // Opaque token to retrieve the next page of results. Absent if there are no - // more pages. __page_token__ should be set to this value for the next + // more pages. **page_token** should be set to this value for the next // request (for the next page of results). NextPageToken string `json:"next_page_token,omitempty"` // An array of data share information objects. @@ -860,22 +872,32 @@ type OidcFederationPolicy struct { Issuer string `json:"issuer"` // The required token subject, as specified in the subject claim of // federated tokens. The subject claim identifies the identity of the user - // or machine accessing the resource. Examples for Entra ID (AAD): - U2M - // flow (group access): If the subject claim is `groups`, this must be the - // Object ID of the group in Entra ID. - U2M flow (user access): If the - // subject claim is `oid`, this must be the Object ID of the user in Entra - // ID. - M2M flow (OAuth App access): If the subject claim is `azp`, this - // must be the client ID of the OAuth app registered in Entra ID. + // or machine accessing the resource. Examples for Entra ID (AAD): + // + // - U2M flow (group access): If the subject claim is `groups`, this must + // be the Object ID of the group in Entra ID. + // - U2M flow (user access): If the subject claim is `oid`, this must be + // the Object ID of the user in Entra ID. + // - M2M flow (OAuth App access): If the subject claim is `azp`, this must + // be the client ID of the OAuth app registered in Entra ID. Subject string `json:"subject"` // The claim that contains the subject of the token. Depending on the - // identity provider and the use case (U2M or M2M), this can vary: - For - // Entra ID (AAD): * U2M flow (group access): Use `groups`. * U2M flow (user - // access): Use `oid`. * M2M flow (OAuth App access): Use `azp`. - For other - // IdPs, refer to the specific IdP documentation. + // identity provider and the use case (U2M or M2M), this can vary: + // + // - For Entra ID (AAD): + // + // - U2M flow (group access): Use `groups`. + // - U2M flow (user access): Use `oid`. + // - M2M flow (OAuth App access): Use `azp`. + // + // - For other IdPs, refer to the specific IdP documentation. + // + // Supported `subject_claim` values are: // - // Supported `subject_claim` values are: - `oid`: Object ID of the user. - - // `azp`: Client ID of the OAuth app. - `groups`: Object ID of the group. - - // `sub`: Subject identifier for other use cases. + // - `oid`: Object ID of the user. + // - `azp`: Client ID of the OAuth app. + // - `groups`: Object ID of the group. + // - `sub`: Subject identifier for other use cases. SubjectClaim string `json:"subject_claim"` } @@ -1153,7 +1175,7 @@ func (s PrivilegeAssignment) MarshalJSON() ([]byte, error) { type ProviderInfo struct { AuthenticationType AuthenticationType `json:"authentication_type,omitempty"` // Cloud vendor of the provider's UC metastore. This field is only present - // when the __authentication_type__ is **DATABRICKS**. + // when the **authentication_type** is **DATABRICKS**. Cloud string `json:"cloud,omitempty"` // Description about the provider. Comment string `json:"comment,omitempty"` @@ -1162,11 +1184,11 @@ type ProviderInfo struct { // Username of Provider creator. CreatedBy string `json:"created_by,omitempty"` // The global UC metastore id of the data provider. This field is only - // present when the __authentication_type__ is **DATABRICKS**. The - // identifier is of format __cloud__:__region__:__metastore-uuid__. + // present when the **authentication_type** is **DATABRICKS**. The + // identifier is of format **cloud**:**region**:**metastore-uuid**. DataProviderGlobalMetastoreId string `json:"data_provider_global_metastore_id,omitempty"` // UUID of the provider's UC metastore. This field is only present when the - // __authentication_type__ is **DATABRICKS**. + // **authentication_type** is **DATABRICKS**. MetastoreId string `json:"metastore_id,omitempty"` // The name of the Provider. Name string `json:"name,omitempty"` @@ -1175,11 +1197,11 @@ type ProviderInfo struct { // The recipient profile. This field is only present when the // authentication_type is `TOKEN` or `OAUTH_CLIENT_CREDENTIALS`. RecipientProfile *RecipientProfile `json:"recipient_profile,omitempty"` - // This field is required when the __authentication_type__ is **TOKEN**, + // This field is required when the **authentication_type** is **TOKEN**, // **OAUTH_CLIENT_CREDENTIALS** or not provided. RecipientProfileStr string `json:"recipient_profile_str,omitempty"` // Cloud region of the provider's UC metastore. This field is only present - // when the __authentication_type__ is **DATABRICKS**. + // when the **authentication_type** is **DATABRICKS**. Region string `json:"region,omitempty"` // Time at which this Provider was created, in epoch milliseconds. UpdatedAt int64 `json:"updated_at,omitempty"` @@ -1222,7 +1244,7 @@ type RecipientInfo struct { AuthenticationType AuthenticationType `json:"authentication_type,omitempty"` // Cloud vendor of the recipient's Unity Catalog Metastore. This field is - // only present when the __authentication_type__ is **DATABRICKS**. + // only present when the **authentication_type** is **DATABRICKS**. Cloud string `json:"cloud,omitempty"` // Description about the recipient. Comment string `json:"comment,omitempty"` @@ -1231,9 +1253,9 @@ type RecipientInfo struct { // Username of recipient creator. CreatedBy string `json:"created_by,omitempty"` // The global Unity Catalog metastore id provided by the data recipient. - // This field is only present when the __authentication_type__ is + // This field is only present when the **authentication_type** is // **DATABRICKS**. The identifier is of format - // __cloud__:__region__:__metastore-uuid__. + // **cloud**:**region**:**metastore-uuid**. DataRecipientGlobalMetastoreId string `json:"data_recipient_global_metastore_id,omitempty"` // Expiration timestamp of the token, in epoch milliseconds. ExpirationTime int64 `json:"expiration_time,omitempty"` @@ -1242,7 +1264,7 @@ type RecipientInfo struct { // IP Access List IpAccessList *IpAccessList `json:"ip_access_list,omitempty"` // Unique identifier of recipient's Unity Catalog Metastore. This field is - // only present when the __authentication_type__ is **DATABRICKS**. + // only present when the **authentication_type** is **DATABRICKS**. MetastoreId string `json:"metastore_id,omitempty"` // Name of Recipient. Name string `json:"name,omitempty"` @@ -1254,12 +1276,12 @@ type RecipientInfo struct { // read-modify-write. PropertiesKvpairs *SecurablePropertiesKvPairs `json:"properties_kvpairs,omitempty"` // Cloud region of the recipient's Unity Catalog Metastore. This field is - // only present when the __authentication_type__ is **DATABRICKS**. + // only present when the **authentication_type** is **DATABRICKS**. Region string `json:"region,omitempty"` // The one-time sharing code provided by the data recipient. This field is - // only present when the __authentication_type__ is **DATABRICKS**. + // only present when the **authentication_type** is **DATABRICKS**. SharingCode string `json:"sharing_code,omitempty"` - // This field is only present when the __authentication_type__ is **TOKEN**. + // This field is only present when the **authentication_type** is **TOKEN**. Tokens []RecipientTokenInfo `json:"tokens,omitempty"` // Time at which the recipient was updated, in epoch milliseconds. UpdatedAt int64 `json:"updated_at,omitempty"` @@ -1377,7 +1399,7 @@ type RotateRecipientToken struct { Name string `json:"-" url:"-"` } -// An object with __properties__ containing map of key-value properties attached +// An object with **properties** containing map of key-value properties attached // to the securable. type SecurablePropertiesKvPairs struct { // A map of key-value properties attached to the securable. @@ -1434,15 +1456,19 @@ func (s ShareInfo) MarshalJSON() ([]byte, error) { } type SharePermissionsRequest struct { - // Maximum number of permissions to return. - when set to 0, the page length - // is set to a server configured value (recommended); - when set to a value - // greater than 0, the page length is the minimum of this value and a server - // configured value; - when set to a value less than 0, an invalid parameter - // error is returned; - If not set, all valid permissions are returned (not - // recommended). - Note: The number of returned permissions might be less - // than the specified max_results size, even zero. The only definitive - // indication that no further permissions can be fetched is when the - // next_page_token is unset from the response. + // Maximum number of permissions to return. + // + // - when set to 0, the page length is set to a server configured value + // (recommended); + // - when set to a value greater than 0, the page length is the minimum of + // this value and a server configured value; + // - when set to a value less than 0, an invalid parameter error is + // returned; + // - If not set, all valid permissions are returned (not recommended). + // - Note: The number of returned permissions might be less than the + // specified max_results size, even zero. The only definitive indication + // that no further permissions can be fetched is when the + // next_page_token is unset from the response. MaxResults int `json:"-" url:"max_results,omitempty"` // The name of the Recipient. Name string `json:"-" url:"-"` @@ -1512,20 +1538,28 @@ type SharedDataObject struct { // Important: For non-table objects, this field must be omitted entirely. // // Format: Must be a 2-part name `.` (e.g., - // "sales_schema.orders_table") - Both schema and table names must contain - // only alphanumeric characters and underscores - No periods, spaces, - // forward slashes, or control characters are allowed within each part - Do - // not include the catalog name (use 2 parts, not 3) + // "sales_schema.orders_table") + // + // - Both schema and table names must contain only alphanumeric characters + // and underscores + // - No periods, spaces, forward slashes, or control characters are + // allowed within each part + // - Do not include the catalog name (use 2 parts, not 3) + // + // Behavior: + // + // - If not provided, the service automatically generates the alias as + // `.` from the object's original name + // - If you don't want to specify this field, omit it entirely from the + // request (do not pass an empty string) + // - The `shared_as` name must be unique within the share // - // Behavior: - If not provided, the service automatically generates the - // alias as `.
` from the object's original name - If you - // don't want to specify this field, omit it entirely from the request (do - // not pass an empty string) - The `shared_as` name must be unique within - // the share + // Examples: // - // Examples: - Valid: "analytics_schema.customer_view" - Invalid: - // "catalog.analytics_schema.customer_view" (3 parts not allowed) - Invalid: - // "analytics-schema.customer-view" (hyphens not allowed) + // - Valid: "analytics_schema.customer_view" + // - Invalid: "catalog.analytics_schema.customer_view" (3 parts not + // allowed) + // - Invalid: "analytics-schema.customer-view" (hyphens not allowed) SharedAs string `json:"shared_as,omitempty"` // The start version associated with the object. This allows data providers // to control the lowest object version that is accessible by clients. If @@ -1546,25 +1580,36 @@ type SharedDataObject struct { // // Important: For table-like objects, this field must be omitted entirely. // - // Format: - For VOLUME: Must be a 2-part name `.` - // (e.g., "data_schema.ml_models") - For FUNCTION: Must be a 2-part name - // `.` (e.g., "udf_schema.calculate_tax") - For - // MODEL: Must be a 2-part name `.` (e.g., - // "models.prediction_model") - For NOTEBOOK_FILE: Should be the notebook - // file name (e.g., "analysis_notebook.py") - All names must contain only - // alphanumeric characters and underscores - No periods, spaces, forward - // slashes, or control characters are allowed within each part + // Format: // - // Behavior: - If not provided, the service automatically generates the - // alias from the object's original name - If you don't want to specify this - // field, omit it entirely from the request (do not pass an empty string) - - // The `string_shared_as` name must be unique for objects of the same type - // within the share + // - For VOLUME: Must be a 2-part name `.` + // (e.g., "data_schema.ml_models") + // - For FUNCTION: Must be a 2-part name `.` + // (e.g., "udf_schema.calculate_tax") + // - For MODEL: Must be a 2-part name `.` (e.g., + // "models.prediction_model") + // - For NOTEBOOK_FILE: Should be the notebook file name (e.g., + // "analysis_notebook.py") + // - All names must contain only alphanumeric characters and underscores + // - No periods, spaces, forward slashes, or control characters are + // allowed within each part // - // Examples: - Valid for VOLUME: "data_schema.training_data" - Valid for - // FUNCTION: "analytics.calculate_revenue" - Invalid: - // "catalog.data_schema.training_data" (3 parts not allowed for volumes) - - // Invalid: "data-schema.training-data" (hyphens not allowed) + // Behavior: + // + // - If not provided, the service automatically generates the alias from + // the object's original name + // - If you don't want to specify this field, omit it entirely from the + // request (do not pass an empty string) + // - The `string_shared_as` name must be unique for objects of the same + // type within the share + // + // Examples: + // + // - Valid for VOLUME: "data_schema.training_data" + // - Valid for FUNCTION: "analytics.calculate_revenue" + // - Invalid: "catalog.data_schema.training_data" (3 parts not allowed for + // volumes) + // - Invalid: "data-schema.training-data" (hyphens not allowed) StringSharedAs string `json:"string_shared_as,omitempty"` ForceSendFields []string `json:"-" url:"-"` @@ -1806,15 +1851,19 @@ func (f *SharedSecurableKind) Type() string { } type SharesListRequest struct { - // Maximum number of shares to return. - when set to 0, the page length is - // set to a server configured value (recommended); - when set to a value - // greater than 0, the page length is the minimum of this value and a server - // configured value; - when set to a value less than 0, an invalid parameter - // error is returned; - If not set, all valid shares are returned (not - // recommended). - Note: The number of returned shares might be less than - // the specified max_results size, even zero. The only definitive indication - // that no further shares can be fetched is when the next_page_token is - // unset from the response. + // Maximum number of shares to return. + // + // - when set to 0, the page length is set to a server configured value + // (recommended); + // - when set to a value greater than 0, the page length is the minimum of + // this value and a server configured value; + // - when set to a value less than 0, an invalid parameter error is + // returned; + // - If not set, all valid shares are returned (not recommended). + // - Note: The number of returned shares might be less than the specified + // max_results size, even zero. The only definitive indication that no + // further shares can be fetched is when the next_page_token is unset + // from the response. MaxResults int `json:"-" url:"max_results,omitempty"` // Opaque pagination token to go to next page based on previous query. PageToken string `json:"-" url:"page_token,omitempty"` @@ -1870,7 +1919,7 @@ type UpdateProvider struct { NewName string `json:"new_name,omitempty"` // Username of Provider owner. Owner string `json:"owner,omitempty"` - // This field is required when the __authentication_type__ is **TOKEN**, + // This field is required when the **authentication_type** is **TOKEN**, // **OAUTH_CLIENT_CREDENTIALS** or not provided. RecipientProfileStr string `json:"recipient_profile_str,omitempty"` diff --git a/service/sql/api.go b/service/sql/api.go index 146039bc9..3a1881b93 100755 --- a/service/sql/api.go +++ b/service/sql/api.go @@ -670,12 +670,10 @@ func NewDbsqlPermissions(client *client.DatabricksClient) *DbsqlPermissionsAPI { // // There are three levels of permission: // -// - `CAN_VIEW`: Allows read-only access -// -// - `CAN_RUN`: Allows read access and run access (superset of `CAN_VIEW`) -// -// - `CAN_MANAGE`: Allows all actions: read, run, edit, delete, modify -// permissions (superset of `CAN_RUN`) +// - `CAN_VIEW`: Allows read-only access +// - `CAN_RUN`: Allows read access and run access (superset of `CAN_VIEW`) +// - `CAN_MANAGE`: Allows all actions: read, run, edit, delete, modify +// permissions (superset of `CAN_RUN`) // // **Warning**: This API is deprecated. Please see the latest version of the // Databricks SQL API. [Learn more] @@ -1197,10 +1195,7 @@ type StatementExecutionInterface interface { // time at which the URL is no longer valid. In `EXTERNAL_LINKS` mode, chunks // can be resolved and fetched multiple times and in parallel. // - // ---- - // - // ### **Warning: Databricks strongly recommends that you protect the URLs that - // are returned by the `EXTERNAL_LINKS` disposition.** + // # **Warning: Databricks strongly recommends that you protect the URLs that are returned by the `EXTERNAL_LINKS` disposition.** // // When you use the `EXTERNAL_LINKS` disposition, a short-lived, URL is // generated, which can be used to download the results directly from . As a @@ -1214,8 +1209,6 @@ type StatementExecutionInterface interface { // // See also [Security best practices]. // - // ---- - // // StatementResponse contains `statement_id` and `status`; other fields might be // absent or present depending on context. If the SQL warehouse fails to execute // the provided statement, a 200 response is returned with `status.state` set to @@ -1317,22 +1310,25 @@ func NewStatementExecution(client *client.DatabricksClient) *StatementExecutionA // to either `CONTINUE`, to fallback to asynchronous mode, or it can be set to // `CANCEL`, which cancels the statement. // -// In summary: - **Synchronous mode** (`wait_timeout=30s` and -// `on_wait_timeout=CANCEL`): The call waits up to 30 seconds; if the statement -// execution finishes within this time, the result data is returned directly in -// the response. If the execution takes longer than 30 seconds, the execution is -// canceled and the call returns with a `CANCELED` state. - **Asynchronous -// mode** (`wait_timeout=0s` and `on_wait_timeout` is ignored): The call doesn't -// wait for the statement to finish but returns directly with a statement ID. -// The status of the statement execution can be polled by issuing -// :method:statementexecution/getStatement with the statement ID. Once the -// execution has succeeded, this call also returns the result and metadata in -// the response. - **[Default] Hybrid mode** (`wait_timeout=10s` and -// `on_wait_timeout=CONTINUE`): The call waits for up to 10 seconds; if the -// statement execution finishes within this time, the result data is returned -// directly in the response. If the execution takes longer than 10 seconds, a -// statement ID is returned. The statement ID can be used to fetch status and -// results in the same way as in the asynchronous mode. +// In summary: +// +// - **Synchronous mode** (`wait_timeout=30s` and `on_wait_timeout=CANCEL`): +// The call waits up to 30 seconds; if the statement execution finishes +// within this time, the result data is returned directly in the response. +// If the execution takes longer than 30 seconds, the execution is canceled +// and the call returns with a `CANCELED` state. +// - **Asynchronous mode** (`wait_timeout=0s` and `on_wait_timeout` is +// ignored): The call doesn't wait for the statement to finish but returns +// directly with a statement ID. The status of the statement execution can +// be polled by issuing :method:statementexecution/getStatement with the +// statement ID. Once the execution has succeeded, this call also returns +// the result and metadata in the response. +// - **[Default] Hybrid mode** (`wait_timeout=10s` and +// `on_wait_timeout=CONTINUE`): The call waits for up to 10 seconds; if the +// statement execution finishes within this time, the result data is +// returned directly in the response. If the execution takes longer than 10 +// seconds, a statement ID is returned. The statement ID can be used to +// fetch status and results in the same way as in the asynchronous mode. // // Depending on the size, the result can be split into multiple chunks. If the // statement execution is successful, the statement response contains a manifest @@ -1354,14 +1350,13 @@ func NewStatementExecution(client *client.DatabricksClient) *StatementExecutionA // There are two ways to receive statement results, controlled by the // `disposition` setting, which can be either `INLINE` or `EXTERNAL_LINKS`: // -// - `INLINE`: In this mode, the result data is directly included in the -// response. It's best suited for smaller results. This mode can only be used -// with the `JSON_ARRAY` format. -// -// - `EXTERNAL_LINKS`: In this mode, the response provides links that can be -// used to download the result data in chunks separately. This approach is ideal -// for larger results and offers higher throughput. This mode can be used with -// all the formats: `JSON_ARRAY`, `ARROW_STREAM`, and `CSV`. +// - `INLINE`: In this mode, the result data is directly included in the +// response. It's best suited for smaller results. This mode can only be +// used with the `JSON_ARRAY` format. +// - `EXTERNAL_LINKS`: In this mode, the response provides links that can be +// used to download the result data in chunks separately. This approach is +// ideal for larger results and offers higher throughput. This mode can be +// used with all the formats: `JSON_ARRAY`, `ARROW_STREAM`, and `CSV`. // // By default, the API uses `format=JSON_ARRAY` and `disposition=INLINE`. // @@ -1370,23 +1365,27 @@ func NewStatementExecution(client *client.DatabricksClient) *StatementExecutionA // Note: The byte limit for INLINE disposition is based on internal storage // metrics and will not exactly match the byte count of the actual payload. // -// - Statements with `disposition=INLINE` are limited to 25 MiB and will fail -// when this limit is exceeded. - Statements with `disposition=EXTERNAL_LINKS` -// are limited to 100 GiB. Result sets larger than this limit will be truncated. -// Truncation is indicated by the `truncated` field in the result manifest. - -// The maximum query text size is 16 MiB. - Cancelation might silently fail. A -// successful response from a cancel request indicates that the cancel request -// was successfully received and sent to the processing engine. However, an -// outstanding statement might have already completed execution when the cancel -// request arrives. Polling for status until a terminal state is reached is a -// reliable way to determine the final state. - Wait timeouts are approximate, -// occur server-side, and cannot account for things such as caller delays and -// network latency from caller to service. - To guarantee that the statement is -// kept alive, you must poll at least once every 15 minutes. - The results are -// only available for one hour after success; polling does not extend this. - -// The SQL Execution API must be used for the entire lifecycle of the statement. -// For example, you cannot use the Jobs API to execute the command, and then the -// SQL Execution API to cancel it. +// - Statements with `disposition=INLINE` are limited to 25 MiB and will fail +// when this limit is exceeded. +// - Statements with `disposition=EXTERNAL_LINKS` are limited to 100 GiB. +// Result sets larger than this limit will be truncated. Truncation is +// indicated by the `truncated` field in the result manifest. +// - The maximum query text size is 16 MiB. +// - Cancelation might silently fail. A successful response from a cancel +// request indicates that the cancel request was successfully received and +// sent to the processing engine. However, an outstanding statement might +// have already completed execution when the cancel request arrives. Polling +// for status until a terminal state is reached is a reliable way to +// determine the final state. +// - Wait timeouts are approximate, occur server-side, and cannot account for +// things such as caller delays and network latency from caller to service. +// - To guarantee that the statement is kept alive, you must poll at least +// once every 15 minutes. +// - The results are only available for one hour after success; polling does +// not extend this. +// - The SQL Execution API must be used for the entire lifecycle of the +// statement. For example, you cannot use the Jobs API to execute the +// command, and then the SQL Execution API to cancel it. // // [Apache Arrow Columnar]: https://arrow.apache.org/overview/ // [Databricks SQL Statement Execution API tutorial]: https://docs.databricks.com/sql/api/sql-execution-tutorial.html diff --git a/service/sql/interface.go b/service/sql/interface.go index d14e1228d..142f1b607 100755 --- a/service/sql/interface.go +++ b/service/sql/interface.go @@ -238,12 +238,10 @@ type DataSourcesService interface { // // There are three levels of permission: // -// - `CAN_VIEW`: Allows read-only access -// -// - `CAN_RUN`: Allows read access and run access (superset of `CAN_VIEW`) -// -// - `CAN_MANAGE`: Allows all actions: read, run, edit, delete, modify -// permissions (superset of `CAN_RUN`) +// - `CAN_VIEW`: Allows read-only access +// - `CAN_RUN`: Allows read access and run access (superset of `CAN_VIEW`) +// - `CAN_MANAGE`: Allows all actions: read, run, edit, delete, modify +// permissions (superset of `CAN_RUN`) // // **Warning**: This API is deprecated. Please see the latest version of the // Databricks SQL API. [Learn more] @@ -506,22 +504,25 @@ type RedashConfigService interface { // to either `CONTINUE`, to fallback to asynchronous mode, or it can be set to // `CANCEL`, which cancels the statement. // -// In summary: - **Synchronous mode** (`wait_timeout=30s` and -// `on_wait_timeout=CANCEL`): The call waits up to 30 seconds; if the statement -// execution finishes within this time, the result data is returned directly in -// the response. If the execution takes longer than 30 seconds, the execution is -// canceled and the call returns with a `CANCELED` state. - **Asynchronous -// mode** (`wait_timeout=0s` and `on_wait_timeout` is ignored): The call doesn't -// wait for the statement to finish but returns directly with a statement ID. -// The status of the statement execution can be polled by issuing -// :method:statementexecution/getStatement with the statement ID. Once the -// execution has succeeded, this call also returns the result and metadata in -// the response. - **[Default] Hybrid mode** (`wait_timeout=10s` and -// `on_wait_timeout=CONTINUE`): The call waits for up to 10 seconds; if the -// statement execution finishes within this time, the result data is returned -// directly in the response. If the execution takes longer than 10 seconds, a -// statement ID is returned. The statement ID can be used to fetch status and -// results in the same way as in the asynchronous mode. +// In summary: +// +// - **Synchronous mode** (`wait_timeout=30s` and `on_wait_timeout=CANCEL`): +// The call waits up to 30 seconds; if the statement execution finishes +// within this time, the result data is returned directly in the response. +// If the execution takes longer than 30 seconds, the execution is canceled +// and the call returns with a `CANCELED` state. +// - **Asynchronous mode** (`wait_timeout=0s` and `on_wait_timeout` is +// ignored): The call doesn't wait for the statement to finish but returns +// directly with a statement ID. The status of the statement execution can +// be polled by issuing :method:statementexecution/getStatement with the +// statement ID. Once the execution has succeeded, this call also returns +// the result and metadata in the response. +// - **[Default] Hybrid mode** (`wait_timeout=10s` and +// `on_wait_timeout=CONTINUE`): The call waits for up to 10 seconds; if the +// statement execution finishes within this time, the result data is +// returned directly in the response. If the execution takes longer than 10 +// seconds, a statement ID is returned. The statement ID can be used to +// fetch status and results in the same way as in the asynchronous mode. // // Depending on the size, the result can be split into multiple chunks. If the // statement execution is successful, the statement response contains a manifest @@ -543,14 +544,13 @@ type RedashConfigService interface { // There are two ways to receive statement results, controlled by the // `disposition` setting, which can be either `INLINE` or `EXTERNAL_LINKS`: // -// - `INLINE`: In this mode, the result data is directly included in the -// response. It's best suited for smaller results. This mode can only be used -// with the `JSON_ARRAY` format. -// -// - `EXTERNAL_LINKS`: In this mode, the response provides links that can be -// used to download the result data in chunks separately. This approach is ideal -// for larger results and offers higher throughput. This mode can be used with -// all the formats: `JSON_ARRAY`, `ARROW_STREAM`, and `CSV`. +// - `INLINE`: In this mode, the result data is directly included in the +// response. It's best suited for smaller results. This mode can only be +// used with the `JSON_ARRAY` format. +// - `EXTERNAL_LINKS`: In this mode, the response provides links that can be +// used to download the result data in chunks separately. This approach is +// ideal for larger results and offers higher throughput. This mode can be +// used with all the formats: `JSON_ARRAY`, `ARROW_STREAM`, and `CSV`. // // By default, the API uses `format=JSON_ARRAY` and `disposition=INLINE`. // @@ -559,23 +559,27 @@ type RedashConfigService interface { // Note: The byte limit for INLINE disposition is based on internal storage // metrics and will not exactly match the byte count of the actual payload. // -// - Statements with `disposition=INLINE` are limited to 25 MiB and will fail -// when this limit is exceeded. - Statements with `disposition=EXTERNAL_LINKS` -// are limited to 100 GiB. Result sets larger than this limit will be truncated. -// Truncation is indicated by the `truncated` field in the result manifest. - -// The maximum query text size is 16 MiB. - Cancelation might silently fail. A -// successful response from a cancel request indicates that the cancel request -// was successfully received and sent to the processing engine. However, an -// outstanding statement might have already completed execution when the cancel -// request arrives. Polling for status until a terminal state is reached is a -// reliable way to determine the final state. - Wait timeouts are approximate, -// occur server-side, and cannot account for things such as caller delays and -// network latency from caller to service. - To guarantee that the statement is -// kept alive, you must poll at least once every 15 minutes. - The results are -// only available for one hour after success; polling does not extend this. - -// The SQL Execution API must be used for the entire lifecycle of the statement. -// For example, you cannot use the Jobs API to execute the command, and then the -// SQL Execution API to cancel it. +// - Statements with `disposition=INLINE` are limited to 25 MiB and will fail +// when this limit is exceeded. +// - Statements with `disposition=EXTERNAL_LINKS` are limited to 100 GiB. +// Result sets larger than this limit will be truncated. Truncation is +// indicated by the `truncated` field in the result manifest. +// - The maximum query text size is 16 MiB. +// - Cancelation might silently fail. A successful response from a cancel +// request indicates that the cancel request was successfully received and +// sent to the processing engine. However, an outstanding statement might +// have already completed execution when the cancel request arrives. Polling +// for status until a terminal state is reached is a reliable way to +// determine the final state. +// - Wait timeouts are approximate, occur server-side, and cannot account for +// things such as caller delays and network latency from caller to service. +// - To guarantee that the statement is kept alive, you must poll at least +// once every 15 minutes. +// - The results are only available for one hour after success; polling does +// not extend this. +// - The SQL Execution API must be used for the entire lifecycle of the +// statement. For example, you cannot use the Jobs API to execute the +// command, and then the SQL Execution API to cancel it. // // Deprecated: Do not use this interface, it will be removed in a future version of the SDK. // @@ -614,10 +618,7 @@ type StatementExecutionService interface { // `EXTERNAL_LINKS` mode, chunks can be resolved and fetched multiple times // and in parallel. // - // ---- - // - // ### **Warning: Databricks strongly recommends that you protect the URLs - // that are returned by the `EXTERNAL_LINKS` disposition.** + // # **Warning: Databricks strongly recommends that you protect the URLs that are returned by the `EXTERNAL_LINKS` disposition.** // // When you use the `EXTERNAL_LINKS` disposition, a short-lived, URL is // generated, which can be used to download the results directly from . As a @@ -631,8 +632,6 @@ type StatementExecutionService interface { // // See also [Security best practices]. // - // ---- - // // StatementResponse contains `statement_id` and `status`; other fields // might be absent or present depending on context. If the SQL warehouse // fails to execute the provided statement, a 200 response is returned with diff --git a/service/sql/model.go b/service/sql/model.go index 525004948..a09a96e5e 100755 --- a/service/sql/model.go +++ b/service/sql/model.go @@ -11,8 +11,10 @@ import ( type AccessControl struct { GroupName string `json:"group_name,omitempty"` - // * `CAN_VIEW`: Can view the query * `CAN_RUN`: Can run the query * - // `CAN_EDIT`: Can edit the query * `CAN_MANAGE`: Can manage the query + // - `CAN_VIEW`: Can view the query + // - `CAN_RUN`: Can run the query + // - `CAN_EDIT`: Can edit the query + // - `CAN_MANAGE`: Can manage the query PermissionLevel PermissionLevel `json:"permission_level,omitempty"` UserName string `json:"user_name,omitempty"` @@ -526,11 +528,13 @@ type AlertV2 struct { QueryText string `json:"query_text"` // Specifies the identity that will be used to run the alert. This field // allows you to configure alerts to run as a specific user or service - // principal. - For user identity: Set `user_name` to the email of an active - // workspace user. Users can only set this to their own email. - For service - // principal: Set `service_principal_name` to the application ID. Requires - // the `servicePrincipal/user` role. If not specified, the alert will run as - // the request user. + // principal. + // + // - For user identity: Set `user_name` to the email of an active + // workspace user. Users can only set this to their own email. + // - For service principal: Set `service_principal_name` to the + // application ID. Requires the `servicePrincipal/user` role. If not + // specified, the alert will run as the request user. RunAs *AlertV2RunAs `json:"run_as,omitempty"` // The run as username or application ID of service principal. On Create and // Update, this field can be set to application ID of an active service @@ -1215,7 +1219,10 @@ type CreateWarehouseRequest struct { // The amount of time in minutes that a SQL warehouse must be idle (i.e., no // RUNNING queries) before it is automatically stopped. // - // Supported values: - Must be == 0 or >= 10 mins - 0 indicates no autostop. + // Supported values: + // + // - Must be == 0 or >= 10 mins + // - 0 indicates no autostop. // // Defaults to 120 mins AutoStopMins int `json:"auto_stop_mins,omitempty"` @@ -1225,8 +1232,18 @@ type CreateWarehouseRequest struct { // a spark cluster allows you to run larger queries on it. If you want to // increase the number of concurrent queries, please tune max_num_clusters. // - // Supported values: - 2X-Small - X-Small - Small - Medium - Large - X-Large - // - 2X-Large - 3X-Large - 4X-Large - 5X-Large + // Supported values: + // + // - 2X-Small + // - X-Small + // - Small + // - Medium + // - Large + // - X-Large + // - 2X-Large + // - 3X-Large + // - 4X-Large + // - 5X-Large ClusterSize string `json:"cluster_size,omitempty"` // warehouse creator name CreatorName string `json:"creator_name,omitempty"` @@ -1241,7 +1258,10 @@ type CreateWarehouseRequest struct { // Maximum number of clusters that the autoscaler will create to handle // concurrent queries. // - // Supported values: - Must be >= min_num_clusters - Must be <= 40. + // Supported values: + // + // - Must be >= min_num_clusters + // - Must be <= 40. // // Defaults to min_clusters if unset. MaxNumClusters int `json:"max_num_clusters,omitempty"` @@ -1251,21 +1271,28 @@ type CreateWarehouseRequest struct { // queries. This is similar to reserved vs. revocable cores in a resource // manager. // - // Supported values: - Must be > 0 - Must be <= min(max_num_clusters, 30) + // Supported values: + // + // - Must be > 0 + // - Must be <= min(max_num_clusters, 30) // // Defaults to 1 MinNumClusters int `json:"min_num_clusters,omitempty"` // Logical name for the cluster. // - // Supported values: - Must be unique within an org. - Must be less than 100 - // characters. + // Supported values: + // + // - Must be unique within an org. + // - Must be less than 100 characters. Name string `json:"name,omitempty"` // Configurations whether the endpoint should use spot instances. SpotInstancePolicy SpotInstancePolicy `json:"spot_instance_policy,omitempty"` // A set of key-value pairs that will be tagged on all resources (e.g., AWS // instances and EBS volumes) associated with this SQL warehouse. // - // Supported values: - Number of tags < 45. + // Supported values: + // + // - Number of tags < 45. Tags *EndpointTags `json:"tags,omitempty"` // Warehouse type: `PRO` or `CLASSIC`. If you want to use serverless // compute, you must set to `PRO` and also set the field @@ -1409,8 +1436,10 @@ type Dashboard struct { Options *DashboardOptions `json:"options,omitempty"` // The identifier of the workspace folder containing the object. Parent string `json:"parent,omitempty"` - // * `CAN_VIEW`: Can view the query * `CAN_RUN`: Can run the query * - // `CAN_EDIT`: Can edit the query * `CAN_MANAGE`: Can manage the query + // - `CAN_VIEW`: Can view the query + // - `CAN_RUN`: Can run the query + // - `CAN_EDIT`: Can edit the query + // - `CAN_MANAGE`: Can manage the query PermissionTier PermissionLevel `json:"permission_tier,omitempty"` // URL slug. Usually mirrors the query name with dashes (`-`) instead of // spaces. Appears in the URL for this query. @@ -1895,7 +1924,10 @@ type EditWarehouseRequest struct { // The amount of time in minutes that a SQL warehouse must be idle (i.e., no // RUNNING queries) before it is automatically stopped. // - // Supported values: - Must be == 0 or >= 10 mins - 0 indicates no autostop. + // Supported values: + // + // - Must be == 0 or >= 10 mins + // - 0 indicates no autostop. // // Defaults to 120 mins AutoStopMins int `json:"auto_stop_mins,omitempty"` @@ -1905,8 +1937,18 @@ type EditWarehouseRequest struct { // a spark cluster allows you to run larger queries on it. If you want to // increase the number of concurrent queries, please tune max_num_clusters. // - // Supported values: - 2X-Small - X-Small - Small - Medium - Large - X-Large - // - 2X-Large - 3X-Large - 4X-Large - 5X-Large + // Supported values: + // + // - 2X-Small + // - X-Small + // - Small + // - Medium + // - Large + // - X-Large + // - 2X-Large + // - 3X-Large + // - 4X-Large + // - 5X-Large ClusterSize string `json:"cluster_size,omitempty"` // warehouse creator name CreatorName string `json:"creator_name,omitempty"` @@ -1923,7 +1965,10 @@ type EditWarehouseRequest struct { // Maximum number of clusters that the autoscaler will create to handle // concurrent queries. // - // Supported values: - Must be >= min_num_clusters - Must be <= 40. + // Supported values: + // + // - Must be >= min_num_clusters + // - Must be <= 40. // // Defaults to min_clusters if unset. MaxNumClusters int `json:"max_num_clusters,omitempty"` @@ -1933,21 +1978,28 @@ type EditWarehouseRequest struct { // queries. This is similar to reserved vs. revocable cores in a resource // manager. // - // Supported values: - Must be > 0 - Must be <= min(max_num_clusters, 30) + // Supported values: + // + // - Must be > 0 + // - Must be <= min(max_num_clusters, 30) // // Defaults to 1 MinNumClusters int `json:"min_num_clusters,omitempty"` // Logical name for the cluster. // - // Supported values: - Must be unique within an org. - Must be less than 100 - // characters. + // Supported values: + // + // - Must be unique within an org. + // - Must be less than 100 characters. Name string `json:"name,omitempty"` // Configurations whether the endpoint should use spot instances. SpotInstancePolicy SpotInstancePolicy `json:"spot_instance_policy,omitempty"` // A set of key-value pairs that will be tagged on all resources (e.g., AWS // instances and EBS volumes) associated with this SQL warehouse. // - // Supported values: - Number of tags < 45. + // Supported values: + // + // - Number of tags < 45. Tags *EndpointTags `json:"tags,omitempty"` // Warehouse type: `PRO` or `CLASSIC`. If you want to use serverless // compute, you must set to `PRO` and also set the field @@ -2050,7 +2102,10 @@ type EndpointInfo struct { // The amount of time in minutes that a SQL warehouse must be idle (i.e., no // RUNNING queries) before it is automatically stopped. // - // Supported values: - Must be == 0 or >= 10 mins - 0 indicates no autostop. + // Supported values: + // + // - Must be == 0 or >= 10 mins + // - 0 indicates no autostop. // // Defaults to 120 mins AutoStopMins int `json:"auto_stop_mins,omitempty"` @@ -2060,8 +2115,18 @@ type EndpointInfo struct { // a spark cluster allows you to run larger queries on it. If you want to // increase the number of concurrent queries, please tune max_num_clusters. // - // Supported values: - 2X-Small - X-Small - Small - Medium - Large - X-Large - // - 2X-Large - 3X-Large - 4X-Large - 5X-Large + // Supported values: + // + // - 2X-Small + // - X-Small + // - Small + // - Medium + // - Large + // - X-Large + // - 2X-Large + // - 3X-Large + // - 4X-Large + // - 5X-Large ClusterSize string `json:"cluster_size,omitempty"` // warehouse creator name CreatorName string `json:"creator_name,omitempty"` @@ -2083,7 +2148,10 @@ type EndpointInfo struct { // Maximum number of clusters that the autoscaler will create to handle // concurrent queries. // - // Supported values: - Must be >= min_num_clusters - Must be <= 40. + // Supported values: + // + // - Must be >= min_num_clusters + // - Must be <= 40. // // Defaults to min_clusters if unset. MaxNumClusters int `json:"max_num_clusters,omitempty"` @@ -2093,14 +2161,19 @@ type EndpointInfo struct { // queries. This is similar to reserved vs. revocable cores in a resource // manager. // - // Supported values: - Must be > 0 - Must be <= min(max_num_clusters, 30) + // Supported values: + // + // - Must be > 0 + // - Must be <= min(max_num_clusters, 30) // // Defaults to 1 MinNumClusters int `json:"min_num_clusters,omitempty"` // Logical name for the cluster. // - // Supported values: - Must be unique within an org. - Must be less than 100 - // characters. + // Supported values: + // + // - Must be unique within an org. + // - Must be less than 100 characters. Name string `json:"name,omitempty"` // Deprecated. current number of active sessions for the warehouse NumActiveSessions int64 `json:"num_active_sessions,omitempty"` @@ -2115,7 +2188,9 @@ type EndpointInfo struct { // A set of key-value pairs that will be tagged on all resources (e.g., AWS // instances and EBS volumes) associated with this SQL warehouse. // - // Supported values: - Number of tags < 45. + // Supported values: + // + // - Number of tags < 45. Tags *EndpointTags `json:"tags,omitempty"` // Warehouse type: `PRO` or `CLASSIC`. If you want to use serverless // compute, you must set to `PRO` and also set the field @@ -2243,13 +2318,13 @@ type ExecuteStatementRequest struct { // generate arbitrarily sized result sets for fetching up to 100 GiB. The // resulting links have two important properties: // - // 1. They point to resources _external_ to the Databricks compute; - // therefore any associated authentication information (typically a personal - // access token, OAuth token, or similar) _must be removed_ when fetching - // from these links. - // - // 2. These are URLs with a specific expiration, indicated in the response. - // The behavior when attempting to use an expired link is cloud specific. + // 1. They point to resources *external* to the Databricks compute; + // therefore any associated authentication information (typically a + // personal access token, OAuth token, or similar) *must be removed* + // when fetching from these links. + // 2. These are URLs with a specific expiration, indicated in the response. + // The behavior when attempting to use an expired link is cloud + // specific. Disposition Disposition `json:"disposition,omitempty"` // Statement execution supports three result formats: `JSON_ARRAY` // (default), `ARROW_STREAM`, and `CSV`. @@ -2264,8 +2339,11 @@ type ExecuteStatementRequest struct { // concat('id-', id) AS strCol, id AS intCol, null AS nullCol FROM range(3)` // would look like this: // - // ``` [ [ "id-1", "1", null ], [ "id-2", "2", null ], [ "id-3", "3", null - // ], ] ``` + // [ + // [ "id-1", "1", null ], + // [ "id-2", "2", null ], + // [ "id-3", "3", null ], + // ] // // When specifying `format=JSON_ARRAY` and `disposition=EXTERNAL_LINKS`, // each chunk in the result contains compact JSON with no indentation or @@ -2283,7 +2361,10 @@ type ExecuteStatementRequest struct { // names. For example, the output of `SELECT concat('id-', id) AS strCol, id // AS intCol, null as nullCol FROM range(3)` would look like this: // - // ``` strCol,intCol,nullCol id-1,1,null id-2,2,null id-3,3,null ``` + // strCol,intCol,nullCol + // id-1,1,null + // id-2,2,null + // id-3,3,null // // [Apache Arrow streaming format]: https://arrow.apache.org/docs/format/Columnar.html#ipc-streaming-format // [RFC 4180]: https://www.rfc-editor.org/rfc/rfc4180 @@ -2312,14 +2393,14 @@ type ExecuteStatementRequest struct { // For example, the following statement contains two parameters, `my_name` // and `my_date`: // - // ``` SELECT * FROM my_table WHERE name = :my_name AND date = :my_date ``` + // SELECT * FROM my_table WHERE name = :my_name AND date = :my_date // // The parameters can be passed in the request body as follows: // - // ` { ..., "statement": "SELECT * FROM my_table WHERE name = :my_name AND + // `{ ..., "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" } ] } - // ` + // 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. @@ -2449,11 +2530,11 @@ type ExternalLink struct { // values of these headers should be considered sensitive and the client // should not expose these values in a log. HttpHeaders map[string]string `json:"http_headers,omitempty"` - // When fetching, provides the `chunk_index` for the _next_ chunk. If + // 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. NextChunkIndex int `json:"next_chunk_index,omitempty"` - // When fetching, provides a link to fetch the _next_ chunk. If absent, + // When fetching, provides a link to fetch the *next* chunk. If absent, // indicates there are no more chunks. This link is an absolute `path` to be // joined with your `$DATABRICKS_HOST`, and should be treated as an opaque // link. This is an alternative to using `next_chunk_index`. @@ -2656,7 +2737,10 @@ type GetWarehouseResponse struct { // The amount of time in minutes that a SQL warehouse must be idle (i.e., no // RUNNING queries) before it is automatically stopped. // - // Supported values: - Must be == 0 or >= 10 mins - 0 indicates no autostop. + // Supported values: + // + // - Must be == 0 or >= 10 mins + // - 0 indicates no autostop. // // Defaults to 120 mins AutoStopMins int `json:"auto_stop_mins,omitempty"` @@ -2666,8 +2750,18 @@ type GetWarehouseResponse struct { // a spark cluster allows you to run larger queries on it. If you want to // increase the number of concurrent queries, please tune max_num_clusters. // - // Supported values: - 2X-Small - X-Small - Small - Medium - Large - X-Large - // - 2X-Large - 3X-Large - 4X-Large - 5X-Large + // Supported values: + // + // - 2X-Small + // - X-Small + // - Small + // - Medium + // - Large + // - X-Large + // - 2X-Large + // - 3X-Large + // - 4X-Large + // - 5X-Large ClusterSize string `json:"cluster_size,omitempty"` // warehouse creator name CreatorName string `json:"creator_name,omitempty"` @@ -2689,7 +2783,10 @@ type GetWarehouseResponse struct { // Maximum number of clusters that the autoscaler will create to handle // concurrent queries. // - // Supported values: - Must be >= min_num_clusters - Must be <= 40. + // Supported values: + // + // - Must be >= min_num_clusters + // - Must be <= 40. // // Defaults to min_clusters if unset. MaxNumClusters int `json:"max_num_clusters,omitempty"` @@ -2699,14 +2796,19 @@ type GetWarehouseResponse struct { // queries. This is similar to reserved vs. revocable cores in a resource // manager. // - // Supported values: - Must be > 0 - Must be <= min(max_num_clusters, 30) + // Supported values: + // + // - Must be > 0 + // - Must be <= min(max_num_clusters, 30) // // Defaults to 1 MinNumClusters int `json:"min_num_clusters,omitempty"` // Logical name for the cluster. // - // Supported values: - Must be unique within an org. - Must be less than 100 - // characters. + // Supported values: + // + // - Must be unique within an org. + // - Must be less than 100 characters. Name string `json:"name,omitempty"` // Deprecated. current number of active sessions for the warehouse NumActiveSessions int64 `json:"num_active_sessions,omitempty"` @@ -2721,7 +2823,9 @@ type GetWarehouseResponse struct { // A set of key-value pairs that will be tagged on all resources (e.g., AWS // instances and EBS volumes) associated with this SQL warehouse. // - // Supported values: - Number of tags < 45. + // Supported values: + // + // - Number of tags < 45. Tags *EndpointTags `json:"tags,omitempty"` // Warehouse type: `PRO` or `CLASSIC`. If you want to use serverless // compute, you must set to `PRO` and also set the field @@ -2989,8 +3093,10 @@ type LegacyQuery struct { Options *QueryOptions `json:"options,omitempty"` // The identifier of the workspace folder containing the object. Parent string `json:"parent,omitempty"` - // * `CAN_VIEW`: Can view the query * `CAN_RUN`: Can run the query * - // `CAN_EDIT`: Can edit the query * `CAN_MANAGE`: Can manage the query + // - `CAN_VIEW`: Can view the query + // - `CAN_RUN`: Can run the query + // - `CAN_EDIT`: Can edit the query + // - `CAN_MANAGE`: Can manage the query PermissionTier PermissionLevel `json:"permission_tier,omitempty"` // The text of the query to be run. Query string `json:"query,omitempty"` @@ -3023,8 +3129,8 @@ func (s LegacyQuery) MarshalJSON() ([]byte, error) { } // The visualization description API changes frequently and is unsupported. You -// can duplicate a visualization by copying description objects received _from -// the API_ and then using them to create a new one with a POST request to the +// can duplicate a visualization by copying description objects received *from +// the API* and then using them to create a new one with a POST request to the // same endpoint. Databricks does not recommend constructing ad-hoc // visualizations entirely in JSON. type LegacyVisualization struct { @@ -3319,17 +3425,13 @@ type ListQueriesLegacyRequest struct { // Name of query attribute to order by. Default sort order is ascending. // Append a dash (`-`) to order descending instead. // - // - `name`: The name of the query. - // - // - `created_at`: The timestamp the query was created. - // - // - `runtime`: The time it took to run this query. This is blank for - // parameterized queries. A blank value is treated as the highest value for - // sorting. - // - // - `executed_at`: The timestamp when the query was last run. - // - // - `created_by`: The user name of the user that created the query. + // - `name`: The name of the query. + // - `created_at`: The timestamp the query was created. + // - `runtime`: The time it took to run this query. This is blank for + // parameterized queries. A blank value is treated as the highest value + // for sorting. + // - `executed_at`: The timestamp when the query was last run. + // - `created_by`: The user name of the user that created the query. Order string `json:"-" url:"order,omitempty"` // Page number to retrieve. Page int `json:"-" url:"page,omitempty"` @@ -3834,8 +3936,10 @@ func (f *ParameterType) Type() string { return "ParameterType" } -// * `CAN_VIEW`: Can view the query * `CAN_RUN`: Can run the query * `CAN_EDIT`: -// Can edit the query * `CAN_MANAGE`: Can manage the query +// - `CAN_VIEW`: Can view the query +// - `CAN_RUN`: Can run the query +// - `CAN_EDIT`: Can edit the query +// - `CAN_MANAGE`: Can manage the query type PermissionLevel string // Can edit the query @@ -4114,9 +4218,11 @@ type QueryInfo struct { StatementType QueryStatementType `json:"statement_type,omitempty"` // Query status with one the following values: // - // - `QUEUED`: Query has been received and queued. - `RUNNING`: Query has - // started. - `CANCELED`: Query has been cancelled by the user. - `FAILED`: - // Query has failed. - `FINISHED`: Query has completed. + // - `QUEUED`: Query has been received and queued. + // - `RUNNING`: Query has started. + // - `CANCELED`: Query has been cancelled by the user. + // - `FAILED`: Query has failed. + // - `FINISHED`: Query has completed. Status QueryStatus `json:"status,omitempty"` // The ID of the user who ran the query. UserId int64 `json:"user_id,omitempty"` @@ -4498,9 +4604,9 @@ func (f *QueryStatus) Type() string { return "QueryStatus" } -// * A query execution can be annotated with an optional key-value pair to allow -// users to attribute the executions by key and optional value to filter by. -// QueryTag is the user-facing representation. +// - A query execution can be annotated with an optional key-value pair to +// allow users to attribute the executions by key and optional value to +// filter by. QueryTag is the user-facing representation. type QueryTag struct { Key string `json:"key"` @@ -4550,11 +4656,11 @@ type ResultData struct { DataArray [][]string `json:"data_array,omitempty"` ExternalLinks []ExternalLink `json:"external_links,omitempty"` - // When fetching, provides the `chunk_index` for the _next_ chunk. If + // 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. NextChunkIndex int `json:"next_chunk_index,omitempty"` - // When fetching, provides a link to fetch the _next_ chunk. If absent, + // When fetching, provides a link to fetch the *next* chunk. If absent, // indicates there are no more chunks. This link is an absolute `path` to be // joined with your `$DATABRICKS_HOST`, and should be treated as an opaque // link. This is an alternative to using `next_chunk_index`. @@ -4994,7 +5100,7 @@ type StartRequest struct { Id string `json:"-" url:"-"` } -// * State of a warehouse. +// State of a warehouse. type State string const StateDeleted State = `DELETED` @@ -5147,13 +5253,18 @@ type StatementStatus struct { // SQLSTATE error code returned when the statement execution fails. Only // populated when the statement status is `FAILED`. SqlState string `json:"sql_state,omitempty"` - // Statement execution state: - `PENDING`: waiting for warehouse - - // `RUNNING`: running - `SUCCEEDED`: execution was successful, result data - // available for fetch - `FAILED`: execution failed; reason for failure - // described in accompanying error message - `CANCELED`: user canceled; can - // come from explicit cancel call, or timeout with `on_wait_timeout=CANCEL` - // - `CLOSED`: execution successful, and statement closed; result no longer - // available for fetch + // Statement execution state: + // + // - `PENDING`: waiting for warehouse + // - `RUNNING`: running + // - `SUCCEEDED`: execution was successful, result data available for + // fetch + // - `FAILED`: execution failed; reason for failure described in + // accompanying error message + // - `CANCELED`: user canceled; can come from explicit cancel call, or + // timeout with `on_wait_timeout=CANCEL` + // - `CLOSED`: execution successful, and statement closed; result no + // longer available for fetch State StatementState `json:"state,omitempty"` ForceSendFields []string `json:"-" url:"-"` @@ -6480,7 +6591,7 @@ type WarehousePermissionsRequest struct { WarehouseId string `json:"-" url:"-"` } -// * Configuration values to enable or disable the access to specific warehouse +// Configuration values to enable or disable the access to specific warehouse // types in the workspace. type WarehouseTypePair struct { // If set to false the specific warehouse type will not be be allowed as a @@ -6547,7 +6658,7 @@ type Widget struct { Options *WidgetOptions `json:"options,omitempty"` // The visualization description API changes frequently and is unsupported. // You can duplicate a visualization by copying description objects received - // _from the API_ and then using them to create a new one with a POST + // *from the API* and then using them to create a new one with a POST // request to the same endpoint. Databricks does not recommend constructing // ad-hoc visualizations entirely in JSON. Visualization *LegacyVisualization `json:"visualization,omitempty"` diff --git a/service/supervisoragents/model.go b/service/supervisoragents/model.go index 03ab9edac..beae326d4 100755 --- a/service/supervisoragents/model.go +++ b/service/supervisoragents/model.go @@ -483,7 +483,10 @@ type UpdateExampleRequest struct { // supervisor-agents/{supervisor_agent_id}/examples/{example_id} Name string `json:"-" url:"-"` // Comma-delimited list of fields to update on the example. Allowed values: - // `question`, `guidelines`. Examples: - `question` - `question,guidelines` + // `question`, `guidelines`. Examples: + // + // - `question` + // - `question,guidelines` UpdateMask fieldmask.FieldMask `json:"-" url:"update_mask"` } diff --git a/service/vectorsearch/api.go b/service/vectorsearch/api.go index 69f0633dd..2ebb882cf 100755 --- a/service/vectorsearch/api.go +++ b/service/vectorsearch/api.go @@ -295,12 +295,14 @@ func NewVectorSearchIndexes(client *client.DatabricksClient) *VectorSearchIndexe // supports real-time and efficient approximate nearest neighbor (ANN) search // queries. // -// There are 2 types of AI Search indexes: - **Delta Sync Index**: An index that -// automatically syncs with a source Delta Table, automatically and -// incrementally updating the index as the underlying data in the Delta Table -// changes. - **Direct Vector Access Index**: An index that supports direct read -// and write of vectors and metadata through our REST and SDK APIs. With this -// model, the user manages index updates. +// There are 2 types of AI Search indexes: +// +// - **Delta Sync Index**: An index that automatically syncs with a source +// Delta Table, automatically and incrementally updating the index as the +// underlying data in the Delta Table changes. +// - **Direct Vector Access Index**: An index that supports direct read and +// write of vectors and metadata through our REST and SDK APIs. With this +// model, the user manages index updates. type VectorSearchIndexesAPI struct { vectorSearchIndexesImpl } diff --git a/service/vectorsearch/interface.go b/service/vectorsearch/interface.go index 572a87d03..c4c6eaba2 100755 --- a/service/vectorsearch/interface.go +++ b/service/vectorsearch/interface.go @@ -56,12 +56,14 @@ type VectorSearchEndpointsService interface { // supports real-time and efficient approximate nearest neighbor (ANN) search // queries. // -// There are 2 types of AI Search indexes: - **Delta Sync Index**: An index that -// automatically syncs with a source Delta Table, automatically and -// incrementally updating the index as the underlying data in the Delta Table -// changes. - **Direct Vector Access Index**: An index that supports direct read -// and write of vectors and metadata through our REST and SDK APIs. With this -// model, the user manages index updates. +// There are 2 types of AI Search indexes: +// +// - **Delta Sync Index**: An index that automatically syncs with a source +// Delta Table, automatically and incrementally updating the index as the +// underlying data in the Delta Table changes. +// - **Direct Vector Access Index**: An index that supports direct read and +// write of vectors and metadata through our REST and SDK APIs. With this +// model, the user manages index updates. // // Deprecated: Do not use this interface, it will be removed in a future version of the SDK. type VectorSearchIndexesService interface { diff --git a/service/vectorsearch/model.go b/service/vectorsearch/model.go index e8e89cd50..0c75593a4 100755 --- a/service/vectorsearch/model.go +++ b/service/vectorsearch/model.go @@ -189,13 +189,15 @@ type DeltaSyncVectorIndexSpecRequest struct { // [Optional] Name of the Delta table to sync the vector index contents and // computed embeddings to. EmbeddingWritebackTable string `json:"embedding_writeback_table,omitempty"` - // Pipeline execution mode. - `TRIGGERED`: If the pipeline uses the - // triggered execution mode, the system stops processing after successfully - // refreshing the source table in the pipeline once, ensuring the table is - // updated based on the data available when the update started. - - // `CONTINUOUS`: If the pipeline uses continuous execution, the pipeline - // processes new data as it arrives in the source table to keep vector index - // fresh. + // Pipeline execution mode. + // + // - `TRIGGERED`: If the pipeline uses the triggered execution mode, the + // system stops processing after successfully refreshing the source + // table in the pipeline once, ensuring the table is updated based on + // the data available when the update started. + // - `CONTINUOUS`: If the pipeline uses continuous execution, the pipeline + // processes new data as it arrives in the source table to keep vector + // index fresh. PipelineType PipelineType `json:"pipeline_type,omitempty"` // The name of the source table. SourceTable string `json:"source_table,omitempty"` @@ -232,13 +234,15 @@ type DeltaSyncVectorIndexSpecResponse struct { EmbeddingWritebackTable string `json:"embedding_writeback_table,omitempty"` // The ID of the pipeline that is used to sync the index. PipelineId string `json:"pipeline_id,omitempty"` - // Pipeline execution mode. - `TRIGGERED`: If the pipeline uses the - // triggered execution mode, the system stops processing after successfully - // refreshing the source table in the pipeline once, ensuring the table is - // updated based on the data available when the update started. - - // `CONTINUOUS`: If the pipeline uses continuous execution, the pipeline - // processes new data as it arrives in the source table to keep vector index - // fresh. + // Pipeline execution mode. + // + // - `TRIGGERED`: If the pipeline uses the triggered execution mode, the + // system stops processing after successfully refreshing the source + // table in the pipeline once, ensuring the table is updated based on + // the data available when the update started. + // - `CONTINUOUS`: If the pipeline uses continuous execution, the pipeline + // processes new data as it arrives in the source table to keep vector + // index fresh. PipelineType PipelineType `json:"pipeline_type,omitempty"` // The name of the source table. SourceTable string `json:"source_table,omitempty"` @@ -538,9 +542,13 @@ type GetVectorSearchEndpointPermissionsRequest struct { } // The subtype of the AI Search index, determining the indexing and retrieval -// strategy. - `VECTOR`: Not supported. Use `HYBRID` instead. - `FULL_TEXT`: An -// index that uses full-text search without vector embeddings. - `HYBRID`: An -// index that uses vector embeddings for similarity search and hybrid search. +// strategy. +// +// - `VECTOR`: Not supported. Use `HYBRID` instead. +// - `FULL_TEXT`: An index that uses full-text search without vector +// embeddings. +// - `HYBRID`: An index that uses vector embeddings for similarity search and +// hybrid search. type IndexSubtype string // An index that uses full-text search without vector embeddings. @@ -805,12 +813,15 @@ func (s PatchEndpointRequest) MarshalJSON() ([]byte, error) { return marshal.Marshal(s) } -// Pipeline execution mode. - `TRIGGERED`: If the pipeline uses the triggered -// execution mode, the system stops processing after successfully refreshing the -// source table in the pipeline once, ensuring the table is updated based on the -// data available when the update started. - `CONTINUOUS`: If the pipeline uses -// continuous execution, the pipeline processes new data as it arrives in the -// source table to keep vector index fresh. +// Pipeline execution mode. +// +// - `TRIGGERED`: If the pipeline uses the triggered execution mode, the +// system stops processing after successfully refreshing the source table in +// the pipeline once, ensuring the table is updated based on the data +// available when the update started. +// - `CONTINUOUS`: If the pipeline uses continuous execution, the pipeline +// processes new data as it arrives in the source table to keep vector index +// fresh. type PipelineType string // If the pipeline uses continuous execution, the pipeline processes new data as @@ -890,10 +901,11 @@ type QueryVectorIndexRequest struct { // // Example filters: // - // - `{"id <": 5}`: Filter for id less than 5. - `{"id >": 5}`: Filter for - // id greater than 5. - `{"id <=": 5}`: Filter for id less than equal to 5. - // - `{"id >=": 5}`: Filter for id greater than equal to 5. - `{"id": 5}`: - // Filter for id equal to 5. + // - `{"id <": 5}`: Filter for id less than 5. + // - `{"id >": 5}`: Filter for id greater than 5. + // - `{"id <=": 5}`: Filter for id less than equal to 5. + // - `{"id >=": 5}`: Filter for id greater than equal to 5. + // - `{"id": 5}`: Filter for id equal to 5. FiltersJson string `json:"filters_json,omitempty"` // Name of the vector index to query. IndexName string `json:"-" url:"-"` @@ -961,9 +973,11 @@ func (s QueryVectorIndexResponse) MarshalJSON() ([]byte, error) { } type RerankerConfig struct { - // Reranker identifier: - When model_type=BASE/UNSPECIFIED: must be - // "databricks_reranker". - When model_type=FINETUNED: the Model Serving - // endpoint name hosting a finetuned reranker. + // Reranker identifier: + // + // - When model_type=BASE/UNSPECIFIED: must be "databricks_reranker". + // - When model_type=FINETUNED: the Model Serving endpoint name hosting a + // finetuned reranker. Model string `json:"model,omitempty"` // Parameters that control how the reranker processes the query results. Parameters *RerankerConfigRerankerParameters `json:"parameters,omitempty"` @@ -1325,12 +1339,14 @@ func (s VectorIndexStatus) MarshalJSON() ([]byte, error) { return marshal.Marshal(s) } -// There are 2 types of AI Search indexes: - `DELTA_SYNC`: An index that -// automatically syncs with a source Delta Table, automatically and -// incrementally updating the index as the underlying data in the Delta Table -// changes. - `DIRECT_ACCESS`: An index that supports direct read and write of -// vectors and metadata through our REST and SDK APIs. With this model, the user -// manages index updates. +// There are 2 types of AI Search indexes: +// +// - `DELTA_SYNC`: An index that automatically syncs with a source Delta +// Table, automatically and incrementally updating the index as the +// underlying data in the Delta Table changes. +// - `DIRECT_ACCESS`: An index that supports direct read and write of vectors +// and metadata through our REST and SDK APIs. With this model, the user +// manages index updates. type VectorIndexType string // An index that automatically syncs with a source Delta Table, automatically diff --git a/service/workspace/api.go b/service/workspace/api.go index ac58635df..adeafbbe9 100755 --- a/service/workspace/api.go +++ b/service/workspace/api.go @@ -340,38 +340,41 @@ type SecretsInterface interface { // .. 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": + // "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`` + // 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 - // ``users``, which contains all users in the workspace. If - // ``initial_manage_principal`` is not specified, the initial ACL with - // ``MANAGE`` permission applied to the scope is assigned to the API request - // issuer's user identity. + // `users`, which contains all users in the workspace. If + // `initial_manage_principal` is not specified, the initial ACL with `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 + // 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 Databricks's own 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 + // `scope_backend_type` is `databricks` or is unspecified, an empty secret scope + // is created and stored in Databricks's own 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 CreateScope(ctx context.Context, request CreateScope) error // Deletes the given ACL on the given scope. // - // Users must have the ``MANAGE`` permission to invoke this API. + // Users must have the `MANAGE` permission to invoke this API. // // Example request: // @@ -379,9 +382,9 @@ type SecretsInterface interface { // // { "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 + // 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 // principal is invalid. DeleteAcl(ctx context.Context, request DeleteAcl) error @@ -393,10 +396,10 @@ type SecretsInterface interface { // // { "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. + // 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. DeleteScope(ctx context.Context, request DeleteScope) error // Deletes a secret scope. @@ -407,14 +410,14 @@ type SecretsInterface interface { // // { "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. + // 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. DeleteScopeByScope(ctx context.Context, scope string) error - // Deletes the secret stored in this secret scope. You must have ``WRITE`` or - // ``MANAGE`` permission on the Secret Scope. + // Deletes the secret stored in this secret scope. You must have `WRITE` or + // `MANAGE` permission on the Secret Scope. // // Example request: // @@ -422,15 +425,15 @@ type SecretsInterface interface { // // { "scope": "my-secret-scope", "key": "my-secret-key" } // - // 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. + // 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. DeleteSecret(ctx context.Context, request DeleteSecret) error // Describes the details about the given ACL, such as the group and permission. // - // Users must have the ``MANAGE`` permission to invoke this API. + // Users must have the `MANAGE` permission to invoke this API. // // Example response: // @@ -438,9 +441,9 @@ type SecretsInterface interface { // // { "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 + // 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 // invalid. GetAcl(ctx context.Context, request GetAclRequest) (*AclItem, error) @@ -457,25 +460,25 @@ type SecretsInterface interface { // bytes is determined by the caller in DBUtils and the type the data is decoded // into. // - // Throws ``RESOURCE_DOES_NOT_EXIST`` if no such secret or secret scope exists. - // Throws ``PERMISSION_DENIED`` if the user does not have permission to make - // this API call. + // Throws `RESOURCE_DOES_NOT_EXIST` if no such secret or secret scope exists. + // Throws `PERMISSION_DENIED` if the user does not have permission to make this + // API call. // // Note: This is explicitly an undocumented API. It also doesn't need to be // supported for the /preview prefix, because it's not a customer-facing API // (i.e. only used for DBUtils SecretUtils to fetch secrets). // - // Throws ``RESOURCE_DOES_NOT_EXIST`` if no such secret scope or secret exists. - // Throws ``BAD_REQUEST`` if normal user calls get secret outside of a notebook. - // AKV specific errors: Throws ``INVALID_PARAMETER_VALUE`` if secret name is not - // alphanumeric or too long. Throws ``PERMISSION_DENIED`` if secret manager - // cannot access AKV with 403 error Throws ``MALFORMED_REQUEST`` if secret - // manager cannot access AKV with any other 4xx error + // Throws `RESOURCE_DOES_NOT_EXIST` if no such secret scope or secret exists. + // Throws `BAD_REQUEST` if normal user calls get secret outside of a notebook. + // AKV specific errors: Throws `INVALID_PARAMETER_VALUE` if secret name is not + // alphanumeric or too long. Throws `PERMISSION_DENIED` if secret manager cannot + // access AKV with 403 error Throws `MALFORMED_REQUEST` if secret manager cannot + // access AKV with any other 4xx error GetSecret(ctx context.Context, request GetSecretRequest) (*GetSecretResponse, error) // Lists the ACLs set on the given scope. // - // Users must have the ``MANAGE`` permission to invoke this API. + // Users must have the `MANAGE` permission to invoke this API. // // Example response: // @@ -484,8 +487,8 @@ type SecretsInterface interface { // { "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 + // 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. // // This method is generated by Databricks SDK Code Generator. @@ -493,7 +496,7 @@ type SecretsInterface interface { // Lists the ACLs set on the given scope. // - // Users must have the ``MANAGE`` permission to invoke this API. + // Users must have the `MANAGE` permission to invoke this API. // // Example response: // @@ -502,8 +505,8 @@ type SecretsInterface interface { // { "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 + // 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. // // This method is generated by Databricks SDK Code Generator. @@ -511,7 +514,7 @@ type SecretsInterface interface { // Lists the ACLs set on the given scope. // - // Users must have the ``MANAGE`` permission to invoke this API. + // Users must have the `MANAGE` permission to invoke this API. // // Example response: // @@ -520,8 +523,8 @@ type SecretsInterface interface { // { "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 + // 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. ListAclsByScope(ctx context.Context, scope string) (*ListAclsResponse, error) @@ -534,8 +537,8 @@ type SecretsInterface interface { // { "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. + // Throws `PERMISSION_DENIED` if the user does not have permission to make this + // API call. // // This method is generated by Databricks SDK Code Generator. ListScopes(ctx context.Context) listing.Iterator[SecretScope] @@ -549,8 +552,8 @@ type SecretsInterface interface { // { "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. + // Throws `PERMISSION_DENIED` if the user does not have permission to make this + // API call. // // This method is generated by Databricks SDK Code Generator. ListScopesAll(ctx context.Context) ([]SecretScope, error) @@ -569,8 +572,8 @@ type SecretsInterface interface { // // The lastUpdatedTimestamp returned is in milliseconds since epoch. // - // 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 + // 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. // // This method is generated by Databricks SDK Code Generator. @@ -590,8 +593,8 @@ type SecretsInterface interface { // // The lastUpdatedTimestamp returned is in milliseconds since epoch. // - // 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 + // 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. // // This method is generated by Databricks SDK Code Generator. @@ -611,8 +614,8 @@ type SecretsInterface interface { // // The lastUpdatedTimestamp returned is in milliseconds since epoch. // - // 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 + // 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. ListSecretsByScope(ctx context.Context, scope string) (*ListSecretsResponse, error) @@ -621,10 +624,11 @@ type SecretsInterface interface { // most powerful permission available to them, and permissions are ordered as // follows: // - // * ``MANAGE`` - Allowed to change ACLs, and read and write to this secret - // scope. * ``WRITE`` - Allowed to read and write to this secret scope. * - // ``READ`` - Allowed to read this secret scope and list what secrets are - // available. + // - `MANAGE` - Allowed to change ACLs, and read and write to this secret + // scope. + // - `WRITE` - Allowed to read and write to this secret scope. + // - `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 @@ -632,7 +636,7 @@ type SecretsInterface interface { // 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. + // Users must have the `MANAGE` permission to invoke this API. // // Example request: // @@ -644,17 +648,17 @@ type SecretsInterface interface { // The principal is a user or group name corresponding to an existing Databricks // 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. + // 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. PutAcl(ctx context.Context, request PutAcl) error // Inserts a secret under the provided scope with the given name. If a secret // already exists with the same name, this command overwrites the existing // secret's value. The server encrypts the secret using the secret scope's - // encryption settings before storing it. You must have ``WRITE`` or ``MANAGE`` + // encryption settings before storing it. You must have `WRITE` or `MANAGE` // permission on the secret scope. // // The secret key must consist of alphanumeric characters, dashes, underscores, @@ -672,13 +676,13 @@ type SecretsInterface interface { // secret, which will determine the value returned when the secret value is // requested. Exactly one must be specified. // - // Throws ``RESOURCE_DOES_NOT_EXIST`` if no such secret scope exists. Throws - // ``RESOURCE_LIMIT_EXCEEDED`` if maximum number of secrets in scope is - // exceeded. Throws ``INVALID_PARAMETER_VALUE`` if the request parameters are - // invalid. Throws ``PERMISSION_DENIED`` if the user does not have permission to - // make this API call. Throws ``MALFORMED_REQUEST`` if request is incorrectly - // formatted or conflicting. Throws ``BAD_REQUEST`` if request is made against - // Azure KeyVault backed scope. + // Throws `RESOURCE_DOES_NOT_EXIST` if no such secret scope exists. Throws + // `RESOURCE_LIMIT_EXCEEDED` if maximum number of secrets in scope is exceeded. + // Throws `INVALID_PARAMETER_VALUE` if the request parameters are invalid. + // Throws `PERMISSION_DENIED` if the user does not have permission to make this + // API call. Throws `MALFORMED_REQUEST` if request is incorrectly formatted or + // conflicting. Throws `BAD_REQUEST` if request is made against Azure KeyVault + // backed scope. PutSecret(ctx context.Context, request PutSecret) error } @@ -714,10 +718,10 @@ type SecretsAPI struct { // // { "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. +// 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. func (a *SecretsAPI) DeleteScopeByScope(ctx context.Context, scope string) error { return a.secretsImpl.DeleteScope(ctx, DeleteScope{ Scope: scope, @@ -726,7 +730,7 @@ func (a *SecretsAPI) DeleteScopeByScope(ctx context.Context, scope string) error // Lists the ACLs set on the given scope. // -// Users must have the “MANAGE“ permission to invoke this API. +// Users must have the `MANAGE` permission to invoke this API. // // Example response: // @@ -735,8 +739,8 @@ func (a *SecretsAPI) DeleteScopeByScope(ctx context.Context, scope string) error // { "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 +// 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. func (a *SecretsAPI) ListAclsByScope(ctx context.Context, scope string) (*ListAclsResponse, error) { return a.secretsImpl.internalListAcls(ctx, ListAclsRequest{ @@ -758,8 +762,8 @@ func (a *SecretsAPI) ListAclsByScope(ctx context.Context, scope string) (*ListAc // // The lastUpdatedTimestamp returned is in milliseconds since epoch. // -// 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 +// 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. func (a *SecretsAPI) ListSecretsByScope(ctx context.Context, scope string) (*ListSecretsResponse, error) { return a.secretsImpl.internalListSecrets(ctx, ListSecretsRequest{ @@ -771,10 +775,12 @@ type WorkspaceInterface interface { workspaceAPIUtilities // Deletes an object or a directory (and optionally recursively deletes all - // objects in the directory). * If `path` does not exist, this call returns an - // error `RESOURCE_DOES_NOT_EXIST`. * If `path` is a non-empty directory and - // `recursive` is set to `false`, this call returns an error - // `DIRECTORY_NOT_EMPTY`. + // objects in the directory). + // + // - If `path` does not exist, this call returns an error + // `RESOURCE_DOES_NOT_EXIST`. + // - If `path` is a non-empty directory and `recursive` is set to `false`, + // this call returns an error `DIRECTORY_NOT_EMPTY`. // // Object deletion cannot be undone and deleting a directory recursively is not // atomic. diff --git a/service/workspace/impl.go b/service/workspace/impl.go index e0a584693..a3ee660a9 100755 --- a/service/workspace/impl.go +++ b/service/workspace/impl.go @@ -366,7 +366,7 @@ func (a *secretsImpl) GetSecret(ctx context.Context, request GetSecretRequest) ( // Lists the ACLs set on the given scope. // -// Users must have the “MANAGE“ permission to invoke this API. +// Users must have the `MANAGE` permission to invoke this API. // // Example response: // @@ -375,8 +375,8 @@ func (a *secretsImpl) GetSecret(ctx context.Context, request GetSecretRequest) ( // { "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 +// 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. func (a *secretsImpl) ListAcls(ctx context.Context, request ListAclsRequest) listing.Iterator[AclItem] { @@ -398,7 +398,7 @@ func (a *secretsImpl) ListAcls(ctx context.Context, request ListAclsRequest) lis // Lists the ACLs set on the given scope. // -// Users must have the “MANAGE“ permission to invoke this API. +// Users must have the `MANAGE` permission to invoke this API. // // Example response: // @@ -407,8 +407,8 @@ func (a *secretsImpl) ListAcls(ctx context.Context, request ListAclsRequest) lis // { "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 +// 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. func (a *secretsImpl) ListAclsAll(ctx context.Context, request ListAclsRequest) ([]AclItem, error) { iterator := a.ListAcls(ctx, request) @@ -438,8 +438,8 @@ func (a *secretsImpl) internalListAcls(ctx context.Context, request ListAclsRequ // { "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. +// Throws `PERMISSION_DENIED` if the user does not have permission to make this +// API call. func (a *secretsImpl) ListScopes(ctx context.Context) listing.Iterator[SecretScope] { request := struct{}{} @@ -468,8 +468,8 @@ func (a *secretsImpl) ListScopes(ctx context.Context) listing.Iterator[SecretSco // { "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. +// Throws `PERMISSION_DENIED` if the user does not have permission to make this +// API call. func (a *secretsImpl) ListScopesAll(ctx context.Context) ([]SecretScope, error) { iterator := a.ListScopes(ctx) return listing.ToSlice[SecretScope](ctx, iterator) @@ -503,8 +503,8 @@ func (a *secretsImpl) internalListScopes(ctx context.Context) (*ListScopesRespon // // The lastUpdatedTimestamp returned is in milliseconds since epoch. // -// 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 +// 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. func (a *secretsImpl) ListSecrets(ctx context.Context, request ListSecretsRequest) listing.Iterator[SecretMetadata] { @@ -538,8 +538,8 @@ func (a *secretsImpl) ListSecrets(ctx context.Context, request ListSecretsReques // // The lastUpdatedTimestamp returned is in milliseconds since epoch. // -// 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 +// 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. func (a *secretsImpl) ListSecretsAll(ctx context.Context, request ListSecretsRequest) ([]SecretMetadata, error) { iterator := a.ListSecrets(ctx, request) diff --git a/service/workspace/interface.go b/service/workspace/interface.go index 47312f19c..04c6eb4dc 100755 --- a/service/workspace/interface.go +++ b/service/workspace/interface.go @@ -110,40 +110,42 @@ type SecretsService interface { // .. 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": + // "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 + // 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 ``users``, which contains all users in the workspace. If - // ``initial_manage_principal`` is not specified, the initial ACL with - // ``MANAGE`` permission applied to the scope is assigned to the API request + // `MANAGE` permissions. The only supported principal for this option is the + // group `users`, which contains all users in the workspace. If + // `initial_manage_principal` is not specified, the initial ACL with + // `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 Databricks's own 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 + // 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 Databricks's own 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 CreateScope(ctx context.Context, request CreateScope) error // Deletes the given ACL on the given scope. // - // Users must have the ``MANAGE`` permission to invoke this API. + // Users must have the `MANAGE` permission to invoke this API. // // Example request: // @@ -151,10 +153,10 @@ type SecretsService interface { // // { "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 principal is invalid. + // 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 principal is invalid. DeleteAcl(ctx context.Context, request DeleteAcl) error // Deletes a secret scope. @@ -165,14 +167,14 @@ type SecretsService interface { // // { "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. + // 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. DeleteScope(ctx context.Context, request DeleteScope) error - // Deletes the secret stored in this secret scope. You must have ``WRITE`` - // or ``MANAGE`` permission on the Secret Scope. + // Deletes the secret stored in this secret scope. You must have `WRITE` or + // `MANAGE` permission on the Secret Scope. // // Example request: // @@ -180,9 +182,9 @@ type SecretsService interface { // // { "scope": "my-secret-scope", "key": "my-secret-key" } // - // 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 + // 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. DeleteSecret(ctx context.Context, request DeleteSecret) error @@ -190,7 +192,7 @@ type SecretsService interface { // Describes the details about the given ACL, such as the group and // permission. // - // Users must have the ``MANAGE`` permission to invoke this API. + // Users must have the `MANAGE` permission to invoke this API. // // Example response: // @@ -198,10 +200,10 @@ type SecretsService interface { // // { "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 invalid. + // 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 + // invalid. GetAcl(ctx context.Context, request GetAclRequest) (*AclItem, error) // Gets a secret for a given key and scope. This API can only be called from @@ -217,26 +219,26 @@ type SecretsService interface { // the bytes is determined by the caller in DBUtils and the type the data is // decoded into. // - // Throws ``RESOURCE_DOES_NOT_EXIST`` if no such secret or secret scope - // exists. Throws ``PERMISSION_DENIED`` if the user does not have permission + // Throws `RESOURCE_DOES_NOT_EXIST` if no such secret or secret scope + // exists. Throws `PERMISSION_DENIED` if the user does not have permission // to make this API call. // // Note: This is explicitly an undocumented API. It also doesn't need to be // supported for the /preview prefix, because it's not a customer-facing API // (i.e. only used for DBUtils SecretUtils to fetch secrets). // - // Throws ``RESOURCE_DOES_NOT_EXIST`` if no such secret scope or secret - // exists. Throws ``BAD_REQUEST`` if normal user calls get secret outside of - // a notebook. AKV specific errors: Throws ``INVALID_PARAMETER_VALUE`` if - // secret name is not alphanumeric or too long. Throws ``PERMISSION_DENIED`` - // if secret manager cannot access AKV with 403 error Throws - // ``MALFORMED_REQUEST`` if secret manager cannot access AKV with any other + // Throws `RESOURCE_DOES_NOT_EXIST` if no such secret scope or secret + // exists. Throws `BAD_REQUEST` if normal user calls get secret outside of a + // notebook. AKV specific errors: Throws `INVALID_PARAMETER_VALUE` if secret + // name is not alphanumeric or too long. Throws `PERMISSION_DENIED` if + // secret manager cannot access AKV with 403 error Throws + // `MALFORMED_REQUEST` if secret manager cannot access AKV with any other // 4xx error GetSecret(ctx context.Context, request GetSecretRequest) (*GetSecretResponse, error) // Lists the ACLs set on the given scope. // - // Users must have the ``MANAGE`` permission to invoke this API. + // Users must have the `MANAGE` permission to invoke this API. // // Example response: // @@ -245,9 +247,9 @@ type SecretsService interface { // { "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. + // 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. ListAcls(ctx context.Context, request ListAclsRequest) (*ListAclsResponse, error) // Lists all secret scopes available in the workspace. @@ -260,7 +262,7 @@ type SecretsService interface { // "DATABRICKS" },{ "name": "mount-points", "backend_type": "DATABRICKS" }] // } // - // Throws ``PERMISSION_DENIED`` if the user does not have permission to make + // Throws `PERMISSION_DENIED` if the user does not have permission to make // this API call. ListScopes(ctx context.Context) (*ListScopesResponse, error) @@ -278,9 +280,9 @@ type SecretsService interface { // // The lastUpdatedTimestamp returned is in milliseconds since epoch. // - // 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 `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. ListSecrets(ctx context.Context, request ListSecretsRequest) (*ListSecretsResponse, error) // Creates or overwrites the ACL associated with the given principal (user @@ -288,10 +290,11 @@ type SecretsService interface { // use the most powerful permission available to them, and permissions are // ordered as follows: // - // * ``MANAGE`` - Allowed to change ACLs, and read and write to this secret - // scope. * ``WRITE`` - Allowed to read and write to this secret scope. * - // ``READ`` - Allowed to read this secret scope and list what secrets are - // available. + // - `MANAGE` - Allowed to change ACLs, and read and write to this secret + // scope. + // - `WRITE` - Allowed to read and write to this secret scope. + // - `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 @@ -299,7 +302,7 @@ type SecretsService interface { // 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. + // Users must have the `MANAGE` permission to invoke this API. // // Example request: // @@ -311,18 +314,18 @@ type SecretsService interface { // The principal is a user or group name corresponding to an existing // Databricks 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 + // 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. PutAcl(ctx context.Context, request PutAcl) error // Inserts a secret under the provided scope with the given name. If a // secret already exists with the same name, this command overwrites the // existing secret's value. The server encrypts the secret using the secret - // scope's encryption settings before storing it. You must have ``WRITE`` or - // ``MANAGE`` permission on the secret scope. + // scope's encryption settings before storing it. You must have `WRITE` or + // `MANAGE` permission on the secret scope. // // The secret key must consist of alphanumeric characters, dashes, // underscores, and periods, and cannot exceed 128 characters. The maximum @@ -340,13 +343,13 @@ type SecretsService interface { // secret, which will determine the value returned when the secret value is // requested. Exactly one must be specified. // - // Throws ``RESOURCE_DOES_NOT_EXIST`` if no such secret scope exists. Throws - // ``RESOURCE_LIMIT_EXCEEDED`` if maximum number of secrets in scope is - // exceeded. Throws ``INVALID_PARAMETER_VALUE`` if the request parameters - // are invalid. Throws ``PERMISSION_DENIED`` if the user does not have - // permission to make this API call. Throws ``MALFORMED_REQUEST`` if request - // is incorrectly formatted or conflicting. Throws ``BAD_REQUEST`` if - // request is made against Azure KeyVault backed scope. + // Throws `RESOURCE_DOES_NOT_EXIST` if no such secret scope exists. Throws + // `RESOURCE_LIMIT_EXCEEDED` if maximum number of secrets in scope is + // exceeded. Throws `INVALID_PARAMETER_VALUE` if the request parameters are + // invalid. Throws `PERMISSION_DENIED` if the user does not have permission + // to make this API call. Throws `MALFORMED_REQUEST` if request is + // incorrectly formatted or conflicting. Throws `BAD_REQUEST` if request is + // made against Azure KeyVault backed scope. PutSecret(ctx context.Context, request PutSecret) error } @@ -361,10 +364,12 @@ type SecretsService interface { type WorkspaceService interface { // Deletes an object or a directory (and optionally recursively deletes all - // objects in the directory). * If `path` does not exist, this call returns - // an error `RESOURCE_DOES_NOT_EXIST`. * If `path` is a non-empty directory - // and `recursive` is set to `false`, this call returns an error - // `DIRECTORY_NOT_EMPTY`. + // objects in the directory). + // + // - If `path` does not exist, this call returns an error + // `RESOURCE_DOES_NOT_EXIST`. + // - If `path` is a non-empty directory and `recursive` is set to `false`, + // this call returns an error `DIRECTORY_NOT_EMPTY`. // // Object deletion cannot be undone and deleting a directory recursively is // not atomic. diff --git a/service/workspace/model.go b/service/workspace/model.go index b16d5015f..ed91ff3cd 100755 --- a/service/workspace/model.go +++ b/service/workspace/model.go @@ -209,15 +209,15 @@ func (s CreateRepoResponse) MarshalJSON() ([]byte, error) { } type CreateScope struct { - // The metadata for the secret scope if the type is ``AZURE_KEYVAULT`` + // The metadata for the secret scope if the type is `AZURE_KEYVAULT` BackendAzureKeyvault *AzureKeyVaultSecretScopeMetadata `json:"backend_azure_keyvault,omitempty"` - // The principal that is initially granted ``MANAGE`` permission to the + // The principal that is initially granted `MANAGE` permission to the // created scope. InitialManagePrincipal string `json:"initial_manage_principal,omitempty"` // Scope name requested by the user. Scope names are unique. Scope string `json:"scope"` // The backend type the scope will be created with. If not specified, will - // default to ``DATABRICKS`` + // default to `DATABRICKS` ScopeBackendType ScopeBackendType `json:"scope_backend_type,omitempty"` ForceSendFields []string `json:"-" url:"-"` @@ -390,15 +390,16 @@ type ExportRequest struct { // // The value is case sensitive. // - // - `SOURCE`: The notebook is exported as source code. Directory exports - // will not include non-notebook entries. - `HTML`: The notebook is exported - // as an HTML file. - `JUPYTER`: The notebook is exported as a - // Jupyter/IPython Notebook file. - `DBC`: The notebook is exported in - // Databricks archive format. Directory exports will not include - // non-notebook entries. - `R_MARKDOWN`: The notebook is exported to R - // Markdown format. - `AUTO`: The object or directory is exported depending - // on the objects type. Directory exports will include notebooks and - // workspace files. + // - `SOURCE`: The notebook is exported as source code. Directory exports + // will not include non-notebook entries. + // - `HTML`: The notebook is exported as an HTML file. + // - `JUPYTER`: The notebook is exported as a Jupyter/IPython Notebook + // file. + // - `DBC`: The notebook is exported in Databricks archive format. + // Directory exports will not include non-notebook entries. + // - `R_MARKDOWN`: The notebook is exported to R Markdown format. + // - `AUTO`: The object or directory is exported depending on the objects + // type. Directory exports will include notebooks and workspace files. Format ExportFormat `json:"-" url:"format,omitempty"` // The absolute path of the object or directory. Exporting a directory is // only supported for the `DBC`, `SOURCE`, and `AUTO` format. @@ -597,15 +598,17 @@ type Import struct { // // The value is case sensitive. // - // - `AUTO`: The item is imported depending on an analysis of the item's - // extension and the header content provided in the request. If the item is - // imported as a notebook, then the item's extension is automatically - // removed. - `SOURCE`: The notebook or directory is imported as source - // code. - `HTML`: The notebook is imported as an HTML file. - `JUPYTER`: - // The notebook is imported as a Jupyter/IPython Notebook file. - `DBC`: The - // notebook is imported in Databricks archive format. Required for - // directories. - `R_MARKDOWN`: The notebook is imported from R Markdown - // format. + // - `AUTO`: The item is imported depending on an analysis of the item's + // extension and the header content provided in the request. If the item + // is imported as a notebook, then the item's extension is automatically + // removed. + // - `SOURCE`: The notebook or directory is imported as source code. + // - `HTML`: The notebook is imported as an HTML file. + // - `JUPYTER`: The notebook is imported as a Jupyter/IPython Notebook + // file. + // - `DBC`: The notebook is imported in Databricks archive format. + // Required for directories. + // - `R_MARKDOWN`: The notebook is imported from R Markdown format. Format ImportFormat `json:"format,omitempty"` // The language of the object. This value is set only if the object type is // `NOTEBOOK`. @@ -840,13 +843,13 @@ type Mkdirs struct { Path string `json:"path"` } -// The information of the object in workspace. It will be returned by “list“ -// and “get-status“. +// The information of the object in workspace. It will be returned by `list` and +// `get-status`. type ObjectInfo struct { // Only applicable to files. The creation UTC timestamp. CreatedAt int64 `json:"created_at,omitempty"` // The language of the object. This value is set only if the object type is - // ``NOTEBOOK``. For Jupyter (.ipynb) notebooks, this is always ``PYTHON``. + // `NOTEBOOK`. For Jupyter (.ipynb) notebooks, this is always `PYTHON`. Language Language `json:"language,omitempty"` // Only applicable to files, the last modified UTC timestamp. ModifiedAt int64 `json:"modified_at,omitempty"` @@ -854,9 +857,13 @@ type ObjectInfo struct { ObjectId int64 `json:"object_id,omitempty"` // The type of the object in workspace. // - // - `NOTEBOOK`: document that contains runnable code, visualizations, and - // explanatory text. - `DIRECTORY`: directory - `LIBRARY`: library - `FILE`: - // file - `REPO`: repository - `DASHBOARD`: Lakeview dashboard + // - `NOTEBOOK`: document that contains runnable code, visualizations, and + // explanatory text. + // - `DIRECTORY`: directory + // - `LIBRARY`: library + // - `FILE`: file + // - `REPO`: repository + // - `DASHBOARD`: Lakeview dashboard ObjectType ObjectType `json:"object_type,omitempty"` // The absolute path of the object. Path string `json:"path,omitempty"` @@ -1198,7 +1205,7 @@ func (s SecretMetadata) MarshalJSON() ([]byte, error) { type SecretScope struct { // The type of secret scope backend. BackendType ScopeBackendType `json:"backend_type,omitempty"` - // 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 `json:"keyvault_metadata,omitempty"` // A unique name to identify the secret scope. Name string `json:"name,omitempty"` diff --git a/workspace_client.go b/workspace_client.go index 26e1c72cc..1ee96d6d4 100755 --- a/workspace_client.go +++ b/workspace_client.go @@ -141,21 +141,26 @@ type WorkspaceClient struct { // attribute values can be used during cluster creation. Cluster policies // have ACLs that limit their use to specific users and groups. // - // With cluster policies, you can: - Auto-install cluster libraries on the - // next restart by listing them in the policy's "libraries" field (Public - // Preview). - Limit users to creating clusters with the prescribed - // settings. - Simplify the user interface, enabling more users to create - // clusters, by fixing and hiding some fields. - Manage costs by setting - // limits on attributes that impact the hourly rate. + // With cluster policies, you can: + // + // - Auto-install cluster libraries on the next restart by listing them in + // the policy's "libraries" field (Public Preview). + // - Limit users to creating clusters with the prescribed settings. + // - Simplify the user interface, enabling more users to create clusters, + // by fixing and hiding some fields. + // - Manage costs by setting limits on attributes that impact the hourly + // rate. // // Cluster policy permissions limit which policies a user can select in the - // Policy drop-down when the user creates a cluster: - A user who has - // unrestricted cluster create permission can select the Unrestricted policy - // and create fully-configurable clusters. - A user who has both - // unrestricted cluster create permission and access to cluster policies can - // select the Unrestricted policy and policies they have access to. - A user - // that has access to only cluster policies, can select the policies they - // have access to. + // Policy drop-down when the user creates a cluster: + // + // - A user who has unrestricted cluster create permission can select the + // Unrestricted policy and create fully-configurable clusters. + // - A user who has both unrestricted cluster create permission and access + // to cluster policies can select the Unrestricted policy and policies + // they have access to. + // - A user that has access to only cluster policies, can select the + // policies they have access to. // // If no policies exist in the workspace, the Policy drop-down doesn't // appear. Only admin users can create, edit, and delete policies. Admin @@ -306,12 +311,10 @@ type WorkspaceClient struct { // // There are three levels of permission: // - // - `CAN_VIEW`: Allows read-only access - // - // - `CAN_RUN`: Allows read access and run access (superset of `CAN_VIEW`) - // - // - `CAN_MANAGE`: Allows all actions: read, run, edit, delete, modify - // permissions (superset of `CAN_RUN`) + // - `CAN_VIEW`: Allows read-only access + // - `CAN_RUN`: Allows read access and run access (superset of `CAN_VIEW`) + // - `CAN_MANAGE`: Allows all actions: read, run, edit, delete, modify + // permissions (superset of `CAN_RUN`) // // **Warning**: This API is deprecated. Please see the latest version of the // Databricks SQL API. [Learn more] @@ -421,7 +424,7 @@ type WorkspaceClient struct { // can be invoked wherever a table reference is allowed in a query. In Unity // Catalog, a function resides at the same level as a table, so it can be // referenced with the form - // __catalog_name__.__schema_name__.__function_name__. + // **catalog_name**.**schema_name**.**function_name**. Functions catalog.FunctionsInterface // Genie provides a no-code experience for business users, powered by AI/BI. @@ -508,10 +511,12 @@ type WorkspaceClient struct { // allowed for this workspace. There is support for allow lists (inclusion) // and block lists (exclusion). // - // When a connection is attempted: 1. **First, all block lists are - // checked.** If the connection IP address matches any block list, the - // connection is rejected. 2. **If the connection was not rejected by block - // lists**, the IP address is compared with the allow lists. + // When a connection is attempted: + // + // 1. **First, all block lists are checked.** If the connection IP address + // matches any block list, the connection is rejected. + // 2. **If the connection was not rejected by block lists**, the IP address + // is compared with the allow lists. // // If there is at least one allow list for the workspace, the connection is // allowed only if the IP address matches an allow list. If there are no @@ -598,11 +603,10 @@ type WorkspaceClient struct { Metastores catalog.MetastoresInterface // Note: This API reference documents APIs for the Workspace Model Registry. - // Databricks recommends using [Models in Unity - // Catalog](/api/workspace/registeredmodels) instead. Models in Unity - // Catalog provides centralized model governance, cross-workspace access, - // lineage, and deployment. Workspace Model Registry will be deprecated in - // the future. + // Databricks recommends using Models in Unity Catalog instead. Models in + // Unity Catalog provides centralized model governance, cross-workspace + // access, lineage, and deployment. Workspace Model Registry will be + // deprecated in the future. // // The Workspace Model Registry is a centralized model repository and a UI // and set of APIs that enable you to manage the full lifecycle of MLflow @@ -615,8 +619,8 @@ type WorkspaceClient struct { // workspaces. // // This API reference documents the REST endpoints for managing model - // versions in Unity Catalog. For more details, see the [registered models - // API docs](/api/workspace/registeredmodels). + // versions in Unity Catalog. For more details, see the registered models + // API docs. ModelVersions catalog.ModelVersionsInterface // The notification destinations API lets you programmatically manage a @@ -635,35 +639,37 @@ type WorkspaceClient struct { PermissionMigration iam.PermissionMigrationInterface // Permissions API are used to create read, write, edit, update and manage - // access for various users on different objects and endpoints. * **[Apps - // permissions](:service:apps)** — Manage which users can manage or use - // apps. * **[Cluster permissions](:service:clusters)** — Manage which - // users can manage, restart, or attach to clusters. * **[Cluster policy - // permissions](:service:clusterpolicies)** — Manage which users can use - // cluster policies. * **[Spark Declarative Pipelines - // permissions](:service:pipelines)** — Manage which users can view, - // manage, run, cancel, or own a Spark Declarative Pipeline. * **[Job - // permissions](:service:jobs)** — Manage which users can view, manage, - // trigger, cancel, or own a job. * **[MLflow experiment - // permissions](:service:experiments)** — Manage which users can read, - // edit, or manage MLflow experiments. * **[MLflow registered model - // permissions](:service:modelregistry)** — Manage which users can read, - // edit, or manage MLflow registered models. * **[Instance Pool - // permissions](:service:instancepools)** — Manage which users can manage - // or attach to pools. * **[Repo permissions](repos)** — Manage which - // users can read, run, edit, or manage a repo. * **[Serving endpoint - // permissions](:service:servingendpoints)** — Manage which users can - // view, query, or manage a serving endpoint. * **[SQL warehouse - // permissions](:service:warehouses)** — Manage which users can use or - // manage SQL warehouses. * **[Token - // permissions](:service:tokenmanagement)** — Manage which users can - // create or use tokens. * **[Workspace object - // permissions](:service:workspace)** — Manage which users can read, run, - // edit, or manage alerts, dbsql-dashboards, directories, files, notebooks - // and queries. For the mapping of the required permissions for specific - // actions or abilities and other important information, see [Access - // Control]. Note that to manage access control on service principals, use - // **[Account Access Control Proxy](:service:accountaccesscontrolproxy)**. + // access for various users on different objects and endpoints. + // + // - **Apps permissions** — Manage which users can manage or use apps. + // - **Cluster permissions** — Manage which users can manage, restart, + // or attach to clusters. + // - **Cluster policy permissions** — Manage which users can use cluster + // policies. + // - **Spark Declarative Pipelines permissions** — Manage which users + // can view, manage, run, cancel, or own a Spark Declarative Pipeline. + // - **Job permissions** — Manage which users can view, manage, trigger, + // cancel, or own a job. + // - **MLflow experiment permissions** — Manage which users can read, + // edit, or manage MLflow experiments. + // - **MLflow registered model permissions** — Manage which users can + // read, edit, or manage MLflow registered models. + // - **Instance Pool permissions** — Manage which users can manage or + // attach to pools. + // - **Repo permissions** — Manage which users can read, run, edit, or + // manage a repo. + // - **Serving endpoint permissions** — Manage which users can view, + // query, or manage a serving endpoint. + // - **SQL warehouse permissions** — Manage which users can use or + // manage SQL warehouses. + // - **Token permissions** — Manage which users can create or use + // tokens. + // - **Workspace object permissions** — Manage which users can read, + // run, edit, or manage alerts, dbsql-dashboards, directories, files, + // notebooks and queries. For the mapping of the required permissions + // for specific actions or abilities and other important information, + // see [Access Control]. Note that to manage access control on service + // principals, use **Account Access Control Proxy**. // // [Access Control]: https://docs.databricks.com/security/auth-authz/access-control/index.html Permissions iam.PermissionsInterface @@ -860,16 +866,20 @@ type WorkspaceClient struct { // tokens. It validates the OIDC claims in federated tokens and is set at // the recipient level. The caller must be the owner of the recipient to // create or manage a federation policy. Federation policies support the - // following scenarios: - User-to-Machine (U2M) flow: A user accesses Delta - // Shares using their own identity, such as connecting through PowerBI Delta - // Sharing Client. - Machine-to-Machine (M2M) flow: An application accesses - // Delta Shares using its own identity, typically for automation tasks like - // nightly jobs through Python Delta Sharing Client. OIDC Token Federation - // enables fine-grained access control, supports Multi-Factor Authentication - // (MFA), and enhances security by minimizing the risk of credential leakage - // through the use of short-lived, expiring tokens. It is designed for - // strong identity governance, secure cross-platform data sharing, and - // reduced operational overhead for credential management. + // following scenarios: + // + // - User-to-Machine (U2M) flow: A user accesses Delta Shares using their + // own identity, such as connecting through PowerBI Delta Sharing + // Client. + // - Machine-to-Machine (M2M) flow: An application accesses Delta Shares + // using its own identity, typically for automation tasks like nightly + // jobs through Python Delta Sharing Client. OIDC Token Federation + // enables fine-grained access control, supports Multi-Factor + // Authentication (MFA), and enhances security by minimizing the risk of + // credential leakage through the use of short-lived, expiring tokens. + // It is designed for strong identity governance, secure cross-platform + // data sharing, and reduced operational overhead for credential + // management. // // For more information, see // https://www.databricks.com/blog/announcing-oidc-token-federation-enhanced-delta-sharing-security @@ -882,18 +892,18 @@ type WorkspaceClient struct { // how sharing works differs depending on whether or not your recipient has // access to a Databricks workspace that is enabled for Unity Catalog: // - // - For recipients with access to a Databricks workspace that is enabled - // for Unity Catalog, you can create a recipient object along with a unique - // sharing identifier you get from the recipient. The sharing identifier is - // the key identifier that enables the secure connection. This sharing mode - // is called **Databricks-to-Databricks sharing**. - // - // - For recipients without access to a Databricks workspace that is enabled - // for Unity Catalog, when you create a recipient object, Databricks - // generates an activation link you can send to the recipient. The recipient - // follows the activation link to download the credential file, and then - // uses the credential file to establish a secure connection to receive the - // shared data. This sharing mode is called **open sharing**. + // - For recipients with access to a Databricks workspace that is enabled + // for Unity Catalog, you can create a recipient object along with a + // unique sharing identifier you get from the recipient. The sharing + // identifier is the key identifier that enables the secure connection. + // This sharing mode is called **Databricks-to-Databricks sharing**. + // - For recipients without access to a Databricks workspace that is + // enabled for Unity Catalog, when you create a recipient object, + // Databricks generates an activation link you can send to the + // recipient. The recipient follows the activation link to download the + // credential file, and then uses the credential file to establish a + // secure connection to receive the shared data. This sharing mode is + // called **open sharing**. Recipients sharing.RecipientsInterface // Redash V2 service for workspace configurations (internal) @@ -917,15 +927,16 @@ type WorkspaceClient struct { // permissions on the enclosing schema. In addition, the following // additional privileges are required for various operations: // - // * To create a registered model, users must additionally have the - // CREATE_MODEL permission on the target schema. * To view registered model - // or model version metadata, model version data files, or invoke a model - // version, users must additionally have the EXECUTE permission on the - // registered model * To update registered model or model version tags, - // users must additionally have APPLY TAG permissions on the registered - // model * To update other registered model or model version metadata - // (comments, aliases) create a new model version, or update permissions on - // the registered model, users must be owners of the registered model. + // - To create a registered model, users must additionally have the + // CREATE_MODEL permission on the target schema. + // - To view registered model or model version metadata, model version + // data files, or invoke a model version, users must additionally have + // the EXECUTE permission on the registered model + // - To update registered model or model version tags, users must + // additionally have APPLY TAG permissions on the registered model + // - To update other registered model or model version metadata (comments, + // aliases) create a new model version, or update permissions on the + // registered model, users must be owners of the registered model. // // Note: The securable type for models is FUNCTION. When using REST APIs // (e.g. tagging, grants) that specify a securable type, use FUNCTION as the @@ -1081,23 +1092,28 @@ type WorkspaceClient struct { // asynchronous mode, or it can be set to `CANCEL`, which cancels the // statement. // - // In summary: - **Synchronous mode** (`wait_timeout=30s` and - // `on_wait_timeout=CANCEL`): The call waits up to 30 seconds; if the - // statement execution finishes within this time, the result data is - // returned directly in the response. If the execution takes longer than 30 - // seconds, the execution is canceled and the call returns with a `CANCELED` - // state. - **Asynchronous mode** (`wait_timeout=0s` and `on_wait_timeout` - // is ignored): The call doesn't wait for the statement to finish but - // returns directly with a statement ID. The status of the statement - // execution can be polled by issuing - // :method:statementexecution/getStatement with the statement ID. Once the - // execution has succeeded, this call also returns the result and metadata - // in the response. - **[Default] Hybrid mode** (`wait_timeout=10s` and - // `on_wait_timeout=CONTINUE`): The call waits for up to 10 seconds; if the - // statement execution finishes within this time, the result data is - // returned directly in the response. If the execution takes longer than 10 - // seconds, a statement ID is returned. The statement ID can be used to - // fetch status and results in the same way as in the asynchronous mode. + // In summary: + // + // - **Synchronous mode** (`wait_timeout=30s` and + // `on_wait_timeout=CANCEL`): The call waits up to 30 seconds; if the + // statement execution finishes within this time, the result data is + // returned directly in the response. If the execution takes longer than + // 30 seconds, the execution is canceled and the call returns with a + // `CANCELED` state. + // - **Asynchronous mode** (`wait_timeout=0s` and `on_wait_timeout` is + // ignored): The call doesn't wait for the statement to finish but + // returns directly with a statement ID. The status of the statement + // execution can be polled by issuing + // :method:statementexecution/getStatement with the statement ID. Once + // the execution has succeeded, this call also returns the result and + // metadata in the response. + // - **[Default] Hybrid mode** (`wait_timeout=10s` and + // `on_wait_timeout=CONTINUE`): The call waits for up to 10 seconds; if + // the statement execution finishes within this time, the result data is + // returned directly in the response. If the execution takes longer than + // 10 seconds, a statement ID is returned. The statement ID can be used + // to fetch status and results in the same way as in the asynchronous + // mode. // // Depending on the size, the result can be split into multiple chunks. If // the statement execution is successful, the statement response contains a @@ -1121,14 +1137,14 @@ type WorkspaceClient struct { // There are two ways to receive statement results, controlled by the // `disposition` setting, which can be either `INLINE` or `EXTERNAL_LINKS`: // - // - `INLINE`: In this mode, the result data is directly included in the - // response. It's best suited for smaller results. This mode can only be - // used with the `JSON_ARRAY` format. - // - // - `EXTERNAL_LINKS`: In this mode, the response provides links that can be - // used to download the result data in chunks separately. This approach is - // ideal for larger results and offers higher throughput. This mode can be - // used with all the formats: `JSON_ARRAY`, `ARROW_STREAM`, and `CSV`. + // - `INLINE`: In this mode, the result data is directly included in the + // response. It's best suited for smaller results. This mode can only be + // used with the `JSON_ARRAY` format. + // - `EXTERNAL_LINKS`: In this mode, the response provides links that can + // be used to download the result data in chunks separately. This + // approach is ideal for larger results and offers higher throughput. + // This mode can be used with all the formats: `JSON_ARRAY`, + // `ARROW_STREAM`, and `CSV`. // // By default, the API uses `format=JSON_ARRAY` and `disposition=INLINE`. // @@ -1137,25 +1153,28 @@ type WorkspaceClient struct { // Note: The byte limit for INLINE disposition is based on internal storage // metrics and will not exactly match the byte count of the actual payload. // - // - Statements with `disposition=INLINE` are limited to 25 MiB and will - // fail when this limit is exceeded. - Statements with - // `disposition=EXTERNAL_LINKS` are limited to 100 GiB. Result sets larger - // than this limit will be truncated. Truncation is indicated by the - // `truncated` field in the result manifest. - The maximum query text size - // is 16 MiB. - Cancelation might silently fail. A successful response from - // a cancel request indicates that the cancel request was successfully - // received and sent to the processing engine. However, an outstanding - // statement might have already completed execution when the cancel request - // arrives. Polling for status until a terminal state is reached is a - // reliable way to determine the final state. - Wait timeouts are - // approximate, occur server-side, and cannot account for things such as - // caller delays and network latency from caller to service. - To guarantee - // that the statement is kept alive, you must poll at least once every 15 - // minutes. - The results are only available for one hour after success; - // polling does not extend this. - The SQL Execution API must be used for - // the entire lifecycle of the statement. For example, you cannot use the - // Jobs API to execute the command, and then the SQL Execution API to cancel - // it. + // - Statements with `disposition=INLINE` are limited to 25 MiB and will + // fail when this limit is exceeded. + // - Statements with `disposition=EXTERNAL_LINKS` are limited to 100 GiB. + // Result sets larger than this limit will be truncated. Truncation is + // indicated by the `truncated` field in the result manifest. + // - The maximum query text size is 16 MiB. + // - Cancelation might silently fail. A successful response from a cancel + // request indicates that the cancel request was successfully received + // and sent to the processing engine. However, an outstanding statement + // might have already completed execution when the cancel request + // arrives. Polling for status until a terminal state is reached is a + // reliable way to determine the final state. + // - Wait timeouts are approximate, occur server-side, and cannot account + // for things such as caller delays and network latency from caller to + // service. + // - To guarantee that the statement is kept alive, you must poll at least + // once every 15 minutes. + // - The results are only available for one hour after success; polling + // does not extend this. + // - The SQL Execution API must be used for the entire lifecycle of the + // statement. For example, you cannot use the Jobs API to execute the + // command, and then the SQL Execution API to cancel it. // // [Apache Arrow Columnar]: https://arrow.apache.org/overview/ // [Databricks SQL Statement Execution API tutorial]: https://docs.databricks.com/sql/api/sql-execution-tutorial.html @@ -1208,7 +1227,7 @@ type WorkspaceClient struct { // USE_CATALOG permission on its parent catalog and the USE_SCHEMA // permission on its parent schema. // - // A table can be managed or external. From an API perspective, a __VIEW__ + // A table can be managed or external. From an API perspective, a **VIEW** // is a particular kind of table (rather than a managed or external table). Tables catalog.TablesInterface @@ -1318,12 +1337,14 @@ type WorkspaceClient struct { // supports real-time and efficient approximate nearest neighbor (ANN) // search queries. // - // There are 2 types of AI Search indexes: - **Delta Sync Index**: An index - // that automatically syncs with a source Delta Table, automatically and - // incrementally updating the index as the underlying data in the Delta - // Table changes. - **Direct Vector Access Index**: An index that supports - // direct read and write of vectors and metadata through our REST and SDK - // APIs. With this model, the user manages index updates. + // There are 2 types of AI Search indexes: + // + // - **Delta Sync Index**: An index that automatically syncs with a source + // Delta Table, automatically and incrementally updating the index as + // the underlying data in the Delta Table changes. + // - **Direct Vector Access Index**: An index that supports direct read + // and write of vectors and metadata through our REST and SDK APIs. With + // this model, the user manages index updates. VectorSearchIndexes vectorsearch.VectorSearchIndexesInterface // Volumes are a Unity Catalog (UC) capability for accessing, storing, @@ -1351,15 +1372,15 @@ type WorkspaceClient struct { // code, visualizations, and explanatory text. Workspace workspace.WorkspaceInterface - // A securable in Databricks can be configured as __OPEN__ or __ISOLATED__. - // An __OPEN__ securable can be accessed from any workspace, while an - // __ISOLATED__ securable can only be accessed from a configured list of + // A securable in Databricks can be configured as **OPEN** or **ISOLATED**. + // An **OPEN** securable can be accessed from any workspace, while an + // **ISOLATED** securable can only be accessed from a configured list of // workspaces. This API allows you to configure (bind) securables to // workspaces. // - // NOTE: The __isolation_mode__ is configured for the securable itself + // NOTE: The **isolation_mode** is configured for the securable itself // (using its Update method) and the workspace bindings are only consulted - // when the securable's __isolation_mode__ is set to __ISOLATED__. + // when the securable's **isolation_mode** is set to **ISOLATED**. // // A securable's workspace bindings can be configured by a metastore admin // or the owner of the securable. @@ -1371,8 +1392,12 @@ type WorkspaceClient struct { // introduces the ability to bind a securable in READ_ONLY mode (catalogs // only). // - // Securable types that support binding: - catalog - storage_credential - - // credential - external_location + // Securable types that support binding: + // + // - catalog + // - storage_credential + // - credential + // - external_location WorkspaceBindings catalog.WorkspaceBindingsInterface // This API allows updating known workspace settings for advanced users.