Configures and manages Cloud Filestore resources.
Cloud Filestore Manager v1beta1.
The file.googleapis.com
service implements the Cloud Filestore API and defines the following model for managing resources: * 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_id}/locations/{location_id}/instances/{instance_id}
backups are resources of the form: /projects/{project_id}/locations/{location_id}/backup/{backup_id}
Note that location_id can represent a GCP zone
or region
depending on the resource. for example: A zonal Filestore instance: * projects/my-project/locations/us-central1-c/instances/my-basic-tier-filer
A regional Filestore instance: * projects/my-project/locations/us-central1/instances/my-enterprise-filer
v1beta1
Package
@google-cloud/filestoreConstructors
(constructor)(opts)
constructor(opts?: ClientOptions);
Construct an instance of CloudFilestoreManagerClient.
Name | Description |
opts |
ClientOptions
|
Properties
apiEndpoint
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
auth
auth: gax.GoogleAuth;
cloudFilestoreManagerStub
cloudFilestoreManagerStub?: Promise<{
[name: string]: Function;
}>;
descriptors
descriptors: Descriptors;
innerApiCalls
innerApiCalls: {
[name: string]: Function;
};
operationsClient
operationsClient: gax.OperationsClient;
pathTemplates
pathTemplates: {
[name: string]: gax.PathTemplate;
};
port
static get port(): number;
The port for this API service.
scopes
static get scopes(): string[];
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
static get servicePath(): string;
The DNS address for this API service.
warn
warn: (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.
Name | Description |
project |
string
|
location |
string
|
backup |
string
|
Type | Description |
string | {string} Resource name string. |
checkCreateBackupProgress(name)
checkCreateBackupProgress(name: string): Promise<LROperation<protos.google.cloud.filestore.v1beta1.Backup, protos.google.cloud.common.OperationMetadata>>;
Check the status of the long running operation returned by createBackup()
.
Name | Description |
name |
string
The operation name that will be passed. |
Type | Description |
Promise<LROperation<protos.google.cloud.filestore.v1beta1.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. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The backup's project and location, in the format
* `projects/{project_id}/locations/{location}`. In Cloud Filestore,
* backup locations map to GCP regions, for example **us-west1**.
*/
// const parent = 'abc123'
/**
* Required. A backup resource google.cloud.filestore.v1beta1.Backup
*/
// const backup = {}
/**
* Required. The ID to use for the backup.
* The ID must be unique within the specified project and location.
* This value must start with a lowercase letter followed by up to 62
* lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
*/
// const backupId = 'abc123'
// Imports the Filestore library
const {CloudFilestoreManagerClient} = require('@google-cloud/filestore').v1beta1;
// Instantiates a client
const filestoreClient = new CloudFilestoreManagerClient();
async function callCreateBackup() {
// Construct request
const request = {
parent,
backup,
backupId,
};
// Run request
const [operation] = await filestoreClient.createBackup(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateBackup();
checkCreateInstanceProgress(name)
checkCreateInstanceProgress(name: string): Promise<LROperation<protos.google.cloud.filestore.v1beta1.Instance, protos.google.cloud.common.OperationMetadata>>;
Check the status of the long running operation returned by createInstance()
.
Name | Description |
name |
string
The operation name that will be passed. |
Type | Description |
Promise<LROperation<protos.google.cloud.filestore.v1beta1.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. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The instance's project and location, in the format
* `projects/{project_id}/locations/{location}`. In Cloud Filestore,
* locations map to GCP zones, for example **us-west1-b**.
*/
// const parent = 'abc123'
/**
* Required. The ID of the instance to create.
* The ID must be unique within the specified project and location.
* This value must start with a lowercase letter followed by up to 62
* lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
*/
// const instanceId = 'abc123'
/**
* Required. An instance resource google.cloud.filestore.v1beta1.Instance
*/
// const instance = {}
// Imports the Filestore library
const {CloudFilestoreManagerClient} = require('@google-cloud/filestore').v1beta1;
// Instantiates a client
const filestoreClient = new CloudFilestoreManagerClient();
async function callCreateInstance() {
// Construct request
const request = {
parent,
instanceId,
instance,
};
// Run request
const [operation] = await filestoreClient.createInstance(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateInstance();
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()
.
Name | Description |
name |
string
The operation name that will be passed. |
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. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The backup resource name, in the format
* `projects/{project_id}/locations/{location}/backups/{backup_id}`
*/
// const name = 'abc123'
// Imports the Filestore library
const {CloudFilestoreManagerClient} = require('@google-cloud/filestore').v1beta1;
// Instantiates a client
const filestoreClient = new CloudFilestoreManagerClient();
async function callDeleteBackup() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await filestoreClient.deleteBackup(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteBackup();
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()
.
Name | Description |
name |
string
The operation name that will be passed. |
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. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The instance resource name, in the format
* `projects/{project_id}/locations/{location}/instances/{instance_id}`
*/
// const name = 'abc123'
// Imports the Filestore library
const {CloudFilestoreManagerClient} = require('@google-cloud/filestore').v1beta1;
// Instantiates a client
const filestoreClient = new CloudFilestoreManagerClient();
async function callDeleteInstance() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await filestoreClient.deleteInstance(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteInstance();
checkRestoreInstanceProgress(name)
checkRestoreInstanceProgress(name: string): Promise<LROperation<protos.google.cloud.filestore.v1beta1.Instance, protos.google.cloud.common.OperationMetadata>>;
Check the status of the long running operation returned by restoreInstance()
.
Name | Description |
name |
string
The operation name that will be passed. |
Type | Description |
Promise<LROperation<protos.google.cloud.filestore.v1beta1.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. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the instance, in the format
* `projects/{project_id}/locations/{location_id}/instances/{instance_id}`.
*/
// const name = 'abc123'
/**
* Required. Name of the file share in the Cloud Filestore instance that the snapshot
* is being restored to.
*/
// const fileShare = 'abc123'
/**
* The resource name of the snapshot, in the format
* `projects/{project_id}/locations/{location_id}/snapshots/{snapshot_id}`.
*/
// const sourceSnapshot = 'abc123'
/**
* The resource name of the backup, in the format
* `projects/{project_id}/locations/{location_id}/backups/{backup_id}`.
*/
// const sourceBackup = 'abc123'
// Imports the Filestore library
const {CloudFilestoreManagerClient} = require('@google-cloud/filestore').v1beta1;
// Instantiates a client
const filestoreClient = new CloudFilestoreManagerClient();
async function callRestoreInstance() {
// Construct request
const request = {
name,
fileShare,
};
// Run request
const [operation] = await filestoreClient.restoreInstance(request);
const [response] = await operation.promise();
console.log(response);
}
callRestoreInstance();
checkUpdateBackupProgress(name)
checkUpdateBackupProgress(name: string): Promise<LROperation<protos.google.cloud.filestore.v1beta1.Backup, protos.google.cloud.common.OperationMetadata>>;
Check the status of the long running operation returned by updateBackup()
.
Name | Description |
name |
string
The operation name that will be passed. |
Type | Description |
Promise<LROperation<protos.google.cloud.filestore.v1beta1.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. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. A backup resource google.cloud.filestore.v1beta1.Backup
*/
// const backup = {}
/**
* Required. Mask of fields to update. At least one path must be supplied in this
* field.
*/
// const updateMask = {}
// Imports the Filestore library
const {CloudFilestoreManagerClient} = require('@google-cloud/filestore').v1beta1;
// Instantiates a client
const filestoreClient = new CloudFilestoreManagerClient();
async function callUpdateBackup() {
// Construct request
const request = {
backup,
updateMask,
};
// Run request
const [operation] = await filestoreClient.updateBackup(request);
const [response] = await operation.promise();
console.log(response);
}
callUpdateBackup();
checkUpdateInstanceProgress(name)
checkUpdateInstanceProgress(name: string): Promise<LROperation<protos.google.cloud.filestore.v1beta1.Instance, protos.google.cloud.common.OperationMetadata>>;
Check the status of the long running operation returned by updateInstance()
.
Name | Description |
name |
string
The operation name that will be passed. |
Type | Description |
Promise<LROperation<protos.google.cloud.filestore.v1beta1.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. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Mask of fields to update. At least one path must be supplied in this
* field. The elements of the repeated paths field may only include these
* fields:
* * "description"
* * "file_shares"
* * "labels"
*/
// const updateMask = {}
/**
* Required. Only fields specified in update_mask are updated.
*/
// const instance = {}
// Imports the Filestore library
const {CloudFilestoreManagerClient} = require('@google-cloud/filestore').v1beta1;
// Instantiates a client
const filestoreClient = new CloudFilestoreManagerClient();
async function callUpdateInstance() {
// Construct request
const request = {
updateMask,
instance,
};
// Run request
const [operation] = await filestoreClient.updateInstance(request);
const [response] = await operation.promise();
console.log(response);
}
callUpdateInstance();
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.
Type | Description |
Promise<void> | {Promise} A promise that resolves when the client is closed. |
createBackup(request, options)
createBackup(request?: protos.google.cloud.filestore.v1beta1.ICreateBackupRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.filestore.v1beta1.IBackup, protos.google.cloud.common.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Creates a backup.
Name | Description |
request |
protos.google.cloud.filestore.v1beta1.ICreateBackupRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[ LROperation<protos.google.cloud.filestore.v1beta1.IBackup, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The backup's project and location, in the format
* `projects/{project_id}/locations/{location}`. In Cloud Filestore,
* backup locations map to GCP regions, for example **us-west1**.
*/
// const parent = 'abc123'
/**
* Required. A backup resource google.cloud.filestore.v1beta1.Backup
*/
// const backup = {}
/**
* Required. The ID to use for the backup.
* The ID must be unique within the specified project and location.
* This value must start with a lowercase letter followed by up to 62
* lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
*/
// const backupId = 'abc123'
// Imports the Filestore library
const {CloudFilestoreManagerClient} = require('@google-cloud/filestore').v1beta1;
// Instantiates a client
const filestoreClient = new CloudFilestoreManagerClient();
async function callCreateBackup() {
// Construct request
const request = {
parent,
backup,
backupId,
};
// Run request
const [operation] = await filestoreClient.createBackup(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateBackup();
createBackup(request, options, callback)
createBackup(request: protos.google.cloud.filestore.v1beta1.ICreateBackupRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.filestore.v1beta1.IBackup, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.filestore.v1beta1.ICreateBackupRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.filestore.v1beta1.IBackup, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
createBackup(request, callback)
createBackup(request: protos.google.cloud.filestore.v1beta1.ICreateBackupRequest, callback: Callback<LROperation<protos.google.cloud.filestore.v1beta1.IBackup, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.filestore.v1beta1.ICreateBackupRequest
|
callback |
Callback<LROperation<protos.google.cloud.filestore.v1beta1.IBackup, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
createInstance(request, options)
createInstance(request?: protos.google.cloud.filestore.v1beta1.ICreateInstanceRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.filestore.v1beta1.IInstance, protos.google.cloud.common.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Creates an instance. When creating from a backup, the capacity of the new instance needs to be equal to or larger than the capacity of the backup (and also equal to or larger than the minimum capacity of the tier).
Name | Description |
request |
protos.google.cloud.filestore.v1beta1.ICreateInstanceRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[ LROperation<protos.google.cloud.filestore.v1beta1.IInstance, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The instance's project and location, in the format
* `projects/{project_id}/locations/{location}`. In Cloud Filestore,
* locations map to GCP zones, for example **us-west1-b**.
*/
// const parent = 'abc123'
/**
* Required. The ID of the instance to create.
* The ID must be unique within the specified project and location.
* This value must start with a lowercase letter followed by up to 62
* lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
*/
// const instanceId = 'abc123'
/**
* Required. An instance resource google.cloud.filestore.v1beta1.Instance
*/
// const instance = {}
// Imports the Filestore library
const {CloudFilestoreManagerClient} = require('@google-cloud/filestore').v1beta1;
// Instantiates a client
const filestoreClient = new CloudFilestoreManagerClient();
async function callCreateInstance() {
// Construct request
const request = {
parent,
instanceId,
instance,
};
// Run request
const [operation] = await filestoreClient.createInstance(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateInstance();
createInstance(request, options, callback)
createInstance(request: protos.google.cloud.filestore.v1beta1.ICreateInstanceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.filestore.v1beta1.IInstance, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.filestore.v1beta1.ICreateInstanceRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.filestore.v1beta1.IInstance, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
createInstance(request, callback)
createInstance(request: protos.google.cloud.filestore.v1beta1.ICreateInstanceRequest, callback: Callback<LROperation<protos.google.cloud.filestore.v1beta1.IInstance, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.filestore.v1beta1.ICreateInstanceRequest
|
callback |
Callback<LROperation<protos.google.cloud.filestore.v1beta1.IInstance, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
deleteBackup(request, options)
deleteBackup(request?: protos.google.cloud.filestore.v1beta1.IDeleteBackupRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.common.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Deletes a backup.
Name | Description |
request |
protos.google.cloud.filestore.v1beta1.IDeleteBackupRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The backup resource name, in the format
* `projects/{project_id}/locations/{location}/backups/{backup_id}`
*/
// const name = 'abc123'
// Imports the Filestore library
const {CloudFilestoreManagerClient} = require('@google-cloud/filestore').v1beta1;
// Instantiates a client
const filestoreClient = new CloudFilestoreManagerClient();
async function callDeleteBackup() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await filestoreClient.deleteBackup(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteBackup();
deleteBackup(request, options, callback)
deleteBackup(request: protos.google.cloud.filestore.v1beta1.IDeleteBackupRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.filestore.v1beta1.IDeleteBackupRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
deleteBackup(request, callback)
deleteBackup(request: protos.google.cloud.filestore.v1beta1.IDeleteBackupRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.filestore.v1beta1.IDeleteBackupRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
deleteInstance(request, options)
deleteInstance(request?: protos.google.cloud.filestore.v1beta1.IDeleteInstanceRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.common.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Deletes an instance.
Name | Description |
request |
protos.google.cloud.filestore.v1beta1.IDeleteInstanceRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The instance resource name, in the format
* `projects/{project_id}/locations/{location}/instances/{instance_id}`
*/
// const name = 'abc123'
// Imports the Filestore library
const {CloudFilestoreManagerClient} = require('@google-cloud/filestore').v1beta1;
// Instantiates a client
const filestoreClient = new CloudFilestoreManagerClient();
async function callDeleteInstance() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await filestoreClient.deleteInstance(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteInstance();
deleteInstance(request, options, callback)
deleteInstance(request: protos.google.cloud.filestore.v1beta1.IDeleteInstanceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.filestore.v1beta1.IDeleteInstanceRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
deleteInstance(request, callback)
deleteInstance(request: protos.google.cloud.filestore.v1beta1.IDeleteInstanceRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.filestore.v1beta1.IDeleteInstanceRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
getBackup(request, options)
getBackup(request?: protos.google.cloud.filestore.v1beta1.IGetBackupRequest, options?: CallOptions): Promise<[
protos.google.cloud.filestore.v1beta1.IBackup,
protos.google.cloud.filestore.v1beta1.IGetBackupRequest | undefined,
{} | undefined
]>;
Gets the details of a specific backup.
Name | Description |
request |
protos.google.cloud.filestore.v1beta1.IGetBackupRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[ protos.google.cloud.filestore.v1beta1.IBackup, protos.google.cloud.filestore.v1beta1.IGetBackupRequest | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [Backup]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The backup resource name, in the format
* `projects/{project_id}/locations/{location}/backups/{backup_id}`.
*/
// const name = 'abc123'
// Imports the Filestore library
const {CloudFilestoreManagerClient} = require('@google-cloud/filestore').v1beta1;
// Instantiates a client
const filestoreClient = new CloudFilestoreManagerClient();
async function callGetBackup() {
// Construct request
const request = {
name,
};
// Run request
const response = await filestoreClient.getBackup(request);
console.log(response);
}
callGetBackup();
getBackup(request, options, callback)
getBackup(request: protos.google.cloud.filestore.v1beta1.IGetBackupRequest, options: CallOptions, callback: Callback<protos.google.cloud.filestore.v1beta1.IBackup, protos.google.cloud.filestore.v1beta1.IGetBackupRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.filestore.v1beta1.IGetBackupRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.filestore.v1beta1.IBackup, protos.google.cloud.filestore.v1beta1.IGetBackupRequest | null | undefined, {} | null | undefined>
|
Type | Description |
void |
getBackup(request, callback)
getBackup(request: protos.google.cloud.filestore.v1beta1.IGetBackupRequest, callback: Callback<protos.google.cloud.filestore.v1beta1.IBackup, protos.google.cloud.filestore.v1beta1.IGetBackupRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.filestore.v1beta1.IGetBackupRequest
|
callback |
Callback<protos.google.cloud.filestore.v1beta1.IBackup, protos.google.cloud.filestore.v1beta1.IGetBackupRequest | null | undefined, {} | null | undefined>
|
Type | Description |
void |
getInstance(request, options)
getInstance(request?: protos.google.cloud.filestore.v1beta1.IGetInstanceRequest, options?: CallOptions): Promise<[
protos.google.cloud.filestore.v1beta1.IInstance,
protos.google.cloud.filestore.v1beta1.IGetInstanceRequest | undefined,
{} | undefined
]>;
Gets the details of a specific instance.
Name | Description |
request |
protos.google.cloud.filestore.v1beta1.IGetInstanceRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[ protos.google.cloud.filestore.v1beta1.IInstance, protos.google.cloud.filestore.v1beta1.IGetInstanceRequest | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [Instance]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The instance resource name, in the format
* `projects/{project_id}/locations/{location}/instances/{instance_id}`.
*/
// const name = 'abc123'
// Imports the Filestore library
const {CloudFilestoreManagerClient} = require('@google-cloud/filestore').v1beta1;
// Instantiates a client
const filestoreClient = new CloudFilestoreManagerClient();
async function callGetInstance() {
// Construct request
const request = {
name,
};
// Run request
const response = await filestoreClient.getInstance(request);
console.log(response);
}
callGetInstance();
getInstance(request, options, callback)
getInstance(request: protos.google.cloud.filestore.v1beta1.IGetInstanceRequest, options: CallOptions, callback: Callback<protos.google.cloud.filestore.v1beta1.IInstance, protos.google.cloud.filestore.v1beta1.IGetInstanceRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.filestore.v1beta1.IGetInstanceRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.filestore.v1beta1.IInstance, protos.google.cloud.filestore.v1beta1.IGetInstanceRequest | null | undefined, {} | null | undefined>
|
Type | Description |
void |
getInstance(request, callback)
getInstance(request: protos.google.cloud.filestore.v1beta1.IGetInstanceRequest, callback: Callback<protos.google.cloud.filestore.v1beta1.IInstance, protos.google.cloud.filestore.v1beta1.IGetInstanceRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.filestore.v1beta1.IGetInstanceRequest
|
callback |
Callback<protos.google.cloud.filestore.v1beta1.IInstance, protos.google.cloud.filestore.v1beta1.IGetInstanceRequest | null | undefined, {} | null | undefined>
|
Type | Description |
void |
getProjectId()
getProjectId(): Promise<string>;
Type | Description |
Promise<string> |
getProjectId(callback)
getProjectId(callback: Callback<string, undefined, undefined>): void;
Name | Description |
callback |
Callback<string, undefined, undefined>
|
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.
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.
Name | Description |
project |
string
|
location |
string
|
instance |
string
|
Type | Description |
string | {string} Resource name string. |
listBackups(request, options)
listBackups(request?: protos.google.cloud.filestore.v1beta1.IListBackupsRequest, options?: CallOptions): Promise<[
protos.google.cloud.filestore.v1beta1.IBackup[],
protos.google.cloud.filestore.v1beta1.IListBackupsRequest | null,
protos.google.cloud.filestore.v1beta1.IListBackupsResponse
]>;
Lists all backups in a project for either a specified location or for all locations.
Name | Description |
request |
protos.google.cloud.filestore.v1beta1.IListBackupsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[ protos.google.cloud.filestore.v1beta1.IBackup[], protos.google.cloud.filestore.v1beta1.IListBackupsRequest | null, protos.google.cloud.filestore.v1beta1.IListBackupsResponse ]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of [Backup]. 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 |
listBackups(request, options, callback)
listBackups(request: protos.google.cloud.filestore.v1beta1.IListBackupsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.filestore.v1beta1.IListBackupsRequest, protos.google.cloud.filestore.v1beta1.IListBackupsResponse | null | undefined, protos.google.cloud.filestore.v1beta1.IBackup>): void;
Name | Description |
request |
protos.google.cloud.filestore.v1beta1.IListBackupsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.filestore.v1beta1.IListBackupsRequest, protos.google.cloud.filestore.v1beta1.IListBackupsResponse | null | undefined, protos.google.cloud.filestore.v1beta1.IBackup>
|
Type | Description |
void |
listBackups(request, callback)
listBackups(request: protos.google.cloud.filestore.v1beta1.IListBackupsRequest, callback: PaginationCallback<protos.google.cloud.filestore.v1beta1.IListBackupsRequest, protos.google.cloud.filestore.v1beta1.IListBackupsResponse | null | undefined, protos.google.cloud.filestore.v1beta1.IBackup>): void;
Name | Description |
request |
protos.google.cloud.filestore.v1beta1.IListBackupsRequest
|
callback |
PaginationCallback<protos.google.cloud.filestore.v1beta1.IListBackupsRequest, protos.google.cloud.filestore.v1beta1.IListBackupsResponse | null | undefined, protos.google.cloud.filestore.v1beta1.IBackup>
|
Type | Description |
void |
listBackupsAsync(request, options)
listBackupsAsync(request?: protos.google.cloud.filestore.v1beta1.IListBackupsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.filestore.v1beta1.IBackup>;
Equivalent to listBackups
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Name | Description |
request |
protos.google.cloud.filestore.v1beta1.IListBackupsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
AsyncIterable<protos.google.cloud.filestore.v1beta1.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. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The project and location for which to retrieve backup information,
* in the format `projects/{project_id}/locations/{location}`.
* In Cloud Filestore, backup locations map to GCP regions,
* for example **us-west1**.
* To retrieve backup information for all locations, use "-" for the
* `{location}` value.
*/
// const parent = 'abc123'
/**
* The maximum number of items to return.
*/
// const pageSize = 1234
/**
* The next_page_token value to use if there are additional
* results to retrieve for this list request.
*/
// const pageToken = 'abc123'
/**
* Sort results. Supported values are "name", "name desc" or "" (unsorted).
*/
// const orderBy = 'abc123'
/**
* List filter.
*/
// const filter = 'abc123'
// Imports the Filestore library
const {CloudFilestoreManagerClient} = require('@google-cloud/filestore').v1beta1;
// Instantiates a client
const filestoreClient = new CloudFilestoreManagerClient();
async function callListBackups() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = await filestoreClient.listBackupsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListBackups();
listBackupsStream(request, options)
listBackupsStream(request?: protos.google.cloud.filestore.v1beta1.IListBackupsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Name | Description |
request |
protos.google.cloud.filestore.v1beta1.IListBackupsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
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 |
listInstances(request, options)
listInstances(request?: protos.google.cloud.filestore.v1beta1.IListInstancesRequest, options?: CallOptions): Promise<[
protos.google.cloud.filestore.v1beta1.IInstance[],
protos.google.cloud.filestore.v1beta1.IListInstancesRequest | null,
protos.google.cloud.filestore.v1beta1.IListInstancesResponse
]>;
Lists all instances in a project for either a specified location or for all locations.
Name | Description |
request |
protos.google.cloud.filestore.v1beta1.IListInstancesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[ protos.google.cloud.filestore.v1beta1.IInstance[], protos.google.cloud.filestore.v1beta1.IListInstancesRequest | null, protos.google.cloud.filestore.v1beta1.IListInstancesResponse ]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of [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 |
listInstances(request, options, callback)
listInstances(request: protos.google.cloud.filestore.v1beta1.IListInstancesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.filestore.v1beta1.IListInstancesRequest, protos.google.cloud.filestore.v1beta1.IListInstancesResponse | null | undefined, protos.google.cloud.filestore.v1beta1.IInstance>): void;
Name | Description |
request |
protos.google.cloud.filestore.v1beta1.IListInstancesRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.filestore.v1beta1.IListInstancesRequest, protos.google.cloud.filestore.v1beta1.IListInstancesResponse | null | undefined, protos.google.cloud.filestore.v1beta1.IInstance>
|
Type | Description |
void |
listInstances(request, callback)
listInstances(request: protos.google.cloud.filestore.v1beta1.IListInstancesRequest, callback: PaginationCallback<protos.google.cloud.filestore.v1beta1.IListInstancesRequest, protos.google.cloud.filestore.v1beta1.IListInstancesResponse | null | undefined, protos.google.cloud.filestore.v1beta1.IInstance>): void;
Name | Description |
request |
protos.google.cloud.filestore.v1beta1.IListInstancesRequest
|
callback |
PaginationCallback<protos.google.cloud.filestore.v1beta1.IListInstancesRequest, protos.google.cloud.filestore.v1beta1.IListInstancesResponse | null | undefined, protos.google.cloud.filestore.v1beta1.IInstance>
|
Type | Description |
void |
listInstancesAsync(request, options)
listInstancesAsync(request?: protos.google.cloud.filestore.v1beta1.IListInstancesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.filestore.v1beta1.IInstance>;
Equivalent to listInstances
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Name | Description |
request |
protos.google.cloud.filestore.v1beta1.IListInstancesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
AsyncIterable<protos.google.cloud.filestore.v1beta1.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. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The project and location for which to retrieve instance information,
* in the format `projects/{project_id}/locations/{location}`. In Cloud
* Filestore, locations map to GCP zones, for example **us-west1-b**. To
* retrieve instance information for all locations, use "-" for the
* `{location}` value.
*/
// const parent = 'abc123'
/**
* The maximum number of items to return.
*/
// const pageSize = 1234
/**
* The next_page_token value to use if there are additional
* results to retrieve for this list request.
*/
// const pageToken = 'abc123'
/**
* Sort results. Supported values are "name", "name desc" or "" (unsorted).
*/
// const orderBy = 'abc123'
/**
* List filter.
*/
// const filter = 'abc123'
// Imports the Filestore library
const {CloudFilestoreManagerClient} = require('@google-cloud/filestore').v1beta1;
// Instantiates a client
const filestoreClient = new CloudFilestoreManagerClient();
async function callListInstances() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = await filestoreClient.listInstancesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListInstances();
listInstancesStream(request, options)
listInstancesStream(request?: protos.google.cloud.filestore.v1beta1.IListInstancesRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Name | Description |
request |
protos.google.cloud.filestore.v1beta1.IListInstancesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
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 |
locationPath(project, location)
locationPath(project: string, location: string): string;
Return a fully-qualified location resource name string.
Name | Description |
project |
string
|
location |
string
|
Type | Description |
string | {string} Resource name string. |
matchBackupFromBackupName(backupName)
matchBackupFromBackupName(backupName: string): string | number;
Parse the backup from Backup resource.
Name | Description |
backupName |
string
A fully-qualified path representing Backup resource. |
Type | Description |
string | number | {string} A string representing the backup. |
matchInstanceFromInstanceName(instanceName)
matchInstanceFromInstanceName(instanceName: string): string | number;
Parse the instance from Instance resource.
Name | Description |
instanceName |
string
A fully-qualified path representing Instance resource. |
Type | Description |
string | number | {string} A string representing the instance. |
matchInstanceFromSnapshotName(snapshotName)
matchInstanceFromSnapshotName(snapshotName: string): string | number;
Parse the instance from Snapshot resource.
Name | Description |
snapshotName |
string
A fully-qualified path representing Snapshot resource. |
Type | Description |
string | number | {string} A string representing the instance. |
matchLocationFromBackupName(backupName)
matchLocationFromBackupName(backupName: string): string | number;
Parse the location from Backup resource.
Name | Description |
backupName |
string
A fully-qualified path representing Backup resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromInstanceName(instanceName)
matchLocationFromInstanceName(instanceName: string): string | number;
Parse the location from Instance resource.
Name | Description |
instanceName |
string
A fully-qualified path representing Instance resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromLocationName(locationName)
matchLocationFromLocationName(locationName: string): string | number;
Parse the location from Location resource.
Name | Description |
locationName |
string
A fully-qualified path representing Location resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromSnapshotName(snapshotName)
matchLocationFromSnapshotName(snapshotName: string): string | number;
Parse the location from Snapshot resource.
Name | Description |
snapshotName |
string
A fully-qualified path representing Snapshot resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchProjectFromBackupName(backupName)
matchProjectFromBackupName(backupName: string): string | number;
Parse the project from Backup resource.
Name | Description |
backupName |
string
A fully-qualified path representing Backup resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromInstanceName(instanceName)
matchProjectFromInstanceName(instanceName: string): string | number;
Parse the project from Instance resource.
Name | Description |
instanceName |
string
A fully-qualified path representing Instance resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromLocationName(locationName)
matchProjectFromLocationName(locationName: string): string | number;
Parse the project from Location resource.
Name | Description |
locationName |
string
A fully-qualified path representing Location resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromSnapshotName(snapshotName)
matchProjectFromSnapshotName(snapshotName: string): string | number;
Parse the project from Snapshot resource.
Name | Description |
snapshotName |
string
A fully-qualified path representing Snapshot resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchSnapshotFromSnapshotName(snapshotName)
matchSnapshotFromSnapshotName(snapshotName: string): string | number;
Parse the snapshot from Snapshot resource.
Name | Description |
snapshotName |
string
A fully-qualified path representing Snapshot resource. |
Type | Description |
string | number | {string} A string representing the snapshot. |
restoreInstance(request, options)
restoreInstance(request?: protos.google.cloud.filestore.v1beta1.IRestoreInstanceRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.filestore.v1beta1.IInstance, protos.google.cloud.common.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Restores an existing instance's file share from a backup.
The capacity of the instance needs to be equal to or larger than the capacity of the backup (and also equal to or larger than the minimum capacity of the tier).
Name | Description |
request |
protos.google.cloud.filestore.v1beta1.IRestoreInstanceRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[ LROperation<protos.google.cloud.filestore.v1beta1.IInstance, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the instance, in the format
* `projects/{project_id}/locations/{location_id}/instances/{instance_id}`.
*/
// const name = 'abc123'
/**
* Required. Name of the file share in the Cloud Filestore instance that the snapshot
* is being restored to.
*/
// const fileShare = 'abc123'
/**
* The resource name of the snapshot, in the format
* `projects/{project_id}/locations/{location_id}/snapshots/{snapshot_id}`.
*/
// const sourceSnapshot = 'abc123'
/**
* The resource name of the backup, in the format
* `projects/{project_id}/locations/{location_id}/backups/{backup_id}`.
*/
// const sourceBackup = 'abc123'
// Imports the Filestore library
const {CloudFilestoreManagerClient} = require('@google-cloud/filestore').v1beta1;
// Instantiates a client
const filestoreClient = new CloudFilestoreManagerClient();
async function callRestoreInstance() {
// Construct request
const request = {
name,
fileShare,
};
// Run request
const [operation] = await filestoreClient.restoreInstance(request);
const [response] = await operation.promise();
console.log(response);
}
callRestoreInstance();
restoreInstance(request, options, callback)
restoreInstance(request: protos.google.cloud.filestore.v1beta1.IRestoreInstanceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.filestore.v1beta1.IInstance, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.filestore.v1beta1.IRestoreInstanceRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.filestore.v1beta1.IInstance, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
restoreInstance(request, callback)
restoreInstance(request: protos.google.cloud.filestore.v1beta1.IRestoreInstanceRequest, callback: Callback<LROperation<protos.google.cloud.filestore.v1beta1.IInstance, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.filestore.v1beta1.IRestoreInstanceRequest
|
callback |
Callback<LROperation<protos.google.cloud.filestore.v1beta1.IInstance, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
snapshotPath(project, location, instance, snapshot)
snapshotPath(project: string, location: string, instance: string, snapshot: string): string;
Return a fully-qualified snapshot resource name string.
Name | Description |
project |
string
|
location |
string
|
instance |
string
|
snapshot |
string
|
Type | Description |
string | {string} Resource name string. |
updateBackup(request, options)
updateBackup(request?: protos.google.cloud.filestore.v1beta1.IUpdateBackupRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.filestore.v1beta1.IBackup, protos.google.cloud.common.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Updates the settings of a specific backup.
Name | Description |
request |
protos.google.cloud.filestore.v1beta1.IUpdateBackupRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[ LROperation<protos.google.cloud.filestore.v1beta1.IBackup, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. A backup resource google.cloud.filestore.v1beta1.Backup
*/
// const backup = {}
/**
* Required. Mask of fields to update. At least one path must be supplied in this
* field.
*/
// const updateMask = {}
// Imports the Filestore library
const {CloudFilestoreManagerClient} = require('@google-cloud/filestore').v1beta1;
// Instantiates a client
const filestoreClient = new CloudFilestoreManagerClient();
async function callUpdateBackup() {
// Construct request
const request = {
backup,
updateMask,
};
// Run request
const [operation] = await filestoreClient.updateBackup(request);
const [response] = await operation.promise();
console.log(response);
}
callUpdateBackup();
updateBackup(request, options, callback)
updateBackup(request: protos.google.cloud.filestore.v1beta1.IUpdateBackupRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.filestore.v1beta1.IBackup, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.filestore.v1beta1.IUpdateBackupRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.filestore.v1beta1.IBackup, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
updateBackup(request, callback)
updateBackup(request: protos.google.cloud.filestore.v1beta1.IUpdateBackupRequest, callback: Callback<LROperation<protos.google.cloud.filestore.v1beta1.IBackup, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.filestore.v1beta1.IUpdateBackupRequest
|
callback |
Callback<LROperation<protos.google.cloud.filestore.v1beta1.IBackup, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
updateInstance(request, options)
updateInstance(request?: protos.google.cloud.filestore.v1beta1.IUpdateInstanceRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.filestore.v1beta1.IInstance, protos.google.cloud.common.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Updates the settings of a specific instance.
Name | Description |
request |
protos.google.cloud.filestore.v1beta1.IUpdateInstanceRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[ LROperation<protos.google.cloud.filestore.v1beta1.IInstance, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Mask of fields to update. At least one path must be supplied in this
* field. The elements of the repeated paths field may only include these
* fields:
* * "description"
* * "file_shares"
* * "labels"
*/
// const updateMask = {}
/**
* Required. Only fields specified in update_mask are updated.
*/
// const instance = {}
// Imports the Filestore library
const {CloudFilestoreManagerClient} = require('@google-cloud/filestore').v1beta1;
// Instantiates a client
const filestoreClient = new CloudFilestoreManagerClient();
async function callUpdateInstance() {
// Construct request
const request = {
updateMask,
instance,
};
// Run request
const [operation] = await filestoreClient.updateInstance(request);
const [response] = await operation.promise();
console.log(response);
}
callUpdateInstance();
updateInstance(request, options, callback)
updateInstance(request: protos.google.cloud.filestore.v1beta1.IUpdateInstanceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.filestore.v1beta1.IInstance, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.filestore.v1beta1.IUpdateInstanceRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.filestore.v1beta1.IInstance, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
updateInstance(request, callback)
updateInstance(request: protos.google.cloud.filestore.v1beta1.IUpdateInstanceRequest, callback: Callback<LROperation<protos.google.cloud.filestore.v1beta1.IInstance, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.filestore.v1beta1.IUpdateInstanceRequest
|
callback |
Callback<LROperation<protos.google.cloud.filestore.v1beta1.IInstance, protos.google.cloud.common.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |