@google-cloud/service-control

import type * as gax from 'google-gax'; import type { Callback, CallOptions, Descriptors, ClientOptions } from 'google-gax'; import * as protos from '../../protos/protos'; /** * [Google Service Control API](/service-control/overview) * * Lets clients check and report operations against a [managed * service](https://cloud.google.com/service-management/reference/rpc/google.api/servicemanagement.v1#google.api.servicemanagement.v1.ManagedService). * @class * @memberof v1 */ export declare class ServiceControllerClient { private _terminated; private _opts; private _providedCustomServicePath; private _gaxModule; private _gaxGrpc; private _protos; private _defaults; private _universeDomain; private _servicePath; private _log; auth: gax.GoogleAuth; descriptors: Descriptors; warn: (code: string, message: string, warnType?: string) => void; innerApiCalls: { [name: string]: Function; }; serviceControllerStub?: Promise<{ [name: string]: Function; }>; /** * Construct an instance of ServiceControllerClient. * * @param {object} [options] - The configuration object. * The options accepted by the constructor are described in detail * in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance). * The common options are: * @param {object} [options.credentials] - Credentials object. * @param {string} [options.credentials.client_email] * @param {string} [options.credentials.private_key] * @param {string} [options.email] - Account email address. Required when * using a .pem or .p12 keyFilename. * @param {string} [options.keyFilename] - Full path to the a .json, .pem, or * .p12 key downloaded from the Google Developers Console. If you provide * a path to a JSON file, the projectId option below is not necessary. * NOTE: .pem and .p12 require you to specify options.email as well. * @param {number} [options.port] - The port on which to connect to * the remote host. * @param {string} [options.projectId] - The project ID from the Google * Developer's Console, e.g. 'grape-spaceship-123'. We will also check * the environment variable GCLOUD_PROJECT for your project ID. If your * app is running in an environment which supports * {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials}, * your project ID will be detected automatically. * @param {string} [options.apiEndpoint] - The domain name of the * API remote host. * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override. * Follows the structure of {@link gapicConfig}. * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode. * For more information, please check the * {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}. * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you * need to avoid loading the default gRPC version and want to use the fallback * HTTP implementation. Load only fallback version and pass it to the constructor: * ``` * const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC * const client = new ServiceControllerClient({fallback: true}, gax); * ``` */ constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback); /** * 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 {Promise} A promise that resolves to an authenticated service stub. */ initialize(): Promise<{ [name: string]: Function; }>; /** * The DNS address for this API service. * @deprecated Use the apiEndpoint method of the client instance. * @returns {string} The DNS address for this service. */ static get servicePath(): string; /** * The DNS address for this API service - same as servicePath. * @deprecated Use the apiEndpoint method of the client instance. * @returns {string} The DNS address for this service. */ static get apiEndpoint(): string; /** * The DNS address for this API service. * @returns {string} The DNS address for this service. */ get apiEndpoint(): string; get universeDomain(): string; /** * The port for this API service. * @returns {number} The default port for this service. */ static get port(): number; /** * The scopes needed to make gRPC calls for every method defined * in this service. * @returns {string[]} List of default scopes. */ static get scopes(): string[]; getProjectId(): Promise<string>; getProjectId(callback: Callback<string, undefined, undefined>): void; /** * Checks whether an operation on a service should be allowed to proceed * based on the configuration of the service and related policies. It must be * called before the operation is executed. * * If feasible, the client should cache the check results and reuse them for * 60 seconds. In case of any server errors, the client should rely on the * cached results for much longer time to avoid outage. * WARNING: There is general 60s delay for the configuration and policy * propagation, therefore callers MUST NOT depend on the `Check` method having * the latest policy information. * * NOTE: the {@link protos.google.api.servicecontrol.v1.CheckRequest|CheckRequest} has * the size limit (wire-format byte size) of 1MB. * * This method requires the `servicemanagement.services.check` permission * on the specified service. For more information, see * [Cloud IAM](https://cloud.google.com/iam). * * @param {Object} request * The request object that will be sent. * @param {string} request.serviceName * The service name as specified in its service configuration. For example, * `"pubsub.googleapis.com"`. * * See * [google.api.Service](https://cloud.google.com/service-management/reference/rpc/google.api#google.api.Service) * for the definition of a service name. * @param {google.api.servicecontrol.v1.Operation} request.operation * The operation to be checked. * @param {string} request.serviceConfigId * Specifies which version of service configuration should be used to process * the request. * * If unspecified or no matching version can be found, the * latest one will be used. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.api.servicecontrol.v1.CheckResponse|CheckResponse}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example <caption>include:samples/generated/v1/service_controller.check.js</caption> * region_tag:servicecontrol_v1_generated_ServiceController_Check_async */ check(request?: protos.google.api.servicecontrol.v1.ICheckRequest, options?: CallOptions): Promise<[ protos.google.api.servicecontrol.v1.ICheckResponse, protos.google.api.servicecontrol.v1.ICheckRequest | undefined, {} | undefined ]>; check(request: protos.google.api.servicecontrol.v1.ICheckRequest, options: CallOptions, callback: Callback<protos.google.api.servicecontrol.v1.ICheckResponse, protos.google.api.servicecontrol.v1.ICheckRequest | null | undefined, {} | null | undefined>): void; check(request: protos.google.api.servicecontrol.v1.ICheckRequest, callback: Callback<protos.google.api.servicecontrol.v1.ICheckResponse, protos.google.api.servicecontrol.v1.ICheckRequest | null | undefined, {} | null | undefined>): void; /** * Reports operation results to Google Service Control, such as logs and * metrics. It should be called after an operation is completed. * * If feasible, the client should aggregate reporting data for up to 5 * seconds to reduce API traffic. Limiting aggregation to 5 seconds is to * reduce data loss during client crashes. Clients should carefully choose * the aggregation time window to avoid data loss risk more than 0.01% * for business and compliance reasons. * * NOTE: the {@link protos.google.api.servicecontrol.v1.ReportRequest|ReportRequest} has * the size limit (wire-format byte size) of 1MB. * * This method requires the `servicemanagement.services.report` permission * on the specified service. For more information, see * [Google Cloud IAM](https://cloud.google.com/iam). * * @param {Object} request * The request object that will be sent. * @param {string} request.serviceName * The service name as specified in its service configuration. For example, * `"pubsub.googleapis.com"`. * * See * [google.api.Service](https://cloud.google.com/service-management/reference/rpc/google.api#google.api.Service) * for the definition of a service name. * @param {number[]} request.operations * Operations to be reported. * * Typically the service should report one operation per request. * Putting multiple operations into a single request is allowed, but should * be used only when multiple operations are natually available at the time * of the report. * * There is no limit on the number of operations in the same ReportRequest, * however the ReportRequest size should be no larger than 1MB. See * {@link protos.google.api.servicecontrol.v1.ReportResponse.report_errors|ReportResponse.report_errors} * for partial failure behavior. * @param {string} request.serviceConfigId * Specifies which version of service config should be used to process the * request. * * If unspecified or no matching version can be found, the * latest one will be used. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.api.servicecontrol.v1.ReportResponse|ReportResponse}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example <caption>include:samples/generated/v1/service_controller.report.js</caption> * region_tag:servicecontrol_v1_generated_ServiceController_Report_async */ report(request?: protos.google.api.servicecontrol.v1.IReportRequest, options?: CallOptions): Promise<[ protos.google.api.servicecontrol.v1.IReportResponse, protos.google.api.servicecontrol.v1.IReportRequest | undefined, {} | undefined ]>; report(request: protos.google.api.servicecontrol.v1.IReportRequest, options: CallOptions, callback: Callback<protos.google.api.servicecontrol.v1.IReportResponse, protos.google.api.servicecontrol.v1.IReportRequest | null | undefined, {} | null | undefined>): void; report(request: protos.google.api.servicecontrol.v1.IReportRequest, callback: Callback<protos.google.api.servicecontrol.v1.IReportResponse, protos.google.api.servicecontrol.v1.IReportRequest | null | undefined, {} | null | undefined>): void; /** * Terminate the gRPC channel and close the client. * * The client will no longer be usable and all future behavior is undefined. * @returns {Promise} A promise that resolves when the client is closed. */ close(): Promise<void>; }