UNPKG

@google-cloud/compute

Version:
782 lines (781 loc) 156 kB
import type * as gax from 'google-gax'; import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback } from 'google-gax'; import { Transform } from 'stream'; import * as protos from '../../protos/protos'; /** * The Routers API. * @class * @memberof v1beta */ export declare class RoutersClient { 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; }; routersStub?: Promise<{ [name: string]: Function; }>; /** * Construct an instance of RoutersClient. * * @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 RoutersClient({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; /** * Deletes the specified Router resource. * * @param {Object} request * The request object that will be sent. * @param {string} request.project * Project ID for this request. * @param {string} request.region * Name of the region for this request. * @param {string} request.requestId * An optional request ID to identify requests. Specify a unique request ID so * that if you must retry your request, the server will know to ignore the * request if it has already been completed. * * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same * request ID, the server can check if original operation with the same * request ID was received, and if so, will ignore the second request. This * prevents clients from accidentally creating duplicate commitments. * * The request ID must be * a valid UUID with the exception that zero UUID is not supported * (00000000-0000-0000-0000-000000000000). * @param {string} request.router * Name of the Router resource to delete. * @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 * a long running operation. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, * and might get backwards-incompatible changes at any time. * `.promise()` is not supported yet. * @example <caption>include:samples/generated/v1beta/routers.delete.js</caption> * region_tag:compute_v1beta_generated_Routers_Delete_async */ delete(request?: protos.google.cloud.compute.v1beta.IDeleteRouterRequest, options?: CallOptions): Promise<[ LROperation<protos.google.cloud.compute.v1beta.IOperation, null>, protos.google.cloud.compute.v1beta.IOperation | undefined, {} | undefined ]>; delete(request: protos.google.cloud.compute.v1beta.IDeleteRouterRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IDeleteRouterRequest | null | undefined, {} | null | undefined>): void; delete(request: protos.google.cloud.compute.v1beta.IDeleteRouterRequest, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IDeleteRouterRequest | null | undefined, {} | null | undefined>): void; /** * Deletes Named Set * * @param {Object} request * The request object that will be sent. * @param {string} request.namedSet * The Named Set name for this request. Name must conform to RFC1035 * @param {string} request.project * Project ID for this request. * @param {string} request.region * Name of the region for this request. * @param {string} request.requestId * An optional request ID to identify requests. Specify a unique request ID so * that if you must retry your request, the server will know to ignore the * request if it has already been completed. * * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same * request ID, the server can check if original operation with the same * request ID was received, and if so, will ignore the second request. This * prevents clients from accidentally creating duplicate commitments. * * The request ID must be * a valid UUID with the exception that zero UUID is not supported * (00000000-0000-0000-0000-000000000000). * @param {string} request.router * Name of the Router resource where Named Set is defined. * @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 * a long running operation. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, * and might get backwards-incompatible changes at any time. * `.promise()` is not supported yet. * @example <caption>include:samples/generated/v1beta/routers.delete_named_set.js</caption> * region_tag:compute_v1beta_generated_Routers_DeleteNamedSet_async */ deleteNamedSet(request?: protos.google.cloud.compute.v1beta.IDeleteNamedSetRouterRequest, options?: CallOptions): Promise<[ LROperation<protos.google.cloud.compute.v1beta.IOperation, null>, protos.google.cloud.compute.v1beta.IOperation | undefined, {} | undefined ]>; deleteNamedSet(request: protos.google.cloud.compute.v1beta.IDeleteNamedSetRouterRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IDeleteNamedSetRouterRequest | null | undefined, {} | null | undefined>): void; deleteNamedSet(request: protos.google.cloud.compute.v1beta.IDeleteNamedSetRouterRequest, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IDeleteNamedSetRouterRequest | null | undefined, {} | null | undefined>): void; /** * Deletes Route Policy * * @param {Object} request * The request object that will be sent. * @param {string} request.policy * The Policy name for this request. Name must conform to RFC1035 * @param {string} request.project * Project ID for this request. * @param {string} request.region * Name of the region for this request. * @param {string} request.requestId * An optional request ID to identify requests. Specify a unique request ID so * that if you must retry your request, the server will know to ignore the * request if it has already been completed. * * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same * request ID, the server can check if original operation with the same * request ID was received, and if so, will ignore the second request. This * prevents clients from accidentally creating duplicate commitments. * * The request ID must be * a valid UUID with the exception that zero UUID is not supported * (00000000-0000-0000-0000-000000000000). * @param {string} request.router * Name of the Router resource where Route Policy is defined. * @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 * a long running operation. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, * and might get backwards-incompatible changes at any time. * `.promise()` is not supported yet. * @example <caption>include:samples/generated/v1beta/routers.delete_route_policy.js</caption> * region_tag:compute_v1beta_generated_Routers_DeleteRoutePolicy_async */ deleteRoutePolicy(request?: protos.google.cloud.compute.v1beta.IDeleteRoutePolicyRouterRequest, options?: CallOptions): Promise<[ LROperation<protos.google.cloud.compute.v1beta.IOperation, null>, protos.google.cloud.compute.v1beta.IOperation | undefined, {} | undefined ]>; deleteRoutePolicy(request: protos.google.cloud.compute.v1beta.IDeleteRoutePolicyRouterRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IDeleteRoutePolicyRouterRequest | null | undefined, {} | null | undefined>): void; deleteRoutePolicy(request: protos.google.cloud.compute.v1beta.IDeleteRoutePolicyRouterRequest, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IDeleteRoutePolicyRouterRequest | null | undefined, {} | null | undefined>): void; /** * Returns the specified Router resource. * * @param {Object} request * The request object that will be sent. * @param {string} request.project * Project ID for this request. * @param {string} request.region * Name of the region for this request. * @param {string} request.router * Name of the Router resource to return. * @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.cloud.compute.v1beta.Router|Router}. * 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/v1beta/routers.get.js</caption> * region_tag:compute_v1beta_generated_Routers_Get_async */ get(request?: protos.google.cloud.compute.v1beta.IGetRouterRequest, options?: CallOptions): Promise<[ protos.google.cloud.compute.v1beta.IRouter, protos.google.cloud.compute.v1beta.IGetRouterRequest | undefined, {} | undefined ]>; get(request: protos.google.cloud.compute.v1beta.IGetRouterRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IRouter, protos.google.cloud.compute.v1beta.IGetRouterRequest | null | undefined, {} | null | undefined>): void; get(request: protos.google.cloud.compute.v1beta.IGetRouterRequest, callback: Callback<protos.google.cloud.compute.v1beta.IRouter, protos.google.cloud.compute.v1beta.IGetRouterRequest | null | undefined, {} | null | undefined>): void; /** * Returns specified Named Set * * @param {Object} request * The request object that will be sent. * @param {string} request.namedSet * The Named Set name for this request. Name must conform to RFC1035 * @param {string} request.project * Project ID for this request. * @param {string} request.region * Name of the region for this request. * @param {string} request.router * Name of the Router resource to query for the named set. The name should * conform to RFC1035. * @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.cloud.compute.v1beta.RoutersGetNamedSetResponse|RoutersGetNamedSetResponse}. * 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/v1beta/routers.get_named_set.js</caption> * region_tag:compute_v1beta_generated_Routers_GetNamedSet_async */ getNamedSet(request?: protos.google.cloud.compute.v1beta.IGetNamedSetRouterRequest, options?: CallOptions): Promise<[ protos.google.cloud.compute.v1beta.IRoutersGetNamedSetResponse, protos.google.cloud.compute.v1beta.IGetNamedSetRouterRequest | undefined, {} | undefined ]>; getNamedSet(request: protos.google.cloud.compute.v1beta.IGetNamedSetRouterRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IRoutersGetNamedSetResponse, protos.google.cloud.compute.v1beta.IGetNamedSetRouterRequest | null | undefined, {} | null | undefined>): void; getNamedSet(request: protos.google.cloud.compute.v1beta.IGetNamedSetRouterRequest, callback: Callback<protos.google.cloud.compute.v1beta.IRoutersGetNamedSetResponse, protos.google.cloud.compute.v1beta.IGetNamedSetRouterRequest | null | undefined, {} | null | undefined>): void; /** * Retrieves runtime NAT IP information. * * @param {Object} request * The request object that will be sent. * @param {string} request.natName * Name of the nat service to filter the NAT IP information. * If it is omitted, all nats for this router will be returned. * Name should conform to RFC1035. * @param {string} request.project * Project ID for this request. * @param {string} request.region * Name of the region for this request. * @param {string} request.router * Name of the Router resource to query for Nat IP information. The name * should conform to RFC1035. * @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.cloud.compute.v1beta.NatIpInfoResponse|NatIpInfoResponse}. * 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/v1beta/routers.get_nat_ip_info.js</caption> * region_tag:compute_v1beta_generated_Routers_GetNatIpInfo_async */ getNatIpInfo(request?: protos.google.cloud.compute.v1beta.IGetNatIpInfoRouterRequest, options?: CallOptions): Promise<[ protos.google.cloud.compute.v1beta.INatIpInfoResponse, protos.google.cloud.compute.v1beta.IGetNatIpInfoRouterRequest | undefined, {} | undefined ]>; getNatIpInfo(request: protos.google.cloud.compute.v1beta.IGetNatIpInfoRouterRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.INatIpInfoResponse, protos.google.cloud.compute.v1beta.IGetNatIpInfoRouterRequest | null | undefined, {} | null | undefined>): void; getNatIpInfo(request: protos.google.cloud.compute.v1beta.IGetNatIpInfoRouterRequest, callback: Callback<protos.google.cloud.compute.v1beta.INatIpInfoResponse, protos.google.cloud.compute.v1beta.IGetNatIpInfoRouterRequest | null | undefined, {} | null | undefined>): void; /** * Returns specified Route Policy * * @param {Object} request * The request object that will be sent. * @param {string} request.policy * The Policy name for this request. Name must conform to RFC1035 * @param {string} request.project * Project ID for this request. * @param {string} request.region * Name of the region for this request. * @param {string} request.router * Name of the Router resource to query for the route policy. The name should * conform to RFC1035. * @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.cloud.compute.v1beta.RoutersGetRoutePolicyResponse|RoutersGetRoutePolicyResponse}. * 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/v1beta/routers.get_route_policy.js</caption> * region_tag:compute_v1beta_generated_Routers_GetRoutePolicy_async */ getRoutePolicy(request?: protos.google.cloud.compute.v1beta.IGetRoutePolicyRouterRequest, options?: CallOptions): Promise<[ protos.google.cloud.compute.v1beta.IRoutersGetRoutePolicyResponse, protos.google.cloud.compute.v1beta.IGetRoutePolicyRouterRequest | undefined, {} | undefined ]>; getRoutePolicy(request: protos.google.cloud.compute.v1beta.IGetRoutePolicyRouterRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IRoutersGetRoutePolicyResponse, protos.google.cloud.compute.v1beta.IGetRoutePolicyRouterRequest | null | undefined, {} | null | undefined>): void; getRoutePolicy(request: protos.google.cloud.compute.v1beta.IGetRoutePolicyRouterRequest, callback: Callback<protos.google.cloud.compute.v1beta.IRoutersGetRoutePolicyResponse, protos.google.cloud.compute.v1beta.IGetRoutePolicyRouterRequest | null | undefined, {} | null | undefined>): void; /** * Retrieves runtime information of the specified router. * * @param {Object} request * The request object that will be sent. * @param {string} request.project * Project ID for this request. * @param {string} request.region * Name of the region for this request. * @param {string} request.router * Name of the Router resource to query. * @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.cloud.compute.v1beta.RouterStatusResponse|RouterStatusResponse}. * 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/v1beta/routers.get_router_status.js</caption> * region_tag:compute_v1beta_generated_Routers_GetRouterStatus_async */ getRouterStatus(request?: protos.google.cloud.compute.v1beta.IGetRouterStatusRouterRequest, options?: CallOptions): Promise<[ protos.google.cloud.compute.v1beta.IRouterStatusResponse, protos.google.cloud.compute.v1beta.IGetRouterStatusRouterRequest | undefined, {} | undefined ]>; getRouterStatus(request: protos.google.cloud.compute.v1beta.IGetRouterStatusRouterRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IRouterStatusResponse, protos.google.cloud.compute.v1beta.IGetRouterStatusRouterRequest | null | undefined, {} | null | undefined>): void; getRouterStatus(request: protos.google.cloud.compute.v1beta.IGetRouterStatusRouterRequest, callback: Callback<protos.google.cloud.compute.v1beta.IRouterStatusResponse, protos.google.cloud.compute.v1beta.IGetRouterStatusRouterRequest | null | undefined, {} | null | undefined>): void; /** * Creates a Router resource in the specified project and region using * the data included in the request. * * @param {Object} request * The request object that will be sent. * @param {string} request.project * Project ID for this request. * @param {string} request.region * Name of the region for this request. * @param {string} request.requestId * An optional request ID to identify requests. Specify a unique request ID so * that if you must retry your request, the server will know to ignore the * request if it has already been completed. * * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same * request ID, the server can check if original operation with the same * request ID was received, and if so, will ignore the second request. This * prevents clients from accidentally creating duplicate commitments. * * The request ID must be * a valid UUID with the exception that zero UUID is not supported * (00000000-0000-0000-0000-000000000000). * @param {google.cloud.compute.v1beta.Router} request.routerResource * The body resource for this request * @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 * a long running operation. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, * and might get backwards-incompatible changes at any time. * `.promise()` is not supported yet. * @example <caption>include:samples/generated/v1beta/routers.insert.js</caption> * region_tag:compute_v1beta_generated_Routers_Insert_async */ insert(request?: protos.google.cloud.compute.v1beta.IInsertRouterRequest, options?: CallOptions): Promise<[ LROperation<protos.google.cloud.compute.v1beta.IOperation, null>, protos.google.cloud.compute.v1beta.IOperation | undefined, {} | undefined ]>; insert(request: protos.google.cloud.compute.v1beta.IInsertRouterRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IInsertRouterRequest | null | undefined, {} | null | undefined>): void; insert(request: protos.google.cloud.compute.v1beta.IInsertRouterRequest, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IInsertRouterRequest | null | undefined, {} | null | undefined>): void; /** * Patches the specified Router resource with the data included in the * request. This method supportsPATCH * semantics and usesJSON merge * patch format and processing rules. * * @param {Object} request * The request object that will be sent. * @param {string} request.project * Project ID for this request. * @param {string} request.region * Name of the region for this request. * @param {string} request.requestId * An optional request ID to identify requests. Specify a unique request ID so * that if you must retry your request, the server will know to ignore the * request if it has already been completed. * * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same * request ID, the server can check if original operation with the same * request ID was received, and if so, will ignore the second request. This * prevents clients from accidentally creating duplicate commitments. * * The request ID must be * a valid UUID with the exception that zero UUID is not supported * (00000000-0000-0000-0000-000000000000). * @param {string} request.router * Name of the Router resource to patch. * @param {google.cloud.compute.v1beta.Router} request.routerResource * The body resource for this request * @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 * a long running operation. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, * and might get backwards-incompatible changes at any time. * `.promise()` is not supported yet. * @example <caption>include:samples/generated/v1beta/routers.patch.js</caption> * region_tag:compute_v1beta_generated_Routers_Patch_async */ patch(request?: protos.google.cloud.compute.v1beta.IPatchRouterRequest, options?: CallOptions): Promise<[ LROperation<protos.google.cloud.compute.v1beta.IOperation, null>, protos.google.cloud.compute.v1beta.IOperation | undefined, {} | undefined ]>; patch(request: protos.google.cloud.compute.v1beta.IPatchRouterRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IPatchRouterRequest | null | undefined, {} | null | undefined>): void; patch(request: protos.google.cloud.compute.v1beta.IPatchRouterRequest, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IPatchRouterRequest | null | undefined, {} | null | undefined>): void; /** * Patches Named Set * * @param {Object} request * The request object that will be sent. * @param {google.cloud.compute.v1beta.NamedSet} request.namedSetResource * The body resource for this request * @param {string} request.project * Project ID for this request. * @param {string} request.region * Name of the region for this request. * @param {string} request.requestId * An optional request ID to identify requests. Specify a unique request ID so * that if you must retry your request, the server will know to ignore the * request if it has already been completed. * * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same * request ID, the server can check if original operation with the same * request ID was received, and if so, will ignore the second request. This * prevents clients from accidentally creating duplicate commitments. * * The request ID must be * a valid UUID with the exception that zero UUID is not supported * (00000000-0000-0000-0000-000000000000). * @param {string} request.router * Name of the Router resource where Named Set is defined. * @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 * a long running operation. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, * and might get backwards-incompatible changes at any time. * `.promise()` is not supported yet. * @example <caption>include:samples/generated/v1beta/routers.patch_named_set.js</caption> * region_tag:compute_v1beta_generated_Routers_PatchNamedSet_async */ patchNamedSet(request?: protos.google.cloud.compute.v1beta.IPatchNamedSetRouterRequest, options?: CallOptions): Promise<[ LROperation<protos.google.cloud.compute.v1beta.IOperation, null>, protos.google.cloud.compute.v1beta.IOperation | undefined, {} | undefined ]>; patchNamedSet(request: protos.google.cloud.compute.v1beta.IPatchNamedSetRouterRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IPatchNamedSetRouterRequest | null | undefined, {} | null | undefined>): void; patchNamedSet(request: protos.google.cloud.compute.v1beta.IPatchNamedSetRouterRequest, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IPatchNamedSetRouterRequest | null | undefined, {} | null | undefined>): void; /** * Patches Route Policy * * @param {Object} request * The request object that will be sent. * @param {string} request.project * Project ID for this request. * @param {string} request.region * Name of the region for this request. * @param {string} request.requestId * An optional request ID to identify requests. Specify a unique request ID so * that if you must retry your request, the server will know to ignore the * request if it has already been completed. * * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same * request ID, the server can check if original operation with the same * request ID was received, and if so, will ignore the second request. This * prevents clients from accidentally creating duplicate commitments. * * The request ID must be * a valid UUID with the exception that zero UUID is not supported * (00000000-0000-0000-0000-000000000000). * @param {google.cloud.compute.v1beta.RoutePolicy} request.routePolicyResource * The body resource for this request * @param {string} request.router * Name of the Router resource where Route Policy is defined. * @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 * a long running operation. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, * and might get backwards-incompatible changes at any time. * `.promise()` is not supported yet. * @example <caption>include:samples/generated/v1beta/routers.patch_route_policy.js</caption> * region_tag:compute_v1beta_generated_Routers_PatchRoutePolicy_async */ patchRoutePolicy(request?: protos.google.cloud.compute.v1beta.IPatchRoutePolicyRouterRequest, options?: CallOptions): Promise<[ LROperation<protos.google.cloud.compute.v1beta.IOperation, null>, protos.google.cloud.compute.v1beta.IOperation | undefined, {} | undefined ]>; patchRoutePolicy(request: protos.google.cloud.compute.v1beta.IPatchRoutePolicyRouterRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IPatchRoutePolicyRouterRequest | null | undefined, {} | null | undefined>): void; patchRoutePolicy(request: protos.google.cloud.compute.v1beta.IPatchRoutePolicyRouterRequest, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IPatchRoutePolicyRouterRequest | null | undefined, {} | null | undefined>): void; /** * Preview fields auto-generated during router create andupdate operations. * Calling this method does NOT create or update the router. * * @param {Object} request * The request object that will be sent. * @param {string} request.project * Project ID for this request. * @param {string} request.region * Name of the region for this request. * @param {string} request.router * Name of the Router resource to query. * @param {google.cloud.compute.v1beta.Router} request.routerResource * The body resource for this request * @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.cloud.compute.v1beta.RoutersPreviewResponse|RoutersPreviewResponse}. * 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/v1beta/routers.preview.js</caption> * region_tag:compute_v1beta_generated_Routers_Preview_async */ preview(request?: protos.google.cloud.compute.v1beta.IPreviewRouterRequest, options?: CallOptions): Promise<[ protos.google.cloud.compute.v1beta.IRoutersPreviewResponse, protos.google.cloud.compute.v1beta.IPreviewRouterRequest | undefined, {} | undefined ]>; preview(request: protos.google.cloud.compute.v1beta.IPreviewRouterRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IRoutersPreviewResponse, protos.google.cloud.compute.v1beta.IPreviewRouterRequest | null | undefined, {} | null | undefined>): void; preview(request: protos.google.cloud.compute.v1beta.IPreviewRouterRequest, callback: Callback<protos.google.cloud.compute.v1beta.IRoutersPreviewResponse, protos.google.cloud.compute.v1beta.IPreviewRouterRequest | null | undefined, {} | null | undefined>): void; /** * Returns permissions that a caller has on the specified resource. * * @param {Object} request * The request object that will be sent. * @param {string} request.project * Project ID for this request. * @param {string} request.region * The name of the region for this request. * @param {string} request.resource * Name or id of the resource for this request. * @param {google.cloud.compute.v1beta.TestPermissionsRequest} request.testPermissionsRequestResource * The body resource for this request * @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.cloud.compute.v1beta.TestPermissionsResponse|TestPermissionsResponse}. * 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/v1beta/routers.test_iam_permissions.js</caption> * region_tag:compute_v1beta_generated_Routers_TestIamPermissions_async */ testIamPermissions(request?: protos.google.cloud.compute.v1beta.ITestIamPermissionsRouterRequest, options?: CallOptions): Promise<[ protos.google.cloud.compute.v1beta.ITestPermissionsResponse, protos.google.cloud.compute.v1beta.ITestIamPermissionsRouterRequest | undefined, {} | undefined ]>; testIamPermissions(request: protos.google.cloud.compute.v1beta.ITestIamPermissionsRouterRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.ITestPermissionsResponse, protos.google.cloud.compute.v1beta.ITestIamPermissionsRouterRequest | null | undefined, {} | null | undefined>): void; testIamPermissions(request: protos.google.cloud.compute.v1beta.ITestIamPermissionsRouterRequest, callback: Callback<protos.google.cloud.compute.v1beta.ITestPermissionsResponse, protos.google.cloud.compute.v1beta.ITestIamPermissionsRouterRequest | null | undefined, {} | null | undefined>): void; /** * Updates the specified Router resource with the data included in the * request. This method conforms toPUT semantics, which requests that the state of the * target resource be created or replaced with the state defined by the * representation enclosed in the request message payload. * * @param {Object} request * The request object that will be sent. * @param {string} request.project * Project ID for this request. * @param {string} request.region * Name of the region for this request. * @param {string} request.requestId * An optional request ID to identify requests. Specify a unique request ID so * that if you must retry your request, the server will know to ignore the * request if it has already been completed. * * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same * request ID, the server can check if original operation with the same * request ID was received, and if so, will ignore the second request. This * prevents clients from accidentally creating duplicate commitments. * * The request ID must be * a valid UUID with the exception that zero UUID is not supported * (00000000-0000-0000-0000-000000000000). * @param {string} request.router * Name of the Router resource to update. * @param {google.cloud.compute.v1beta.Router} request.routerResource * The body resource for this request * @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 * a long running operation. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, * and might get backwards-incompatible changes at any time. * `.promise()` is not supported yet. * @example <caption>include:samples/generated/v1beta/routers.update.js</caption> * region_tag:compute_v1beta_generated_Routers_Update_async */ update(request?: protos.google.cloud.compute.v1beta.IUpdateRouterRequest, options?: CallOptions): Promise<[ LROperation<protos.google.cloud.compute.v1beta.IOperation, null>, protos.google.cloud.compute.v1beta.IOperation | undefined, {} | undefined ]>; update(request: protos.google.cloud.compute.v1beta.IUpdateRouterRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IUpdateRouterRequest | null | undefined, {} | null | undefined>): void; update(request: protos.google.cloud.compute.v1beta.IUpdateRouterRequest, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IUpdateRouterRequest | null | undefined, {} | null | undefined>): void; /** * Updates or creates new Named Set * * @param {Object} request * The request object that will be sent. * @param {google.cloud.compute.v1beta.NamedSet} request.namedSetResource * The body resource for this request * @param {string} request.project * Project ID for this request. * @param {string} request.region * Name of the region for this request. * @param {string} request.requestId * An optional request ID to identify requests. Specify a unique request ID so * that if you must retry your request, the server will know to ignore the * request if it has already been completed. * * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same * request ID, the server can check if original operation with the same * request ID was received, and if so, will ignore the second request. This * prevents clients from accidentally creating duplicate commitments. * * The request ID must be * a valid UUID with the exception that zero UUID is not supported * (00000000-0000-0000-0000-000000000000). * @param {string} request.router * Name of the Router resource where Named Set is defined. * @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 * a long running operation. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * This method is considered to be in beta. This means while * stable it is still a work-in-progress and under active development, * and might get backwards-incompatible changes at any time. * `.promise()` is not supported yet. * @example <caption>include:samples/generated/v1beta/routers.update_named_set.js</caption> * region_tag:compute_v1beta_generated_Routers_UpdateNamedSet_async */ updateNamedSet(request?: protos.google.cloud.compute.v1beta.IUpdateNamedSetRouterRequest, options?: CallOptions): Promise<[ LROperation<protos.google.cloud.compute.v1beta.IOperation, null>, protos.google.cloud.compute.v1beta.IOperation | undefined, {} | undefined ]>; updateNamedSet(request: protos.google.cloud.compute.v1beta.IUpdateNamedSetRouterRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IUpdateNamedSetRouterRequest | null | undefined, {} | null | undefined>): void; updateNamedSet(request: protos.google.cloud.compute.v1beta.IUpdateNamedSetRouterRequest, callback: Callback<protos.google.cloud.compute.v1beta.IOperation, protos.google.cloud.compute.v1beta.IUpdateNamedSetRouterRequest | null | undefined, {} | null | undefined>): void; /** * Updates or creates new Route Policy * * @param {Object} request * The request object that will be sent. * @param {string} request.project * Project ID for this request. * @param {string} request.region * Name of the region for this request. * @param {string} request.requestId * An optional request ID to identify requests. Specify a unique request ID so * that if you must retry your request, the server will know to ignore the * request if it has already been completed. * * For example, consider a situation where you make an initial request and * the request times out. If you make the request again with the same * request ID, the server can check if original operation with the same * request ID was received, and if so, will ignore the second request. This * prevents clients from accidentally creating duplicate commitments. * * The request ID must be * a valid UUID with the exception that zero UUID is not supported * (00000000-0000-0000-0000-000000000000). * @param {google.cloud.compute.v1beta.RoutePolicy} request.routePolicyResource * The body resource for this request * @param {string} request.router * Name of the Router resource where Route Policy is defined.