@databricks/sdk-uc-volumes 0.1.0-dev.2 → 0.1.0-dev.4

package/src/v1/client.ts

@@ -1,314 +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 {
-  CreateVolumeRequest,
-  DeleteVolumeRequest,
-  DeleteVolumeRequest_Response,
-  GetVolumeRequest,
-  ListVolumesRequest,
-  ListVolumesRequest_Response,
-  UpdateVolumeRequest,
-  VolumeInfo,
-} from './model';
-import {
-  marshalCreateVolumeRequestSchema,
-  marshalUpdateVolumeRequestSchema,
-  unmarshalDeleteVolumeRequest_ResponseSchema,
-  unmarshalListVolumesRequest_ResponseSchema,
-  unmarshalVolumeInfoSchema,
-} 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 VolumesClient {
-  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 volume.
-   *
-   * The user could create either an external volume or a managed volume. An external volume
-   * will be created in the specified external location, while a managed volume
-   * will be located in the default location which is specified by the parent schema,
-   * or the parent catalog, or the Metastore.
-   *
-   * For the volume creation to succeed, the user must satisfy following conditions:
-   * - The caller must be a metastore admin, or be the owner of the parent catalog and schema,
-   * or have the **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.
-   */
-  async createVolume(
-    req: CreateVolumeRequest,
-    options?: CallOptions
-  ): Promise<VolumeInfo> {
-    const url = `${this.host}/api/2.1/unity-catalog/volumes`;
-    const body = marshalRequest(req, marshalCreateVolumeRequestSchema);
-    let resp: VolumeInfo | 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, unmarshalVolumeInfoSchema);
-    };
-    await executeCall(call, options);
-    if (resp === undefined) {
-      throw new Error('operation completed without a result.');
-    }
-    return resp;
-  }
-
-  /**
-   * Deletes a volume from the specified parent catalog and schema.
-   *
-   * The caller must be a metastore admin or an owner of the volume.
-   * For the latter case, the caller must also be the owner or have the **USE_CATALOG**
-   * privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema.
-   */
-  async deleteVolume(
-    req: DeleteVolumeRequest,
-    options?: CallOptions
-  ): Promise<DeleteVolumeRequest_Response> {
-    const url = `${this.host}/api/2.1/unity-catalog/volumes/${req.fullNameArg ?? ''}`;
-    let resp: DeleteVolumeRequest_Response | 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,
-        unmarshalDeleteVolumeRequest_ResponseSchema
-      );
-    };
-    await executeCall(call, options);
-    if (resp === undefined) {
-      throw new Error('operation completed without a result.');
-    }
-    return resp;
-  }
-
-  /**
-   * Gets a volume from the metastore for a specific catalog and schema.
-   *
-   * The caller must be a metastore admin or an owner of (or have the **READ VOLUME**
-   * privilege on) the volume.
-   * For the latter case, the caller must also be the owner or have the **USE_CATALOG**
-   * privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema.
-   */
-  async getVolume(
-    req: GetVolumeRequest,
-    options?: CallOptions
-  ): Promise<VolumeInfo> {
-    const url = `${this.host}/api/2.1/unity-catalog/volumes/${req.fullNameArg ?? ''}`;
-    const params = new URLSearchParams();
-    if (req.includeBrowse !== undefined) {
-      params.append('include_browse', String(req.includeBrowse));
-    }
-    const query = params.toString();
-    const fullUrl = query !== '' ? `${url}?${query}` : url;
-    let resp: VolumeInfo | 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, unmarshalVolumeInfoSchema);
-    };
-    await executeCall(call, options);
-    if (resp === undefined) {
-      throw new Error('operation completed without a result.');
-    }
-    return resp;
-  }
-
-  /**
-   * Gets an array of volumes for the current metastore
-   * under the parent catalog and schema.
-   *
-   * The returned volumes are filtered based on the privileges of the calling user.
-   * For example, the metastore admin is able to list all the volumes.
-   * A regular user needs to be the owner or have the **READ VOLUME** privilege
-   * on the volume to receive the volumes in the response.
-   * For the latter case, the caller must also be the owner or have the **USE_CATALOG**
-   * privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema.
-   *
-   * There is no guarantee of a specific ordering of the elements in the array.
-   *
-   * PAGINATION BEHAVIOR: The API is by default paginated, 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 listVolumes(
-    req: ListVolumesRequest,
-    options?: CallOptions
-  ): Promise<ListVolumesRequest_Response> {
-    const url = `${this.host}/api/2.1/unity-catalog/volumes`;
-    const params = new URLSearchParams();
-    if (req.catalogName !== undefined) {
-      params.append('catalog_name', req.catalogName);
-    }
-    if (req.schemaName !== undefined) {
-      params.append('schema_name', req.schemaName);
-    }
-    if (req.includeBrowse !== undefined) {
-      params.append('include_browse', String(req.includeBrowse));
-    }
-    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: ListVolumesRequest_Response | 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,
-        unmarshalListVolumesRequest_ResponseSchema
-      );
-    };
-    await executeCall(call, options);
-    if (resp === undefined) {
-      throw new Error('operation completed without a result.');
-    }
-    return resp;
-  }
-
-  async *listVolumesIter(
-    req: ListVolumesRequest,
-    options?: CallOptions
-  ): AsyncGenerator<VolumeInfo> {
-    const pageReq: ListVolumesRequest = {...req};
-    for (;;) {
-      const resp = await this.listVolumes(pageReq, options);
-      for (const item of resp.volumes ?? []) {
-        yield item;
-      }
-      if (resp.nextPageToken === undefined || resp.nextPageToken === '') {
-        return;
-      }
-      pageReq.pageToken = resp.nextPageToken;
-    }
-  }
-
-  /**
-   * Updates the specified volume under the specified parent catalog and schema.
-   *
-   * The caller must be a metastore admin or an owner of the volume.
-   * For the latter case, the caller must also be the owner or have the **USE_CATALOG**
-   * privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema.
-   *
-   * Currently only the name, the owner or the comment of the volume could be updated.
-   */
-  async updateVolume(
-    req: UpdateVolumeRequest,
-    options?: CallOptions
-  ): Promise<VolumeInfo> {
-    const url = `${this.host}/api/2.1/unity-catalog/volumes/${req.fullNameArg ?? ''}`;
-    const body = marshalRequest(req, marshalUpdateVolumeRequestSchema);
-    let resp: VolumeInfo | 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, unmarshalVolumeInfoSchema);
-    };
-    await executeCall(call, options);
-    if (resp === undefined) {
-      throw new Error('operation completed without a result.');
-    }
-    return resp;
-  }
-}

package/src/v1/index.ts

@@ -1,18 +0,0 @@
-// Code generated from API definition by Databricks SDK Generator. DO NOT EDIT.
-
-export {VolumesClient} from './client';
-
-export {SseEncryptionAlgorithm, VolumeType} from './model';
-
-export type {
-  CreateVolumeRequest,
-  DeleteVolumeRequest,
-  DeleteVolumeRequest_Response,
-  EncryptionDetails,
-  GetVolumeRequest,
-  ListVolumesRequest,
-  ListVolumesRequest_Response,
-  SseEncryptionDetails,
-  UpdateVolumeRequest,
-  VolumeInfo,
-} from './model';