Package Classes (1.13.0)

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

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

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.

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.

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.

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.

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.

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.

A Filestore backup.

The abstract base class for a message.

The backup state.

The abstract base class for a message.

CreateBackupRequest creates a backup.

CreateInstanceRequest creates an instance.

CreateSnapshotRequest creates a snapshot.

DeleteBackupRequest deletes a backup.

DeleteInstanceRequest deletes an instance.

DeleteSnapshotRequest deletes a snapshot.

File share configuration for the instance.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

GetBackupRequest gets the state of a backup.

GetInstanceRequest gets the state of an instance.

GetSnapshotRequest gets the state of a snapshot.

A Filestore instance.

File access protocol.

Fixed IOPS (input/output operations per second) parameters.

IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB).

The abstract base class for a message.

Used for setting the performance configuration. If the user doesn't specify PerformanceConfig, automatically provision the default performance settings as described in https://cloud.google.com/filestore/docs/performance. Larger instances will be linearly set to more IOPS. If the instance's capacity is increased or decreased, its performance will be automatically adjusted upwards or downwards accordingly (respectively).

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The enforced performance limits, calculated from the instance's performance configuration.

The instance state.

SuspensionReason contains the possible reasons for a suspension.

The abstract base class for a message.

Available service tiers.

ListBackupsRequest lists backups.

ListBackupsResponse is the result of ListBackupsRequest.

ListInstancesRequest lists instances.

ListInstancesResponse is the result of ListInstancesRequest.

ListSnapshotsRequest lists snapshots.

ListSnapshotsResponse is the result of ListSnapshotsRequest.

Network configuration for the instance.

Internet protocol versions supported by Filestore.

Available connection modes.

NFS export options specifications.

The access mode.

The squash mode.

PromoteReplicaRequest promotes a Filestore standby instance (replica).

Replica configuration for the instance.

The replica state.

Additional information about the replication state, if available.

Replication specifications.

Replication role.

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 reverts the given instance's file share to the specified snapshot.

A Filestore snapshot.

The abstract base class for a message.

The snapshot state.

The abstract base class for a message.

UpdateBackupRequest updates description and/or labels for a backup.

UpdateInstanceRequest updates the settings of an instance.

UpdateSnapshotRequest updates description and/or labels for a snapshot.

API documentation for filestore_v1.services.cloud_filestore_manager.pagers module.