Summary of entries of Methods for file.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerAsyncClient
CloudFilestoreManagerAsyncClient
(
*
,
credentials
:
typing
.
Optional
[
google
.
auth
.
credentials
.
Credentials
]
=
None
,
transport
:
typing
.
Optional
[
typing
.
Union
[
str
,
google
.
cloud
.
filestore_v1
.
services
.
cloud_filestore_manager
.
transports
.
base
.
CloudFilestoreManagerTransport
,
typing
.
Callable
[[
...
],
google
.
cloud
.
filestore_v1
.
services
.
cloud_filestore_manager
.
transports
.
base
.
CloudFilestoreManagerTransport
]]]
=
'grpc_asyncio'
,
client_options
:
typing
.
Optional
[
google
.
api_core
.
client_options
.
ClientOptions
]
=
None
,
client_info
:
google
.
api_core
.
gapic_v1
.
client_info
.
ClientInfo
=
Instantiates the cloud filestore manager async client.
See more: google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerAsyncClient
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerAsyncClient.backup_path
backup_path
(
project
:
str
,
location
:
str
,
backup
:
str
)
-
> str
Returns a fully-qualified backup string.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerAsyncClient.cancel_operation
cancel_operation
(
request
:
typing
.
Optional
[
google
.
longrunning
.
operations_pb2
.
CancelOperationRequest
]
=
None
,
*
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary_async
.
AsyncRetry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerAsyncClient.common_billing_account_path
common_billing_account_path
(
billing_account
:
str
)
-
> str
Returns a fully-qualified billing_account string.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerAsyncClient.common_folder_path
common_folder_path
(
folder
:
str
)
-
> str
Returns a fully-qualified folder string.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerAsyncClient.common_location_path
common_location_path
(
project
:
str
,
location
:
str
)
-
> str
Returns a fully-qualified location string.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerAsyncClient.common_organization_path
common_organization_path
(
organization
:
str
)
-
> str
Returns a fully-qualified organization string.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerAsyncClient.common_project_path
common_project_path
(
project
:
str
)
-
> str
Returns a fully-qualified project string.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerAsyncClient.create_backup
create_backup
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
CreateBackupRequest
,
dict
,
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
backup
:
typing
.
Optional
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
Backup
]
=
None
,
backup_id
:
typing
.
Optional
[
str
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary_async
.
AsyncRetry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
api_core
.
operation_async
.
AsyncOperation
Creates a backup.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerAsyncClient.create_instance
create_instance
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
CreateInstanceRequest
,
dict
,
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
instance
:
typing
.
Optional
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
Instance
]
=
None
,
instance_id
:
typing
.
Optional
[
str
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary_async
.
AsyncRetry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
api_core
.
operation_async
.
AsyncOperation
Creates an instance.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerAsyncClient.create_snapshot
create_snapshot
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
CreateSnapshotRequest
,
dict
,
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
snapshot
:
typing
.
Optional
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
Snapshot
]
=
None
,
snapshot_id
:
typing
.
Optional
[
str
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary_async
.
AsyncRetry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
api_core
.
operation_async
.
AsyncOperation
Creates a snapshot.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerAsyncClient.delete_backup
delete_backup
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
DeleteBackupRequest
,
dict
,
]
]
=
None
,
*
,
name
:
typing
.
Optional
[
str
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary_async
.
AsyncRetry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
api_core
.
operation_async
.
AsyncOperation
Deletes a backup.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerAsyncClient.delete_instance
delete_instance
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
DeleteInstanceRequest
,
dict
,
]
]
=
None
,
*
,
name
:
typing
.
Optional
[
str
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary_async
.
AsyncRetry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
api_core
.
operation_async
.
AsyncOperation
Deletes an instance.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerAsyncClient.delete_operation
delete_operation
(
request
:
typing
.
Optional
[
google
.
longrunning
.
operations_pb2
.
DeleteOperationRequest
]
=
None
,
*
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary_async
.
AsyncRetry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> None
Deletes a long-running operation.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerAsyncClient.delete_snapshot
delete_snapshot
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
DeleteSnapshotRequest
,
dict
,
]
]
=
None
,
*
,
name
:
typing
.
Optional
[
str
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary_async
.
AsyncRetry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
api_core
.
operation_async
.
AsyncOperation
Deletes a snapshot.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerAsyncClient.from_service_account_file
from_service_account_file
(
filename
:
str
,
*
args
,
**
kwargs
)
Creates an instance of this client using the provided credentials file.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerAsyncClient.from_service_account_info
from_service_account_info
(
info
:
dict
,
*
args
,
**
kwargs
)
Creates an instance of this client using the provided credentials info.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerAsyncClient.from_service_account_json
from_service_account_json
(
filename
:
str
,
*
args
,
**
kwargs
)
Creates an instance of this client using the provided credentials file.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerAsyncClient.get_backup
get_backup
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
GetBackupRequest
,
dict
,
]
]
=
None
,
*
,
name
:
typing
.
Optional
[
str
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary_async
.
AsyncRetry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
Backup
Gets the details of a specific backup.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerAsyncClient.get_instance
get_instance
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
GetInstanceRequest
,
dict
,
]
]
=
None
,
*
,
name
:
typing
.
Optional
[
str
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary_async
.
AsyncRetry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
Instance
Gets the details of a specific instance.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerAsyncClient.get_location
get_location
(
request
:
typing
.
Optional
[
google
.
cloud
.
location
.
locations_pb2
.
GetLocationRequest
]
=
None
,
*
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary_async
.
AsyncRetry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
cloud
.
location
.
locations_pb2
.
Location
Gets information about a location.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source
(
client_options
:
typing
.
Optional
[
google
.
api_core
.
client_options
.
ClientOptions
]
=
None
,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerAsyncClient.get_operation
get_operation
(
request
:
typing
.
Optional
[
google
.
longrunning
.
operations_pb2
.
GetOperationRequest
]
=
None
,
*
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary_async
.
AsyncRetry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
longrunning
.
operations_pb2
.
Operation
Gets the latest state of a long-running operation.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerAsyncClient.get_snapshot
get_snapshot
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
GetSnapshotRequest
,
dict
,
]
]
=
None
,
*
,
name
:
typing
.
Optional
[
str
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary_async
.
AsyncRetry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
Snapshot
Gets the details of a specific snapshot.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerAsyncClient.get_transport_class
get_transport_class
()
-
> (
typing
.
Type
[
google
.
cloud
.
filestore_v1
.
services
.
cloud_filestore_manager
.
transports
.
base
.
CloudFilestoreManagerTransport
]
)
Returns an appropriate transport class.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerAsyncClient.instance_path
instance_path
(
project
:
str
,
location
:
str
,
instance
:
str
)
-
> str
Returns a fully-qualified instance string.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerAsyncClient.list_backups
list_backups
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
ListBackupsRequest
,
dict
,
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary_async
.
AsyncRetry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> (
google
.
cloud
.
filestore_v1
.
services
.
cloud_filestore_manager
.
pagers
.
ListBackupsAsyncPager
)
Lists all backups in a project for either a specified location or for all locations.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerAsyncClient.list_instances
list_instances
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
ListInstancesRequest
,
dict
,
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary_async
.
AsyncRetry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> (
google
.
cloud
.
filestore_v1
.
services
.
cloud_filestore_manager
.
pagers
.
ListInstancesAsyncPager
)
Lists all instances in a project for either a specified location or for all locations.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerAsyncClient.list_locations
list_locations
(
request
:
typing
.
Optional
[
google
.
cloud
.
location
.
locations_pb2
.
ListLocationsRequest
]
=
None
,
*
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary_async
.
AsyncRetry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
cloud
.
location
.
locations_pb2
.
ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerAsyncClient.list_operations
list_operations
(
request
:
typing
.
Optional
[
google
.
longrunning
.
operations_pb2
.
ListOperationsRequest
]
=
None
,
*
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary_async
.
AsyncRetry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
longrunning
.
operations_pb2
.
ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerAsyncClient.list_snapshots
list_snapshots
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
ListSnapshotsRequest
,
dict
,
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary_async
.
AsyncRetry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> (
google
.
cloud
.
filestore_v1
.
services
.
cloud_filestore_manager
.
pagers
.
ListSnapshotsAsyncPager
)
Lists all snapshots in a project for either a specified location or for all locations.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerAsyncClient.parse_backup_path
parse_backup_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a backup path into its component segments.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a billing_account path into its component segments.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerAsyncClient.parse_common_folder_path
parse_common_folder_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a folder path into its component segments.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerAsyncClient.parse_common_location_path
parse_common_location_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a location path into its component segments.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerAsyncClient.parse_common_organization_path
parse_common_organization_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a organization path into its component segments.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerAsyncClient.parse_common_project_path
parse_common_project_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a project path into its component segments.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerAsyncClient.parse_instance_path
parse_instance_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a instance path into its component segments.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerAsyncClient.parse_snapshot_path
parse_snapshot_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a snapshot path into its component segments.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerAsyncClient.restore_instance
restore_instance
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
RestoreInstanceRequest
,
dict
,
]
]
=
None
,
*
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary_async
.
AsyncRetry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
api_core
.
operation_async
.
AsyncOperation
Restores an existing instance's file share from a backup.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerAsyncClient.revert_instance
revert_instance
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
RevertInstanceRequest
,
dict
,
]
]
=
None
,
*
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary_async
.
AsyncRetry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
api_core
.
operation_async
.
AsyncOperation
Revert an existing instance's file system to a specified snapshot.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerAsyncClient.snapshot_path
snapshot_path
(
project
:
str
,
location
:
str
,
instance
:
str
,
snapshot
:
str
)
-
> str
Returns a fully-qualified snapshot string.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerAsyncClient.update_backup
update_backup
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
UpdateBackupRequest
,
dict
,
]
]
=
None
,
*
,
backup
:
typing
.
Optional
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
Backup
]
=
None
,
update_mask
:
typing
.
Optional
[
google
.
protobuf
.
field_mask_pb2
.
FieldMask
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary_async
.
AsyncRetry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
api_core
.
operation_async
.
AsyncOperation
Updates the settings of a specific backup.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerAsyncClient.update_instance
update_instance
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
UpdateInstanceRequest
,
dict
,
]
]
=
None
,
*
,
instance
:
typing
.
Optional
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
Instance
]
=
None
,
update_mask
:
typing
.
Optional
[
google
.
protobuf
.
field_mask_pb2
.
FieldMask
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary_async
.
AsyncRetry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
api_core
.
operation_async
.
AsyncOperation
Updates the settings of a specific instance.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerAsyncClient.update_snapshot
update_snapshot
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
UpdateSnapshotRequest
,
dict
,
]
]
=
None
,
*
,
snapshot
:
typing
.
Optional
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
Snapshot
]
=
None
,
update_mask
:
typing
.
Optional
[
google
.
protobuf
.
field_mask_pb2
.
FieldMask
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary_async
.
AsyncRetry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
api_core
.
operation_async
.
AsyncOperation
Updates the settings of a specific snapshot.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient
CloudFilestoreManagerClient
(
*
,
credentials
:
typing
.
Optional
[
google
.
auth
.
credentials
.
Credentials
]
=
None
,
transport
:
typing
.
Optional
[
typing
.
Union
[
str
,
google
.
cloud
.
filestore_v1
.
services
.
cloud_filestore_manager
.
transports
.
base
.
CloudFilestoreManagerTransport
,
typing
.
Callable
[[
...
],
google
.
cloud
.
filestore_v1
.
services
.
cloud_filestore_manager
.
transports
.
base
.
CloudFilestoreManagerTransport
]]]
=
None
,
client_options
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
client_options
.
ClientOptions
,
dict
]]
=
None
,
client_info
:
google
.
api_core
.
gapic_v1
.
client_info
.
ClientInfo
=
Instantiates the cloud filestore manager client.
See more: google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.__exit__
__exit__
(
type
,
value
,
traceback
)
Releases underlying transport's resources.
See more: google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient. exit
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.backup_path
backup_path
(
project
:
str
,
location
:
str
,
backup
:
str
)
-
> str
Returns a fully-qualified backup string.
See more: google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.backup_path
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.cancel_operation
cancel_operation
(
request
:
typing
.
Optional
[
google
.
longrunning
.
operations_pb2
.
CancelOperationRequest
]
=
None
,
*
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> None
Starts asynchronous cancellation on a long-running operation.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.common_billing_account_path
common_billing_account_path
(
billing_account
:
str
)
-
> str
Returns a fully-qualified billing_account string.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.common_folder_path
common_folder_path
(
folder
:
str
)
-
> str
Returns a fully-qualified folder string.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.common_location_path
common_location_path
(
project
:
str
,
location
:
str
)
-
> str
Returns a fully-qualified location string.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.common_organization_path
common_organization_path
(
organization
:
str
)
-
> str
Returns a fully-qualified organization string.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.common_project_path
common_project_path
(
project
:
str
)
-
> str
Returns a fully-qualified project string.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.create_backup
create_backup
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
CreateBackupRequest
,
dict
,
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
backup
:
typing
.
Optional
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
Backup
]
=
None
,
backup_id
:
typing
.
Optional
[
str
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
api_core
.
operation
.
Operation
Creates a backup.
See more: google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.create_backup
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.create_instance
create_instance
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
CreateInstanceRequest
,
dict
,
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
instance
:
typing
.
Optional
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
Instance
]
=
None
,
instance_id
:
typing
.
Optional
[
str
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
api_core
.
operation
.
Operation
Creates an instance.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.create_snapshot
create_snapshot
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
CreateSnapshotRequest
,
dict
,
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
snapshot
:
typing
.
Optional
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
Snapshot
]
=
None
,
snapshot_id
:
typing
.
Optional
[
str
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
api_core
.
operation
.
Operation
Creates a snapshot.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.delete_backup
delete_backup
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
DeleteBackupRequest
,
dict
,
]
]
=
None
,
*
,
name
:
typing
.
Optional
[
str
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
api_core
.
operation
.
Operation
Deletes a backup.
See more: google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.delete_backup
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.delete_instance
delete_instance
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
DeleteInstanceRequest
,
dict
,
]
]
=
None
,
*
,
name
:
typing
.
Optional
[
str
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
api_core
.
operation
.
Operation
Deletes an instance.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.delete_operation
delete_operation
(
request
:
typing
.
Optional
[
google
.
longrunning
.
operations_pb2
.
DeleteOperationRequest
]
=
None
,
*
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> None
Deletes a long-running operation.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.delete_snapshot
delete_snapshot
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
DeleteSnapshotRequest
,
dict
,
]
]
=
None
,
*
,
name
:
typing
.
Optional
[
str
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
api_core
.
operation
.
Operation
Deletes a snapshot.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.from_service_account_file
from_service_account_file
(
filename
:
str
,
*
args
,
**
kwargs
)
Creates an instance of this client using the provided credentials file.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.from_service_account_info
from_service_account_info
(
info
:
dict
,
*
args
,
**
kwargs
)
Creates an instance of this client using the provided credentials info.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.from_service_account_json
from_service_account_json
(
filename
:
str
,
*
args
,
**
kwargs
)
Creates an instance of this client using the provided credentials file.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.get_backup
get_backup
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
GetBackupRequest
,
dict
,
]
]
=
None
,
*
,
name
:
typing
.
Optional
[
str
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
Backup
Gets the details of a specific backup.
See more: google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.get_backup
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.get_instance
get_instance
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
GetInstanceRequest
,
dict
,
]
]
=
None
,
*
,
name
:
typing
.
Optional
[
str
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
Instance
Gets the details of a specific instance.
See more: google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.get_instance
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.get_location
get_location
(
request
:
typing
.
Optional
[
google
.
cloud
.
location
.
locations_pb2
.
GetLocationRequest
]
=
None
,
*
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
cloud
.
location
.
locations_pb2
.
Location
Gets information about a location.
See more: google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.get_location
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source
(
client_options
:
typing
.
Optional
[
google
.
api_core
.
client_options
.
ClientOptions
]
=
None
,
)
Deprecated.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.get_operation
get_operation
(
request
:
typing
.
Optional
[
google
.
longrunning
.
operations_pb2
.
GetOperationRequest
]
=
None
,
*
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
longrunning
.
operations_pb2
.
Operation
Gets the latest state of a long-running operation.
See more: google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.get_operation
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.get_snapshot
get_snapshot
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
GetSnapshotRequest
,
dict
,
]
]
=
None
,
*
,
name
:
typing
.
Optional
[
str
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
Snapshot
Gets the details of a specific snapshot.
See more: google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.get_snapshot
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.instance_path
instance_path
(
project
:
str
,
location
:
str
,
instance
:
str
)
-
> str
Returns a fully-qualified instance string.
See more: google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.instance_path
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.list_backups
list_backups
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
ListBackupsRequest
,
dict
,
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
cloud
.
filestore_v1
.
services
.
cloud_filestore_manager
.
pagers
.
ListBackupsPager
Lists all backups in a project for either a specified location or for all locations.
See more: google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.list_backups
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.list_instances
list_instances
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
ListInstancesRequest
,
dict
,
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> (
google
.
cloud
.
filestore_v1
.
services
.
cloud_filestore_manager
.
pagers
.
ListInstancesPager
)
Lists all instances in a project for either a specified location or for all locations.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.list_locations
list_locations
(
request
:
typing
.
Optional
[
google
.
cloud
.
location
.
locations_pb2
.
ListLocationsRequest
]
=
None
,
*
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
cloud
.
location
.
locations_pb2
.
ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.list_operations
list_operations
(
request
:
typing
.
Optional
[
google
.
longrunning
.
operations_pb2
.
ListOperationsRequest
]
=
None
,
*
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
longrunning
.
operations_pb2
.
ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.list_snapshots
list_snapshots
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
ListSnapshotsRequest
,
dict
,
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> (
google
.
cloud
.
filestore_v1
.
services
.
cloud_filestore_manager
.
pagers
.
ListSnapshotsPager
)
Lists all snapshots in a project for either a specified location or for all locations.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.parse_backup_path
parse_backup_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a backup path into its component segments.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.parse_common_billing_account_path
parse_common_billing_account_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a billing_account path into its component segments.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.parse_common_folder_path
parse_common_folder_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a folder path into its component segments.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.parse_common_location_path
parse_common_location_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a location path into its component segments.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.parse_common_organization_path
parse_common_organization_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a organization path into its component segments.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.parse_common_project_path
parse_common_project_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a project path into its component segments.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.parse_instance_path
parse_instance_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a instance path into its component segments.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.parse_snapshot_path
parse_snapshot_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a snapshot path into its component segments.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.restore_instance
restore_instance
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
RestoreInstanceRequest
,
dict
,
]
]
=
None
,
*
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
api_core
.
operation
.
Operation
Restores an existing instance's file share from a backup.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.revert_instance
revert_instance
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
RevertInstanceRequest
,
dict
,
]
]
=
None
,
*
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
api_core
.
operation
.
Operation
Revert an existing instance's file system to a specified snapshot.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.snapshot_path
snapshot_path
(
project
:
str
,
location
:
str
,
instance
:
str
,
snapshot
:
str
)
-
> str
Returns a fully-qualified snapshot string.
See more: google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.snapshot_path
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.update_backup
update_backup
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
UpdateBackupRequest
,
dict
,
]
]
=
None
,
*
,
backup
:
typing
.
Optional
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
Backup
]
=
None
,
update_mask
:
typing
.
Optional
[
google
.
protobuf
.
field_mask_pb2
.
FieldMask
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
api_core
.
operation
.
Operation
Updates the settings of a specific backup.
See more: google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.update_backup
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.update_instance
update_instance
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
UpdateInstanceRequest
,
dict
,
]
]
=
None
,
*
,
instance
:
typing
.
Optional
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
Instance
]
=
None
,
update_mask
:
typing
.
Optional
[
google
.
protobuf
.
field_mask_pb2
.
FieldMask
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
api_core
.
operation
.
Operation
Updates the settings of a specific instance.
google.cloud.filestore_v1.services.cloud_filestore_manager.CloudFilestoreManagerClient.update_snapshot
update_snapshot
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
UpdateSnapshotRequest
,
dict
,
]
]
=
None
,
*
,
snapshot
:
typing
.
Optional
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
Snapshot
]
=
None
,
update_mask
:
typing
.
Optional
[
google
.
protobuf
.
field_mask_pb2
.
FieldMask
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
-
> google
.
api_core
.
operation
.
Operation
Updates the settings of a specific snapshot.
google.cloud.filestore_v1.services.cloud_filestore_manager.pagers.ListBackupsAsyncPager
ListBackupsAsyncPager
(
method
:
typing
.
Callable
[
[
...
],
typing
.
Awaitable
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
ListBackupsResponse
],
],
request
:
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
ListBackupsRequest
,
response
:
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
ListBackupsResponse
,
*
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary_async
.
AsyncRetry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
Instantiates the pager.
See more: google.cloud.filestore_v1.services.cloud_filestore_manager.pagers.ListBackupsAsyncPager
google.cloud.filestore_v1.services.cloud_filestore_manager.pagers.ListBackupsPager
ListBackupsPager
(
method
:
typing
.
Callable
[
[
...
],
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
ListBackupsResponse
,
],
request
:
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
ListBackupsRequest
,
response
:
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
ListBackupsResponse
,
*
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
Instantiate the pager.
See more: google.cloud.filestore_v1.services.cloud_filestore_manager.pagers.ListBackupsPager
google.cloud.filestore_v1.services.cloud_filestore_manager.pagers.ListInstancesAsyncPager
ListInstancesAsyncPager
(
method
:
typing
.
Callable
[
[
...
],
typing
.
Awaitable
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
ListInstancesResponse
],
],
request
:
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
ListInstancesRequest
,
response
:
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
ListInstancesResponse
,
*
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary_async
.
AsyncRetry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
Instantiates the pager.
See more: google.cloud.filestore_v1.services.cloud_filestore_manager.pagers.ListInstancesAsyncPager
google.cloud.filestore_v1.services.cloud_filestore_manager.pagers.ListInstancesPager
ListInstancesPager
(
method
:
typing
.
Callable
[
[
...
],
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
ListInstancesResponse
,
],
request
:
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
ListInstancesRequest
,
response
:
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
ListInstancesResponse
,
*
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
Instantiate the pager.
See more: google.cloud.filestore_v1.services.cloud_filestore_manager.pagers.ListInstancesPager
google.cloud.filestore_v1.services.cloud_filestore_manager.pagers.ListSnapshotsAsyncPager
ListSnapshotsAsyncPager
(
method
:
typing
.
Callable
[
[
...
],
typing
.
Awaitable
[
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
ListSnapshotsResponse
],
],
request
:
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
ListSnapshotsRequest
,
response
:
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
ListSnapshotsResponse
,
*
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary_async
.
AsyncRetry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
Instantiates the pager.
See more: google.cloud.filestore_v1.services.cloud_filestore_manager.pagers.ListSnapshotsAsyncPager
google.cloud.filestore_v1.services.cloud_filestore_manager.pagers.ListSnapshotsPager
ListSnapshotsPager
(
method
:
typing
.
Callable
[
[
...
],
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
ListSnapshotsResponse
,
],
request
:
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
ListSnapshotsRequest
,
response
:
google
.
cloud
.
filestore_v1
.
types
.
cloud_filestore_service
.
ListSnapshotsResponse
,
*
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
str
]]
=
()
)
Instantiate the pager.
See more: google.cloud.filestore_v1.services.cloud_filestore_manager.pagers.ListSnapshotsPager