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.

Types for Google Cloud Filestore v1 API

class google.cloud.filestore_v1.types.Backup(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A Filestore backup.

name

Output only. The resource name of the backup, in the format projects/{project_number}/locations/{location_id}/backups/{backup_id}.

Type

str

description

A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.

Type

str

state

Output only. The backup state.

Type

google.cloud.filestore_v1.types.Backup.State

create_time

Output only. The time when the backup was created.

Type

google.protobuf.timestamp_pb2.Timestamp

labels

Resource labels to represent user provided metadata.

Type

MutableMapping[str, str]

capacity_gb

Output only. Capacity of the source file share when the backup was created.

Type

int

storage_bytes

Output only. The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion.

Type

int

source_instance

The resource name of the source Filestore instance, in the format projects/{project_number}/locations/{location_id}/instances/{instance_id}, used to create this backup.

Type

str

source_file_share

Name of the file share in the source Filestore instance that the backup is created from.

Type

str

source_instance_tier

Output only. The service tier of the source Filestore instance that this backup is created from.

Type

google.cloud.filestore_v1.types.Instance.Tier

download_bytes

Output only. Amount of bytes that will be downloaded if the backup is restored. This may be different than storage bytes, since sequential backups of the same disk will share storage.

Type

int

satisfies_pzs

Output only. Reserved for future use.

Type

google.protobuf.wrappers_pb2.BoolValue

satisfies_pzi

Output only. Reserved for future use.

Type

bool

kms_key

Immutable. KMS key name used for data encryption.

Type

str

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class State(value)

Bases: proto.enums.Enum

The backup state.

Values:

STATE_UNSPECIFIED (0):

State not set.

CREATING (1):

Backup is being created.

FINALIZING (2):

Backup has been taken and the operation is being finalized. At this point, changes to the file share will not be reflected in the backup.

READY (3):

Backup is available for use.

DELETING (4):

Backup is being deleted.

INVALID (5):

Backup is not valid and cannot be used for creating new instances or restoring existing instances.

class google.cloud.filestore_v1.types.CreateBackupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

CreateBackupRequest creates a backup.

parent

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.

Type

str

backup

Required. A [backup resource][google.cloud.filestore.v1.Backup]

Type

google.cloud.filestore_v1.types.Backup

backup_id

Required. The ID to use for the backup. The ID must be unique within the specified project and location.

This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. Values that do not match this pattern will trigger an INVALID_ARGUMENT error.

Type

str

class google.cloud.filestore_v1.types.CreateInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

CreateInstanceRequest creates an instance.

parent

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.

Type

str

instance_id

Required. The name of the instance to create. The name must be unique for the specified project and location.

Type

str

instance

Required. An [instance resource][google.cloud.filestore.v1.Instance]

Type

google.cloud.filestore_v1.types.Instance

class google.cloud.filestore_v1.types.CreateSnapshotRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

CreateSnapshotRequest creates a snapshot.

parent

Required. The Filestore Instance to create the snapshots of, in the format projects/{project_id}/locations/{location}/instances/{instance_id}

Type

str

snapshot_id

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.

Type

str

snapshot

Required. A snapshot resource.

Type

google.cloud.filestore_v1.types.Snapshot

class google.cloud.filestore_v1.types.DeleteBackupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

DeleteBackupRequest deletes a backup.

name

Required. The backup resource name, in the format projects/{project_number}/locations/{location}/backups/{backup_id}

Type

str

class google.cloud.filestore_v1.types.DeleteInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

DeleteInstanceRequest deletes an instance.

name

Required. The instance resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id}

Type

str

force

If set to true, all snapshots of the instance will also be deleted. (Otherwise, the request will only work if the instance has no snapshots.)

Type

bool

class google.cloud.filestore_v1.types.DeleteSnapshotRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

DeleteSnapshotRequest deletes a snapshot.

name

Required. The snapshot resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id}/snapshots/{snapshot_id}

Type

str

class google.cloud.filestore_v1.types.FileShareConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

File share configuration for the instance.

name

Required. The name of the file share. Must use 1-16 characters for the basic service tier and 1-63 characters for all other service tiers. Must use lowercase letters, numbers, or underscores [a-z0-9_]. Must start with a letter. Immutable.

Type

str

capacity_gb

File share capacity in gigabytes (GB). Filestore defines 1 GB as 1024^3 bytes.

Type

int

source_backup

The resource name of the backup, in the format projects/{project_number}/locations/{location_id}/backups/{backup_id}, that this file share has been restored from.

This field is a member of oneof source.

Type

str

nfs_export_options

