Class Instance (1.13.0)
Stay organized with collections Save and categorize content based on your preferences.

Instance(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A Filestore instance.

Attributes
Name	Description
`name`	`str` Output only. The resource name of the instance, in the format `projects/{project}/locations/{location}/instances/{instance}`.
`description`	`str` The description of the instance (2048 characters or less).
`state`	`google.cloud.filestore_v1.types.Instance.State` Output only. The instance state.
`status_message`	`str` Output only. Additional information about the instance state, if available.
`create_time`	`google.protobuf.timestamp_pb2.Timestamp` Output only. The time when the instance was created.
`tier`	`google.cloud.filestore_v1.types.Instance.Tier` The service tier of the instance.
`labels`	`MutableMapping[str, str]` Resource labels to represent user provided metadata.
`file_shares`	`MutableSequence[google.cloud.filestore_v1.types.FileShareConfig]` File system shares on the instance. For this version, only a single file share is supported.
`networks`	`MutableSequence[google.cloud.filestore_v1.types.NetworkConfig]` VPC networks to which the instance is connected. For this version, only a single network is supported.
`etag`	`str` Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
`satisfies_pzs`	`google.protobuf.wrappers_pb2.BoolValue` Output only. Reserved for future use.
`satisfies_pzi`	`bool` Output only. Reserved for future use.
`kms_key_name`	`str` KMS key name used for data encryption.
`suspension_reasons`	`MutableSequence[google.cloud.filestore_v1.types.Instance.SuspensionReason]` Output only. Field indicates all the reasons the instance is in "SUSPENDED" state.
`replication`	`google.cloud.filestore_v1.types.Replication` Optional. Replication configuration.
`tags`	`MutableMapping[str, str]` Optional. Input only. Immutable. Tag key-value pairs bound to this resource. Each key must be a namespaced name and each value a short name. Example: "123456789012/environment" : "production", "123456789013/costCenter" : "marketing" See the documentation for more information: - Namespaced name: https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_key - Short name: https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_value
`protocol`	`google.cloud.filestore_v1.types.Instance.FileProtocol` Immutable. The protocol indicates the access protocol for all shares in the instance. This field is immutable and it cannot be changed after the instance has been created. Default value: `NFS_V3`.
`custom_performance_supported`	`bool` Output only. Indicates whether this instance supports configuring its performance. If true, the user can configure the instance's performance by using the 'performance_config' field.
`performance_config`	`google.cloud.filestore_v1.types.Instance.PerformanceConfig` Optional. Used to configure performance.
`performance_limits`	`google.cloud.filestore_v1.types.Instance.PerformanceLimits` Output only. Used for getting performance limits.
`deletion_protection_enabled`	`bool` Optional. Indicates whether the instance is protected against deletion.
`deletion_protection_reason`	`str` Optional. The reason for enabling deletion protection.

Classes

FileProtocol

FileProtocol(value)

File access protocol.

FixedIOPS

FixedIOPS(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

IOPSPerTB

IOPSPerTB(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

LabelsEntry

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

The abstract base class for a message.

Parameters
Name	Description
`kwargs`	`dict` Keys and values corresponding to the fields of the message.
`mapping`	`Union[dict, .Message]` A dictionary or message to be used to determine the values for this message.
`ignore_unknown_fields`	`Optional(bool)` If True, do not raise errors for unknown fields. Only applied if `mapping` is a mapping type or there are keyword parameters.

PerformanceConfig

PerformanceConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

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

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

PerformanceLimits

PerformanceLimits(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

State

State(value)

The instance state.

SuspensionReason

SuspensionReason(value)

SuspensionReason contains the possible reasons for a suspension.

TagsEntry

TagsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)