Summary of entries of Classes for file.
Classes
CloudFilestoreManagerAsyncClient
Configures and manages Filestore resources.
Filestore Manager v1.
The file.googleapis.com
service implements the 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, 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 Google Cloud zone
for instances,
but a Google Cloud region
for backups; for example:
projects/12345/locations/us-central1-c/instances/my-filestore
projects/12345/locations/us-central1/backups/my-backup
CloudFilestoreManagerClient
Configures and manages Filestore resources.
Filestore Manager v1.
The file.googleapis.com
service implements the 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, 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 Google Cloud zone
for instances,
but a Google Cloud region
for backups; for example:
projects/12345/locations/us-central1-c/instances/my-filestore
projects/12345/locations/us-central1/backups/my-backup
ListBackupsAsyncPager
A pager for iterating through list_backups
requests.
This class thinly wraps an initial
ListBackupsResponse object, and
provides an __aiter__
method to iterate through its
backups
field.
If there are more pages, the __aiter__
method will make additional
ListBackups
requests and continue to iterate
through the backups
field on the
corresponding responses.
All the usual ListBackupsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListBackupsPager
A pager for iterating through list_backups
requests.
This class thinly wraps an initial
ListBackupsResponse object, and
provides an __iter__
method to iterate through its
backups
field.
If there are more pages, the __iter__
method will make additional
ListBackups
requests and continue to iterate
through the backups
field on the
corresponding responses.
All the usual ListBackupsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListInstancesAsyncPager
A pager for iterating through list_instances
requests.
This class thinly wraps an initial
ListInstancesResponse object, and
provides an __aiter__
method to iterate through its
instances
field.
If there are more pages, the __aiter__
method will make additional
ListInstances
requests and continue to iterate
through the instances
field on the
corresponding responses.
All the usual ListInstancesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListInstancesPager
A pager for iterating through list_instances
requests.
This class thinly wraps an initial
ListInstancesResponse object, and
provides an __iter__
method to iterate through its
instances
field.
If there are more pages, the __iter__
method will make additional
ListInstances
requests and continue to iterate
through the instances
field on the
corresponding responses.
All the usual ListInstancesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListSnapshotsAsyncPager
A pager for iterating through list_snapshots
requests.
This class thinly wraps an initial
ListSnapshotsResponse object, and
provides an __aiter__
method to iterate through its
snapshots
field.
If there are more pages, the __aiter__
method will make additional
ListSnapshots
requests and continue to iterate
through the snapshots
field on the
corresponding responses.
All the usual ListSnapshotsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListSnapshotsPager
A pager for iterating through list_snapshots
requests.
This class thinly wraps an initial
ListSnapshotsResponse object, and
provides an __iter__
method to iterate through its
snapshots
field.
If there are more pages, the __iter__
method will make additional
ListSnapshots
requests and continue to iterate
through the snapshots
field on the
corresponding responses.
All the usual ListSnapshotsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
Backup
A Filestore backup.
LabelsEntry
The abstract base class for a message.
State
The backup state.
CreateBackupRequest
CreateBackupRequest creates a backup.
CreateInstanceRequest
CreateInstanceRequest creates an instance.
CreateSnapshotRequest
CreateSnapshotRequest creates a snapshot.
DeleteBackupRequest
DeleteBackupRequest deletes a backup.
DeleteInstanceRequest
DeleteInstanceRequest deletes an instance.
DeleteSnapshotRequest
DeleteSnapshotRequest deletes a snapshot.
FileShareConfig
File share configuration for the instance.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
GetBackupRequest
GetBackupRequest gets the state of a backup.
GetInstanceRequest
GetInstanceRequest gets the state of an instance.
GetSnapshotRequest
GetSnapshotRequest gets the state of a snapshot.
Instance
A Filestore instance.
LabelsEntry
The abstract base class for a message.
State
The instance state.
SuspensionReason
SuspensionReason contains the possible reasons for a suspension.
Tier
Available service tiers.
ListBackupsRequest
ListBackupsRequest lists backups.
ListBackupsResponse
ListBackupsResponse is the result of ListBackupsRequest.
ListInstancesRequest
ListInstancesRequest lists instances.
ListInstancesResponse
ListInstancesResponse is the result of ListInstancesRequest.
ListSnapshotsRequest
ListSnapshotsRequest lists snapshots.
ListSnapshotsResponse
ListSnapshotsResponse is the result of ListSnapshotsRequest.
NetworkConfig
Network configuration for the instance.
AddressMode
Internet protocol versions supported by Filestore.
ConnectMode
Available connection modes.
NfsExportOptions
NFS export options specifications.
AccessMode
The access mode.
SquashMode
The squash mode.
RestoreInstanceRequest
RestoreInstanceRequest restores an existing instance's file share from a backup.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
RevertInstanceRequest
RevertInstanceRequest reverts the given instance's file share to the specified snapshot.
Snapshot
A Filestore snapshot.
LabelsEntry
The abstract base class for a message.
State
The snapshot state.
UpdateBackupRequest
UpdateBackupRequest updates description and/or labels for a backup.
UpdateInstanceRequest
UpdateInstanceRequest updates the settings of an instance.
UpdateSnapshotRequest
UpdateSnapshotRequest updates description and/or labels for a snapshot.
Modules
pagers
API documentation for filestore_v1.services.cloud_filestore_manager.pagers
module.