file

import { file } from "https://googleapis.deno.dev/v1/file:v1.ts";

The Cloud Filestore API is used for creating and managing cloud file servers.

class file {

constructor(client?: CredentialsClient, baseUrl?: string);

async projectsLocationsBackupsCreate(

parent: string,

req: Backup,

opts?: ProjectsLocationsBackupsCreateOptions,

): Promise<Operation>;

async projectsLocationsBackupsDelete(name: string): Promise<Operation>;

async projectsLocationsBackupsGet(name: string): Promise<Backup>;

async projectsLocationsBackupsList(parent: string, opts?: ProjectsLocationsBackupsListOptions): Promise<ListBackupsResponse>;

async projectsLocationsBackupsPatch(

req: Backup,

opts?: ProjectsLocationsBackupsPatchOptions,

): Promise<Operation>;

async projectsLocationsGet(name: string): Promise<Location>;

async projectsLocationsInstancesCreate(

parent: string,

req: Instance,

opts?: ProjectsLocationsInstancesCreateOptions,

): Promise<Operation>;

async projectsLocationsInstancesDelete(name: string, opts?: ProjectsLocationsInstancesDeleteOptions): Promise<Operation>;

async projectsLocationsInstancesGet(name: string): Promise<Instance>;

async projectsLocationsInstancesList(parent: string, opts?: ProjectsLocationsInstancesListOptions): Promise<ListInstancesResponse>;

async projectsLocationsInstancesPatch(

req: Instance,

opts?: ProjectsLocationsInstancesPatchOptions,

): Promise<Operation>;

async projectsLocationsInstancesRestore(name: string, req: RestoreInstanceRequest): Promise<Operation>;

async projectsLocationsInstancesRevert(name: string, req: RevertInstanceRequest): Promise<Operation>;

async projectsLocationsInstancesSnapshotsCreate(

parent: string,

req: Snapshot,

opts?: ProjectsLocationsInstancesSnapshotsCreateOptions,

): Promise<Operation>;

async projectsLocationsInstancesSnapshotsDelete(name: string): Promise<Operation>;

async projectsLocationsInstancesSnapshotsGet(name: string): Promise<Snapshot>;

async projectsLocationsInstancesSnapshotsList(parent: string, opts?: ProjectsLocationsInstancesSnapshotsListOptions): Promise<ListSnapshotsResponse>;

async projectsLocationsInstancesSnapshotsPatch(

req: Snapshot,

opts?: ProjectsLocationsInstancesSnapshotsPatchOptions,

): Promise<Operation>;

async projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>;

async projectsLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>;

async projectsLocationsOperationsDelete(name: string): Promise<Empty>;

async projectsLocationsOperationsGet(name: string): Promise<Operation>;

async projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>;

}

§Constructors

new file(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

projectsLocationsBackupsCreate(parent: string, req: Backup, opts?: ProjectsLocationsBackupsCreateOptions): Promise<Operation>

[src]

Creates a backup.

@param parent

Required. The backup's project and location, in the format projects/{project_number}/locations/{location}. In Filestore, backup locations map to Google Cloud regions, for example us-west1.

projectsLocationsBackupsDelete(name: string): Promise<Operation>

[src]

Deletes a backup.

@param name

Required. The backup resource name, in the format projects/{project_number}/locations/{location}/backups/{backup_id}

projectsLocationsBackupsGet(name: string): Promise<Backup>

[src]

Gets the details of a specific backup.

@param name

Required. The backup resource name, in the format projects/{project_number}/locations/{location}/backups/{backup_id}.

projectsLocationsBackupsList(parent: string, opts?: ProjectsLocationsBackupsListOptions): Promise<ListBackupsResponse>

[src]

Lists all backups in a project for either a specified location or for all locations.

@param parent

Required. The project and location for which to retrieve backup information, in the format projects/{project_number}/locations/{location}. In Filestore, backup locations map to Google Cloud regions, for example us-west1. To retrieve backup information for all locations, use "-" for the {location} value.

projectsLocationsBackupsPatch(name: string, req: Backup, opts?: ProjectsLocationsBackupsPatchOptions): Promise<Operation>

[src]

Updates the settings of a specific backup.

@param name

Output only. The resource name of the backup, in the format projects/{project_number}/locations/{location_id}/backups/{backup_id}.

projectsLocationsGet(name: string): Promise<Location>

[src]

Gets information about a location.

@param name

Resource name for the location.

projectsLocationsInstancesCreate(parent: string, req: Instance, opts?: ProjectsLocationsInstancesCreateOptions): Promise<Operation>

[src]

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).

