Class v1.CloudFilestoreManagerClient (1.0.1)

Configures and manages Cloud Filestore resources.

Cloud Filestore Manager v1.

The file.googleapis.com service implements the Cloud Filestore API and defines the following resource model for managing instances: * The service works with a collection of cloud projects, named: /projects/* * Each project has a collection of available locations, named: /locations/* * Each location has a collection of instances and backups, named: /instances/* and /backups/* respectively. * As such, Cloud Filestore instances are resources of the form: /projects/{project_number}/locations/{location_id}/instances/{instance_id} and backups are resources of the form: /projects/{project_number}/locations/{location_id}/backup/{backup_id}

Note that location_id must be a GCP zone for instances and but to a GCP region for backups; for example: * projects/12345/locations/us-central1-c/instances/my-filestore * projects/12345/locations/us-central1/backups/my-backup v1

Package

@google-cloud/filestore!

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of CloudFilestoreManagerClient.

Parameter
Name Description
opts ClientOptions

Properties

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

Property Value
Type Description
string

auth

auth: gax.GoogleAuth;
Property Value
Type Description
gax.GoogleAuth

cloudFilestoreManagerStub

cloudFilestoreManagerStub?: Promise<{
        [name: string]: Function;
    }>;
Property Value
Type Description
Promise<{ [name: string]: Function; }>

descriptors

descriptors: Descriptors;
Property Value
Type Description
Descriptors

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };
Property Value
Type Description
{ [name: string]: Function; }

operationsClient

operationsClient: gax.OperationsClient;
Property Value
Type Description
gax.OperationsClient

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };
Property Value
Type Description
{ [name: string]: gax.PathTemplate; }

port

static get port(): number;

The port for this API service.

Property Value
Type Description
number

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

Property Value
Type Description
string[]

servicePath

static get servicePath(): string;

The DNS address for this API service.

Property Value
Type Description
string

warn

warn: (code: string, message: string, warnType?: string) => void;
Property Value
Type Description
(code: string, message: string, warnType?: string) => void

Methods

backupPath(project, location, backup)

backupPath(project: string, location: string, backup: string): string;

Return a fully-qualified backup resource name string.

Parameters
Name Description
project string
location string
backup string
Returns
Type Description
string

{string} Resource name string.

checkCreateBackupProgress(name)

checkCreateBackupProgress(name: string): Promise<LROperation<protos.google.cloud.filestore.v1.Backup, protos.google.cloud.common.OperationMetadata>>;

Check the status of the long running operation returned by createBackup().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.filestore.v1.Backup, protos.google.cloud.common.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkCreateInstanceProgress(name)

checkCreateInstanceProgress(name: string): Promise<LROperation<protos.google.cloud.filestore.v1.Instance, protos.google.cloud.common.OperationMetadata>>;

Check the status of the long running operation returned by createInstance().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.filestore.v1.Instance, protos.google.cloud.common.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkDeleteBackupProgress(name)

checkDeleteBackupProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.common.OperationMetadata>>;

Check the status of the long running operation returned by deleteBackup().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.common.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkDeleteInstanceProgress(name)

checkDeleteInstanceProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.common.OperationMetadata>>;

Check the status of the long running operation returned by deleteInstance().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.common.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkRestoreInstanceProgress(name)

checkRestoreInstanceProgress(name: string): Promise<LROperation<protos.google.cloud.filestore.v1.Instance, protos.google.cloud.common.OperationMetadata>>;

Check the status of the long running operation returned by restoreInstance().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.filestore.v1.Instance, protos.google.cloud.common.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkUpdateBackupProgress(name)

checkUpdateBackupProgress(name: string): Promise<LROperation<protos.google.cloud.filestore.v1.Backup, protos.google.cloud.common.OperationMetadata>>;

Check the status of the long running operation returned by updateBackup().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.filestore.v1.Backup, protos.google.cloud.common.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkUpdateInstanceProgress(name)

checkUpdateInstanceProgress(name: string): Promise<LROperation<protos.google.cloud.filestore.v1.Instance, protos.google.cloud.common.OperationMetadata>>;

Check the status of the long running operation returned by updateInstance().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.filestore.v1.Instance, protos.google.cloud.common.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns
Type Description
Promise<void>

{Promise} A promise that resolves when the client is closed.

createBackup(request, options)

createBackup(request?: protos.google.cloud.filestore.v1.ICreateBackupRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.filestore.v1.IBackup, protos.google.cloud.common.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.cloud.filestore.v1.ICreateBackupRequest
options CallOptions
Returns
Type Description
Promise<[ LROperation<protos.google.cloud.filestore.v1.IBackup, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

createBackup(request, options, callback)

createBackup(request: protos.google.cloud.filestore.v1.ICreateBackupRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.filestore.v1.IBackup, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.filestore.v1.ICreateBackupRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.filestore.v1.IBackup, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createBackup(request, callback)

createBackup(request: protos.google.cloud.filestore.v1.ICreateBackupRequest, callback: Callback<LROperation<protos.google.cloud.filestore.v1.IBackup, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.filestore.v1.ICreateBackupRequest
callback Callback<LROperation<protos.google.cloud.filestore.v1.IBackup, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createInstance(request, options)

createInstance(request?: protos.google.cloud.filestore.v1.ICreateInstanceRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.filestore.v1.IInstance, protos.google.cloud.common.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.cloud.filestore.v1.ICreateInstanceRequest
options CallOptions
Returns
Type Description
Promise<[ LROperation<protos.google.cloud.filestore.v1.IInstance, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

createInstance(request, options, callback)

createInstance(request: protos.google.cloud.filestore.v1.ICreateInstanceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.filestore.v1.IInstance, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.filestore.v1.ICreateInstanceRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.filestore.v1.IInstance, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createInstance(request, callback)

createInstance(request: protos.google.cloud.filestore.v1.ICreateInstanceRequest, callback: Callback<LROperation<protos.google.cloud.filestore.v1.IInstance, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.filestore.v1.ICreateInstanceRequest
callback Callback<LROperation<protos.google.cloud.filestore.v1.IInstance, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteBackup(request, options)

deleteBackup(request?: protos.google.cloud.filestore.v1.IDeleteBackupRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.common.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.cloud.filestore.v1.IDeleteBackupRequest
options CallOptions
Returns
Type Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

deleteBackup(request, options, callback)

deleteBackup(request: protos.google.cloud.filestore.v1.IDeleteBackupRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.filestore.v1.IDeleteBackupRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteBackup(request, callback)

deleteBackup(request: protos.google.cloud.filestore.v1.IDeleteBackupRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.filestore.v1.IDeleteBackupRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteInstance(request, options)

deleteInstance(request?: protos.google.cloud.filestore.v1.IDeleteInstanceRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.common.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.cloud.filestore.v1.IDeleteInstanceRequest
options CallOptions
Returns
Type Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

deleteInstance(request, options, callback)

deleteInstance(request: protos.google.cloud.filestore.v1.IDeleteInstanceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.filestore.v1.IDeleteInstanceRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteInstance(request, callback)

deleteInstance(request: protos.google.cloud.filestore.v1.IDeleteInstanceRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.filestore.v1.IDeleteInstanceRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

getBackup(request, options)

getBackup(request?: protos.google.cloud.filestore.v1.IGetBackupRequest, options?: CallOptions): Promise<[
        protos.google.cloud.filestore.v1.IBackup,
        protos.google.cloud.filestore.v1.IGetBackupRequest | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.cloud.filestore.v1.IGetBackupRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.filestore.v1.IBackup, protos.google.cloud.filestore.v1.IGetBackupRequest | undefined, {} | undefined ]>

getBackup(request, options, callback)

getBackup(request: protos.google.cloud.filestore.v1.IGetBackupRequest, options: CallOptions, callback: Callback<protos.google.cloud.filestore.v1.IBackup, protos.google.cloud.filestore.v1.IGetBackupRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.filestore.v1.IGetBackupRequest
options CallOptions
callback Callback<protos.google.cloud.filestore.v1.IBackup, protos.google.cloud.filestore.v1.IGetBackupRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getBackup(request, callback)

getBackup(request: protos.google.cloud.filestore.v1.IGetBackupRequest, callback: Callback<protos.google.cloud.filestore.v1.IBackup, protos.google.cloud.filestore.v1.IGetBackupRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.filestore.v1.IGetBackupRequest
callback Callback<protos.google.cloud.filestore.v1.IBackup, protos.google.cloud.filestore.v1.IGetBackupRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getInstance(request, options)

getInstance(request?: protos.google.cloud.filestore.v1.IGetInstanceRequest, options?: CallOptions): Promise<[
        protos.google.cloud.filestore.v1.IInstance,
        protos.google.cloud.filestore.v1.IGetInstanceRequest | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.cloud.filestore.v1.IGetInstanceRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.filestore.v1.IInstance, protos.google.cloud.filestore.v1.IGetInstanceRequest | undefined, {} | undefined ]>

getInstance(request, options, callback)

getInstance(request: protos.google.cloud.filestore.v1.IGetInstanceRequest, options: CallOptions, callback: Callback<protos.google.cloud.filestore.v1.IInstance, protos.google.cloud.filestore.v1.IGetInstanceRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.filestore.v1.IGetInstanceRequest
options CallOptions
callback Callback<protos.google.cloud.filestore.v1.IInstance, protos.google.cloud.filestore.v1.IGetInstanceRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getInstance(request, callback)

getInstance(request: protos.google.cloud.filestore.v1.IGetInstanceRequest, callback: Callback<protos.google.cloud.filestore.v1.IInstance, protos.google.cloud.filestore.v1.IGetInstanceRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.filestore.v1.IGetInstanceRequest
callback Callback<protos.google.cloud.filestore.v1.IInstance, protos.google.cloud.filestore.v1.IGetInstanceRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getProjectId()

getProjectId(): Promise<string>;
Returns
Type Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
Name Description
callback Callback<string, undefined, undefined>
Returns
Type Description
void

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

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
Type Description
Promise<{ [name: string]: Function; }>

{Promise} A promise that resolves to an authenticated service stub.

instancePath(project, location, instance)

instancePath(project: string, location: string, instance: string): string;

Return a fully-qualified instance resource name string.

Parameters
Name Description
project string
location string
instance string
Returns
Type Description
string

{string} Resource name string.

listBackups(request, options)

listBackups(request?: protos.google.cloud.filestore.v1.IListBackupsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.filestore.v1.IBackup[],
        protos.google.cloud.filestore.v1.IListBackupsRequest | null,
        protos.google.cloud.filestore.v1.IListBackupsResponse
    ]>;
Parameters
Name Description
request protos.google.cloud.filestore.v1.IListBackupsRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.filestore.v1.IBackup[], protos.google.cloud.filestore.v1.IListBackupsRequest | null, protos.google.cloud.filestore.v1.IListBackupsResponse ]>

listBackups(request, options, callback)

listBackups(request: protos.google.cloud.filestore.v1.IListBackupsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.filestore.v1.IListBackupsRequest, protos.google.cloud.filestore.v1.IListBackupsResponse | null | undefined, protos.google.cloud.filestore.v1.IBackup>): void;
Parameters
Name Description
request protos.google.cloud.filestore.v1.IListBackupsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.filestore.v1.IListBackupsRequest, protos.google.cloud.filestore.v1.IListBackupsResponse | null | undefined, protos.google.cloud.filestore.v1.IBackup>
Returns
Type Description
void

listBackups(request, callback)

listBackups(request: protos.google.cloud.filestore.v1.IListBackupsRequest, callback: PaginationCallback<protos.google.cloud.filestore.v1.IListBackupsRequest, protos.google.cloud.filestore.v1.IListBackupsResponse | null | undefined, protos.google.cloud.filestore.v1.IBackup>): void;
Parameters
Name Description
request protos.google.cloud.filestore.v1.IListBackupsRequest
callback PaginationCallback<protos.google.cloud.filestore.v1.IListBackupsRequest, protos.google.cloud.filestore.v1.IListBackupsResponse | null | undefined, protos.google.cloud.filestore.v1.IBackup>
Returns
Type Description
void

listBackupsAsync(request, options)

listBackupsAsync(request?: protos.google.cloud.filestore.v1.IListBackupsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.filestore.v1.IBackup>;

Equivalent to listBackups, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name Description
request protos.google.cloud.filestore.v1.IListBackupsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.filestore.v1.IBackup>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Backup]. 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 [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listBackupsStream(request, options)

listBackupsStream(request?: protos.google.cloud.filestore.v1.IListBackupsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name Description
request protos.google.cloud.filestore.v1.IListBackupsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{Stream} An object stream which emits an object representing [Backup] 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 listBackupsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listInstances(request, options)

listInstances(request?: protos.google.cloud.filestore.v1.IListInstancesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.filestore.v1.IInstance[],
        protos.google.cloud.filestore.v1.IListInstancesRequest | null,
        protos.google.cloud.filestore.v1.IListInstancesResponse
    ]>;
Parameters
Name Description
request protos.google.cloud.filestore.v1.IListInstancesRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.filestore.v1.IInstance[], protos.google.cloud.filestore.v1.IListInstancesRequest | null, protos.google.cloud.filestore.v1.IListInstancesResponse ]>

listInstances(request, options, callback)

listInstances(request: protos.google.cloud.filestore.v1.IListInstancesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.filestore.v1.IListInstancesRequest, protos.google.cloud.filestore.v1.IListInstancesResponse | null | undefined, protos.google.cloud.filestore.v1.IInstance>): void;
Parameters
Name Description
request protos.google.cloud.filestore.v1.IListInstancesRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.filestore.v1.IListInstancesRequest, protos.google.cloud.filestore.v1.IListInstancesResponse | null | undefined, protos.google.cloud.filestore.v1.IInstance>
Returns
Type Description
void

listInstances(request, callback)

listInstances(request: protos.google.cloud.filestore.v1.IListInstancesRequest, callback: PaginationCallback<protos.google.cloud.filestore.v1.IListInstancesRequest, protos.google.cloud.filestore.v1.IListInstancesResponse | null | undefined, protos.google.cloud.filestore.v1.IInstance>): void;
Parameters
Name Description
request protos.google.cloud.filestore.v1.IListInstancesRequest
callback PaginationCallback<protos.google.cloud.filestore.v1.IListInstancesRequest, protos.google.cloud.filestore.v1.IListInstancesResponse | null | undefined, protos.google.cloud.filestore.v1.IInstance>
Returns
Type Description
void

listInstancesAsync(request, options)

listInstancesAsync(request?: protos.google.cloud.filestore.v1.IListInstancesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.filestore.v1.IInstance>;

Equivalent to listInstances, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name Description
request protos.google.cloud.filestore.v1.IListInstancesRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.filestore.v1.IInstance>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [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 [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listInstancesStream(request, options)

listInstancesStream(request?: protos.google.cloud.filestore.v1.IListInstancesRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name Description
request protos.google.cloud.filestore.v1.IListInstancesRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{Stream} An object stream which emits an object representing [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 [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

locationPath(project, location)

locationPath(project: string, location: string): string;

Return a fully-qualified location resource name string.

Parameters
Name Description
project string
location string
Returns
Type Description
string

{string} Resource name string.

matchBackupFromBackupName(backupName)

matchBackupFromBackupName(backupName: string): string | number;

Parse the backup from Backup resource.

Parameter
Name Description
backupName string

A fully-qualified path representing Backup resource.
Returns
Type Description
string | number

{string} A string representing the backup.

matchInstanceFromInstanceName(instanceName)

matchInstanceFromInstanceName(instanceName: string): string | number;

Parse the instance from Instance resource.

Parameter
Name Description
instanceName string

A fully-qualified path representing Instance resource.
Returns
Type Description
string | number

{string} A string representing the instance.

matchLocationFromBackupName(backupName)

matchLocationFromBackupName(backupName: string): string | number;

Parse the location from Backup resource.

Parameter
Name Description
backupName string

A fully-qualified path representing Backup resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromInstanceName(instanceName)

matchLocationFromInstanceName(instanceName: string): string | number;

Parse the location from Instance resource.

Parameter
Name Description
instanceName string

A fully-qualified path representing Instance resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter
Name Description
locationName string

A fully-qualified path representing Location resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchProjectFromBackupName(backupName)

matchProjectFromBackupName(backupName: string): string | number;

Parse the project from Backup resource.

Parameter
Name Description
backupName string

A fully-qualified path representing Backup resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromInstanceName(instanceName)

matchProjectFromInstanceName(instanceName: string): string | number;

Parse the project from Instance resource.

Parameter
Name Description
instanceName string

A fully-qualified path representing Instance resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter
Name Description
locationName string

A fully-qualified path representing Location resource.
Returns
Type Description
string | number

{string} A string representing the project.

restoreInstance(request, options)

restoreInstance(request?: protos.google.cloud.filestore.v1.IRestoreInstanceRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.filestore.v1.IInstance, protos.google.cloud.common.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.cloud.filestore.v1.IRestoreInstanceRequest
options CallOptions
Returns
Type Description
Promise<[ LROperation<protos.google.cloud.filestore.v1.IInstance, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

restoreInstance(request, options, callback)

restoreInstance(request: protos.google.cloud.filestore.v1.IRestoreInstanceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.filestore.v1.IInstance, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.filestore.v1.IRestoreInstanceRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.filestore.v1.IInstance, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

restoreInstance(request, callback)

restoreInstance(request: protos.google.cloud.filestore.v1.IRestoreInstanceRequest, callback: Callback<LROperation<protos.google.cloud.filestore.v1.IInstance, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.filestore.v1.IRestoreInstanceRequest
callback Callback<LROperation<protos.google.cloud.filestore.v1.IInstance, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateBackup(request, options)

updateBackup(request?: protos.google.cloud.filestore.v1.IUpdateBackupRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.filestore.v1.IBackup, protos.google.cloud.common.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.cloud.filestore.v1.IUpdateBackupRequest
options CallOptions
Returns
Type Description
Promise<[ LROperation<protos.google.cloud.filestore.v1.IBackup, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

updateBackup(request, options, callback)

updateBackup(request: protos.google.cloud.filestore.v1.IUpdateBackupRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.filestore.v1.IBackup, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.filestore.v1.IUpdateBackupRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.filestore.v1.IBackup, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateBackup(request, callback)

updateBackup(request: protos.google.cloud.filestore.v1.IUpdateBackupRequest, callback: Callback<LROperation<protos.google.cloud.filestore.v1.IBackup, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.filestore.v1.IUpdateBackupRequest
callback Callback<LROperation<protos.google.cloud.filestore.v1.IBackup, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateInstance(request, options)

updateInstance(request?: protos.google.cloud.filestore.v1.IUpdateInstanceRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.filestore.v1.IInstance, protos.google.cloud.common.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.cloud.filestore.v1.IUpdateInstanceRequest
options CallOptions
Returns
Type Description
Promise<[ LROperation<protos.google.cloud.filestore.v1.IInstance, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

updateInstance(request, options, callback)

updateInstance(request: protos.google.cloud.filestore.v1.IUpdateInstanceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.filestore.v1.IInstance, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.filestore.v1.IUpdateInstanceRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.filestore.v1.IInstance, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateInstance(request, callback)

updateInstance(request: protos.google.cloud.filestore.v1.IUpdateInstanceRequest, callback: Callback<LROperation<protos.google.cloud.filestore.v1.IInstance, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.filestore.v1.IUpdateInstanceRequest
callback Callback<LROperation<protos.google.cloud.filestore.v1.IInstance, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void