instances

Overview

Name	instances
Type	Resource
Id	google.file.instances

Fields

Name	Datatype	Description
name	string	Output only. The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instance}.
description	string	The description of the instance (2048 characters or less).
createTime	string	Output only. The time when the instance was created.
etag	string	Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
state	string	Output only. The instance state.
networks	array	VPC networks to which the instance is connected. For this version, only a single network is supported.
suspensionReasons	array	Output only. Field indicates all the reasons the instance is in "SUSPENDED" state.
tier	string	The service tier of the instance.
kmsKeyName	string	KMS key name used for data encryption.
statusMessage	string	Output only. Additional information about the instance state, if available.
labels	object	Resource labels to represent user provided metadata.
fileShares	array	File system shares on the instance. For this version, only a single file share is supported.
satisfiesPzs	boolean	Output only. Reserved for future use.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	instancesId, locationsId, projectsId	Gets the details of a specific instance.
list	SELECT	locationsId, projectsId	Lists all instances in a project for either a specified location or for all locations.
create	INSERT	locationsId, projectsId	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).
delete	DELETE	instancesId, locationsId, projectsId	Deletes an instance.
_list	EXEC	locationsId, projectsId	Lists all instances in a project for either a specified location or for all locations.
patch	EXEC	instancesId, locationsId, projectsId	Updates the settings of a specific instance.
restore	EXEC	instancesId, locationsId, projectsId	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).
revert	EXEC	instancesId, locationsId, projectsId	Revert an existing instance's file system to a specified snapshot.