Class v1.QuotaControllerClient (1.1.4)

[Google Quota Control API](/service-control/overview)

Allows clients to allocate and release quota against a [managed service](https://cloud.google.com/service-management/reference/rpc/google.api/servicemanagement.v1#google.api.servicemanagement.v1.ManagedService). v1

Package

@google-cloud/service-control!

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of QuotaControllerClient.

Parameter
NameDescription
opts ClientOptions

Properties

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

Property Value
TypeDescription
string

auth

auth: gax.GoogleAuth;
Property Value
TypeDescription
gax.GoogleAuth

descriptors

descriptors: Descriptors;
Property Value
TypeDescription
Descriptors

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };
Property Value
TypeDescription
{ [name: string]: Function; }

port

static get port(): number;

The port for this API service.

Property Value
TypeDescription
number

quotaControllerStub

quotaControllerStub?: Promise<{
        [name: string]: Function;
    }>;
Property Value
TypeDescription
Promise<{ [name: string]: Function; }>

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

Property Value
TypeDescription
string[]

servicePath

static get servicePath(): string;

The DNS address for this API service.

Property Value
TypeDescription
string

warn

warn: (code: string, message: string, warnType?: string) => void;
Property Value
TypeDescription
(code: string, message: string, warnType?: string) => void

Methods

allocateQuota(request, options)

allocateQuota(request?: protos.google.api.servicecontrol.v1.IAllocateQuotaRequest, options?: CallOptions): Promise<[
        protos.google.api.servicecontrol.v1.IAllocateQuotaResponse,
        protos.google.api.servicecontrol.v1.IAllocateQuotaRequest | undefined,
        {} | undefined
    ]>;
Parameters
NameDescription
request protos.google.api.servicecontrol.v1.IAllocateQuotaRequest
options CallOptions
Returns
TypeDescription
Promise<[ protos.google.api.servicecontrol.v1.IAllocateQuotaResponse, protos.google.api.servicecontrol.v1.IAllocateQuotaRequest | undefined, {} | undefined ]>

allocateQuota(request, options, callback)

allocateQuota(request: protos.google.api.servicecontrol.v1.IAllocateQuotaRequest, options: CallOptions, callback: Callback<protos.google.api.servicecontrol.v1.IAllocateQuotaResponse, protos.google.api.servicecontrol.v1.IAllocateQuotaRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.api.servicecontrol.v1.IAllocateQuotaRequest
options CallOptions
callback Callback<protos.google.api.servicecontrol.v1.IAllocateQuotaResponse, protos.google.api.servicecontrol.v1.IAllocateQuotaRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

allocateQuota(request, callback)

allocateQuota(request: protos.google.api.servicecontrol.v1.IAllocateQuotaRequest, callback: Callback<protos.google.api.servicecontrol.v1.IAllocateQuotaResponse, protos.google.api.servicecontrol.v1.IAllocateQuotaRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.api.servicecontrol.v1.IAllocateQuotaRequest
callback Callback<protos.google.api.servicecontrol.v1.IAllocateQuotaResponse, protos.google.api.servicecontrol.v1.IAllocateQuotaRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns
TypeDescription
Promise<void>

{Promise} A promise that resolves when the client is closed.

getProjectId()

getProjectId(): Promise<string>;
Returns
TypeDescription
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
NameDescription
callback Callback<string, undefined, undefined>
Returns
TypeDescription
void

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns
TypeDescription
Promise<{ [name: string]: Function; }>

{Promise} A promise that resolves to an authenticated service stub.