Instance
(
mapping
=
None
,
*
,
ignore_unknown_fields
=
False
,
**
kwargs
)
A Filestore instance.
Attributes
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
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
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.
Classes
LabelsEntry
LabelsEntry
(
mapping
=
None
,
*
,
ignore_unknown_fields
=
False
,
**
kwargs
)
The abstract base class for a message.
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.
State
State
(
value
)
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.
SuspensionReason
SuspensionReason
(
value
)
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.
Tier
Tier
(
value
)
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.
