UNPKG

@google-cloud/edgecontainer

Version:
708 lines 90.6 kB
import type * as gax from 'google-gax'; import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback, LocationsClient, LocationProtos } from 'google-gax'; import { Transform } from 'stream'; import * as protos from '../../protos/protos'; /** * EdgeContainer API provides management of Kubernetes Clusters on Google Edge * Cloud deployments. * @class * @memberof v1 */ export declare class EdgeContainerClient { 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; }; locationsClient: LocationsClient; pathTemplates: { [name: string]: gax.PathTemplate; }; operationsClient: gax.OperationsClient; edgeContainerStub?: Promise<{ [name: string]: Function; }>; /** * Construct an instance of EdgeContainerClient. * * @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 EdgeContainerClient({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; /** * Gets details of a single Cluster. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The resource name of the cluster. * @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.edgecontainer.v1.Cluster|Cluster}. * 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/edge_container.get_cluster.js</caption> * region_tag:edgecontainer_v1_generated_EdgeContainer_GetCluster_async */ getCluster(request?: protos.google.cloud.edgecontainer.v1.IGetClusterRequest, options?: CallOptions): Promise<[ protos.google.cloud.edgecontainer.v1.ICluster, protos.google.cloud.edgecontainer.v1.IGetClusterRequest | undefined, {} | undefined ]>; getCluster(request: protos.google.cloud.edgecontainer.v1.IGetClusterRequest, options: CallOptions, callback: Callback<protos.google.cloud.edgecontainer.v1.ICluster, protos.google.cloud.edgecontainer.v1.IGetClusterRequest | null | undefined, {} | null | undefined>): void; getCluster(request: protos.google.cloud.edgecontainer.v1.IGetClusterRequest, callback: Callback<protos.google.cloud.edgecontainer.v1.ICluster, protos.google.cloud.edgecontainer.v1.IGetClusterRequest | null | undefined, {} | null | undefined>): void; /** * Generates an access token for a Cluster. * * @param {Object} request * The request object that will be sent. * @param {string} request.cluster * Required. The resource name of the cluster. * @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.edgecontainer.v1.GenerateAccessTokenResponse|GenerateAccessTokenResponse}. * 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/edge_container.generate_access_token.js</caption> * region_tag:edgecontainer_v1_generated_EdgeContainer_GenerateAccessToken_async */ generateAccessToken(request?: protos.google.cloud.edgecontainer.v1.IGenerateAccessTokenRequest, options?: CallOptions): Promise<[ protos.google.cloud.edgecontainer.v1.IGenerateAccessTokenResponse, protos.google.cloud.edgecontainer.v1.IGenerateAccessTokenRequest | undefined, {} | undefined ]>; generateAccessToken(request: protos.google.cloud.edgecontainer.v1.IGenerateAccessTokenRequest, options: CallOptions, callback: Callback<protos.google.cloud.edgecontainer.v1.IGenerateAccessTokenResponse, protos.google.cloud.edgecontainer.v1.IGenerateAccessTokenRequest | null | undefined, {} | null | undefined>): void; generateAccessToken(request: protos.google.cloud.edgecontainer.v1.IGenerateAccessTokenRequest, callback: Callback<protos.google.cloud.edgecontainer.v1.IGenerateAccessTokenResponse, protos.google.cloud.edgecontainer.v1.IGenerateAccessTokenRequest | null | undefined, {} | null | undefined>): void; /** * Generates an offline credential for a Cluster. * * @param {Object} request * The request object that will be sent. * @param {string} request.cluster * Required. The resource name of the cluster. * @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.edgecontainer.v1.GenerateOfflineCredentialResponse|GenerateOfflineCredentialResponse}. * 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/edge_container.generate_offline_credential.js</caption> * region_tag:edgecontainer_v1_generated_EdgeContainer_GenerateOfflineCredential_async */ generateOfflineCredential(request?: protos.google.cloud.edgecontainer.v1.IGenerateOfflineCredentialRequest, options?: CallOptions): Promise<[ protos.google.cloud.edgecontainer.v1.IGenerateOfflineCredentialResponse, protos.google.cloud.edgecontainer.v1.IGenerateOfflineCredentialRequest | undefined, {} | undefined ]>; generateOfflineCredential(request: protos.google.cloud.edgecontainer.v1.IGenerateOfflineCredentialRequest, options: CallOptions, callback: Callback<protos.google.cloud.edgecontainer.v1.IGenerateOfflineCredentialResponse, protos.google.cloud.edgecontainer.v1.IGenerateOfflineCredentialRequest | null | undefined, {} | null | undefined>): void; generateOfflineCredential(request: protos.google.cloud.edgecontainer.v1.IGenerateOfflineCredentialRequest, callback: Callback<protos.google.cloud.edgecontainer.v1.IGenerateOfflineCredentialResponse, protos.google.cloud.edgecontainer.v1.IGenerateOfflineCredentialRequest | null | undefined, {} | null | undefined>): void; /** * Gets details of a single NodePool. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The resource name of the node pool. * @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.edgecontainer.v1.NodePool|NodePool}. * 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/edge_container.get_node_pool.js</caption> * region_tag:edgecontainer_v1_generated_EdgeContainer_GetNodePool_async */ getNodePool(request?: protos.google.cloud.edgecontainer.v1.IGetNodePoolRequest, options?: CallOptions): Promise<[ protos.google.cloud.edgecontainer.v1.INodePool, protos.google.cloud.edgecontainer.v1.IGetNodePoolRequest | undefined, {} | undefined ]>; getNodePool(request: protos.google.cloud.edgecontainer.v1.IGetNodePoolRequest, options: CallOptions, callback: Callback<protos.google.cloud.edgecontainer.v1.INodePool, protos.google.cloud.edgecontainer.v1.IGetNodePoolRequest | null | undefined, {} | null | undefined>): void; getNodePool(request: protos.google.cloud.edgecontainer.v1.IGetNodePoolRequest, callback: Callback<protos.google.cloud.edgecontainer.v1.INodePool, protos.google.cloud.edgecontainer.v1.IGetNodePoolRequest | null | undefined, {} | null | undefined>): void; /** * Gets details of a single Machine. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The resource name of the machine. * @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.edgecontainer.v1.Machine|Machine}. * 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/edge_container.get_machine.js</caption> * region_tag:edgecontainer_v1_generated_EdgeContainer_GetMachine_async */ getMachine(request?: protos.google.cloud.edgecontainer.v1.IGetMachineRequest, options?: CallOptions): Promise<[ protos.google.cloud.edgecontainer.v1.IMachine, protos.google.cloud.edgecontainer.v1.IGetMachineRequest | undefined, {} | undefined ]>; getMachine(request: protos.google.cloud.edgecontainer.v1.IGetMachineRequest, options: CallOptions, callback: Callback<protos.google.cloud.edgecontainer.v1.IMachine, protos.google.cloud.edgecontainer.v1.IGetMachineRequest | null | undefined, {} | null | undefined>): void; getMachine(request: protos.google.cloud.edgecontainer.v1.IGetMachineRequest, callback: Callback<protos.google.cloud.edgecontainer.v1.IMachine, protos.google.cloud.edgecontainer.v1.IGetMachineRequest | null | undefined, {} | null | undefined>): void; /** * Gets details of a single VPN connection. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The resource name of the vpn connection. * @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.edgecontainer.v1.VpnConnection|VpnConnection}. * 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/edge_container.get_vpn_connection.js</caption> * region_tag:edgecontainer_v1_generated_EdgeContainer_GetVpnConnection_async */ getVpnConnection(request?: protos.google.cloud.edgecontainer.v1.IGetVpnConnectionRequest, options?: CallOptions): Promise<[ protos.google.cloud.edgecontainer.v1.IVpnConnection, protos.google.cloud.edgecontainer.v1.IGetVpnConnectionRequest | undefined, {} | undefined ]>; getVpnConnection(request: protos.google.cloud.edgecontainer.v1.IGetVpnConnectionRequest, options: CallOptions, callback: Callback<protos.google.cloud.edgecontainer.v1.IVpnConnection, protos.google.cloud.edgecontainer.v1.IGetVpnConnectionRequest | null | undefined, {} | null | undefined>): void; getVpnConnection(request: protos.google.cloud.edgecontainer.v1.IGetVpnConnectionRequest, callback: Callback<protos.google.cloud.edgecontainer.v1.IVpnConnection, protos.google.cloud.edgecontainer.v1.IGetVpnConnectionRequest | null | undefined, {} | null | undefined>): void; /** * Gets the server config. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The name (project and location) of the server config to get, * specified in the format `projects/* /locations/*`. * @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.edgecontainer.v1.ServerConfig|ServerConfig}. * 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/edge_container.get_server_config.js</caption> * region_tag:edgecontainer_v1_generated_EdgeContainer_GetServerConfig_async */ getServerConfig(request?: protos.google.cloud.edgecontainer.v1.IGetServerConfigRequest, options?: CallOptions): Promise<[ protos.google.cloud.edgecontainer.v1.IServerConfig, protos.google.cloud.edgecontainer.v1.IGetServerConfigRequest | undefined, {} | undefined ]>; getServerConfig(request: protos.google.cloud.edgecontainer.v1.IGetServerConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.edgecontainer.v1.IServerConfig, protos.google.cloud.edgecontainer.v1.IGetServerConfigRequest | null | undefined, {} | null | undefined>): void; getServerConfig(request: protos.google.cloud.edgecontainer.v1.IGetServerConfigRequest, callback: Callback<protos.google.cloud.edgecontainer.v1.IServerConfig, protos.google.cloud.edgecontainer.v1.IGetServerConfigRequest | null | undefined, {} | null | undefined>): void; /** * Creates a new Cluster in a given project and location. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent location where this cluster will be created. * @param {string} request.clusterId * Required. A client-specified unique identifier for the cluster. * @param {google.cloud.edgecontainer.v1.Cluster} request.cluster * Required. The cluster to create. * @param {string} request.requestId * A unique identifier for this request. Restricted to 36 ASCII characters. A * random UUID is recommended. This request is only idempotent if * `request_id` is provided. * @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. Its `promise()` method returns a promise * you can `await` for. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example <caption>include:samples/generated/v1/edge_container.create_cluster.js</caption> * region_tag:edgecontainer_v1_generated_EdgeContainer_CreateCluster_async */ createCluster(request?: protos.google.cloud.edgecontainer.v1.ICreateClusterRequest, options?: CallOptions): Promise<[ LROperation<protos.google.cloud.edgecontainer.v1.ICluster, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; createCluster(request: protos.google.cloud.edgecontainer.v1.ICreateClusterRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.edgecontainer.v1.ICluster, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; createCluster(request: protos.google.cloud.edgecontainer.v1.ICreateClusterRequest, callback: Callback<LROperation<protos.google.cloud.edgecontainer.v1.ICluster, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `createCluster()`. * @param {String} name * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example <caption>include:samples/generated/v1/edge_container.create_cluster.js</caption> * region_tag:edgecontainer_v1_generated_EdgeContainer_CreateCluster_async */ checkCreateClusterProgress(name: string): Promise<LROperation<protos.google.cloud.edgecontainer.v1.Cluster, protos.google.cloud.edgecontainer.v1.OperationMetadata>>; /** * Updates the parameters of a single Cluster. * * @param {Object} request * The request object that will be sent. * @param {google.protobuf.FieldMask} request.updateMask * Field mask is used to specify the fields to be overwritten in the * Cluster resource by the update. * The fields specified in the update_mask are relative to the resource, not * the full request. A field will be overwritten if it is in the mask. If the * user does not provide a mask then all fields will be overwritten. * @param {google.cloud.edgecontainer.v1.Cluster} request.cluster * The updated cluster. * @param {string} request.requestId * A unique identifier for this request. Restricted to 36 ASCII characters. * A random UUID is recommended. * This request is only idempotent if `request_id` is provided. * @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. Its `promise()` method returns a promise * you can `await` for. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example <caption>include:samples/generated/v1/edge_container.update_cluster.js</caption> * region_tag:edgecontainer_v1_generated_EdgeContainer_UpdateCluster_async */ updateCluster(request?: protos.google.cloud.edgecontainer.v1.IUpdateClusterRequest, options?: CallOptions): Promise<[ LROperation<protos.google.cloud.edgecontainer.v1.ICluster, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; updateCluster(request: protos.google.cloud.edgecontainer.v1.IUpdateClusterRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.edgecontainer.v1.ICluster, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; updateCluster(request: protos.google.cloud.edgecontainer.v1.IUpdateClusterRequest, callback: Callback<LROperation<protos.google.cloud.edgecontainer.v1.ICluster, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `updateCluster()`. * @param {String} name * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example <caption>include:samples/generated/v1/edge_container.update_cluster.js</caption> * region_tag:edgecontainer_v1_generated_EdgeContainer_UpdateCluster_async */ checkUpdateClusterProgress(name: string): Promise<LROperation<protos.google.cloud.edgecontainer.v1.Cluster, protos.google.cloud.edgecontainer.v1.OperationMetadata>>; /** * Upgrades a single cluster. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The resource name of the cluster. * @param {string} request.targetVersion * Required. The version the cluster is going to be upgraded to. * @param {google.cloud.edgecontainer.v1.UpgradeClusterRequest.Schedule} request.schedule * The schedule for the upgrade. * @param {string} request.requestId * A unique identifier for this request. Restricted to 36 ASCII characters. A * random UUID is recommended. This request is only idempotent if * `request_id` is provided. * @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. Its `promise()` method returns a promise * you can `await` for. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example <caption>include:samples/generated/v1/edge_container.upgrade_cluster.js</caption> * region_tag:edgecontainer_v1_generated_EdgeContainer_UpgradeCluster_async */ upgradeCluster(request?: protos.google.cloud.edgecontainer.v1.IUpgradeClusterRequest, options?: CallOptions): Promise<[ LROperation<protos.google.cloud.edgecontainer.v1.ICluster, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; upgradeCluster(request: protos.google.cloud.edgecontainer.v1.IUpgradeClusterRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.edgecontainer.v1.ICluster, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; upgradeCluster(request: protos.google.cloud.edgecontainer.v1.IUpgradeClusterRequest, callback: Callback<LROperation<protos.google.cloud.edgecontainer.v1.ICluster, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `upgradeCluster()`. * @param {String} name * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example <caption>include:samples/generated/v1/edge_container.upgrade_cluster.js</caption> * region_tag:edgecontainer_v1_generated_EdgeContainer_UpgradeCluster_async */ checkUpgradeClusterProgress(name: string): Promise<LROperation<protos.google.cloud.edgecontainer.v1.Cluster, protos.google.cloud.edgecontainer.v1.OperationMetadata>>; /** * Deletes a single Cluster. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The resource name of the cluster. * @param {string} request.requestId * A unique identifier for this request. Restricted to 36 ASCII characters. A * random UUID is recommended. This request is only idempotent if * `request_id` is provided. * @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. Its `promise()` method returns a promise * you can `await` for. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example <caption>include:samples/generated/v1/edge_container.delete_cluster.js</caption> * region_tag:edgecontainer_v1_generated_EdgeContainer_DeleteCluster_async */ deleteCluster(request?: protos.google.cloud.edgecontainer.v1.IDeleteClusterRequest, options?: CallOptions): Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; deleteCluster(request: protos.google.cloud.edgecontainer.v1.IDeleteClusterRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; deleteCluster(request: protos.google.cloud.edgecontainer.v1.IDeleteClusterRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `deleteCluster()`. * @param {String} name * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example <caption>include:samples/generated/v1/edge_container.delete_cluster.js</caption> * region_tag:edgecontainer_v1_generated_EdgeContainer_DeleteCluster_async */ checkDeleteClusterProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.edgecontainer.v1.OperationMetadata>>; /** * Creates a new NodePool in a given project and location. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent cluster where this node pool will be created. * @param {string} request.nodePoolId * Required. A client-specified unique identifier for the node pool. * @param {google.cloud.edgecontainer.v1.NodePool} request.nodePool * Required. The node pool to create. * @param {string} request.requestId * A unique identifier for this request. Restricted to 36 ASCII characters. A * random UUID is recommended. This request is only idempotent if * `request_id` is provided. * @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. Its `promise()` method returns a promise * you can `await` for. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example <caption>include:samples/generated/v1/edge_container.create_node_pool.js</caption> * region_tag:edgecontainer_v1_generated_EdgeContainer_CreateNodePool_async */ createNodePool(request?: protos.google.cloud.edgecontainer.v1.ICreateNodePoolRequest, options?: CallOptions): Promise<[ LROperation<protos.google.cloud.edgecontainer.v1.INodePool, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; createNodePool(request: protos.google.cloud.edgecontainer.v1.ICreateNodePoolRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.edgecontainer.v1.INodePool, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; createNodePool(request: protos.google.cloud.edgecontainer.v1.ICreateNodePoolRequest, callback: Callback<LROperation<protos.google.cloud.edgecontainer.v1.INodePool, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `createNodePool()`. * @param {String} name * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example <caption>include:samples/generated/v1/edge_container.create_node_pool.js</caption> * region_tag:edgecontainer_v1_generated_EdgeContainer_CreateNodePool_async */ checkCreateNodePoolProgress(name: string): Promise<LROperation<protos.google.cloud.edgecontainer.v1.NodePool, protos.google.cloud.edgecontainer.v1.OperationMetadata>>; /** * Updates the parameters of a single NodePool. * * @param {Object} request * The request object that will be sent. * @param {google.protobuf.FieldMask} request.updateMask * Field mask is used to specify the fields to be overwritten in the * NodePool resource by the update. * The fields specified in the update_mask are relative to the resource, not * the full request. A field will be overwritten if it is in the mask. If the * user does not provide a mask then all fields will be overwritten. * @param {google.cloud.edgecontainer.v1.NodePool} request.nodePool * The updated node pool. * @param {string} request.requestId * A unique identifier for this request. Restricted to 36 ASCII characters. A * random UUID is recommended. This request is only idempotent if * `request_id` is provided. * @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. Its `promise()` method returns a promise * you can `await` for. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example <caption>include:samples/generated/v1/edge_container.update_node_pool.js</caption> * region_tag:edgecontainer_v1_generated_EdgeContainer_UpdateNodePool_async */ updateNodePool(request?: protos.google.cloud.edgecontainer.v1.IUpdateNodePoolRequest, options?: CallOptions): Promise<[ LROperation<protos.google.cloud.edgecontainer.v1.INodePool, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; updateNodePool(request: protos.google.cloud.edgecontainer.v1.IUpdateNodePoolRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.edgecontainer.v1.INodePool, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; updateNodePool(request: protos.google.cloud.edgecontainer.v1.IUpdateNodePoolRequest, callback: Callback<LROperation<protos.google.cloud.edgecontainer.v1.INodePool, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `updateNodePool()`. * @param {String} name * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example <caption>include:samples/generated/v1/edge_container.update_node_pool.js</caption> * region_tag:edgecontainer_v1_generated_EdgeContainer_UpdateNodePool_async */ checkUpdateNodePoolProgress(name: string): Promise<LROperation<protos.google.cloud.edgecontainer.v1.NodePool, protos.google.cloud.edgecontainer.v1.OperationMetadata>>; /** * Deletes a single NodePool. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The resource name of the node pool. * @param {string} request.requestId * A unique identifier for this request. Restricted to 36 ASCII characters. A * random UUID is recommended. This request is only idempotent if * `request_id` is provided. * @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. Its `promise()` method returns a promise * you can `await` for. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example <caption>include:samples/generated/v1/edge_container.delete_node_pool.js</caption> * region_tag:edgecontainer_v1_generated_EdgeContainer_DeleteNodePool_async */ deleteNodePool(request?: protos.google.cloud.edgecontainer.v1.IDeleteNodePoolRequest, options?: CallOptions): Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; deleteNodePool(request: protos.google.cloud.edgecontainer.v1.IDeleteNodePoolRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; deleteNodePool(request: protos.google.cloud.edgecontainer.v1.IDeleteNodePoolRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `deleteNodePool()`. * @param {String} name * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example <caption>include:samples/generated/v1/edge_container.delete_node_pool.js</caption> * region_tag:edgecontainer_v1_generated_EdgeContainer_DeleteNodePool_async */ checkDeleteNodePoolProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.edgecontainer.v1.OperationMetadata>>; /** * Creates a new VPN connection in a given project and location. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent location where this vpn connection will be created. * @param {string} request.vpnConnectionId * Required. The VPN connection identifier. * @param {google.cloud.edgecontainer.v1.VpnConnection} request.vpnConnection * Required. The VPN connection to create. * @param {string} request.requestId * A unique identifier for this request. Restricted to 36 ASCII characters. A * random UUID is recommended. This request is only idempotent if * `request_id` is provided. * @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. Its `promise()` method returns a promise * you can `await` for. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example <caption>include:samples/generated/v1/edge_container.create_vpn_connection.js</caption> * region_tag:edgecontainer_v1_generated_EdgeContainer_CreateVpnConnection_async */ createVpnConnection(request?: protos.google.cloud.edgecontainer.v1.ICreateVpnConnectionRequest, options?: CallOptions): Promise<[ LROperation<protos.google.cloud.edgecontainer.v1.IVpnConnection, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; createVpnConnection(request: protos.google.cloud.edgecontainer.v1.ICreateVpnConnectionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.edgecontainer.v1.IVpnConnection, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; createVpnConnection(request: protos.google.cloud.edgecontainer.v1.ICreateVpnConnectionRequest, callback: Callback<LROperation<protos.google.cloud.edgecontainer.v1.IVpnConnection, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `createVpnConnection()`. * @param {String} name * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example <caption>include:samples/generated/v1/edge_container.create_vpn_connection.js</caption> * region_tag:edgecontainer_v1_generated_EdgeContainer_CreateVpnConnection_async */ checkCreateVpnConnectionProgress(name: string): Promise<LROperation<protos.google.cloud.edgecontainer.v1.VpnConnection, protos.google.cloud.edgecontainer.v1.OperationMetadata>>; /** * Deletes a single VPN connection. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The resource name of the vpn connection. * @param {string} request.requestId * A unique identifier for this request. Restricted to 36 ASCII characters. A * random UUID is recommended. This request is only idempotent if * `request_id` is provided. * @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. Its `promise()` method returns a promise * you can `await` for. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example <caption>include:samples/generated/v1/edge_container.delete_vpn_connection.js</caption> * region_tag:edgecontainer_v1_generated_EdgeContainer_DeleteVpnConnection_async */ deleteVpnConnection(request?: protos.google.cloud.edgecontainer.v1.IDeleteVpnConnectionRequest, options?: CallOptions): Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; deleteVpnConnection(request: protos.google.cloud.edgecontainer.v1.IDeleteVpnConnectionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; deleteVpnConnection(request: protos.google.cloud.edgecontainer.v1.IDeleteVpnConnectionRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.edgecontainer.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `deleteVpnConnection()`. * @param {String} name * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example <caption>include:samples/generated/v1/edge_container.delete_vpn_connection.js</caption> * region_tag:edgecontainer_v1_generated_EdgeContainer_DeleteVpnConnection_async */ checkDeleteVpnConnectionProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.edgecontainer.v1.OperationMetadata>>; /** * Lists Clusters in a given project and location. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent location, which owns this collection of clusters. * @param {number} request.pageSize * The maximum number of resources to list. * @param {string} request.pageToken * A page token received from previous list request. * A page token received from previous list request. * @param {string} request.filter * Only resources matching this filter will be listed. * @param {string} request.orderBy * Specifies the order in which resources will be listed. * @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 Array of {@link protos.google.cloud.edgecontainer.v1.Cluster|Cluster}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listClustersAsync()` * method described below for async iteration which you can stop as needed. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ list