@google-cloud/memorystore
Version:
Memorystore API client for Node.js
729 lines • 83.6 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 v1
*/
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.v1.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/v1/memorystore.get_instance.js</caption>
* region_tag:memorystore_v1_generated_Memorystore_GetInstance_async
*/
getInstance(request?: protos.google.cloud.memorystore.v1.IGetInstanceRequest, options?: CallOptions): Promise<[
protos.google.cloud.memorystore.v1.IInstance,
protos.google.cloud.memorystore.v1.IGetInstanceRequest | undefined,
{} | undefined
]>;
getInstance(request: protos.google.cloud.memorystore.v1.IGetInstanceRequest, options: CallOptions, callback: Callback<protos.google.cloud.memorystore.v1.IInstance, protos.google.cloud.memorystore.v1.IGetInstanceRequest | null | undefined, {} | null | undefined>): void;
getInstance(request: protos.google.cloud.memorystore.v1.IGetInstanceRequest, callback: Callback<protos.google.cloud.memorystore.v1.IInstance, protos.google.cloud.memorystore.v1.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.v1.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/v1/memorystore.get_certificate_authority.js</caption>
* region_tag:memorystore_v1_generated_Memorystore_GetCertificateAuthority_async
*/
getCertificateAuthority(request?: protos.google.cloud.memorystore.v1.IGetCertificateAuthorityRequest, options?: CallOptions): Promise<[
protos.google.cloud.memorystore.v1.ICertificateAuthority,
protos.google.cloud.memorystore.v1.IGetCertificateAuthorityRequest | undefined,
{} | undefined
]>;
getCertificateAuthority(request: protos.google.cloud.memorystore.v1.IGetCertificateAuthorityRequest, options: CallOptions, callback: Callback<protos.google.cloud.memorystore.v1.ICertificateAuthority, protos.google.cloud.memorystore.v1.IGetCertificateAuthorityRequest | null | undefined, {} | null | undefined>): void;
getCertificateAuthority(request: protos.google.cloud.memorystore.v1.IGetCertificateAuthorityRequest, callback: Callback<protos.google.cloud.memorystore.v1.ICertificateAuthority, protos.google.cloud.memorystore.v1.IGetCertificateAuthorityRequest | null | undefined, {} | null | undefined>): void;
/**
* Get a backup collection.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. Instance backupCollection resource name using the form:
* `projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}`
* where `location_id` refers to a Google Cloud region.
* @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.v1.BackupCollection|BackupCollection}.
* 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/memorystore.get_backup_collection.js</caption>
* region_tag:memorystore_v1_generated_Memorystore_GetBackupCollection_async
*/
getBackupCollection(request?: protos.google.cloud.memorystore.v1.IGetBackupCollectionRequest, options?: CallOptions): Promise<[
protos.google.cloud.memorystore.v1.IBackupCollection,
protos.google.cloud.memorystore.v1.IGetBackupCollectionRequest | undefined,
{} | undefined
]>;
getBackupCollection(request: protos.google.cloud.memorystore.v1.IGetBackupCollectionRequest, options: CallOptions, callback: Callback<protos.google.cloud.memorystore.v1.IBackupCollection, protos.google.cloud.memorystore.v1.IGetBackupCollectionRequest | null | undefined, {} | null | undefined>): void;
getBackupCollection(request: protos.google.cloud.memorystore.v1.IGetBackupCollectionRequest, callback: Callback<protos.google.cloud.memorystore.v1.IBackupCollection, protos.google.cloud.memorystore.v1.IGetBackupCollectionRequest | null | undefined, {} | null | undefined>): void;
/**
* Gets the details of a specific backup.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. Instance backup resource name using the form:
* `projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}/backups/{backup_id}`
* @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.v1.Backup|Backup}.
* 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/memorystore.get_backup.js</caption>
* region_tag:memorystore_v1_generated_Memorystore_GetBackup_async
*/
getBackup(request?: protos.google.cloud.memorystore.v1.IGetBackupRequest, options?: CallOptions): Promise<[
protos.google.cloud.memorystore.v1.IBackup,
protos.google.cloud.memorystore.v1.IGetBackupRequest | undefined,
{} | undefined
]>;
getBackup(request: protos.google.cloud.memorystore.v1.IGetBackupRequest, options: CallOptions, callback: Callback<protos.google.cloud.memorystore.v1.IBackup, protos.google.cloud.memorystore.v1.IGetBackupRequest | null | undefined, {} | null | undefined>): void;
getBackup(request: protos.google.cloud.memorystore.v1.IGetBackupRequest, callback: Callback<protos.google.cloud.memorystore.v1.IBackup, protos.google.cloud.memorystore.v1.IGetBackupRequest | 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.v1.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/v1/memorystore.create_instance.js</caption>
* region_tag:memorystore_v1_generated_Memorystore_CreateInstance_async
*/
createInstance(request?: protos.google.cloud.memorystore.v1.ICreateInstanceRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.memorystore.v1.IInstance, protos.google.cloud.memorystore.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
createInstance(request: protos.google.cloud.memorystore.v1.ICreateInstanceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.memorystore.v1.IInstance, protos.google.cloud.memorystore.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
createInstance(request: protos.google.cloud.memorystore.v1.ICreateInstanceRequest, callback: Callback<LROperation<protos.google.cloud.memorystore.v1.IInstance, protos.google.cloud.memorystore.v1.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/v1/memorystore.create_instance.js</caption>
* region_tag:memorystore_v1_generated_Memorystore_CreateInstance_async
*/
checkCreateInstanceProgress(name: string): Promise<LROperation<protos.google.cloud.memorystore.v1.Instance, protos.google.cloud.memorystore.v1.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.v1.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/v1/memorystore.update_instance.js</caption>
* region_tag:memorystore_v1_generated_Memorystore_UpdateInstance_async
*/
updateInstance(request?: protos.google.cloud.memorystore.v1.IUpdateInstanceRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.memorystore.v1.IInstance, protos.google.cloud.memorystore.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
updateInstance(request: protos.google.cloud.memorystore.v1.IUpdateInstanceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.memorystore.v1.IInstance, protos.google.cloud.memorystore.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
updateInstance(request: protos.google.cloud.memorystore.v1.IUpdateInstanceRequest, callback: Callback<LROperation<protos.google.cloud.memorystore.v1.IInstance, protos.google.cloud.memorystore.v1.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/v1/memorystore.update_instance.js</caption>
* region_tag:memorystore_v1_generated_Memorystore_UpdateInstance_async
*/
checkUpdateInstanceProgress(name: string): Promise<LROperation<protos.google.cloud.memorystore.v1.Instance, protos.google.cloud.memorystore.v1.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/v1/memorystore.delete_instance.js</caption>
* region_tag:memorystore_v1_generated_Memorystore_DeleteInstance_async
*/
deleteInstance(request?: protos.google.cloud.memorystore.v1.IDeleteInstanceRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.memorystore.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
deleteInstance(request: protos.google.cloud.memorystore.v1.IDeleteInstanceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.memorystore.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
deleteInstance(request: protos.google.cloud.memorystore.v1.IDeleteInstanceRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.memorystore.v1.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/v1/memorystore.delete_instance.js</caption>
* region_tag:memorystore_v1_generated_Memorystore_DeleteInstance_async
*/
checkDeleteInstanceProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.memorystore.v1.OperationMetadata>>;
/**
* Reschedules upcoming maintenance event.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. Name of the instance to reschedule maintenance for:
* `projects/{project}/locations/{location_id}/instances/{instance}`
* @param {google.cloud.memorystore.v1.RescheduleMaintenanceRequest.RescheduleType} request.rescheduleType
* Required. If reschedule type is SPECIFIC_TIME, schedule_time must be set.
* @param {google.protobuf.Timestamp} [request.scheduleTime]
* Optional. Timestamp when the maintenance shall be rescheduled to if
* reschedule_type=SPECIFIC_TIME, in RFC 3339 format.
* Example: `2012-11-15T16:19:00.094Z`.
* @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/memorystore.reschedule_maintenance.js</caption>
* region_tag:memorystore_v1_generated_Memorystore_RescheduleMaintenance_async
*/
rescheduleMaintenance(request?: protos.google.cloud.memorystore.v1.IRescheduleMaintenanceRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.memorystore.v1.IInstance, protos.google.cloud.memorystore.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
rescheduleMaintenance(request: protos.google.cloud.memorystore.v1.IRescheduleMaintenanceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.memorystore.v1.IInstance, protos.google.cloud.memorystore.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
rescheduleMaintenance(request: protos.google.cloud.memorystore.v1.IRescheduleMaintenanceRequest, callback: Callback<LROperation<protos.google.cloud.memorystore.v1.IInstance, protos.google.cloud.memorystore.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
/**
* Check the status of the long running operation returned by `rescheduleMaintenance()`.
* @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/memorystore.reschedule_maintenance.js</caption>
* region_tag:memorystore_v1_generated_Memorystore_RescheduleMaintenance_async
*/
checkRescheduleMaintenanceProgress(name: string): Promise<LROperation<protos.google.cloud.memorystore.v1.Instance, protos.google.cloud.memorystore.v1.OperationMetadata>>;
/**
* Deletes a specific backup.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. Instance backup resource name using the form:
* `projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}/backups/{backup_id}`
* @param {string} [request.requestId]
* Optional. Idempotent request UUID.
* @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/memorystore.delete_backup.js</caption>
* region_tag:memorystore_v1_generated_Memorystore_DeleteBackup_async
*/
deleteBackup(request?: protos.google.cloud.memorystore.v1.IDeleteBackupRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.memorystore.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
deleteBackup(request: protos.google.cloud.memorystore.v1.IDeleteBackupRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.memorystore.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
deleteBackup(request: protos.google.cloud.memorystore.v1.IDeleteBackupRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.memorystore.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
/**
* Check the status of the long running operation returned by `deleteBackup()`.
* @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/memorystore.delete_backup.js</caption>
* region_tag:memorystore_v1_generated_Memorystore_DeleteBackup_async
*/
checkDeleteBackupProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.memorystore.v1.OperationMetadata>>;
/**
* Exports a specific backup to a customer target Cloud Storage URI.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.gcsBucket
* Google Cloud Storage bucket, like "my-bucket".
* @param {string} request.name
* Required. Instance backup resource name using the form:
* `projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}/backups/{backup_id}`
* @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/memorystore.export_backup.js</caption>
* region_tag:memorystore_v1_generated_Memorystore_ExportBackup_async
*/
exportBackup(request?: protos.google.cloud.memorystore.v1.IExportBackupRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.memorystore.v1.IBackup, protos.google.cloud.memorystore.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
exportBackup(request: protos.google.cloud.memorystore.v1.IExportBackupRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.memorystore.v1.IBackup, protos.google.cloud.memorystore.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
exportBackup(request: protos.google.cloud.memorystore.v1.IExportBackupRequest, callback: Callback<LROperation<protos.google.cloud.memorystore.v1.IBackup, protos.google.cloud.memorystore.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
/**
* Check the status of the long running operation returned by `exportBackup()`.
* @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/memorystore.export_backup.js</caption>
* region_tag:memorystore_v1_generated_Memorystore_ExportBackup_async
*/
checkExportBackupProgress(name: string): Promise<LROperation<protos.google.cloud.memorystore.v1.Backup, protos.google.cloud.memorystore.v1.OperationMetadata>>;
/**
* Backup Instance.
* If this is the first time a backup is being created, a backup collection
* will be created at the backend, and this backup belongs to this collection.
* Both collection and backup will have a resource name. Backup will be
* executed for each shard. A replica (primary if nonHA) will be selected to
* perform the execution. Backup call will be rejected if there is an ongoing
* backup or update operation. Be aware that during preview, if the instance's
* internal software version is too old, critical update will be performed
* before actual backup. Once the internal software version is updated to the
* minimum version required by the backup feature, subsequent backups will not
* require critical update. After preview, there will be no critical update
* needed for backup.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. Instance resource name using the form:
* `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
* where `location_id` refers to a Google Cloud region.
* @param {google.protobuf.Duration} [request.ttl]
* Optional. TTL for the backup to expire. Value range is 1 day to 100 years.
* If not specified, the default value is 100 years.
* @param {string} [request.backupId]
* Optional. The id of the backup to be created. If not specified, the
* default value ([YYYYMMDDHHMMSS]_[Shortened Instance UID] is used.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing
* 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/memorystore.backup_instance.js</caption>
* region_tag:memorystore_v1_generated_Memorystore_BackupInstance_async
*/
backupInstance(request?: protos.google.cloud.memorystore.v1.IBackupInstanceRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.memorystore.v1.IInstance, protos.google.cloud.memorystore.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
backupInstance(request: protos.google.cloud.memorystore.v1.IBackupInstanceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.memorystore.v1.IInstance, protos.google.cloud.memorystore.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
backupInstance(request: protos.google.cloud.memorystore.v1.IBackupInstanceRequest, callback: Callback<LROperation<protos.google.cloud.memorystore.v1.IInstance, protos.google.cloud.memorystore.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
/**
* Check the status of the long running operation returned by `backupInstance()`.
* @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/memorystore.backup_instance.js</caption>
* region_tag:memorystore_v1_generated_Memorystore_BackupInstance_async
*/
checkBackupInstanceProgress(name: string): Promise<LROperation<protos.google.cloud.memorystore.v1.Instance, protos.google.cloud.memorystore.v1.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.v1.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.v1.IListInstancesRequest, options?: CallOptions): Promise<[
protos.google.cloud.memorystore.v1.IInstance[],
protos.google.cloud.memorystore.v1.IListInstancesRequest | null,
protos.google.cloud.memorystore.v1.IListInstancesResponse
]>;
listInstances(request: protos.google.cloud.memorystore.v1.IListInstancesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.memorystore.v1.IListInstancesRequest, protos.google.cloud.memorystore.v1.IListInstancesResponse | null | undefined, protos.google.cloud.memorystore.v1.IInstance>): void;
listInstances(request: protos.google.cloud.memorystore.v1.IListInstancesRequest, callback: PaginationCallback<protos.google.cloud.memorystore.v1.IListInstancesRequest, protos.google.cloud.memorystore.v1.IListInstancesResponse | null | undefined, protos.google.cloud.memorystore.v1.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.v1.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.v1.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.v1.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/v1/memorystore.list_instances.js</caption>
* region_tag:memorystore_v1_generated_Memorystore_ListInstances_async
*/
listInstancesAsync(request?: protos.google.cloud.memorystore.v1.IListInstancesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.memorystore.v1.IInstance>;
/**
* Lists all backup collections owned by a consumer project in either the
* specified location (region) or all locations.
*
* If `location_id` is specified as `-` (wildcard), then all regions
* available to the project are queried, and the results are aggregated.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The resource name of the backupCollection location using the
* form:
* `projects/{project_id}/locations/{location_id}`
* where `location_id` refers to a Google Cloud region.
* @param {number} [request.pageSize]
* Optional. The maximum number of items to return.
*
* If not specified, a default value of 1000 will be used by the service.
* Regardless of the page_size value, the response may include a partial list
* and a caller should only rely on response's
* {@link protos.google.cloud.memorystore.v1.ListBackupCollectionsResponse.next_page_token|`next_page_token`}
* to determine if there are more clusters left to be queried.
* @param {string} [request.pageToken]
* Optional. The `next_page_token` value returned from a previous
* [ListBackupCollections] request, if any.
* @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.v1.BackupCollection|BackupCollection}.
* 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 `listBackupCollectionsAsync()`
* 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.
*/
listBackupCollections(request?: protos.google.cloud.memorystore.v1.IListBackupCollectionsRequest, options?: CallOptions): Promise<[
protos.google.cloud.memorystore.v1.IBackupCollection[],
protos.google.cloud.memorystore.v1.IListBackupCollectionsRequest | null,
protos.google.cloud.memorystore.v1.IListBackupCollectionsResponse
]>;
listBackupCollections(request: protos.google.cloud.memorystore.v1.IListBackupCollectionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.memorystore.v1.IListBackupCollectionsRequest, protos.google.cloud.memorystore.v1.IListBackupCollectionsResponse | null | undefined, protos.google.cloud.memorystore.v1.IBackupCollection>): void;
listBackupCollections(request: protos.google.cloud.memorystore.v1.IListBackupCollectionsRequest, callback: PaginationCallback<protos.google.cloud.memorystore.v1.IListBackupCollectionsRequest, protos.google.cloud.memorystore.v1.IListBackupCollectionsResponse | null | undefined, protos.google.cloud.memorystore.v1.IBackupCollection>): void;
/**
* Equivalent to `listBackupCollections`, but returns a NodeJS Stream object.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The resource name of the backupCollection location using the
* form:
* `projects/{project_id}/locations/{location_id}`
* where `location_id` refers to a Google Cloud region.
* @param {number} [request.pageSize]
* Optional. The maximum number of items to return.
*
* If not specified, a default value of 1000 will be used by the service.
* Regardless of the page_size value, the response may include a partial list
* and a caller should only rely on response's
* {@link protos.google.cloud.memorystore.v1.ListBackupCollectionsResponse.next_page_token|`next_page_token`}
* to determine if there are more clusters left to be queried.
* @param {string} [request.pageToken]
* Optional. T