Package
@google-cloud/service-usage!
Constructors
(constructor)(opts)
constructor(opts?: ClientOptions);
Construct an instance of ServiceUsageClient.
Parameter
Name | Description |
opts |
ClientOptions
|
Properties
apiEndpoint
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
Property Value
auth
Property Value
Type | Description |
gax.GoogleAuth | |
descriptors
descriptors: Descriptors;
Property Value
Type | Description |
Descriptors | |
innerApiCalls
innerApiCalls: {
[name: string]: Function;
};
Property Value
Type | Description |
{
[name: string]: Function;
} | |
operationsClient
operationsClient: gax.OperationsClient;
Property Value
Type | Description |
gax.OperationsClient | |
port
static get port(): number;
The port for this API service.
Property Value
scopes
static get scopes(): string[];
The scopes needed to make gRPC calls for every method defined in this service.
Property Value
servicePath
static get servicePath(): string;
The DNS address for this API service.
Property Value
serviceUsageStub
serviceUsageStub?: Promise<{
[name: string]: Function;
}>;
Property Value
Type | Description |
Promise<{
[name: string]: Function;
}> | |
warn
warn: (code: string, message: string, warnType?: string) => void;
Property Value
Type | Description |
(code: string, message: string, warnType?: string) => void | |
Methods
batchEnableServices(request, options)
batchEnableServices(request?: protos.google.api.serviceusage.v1beta1.IBatchEnableServicesRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.api.serviceusage.v1beta1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IBatchEnableServicesRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.api.serviceusage.v1beta1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | |
batchEnableServices(request, options, callback)
batchEnableServices(request: protos.google.api.serviceusage.v1beta1.IBatchEnableServicesRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.api.serviceusage.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IBatchEnableServicesRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.api.serviceusage.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
batchEnableServices(request, callback)
batchEnableServices(request: protos.google.api.serviceusage.v1beta1.IBatchEnableServicesRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.api.serviceusage.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IBatchEnableServicesRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.api.serviceusage.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
checkBatchEnableServicesProgress(name)
checkBatchEnableServicesProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.api.serviceusage.v1beta1.OperationMetadata>>;
Check the status of the long running operation returned by batchEnableServices()
.
Parameter
Name | Description |
name |
string
The operation name that will be passed.
|
Returns
Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, protos.google.api.serviceusage.v1beta1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
|
checkCreateAdminOverrideProgress(name)
checkCreateAdminOverrideProgress(name: string): Promise<LROperation<protos.google.api.serviceusage.v1beta1.QuotaOverride, protos.google.api.serviceusage.v1beta1.OperationMetadata>>;
Check the status of the long running operation returned by createAdminOverride()
.
Parameter
Name | Description |
name |
string
The operation name that will be passed.
|
Returns
Type | Description |
Promise<LROperation<protos.google.api.serviceusage.v1beta1.QuotaOverride, protos.google.api.serviceusage.v1beta1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
|
checkCreateConsumerOverrideProgress(name)
checkCreateConsumerOverrideProgress(name: string): Promise<LROperation<protos.google.api.serviceusage.v1beta1.QuotaOverride, protos.google.api.serviceusage.v1beta1.OperationMetadata>>;
Check the status of the long running operation returned by createConsumerOverride()
.
Parameter
Name | Description |
name |
string
The operation name that will be passed.
|
Returns
Type | Description |
Promise<LROperation<protos.google.api.serviceusage.v1beta1.QuotaOverride, protos.google.api.serviceusage.v1beta1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
|
checkDeleteAdminOverrideProgress(name)
checkDeleteAdminOverrideProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.api.serviceusage.v1beta1.OperationMetadata>>;
Check the status of the long running operation returned by deleteAdminOverride()
.
Parameter
Name | Description |
name |
string
The operation name that will be passed.
|
Returns
Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, protos.google.api.serviceusage.v1beta1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
|
checkDeleteConsumerOverrideProgress(name)
checkDeleteConsumerOverrideProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.api.serviceusage.v1beta1.OperationMetadata>>;
Check the status of the long running operation returned by deleteConsumerOverride()
.
Parameter
Name | Description |
name |
string
The operation name that will be passed.
|
Returns
Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, protos.google.api.serviceusage.v1beta1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
|
checkDisableServiceProgress(name)
checkDisableServiceProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.api.serviceusage.v1beta1.OperationMetadata>>;
Check the status of the long running operation returned by disableService()
.
Parameter
Name | Description |
name |
string
The operation name that will be passed.
|
Returns
Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, protos.google.api.serviceusage.v1beta1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
|
checkEnableServiceProgress(name)
checkEnableServiceProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.api.serviceusage.v1beta1.OperationMetadata>>;
Check the status of the long running operation returned by enableService()
.
Parameter
Name | Description |
name |
string
The operation name that will be passed.
|
Returns
Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, protos.google.api.serviceusage.v1beta1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
|
checkGenerateServiceIdentityProgress(name)
checkGenerateServiceIdentityProgress(name: string): Promise<LROperation<protos.google.api.serviceusage.v1beta1.ServiceIdentity, protos.google.protobuf.Empty>>;
Check the status of the long running operation returned by generateServiceIdentity()
.
Parameter
Name | Description |
name |
string
The operation name that will be passed.
|
Returns
Type | Description |
Promise<LROperation<protos.google.api.serviceusage.v1beta1.ServiceIdentity, protos.google.protobuf.Empty>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
|
checkImportAdminOverridesProgress(name)
checkImportAdminOverridesProgress(name: string): Promise<LROperation<protos.google.api.serviceusage.v1beta1.ImportAdminOverridesResponse, protos.google.api.serviceusage.v1beta1.ImportAdminOverridesMetadata>>;
Check the status of the long running operation returned by importAdminOverrides()
.
Parameter
Name | Description |
name |
string
The operation name that will be passed.
|
Returns
Type | Description |
Promise<LROperation<protos.google.api.serviceusage.v1beta1.ImportAdminOverridesResponse, protos.google.api.serviceusage.v1beta1.ImportAdminOverridesMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
|
checkImportConsumerOverridesProgress(name)
checkImportConsumerOverridesProgress(name: string): Promise<LROperation<protos.google.api.serviceusage.v1beta1.ImportConsumerOverridesResponse, protos.google.api.serviceusage.v1beta1.ImportConsumerOverridesMetadata>>;
Check the status of the long running operation returned by importConsumerOverrides()
.
Parameter
Name | Description |
name |
string
The operation name that will be passed.
|
Returns
Type | Description |
Promise<LROperation<protos.google.api.serviceusage.v1beta1.ImportConsumerOverridesResponse, protos.google.api.serviceusage.v1beta1.ImportConsumerOverridesMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
|
checkUpdateAdminOverrideProgress(name)
checkUpdateAdminOverrideProgress(name: string): Promise<LROperation<protos.google.api.serviceusage.v1beta1.QuotaOverride, protos.google.api.serviceusage.v1beta1.OperationMetadata>>;
Check the status of the long running operation returned by updateAdminOverride()
.
Parameter
Name | Description |
name |
string
The operation name that will be passed.
|
Returns
Type | Description |
Promise<LROperation<protos.google.api.serviceusage.v1beta1.QuotaOverride, protos.google.api.serviceusage.v1beta1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
|
checkUpdateConsumerOverrideProgress(name)
checkUpdateConsumerOverrideProgress(name: string): Promise<LROperation<protos.google.api.serviceusage.v1beta1.QuotaOverride, protos.google.api.serviceusage.v1beta1.OperationMetadata>>;
Check the status of the long running operation returned by updateConsumerOverride()
.
Parameter
Name | Description |
name |
string
The operation name that will be passed.
|
Returns
Type | Description |
Promise<LROperation<protos.google.api.serviceusage.v1beta1.QuotaOverride, protos.google.api.serviceusage.v1beta1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
|
close()
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Returns
Type | Description |
Promise<void> | {Promise} A promise that resolves when the client is closed.
|
createAdminOverride(request, options)
createAdminOverride(request?: protos.google.api.serviceusage.v1beta1.ICreateAdminOverrideRequest, options?: CallOptions): Promise<[
LROperation<protos.google.api.serviceusage.v1beta1.IQuotaOverride, protos.google.api.serviceusage.v1beta1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.ICreateAdminOverrideRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
LROperation<protos.google.api.serviceusage.v1beta1.IQuotaOverride, protos.google.api.serviceusage.v1beta1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | |
createAdminOverride(request, options, callback)
createAdminOverride(request: protos.google.api.serviceusage.v1beta1.ICreateAdminOverrideRequest, options: CallOptions, callback: Callback<LROperation<protos.google.api.serviceusage.v1beta1.IQuotaOverride, protos.google.api.serviceusage.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.ICreateAdminOverrideRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.api.serviceusage.v1beta1.IQuotaOverride, protos.google.api.serviceusage.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
createAdminOverride(request, callback)
createAdminOverride(request: protos.google.api.serviceusage.v1beta1.ICreateAdminOverrideRequest, callback: Callback<LROperation<protos.google.api.serviceusage.v1beta1.IQuotaOverride, protos.google.api.serviceusage.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.ICreateAdminOverrideRequest
|
callback |
Callback<LROperation<protos.google.api.serviceusage.v1beta1.IQuotaOverride, protos.google.api.serviceusage.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
createConsumerOverride(request, options)
createConsumerOverride(request?: protos.google.api.serviceusage.v1beta1.ICreateConsumerOverrideRequest, options?: CallOptions): Promise<[
LROperation<protos.google.api.serviceusage.v1beta1.IQuotaOverride, protos.google.api.serviceusage.v1beta1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.ICreateConsumerOverrideRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
LROperation<protos.google.api.serviceusage.v1beta1.IQuotaOverride, protos.google.api.serviceusage.v1beta1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | |
createConsumerOverride(request, options, callback)
createConsumerOverride(request: protos.google.api.serviceusage.v1beta1.ICreateConsumerOverrideRequest, options: CallOptions, callback: Callback<LROperation<protos.google.api.serviceusage.v1beta1.IQuotaOverride, protos.google.api.serviceusage.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.ICreateConsumerOverrideRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.api.serviceusage.v1beta1.IQuotaOverride, protos.google.api.serviceusage.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
createConsumerOverride(request, callback)
createConsumerOverride(request: protos.google.api.serviceusage.v1beta1.ICreateConsumerOverrideRequest, callback: Callback<LROperation<protos.google.api.serviceusage.v1beta1.IQuotaOverride, protos.google.api.serviceusage.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.ICreateConsumerOverrideRequest
|
callback |
Callback<LROperation<protos.google.api.serviceusage.v1beta1.IQuotaOverride, protos.google.api.serviceusage.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
deleteAdminOverride(request, options)
deleteAdminOverride(request?: protos.google.api.serviceusage.v1beta1.IDeleteAdminOverrideRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.api.serviceusage.v1beta1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IDeleteAdminOverrideRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.api.serviceusage.v1beta1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | |
deleteAdminOverride(request, options, callback)
deleteAdminOverride(request: protos.google.api.serviceusage.v1beta1.IDeleteAdminOverrideRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.api.serviceusage.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IDeleteAdminOverrideRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.api.serviceusage.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
deleteAdminOverride(request, callback)
deleteAdminOverride(request: protos.google.api.serviceusage.v1beta1.IDeleteAdminOverrideRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.api.serviceusage.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IDeleteAdminOverrideRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.api.serviceusage.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
deleteConsumerOverride(request, options)
deleteConsumerOverride(request?: protos.google.api.serviceusage.v1beta1.IDeleteConsumerOverrideRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.api.serviceusage.v1beta1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IDeleteConsumerOverrideRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.api.serviceusage.v1beta1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | |
deleteConsumerOverride(request, options, callback)
deleteConsumerOverride(request: protos.google.api.serviceusage.v1beta1.IDeleteConsumerOverrideRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.api.serviceusage.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IDeleteConsumerOverrideRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.api.serviceusage.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
deleteConsumerOverride(request, callback)
deleteConsumerOverride(request: protos.google.api.serviceusage.v1beta1.IDeleteConsumerOverrideRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.api.serviceusage.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IDeleteConsumerOverrideRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.api.serviceusage.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
disableService(request, options)
disableService(request?: protos.google.api.serviceusage.v1beta1.IDisableServiceRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.api.serviceusage.v1beta1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IDisableServiceRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.api.serviceusage.v1beta1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | |
disableService(request, options, callback)
disableService(request: protos.google.api.serviceusage.v1beta1.IDisableServiceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.api.serviceusage.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IDisableServiceRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.api.serviceusage.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
disableService(request, callback)
disableService(request: protos.google.api.serviceusage.v1beta1.IDisableServiceRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.api.serviceusage.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IDisableServiceRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.api.serviceusage.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
enableService(request, options)
enableService(request?: protos.google.api.serviceusage.v1beta1.IEnableServiceRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.api.serviceusage.v1beta1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IEnableServiceRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.api.serviceusage.v1beta1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | |
enableService(request, options, callback)
enableService(request: protos.google.api.serviceusage.v1beta1.IEnableServiceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.api.serviceusage.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IEnableServiceRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.api.serviceusage.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
enableService(request, callback)
enableService(request: protos.google.api.serviceusage.v1beta1.IEnableServiceRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.api.serviceusage.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IEnableServiceRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.api.serviceusage.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
generateServiceIdentity(request, options)
generateServiceIdentity(request?: protos.google.api.serviceusage.v1beta1.IGenerateServiceIdentityRequest, options?: CallOptions): Promise<[
LROperation<protos.google.api.serviceusage.v1beta1.IServiceIdentity, protos.google.protobuf.IEmpty>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IGenerateServiceIdentityRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
LROperation<protos.google.api.serviceusage.v1beta1.IServiceIdentity, protos.google.protobuf.IEmpty>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | |
generateServiceIdentity(request, options, callback)
generateServiceIdentity(request: protos.google.api.serviceusage.v1beta1.IGenerateServiceIdentityRequest, options: CallOptions, callback: Callback<LROperation<protos.google.api.serviceusage.v1beta1.IServiceIdentity, protos.google.protobuf.IEmpty>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IGenerateServiceIdentityRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.api.serviceusage.v1beta1.IServiceIdentity, protos.google.protobuf.IEmpty>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
generateServiceIdentity(request, callback)
generateServiceIdentity(request: protos.google.api.serviceusage.v1beta1.IGenerateServiceIdentityRequest, callback: Callback<LROperation<protos.google.api.serviceusage.v1beta1.IServiceIdentity, protos.google.protobuf.IEmpty>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IGenerateServiceIdentityRequest
|
callback |
Callback<LROperation<protos.google.api.serviceusage.v1beta1.IServiceIdentity, protos.google.protobuf.IEmpty>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
getConsumerQuotaLimit(request, options)
getConsumerQuotaLimit(request?: protos.google.api.serviceusage.v1beta1.IGetConsumerQuotaLimitRequest, options?: CallOptions): Promise<[
protos.google.api.serviceusage.v1beta1.IConsumerQuotaLimit,
(protos.google.api.serviceusage.v1beta1.IGetConsumerQuotaLimitRequest | undefined),
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IGetConsumerQuotaLimitRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.api.serviceusage.v1beta1.IConsumerQuotaLimit,
(protos.google.api.serviceusage.v1beta1.IGetConsumerQuotaLimitRequest | undefined),
{} | undefined
]> | |
getConsumerQuotaLimit(request, options, callback)
getConsumerQuotaLimit(request: protos.google.api.serviceusage.v1beta1.IGetConsumerQuotaLimitRequest, options: CallOptions, callback: Callback<protos.google.api.serviceusage.v1beta1.IConsumerQuotaLimit, protos.google.api.serviceusage.v1beta1.IGetConsumerQuotaLimitRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IGetConsumerQuotaLimitRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.api.serviceusage.v1beta1.IConsumerQuotaLimit, protos.google.api.serviceusage.v1beta1.IGetConsumerQuotaLimitRequest | null | undefined, {} | null | undefined>
|
Returns
getConsumerQuotaLimit(request, callback)
getConsumerQuotaLimit(request: protos.google.api.serviceusage.v1beta1.IGetConsumerQuotaLimitRequest, callback: Callback<protos.google.api.serviceusage.v1beta1.IConsumerQuotaLimit, protos.google.api.serviceusage.v1beta1.IGetConsumerQuotaLimitRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IGetConsumerQuotaLimitRequest
|
callback |
Callback<protos.google.api.serviceusage.v1beta1.IConsumerQuotaLimit, protos.google.api.serviceusage.v1beta1.IGetConsumerQuotaLimitRequest | null | undefined, {} | null | undefined>
|
Returns
getConsumerQuotaMetric(request, options)
getConsumerQuotaMetric(request?: protos.google.api.serviceusage.v1beta1.IGetConsumerQuotaMetricRequest, options?: CallOptions): Promise<[
protos.google.api.serviceusage.v1beta1.IConsumerQuotaMetric,
(protos.google.api.serviceusage.v1beta1.IGetConsumerQuotaMetricRequest | undefined),
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IGetConsumerQuotaMetricRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.api.serviceusage.v1beta1.IConsumerQuotaMetric,
(protos.google.api.serviceusage.v1beta1.IGetConsumerQuotaMetricRequest | undefined),
{} | undefined
]> | |
getConsumerQuotaMetric(request, options, callback)
getConsumerQuotaMetric(request: protos.google.api.serviceusage.v1beta1.IGetConsumerQuotaMetricRequest, options: CallOptions, callback: Callback<protos.google.api.serviceusage.v1beta1.IConsumerQuotaMetric, protos.google.api.serviceusage.v1beta1.IGetConsumerQuotaMetricRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IGetConsumerQuotaMetricRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.api.serviceusage.v1beta1.IConsumerQuotaMetric, protos.google.api.serviceusage.v1beta1.IGetConsumerQuotaMetricRequest | null | undefined, {} | null | undefined>
|
Returns
getConsumerQuotaMetric(request, callback)
getConsumerQuotaMetric(request: protos.google.api.serviceusage.v1beta1.IGetConsumerQuotaMetricRequest, callback: Callback<protos.google.api.serviceusage.v1beta1.IConsumerQuotaMetric, protos.google.api.serviceusage.v1beta1.IGetConsumerQuotaMetricRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IGetConsumerQuotaMetricRequest
|
callback |
Callback<protos.google.api.serviceusage.v1beta1.IConsumerQuotaMetric, protos.google.api.serviceusage.v1beta1.IGetConsumerQuotaMetricRequest | null | undefined, {} | null | undefined>
|
Returns
getProjectId()
getProjectId(): Promise<string>;
Returns
Type | Description |
Promise<string> | |
getProjectId(callback)
getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
Name | Description |
callback |
Callback<string, undefined, undefined>
|
Returns
getService(request, options)
getService(request?: protos.google.api.serviceusage.v1beta1.IGetServiceRequest, options?: CallOptions): Promise<[
protos.google.api.serviceusage.v1beta1.IService,
protos.google.api.serviceusage.v1beta1.IGetServiceRequest | undefined,
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IGetServiceRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.api.serviceusage.v1beta1.IService,
protos.google.api.serviceusage.v1beta1.IGetServiceRequest | undefined,
{} | undefined
]> | |
getService(request, options, callback)
getService(request: protos.google.api.serviceusage.v1beta1.IGetServiceRequest, options: CallOptions, callback: Callback<protos.google.api.serviceusage.v1beta1.IService, protos.google.api.serviceusage.v1beta1.IGetServiceRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IGetServiceRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.api.serviceusage.v1beta1.IService, protos.google.api.serviceusage.v1beta1.IGetServiceRequest | null | undefined, {} | null | undefined>
|
Returns
getService(request, callback)
getService(request: protos.google.api.serviceusage.v1beta1.IGetServiceRequest, callback: Callback<protos.google.api.serviceusage.v1beta1.IService, protos.google.api.serviceusage.v1beta1.IGetServiceRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IGetServiceRequest
|
callback |
Callback<protos.google.api.serviceusage.v1beta1.IService, protos.google.api.serviceusage.v1beta1.IGetServiceRequest | null | undefined, {} | null | undefined>
|
Returns
importAdminOverrides(request, options)
importAdminOverrides(request?: protos.google.api.serviceusage.v1beta1.IImportAdminOverridesRequest, options?: CallOptions): Promise<[
LROperation<protos.google.api.serviceusage.v1beta1.IImportAdminOverridesResponse, protos.google.api.serviceusage.v1beta1.IImportAdminOverridesMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IImportAdminOverridesRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
LROperation<protos.google.api.serviceusage.v1beta1.IImportAdminOverridesResponse, protos.google.api.serviceusage.v1beta1.IImportAdminOverridesMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | |
importAdminOverrides(request, options, callback)
importAdminOverrides(request: protos.google.api.serviceusage.v1beta1.IImportAdminOverridesRequest, options: CallOptions, callback: Callback<LROperation<protos.google.api.serviceusage.v1beta1.IImportAdminOverridesResponse, protos.google.api.serviceusage.v1beta1.IImportAdminOverridesMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IImportAdminOverridesRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.api.serviceusage.v1beta1.IImportAdminOverridesResponse, protos.google.api.serviceusage.v1beta1.IImportAdminOverridesMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
importAdminOverrides(request, callback)
importAdminOverrides(request: protos.google.api.serviceusage.v1beta1.IImportAdminOverridesRequest, callback: Callback<LROperation<protos.google.api.serviceusage.v1beta1.IImportAdminOverridesResponse, protos.google.api.serviceusage.v1beta1.IImportAdminOverridesMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IImportAdminOverridesRequest
|
callback |
Callback<LROperation<protos.google.api.serviceusage.v1beta1.IImportAdminOverridesResponse, protos.google.api.serviceusage.v1beta1.IImportAdminOverridesMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
importConsumerOverrides(request, options)
importConsumerOverrides(request?: protos.google.api.serviceusage.v1beta1.IImportConsumerOverridesRequest, options?: CallOptions): Promise<[
LROperation<protos.google.api.serviceusage.v1beta1.IImportConsumerOverridesResponse, protos.google.api.serviceusage.v1beta1.IImportConsumerOverridesMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IImportConsumerOverridesRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
LROperation<protos.google.api.serviceusage.v1beta1.IImportConsumerOverridesResponse, protos.google.api.serviceusage.v1beta1.IImportConsumerOverridesMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | |
importConsumerOverrides(request, options, callback)
importConsumerOverrides(request: protos.google.api.serviceusage.v1beta1.IImportConsumerOverridesRequest, options: CallOptions, callback: Callback<LROperation<protos.google.api.serviceusage.v1beta1.IImportConsumerOverridesResponse, protos.google.api.serviceusage.v1beta1.IImportConsumerOverridesMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IImportConsumerOverridesRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.api.serviceusage.v1beta1.IImportConsumerOverridesResponse, protos.google.api.serviceusage.v1beta1.IImportConsumerOverridesMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
importConsumerOverrides(request, callback)
importConsumerOverrides(request: protos.google.api.serviceusage.v1beta1.IImportConsumerOverridesRequest, callback: Callback<LROperation<protos.google.api.serviceusage.v1beta1.IImportConsumerOverridesResponse, protos.google.api.serviceusage.v1beta1.IImportConsumerOverridesMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IImportConsumerOverridesRequest
|
callback |
Callback<LROperation<protos.google.api.serviceusage.v1beta1.IImportConsumerOverridesResponse, protos.google.api.serviceusage.v1beta1.IImportConsumerOverridesMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
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
Type | Description |
Promise<{
[name: string]: Function;
}> | {Promise} A promise that resolves to an authenticated service stub.
|
listAdminOverrides(request, options)
listAdminOverrides(request?: protos.google.api.serviceusage.v1beta1.IListAdminOverridesRequest, options?: CallOptions): Promise<[
protos.google.api.serviceusage.v1beta1.IQuotaOverride[],
protos.google.api.serviceusage.v1beta1.IListAdminOverridesRequest | null,
protos.google.api.serviceusage.v1beta1.IListAdminOverridesResponse
]>;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IListAdminOverridesRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.api.serviceusage.v1beta1.IQuotaOverride[],
protos.google.api.serviceusage.v1beta1.IListAdminOverridesRequest | null,
protos.google.api.serviceusage.v1beta1.IListAdminOverridesResponse
]> | |
listAdminOverrides(request, options, callback)
listAdminOverrides(request: protos.google.api.serviceusage.v1beta1.IListAdminOverridesRequest, options: CallOptions, callback: PaginationCallback<protos.google.api.serviceusage.v1beta1.IListAdminOverridesRequest, protos.google.api.serviceusage.v1beta1.IListAdminOverridesResponse | null | undefined, protos.google.api.serviceusage.v1beta1.IQuotaOverride>): void;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IListAdminOverridesRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.api.serviceusage.v1beta1.IListAdminOverridesRequest, protos.google.api.serviceusage.v1beta1.IListAdminOverridesResponse | null | undefined, protos.google.api.serviceusage.v1beta1.IQuotaOverride>
|
Returns
listAdminOverrides(request, callback)
listAdminOverrides(request: protos.google.api.serviceusage.v1beta1.IListAdminOverridesRequest, callback: PaginationCallback<protos.google.api.serviceusage.v1beta1.IListAdminOverridesRequest, protos.google.api.serviceusage.v1beta1.IListAdminOverridesResponse | null | undefined, protos.google.api.serviceusage.v1beta1.IQuotaOverride>): void;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IListAdminOverridesRequest
|
callback |
PaginationCallback<protos.google.api.serviceusage.v1beta1.IListAdminOverridesRequest, protos.google.api.serviceusage.v1beta1.IListAdminOverridesResponse | null | undefined, protos.google.api.serviceusage.v1beta1.IQuotaOverride>
|
Returns
listAdminOverridesAsync(request, options)
listAdminOverridesAsync(request?: protos.google.api.serviceusage.v1beta1.IListAdminOverridesRequest, options?: CallOptions): AsyncIterable<protos.google.api.serviceusage.v1beta1.IQuotaOverride>;
Equivalent to listAdminOverrides
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IListAdminOverridesRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
AsyncIterable<protos.google.api.serviceusage.v1beta1.IQuotaOverride> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [QuotaOverride]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listAdminOverridesStream(request, options)
listAdminOverridesStream(request?: protos.google.api.serviceusage.v1beta1.IListAdminOverridesRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IListAdminOverridesRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
Transform | {Stream} An object stream which emits an object representing [QuotaOverride] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listAdminOverridesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listConsumerOverrides(request, options)
listConsumerOverrides(request?: protos.google.api.serviceusage.v1beta1.IListConsumerOverridesRequest, options?: CallOptions): Promise<[
protos.google.api.serviceusage.v1beta1.IQuotaOverride[],
protos.google.api.serviceusage.v1beta1.IListConsumerOverridesRequest | null,
protos.google.api.serviceusage.v1beta1.IListConsumerOverridesResponse
]>;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IListConsumerOverridesRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.api.serviceusage.v1beta1.IQuotaOverride[],
protos.google.api.serviceusage.v1beta1.IListConsumerOverridesRequest | null,
protos.google.api.serviceusage.v1beta1.IListConsumerOverridesResponse
]> | |
listConsumerOverrides(request, options, callback)
listConsumerOverrides(request: protos.google.api.serviceusage.v1beta1.IListConsumerOverridesRequest, options: CallOptions, callback: PaginationCallback<protos.google.api.serviceusage.v1beta1.IListConsumerOverridesRequest, protos.google.api.serviceusage.v1beta1.IListConsumerOverridesResponse | null | undefined, protos.google.api.serviceusage.v1beta1.IQuotaOverride>): void;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IListConsumerOverridesRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.api.serviceusage.v1beta1.IListConsumerOverridesRequest, protos.google.api.serviceusage.v1beta1.IListConsumerOverridesResponse | null | undefined, protos.google.api.serviceusage.v1beta1.IQuotaOverride>
|
Returns
listConsumerOverrides(request, callback)
listConsumerOverrides(request: protos.google.api.serviceusage.v1beta1.IListConsumerOverridesRequest, callback: PaginationCallback<protos.google.api.serviceusage.v1beta1.IListConsumerOverridesRequest, protos.google.api.serviceusage.v1beta1.IListConsumerOverridesResponse | null | undefined, protos.google.api.serviceusage.v1beta1.IQuotaOverride>): void;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IListConsumerOverridesRequest
|
callback |
PaginationCallback<protos.google.api.serviceusage.v1beta1.IListConsumerOverridesRequest, protos.google.api.serviceusage.v1beta1.IListConsumerOverridesResponse | null | undefined, protos.google.api.serviceusage.v1beta1.IQuotaOverride>
|
Returns
listConsumerOverridesAsync(request, options)
listConsumerOverridesAsync(request?: protos.google.api.serviceusage.v1beta1.IListConsumerOverridesRequest, options?: CallOptions): AsyncIterable<protos.google.api.serviceusage.v1beta1.IQuotaOverride>;
Equivalent to listConsumerOverrides
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IListConsumerOverridesRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
AsyncIterable<protos.google.api.serviceusage.v1beta1.IQuotaOverride> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [QuotaOverride]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listConsumerOverridesStream(request, options)
listConsumerOverridesStream(request?: protos.google.api.serviceusage.v1beta1.IListConsumerOverridesRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IListConsumerOverridesRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
Transform | {Stream} An object stream which emits an object representing [QuotaOverride] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listConsumerOverridesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listConsumerQuotaMetrics(request, options)
listConsumerQuotaMetrics(request?: protos.google.api.serviceusage.v1beta1.IListConsumerQuotaMetricsRequest, options?: CallOptions): Promise<[
protos.google.api.serviceusage.v1beta1.IConsumerQuotaMetric[],
protos.google.api.serviceusage.v1beta1.IListConsumerQuotaMetricsRequest | null,
protos.google.api.serviceusage.v1beta1.IListConsumerQuotaMetricsResponse
]>;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IListConsumerQuotaMetricsRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.api.serviceusage.v1beta1.IConsumerQuotaMetric[],
protos.google.api.serviceusage.v1beta1.IListConsumerQuotaMetricsRequest | null,
protos.google.api.serviceusage.v1beta1.IListConsumerQuotaMetricsResponse
]> | |
listConsumerQuotaMetrics(request, options, callback)
listConsumerQuotaMetrics(request: protos.google.api.serviceusage.v1beta1.IListConsumerQuotaMetricsRequest, options: CallOptions, callback: PaginationCallback<protos.google.api.serviceusage.v1beta1.IListConsumerQuotaMetricsRequest, protos.google.api.serviceusage.v1beta1.IListConsumerQuotaMetricsResponse | null | undefined, protos.google.api.serviceusage.v1beta1.IConsumerQuotaMetric>): void;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IListConsumerQuotaMetricsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.api.serviceusage.v1beta1.IListConsumerQuotaMetricsRequest, protos.google.api.serviceusage.v1beta1.IListConsumerQuotaMetricsResponse | null | undefined, protos.google.api.serviceusage.v1beta1.IConsumerQuotaMetric>
|
Returns
listConsumerQuotaMetrics(request, callback)
listConsumerQuotaMetrics(request: protos.google.api.serviceusage.v1beta1.IListConsumerQuotaMetricsRequest, callback: PaginationCallback<protos.google.api.serviceusage.v1beta1.IListConsumerQuotaMetricsRequest, protos.google.api.serviceusage.v1beta1.IListConsumerQuotaMetricsResponse | null | undefined, protos.google.api.serviceusage.v1beta1.IConsumerQuotaMetric>): void;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IListConsumerQuotaMetricsRequest
|
callback |
PaginationCallback<protos.google.api.serviceusage.v1beta1.IListConsumerQuotaMetricsRequest, protos.google.api.serviceusage.v1beta1.IListConsumerQuotaMetricsResponse | null | undefined, protos.google.api.serviceusage.v1beta1.IConsumerQuotaMetric>
|
Returns
listConsumerQuotaMetricsAsync(request, options)
listConsumerQuotaMetricsAsync(request?: protos.google.api.serviceusage.v1beta1.IListConsumerQuotaMetricsRequest, options?: CallOptions): AsyncIterable<protos.google.api.serviceusage.v1beta1.IConsumerQuotaMetric>;
Equivalent to listConsumerQuotaMetrics
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IListConsumerQuotaMetricsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
AsyncIterable<protos.google.api.serviceusage.v1beta1.IConsumerQuotaMetric> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [ConsumerQuotaMetric]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listConsumerQuotaMetricsStream(request, options)
listConsumerQuotaMetricsStream(request?: protos.google.api.serviceusage.v1beta1.IListConsumerQuotaMetricsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IListConsumerQuotaMetricsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
Transform | {Stream} An object stream which emits an object representing [ConsumerQuotaMetric] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listConsumerQuotaMetricsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listServices(request, options)
listServices(request?: protos.google.api.serviceusage.v1beta1.IListServicesRequest, options?: CallOptions): Promise<[
protos.google.api.serviceusage.v1beta1.IService[],
protos.google.api.serviceusage.v1beta1.IListServicesRequest | null,
protos.google.api.serviceusage.v1beta1.IListServicesResponse
]>;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IListServicesRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.api.serviceusage.v1beta1.IService[],
protos.google.api.serviceusage.v1beta1.IListServicesRequest | null,
protos.google.api.serviceusage.v1beta1.IListServicesResponse
]> | |
listServices(request, options, callback)
listServices(request: protos.google.api.serviceusage.v1beta1.IListServicesRequest, options: CallOptions, callback: PaginationCallback<protos.google.api.serviceusage.v1beta1.IListServicesRequest, protos.google.api.serviceusage.v1beta1.IListServicesResponse | null | undefined, protos.google.api.serviceusage.v1beta1.IService>): void;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IListServicesRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.api.serviceusage.v1beta1.IListServicesRequest, protos.google.api.serviceusage.v1beta1.IListServicesResponse | null | undefined, protos.google.api.serviceusage.v1beta1.IService>
|
Returns
listServices(request, callback)
listServices(request: protos.google.api.serviceusage.v1beta1.IListServicesRequest, callback: PaginationCallback<protos.google.api.serviceusage.v1beta1.IListServicesRequest, protos.google.api.serviceusage.v1beta1.IListServicesResponse | null | undefined, protos.google.api.serviceusage.v1beta1.IService>): void;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IListServicesRequest
|
callback |
PaginationCallback<protos.google.api.serviceusage.v1beta1.IListServicesRequest, protos.google.api.serviceusage.v1beta1.IListServicesResponse | null | undefined, protos.google.api.serviceusage.v1beta1.IService>
|
Returns
listServicesAsync(request, options)
listServicesAsync(request?: protos.google.api.serviceusage.v1beta1.IListServicesRequest, options?: CallOptions): AsyncIterable<protos.google.api.serviceusage.v1beta1.IService>;
Equivalent to listServices
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IListServicesRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
AsyncIterable<protos.google.api.serviceusage.v1beta1.IService> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Service]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listServicesStream(request, options)
listServicesStream(request?: protos.google.api.serviceusage.v1beta1.IListServicesRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IListServicesRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
Transform | {Stream} An object stream which emits an object representing [Service] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listServicesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
updateAdminOverride(request, options)
updateAdminOverride(request?: protos.google.api.serviceusage.v1beta1.IUpdateAdminOverrideRequest, options?: CallOptions): Promise<[
LROperation<protos.google.api.serviceusage.v1beta1.IQuotaOverride, protos.google.api.serviceusage.v1beta1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IUpdateAdminOverrideRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
LROperation<protos.google.api.serviceusage.v1beta1.IQuotaOverride, protos.google.api.serviceusage.v1beta1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | |
updateAdminOverride(request, options, callback)
updateAdminOverride(request: protos.google.api.serviceusage.v1beta1.IUpdateAdminOverrideRequest, options: CallOptions, callback: Callback<LROperation<protos.google.api.serviceusage.v1beta1.IQuotaOverride, protos.google.api.serviceusage.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IUpdateAdminOverrideRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.api.serviceusage.v1beta1.IQuotaOverride, protos.google.api.serviceusage.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
updateAdminOverride(request, callback)
updateAdminOverride(request: protos.google.api.serviceusage.v1beta1.IUpdateAdminOverrideRequest, callback: Callback<LROperation<protos.google.api.serviceusage.v1beta1.IQuotaOverride, protos.google.api.serviceusage.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IUpdateAdminOverrideRequest
|
callback |
Callback<LROperation<protos.google.api.serviceusage.v1beta1.IQuotaOverride, protos.google.api.serviceusage.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
updateConsumerOverride(request, options)
updateConsumerOverride(request?: protos.google.api.serviceusage.v1beta1.IUpdateConsumerOverrideRequest, options?: CallOptions): Promise<[
LROperation<protos.google.api.serviceusage.v1beta1.IQuotaOverride, protos.google.api.serviceusage.v1beta1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IUpdateConsumerOverrideRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
LROperation<protos.google.api.serviceusage.v1beta1.IQuotaOverride, protos.google.api.serviceusage.v1beta1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | |
updateConsumerOverride(request, options, callback)
updateConsumerOverride(request: protos.google.api.serviceusage.v1beta1.IUpdateConsumerOverrideRequest, options: CallOptions, callback: Callback<LROperation<protos.google.api.serviceusage.v1beta1.IQuotaOverride, protos.google.api.serviceusage.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IUpdateConsumerOverrideRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.api.serviceusage.v1beta1.IQuotaOverride, protos.google.api.serviceusage.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
updateConsumerOverride(request, callback)
updateConsumerOverride(request: protos.google.api.serviceusage.v1beta1.IUpdateConsumerOverrideRequest, callback: Callback<LROperation<protos.google.api.serviceusage.v1beta1.IQuotaOverride, protos.google.api.serviceusage.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.api.serviceusage.v1beta1.IUpdateConsumerOverrideRequest
|
callback |
Callback<LROperation<protos.google.api.serviceusage.v1beta1.IQuotaOverride, protos.google.api.serviceusage.v1beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns