Class WorkspaceBindingsClient

Index

Constructors

Methods

getCatalogWorkspaceBindings getWorkspaceBindings getWorkspaceBindingsIter updateCatalogWorkspaceBindings updateWorkspaceBindings

Constructors

constructor

new WorkspaceBindingsClient(options: ClientOptions): WorkspaceBindingsClient
Parameters
- options: ClientOptions
Returns WorkspaceBindingsClient
- Defined in client.ts:57

Methods

getCatalogWorkspaceBindings

getCatalogWorkspaceBindings(
req: GetCatalogWorkspaceBindingsRequest,
options?: CallOptions,
): Promise<GetCatalogWorkspaceBindingsResponse>
Gets workspace bindings of the catalog. The caller must be a metastore admin or an owner of the catalog.
Parameters
- req: GetCatalogWorkspaceBindingsRequest
- Optionaloptions: CallOptions
Returns Promise<GetCatalogWorkspaceBindingsResponse>
- Defined in client.ts:76

getWorkspaceBindings

getWorkspaceBindings(
req: GetWorkspaceBindingsRequest,
options?: CallOptions,
): Promise<GetWorkspaceBindingsResponse>
Gets workspace bindings of the securable. The caller must be a metastore admin or an owner of the securable.

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.
Parameters
- req: GetWorkspaceBindingsRequest
- Optionaloptions: CallOptions
Returns Promise<GetWorkspaceBindingsResponse>
- Defined in client.ts:116

getWorkspaceBindingsIter

getWorkspaceBindingsIter(
req: GetWorkspaceBindingsRequest,
options?: CallOptions,
): AsyncGenerator<WorkspaceBindingInfo>
Parameters
- req: GetWorkspaceBindingsRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<WorkspaceBindingInfo>
- Defined in client.ts:156

updateCatalogWorkspaceBindings

updateCatalogWorkspaceBindings(
req: UpdateCatalogWorkspaceBindingsRequest,
options?: CallOptions,
): Promise<UpdateCatalogWorkspaceBindingsResponse>
Updates workspace bindings of the catalog. The caller must be a metastore admin or an owner of the catalog.
Parameters
- req: UpdateCatalogWorkspaceBindingsRequest
- Optionaloptions: CallOptions
Returns Promise<UpdateCatalogWorkspaceBindingsResponse>
- Defined in client.ts:177

updateWorkspaceBindings

updateWorkspaceBindings(
req: UpdateWorkspaceBindingsRequest,
options?: CallOptions,
): Promise<UpdateWorkspaceBindingsResponse>
Updates workspace bindings of the securable. The caller must be a metastore admin or an owner of the securable.
Parameters
- req: UpdateWorkspaceBindingsRequest
- Optionaloptions: CallOptions
Returns Promise<UpdateWorkspaceBindingsResponse>
- Defined in client.ts:216