Reference documentation and code samples for the Filestore V1 API class Google::Cloud::Filestore::V1::Instance.
A Filestore instance.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The time when the instance was created.
#custom_performance_supported
def custom_performance_supported() -> ::Boolean
Returns
- (::Boolean) — 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.
#deletion_protection_enabled
def deletion_protection_enabled() -> ::Boolean
Returns
- (::Boolean) — Optional. Indicates whether the instance is protected against deletion.
#deletion_protection_enabled=
def deletion_protection_enabled=(value) -> ::Boolean
Parameter
- value (::Boolean) — Optional. Indicates whether the instance is protected against deletion.
Returns
- (::Boolean) — Optional. Indicates whether the instance is protected against deletion.
#deletion_protection_reason
def deletion_protection_reason() -> ::String
Returns
- (::String) — Optional. The reason for enabling deletion protection.
#deletion_protection_reason=
def deletion_protection_reason=(value) -> ::String
Parameter
- value (::String) — Optional. The reason for enabling deletion protection.
Returns
- (::String) — Optional. The reason for enabling deletion protection.
#description
def description() -> ::String
Returns
- (::String) — The description of the instance (2048 characters or less).
#description=
def description=(value) -> ::String
Parameter
- value (::String) — The description of the instance (2048 characters or less).
Returns
- (::String) — The description of the instance (2048 characters or less).
#etag
def etag() -> ::String
Returns
- (::String) — Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
#etag=
def etag=(value) -> ::String
Parameter
- value (::String) — Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
Returns
- (::String) — Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
#file_shares
def file_shares() -> ::Array<::Google::Cloud::Filestore::V1::FileShareConfig>
Returns
- (::Array<::Google::Cloud::Filestore::V1::FileShareConfig>) — File system shares on the instance. For this version, only a single file share is supported.
#file_shares=
def file_shares=(value) -> ::Array<::Google::Cloud::Filestore::V1::FileShareConfig>
Parameter
- value (::Array<::Google::Cloud::Filestore::V1::FileShareConfig>) — File system shares on the instance. For this version, only a single file share is supported.
Returns
- (::Array<::Google::Cloud::Filestore::V1::FileShareConfig>) — File system shares on the instance. For this version, only a single file share is supported.
#kms_key_name
def kms_key_name() -> ::String
Returns
- (::String) — KMS key name used for data encryption.
#kms_key_name=
def kms_key_name=(value) -> ::String
Parameter
- value (::String) — KMS key name used for data encryption.
Returns
- (::String) — KMS key name used for data encryption.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Resource labels to represent user provided metadata.
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
- value (::Google::Protobuf::Map{::String => ::String}) — Resource labels to represent user provided metadata.
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Resource labels to represent user provided metadata.
#name
def name() -> ::String
Returns
-
(::String) — Output only. The resource name of the instance, in the format
projects/{project}/locations/{location}/instances/{instance}.
#networks
def networks() -> ::Array<::Google::Cloud::Filestore::V1::NetworkConfig>
Returns
- (::Array<::Google::Cloud::Filestore::V1::NetworkConfig>) — VPC networks to which the instance is connected. For this version, only a single network is supported.
#networks=
def networks=(value) -> ::Array<::Google::Cloud::Filestore::V1::NetworkConfig>
Parameter
- value (::Array<::Google::Cloud::Filestore::V1::NetworkConfig>) — VPC networks to which the instance is connected. For this version, only a single network is supported.
Returns
- (::Array<::Google::Cloud::Filestore::V1::NetworkConfig>) — VPC networks to which the instance is connected. For this version, only a single network is supported.
#performance_config
def performance_config() -> ::Google::Cloud::Filestore::V1::Instance::PerformanceConfig
Returns
- (::Google::Cloud::Filestore::V1::Instance::PerformanceConfig) — Optional. Used to configure performance.
#performance_config=
def performance_config=(value) -> ::Google::Cloud::Filestore::V1::Instance::PerformanceConfig
Parameter
- value (::Google::Cloud::Filestore::V1::Instance::PerformanceConfig) — Optional. Used to configure performance.
Returns
- (::Google::Cloud::Filestore::V1::Instance::PerformanceConfig) — Optional. Used to configure performance.
#performance_limits
def performance_limits() -> ::Google::Cloud::Filestore::V1::Instance::PerformanceLimits
Returns
- (::Google::Cloud::Filestore::V1::Instance::PerformanceLimits) — Output only. Used for getting performance limits.
#protocol
def protocol() -> ::Google::Cloud::Filestore::V1::Instance::FileProtocol
Returns
-
(::Google::Cloud::Filestore::V1::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.
#protocol=
def protocol=(value) -> ::Google::Cloud::Filestore::V1::Instance::FileProtocol
Parameter
-
value (::Google::Cloud::Filestore::V1::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.
Returns
-
(::Google::Cloud::Filestore::V1::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.
#replication
def replication() -> ::Google::Cloud::Filestore::V1::Replication
Returns
- (::Google::Cloud::Filestore::V1::Replication) — Optional. Replication configuration.
#replication=
def replication=(value) -> ::Google::Cloud::Filestore::V1::Replication
Parameter
- value (::Google::Cloud::Filestore::V1::Replication) — Optional. Replication configuration.
Returns
- (::Google::Cloud::Filestore::V1::Replication) — Optional. Replication configuration.
#satisfies_pzi
def satisfies_pzi() -> ::Boolean
Returns
- (::Boolean) — Output only. Reserved for future use.
#satisfies_pzs
def satisfies_pzs() -> ::Google::Protobuf::BoolValue
Returns
- (::Google::Protobuf::BoolValue) — Output only. Reserved for future use.
#state
def state() -> ::Google::Cloud::Filestore::V1::Instance::State
Returns
- (::Google::Cloud::Filestore::V1::Instance::State) — Output only. The instance state.
#status_message
def status_message() -> ::String
Returns
- (::String) — Output only. Additional information about the instance state, if available.
#suspension_reasons
def suspension_reasons() -> ::Array<::Google::Cloud::Filestore::V1::Instance::SuspensionReason>
Returns
- (::Array<::Google::Cloud::Filestore::V1::Instance::SuspensionReason>) — Output only. Field indicates all the reasons the instance is in "SUSPENDED" state.
#tags
def tags() -> ::Google::Protobuf::Map{::String => ::String}
Returns
-
(::Google::Protobuf::Map{::String => ::String}) —
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
#tags=
def tags=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
-
value (::Google::Protobuf::Map{::String => ::String}) —
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
Returns
-
(::Google::Protobuf::Map{::String => ::String}) —
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
#tier
def tier() -> ::Google::Cloud::Filestore::V1::Instance::Tier
Returns
- (::Google::Cloud::Filestore::V1::Instance::Tier) — The service tier of the instance.
#tier=
def tier=(value) -> ::Google::Cloud::Filestore::V1::Instance::Tier
Parameter
- value (::Google::Cloud::Filestore::V1::Instance::Tier) — The service tier of the instance.
Returns
- (::Google::Cloud::Filestore::V1::Instance::Tier) — The service tier of the instance.