Class ResourceQuotasClient

Index

Constructors

Methods

getQuota listQuotas listQuotasIter

Constructors

constructor

new ResourceQuotasClient(options: ClientOptions): ResourceQuotasClient
Parameters
- options: ClientOptions
Returns ResourceQuotasClient
- Defined in client.ts:48

Methods

getQuota

getQuota(req: GetQuotaRequest, options?: CallOptions): Promise<GetQuotaResponse>
The GetQuota API returns usage information for a single resource quota, defined as a child-parent pair. This API also refreshes the quota count if it is out of date. Refreshes are triggered asynchronously. The updated count might not be returned in the first call.
Parameters
- req: GetQuotaRequest
- Optionaloptions: CallOptions
Returns Promise<GetQuotaResponse>
- Defined in client.ts:68

listQuotas

listQuotas(
req: ListQuotasRequest,
options?: CallOptions,
): Promise<ListQuotasResponse>
ListQuotas returns all quota values under the metastore. There are no SLAs on the freshness of the counts returned. This API does not trigger a refresh of quota counts.

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.
Parameters
- req: ListQuotasRequest
- Optionaloptions: CallOptions
Returns Promise<ListQuotasResponse>
- Defined in client.ts:103

listQuotasIter

listQuotasIter(
req: ListQuotasRequest,
options?: CallOptions,
): AsyncGenerator<QuotaInfo>
Parameters
- req: ListQuotasRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<QuotaInfo>
- Defined in client.ts:140