@param parent

Required. The instance's project and location, in the format projects/{project_id}/locations/{location}. In Filestore, locations map to Google Cloud zones, for example us-west1-b.

projectsLocationsInstancesDelete(name: string, opts?: ProjectsLocationsInstancesDeleteOptions): Promise<Operation>

[src]

Deletes an instance.

@param name

Required. The instance resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id}

projectsLocationsInstancesGet(name: string): Promise<Instance>

[src]

Gets the details of a specific instance.

@param name

Required. The instance resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id}.

projectsLocationsInstancesList(parent: string, opts?: ProjectsLocationsInstancesListOptions): Promise<ListInstancesResponse>

[src]

Lists all instances in a project for either a specified location or for all locations.

@param parent

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 Google Cloud zones, for example us-west1-b. To retrieve instance information for all locations, use "-" for the {location} value.

projectsLocationsInstancesPatch(name: string, req: Instance, opts?: ProjectsLocationsInstancesPatchOptions): Promise<Operation>

[src]

Updates the settings of a specific instance.

@param name

Output only. The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instance}.

projectsLocationsInstancesRestore(name: string, req: RestoreInstanceRequest): Promise<Operation>

[src]

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).

@param name

Required. The resource name of the instance, in the format projects/{project_number}/locations/{location_id}/instances/{instance_id}.

projectsLocationsInstancesRevert(name: string, req: RevertInstanceRequest): Promise<Operation>

[src]

Revert an existing instance's file system to a specified snapshot.

@param name

Required. The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}.

projectsLocationsInstancesSnapshotsCreate(parent: string, req: Snapshot, opts?: ProjectsLocationsInstancesSnapshotsCreateOptions): Promise<Operation>

[src]

Creates a snapshot.

@param parent

Required. The Filestore Instance to create the snapshots of, in the format projects/{project_id}/locations/{location}/instances/{instance_id}

projectsLocationsInstancesSnapshotsDelete(name: string): Promise<Operation>

[src]

Deletes a snapshot.

@param name

Required. The snapshot resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id}/snapshots/{snapshot_id}

projectsLocationsInstancesSnapshotsGet(name: string): Promise<Snapshot>

[src]

Gets the details of a specific snapshot.

@param name

Required. The snapshot resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id}/snapshots/{snapshot_id}

projectsLocationsInstancesSnapshotsList(parent: string, opts?: ProjectsLocationsInstancesSnapshotsListOptions): Promise<ListSnapshotsResponse>

[src]

Lists all snapshots in a project for either a specified location or for all locations.

@param parent

Required. The instance for which to retrieve snapshot information, in the format projects/{project_id}/locations/{location}/instances/{instance_id}.

projectsLocationsInstancesSnapshotsPatch(name: string, req: Snapshot, opts?: ProjectsLocationsInstancesSnapshotsPatchOptions): Promise<Operation>

[src]

Updates the settings of a specific snapshot.

@param name

Output only. The resource name of the snapshot, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}/snapshots/{snapshot_id}.

projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>

[src]

Lists information about the supported locations for this service.

@param name

The resource that owns the locations collection, if applicable.

projectsLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>

[src]

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

projectsLocationsOperationsDelete(name: string): Promise<Empty>

[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

projectsLocationsOperationsGet(name: string): Promise<Operation>

[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>

[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.