@databricks/sdk-uc-connections 0.1.0-dev.3 → 0.1.0-dev.5

package/src/v1/client.ts

@@ -1,250 +0,0 @@
-// Code generated from API definition by Databricks SDK Generator. DO NOT EDIT.
-
-import {VERSION as AUTH_VERSION} from '@databricks/sdk-auth';
-import {createDefault} from '@databricks/sdk-core/clientinfo';
-import type {Logger} from '@databricks/sdk-core/logger';
-import {NoOpLogger} from '@databricks/sdk-core/logger';
-import type {CallOptions} from '@databricks/sdk-options/call';
-import type {ClientOptions} from '@databricks/sdk-options/client';
-import type {HttpClient} from '@databricks/sdk-core/http';
-import {newHttpClient} from './transport';
-import {
-  buildHttpRequest,
-  executeCall,
-  executeHttpCall,
-  marshalRequest,
-  parseResponse,
-} from './utils';
-import pkgJson from '../../package.json' with {type: 'json'};
-import type {
-  ConnectionInfo,
-  CreateConnectionRequest,
-  DeleteConnectionRequest,
-  DeleteConnectionResponse,
-  GetConnectionRequest,
-  ListConnectionsRequest,
-  ListConnectionsResponse,
-  UpdateConnectionRequest,
-} from './model';
-import {
-  marshalCreateConnectionRequestSchema,
-  marshalUpdateConnectionRequestSchema,
-  unmarshalConnectionInfoSchema,
-  unmarshalDeleteConnectionResponseSchema,
-  unmarshalListConnectionsResponseSchema,
-} from './model';
-
-// Package identity segment for this client to be used in the User-Agent header.
-const PACKAGE_SEGMENT = {
-  key: 'sdk-js-' + pkgJson.name.replace(/^@[^/]+\/sdk-/, ''),
-  value: pkgJson.version,
-};
-
-export class ConnectionsClient {
-  private readonly host: string;
-  // Workspace ID used to route workspace-level calls on unified hosts (SPOG).
-  // When set, workspace-level methods send X-Databricks-Org-Id on every
-  // request.
-  private readonly workspaceId: string | undefined;
-  private readonly httpClient: HttpClient;
-  private readonly logger: Logger;
-  // User-Agent header value. Composed once at construction from
-  // createDefault() merged with this package's identity and the active
-  // credential's name.
-  private readonly userAgent: string;
-
-  constructor(options: ClientOptions) {
-    if (options.host === undefined) {
-      throw new Error('Host is required.');
-    }
-    this.host = options.host.replace(/\/$/, '');
-    this.workspaceId = options.workspaceId;
-    this.logger = options.logger ?? new NoOpLogger();
-    const info = createDefault()
-      .with(PACKAGE_SEGMENT)
-      .with({key: 'sdk-js-auth', value: AUTH_VERSION})
-      .with({key: 'auth', value: options.credentials?.name() ?? 'default'});
-    this.userAgent = info.toString();
-    this.httpClient = newHttpClient(options);
-  }
-
-  /**
-   * Creates a new connection
-   *
-   * Creates a new connection to an external data source. It allows users to specify connection details and
-   * configurations for interaction with the external server.
-   */
-  async createConnection(
-    req: CreateConnectionRequest,
-    options?: CallOptions
-  ): Promise<ConnectionInfo> {
-    const url = `${this.host}/api/2.1/unity-catalog/connections`;
-    const body = marshalRequest(req, marshalCreateConnectionRequestSchema);
-    let resp: ConnectionInfo | undefined;
-    const call = async (callSignal?: AbortSignal): Promise<void> => {
-      const headers = new Headers({'Content-Type': 'application/json'});
-      if (this.workspaceId !== undefined) {
-        headers.set('X-Databricks-Org-Id', this.workspaceId);
-      }
-      headers.set('User-Agent', this.userAgent);
-      const httpReq = buildHttpRequest('POST', url, headers, callSignal, body);
-      const respBody = await executeHttpCall({
-        request: httpReq,
-        httpClient: this.httpClient,
-        logger: this.logger,
-      });
-      resp = parseResponse(respBody, unmarshalConnectionInfoSchema);
-    };
-    await executeCall(call, options);
-    if (resp === undefined) {
-      throw new Error('operation completed without a result.');
-    }
-    return resp;
-  }
-
-  /** Deletes the connection that matches the supplied name. */
-  async deleteConnection(
-    req: DeleteConnectionRequest,
-    options?: CallOptions
-  ): Promise<DeleteConnectionResponse> {
-    const url = `${this.host}/api/2.1/unity-catalog/connections/${req.nameArg ?? ''}`;
-    let resp: DeleteConnectionResponse | undefined;
-    const call = async (callSignal?: AbortSignal): Promise<void> => {
-      const headers = new Headers();
-      if (this.workspaceId !== undefined) {
-        headers.set('X-Databricks-Org-Id', this.workspaceId);
-      }
-      headers.set('User-Agent', this.userAgent);
-      const httpReq = buildHttpRequest('DELETE', url, headers, callSignal);
-      const respBody = await executeHttpCall({
-        request: httpReq,
-        httpClient: this.httpClient,
-        logger: this.logger,
-      });
-      resp = parseResponse(respBody, unmarshalDeleteConnectionResponseSchema);
-    };
-    await executeCall(call, options);
-    if (resp === undefined) {
-      throw new Error('operation completed without a result.');
-    }
-    return resp;
-  }
-
-  /** Gets a connection from it's name. */
-  async getConnection(
-    req: GetConnectionRequest,
-    options?: CallOptions
-  ): Promise<ConnectionInfo> {
-    const url = `${this.host}/api/2.1/unity-catalog/connections/${req.nameArg ?? ''}`;
-    let resp: ConnectionInfo | undefined;
-    const call = async (callSignal?: AbortSignal): Promise<void> => {
-      const headers = new Headers();
-      if (this.workspaceId !== undefined) {
-        headers.set('X-Databricks-Org-Id', this.workspaceId);
-      }
-      headers.set('User-Agent', this.userAgent);
-      const httpReq = buildHttpRequest('GET', url, headers, callSignal);
-      const respBody = await executeHttpCall({
-        request: httpReq,
-        httpClient: this.httpClient,
-        logger: this.logger,
-      });
-      resp = parseResponse(respBody, unmarshalConnectionInfoSchema);
-    };
-    await executeCall(call, options);
-    if (resp === undefined) {
-      throw new Error('operation completed without a result.');
-    }
-    return resp;
-  }
-
-  /**
-   * List all connections.
-   *
-   * NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls will be deprecated soon.
-   *
-   * PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while still providing a next_page_token.
-   * Clients must continue reading pages until next_page_token is absent, which is the only indication that the end of results has been reached.
-   */
-  async listConnections(
-    req: ListConnectionsRequest,
-    options?: CallOptions
-  ): Promise<ListConnectionsResponse> {
-    const url = `${this.host}/api/2.1/unity-catalog/connections`;
-    const params = new URLSearchParams();
-    if (req.maxResults !== undefined) {
-      params.append('max_results', String(req.maxResults));
-    }
-    if (req.pageToken !== undefined) {
-      params.append('page_token', req.pageToken);
-    }
-    const query = params.toString();
-    const fullUrl = query !== '' ? `${url}?${query}` : url;
-    let resp: ListConnectionsResponse | undefined;
-    const call = async (callSignal?: AbortSignal): Promise<void> => {
-      const headers = new Headers();
-      if (this.workspaceId !== undefined) {
-        headers.set('X-Databricks-Org-Id', this.workspaceId);
-      }
-      headers.set('User-Agent', this.userAgent);
-      const httpReq = buildHttpRequest('GET', fullUrl, headers, callSignal);
-      const respBody = await executeHttpCall({
-        request: httpReq,
-        httpClient: this.httpClient,
-        logger: this.logger,
-      });
-      resp = parseResponse(respBody, unmarshalListConnectionsResponseSchema);
-    };
-    await executeCall(call, options);
-    if (resp === undefined) {
-      throw new Error('operation completed without a result.');
-    }
-    return resp;
-  }
-
-  async *listConnectionsIter(
-    req: ListConnectionsRequest,
-    options?: CallOptions
-  ): AsyncGenerator<ConnectionInfo> {
-    const pageReq: ListConnectionsRequest = {...req};
-    for (;;) {
-      const resp = await this.listConnections(pageReq, options);
-      for (const item of resp.connections ?? []) {
-        yield item;
-      }
-      if (resp.nextPageToken === undefined || resp.nextPageToken === '') {
-        return;
-      }
-      pageReq.pageToken = resp.nextPageToken;
-    }
-  }
-
-  /** Updates the connection that matches the supplied name. */
-  async updateConnection(
-    req: UpdateConnectionRequest,
-    options?: CallOptions
-  ): Promise<ConnectionInfo> {
-    const url = `${this.host}/api/2.1/unity-catalog/connections/${req.nameArg ?? ''}`;
-    const body = marshalRequest(req, marshalUpdateConnectionRequestSchema);
-    let resp: ConnectionInfo | undefined;
-    const call = async (callSignal?: AbortSignal): Promise<void> => {
-      const headers = new Headers({'Content-Type': 'application/json'});
-      if (this.workspaceId !== undefined) {
-        headers.set('X-Databricks-Org-Id', this.workspaceId);
-      }
-      headers.set('User-Agent', this.userAgent);
-      const httpReq = buildHttpRequest('PATCH', url, headers, callSignal, body);
-      const respBody = await executeHttpCall({
-        request: httpReq,
-        httpClient: this.httpClient,
-        logger: this.logger,
-      });
-      resp = parseResponse(respBody, unmarshalConnectionInfoSchema);
-    };
-    await executeCall(call, options);
-    if (resp === undefined) {
-      throw new Error('operation completed without a result.');
-    }
-    return resp;
-  }
-}

package/src/v1/index.ts

@@ -1,28 +0,0 @@
-// Code generated from API definition by Databricks SDK Generator. DO NOT EDIT.
-
-export {ConnectionsClient} from './client';
-
-export {
-  ConnectionType,
-  CredentialType,
-  SecurableType,
-  ProvisioningInfo_State,
-} from './model';
-
-export type {
-  ConnectionInfo,
-  ConnectionInfo_OptionsEntry,
-  ConnectionInfo_PropertiesEntry,
-  CreateConnectionRequest,
-  CreateConnectionRequest_OptionsEntry,
-  CreateConnectionRequest_PropertiesEntry,
-  DeleteConnectionRequest,
-  DeleteConnectionResponse,
-  GetConnectionRequest,
-  ListConnectionsRequest,
-  ListConnectionsResponse,
-  ProvisioningInfo,
-  UpdateConnectionRequest,
-  UpdateConnectionRequest_OptionsEntry,
-  UpdateConnectionRequest_PropertiesEntry,
-} from './model';