Nfs Export Options. There is a limit of 10 export options per file share.

Type

MutableSequence[google.cloud.filestore_v1.types.NfsExportOptions]

class google.cloud.filestore_v1.types.GetBackupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

GetBackupRequest gets the state of a backup.

name

Required. The backup resource name, in the format projects/{project_number}/locations/{location}/backups/{backup_id}.

Type

str

class google.cloud.filestore_v1.types.GetInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

GetInstanceRequest gets the state of an instance.

name

Required. The instance resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id}.

Type

str

class google.cloud.filestore_v1.types.GetSnapshotRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

GetSnapshotRequest gets the state of a snapshot.

name

Required. The snapshot resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id}/snapshots/{snapshot_id}

Type

str

class google.cloud.filestore_v1.types.Instance(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A Filestore instance.

name

Output only. The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instance}.

Type

str

description

The description of the instance (2048 characters or less).

Type

str

state

Output only. The instance state.

Type

google.cloud.filestore_v1.types.Instance.State

status_message

Output only. Additional information about the instance state, if available.

Type

str

create_time

Output only. The time when the instance was created.

Type

google.protobuf.timestamp_pb2.Timestamp

tier

The service tier of the instance.

Type

google.cloud.filestore_v1.types.Instance.Tier

labels

Resource labels to represent user provided metadata.

Type

MutableMapping[str, str]

file_shares

File system shares on the instance. For this version, only a single file share is supported.

Type

MutableSequence[google.cloud.filestore_v1.types.FileShareConfig]

networks

VPC networks to which the instance is connected. For this version, only a single network is supported.

Type

MutableSequence[google.cloud.filestore_v1.types.NetworkConfig]

etag

Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.

Type

str

satisfies_pzs

Output only. Reserved for future use.

Type

google.protobuf.wrappers_pb2.BoolValue

satisfies_pzi

Output only. Reserved for future use.

Type

bool

kms_key_name

KMS key name used for data encryption.

Type

str

suspension_reasons

Output only. Field indicates all the reasons the instance is in “SUSPENDED” state.

Type

MutableSequence[google.cloud.filestore_v1.types.Instance.SuspensionReason]

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class State(value)

Bases: proto.enums.Enum

The instance state.

Values:

STATE_UNSPECIFIED (0):

State not set.

CREATING (1):

The instance is being created.

READY (2):

The instance is available for use.

REPAIRING (3):

Work is being done on the instance. You can get further details from the statusMessage field of the Instance resource.

DELETING (4):

The instance is shutting down.

ERROR (6):

The instance is experiencing an issue and might be unusable. You can get further details from the statusMessage field of the Instance resource.

RESTORING (7):

The instance is restoring a backup to an existing file share and may be unusable during this time.

SUSPENDED (8):

The instance is suspended. You can get further details from the suspension_reasons field of the Instance resource.

SUSPENDING (9):

The instance is in the process of becoming suspended.

RESUMING (10):

The instance is in the process of becoming active.

REVERTING (12):

The instance is reverting to a snapshot.

class SuspensionReason(value)

Bases: proto.enums.Enum

SuspensionReason contains the possible reasons for a suspension.

Values:

SUSPENSION_REASON_UNSPECIFIED (0):

Not set.

KMS_KEY_ISSUE (1):

The KMS key used by the instance is either revoked or denied access to.

class Tier(value)

Bases: proto.enums.Enum

Available service tiers.

Values:

TIER_UNSPECIFIED (0):

Not set.

STANDARD (1):

STANDARD tier. BASIC_HDD is the preferred term for this tier.

PREMIUM (2):

PREMIUM tier. BASIC_SSD is the preferred term for this tier.

BASIC_HDD (3):

BASIC instances offer a maximum capacity of 63.9 TB. BASIC_HDD is an alias for STANDARD Tier, offering economical performance backed by HDD.

BASIC_SSD (4):

BASIC instances offer a maximum capacity of 63.9 TB. BASIC_SSD is an alias for PREMIUM Tier, and offers improved performance backed by SSD.

HIGH_SCALE_SSD (5):

HIGH_SCALE instances offer expanded capacity and performance scaling capabilities.

ENTERPRISE (6):

ENTERPRISE instances offer the features and availability needed for mission-critical workloads.

ZONAL (7):

ZONAL instances offer expanded capacity and performance scaling capabilities.

REGIONAL (8):

REGIONAL instances offer the features and availability needed for mission-critical workloads.

class google.cloud.filestore_v1.types.ListBackupsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

ListBackupsRequest lists backups.

parent

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.

Type

str

page_size

The maximum number of items to return.

Type

int

page_token

The next_page_token value to use if there are additional results to retrieve for this list request.

Type

str

order_by

Sort results. Supported values are “name”, “name desc” or “” (unsorted).

Type

str

filter

List filter.

Type

str

class google.cloud.filestore_v1.types.ListBackupsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

ListBackupsResponse is the result of ListBackupsRequest.

backups

A list of backups in the project for the specified location.

If the {location} value in the request is “-”, the response contains a list of backups from all locations. If any location is unreachable, the response will only return backups in reachable locations and the “unreachable” field will be populated with a list of unreachable locations.

Type

MutableSequence[google.cloud.filestore_v1.types.Backup]

next_page_token

The token you can use to retrieve the next page of results. Not returned if there are no more results in the list.

Type

str

unreachable

Locations that could not be reached.

Type

MutableSequence[str]

class google.cloud.filestore_v1.types.ListInstancesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

ListInstancesRequest lists instances.

parent

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.

Type

str

page_size

The maximum number of items to return.

Type

int

page_token

The next_page_token value to use if there are additional results to retrieve for this list request.

Type

str

order_by

Sort results. Supported values are “name”, “name desc” or “” (unsorted).

Type

str

filter

List filter.

Type

str

class google.cloud.filestore_v1.types.ListInstancesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

ListInstancesResponse is the result of ListInstancesRequest.

instances

A list of instances in the project for the specified location.

If the {location} value in the request is “-”, the response contains a list of instances from all locations. If any location is unreachable, the response will only return instances in reachable locations and the “unreachable” field will be populated with a list of unreachable locations.

Type

MutableSequence[google.cloud.filestore_v1.types.Instance]

next_page_token

The token you can use to retrieve the next page of results. Not returned if there are no more results in the list.

Type

str

unreachable

Locations that could not be reached.

Type

MutableSequence[str]

class google.cloud.filestore_v1.types.ListSnapshotsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

ListSnapshotsRequest lists snapshots.

parent

Required. The instance for which to retrieve snapshot information, in the format projects/{project_id}/locations/{location}/instances/{instance_id}.

Type

str

page_size

The maximum number of items to return.

Type

int

page_token

The next_page_token value to use if there are additional results to retrieve for this list request.

Type

str

order_by

Sort results. Supported values are “name”, “name desc” or “” (unsorted).

Type

str

filter

List filter.

Type

str

class google.cloud.filestore_v1.types.ListSnapshotsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

ListSnapshotsResponse is the result of ListSnapshotsRequest.

snapshots

A list of snapshots in the project for the specified instance.

Type

MutableSequence[google.cloud.filestore_v1.types.Snapshot]

next_page_token

The token you can use to retrieve the next page of results. Not returned if there are no more results in the list.

Type

str

class google.cloud.filestore_v1.types.NetworkConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Network configuration for the instance.

network

The name of the Google Compute Engine VPC network to which the instance is connected.

Type

str

modes

Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported.

Type

MutableSequence[google.cloud.filestore_v1.types.NetworkConfig.AddressMode]

reserved_ip_range

Optional, reserved_ip_range can have one of the following two types of values.

• CIDR range value when using DIRECT_PEERING connect mode.

• Allocated IP address range when using PRIVATE_SERVICE_ACCESS connect mode.

When the name of an allocated IP address range is specified, it must be one of the ranges associated with the private service access connection. When specified as a direct CIDR value, it must be a /29 CIDR block for Basic tier, a /24 CIDR block for High Scale tier, or a /26 CIDR block for Enterprise tier in one of the internal IP address ranges that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29, 192.168.0.0/24 or 192.168.0.0/26, respectively. The range you specify can’t overlap with either existing subnets or assigned IP address ranges for other Filestore instances in the selected VPC network.

Type

str

ip_addresses

Output only. IPv4 addresses in the format {octet1}.{octet2}.{octet3}.{octet4} or IPv6 addresses in the format {block1}:{block2}:{block3}:{block4}:{block5}:{block6}:{block7}:{block8}.

Type

MutableSequence[str]

connect_mode

The network connect mode of the Filestore instance. If not provided, the connect mode defaults to DIRECT_PEERING.

Type

google.cloud.filestore_v1.types.NetworkConfig.ConnectMode

class AddressMode(value)

Bases: proto.enums.Enum

Internet protocol versions supported by Filestore.

Values:

ADDRESS_MODE_UNSPECIFIED (0):

Internet protocol not set.

MODE_IPV4 (1):

Use the IPv4 internet protocol.

class ConnectMode(value)

Bases: proto.enums.Enum

Available connection modes.

Values:

CONNECT_MODE_UNSPECIFIED (0):

