Google Cloud Managed Lustre V1 API - Class Google::Cloud::Lustre::V1::Instance (v1.1.0)

Reference documentation and code samples for the Google Cloud Managed Lustre V1 API class Google::Cloud::Lustre::V1::Instance.

A Managed Lustre instance.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#access_rules_options

def access_rules_options() -> ::Google::Cloud::Lustre::V1::AccessRulesOptions
Returns

#access_rules_options=

def access_rules_options=(value) -> ::Google::Cloud::Lustre::V1::AccessRulesOptions
Parameter
Returns

#available_version

def available_version() -> ::String
Returns
  • (::String) — Output only. The available version that this instance can be upgraded to. Format: Lustre_YYYYMMDD.NN_pXX

#capacity_gib

def capacity_gib() -> ::Integer
Returns
  • (::Integer) — Required. The storage capacity of the instance in gibibytes (GiB). Allowed values depend on the perUnitStorageThroughput. See Performance tiers for specific minimums, maximums, and step sizes for each performance tier.

#capacity_gib=

def capacity_gib=(value) -> ::Integer
Parameter
  • value (::Integer) — Required. The storage capacity of the instance in gibibytes (GiB). Allowed values depend on the perUnitStorageThroughput. See Performance tiers for specific minimums, maximums, and step sizes for each performance tier.
Returns
  • (::Integer) — Required. The storage capacity of the instance in gibibytes (GiB). Allowed values depend on the perUnitStorageThroughput. See Performance tiers for specific minimums, maximums, and step sizes for each performance tier.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#description

def description() -> ::String
Returns
  • (::String) — Optional. A user-readable description of the instance.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Optional. A user-readable description of the instance.
Returns
  • (::String) — Optional. A user-readable description of the instance.

#dynamic_tier_options

def dynamic_tier_options() -> ::Google::Cloud::Lustre::V1::DynamicTierOptions
Returns

#dynamic_tier_options=

def dynamic_tier_options=(value) -> ::Google::Cloud::Lustre::V1::DynamicTierOptions
Parameter
Returns

#effective_version

def effective_version() -> ::String
Returns
  • (::String) — Output only. The effective version of the instance. Format: Lustre_YYYYMMDD.NN_pXX

#filesystem

def filesystem() -> ::String
Returns
  • (::String) — Required. Immutable. The filesystem name for this instance. This name is used by client-side tools, including when mounting the instance. Must be eight characters or less and can only contain letters and numbers.

#filesystem=

def filesystem=(value) -> ::String
Parameter
  • value (::String) — Required. Immutable. The filesystem name for this instance. This name is used by client-side tools, including when mounting the instance. Must be eight characters or less and can only contain letters and numbers.
Returns
  • (::String) — Required. Immutable. The filesystem name for this instance. This name is used by client-side tools, including when mounting the instance. Must be eight characters or less and can only contain letters and numbers.

#gke_support_enabled

def gke_support_enabled() -> ::Boolean
Returns
  • (::Boolean) — Optional. Deprecated: No longer required for GKE instance creation. Indicates whether you want to enable support for GKE clients. By default, GKE clients are not supported.

#gke_support_enabled=

def gke_support_enabled=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. Deprecated: No longer required for GKE instance creation. Indicates whether you want to enable support for GKE clients. By default, GKE clients are not supported.
Returns
  • (::Boolean) — Optional. Deprecated: No longer required for GKE instance creation. Indicates whether you want to enable support for GKE clients. By default, GKE clients are not supported.

#kms_key

def kms_key() -> ::String
Returns
  • (::String) — Optional. Immutable. The Cloud KMS key name to use for data encryption. If not set, the instance will use Google-managed encryption keys. If set, the instance will use customer-managed encryption keys. The key must be in the same region as the instance. The key format is: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}

#kms_key=

def kms_key=(value) -> ::String
Parameter
  • value (::String) — Optional. Immutable. The Cloud KMS key name to use for data encryption. If not set, the instance will use Google-managed encryption keys. If set, the instance will use customer-managed encryption keys. The key must be in the same region as the instance. The key format is: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}
