CloudFilestoreManagerAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.filestore_v1.services.cloud_filestore_manager.transports.base.CloudFilestoreManagerTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)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-filestoreprojects/12345/locations/us-central1/backups/my-backup
Properties
transport
Returns the transport used by the client instance.
| Returns | |
|---|---|
| Type | Description |
CloudFilestoreManagerTransport | The transport used by the client instance. |
Methods
CloudFilestoreManagerAsyncClient
CloudFilestoreManagerAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.filestore_v1.services.cloud_filestore_manager.transports.base.CloudFilestoreManagerTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)Instantiates the cloud filestore manager client.
| Parameters | |
|---|---|
| Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Union[str,
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
ClientOptions
Custom options for the client. It won't take effect if a |
| Exceptions | |
|---|---|
| Type | Description |
google.auth.exceptions.MutualTlsChannelError | If mutual TLS transport creation failed for any reason. |
backup_path
backup_path(project: str, location: str, backup: str)Returns a fully-qualified backup string.
common_billing_account_path
common_billing_account_path(billing_account: str)Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)Returns a fully-qualified project string.
create_backup
create_backup(request: Optional[Union[google.cloud.filestore_v1.types.cloud_filestore_service.CreateBackupRequest, dict]] = None, *, parent: Optional[str] = None, backup: Optional[google.cloud.filestore_v1.types.cloud_filestore_service.Backup] = None, backup_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Creates a backup.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.filestore_v1.types.CreateBackupRequest, dict]
The request object. CreateBackupRequest creates a backup. |
parent |
Required. The backup's project and location, in the format |
backup |
Backup
Required. A [backup resource][google.cloud.filestore.v1.Backup] This corresponds to the |
backup_id |
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. Values that do not match this pattern will trigger an INVALID_ARGUMENT error. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Backup A Cloud Filestore backup. |
create_instance
create_instance(request: Optional[Union[google.cloud.filestore_v1.types.cloud_filestore_service.CreateInstanceRequest, dict]] = None, *, parent: Optional[str] = None, instance: Optional[google.cloud.filestore_v1.types.cloud_filestore_service.Instance] = None, instance_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())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).
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.filestore_v1.types.CreateInstanceRequest, dict]
The request object. CreateInstanceRequest creates an instance. |
parent |
Required. The instance's project and location, in the format |
instance |
Instance
Required. An [instance resource][google.cloud.filestore.v1.Instance] This corresponds to the |
instance_id |
Required. The name of the instance to create. The name must be unique for the specified project and location. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Instance A Cloud Filestore instance. |
delete_backup
delete_backup(request: Optional[Union[google.cloud.filestore_v1.types.cloud_filestore_service.DeleteBackupRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Deletes a backup.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.filestore_v1.types.DeleteBackupRequest, dict]
The request object. DeleteBackupRequest deletes a backup. |
name |
Required. The backup resource name, in the format |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}. |
delete_instance
delete_instance(request: Optional[Union[google.cloud.filestore_v1.types.cloud_filestore_service.DeleteInstanceRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Deletes an instance.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.filestore_v1.types.DeleteInstanceRequest, dict]
The request object. DeleteInstanceRequest deletes an instance. |
name |
Required. The instance resource name, in the format |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}. |
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Parameter | |
|---|---|
| Name | Description |
filename |
str
The path to the service account private key json file. |
| Returns | |
|---|---|
| Type | Description |
CloudFilestoreManagerAsyncClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)Creates an instance of this client using the provided credentials info.
| Parameter | |
|---|---|
| Name | Description |
info |
dict
The service account private key info. |
| Returns | |
|---|---|
| Type | Description |
CloudFilestoreManagerAsyncClient | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Parameter | |
|---|---|
| Name | Description |
filename |
str
The path to the service account private key json file. |
| Returns | |
|---|---|
| Type | Description |
CloudFilestoreManagerAsyncClient | The constructed client. |
get_backup
get_backup(request: Optional[Union[google.cloud.filestore_v1.types.cloud_filestore_service.GetBackupRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Gets the details of a specific backup.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.filestore_v1.types.GetBackupRequest, dict]
The request object. GetBackupRequest gets the state of a backup. |
name |
Required. The backup resource name, in the format |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.filestore_v1.types.Backup | A Cloud Filestore backup. |
get_instance
get_instance(request: Optional[Union[google.cloud.filestore_v1.types.cloud_filestore_service.GetInstanceRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Gets the details of a specific instance.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.filestore_v1.types.GetInstanceRequest, dict]
The request object. GetInstanceRequest gets the state of an instance. |
name |
Required. The instance resource name, in the format |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.filestore_v1.types.Instance | A Cloud Filestore instance. |
get_transport_class
get_transport_class()Returns an appropriate transport class.
instance_path
instance_path(project: str, location: str, instance: str)Returns a fully-qualified instance string.
list_backups
list_backups(request: Optional[Union[google.cloud.filestore_v1.types.cloud_filestore_service.ListBackupsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Lists all backups in a project for either a specified location or for all locations.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.filestore_v1.types.ListBackupsRequest, dict]
The request object. ListBackupsRequest lists backups. |
parent |
Required. The project and location for which to retrieve backup information, in the format |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.filestore_v1.services.cloud_filestore_manager.pagers.ListBackupsAsyncPager | ListBackupsResponse is the result of ListBackupsRequest. Iterating over this object will yield results and resolve additional pages automatically. |
list_instances
list_instances(request: Optional[Union[google.cloud.filestore_v1.types.cloud_filestore_service.ListInstancesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Lists all instances in a project for either a specified location or for all locations.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.filestore_v1.types.ListInstancesRequest, dict]
The request object. ListInstancesRequest lists instances. |
parent |
Required. The project and location for which to retrieve instance information, in the format |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.filestore_v1.services.cloud_filestore_manager.pagers.ListInstancesAsyncPager | ListInstancesResponse is the result of ListInstancesRequest. Iterating over this object will yield results and resolve additional pages automatically. |
parse_backup_path
parse_backup_path(path: str)Parses a backup path into its component segments.
parse_common_billing_account_path
parse_common_billing_account_path(path: str)Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)Parse a project path into its component segments.
parse_instance_path
parse_instance_path(path: str)Parses a instance path into its component segments.
restore_instance
restore_instance(request: Optional[Union[google.cloud.filestore_v1.types.cloud_filestore_service.RestoreInstanceRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())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).
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.filestore_v1.types.RestoreInstanceRequest, dict]
The request object. RestoreInstanceRequest restores an existing instances's file share from a backup. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Instance A Cloud Filestore instance. |
update_backup
update_backup(request: Optional[Union[google.cloud.filestore_v1.types.cloud_filestore_service.UpdateBackupRequest, dict]] = None, *, backup: Optional[google.cloud.filestore_v1.types.cloud_filestore_service.Backup] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Updates the settings of a specific backup.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.filestore_v1.types.UpdateBackupRequest, dict]
The request object. UpdateBackupRequest updates description and/or labels for a backup. |
backup |
Backup
Required. A [backup resource][google.cloud.filestore.v1.Backup] This corresponds to the |
update_mask |
Required. Mask of fields to update. At least one path must be supplied in this field. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Backup A Cloud Filestore backup. |
update_instance
update_instance(request: Optional[Union[google.cloud.filestore_v1.types.cloud_filestore_service.UpdateInstanceRequest, dict]] = None, *, instance: Optional[google.cloud.filestore_v1.types.cloud_filestore_service.Instance] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Updates the settings of a specific instance.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.filestore_v1.types.UpdateInstanceRequest, dict]
The request object. UpdateInstanceRequest updates the settings of an instance. |
instance |
Instance
Only fields specified in update_mask are updated. This corresponds to the |
update_mask |
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" This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Instance A Cloud Filestore instance. |