Class ClusterLibrariesClient

Index

Constructors

Methods

allClusterStatuses clusterStatus installLibraries uninstallLibraries

Constructors

constructor

new ClusterLibrariesClient(options: ClientOptions): ClusterLibrariesClient
Parameters
- options: ClientOptions
Returns ClusterLibrariesClient
- Defined in client.ts:56

Methods

allClusterStatuses

allClusterStatuses(
_req: ListAllClusterLibraryStatusesRequest,
options?: CallOptions,
): Promise<ListAllClusterLibraryStatusesResponse>
Get the status of all libraries on all clusters. A status is returned for all libraries installed on this cluster via the API or the libraries UI.
Parameters
- _req: ListAllClusterLibraryStatusesRequest
- Optionaloptions: CallOptions
Returns Promise<ListAllClusterLibraryStatusesResponse>
- Defined in client.ts:75

clusterStatus

clusterStatus(
req: ClusterStatusRequest,
options?: CallOptions,
): Promise<ClusterLibraryStatuses>
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.
Parameters
- req: ClusterStatusRequest
- Optionaloptions: CallOptions
Returns Promise<ClusterLibraryStatuses>
- Defined in client.ts:115

installLibraries

installLibraries(
req: InstallLibrariesRequest,
options?: CallOptions,
): Promise<InstallLibrariesResponse>
Add libraries to install on a cluster. The installation is asynchronous; it happens in the background after the completion of this request.
Parameters
- req: InstallLibrariesRequest
- Optionaloptions: CallOptions
Returns Promise<InstallLibrariesResponse>
- Defined in client.ts:153

uninstallLibraries

uninstallLibraries(
req: UninstallLibrariesRequest,
options?: CallOptions,
): Promise<UninstallLibrariesResponse>
Set libraries to uninstall from a cluster. The libraries won't be uninstalled until the cluster is restarted. A request to uninstall a library that is not currently installed is ignored.
Parameters
- req: UninstallLibrariesRequest
- Optionaloptions: CallOptions
Returns Promise<UninstallLibrariesResponse>
- Defined in client.ts:186