Returns
  • (::String) — Optional. Immutable. The Cloud KMS key name to use for data encryption. If not set, the instance will use Google-managed encryption keys. If set, the instance will use customer-managed encryption keys. The key must be in the same region as the instance. The key format is: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. Labels as key value pairs.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Optional. Labels as key value pairs.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. Labels as key value pairs.

#maintenance_policy

def maintenance_policy() -> ::Google::Cloud::Lustre::V1::MaintenancePolicy
Returns

#maintenance_policy=

def maintenance_policy=(value) -> ::Google::Cloud::Lustre::V1::MaintenancePolicy
Parameter
Returns

#mount_point

def mount_point() -> ::String
Returns
  • (::String) — Output only. Mount point of the instance in the format IP_ADDRESS@tcp:/FILESYSTEM.

#name

def name() -> ::String
Returns
  • (::String) — Identifier. The name of the instance.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Identifier. The name of the instance.
Returns
  • (::String) — Identifier. The name of the instance.

#network

def network() -> ::String
Returns
  • (::String) — Required. Immutable. The full name of the VPC network to which the instance is connected. Must be in the format projects/{project_id}/global/networks/{network_name}.

#network=

def network=(value) -> ::String
Parameter
  • value (::String) — Required. Immutable. The full name of the VPC network to which the instance is connected. Must be in the format projects/{project_id}/global/networks/{network_name}.
Returns
  • (::String) — Required. Immutable. The full name of the VPC network to which the instance is connected. Must be in the format projects/{project_id}/global/networks/{network_name}.

#per_unit_storage_throughput

def per_unit_storage_throughput() -> ::Integer
Returns
  • (::Integer) — Optional. The throughput of the instance in MBps per TiB. Valid values are 0, 125, 250, 500, 1000. See Performance tiers for more information.

    If the instance is using the Dynamic tier, this field must not be set or must be set to zero.

#per_unit_storage_throughput=

def per_unit_storage_throughput=(value) -> ::Integer
Parameter
  • value (::Integer) — Optional. The throughput of the instance in MBps per TiB. Valid values are 0, 125, 250, 500, 1000. See Performance tiers for more information.

    If the instance is using the Dynamic tier, this field must not be set or must be set to zero.

Returns
  • (::Integer) — Optional. The throughput of the instance in MBps per TiB. Valid values are 0, 125, 250, 500, 1000. See Performance tiers for more information.

    If the instance is using the Dynamic tier, this field must not be set or must be set to zero.

#placement_policy

def placement_policy() -> ::String
Returns
  • (::String) — Optional. The placement policy name for the instance in the format of projects/{project}/locations/{location}/resourcePolicies/{resource_policy}

#placement_policy=

def placement_policy=(value) -> ::String
Parameter
  • value (::String) — Optional. The placement policy name for the instance in the format of projects/{project}/locations/{location}/resourcePolicies/{resource_policy}
Returns
  • (::String) — Optional. The placement policy name for the instance in the format of projects/{project}/locations/{location}/resourcePolicies/{resource_policy}

#state

def state() -> ::Google::Cloud::Lustre::V1::Instance::State
Returns

#state_reason

def state_reason() -> ::String
Returns
  • (::String) — Output only. The reason why the instance is in a certain state (e.g. SUSPENDED).

#target_version

def target_version() -> ::String
Returns
  • (::String) — Optional. The target version of the instance. Setting this field triggers a self-service update to the specified version. Format: Lustre_YYYYMMDD.NN_pXX or latest

#target_version=

def target_version=(value) -> ::String
Parameter
  • value (::String) — Optional. The target version of the instance. Setting this field triggers a self-service update to the specified version. Format: Lustre_YYYYMMDD.NN_pXX or latest
Returns
  • (::String) — Optional. The target version of the instance. Setting this field triggers a self-service update to the specified version. Format: Lustre_YYYYMMDD.NN_pXX or latest

#uid

def uid() -> ::String
Returns
  • (::String) — Output only. Unique ID of the resource. This is unrelated to the access rules which allow specifying the root squash uid.

#upcoming_maintenance_schedule

def upcoming_maintenance_schedule() -> ::Google::Cloud::Lustre::V1::MaintenanceSchedule
Returns

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns