Reference documentation and code samples for the Google Cloud Filestore V1 Client class Instance.
A Filestore instance.
Generated from protobuf message google.cloud.filestore.v1.Instance
Namespace
Google \ Cloud \ Filestore \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ 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).
↳ state
int
Output only. The instance state.
↳ status_message
string
Output only. Additional information about the instance state, if available.
↳ create_time
↳ tier
int
The service tier of the instance.
↳ labels
↳ file_shares
array< FileShareConfig
>
File system shares on the instance. For this version, only a single file share is supported.
↳ networks
array< NetworkConfig
>
VPC networks to which the instance is connected. For this version, only a single network is supported.
↳ etag
string
Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
↳ satisfies_pzs
↳ satisfies_pzi
bool
Output only. Reserved for future use.
↳ kms_key_name
string
KMS key name used for data encryption.
↳ suspension_reasons
array
Output only. Field indicates all the reasons the instance is in "SUSPENDED" state.
↳ replication
↳ tags
array| Google\Protobuf\Internal\MapField
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
int
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
↳ performance_limits
↳ deletion_protection_enabled
bool
Optional. Indicates whether the instance is protected against deletion.
↳ deletion_protection_reason
string
Optional. The reason for enabling deletion protection.
getName
Output only. The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instance}
.
string
setName
Output only. The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instance}
.
var
string
$this
getDescription
The description of the instance (2048 characters or less).
string
setDescription
The description of the instance (2048 characters or less).
var
string
$this
getState
Output only. The instance state.
int
setState
Output only. The instance state.
var
int
$this
getStatusMessage
Output only. Additional information about the instance state, if available.
string
setStatusMessage
Output only. Additional information about the instance state, if available.
var
string
$this
getCreateTime
Output only. The time when the instance was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time when the instance was created.
$this
getTier
The service tier of the instance.
int
setTier
The service tier of the instance.
var
int
$this
getLabels
Resource labels to represent user provided metadata.
setLabels
Resource labels to represent user provided metadata.
$this
getFileShares
File system shares on the instance.
For this version, only a single file share is supported.
setFileShares
File system shares on the instance.
For this version, only a single file share is supported.
$this
getNetworks
VPC networks to which the instance is connected.
For this version, only a single network is supported.
setNetworks
VPC networks to which the instance is connected.
For this version, only a single network is supported.
$this
getEtag
Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
string
setEtag
Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
var
string
$this
getSatisfiesPzs
Output only. Reserved for future use.
hasSatisfiesPzs
clearSatisfiesPzs
getSatisfiesPzsUnwrapped
Returns the unboxed value from getSatisfiesPzs()
Output only. Reserved for future use.
bool|null
setSatisfiesPzs
Output only. Reserved for future use.
$this
setSatisfiesPzsUnwrapped
Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.
Output only. Reserved for future use.
var
bool|null
$this
getSatisfiesPzi
Output only. Reserved for future use.
bool
setSatisfiesPzi
Output only. Reserved for future use.
var
bool
$this
getKmsKeyName
KMS key name used for data encryption.
string
setKmsKeyName
KMS key name used for data encryption.
var
string
$this
getSuspensionReasons
Output only. Field indicates all the reasons the instance is in "SUSPENDED" state.
setSuspensionReasons
Output only. Field indicates all the reasons the instance is in "SUSPENDED" state.
var
int[]
$this
getReplication
Optional. Replication configuration.
hasReplication
clearReplication
setReplication
Optional. Replication configuration.
$this
getTags
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:
setTags
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:
$this
getProtocol
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
.
int
setProtocol
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
.
var
int
$this
getCustomPerformanceSupported
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.
bool
setCustomPerformanceSupported
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.
var
bool
$this
getPerformanceConfig
Optional. Used to configure performance.
hasPerformanceConfig
clearPerformanceConfig
setPerformanceConfig
Optional. Used to configure performance.
$this
getPerformanceLimits
Output only. Used for getting performance limits.
hasPerformanceLimits
clearPerformanceLimits
setPerformanceLimits
Output only. Used for getting performance limits.
$this
getDeletionProtectionEnabled
Optional. Indicates whether the instance is protected against deletion.
bool
setDeletionProtectionEnabled
Optional. Indicates whether the instance is protected against deletion.
var
bool
$this
getDeletionProtectionReason
Optional. The reason for enabling deletion protection.
string
setDeletionProtectionReason
Optional. The reason for enabling deletion protection.
var
string
$this
