@google-cloud/memorystore
Version:
Memorystore API client for Node.js
812 lines (811 loc) • 46.9 kB
TypeScript
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';
/**
* Service describing handlers for resources
* @class
* @memberof v1beta
*/
export declare class MemorystoreClient {
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;
memorystoreStub?: Promise<{
[name: string]: Function;
}>;
/**
* Construct an instance of MemorystoreClient.
*
* @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 MemorystoreClient({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 Instance.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The name of the instance to retrieve.
* Format: projects/{project}/locations/{location}/instances/{instance}
* @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.memorystore.v1beta.Instance|Instance}.
* 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/memorystore.get_instance.js</caption>
* region_tag:memorystore_v1beta_generated_Memorystore_GetInstance_async
*/
getInstance(request?: protos.google.cloud.memorystore.v1beta.IGetInstanceRequest, options?: CallOptions): Promise<[
protos.google.cloud.memorystore.v1beta.IInstance,
protos.google.cloud.memorystore.v1beta.IGetInstanceRequest | undefined,
{} | undefined
]>;
getInstance(request: protos.google.cloud.memorystore.v1beta.IGetInstanceRequest, options: CallOptions, callback: Callback<protos.google.cloud.memorystore.v1beta.IInstance, protos.google.cloud.memorystore.v1beta.IGetInstanceRequest | null | undefined, {} | null | undefined>): void;
getInstance(request: protos.google.cloud.memorystore.v1beta.IGetInstanceRequest, callback: Callback<protos.google.cloud.memorystore.v1beta.IInstance, protos.google.cloud.memorystore.v1beta.IGetInstanceRequest | null | undefined, {} | null | undefined>): void;
/**
* Gets details about the certificate authority for an Instance.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The name of the certificate authority.
* Format:
* projects/{project}/locations/{location}/instances/{instance}/certificateAuthority
* @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.memorystore.v1beta.CertificateAuthority|CertificateAuthority}.
* 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/memorystore.get_certificate_authority.js</caption>
* region_tag:memorystore_v1beta_generated_Memorystore_GetCertificateAuthority_async
*/
getCertificateAuthority(request?: protos.google.cloud.memorystore.v1beta.IGetCertificateAuthorityRequest, options?: CallOptions): Promise<[
protos.google.cloud.memorystore.v1beta.ICertificateAuthority,
protos.google.cloud.memorystore.v1beta.IGetCertificateAuthorityRequest | undefined,
{} | undefined
]>;
getCertificateAuthority(request: protos.google.cloud.memorystore.v1beta.IGetCertificateAuthorityRequest, options: CallOptions, callback: Callback<protos.google.cloud.memorystore.v1beta.ICertificateAuthority, protos.google.cloud.memorystore.v1beta.IGetCertificateAuthorityRequest | null | undefined, {} | null | undefined>): void;
getCertificateAuthority(request: protos.google.cloud.memorystore.v1beta.IGetCertificateAuthorityRequest, callback: Callback<protos.google.cloud.memorystore.v1beta.ICertificateAuthority, protos.google.cloud.memorystore.v1beta.IGetCertificateAuthorityRequest | null | undefined, {} | null | undefined>): void;
/**
* Creates a new Instance in a given project and location.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The parent resource where this instance will be created.
* Format: projects/{project}/locations/{location}
* @param {string} request.instanceId
* Required. The ID to use for the instance, which will become the final
* component of the instance's resource name.
*
* This value is subject to the following restrictions:
*
* * Must be 4-63 characters in length
* * Must begin with a letter or digit
* * Must contain only lowercase letters, digits, and hyphens
* * Must not end with a hyphen
* * Must be unique within a location
* @param {google.cloud.memorystore.v1beta.Instance} request.instance
* Required. The instance to create.
* @param {string} [request.requestId]
* Optional. 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. The server will
* guarantee that for at least 60 minutes since the first request.
*
* 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 {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/v1beta/memorystore.create_instance.js</caption>
* region_tag:memorystore_v1beta_generated_Memorystore_CreateInstance_async
*/
createInstance(request?: protos.google.cloud.memorystore.v1beta.ICreateInstanceRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.memorystore.v1beta.IInstance, protos.google.cloud.memorystore.v1beta.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
createInstance(request: protos.google.cloud.memorystore.v1beta.ICreateInstanceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.memorystore.v1beta.IInstance, protos.google.cloud.memorystore.v1beta.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
createInstance(request: protos.google.cloud.memorystore.v1beta.ICreateInstanceRequest, callback: Callback<LROperation<protos.google.cloud.memorystore.v1beta.IInstance, protos.google.cloud.memorystore.v1beta.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
/**
* Check the status of the long running operation returned by `createInstance()`.
* @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/v1beta/memorystore.create_instance.js</caption>
* region_tag:memorystore_v1beta_generated_Memorystore_CreateInstance_async
*/
checkCreateInstanceProgress(name: string): Promise<LROperation<protos.google.cloud.memorystore.v1beta.Instance, protos.google.cloud.memorystore.v1beta.OperationMetadata>>;
/**
* Updates the parameters of a single Instance.
*
* @param {Object} request
* The request object that will be sent.
* @param {google.protobuf.FieldMask} [request.updateMask]
* Optional. The list of fields to be updated on the instance. At least one
* field must be specified.
* @param {google.cloud.memorystore.v1beta.Instance} request.instance
* Required. The instance to update.
* @param {string} [request.requestId]
* Optional. 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. The server will
* guarantee that for at least 60 minutes since the first request.
*
* 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 {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/v1beta/memorystore.update_instance.js</caption>
* region_tag:memorystore_v1beta_generated_Memorystore_UpdateInstance_async
*/
updateInstance(request?: protos.google.cloud.memorystore.v1beta.IUpdateInstanceRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.memorystore.v1beta.IInstance, protos.google.cloud.memorystore.v1beta.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
updateInstance(request: protos.google.cloud.memorystore.v1beta.IUpdateInstanceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.memorystore.v1beta.IInstance, protos.google.cloud.memorystore.v1beta.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
updateInstance(request: protos.google.cloud.memorystore.v1beta.IUpdateInstanceRequest, callback: Callback<LROperation<protos.google.cloud.memorystore.v1beta.IInstance, protos.google.cloud.memorystore.v1beta.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
/**
* Check the status of the long running operation returned by `updateInstance()`.
* @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/v1beta/memorystore.update_instance.js</caption>
* region_tag:memorystore_v1beta_generated_Memorystore_UpdateInstance_async
*/
checkUpdateInstanceProgress(name: string): Promise<LROperation<protos.google.cloud.memorystore.v1beta.Instance, protos.google.cloud.memorystore.v1beta.OperationMetadata>>;
/**
* Deletes a single Instance.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The name of the instance to delete.
* Format: projects/{project}/locations/{location}/instances/{instance}
* @param {string} [request.requestId]
* Optional. 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. The server will
* guarantee that for at least 60 minutes after the first request.
*
* 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 {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/v1beta/memorystore.delete_instance.js</caption>
* region_tag:memorystore_v1beta_generated_Memorystore_DeleteInstance_async
*/
deleteInstance(request?: protos.google.cloud.memorystore.v1beta.IDeleteInstanceRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.memorystore.v1beta.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
deleteInstance(request: protos.google.cloud.memorystore.v1beta.IDeleteInstanceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.memorystore.v1beta.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
deleteInstance(request: protos.google.cloud.memorystore.v1beta.IDeleteInstanceRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.memorystore.v1beta.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
/**
* Check the status of the long running operation returned by `deleteInstance()`.
* @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/v1beta/memorystore.delete_instance.js</caption>
* region_tag:memorystore_v1beta_generated_Memorystore_DeleteInstance_async
*/
checkDeleteInstanceProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.memorystore.v1beta.OperationMetadata>>;
/**
* Lists Instances in a given project and location.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The parent to list instances from.
* Format: projects/{project}/locations/{location}
* @param {number} [request.pageSize]
* Optional. Requested page size. Server may return fewer items than
* requested. If unspecified, server will pick an appropriate default.
* @param {string} [request.pageToken]
* Optional. A token identifying a page of results the server should return.
* @param {string} [request.filter]
* Optional. Expression for filtering results.
* @param {string} [request.orderBy]
* Optional. Sort results by a defined order. Supported values: "name",
* "create_time".
* @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.memorystore.v1beta.Instance|Instance}.
* 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 `listInstancesAsync()`
* 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.
*/
listInstances(request?: protos.google.cloud.memorystore.v1beta.IListInstancesRequest, options?: CallOptions): Promise<[
protos.google.cloud.memorystore.v1beta.IInstance[],
protos.google.cloud.memorystore.v1beta.IListInstancesRequest | null,
protos.google.cloud.memorystore.v1beta.IListInstancesResponse
]>;
listInstances(request: protos.google.cloud.memorystore.v1beta.IListInstancesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.memorystore.v1beta.IListInstancesRequest, protos.google.cloud.memorystore.v1beta.IListInstancesResponse | null | undefined, protos.google.cloud.memorystore.v1beta.IInstance>): void;
listInstances(request: protos.google.cloud.memorystore.v1beta.IListInstancesRequest, callback: PaginationCallback<protos.google.cloud.memorystore.v1beta.IListInstancesRequest, protos.google.cloud.memorystore.v1beta.IListInstancesResponse | null | undefined, protos.google.cloud.memorystore.v1beta.IInstance>): void;
/**
* Equivalent to `listInstances`, but returns a NodeJS Stream object.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The parent to list instances from.
* Format: projects/{project}/locations/{location}
* @param {number} [request.pageSize]
* Optional. Requested page size. Server may return fewer items than
* requested. If unspecified, server will pick an appropriate default.
* @param {string} [request.pageToken]
* Optional. A token identifying a page of results the server should return.
* @param {string} [request.filter]
* Optional. Expression for filtering results.
* @param {string} [request.orderBy]
* Optional. Sort results by a defined order. Supported values: "name",
* "create_time".
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Stream}
* An object stream which emits an object representing {@link protos.google.cloud.memorystore.v1beta.Instance|Instance} on 'data' event.
* The client library will perform auto-pagination by default: it will call the API as many
* times as needed. Note that it can affect your quota.
* We recommend using `listInstancesAsync()`
* 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.
*/
listInstancesStream(request?: protos.google.cloud.memorystore.v1beta.IListInstancesRequest, options?: CallOptions): Transform;
/**
* Equivalent to `listInstances`, but returns an iterable object.
*
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The parent to list instances from.
* Format: projects/{project}/locations/{location}
* @param {number} [request.pageSize]
* Optional. Requested page size. Server may return fewer items than
* requested. If unspecified, server will pick an appropriate default.
* @param {string} [request.pageToken]
* Optional. A token identifying a page of results the server should return.
* @param {string} [request.filter]
* Optional. Expression for filtering results.
* @param {string} [request.orderBy]
* Optional. Sort results by a defined order. Supported values: "name",
* "create_time".
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Object}
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
* When you iterate the returned iterable, each element will be an object representing
* {@link protos.google.cloud.memorystore.v1beta.Instance|Instance}. The API will be called under the hood as needed, once per the page,
* so you can stop the iteration when you don't need more results.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1beta/memorystore.list_instances.js</caption>
* region_tag:memorystore_v1beta_generated_Memorystore_ListInstances_async
*/
listInstancesAsync(request?: protos.google.cloud.memorystore.v1beta.IListInstancesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.memorystore.v1beta.IInstance>;
/**
* Gets information about a location.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Resource name for the location.
* @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 google.cloud.location.Location | Location}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example
* ```
* const [response] = await client.getLocation(request);
* ```
*/
getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;
/**
* Lists information about the supported locations for this service. Returns an iterable object.
*
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* The resource that owns the locations collection, if applicable.
* @param {string} request.filter
* The standard list filter.
* @param {number} request.pageSize
* The standard list page size.
* @param {string} request.pageToken
* The standard list page token.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Object}
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
* When you iterate the returned iterable, each element will be an object representing
* {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
* so you can stop the iteration when you don't need more results.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
* for more details and examples.
* @example
* ```
* const iterable = client.listLocationsAsync(request);
* for await (const response of iterable) {
* // process response
* }
* ```
*/
listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
/**
* Gets the latest state of a long-running operation. Clients can use this
* method to poll the operation result at intervals as recommended by the API
* service.
*
* @param {Object} request - The request object that will be sent.
* @param {string} request.name - The name of the operation resource.
* @param {Object=} options
* Optional parameters. You can override the default settings for this call,
* e.g, timeout, retries, paginations, etc. See {@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
* for the details.
* @param {function(?Error, ?Object)=} callback
* The function which will be called with the result of the API call.
*
* The second parameter to the callback is an object representing
* {@link google.longrunning.Operation | google.longrunning.Operation}.
* @return {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing
* {@link google.longrunning.Operation | google.longrunning.Operation}.
* The promise has a method named "cancel" which cancels the ongoing API call.
*
* @example
* ```
* const client = longrunning.operationsClient();
* const name = '';
* const [response] = await client.getOperation({name});
* // doThingsWith(response)
* ```
*/
getOperation(request: protos.google.longrunning.GetOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;
/**
* Lists operations that match the specified filter in the request. If the
* server doesn't support this method, it returns `UNIMPLEMENTED`. Returns an iterable object.
*
* For-await-of syntax is used with the iterable to recursively get response element on-demand.
*
* @param {Object} request - The request object that will be sent.
* @param {string} request.name - The name of the operation collection.
* @param {string} request.filter - The standard list filter.
* @param {number=} request.pageSize -
* The maximum number of resources contained in the underlying API
* response. If page streaming is performed per-resource, this
* parameter does not affect the return value. If page streaming is
* performed per-page, this determines the maximum number of
* resources in a page.
* @param {Object=} options
* Optional parameters. You can override the default settings for this call,
* e.g, timeout, retries, paginations, etc. See {@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
* details.
* @returns {Object}
* An iterable Object that conforms to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | iteration protocols}.
*
* @example
* ```
* const client = longrunning.operationsClient();
* for await (const response of client.listOperationsAsync(request));
* // doThingsWith(response)
* ```
*/
listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.IOperation>;
/**
* Starts asynchronous cancellation on a long-running operation. The server
* makes a best effort to cancel the operation, but success is not
* guaranteed. If the server doesn't support this method, it returns
* `google.rpc.Code.UNIMPLEMENTED`. Clients can use
* {@link Operations.GetOperation} or
* other methods to check whether the cancellation succeeded or whether the
* operation completed despite cancellation. On successful cancellation,
* the operation is not deleted; instead, it becomes an operation with
* an {@link Operation.error} value with a {@link google.rpc.Status.code} of
* 1, corresponding to `Code.CANCELLED`.
*
* @param {Object} request - The request object that will be sent.
* @param {string} request.name - The name of the operation resource to be cancelled.
* @param {Object=} options
* Optional parameters. You can override the default settings for this call,
* e.g, timeout, retries, paginations, etc. See {@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
* details.
* @param {function(?Error)=} callback
* The function which will be called with the result of the API call.
* @return {Promise} - The promise which resolves when API call finishes.
* The promise has a method named "cancel" which cancels the ongoing API
* call.
*
* @example
* ```
* const client = longrunning.operationsClient();
* await client.cancelOperation({name: ''});
* ```
*/
cancelOperation(request: protos.google.longrunning.CancelOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;
/**
* Deletes a long-running operation. This method indicates that the client is
* no longer interested in the operation result. It does not cancel the
* operation. If the server doesn't support this method, it returns
* `google.rpc.Code.UNIMPLEMENTED`.
*
* @param {Object} request - The request object that will be sent.
* @param {string} request.name - The name of the operation resource to be deleted.
* @param {Object=} options
* Optional parameters. You can override the default settings for this call,
* e.g, timeout, retries, paginations, etc. See {@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
* for the details.
* @param {function(?Error)=} callback
* The function which will be called with the result of the API call.
* @return {Promise} - The promise which resolves when API call finishes.
* The promise has a method named "cancel" which cancels the ongoing API
* call.
*
* @example
* ```
* const client = longrunning.operationsClient();
* await client.deleteOperation({name: ''});
* ```
*/
deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;
/**
* Return a fully-qualified certificateAuthority resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} instance
* @returns {string} Resource name string.
*/
certificateAuthorityPath(project: string, location: string, instance: string): string;
/**
* Parse the project from CertificateAuthority resource.
*
* @param {string} certificateAuthorityName
* A fully-qualified path representing CertificateAuthority resource.
* @returns {string} A string representing the project.
*/
matchProjectFromCertificateAuthorityName(certificateAuthorityName: string): string | number;
/**
* Parse the location from CertificateAuthority resource.
*
* @param {string} certificateAuthorityName
* A fully-qualified path representing CertificateAuthority resource.
* @returns {string} A string representing the location.
*/
matchLocationFromCertificateAuthorityName(certificateAuthorityName: string): string | number;
/**
* Parse the instance from CertificateAuthority resource.
*
* @param {string} certificateAuthorityName
* A fully-qualified path representing CertificateAuthority resource.
* @returns {string} A string representing the instance.
*/
matchInstanceFromCertificateAuthorityName(certificateAuthorityName: string): string | number;
/**
* Return a fully-qualified forwardingRule resource name string.
*
* @param {string} project
* @param {string} region
* @param {string} forwarding_rule
* @returns {string} Resource name string.
*/
forwardingRulePath(project: string, region: string, forwardingRule: string): string;
/**
* Parse the project from ForwardingRule resource.
*
* @param {string} forwardingRuleName
* A fully-qualified path representing ForwardingRule resource.
* @returns {string} A string representing the project.
*/
matchProjectFromForwardingRuleName(forwardingRuleName: string): string | number;
/**
* Parse the region from ForwardingRule resource.
*
* @param {string} forwardingRuleName
* A fully-qualified path representing ForwardingRule resource.
* @returns {string} A string representing the region.
*/
matchRegionFromForwardingRuleName(forwardingRuleName: string): string | number;
/**
* Parse the forwarding_rule from ForwardingRule resource.
*
* @param {string} forwardingRuleName
* A fully-qualified path representing ForwardingRule resource.
* @returns {string} A string representing the forwarding_rule.
*/
matchForwardingRuleFromForwardingRuleName(forwardingRuleName: string): string | number;
/**
* Return a fully-qualified instance resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} instance
* @returns {string} Resource name string.
*/
instancePath(project: string, location: string, instance: string): string;
/**
* Parse the project from Instance resource.
*
* @param {string} instanceName
* A fully-qualified path representing Instance resource.
* @returns {string} A string representing the project.
*/
matchProjectFromInstanceName(instanceName: string): string | number;
/**
* Parse the location from Instance resource.
*
* @param {string} instanceName
* A fully-qualified path representing Instance resource.
* @returns {string} A string representing the location.
*/
matchLocationFromInstanceName(instanceName: string): string | number;
/**
* Parse the instance from Instance resource.
*
* @param {string} instanceName
* A fully-qualified path representing Instance resource.
* @returns {string} A string representing the instance.
*/
matchInstanceFromInstanceName(instanceName: string): string | number;
/**
* Return a fully-qualified location resource name string.
*
* @param {string} project
* @param {string} location
* @returns {string} Resource name string.
*/
locationPath(project: string, location: string): string;
/**
* Parse the project from Location resource.
*
* @param {string} locationName
* A fully-qualified path representing Location resource.
* @returns {string} A string representing the project.
*/
matchProjectFromLocationName(locationName: string): string | number;
/**
* Parse the location from Location resource.
*
* @param {string} locationName
* A fully-qualified path representing Location resource.
* @returns {string} A string representing the location.
*/
matchLocationFromLocationName(locationName: string): string | number;
/**
* Return a fully-qualified network resource name string.
*
* @param {string} project
* @param {string} network
* @returns {string} Resource name string.
*/
networkPath(project: string, network: string): string;
/**
* Parse the project from Network resource.
*
* @param {string} networkName
* A fully-qualified path representing Network resource.
* @returns {string} A string representing the project.
*/
matchProjectFromNetworkName(networkName: string): string | number;
/**
* Parse the network from Network resource.
*
* @param {string} networkName
* A fully-qualified path representing Network resource.
* @returns {string} A string representing the network.
*/
matchNetworkFromNetworkName(networkName: string): string | number;
/**
* Return a fully-qualified project resource name string.
*
* @param {string} project
* @returns {string} Resource name string.
*/
projectPath(project: string): string;
/**
* Parse the project from Project resource.
*
* @param {string} projectName
* A fully-qualified path representing Project resource.
* @returns {string} A string representing the project.
*/
matchProjectFromProjectName(projectName: string): string | number;
/**
* Return a fully-qualified serviceAttachment resource name string.
*
* @param {string} project
* @param {string} region
* @param {string} service_attachment
* @returns {string} Resource name string.
*/
serviceAttachmentPath(project: string, region: string, serviceAttachment: string): string;
/**
* Parse the project from ServiceAttachment resource.
*
* @param {string} serviceAttachmentName
* A fully-qualified path representing ServiceAttachment resource.
* @returns {string} A string representing the project.
*/
matchProjectFromServiceAttachmentName(serviceAttachmentName: string): string | number;
/**
* Parse the region from ServiceAttachment resource.
*
* @param {string} serviceAttachmentName
* A fully-qualified path representing ServiceAttachment resource.
* @returns {string} A string representing the region.
*/
matchRegionFromServiceAttachmentName(serviceAttachmentName: string): string | number;
/**
* Parse the service_attachment from ServiceAttachment resource.
*
* @param {string} serviceAttachmentName
* A fully-qualified path representing ServiceAttachment resource.
* @returns {string} A string representing the service_attachment.
*/
matchServiceAttachmentFromServiceAttachmentName(serviceAttachmentName: string): string | number;
/**
* 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>;
}