Not set.

DIRECT_PEERING (1):

Connect via direct peering to the Filestore service.

PRIVATE_SERVICE_ACCESS (2):

Connect to your Filestore instance using Private Service Access. Private services access provides an IP address range for multiple Google Cloud services, including Filestore.

class google.cloud.filestore_v1.types.NfsExportOptions(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

NFS export options specifications.

ip_ranges

List of either an IPv4 addresses in the format {octet1}.{octet2}.{octet3}.{octet4} or CIDR ranges in the format {octet1}.{octet2}.{octet3}.{octet4}/{mask size} which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.

Type

MutableSequence[str]

access_mode

Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE.

Type

google.cloud.filestore_v1.types.NfsExportOptions.AccessMode

squash_mode

Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH.

Type

google.cloud.filestore_v1.types.NfsExportOptions.SquashMode

anon_uid

An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.

Type

int

anon_gid

An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.

Type

int

class AccessMode(value)

Bases: proto.enums.Enum

The access mode.

Values:

ACCESS_MODE_UNSPECIFIED (0):

AccessMode not set.

READ_ONLY (1):

The client can only read the file share.

READ_WRITE (2):

The client can read and write the file share (default).

class SquashMode(value)

Bases: proto.enums.Enum

The squash mode.

Values:

SQUASH_MODE_UNSPECIFIED (0):

SquashMode not set.

NO_ROOT_SQUASH (1):

The Root user has root access to the file share (default).

ROOT_SQUASH (2):

The Root user has squashed access to the anonymous uid/gid.

class google.cloud.filestore_v1.types.RestoreInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

RestoreInstanceRequest restores an existing instance’s file share from a backup.

name

Required. The resource name of the instance, in the format projects/{project_number}/locations/{location_id}/instances/{instance_id}.

Type

str

file_share

Required. Name of the file share in the Filestore instance that the backup is being restored to.

Type

str

source_backup

The resource name of the backup, in the format projects/{project_number}/locations/{location_id}/backups/{backup_id}.

This field is a member of oneof source.

Type

str

class google.cloud.filestore_v1.types.RevertInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

RevertInstanceRequest reverts the given instance’s file share to the specified snapshot.

name

Required. projects/{project_id}/locations/{location_id}/instances/{instance_id}. The resource name of the instance, in the format

Type

str

target_snapshot_id

Required. The snapshot resource ID, in the format ‘my-snapshot’, where the specified ID is the {snapshot_id} of the fully qualified name like projects/{project_id}/locations/{location_id}/instances/{instance_id}/snapshots/{snapshot_id}

Type

str

class google.cloud.filestore_v1.types.Snapshot(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A Filestore snapshot.

name

Output only. The resource name of the snapshot, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}/snapshots/{snapshot_id}.

Type

str

description

A description of the snapshot with 2048 characters or less. Requests with longer descriptions will be rejected.

Type

str

state

Output only. The snapshot state.

Type

google.cloud.filestore_v1.types.Snapshot.State

create_time

Output only. The time when the snapshot was created.

Type

google.protobuf.timestamp_pb2.Timestamp

labels

Resource labels to represent user provided metadata.

Type

MutableMapping[str, str]

filesystem_used_bytes

Output only. The amount of bytes needed to allocate a full copy of the snapshot content

Type

int

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class State(value)

Bases: proto.enums.Enum

The snapshot state.

Values:

STATE_UNSPECIFIED (0):

State not set.

CREATING (1):

Snapshot is being created.

READY (2):

Snapshot is available for use.

DELETING (3):

Snapshot is being deleted.

class google.cloud.filestore_v1.types.UpdateBackupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

UpdateBackupRequest updates description and/or labels for a backup.

backup

Required. A [backup resource][google.cloud.filestore.v1.Backup]

Type

google.cloud.filestore_v1.types.Backup

update_mask

Required. Mask of fields to update. At least one path must be supplied in this field.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.filestore_v1.types.UpdateInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

UpdateInstanceRequest updates the settings of an instance.

update_mask

Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields:

• “description”

• “file_shares”

• “labels”.

Type

google.protobuf.field_mask_pb2.FieldMask

instance

Only fields specified in update_mask are updated.

Type

google.cloud.filestore_v1.types.Instance

class google.cloud.filestore_v1.types.UpdateSnapshotRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

UpdateSnapshotRequest updates description and/or labels for a snapshot.

update_mask

Required. Mask of fields to update. At least one path must be supplied in this field.

Type

google.protobuf.field_mask_pb2.FieldMask

snapshot

Required. A snapshot resource.

Type

google.cloud.filestore_v1.types.Snapshot