As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

CloudFilestoreManager¶

class google.cloud.filestore_v1.services.cloud_filestore_manager.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 = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶

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

Instantiates the cloud filestore manager async client.

Parameters

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 (Optional[Union[str,CloudFilestoreManagerTransport,Callable[..., CloudFilestoreManagerTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport to use. If a Callable is given, it will be called with the same set of initialization arguments as used in the CloudFilestoreManagerTransport constructor. If set to None, a transport is chosen automatically.
client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –
Custom options for the client.

1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value).

2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

static backup_path(project: str, location: str, backup: str) → str¶: Returns a fully-qualified backup string.

async cancel_operation(request: Optional[google.longrunning.operations_pb2.CancelOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

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.

Parameters

request (CancelOperationRequest) – The request object. Request message for CancelOperation method.
retry (google.api_core.retry_async.AsyncRetry) – 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

None

static common_billing_account_path(billing_account: str) → str¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str¶: Returns a fully-qualified project string.

async 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: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Creates a backup.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import filestore_v1

async def sample_create_backup():
    # Create a client
    client = filestore_v1.CloudFilestoreManagerAsyncClient()

    # Initialize request argument(s)
    request = filestore_v1.CreateBackupRequest(
        parent="parent_value",
        backup_id="backup_id_value",
    )

    # Make the request
    operation = client.create_backup(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.filestore_v1.types.CreateBackupRequest, dict]]) – The request object. CreateBackupRequest creates a backup.
parent (str) –
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.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
backup (google.cloud.filestore_v1.types.Backup) –
Required. A [backup resource][google.cloud.filestore.v1.Backup]

This corresponds to the backup field on the request instance; if request is provided, this should not be set.
backup_id (str) –
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 backup_id field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.filestore_v1.types.Backup A Filestore backup.

Return type

google.api_core.operation_async.AsyncOperation

async 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: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import filestore_v1

async def sample_create_instance():
    # Create a client
    client = filestore_v1.CloudFilestoreManagerAsyncClient()

    # Initialize request argument(s)
    request = filestore_v1.CreateInstanceRequest(
        parent="parent_value",
        instance_id="instance_id_value",
    )

    # Make the request
    operation = client.create_instance(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.filestore_v1.types.CreateInstanceRequest, dict]]) – The request object. CreateInstanceRequest creates an instance.
parent (str) –
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.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
instance (google.cloud.filestore_v1.types.Instance) –
Required. An [instance resource][google.cloud.filestore.v1.Instance]

This corresponds to the instance field on the request instance; if request is provided, this should not be set.
instance_id (str) –
Required. The name of the instance to create. The name must be unique for the specified project and location.

This corresponds to the instance_id field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.filestore_v1.types.Instance A Filestore instance.

Return type

google.api_core.operation_async.AsyncOperation

async create_snapshot(request: Optional[Union[google.cloud.filestore_v1.types.cloud_filestore_service.CreateSnapshotRequest, dict]] = None, *, parent: Optional[str] = None, snapshot: Optional[google.cloud.filestore_v1.types.cloud_filestore_service.Snapshot] = None, snapshot_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Creates a snapshot.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import filestore_v1

async def sample_create_snapshot():
    # Create a client
    client = filestore_v1.CloudFilestoreManagerAsyncClient()

    # Initialize request argument(s)
    request = filestore_v1.CreateSnapshotRequest(
        parent="parent_value",
        snapshot_id="snapshot_id_value",
    )

    # Make the request
    operation = client.create_snapshot(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.filestore_v1.types.CreateSnapshotRequest, dict]]) – The request object. CreateSnapshotRequest creates a snapshot.
parent (str) –
Required. The Filestore Instance to create the snapshots of, in the format projects/{project_id}/locations/{location}/instances/{instance_id}

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
snapshot (google.cloud.filestore_v1.types.Snapshot) – Required. A snapshot resource. This corresponds to the snapshot field on the request instance; if request is provided, this should not be set.
snapshot_id (str) –
Required. The ID to use for the snapshot. The ID must be unique within the specified instance.

This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.

This corresponds to the snapshot_id field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.filestore_v1.types.Snapshot A Filestore snapshot.

Return type

google.api_core.operation_async.AsyncOperation

async delete_backup(request: Optional[Union[google.cloud.filestore_v1.types.cloud_filestore_service.DeleteBackupRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Deletes a backup.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import filestore_v1

async def sample_delete_backup():
    # Create a client
    client = filestore_v1.CloudFilestoreManagerAsyncClient()

    # Initialize request argument(s)
    request = filestore_v1.DeleteBackupRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_backup(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.filestore_v1.types.DeleteBackupRequest, dict]]) – The request object. DeleteBackupRequest deletes a backup.
name (str) –
Required. The backup resource name, in the format projects/{project_number}/locations/{location}/backups/{backup_id}

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

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

}

Return type

google.api_core.operation_async.AsyncOperation

async delete_instance(request: Optional[Union[google.cloud.filestore_v1.types.cloud_filestore_service.DeleteInstanceRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Deletes an instance.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import filestore_v1

async def sample_delete_instance():
    # Create a client
    client = filestore_v1.CloudFilestoreManagerAsyncClient()

    # Initialize request argument(s)
    request = filestore_v1.DeleteInstanceRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_instance(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.filestore_v1.types.DeleteInstanceRequest, dict]]) – The request object. DeleteInstanceRequest deletes an instance.
name (str) –
Required. The instance resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id}

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

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

}

Return type

google.api_core.operation_async.AsyncOperation

async delete_operation(request: Optional[google.longrunning.operations_pb2.DeleteOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

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.

Parameters

request (DeleteOperationRequest) – The request object. Request message for DeleteOperation method.
retry (google.api_core.retry_async.AsyncRetry) – 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

None

async delete_snapshot(request: Optional[Union[google.cloud.filestore_v1.types.cloud_filestore_service.DeleteSnapshotRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Deletes a snapshot.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import filestore_v1

async def sample_delete_snapshot():
    # Create a client
    client = filestore_v1.CloudFilestoreManagerAsyncClient()

    # Initialize request argument(s)
    request = filestore_v1.DeleteSnapshotRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_snapshot(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.filestore_v1.types.DeleteSnapshotRequest, dict]]) – The request object. DeleteSnapshotRequest deletes a snapshot.
name (str) –
Required. The snapshot resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id}/snapshots/{snapshot_id}

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

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

}

Return type

google.api_core.operation_async.AsyncOperation

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: file.

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

CloudFilestoreManagerAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: info.

Parameters

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

CloudFilestoreManagerAsyncClient

classmethod from_service_account_json(filename: str, *args, **kwargs)¶

Creates an instance of this client using the provided credentials: file.

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

CloudFilestoreManagerAsyncClient

async get_backup(request: Optional[Union[google.cloud.filestore_v1.types.cloud_filestore_service.GetBackupRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.filestore_v1.types.cloud_filestore_service.Backup[source]¶

Gets the details of a specific backup.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import filestore_v1

async def sample_get_backup():
    # Create a client
    client = filestore_v1.CloudFilestoreManagerAsyncClient()

    # Initialize request argument(s)
    request = filestore_v1.GetBackupRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_backup(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.filestore_v1.types.GetBackupRequest, dict]]) – The request object. GetBackupRequest gets the state of a backup.
name (str) –
Required. The backup resource name, in the format projects/{project_number}/locations/{location}/backups/{backup_id}.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

A Filestore backup.

Return type

google.cloud.filestore_v1.types.Backup

async get_instance(request: Optional[Union[google.cloud.filestore_v1.types.cloud_filestore_service.GetInstanceRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.filestore_v1.types.cloud_filestore_service.Instance[source]¶

Gets the details of a specific instance.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import filestore_v1

async def sample_get_instance():
    # Create a client
    client = filestore_v1.CloudFilestoreManagerAsyncClient()

    # Initialize request argument(s)
    request = filestore_v1.GetInstanceRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_instance(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.filestore_v1.types.GetInstanceRequest, dict]]) – The request object. GetInstanceRequest gets the state of an instance.
name (str) –
Required. The instance resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id}.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

A Filestore instance.

Return type

google.cloud.filestore_v1.types.Instance

async get_location(request: Optional[google.cloud.location.locations_pb2.GetLocationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.Location[source]¶

Gets information about a location.

Parameters

request (GetLocationRequest) – The request object. Request message for GetLocation method.
retry (google.api_core.retry_async.AsyncRetry) – 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

Location object.

Return type

Location

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not “true”, the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “always”, use the default mTLS endpoint; if the environment variable is “never”, use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

async get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.Operation[source]¶

Gets the latest state of a long-running operation.

Parameters

request (GetOperationRequest) – The request object. Request message for GetOperation method.
retry (google.api_core.retry_async.AsyncRetry) – 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

An Operation object.

Return type

Operation

async get_snapshot(request: Optional[Union[google.cloud.filestore_v1.types.cloud_filestore_service.GetSnapshotRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.filestore_v1.types.cloud_filestore_service.Snapshot[source]¶

Gets the details of a specific snapshot.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import filestore_v1

async def sample_get_snapshot():
    # Create a client
    client = filestore_v1.CloudFilestoreManagerAsyncClient()

    # Initialize request argument(s)
    request = filestore_v1.GetSnapshotRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_snapshot(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.filestore_v1.types.GetSnapshotRequest, dict]]) – The request object. GetSnapshotRequest gets the state of a snapshot.
name (str) –
Required. The snapshot resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id}/snapshots/{snapshot_id}

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

A Filestore snapshot.

Return type

google.cloud.filestore_v1.types.Snapshot

classmethod get_transport_class(label: Optional[str] = None) → Type[google.cloud.filestore_v1.services.cloud_filestore_manager.transports.base.CloudFilestoreManagerTransport]¶

Returns an appropriate transport class.

Parameters: label – The name of the desired transport. If none is provided, then the first transport in the registry is used.
Returns: The transport class to use.

static instance_path(project: str, location: str, instance: str) → str¶: Returns a fully-qualified instance string.

async list_backups(request: Optional[Union[google.cloud.filestore_v1.types.cloud_filestore_service.ListBackupsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.filestore_v1.services.cloud_filestore_manager.pagers.ListBackupsAsyncPager[source]¶

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import filestore_v1

async def sample_list_backups():
    # Create a client
    client = filestore_v1.CloudFilestoreManagerAsyncClient()

    # Initialize request argument(s)
    request = filestore_v1.ListBackupsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_backups(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

request (Optional[Union[google.cloud.filestore_v1.types.ListBackupsRequest, dict]]) – The request object. ListBackupsRequest lists backups.
parent (str) –
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.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

ListBackupsResponse is the result of ListBackupsRequest. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.filestore_v1.services.cloud_filestore_manager.pagers.ListBackupsAsyncPager

async list_instances(request: Optional[Union[google.cloud.filestore_v1.types.cloud_filestore_service.ListInstancesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.filestore_v1.services.cloud_filestore_manager.pagers.ListInstancesAsyncPager[source]¶

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import filestore_v1

async def sample_list_instances():
    # Create a client
    client = filestore_v1.CloudFilestoreManagerAsyncClient()

    # Initialize request argument(s)
    request = filestore_v1.ListInstancesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_instances(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

request (Optional[Union[google.cloud.filestore_v1.types.ListInstancesRequest, dict]]) – The request object. ListInstancesRequest lists instances.
parent (str) –
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.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

ListInstancesResponse is the result of ListInstancesRequest. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.filestore_v1.services.cloud_filestore_manager.pagers.ListInstancesAsyncPager

async list_locations(request: Optional[google.cloud.location.locations_pb2.ListLocationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.ListLocationsResponse[source]¶

Lists information about the supported locations for this service.

Parameters

request (ListLocationsRequest) – The request object. Request message for ListLocations method.
retry (google.api_core.retry_async.AsyncRetry) – 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

Response message for ListLocations method.

Return type

ListLocationsResponse

async list_operations(request: Optional[google.longrunning.operations_pb2.ListOperationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.ListOperationsResponse[source]¶

Lists operations that match the specified filter in the request.

Parameters

request (ListOperationsRequest) – The request object. Request message for ListOperations method.
retry (google.api_core.retry_async.AsyncRetry) – 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

Response message for ListOperations method.

Return type

ListOperationsResponse

async list_snapshots(request: Optional[Union[google.cloud.filestore_v1.types.cloud_filestore_service.ListSnapshotsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.filestore_v1.services.cloud_filestore_manager.pagers.ListSnapshotsAsyncPager[source]¶

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import filestore_v1

async def sample_list_snapshots():
    # Create a client
    client = filestore_v1.CloudFilestoreManagerAsyncClient()

    # Initialize request argument(s)
    request = filestore_v1.ListSnapshotsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_snapshots(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

request (Optional[Union[google.cloud.filestore_v1.types.ListSnapshotsRequest, dict]]) – The request object. ListSnapshotsRequest lists snapshots.
parent (str) –
Required. The instance for which to retrieve snapshot information, in the format projects/{project_id}/locations/{location}/instances/{instance_id}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

ListSnapshotsResponse is the result of ListSnapshotsRequest. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.filestore_v1.services.cloud_filestore_manager.pagers.ListSnapshotsAsyncPager

static parse_backup_path(path: str) → Dict[str, str]¶: Parses a backup path into its component segments.

static parse_common_billing_account_path(path: str) → Dict[str, str]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str]¶: Parse a project path into its component segments.

static parse_instance_path(path: str) → Dict[str, str]¶: Parses a instance path into its component segments.

static parse_snapshot_path(path: str) → Dict[str, str]¶: Parses a snapshot path into its component segments.

async restore_instance(request: Optional[Union[google.cloud.filestore_v1.types.cloud_filestore_service.RestoreInstanceRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import filestore_v1

async def sample_restore_instance():
    # Create a client
    client = filestore_v1.CloudFilestoreManagerAsyncClient()

    # Initialize request argument(s)
    request = filestore_v1.RestoreInstanceRequest(
        source_backup="source_backup_value",
        name="name_value",
        file_share="file_share_value",
    )

    # Make the request
    operation = client.restore_instance(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.filestore_v1.types.RestoreInstanceRequest, dict]]) – The request object. RestoreInstanceRequest restores an existing instance’s file share from a backup.
retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.filestore_v1.types.Instance A Filestore instance.

Return type

google.api_core.operation_async.AsyncOperation

async revert_instance(request: Optional[Union[google.cloud.filestore_v1.types.cloud_filestore_service.RevertInstanceRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import filestore_v1

async def sample_revert_instance():
    # Create a client
    client = filestore_v1.CloudFilestoreManagerAsyncClient()

    # Initialize request argument(s)
    request = filestore_v1.RevertInstanceRequest(
        name="name_value",
        target_snapshot_id="target_snapshot_id_value",
    )

    # Make the request
    operation = client.revert_instance(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.filestore_v1.types.RevertInstanceRequest, dict]]) – The request object. RevertInstanceRequest reverts the given instance’s file share to the specified snapshot.
retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.filestore_v1.types.Instance A Filestore instance.

Return type

google.api_core.operation_async.AsyncOperation

static snapshot_path(project: str, location: str, instance: str, snapshot: str) → str¶: Returns a fully-qualified snapshot string.

property transport: google.cloud.filestore_v1.services.cloud_filestore_manager.transports.base.CloudFilestoreManagerTransport¶

Returns the transport used by the client instance.

Returns: The transport used by the client instance.
Return type: CloudFilestoreManagerTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns

The universe domain used: by the client instance.

Return type

str

async 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: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Updates the settings of a specific backup.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import filestore_v1

async def sample_update_backup():
    # Create a client
    client = filestore_v1.CloudFilestoreManagerAsyncClient()

    # Initialize request argument(s)
    request = filestore_v1.UpdateBackupRequest(
    )

    # Make the request
    operation = client.update_backup(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.filestore_v1.types.UpdateBackupRequest, dict]]) – The request object. UpdateBackupRequest updates description and/or labels for a backup.
backup (google.cloud.filestore_v1.types.Backup) –
Required. A [backup resource][google.cloud.filestore.v1.Backup]

This corresponds to the backup field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Required. Mask of fields to update. At least one path must be supplied in this field.

This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.filestore_v1.types.Backup A Filestore backup.

Return type

google.api_core.operation_async.AsyncOperation

async 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: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Updates the settings of a specific instance.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import filestore_v1

async def sample_update_instance():
    # Create a client
    client = filestore_v1.CloudFilestoreManagerAsyncClient()

    # Initialize request argument(s)
    request = filestore_v1.UpdateInstanceRequest(
    )

    # Make the request
    operation = client.update_instance(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.filestore_v1.types.UpdateInstanceRequest, dict]]) – The request object. UpdateInstanceRequest updates the settings of an instance.
instance (google.cloud.filestore_v1.types.Instance) – Only fields specified in update_mask are updated. This corresponds to the instance field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
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 update_mask field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.filestore_v1.types.Instance A Filestore instance.

Return type

google.api_core.operation_async.AsyncOperation

async update_snapshot(request: Optional[Union[google.cloud.filestore_v1.types.cloud_filestore_service.UpdateSnapshotRequest, dict]] = None, *, snapshot: Optional[google.cloud.filestore_v1.types.cloud_filestore_service.Snapshot] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Updates the settings of a specific snapshot.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import filestore_v1

async def sample_update_snapshot():
    # Create a client
    client = filestore_v1.CloudFilestoreManagerAsyncClient()

    # Initialize request argument(s)
    request = filestore_v1.UpdateSnapshotRequest(
    )

    # Make the request
    operation = client.update_snapshot(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.filestore_v1.types.UpdateSnapshotRequest, dict]]) – The request object. UpdateSnapshotRequest updates description and/or labels for a snapshot.
snapshot (google.cloud.filestore_v1.types.Snapshot) – Required. A snapshot resource. This corresponds to the snapshot field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Required. Mask of fields to update. At least one path must be supplied in this field.

This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.filestore_v1.types.Snapshot A Filestore snapshot.

Return type

google.api_core.operation_async.AsyncOperation

class google.cloud.filestore_v1.services.cloud_filestore_manager.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 = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶

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

Instantiates the cloud filestore manager client.

Parameters

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 (Optional[Union[str,CloudFilestoreManagerTransport,Callable[..., CloudFilestoreManagerTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the CloudFilestoreManagerTransport constructor. If set to None, a transport is chosen automatically.
client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –
Custom options for the client.

1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value).

2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]¶: Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

static backup_path(project: str, location: str, backup: str) → str[source]¶: Returns a fully-qualified backup string.

cancel_operation(request: Optional[google.longrunning.operations_pb2.CancelOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

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.

Parameters

request (CancelOperationRequest) – The request object. Request message for CancelOperation method.
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

None

static common_billing_account_path(billing_account: str) → str[source]¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str[source]¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str[source]¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str[source]¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str[source]¶: Returns a fully-qualified project string.

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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Creates a backup.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import filestore_v1

def sample_create_backup():
    # Create a client
    client = filestore_v1.CloudFilestoreManagerClient()

    # Initialize request argument(s)
    request = filestore_v1.CreateBackupRequest(
        parent="parent_value",
        backup_id="backup_id_value",
    )

    # Make the request
    operation = client.create_backup(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.filestore_v1.types.CreateBackupRequest, dict]) – The request object. CreateBackupRequest creates a backup.
parent (str) –
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.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
backup (google.cloud.filestore_v1.types.Backup) –
Required. A [backup resource][google.cloud.filestore.v1.Backup]

This corresponds to the backup field on the request instance; if request is provided, this should not be set.
backup_id (str) –
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 backup_id field on the request instance; if request is provided, this should not be set.
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

An object representing a long-running operation.

The result type for the operation will be google.cloud.filestore_v1.types.Backup A Filestore backup.

Return type

google.api_core.operation.Operation

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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import filestore_v1

def sample_create_instance():
    # Create a client
    client = filestore_v1.CloudFilestoreManagerClient()

    # Initialize request argument(s)
    request = filestore_v1.CreateInstanceRequest(
        parent="parent_value",
        instance_id="instance_id_value",
    )

    # Make the request
    operation = client.create_instance(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.filestore_v1.types.CreateInstanceRequest, dict]) – The request object. CreateInstanceRequest creates an instance.
parent (str) –
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.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
instance (google.cloud.filestore_v1.types.Instance) –
Required. An [instance resource][google.cloud.filestore.v1.Instance]

This corresponds to the instance field on the request instance; if request is provided, this should not be set.
instance_id (str) –
Required. The name of the instance to create. The name must be unique for the specified project and location.

This corresponds to the instance_id field on the request instance; if request is provided, this should not be set.
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

An object representing a long-running operation.

The result type for the operation will be google.cloud.filestore_v1.types.Instance A Filestore instance.

Return type

google.api_core.operation.Operation

create_snapshot(request: Optional[Union[google.cloud.filestore_v1.types.cloud_filestore_service.CreateSnapshotRequest, dict]] = None, *, parent: Optional[str] = None, snapshot: Optional[google.cloud.filestore_v1.types.cloud_filestore_service.Snapshot] = None, snapshot_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Creates a snapshot.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import filestore_v1

def sample_create_snapshot():
    # Create a client
    client = filestore_v1.CloudFilestoreManagerClient()

    # Initialize request argument(s)
    request = filestore_v1.CreateSnapshotRequest(
        parent="parent_value",
        snapshot_id="snapshot_id_value",
    )

    # Make the request
    operation = client.create_snapshot(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.filestore_v1.types.CreateSnapshotRequest, dict]) – The request object. CreateSnapshotRequest creates a snapshot.
parent (str) –
Required. The Filestore Instance to create the snapshots of, in the format projects/{project_id}/locations/{location}/instances/{instance_id}

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
snapshot (google.cloud.filestore_v1.types.Snapshot) – Required. A snapshot resource. This corresponds to the snapshot field on the request instance; if request is provided, this should not be set.
snapshot_id (str) –
Required. The ID to use for the snapshot. The ID must be unique within the specified instance.

This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.

This corresponds to the snapshot_id field on the request instance; if request is provided, this should not be set.
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

An object representing a long-running operation.

The result type for the operation will be google.cloud.filestore_v1.types.Snapshot A Filestore snapshot.

Return type

google.api_core.operation.Operation

delete_backup(request: Optional[Union[google.cloud.filestore_v1.types.cloud_filestore_service.DeleteBackupRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Deletes a backup.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import filestore_v1

def sample_delete_backup():
    # Create a client
    client = filestore_v1.CloudFilestoreManagerClient()

    # Initialize request argument(s)
    request = filestore_v1.DeleteBackupRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_backup(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.filestore_v1.types.DeleteBackupRequest, dict]) – The request object. DeleteBackupRequest deletes a backup.
name (str) –
Required. The backup resource name, in the format projects/{project_number}/locations/{location}/backups/{backup_id}

This corresponds to the name field on the request instance; if request is provided, this should not be set.
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

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

}

Return type

google.api_core.operation.Operation

delete_instance(request: Optional[Union[google.cloud.filestore_v1.types.cloud_filestore_service.DeleteInstanceRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Deletes an instance.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import filestore_v1

def sample_delete_instance():
    # Create a client
    client = filestore_v1.CloudFilestoreManagerClient()

    # Initialize request argument(s)
    request = filestore_v1.DeleteInstanceRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_instance(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.filestore_v1.types.DeleteInstanceRequest, dict]) – The request object. DeleteInstanceRequest deletes an instance.
name (str) –
Required. The instance resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id}

This corresponds to the name field on the request instance; if request is provided, this should not be set.
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

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

}

Return type

google.api_core.operation.Operation

delete_operation(request: Optional[google.longrunning.operations_pb2.DeleteOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

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.

Parameters

request (DeleteOperationRequest) – The request object. Request message for DeleteOperation method.
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

None

delete_snapshot(request: Optional[Union[google.cloud.filestore_v1.types.cloud_filestore_service.DeleteSnapshotRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Deletes a snapshot.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import filestore_v1

def sample_delete_snapshot():
    # Create a client
    client = filestore_v1.CloudFilestoreManagerClient()

    # Initialize request argument(s)
    request = filestore_v1.DeleteSnapshotRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_snapshot(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.filestore_v1.types.DeleteSnapshotRequest, dict]) – The request object. DeleteSnapshotRequest deletes a snapshot.
name (str) –
Required. The snapshot resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id}/snapshots/{snapshot_id}

This corresponds to the name field on the request instance; if request is provided, this should not be set.
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

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

}

Return type

google.api_core.operation.Operation

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: file.

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

CloudFilestoreManagerClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: info.

Parameters

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

CloudFilestoreManagerClient

classmethod from_service_account_json(filename: str, *args, **kwargs)¶

Creates an instance of this client using the provided credentials: file.

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

CloudFilestoreManagerClient

get_backup(request: Optional[Union[google.cloud.filestore_v1.types.cloud_filestore_service.GetBackupRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.filestore_v1.types.cloud_filestore_service.Backup[source]¶

Gets the details of a specific backup.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import filestore_v1

def sample_get_backup():
    # Create a client
    client = filestore_v1.CloudFilestoreManagerClient()

    # Initialize request argument(s)
    request = filestore_v1.GetBackupRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_backup(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.filestore_v1.types.GetBackupRequest, dict]) – The request object. GetBackupRequest gets the state of a backup.
name (str) –
Required. The backup resource name, in the format projects/{project_number}/locations/{location}/backups/{backup_id}.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
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

A Filestore backup.

Return type

google.cloud.filestore_v1.types.Backup

get_instance(request: Optional[Union[google.cloud.filestore_v1.types.cloud_filestore_service.GetInstanceRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.filestore_v1.types.cloud_filestore_service.Instance[source]¶

Gets the details of a specific instance.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import filestore_v1

def sample_get_instance():
    # Create a client
    client = filestore_v1.CloudFilestoreManagerClient()

    # Initialize request argument(s)
    request = filestore_v1.GetInstanceRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_instance(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.filestore_v1.types.GetInstanceRequest, dict]) – The request object. GetInstanceRequest gets the state of an instance.
name (str) –
Required. The instance resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id}.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
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

A Filestore instance.

Return type

google.cloud.filestore_v1.types.Instance

get_location(request: Optional[google.cloud.location.locations_pb2.GetLocationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.Location[source]¶

Gets information about a location.

Parameters

request (GetLocationRequest) – The request object. Request message for GetLocation method.
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

Location object.

Return type

Location

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

Deprecated. Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not “true”, the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “always”, use the default mTLS endpoint; if the environment variable is “never”, use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.Operation[source]¶

Gets the latest state of a long-running operation.

Parameters

request (GetOperationRequest) – The request object. Request message for GetOperation method.
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

An Operation object.

Return type

Operation

get_snapshot(request: Optional[Union[google.cloud.filestore_v1.types.cloud_filestore_service.GetSnapshotRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.filestore_v1.types.cloud_filestore_service.Snapshot[source]¶

Gets the details of a specific snapshot.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import filestore_v1

def sample_get_snapshot():
    # Create a client
    client = filestore_v1.CloudFilestoreManagerClient()

    # Initialize request argument(s)
    request = filestore_v1.GetSnapshotRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_snapshot(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.filestore_v1.types.GetSnapshotRequest, dict]) – The request object. GetSnapshotRequest gets the state of a snapshot.
name (str) –
Required. The snapshot resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id}/snapshots/{snapshot_id}

This corresponds to the name field on the request instance; if request is provided, this should not be set.
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

A Filestore snapshot.

Return type

google.cloud.filestore_v1.types.Snapshot

static instance_path(project: str, location: str, instance: str) → str[source]¶: Returns a fully-qualified instance string.

list_backups(request: Optional[Union[google.cloud.filestore_v1.types.cloud_filestore_service.ListBackupsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.filestore_v1.services.cloud_filestore_manager.pagers.ListBackupsPager[source]¶

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import filestore_v1

def sample_list_backups():
    # Create a client
    client = filestore_v1.CloudFilestoreManagerClient()

    # Initialize request argument(s)
    request = filestore_v1.ListBackupsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_backups(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.filestore_v1.types.ListBackupsRequest, dict]) – The request object. ListBackupsRequest lists backups.
parent (str) –
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.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
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

ListBackupsResponse is the result of ListBackupsRequest. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.filestore_v1.services.cloud_filestore_manager.pagers.ListBackupsPager

list_instances(request: Optional[Union[google.cloud.filestore_v1.types.cloud_filestore_service.ListInstancesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.filestore_v1.services.cloud_filestore_manager.pagers.ListInstancesPager[source]¶

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import filestore_v1

def sample_list_instances():
    # Create a client
    client = filestore_v1.CloudFilestoreManagerClient()

    # Initialize request argument(s)
    request = filestore_v1.ListInstancesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_instances(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.filestore_v1.types.ListInstancesRequest, dict]) – The request object. ListInstancesRequest lists instances.
parent (str) –
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.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
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

ListInstancesResponse is the result of ListInstancesRequest. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.filestore_v1.services.cloud_filestore_manager.pagers.ListInstancesPager

list_locations(request: Optional[google.cloud.location.locations_pb2.ListLocationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.ListLocationsResponse[source]¶

Lists information about the supported locations for this service.

Parameters

request (ListLocationsRequest) – The request object. Request message for ListLocations method.
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

Response message for ListLocations method.

Return type

ListLocationsResponse

list_operations(request: Optional[google.longrunning.operations_pb2.ListOperationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.ListOperationsResponse[source]¶

Lists operations that match the specified filter in the request.

Parameters

request (ListOperationsRequest) – The request object. Request message for ListOperations method.
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

Response message for ListOperations method.

Return type

ListOperationsResponse

list_snapshots(request: Optional[Union[google.cloud.filestore_v1.types.cloud_filestore_service.ListSnapshotsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.filestore_v1.services.cloud_filestore_manager.pagers.ListSnapshotsPager[source]¶

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import filestore_v1

def sample_list_snapshots():
    # Create a client
    client = filestore_v1.CloudFilestoreManagerClient()

    # Initialize request argument(s)
    request = filestore_v1.ListSnapshotsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_snapshots(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.filestore_v1.types.ListSnapshotsRequest, dict]) – The request object. ListSnapshotsRequest lists snapshots.
parent (str) –
Required. The instance for which to retrieve snapshot information, in the format projects/{project_id}/locations/{location}/instances/{instance_id}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
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

ListSnapshotsResponse is the result of ListSnapshotsRequest. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.filestore_v1.services.cloud_filestore_manager.pagers.ListSnapshotsPager

static parse_backup_path(path: str) → Dict[str, str][source]¶: Parses a backup path into its component segments.

static parse_common_billing_account_path(path: str) → Dict[str, str][source]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str][source]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str][source]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str][source]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str][source]¶: Parse a project path into its component segments.

static parse_instance_path(path: str) → Dict[str, str][source]¶: Parses a instance path into its component segments.

static parse_snapshot_path(path: str) → Dict[str, str][source]¶: Parses a snapshot path into its component segments.

restore_instance(request: Optional[Union[google.cloud.filestore_v1.types.cloud_filestore_service.RestoreInstanceRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import filestore_v1

def sample_restore_instance():
    # Create a client
    client = filestore_v1.CloudFilestoreManagerClient()

    # Initialize request argument(s)
    request = filestore_v1.RestoreInstanceRequest(
        source_backup="source_backup_value",
        name="name_value",
        file_share="file_share_value",
    )

    # Make the request
    operation = client.restore_instance(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.filestore_v1.types.RestoreInstanceRequest, dict]) – The request object. RestoreInstanceRequest restores an existing instance’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

An object representing a long-running operation.

The result type for the operation will be google.cloud.filestore_v1.types.Instance A Filestore instance.

Return type

google.api_core.operation.Operation

revert_instance(request: Optional[Union[google.cloud.filestore_v1.types.cloud_filestore_service.RevertInstanceRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import filestore_v1

def sample_revert_instance():
    # Create a client
    client = filestore_v1.CloudFilestoreManagerClient()

    # Initialize request argument(s)
    request = filestore_v1.RevertInstanceRequest(
        name="name_value",
        target_snapshot_id="target_snapshot_id_value",
    )

    # Make the request
    operation = client.revert_instance(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.filestore_v1.types.RevertInstanceRequest, dict]) – The request object. RevertInstanceRequest reverts the given instance’s file share to the specified snapshot.
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

An object representing a long-running operation.

The result type for the operation will be google.cloud.filestore_v1.types.Instance A Filestore instance.

Return type

google.api_core.operation.Operation

static snapshot_path(project: str, location: str, instance: str, snapshot: str) → str[source]¶: Returns a fully-qualified snapshot string.

property transport: google.cloud.filestore_v1.services.cloud_filestore_manager.transports.base.CloudFilestoreManagerTransport¶

Returns the transport used by the client instance.

Returns

The transport used by the client: instance.

Return type

CloudFilestoreManagerTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns: The universe domain used by the client instance.
Return type: str

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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Updates the settings of a specific backup.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import filestore_v1

def sample_update_backup():
    # Create a client
    client = filestore_v1.CloudFilestoreManagerClient()

    # Initialize request argument(s)
    request = filestore_v1.UpdateBackupRequest(
    )

    # Make the request
    operation = client.update_backup(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.filestore_v1.types.UpdateBackupRequest, dict]) – The request object. UpdateBackupRequest updates description and/or labels for a backup.
backup (google.cloud.filestore_v1.types.Backup) –
Required. A [backup resource][google.cloud.filestore.v1.Backup]

This corresponds to the backup field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Required. Mask of fields to update. At least one path must be supplied in this field.

This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
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

An object representing a long-running operation.

The result type for the operation will be google.cloud.filestore_v1.types.Backup A Filestore backup.

Return type

google.api_core.operation.Operation

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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Updates the settings of a specific instance.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import filestore_v1

def sample_update_instance():
    # Create a client
    client = filestore_v1.CloudFilestoreManagerClient()

    # Initialize request argument(s)
    request = filestore_v1.UpdateInstanceRequest(
    )

    # Make the request
    operation = client.update_instance(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.filestore_v1.types.UpdateInstanceRequest, dict]) – The request object. UpdateInstanceRequest updates the settings of an instance.
instance (google.cloud.filestore_v1.types.Instance) – Only fields specified in update_mask are updated. This corresponds to the instance field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
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 update_mask field on the request instance; if request is provided, this should not be set.
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

An object representing a long-running operation.

The result type for the operation will be google.cloud.filestore_v1.types.Instance A Filestore instance.

Return type

google.api_core.operation.Operation

update_snapshot(request: Optional[Union[google.cloud.filestore_v1.types.cloud_filestore_service.UpdateSnapshotRequest, dict]] = None, *, snapshot: Optional[google.cloud.filestore_v1.types.cloud_filestore_service.Snapshot] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Updates the settings of a specific snapshot.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import filestore_v1

def sample_update_snapshot():
    # Create a client
    client = filestore_v1.CloudFilestoreManagerClient()

    # Initialize request argument(s)
    request = filestore_v1.UpdateSnapshotRequest(
    )

    # Make the request
    operation = client.update_snapshot(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.filestore_v1.types.UpdateSnapshotRequest, dict]) – The request object. UpdateSnapshotRequest updates description and/or labels for a snapshot.
snapshot (google.cloud.filestore_v1.types.Snapshot) – Required. A snapshot resource. This corresponds to the snapshot field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Required. Mask of fields to update. At least one path must be supplied in this field.

This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
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

An object representing a long-running operation.

The result type for the operation will be google.cloud.filestore_v1.types.Snapshot A Filestore snapshot.

Return type

google.api_core.operation.Operation

class google.cloud.filestore_v1.services.cloud_filestore_manager.pagers.ListBackupsAsyncPager(method: Callable[[...], 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: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_backups requests.

This class thinly wraps an initial google.cloud.filestore_v1.types.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 google.cloud.filestore_v1.types.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.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.filestore_v1.types.ListBackupsRequest) – The initial request object.
response (google.cloud.filestore_v1.types.ListBackupsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.filestore_v1.services.cloud_filestore_manager.pagers.ListBackupsPager(method: 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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_backups requests.

This class thinly wraps an initial google.cloud.filestore_v1.types.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 google.cloud.filestore_v1.types.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.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.filestore_v1.types.ListBackupsRequest) – The initial request object.
response (google.cloud.filestore_v1.types.ListBackupsResponse) – The initial response object.
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.

class google.cloud.filestore_v1.services.cloud_filestore_manager.pagers.ListInstancesAsyncPager(method: Callable[[...], 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: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_instances requests.

This class thinly wraps an initial google.cloud.filestore_v1.types.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 google.cloud.filestore_v1.types.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.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.filestore_v1.types.ListInstancesRequest) – The initial request object.
response (google.cloud.filestore_v1.types.ListInstancesResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.filestore_v1.services.cloud_filestore_manager.pagers.ListInstancesPager(method: 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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_instances requests.

This class thinly wraps an initial google.cloud.filestore_v1.types.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 google.cloud.filestore_v1.types.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.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.filestore_v1.types.ListInstancesRequest) – The initial request object.
response (google.cloud.filestore_v1.types.ListInstancesResponse) – The initial response object.
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.

class google.cloud.filestore_v1.services.cloud_filestore_manager.pagers.ListSnapshotsAsyncPager(method: Callable[[...], 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: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_snapshots requests.

This class thinly wraps an initial google.cloud.filestore_v1.types.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 google.cloud.filestore_v1.types.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.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.filestore_v1.types.ListSnapshotsRequest) – The initial request object.
response (google.cloud.filestore_v1.types.ListSnapshotsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.filestore_v1.services.cloud_filestore_manager.pagers.ListSnapshotsPager(method: 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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_snapshots requests.

This class thinly wraps an initial google.cloud.filestore_v1.types.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 google.cloud.filestore_v1.types.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.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.filestore_v1.types.ListSnapshotsRequest) – The initial request object.
response (google.cloud.filestore_v1.types.ListSnapshotsResponse) – The initial response object.
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.

CloudFilestoreManager¶

google-cloud-filestore

Navigation

Related Topics