Class: Google::Cloud::Filestore::V1::Instance

Inherits:

Object

Object
Google::Cloud::Filestore::V1::Instance

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/filestore/v1/cloud_filestore_service.rb

Overview

A Filestore instance.

Defined Under Namespace

Modules: State, SuspensionReason, Tier Classes: LabelsEntry

Instance Attribute Summary collapse

#create_time ⇒ ::Google::Protobuf::Timestamp readonly
Output only.
#description ⇒ ::String
The description of the instance (2048 characters or less).
#etag ⇒ ::String
Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
#file_shares ⇒ ::Array<::Google::Cloud::Filestore::V1::FileShareConfig>
File system shares on the instance.
#kms_key_name ⇒ ::String
KMS key name used for data encryption.
#labels ⇒ ::Google::Protobuf::Map{::String => ::String}
Resource labels to represent user provided metadata.
#name ⇒ ::String readonly
Output only.
#networks ⇒ ::Array<::Google::Cloud::Filestore::V1::NetworkConfig>
VPC networks to which the instance is connected.
#satisfies_pzi ⇒ ::Boolean readonly
Output only.
#satisfies_pzs ⇒ ::Google::Protobuf::BoolValue readonly
Output only.
#state ⇒ ::Google::Cloud::Filestore::V1::Instance::State readonly
Output only.
#status_message ⇒ ::String readonly
Output only.
#suspension_reasons ⇒ ::Array<::Google::Cloud::Filestore::V1::Instance::SuspensionReason> readonly
Output only.
#tier ⇒ ::Google::Cloud::Filestore::V1::Instance::Tier
The service tier of the instance.

Instance Attribute Details

#create_time ⇒ `::Google::Protobuf::Timestamp` (readonly)

Returns Output only. The time when the instance was created.

Returns:

(::Google::Protobuf::Timestamp) —
Output only. The time when the instance was created.

# File 'proto_docs/google/cloud/filestore/v1/cloud_filestore_service.rb', line 227

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The instance state.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The instance is being created.
    CREATING = 1

    # The instance is available for use.
    READY = 2

    # Work is being done on the instance. You can get further details from the
    # `statusMessage` field of the `Instance` resource.
    REPAIRING = 3

    # The instance is shutting down.
    DELETING = 4

    # The instance is experiencing an issue and might be unusable. You can get
    # further details from the `statusMessage` field of the `Instance`
    # resource.
    ERROR = 6

    # The instance is restoring a backup to an existing file share and may be
    # unusable during this time.
    RESTORING = 7

    # The instance is suspended. You can get further details from
    # the `suspension_reasons` field of the `Instance` resource.
    SUSPENDED = 8

    # The instance is in the process of becoming suspended.
    SUSPENDING = 9

    # The instance is in the process of becoming active.
    RESUMING = 10

    # The instance is reverting to a snapshot.
    REVERTING = 12
  end

  # Available service tiers.
  module Tier
    # Not set.
    TIER_UNSPECIFIED = 0

    # STANDARD tier. BASIC_HDD is the preferred term for this tier.
    STANDARD = 1

    # PREMIUM tier. BASIC_SSD is the preferred term for this tier.
    PREMIUM = 2

    # 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_HDD = 3

    # 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.
    BASIC_SSD = 4

    # HIGH_SCALE instances offer expanded capacity and performance scaling
    # capabilities.
    HIGH_SCALE_SSD = 5

    # ENTERPRISE instances offer the features and availability needed for
    # mission-critical workloads.
    ENTERPRISE = 6

    # ZONAL instances offer expanded capacity and performance scaling
    # capabilities.
    ZONAL = 7

    # REGIONAL instances offer the features and availability needed for
    # mission-critical workloads.
    REGIONAL = 8
  end

  # SuspensionReason contains the possible reasons for a suspension.
  module SuspensionReason
    # Not set.
    SUSPENSION_REASON_UNSPECIFIED = 0

    # The KMS key used by the instance is either revoked or denied access to.
    KMS_KEY_ISSUE = 1
  end
end

#description ⇒ `::String`

Returns The description of the instance (2048 characters or less).

Returns:

(::String) —
The description of the instance (2048 characters or less).

# File 'proto_docs/google/cloud/filestore/v1/cloud_filestore_service.rb', line 227

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The instance state.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The instance is being created.
    CREATING = 1

    # The instance is available for use.
    READY = 2

    # Work is being done on the instance. You can get further details from the
    # `statusMessage` field of the `Instance` resource.
    REPAIRING = 3

    # The instance is shutting down.
    DELETING = 4

    # The instance is experiencing an issue and might be unusable. You can get
    # further details from the `statusMessage` field of the `Instance`
    # resource.
    ERROR = 6

    # The instance is restoring a backup to an existing file share and may be
    # unusable during this time.
    RESTORING = 7

    # The instance is suspended. You can get further details from
    # the `suspension_reasons` field of the `Instance` resource.
    SUSPENDED = 8

    # The instance is in the process of becoming suspended.
    SUSPENDING = 9

    # The instance is in the process of becoming active.
    RESUMING = 10

    # The instance is reverting to a snapshot.
    REVERTING = 12
  end

  # Available service tiers.
  module Tier
    # Not set.
    TIER_UNSPECIFIED = 0

    # STANDARD tier. BASIC_HDD is the preferred term for this tier.
    STANDARD = 1

    # PREMIUM tier. BASIC_SSD is the preferred term for this tier.
    PREMIUM = 2

    # 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_HDD = 3

    # 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.
    BASIC_SSD = 4

    # HIGH_SCALE instances offer expanded capacity and performance scaling
    # capabilities.
    HIGH_SCALE_SSD = 5

    # ENTERPRISE instances offer the features and availability needed for
    # mission-critical workloads.
    ENTERPRISE = 6

    # ZONAL instances offer expanded capacity and performance scaling
    # capabilities.
    ZONAL = 7

    # REGIONAL instances offer the features and availability needed for
    # mission-critical workloads.
    REGIONAL = 8
  end

  # SuspensionReason contains the possible reasons for a suspension.
  module SuspensionReason
    # Not set.
    SUSPENSION_REASON_UNSPECIFIED = 0

    # The KMS key used by the instance is either revoked or denied access to.
    KMS_KEY_ISSUE = 1
  end
end

#etag ⇒ `::String`

Returns 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 'proto_docs/google/cloud/filestore/v1/cloud_filestore_service.rb', line 227

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The instance state.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The instance is being created.
    CREATING = 1

    # The instance is available for use.
    READY = 2

    # Work is being done on the instance. You can get further details from the
    # `statusMessage` field of the `Instance` resource.
    REPAIRING = 3

    # The instance is shutting down.
    DELETING = 4

    # The instance is experiencing an issue and might be unusable. You can get
    # further details from the `statusMessage` field of the `Instance`
    # resource.
    ERROR = 6

    # The instance is restoring a backup to an existing file share and may be
    # unusable during this time.
    RESTORING = 7

    # The instance is suspended. You can get further details from
    # the `suspension_reasons` field of the `Instance` resource.
    SUSPENDED = 8

    # The instance is in the process of becoming suspended.
    SUSPENDING = 9

    # The instance is in the process of becoming active.
    RESUMING = 10

    # The instance is reverting to a snapshot.
    REVERTING = 12
  end

  # Available service tiers.
  module Tier
    # Not set.
    TIER_UNSPECIFIED = 0

    # STANDARD tier. BASIC_HDD is the preferred term for this tier.
    STANDARD = 1

    # PREMIUM tier. BASIC_SSD is the preferred term for this tier.
    PREMIUM = 2

    # 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_HDD = 3

    # 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.
    BASIC_SSD = 4

    # HIGH_SCALE instances offer expanded capacity and performance scaling
    # capabilities.
    HIGH_SCALE_SSD = 5

    # ENTERPRISE instances offer the features and availability needed for
    # mission-critical workloads.
    ENTERPRISE = 6

    # ZONAL instances offer expanded capacity and performance scaling
    # capabilities.
    ZONAL = 7

    # REGIONAL instances offer the features and availability needed for
    # mission-critical workloads.
    REGIONAL = 8
  end

  # SuspensionReason contains the possible reasons for a suspension.
  module SuspensionReason
    # Not set.
    SUSPENSION_REASON_UNSPECIFIED = 0

    # The KMS key used by the instance is either revoked or denied access to.
    KMS_KEY_ISSUE = 1
  end
end

#file_shares ⇒ `::Array<::Google::Cloud::Filestore::V1::FileShareConfig>`

Returns 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.

# File 'proto_docs/google/cloud/filestore/v1/cloud_filestore_service.rb', line 227

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The instance state.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The instance is being created.
    CREATING = 1

    # The instance is available for use.
    READY = 2

    # Work is being done on the instance. You can get further details from the
    # `statusMessage` field of the `Instance` resource.
    REPAIRING = 3

    # The instance is shutting down.
    DELETING = 4

    # The instance is experiencing an issue and might be unusable. You can get
    # further details from the `statusMessage` field of the `Instance`
    # resource.
    ERROR = 6

    # The instance is restoring a backup to an existing file share and may be
    # unusable during this time.
    RESTORING = 7

    # The instance is suspended. You can get further details from
    # the `suspension_reasons` field of the `Instance` resource.
    SUSPENDED = 8

    # The instance is in the process of becoming suspended.
    SUSPENDING = 9

    # The instance is in the process of becoming active.
    RESUMING = 10

    # The instance is reverting to a snapshot.
    REVERTING = 12
  end

  # Available service tiers.
  module Tier
    # Not set.
    TIER_UNSPECIFIED = 0

    # STANDARD tier. BASIC_HDD is the preferred term for this tier.
    STANDARD = 1

    # PREMIUM tier. BASIC_SSD is the preferred term for this tier.
    PREMIUM = 2

    # 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_HDD = 3

    # 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.
    BASIC_SSD = 4

    # HIGH_SCALE instances offer expanded capacity and performance scaling
    # capabilities.
    HIGH_SCALE_SSD = 5

    # ENTERPRISE instances offer the features and availability needed for
    # mission-critical workloads.
    ENTERPRISE = 6

    # ZONAL instances offer expanded capacity and performance scaling
    # capabilities.
    ZONAL = 7

    # REGIONAL instances offer the features and availability needed for
    # mission-critical workloads.
    REGIONAL = 8
  end

  # SuspensionReason contains the possible reasons for a suspension.
  module SuspensionReason
    # Not set.
    SUSPENSION_REASON_UNSPECIFIED = 0

    # The KMS key used by the instance is either revoked or denied access to.
    KMS_KEY_ISSUE = 1
  end
end

#kms_key_name ⇒ `::String`

Returns KMS key name used for data encryption.

Returns:

(::String) —
KMS key name used for data encryption.

# File 'proto_docs/google/cloud/filestore/v1/cloud_filestore_service.rb', line 227

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The instance state.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The instance is being created.
    CREATING = 1

    # The instance is available for use.
    READY = 2

    # Work is being done on the instance. You can get further details from the
    # `statusMessage` field of the `Instance` resource.
    REPAIRING = 3

    # The instance is shutting down.
    DELETING = 4

    # The instance is experiencing an issue and might be unusable. You can get
    # further details from the `statusMessage` field of the `Instance`
    # resource.
    ERROR = 6

    # The instance is restoring a backup to an existing file share and may be
    # unusable during this time.
    RESTORING = 7

    # The instance is suspended. You can get further details from
    # the `suspension_reasons` field of the `Instance` resource.
    SUSPENDED = 8

    # The instance is in the process of becoming suspended.
    SUSPENDING = 9

    # The instance is in the process of becoming active.
    RESUMING = 10

    # The instance is reverting to a snapshot.
    REVERTING = 12
  end

  # Available service tiers.
  module Tier
    # Not set.
    TIER_UNSPECIFIED = 0

    # STANDARD tier. BASIC_HDD is the preferred term for this tier.
    STANDARD = 1

    # PREMIUM tier. BASIC_SSD is the preferred term for this tier.
    PREMIUM = 2

    # 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_HDD = 3

    # 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.
    BASIC_SSD = 4

    # HIGH_SCALE instances offer expanded capacity and performance scaling
    # capabilities.
    HIGH_SCALE_SSD = 5

    # ENTERPRISE instances offer the features and availability needed for
    # mission-critical workloads.
    ENTERPRISE = 6

    # ZONAL instances offer expanded capacity and performance scaling
    # capabilities.
    ZONAL = 7

    # REGIONAL instances offer the features and availability needed for
    # mission-critical workloads.
    REGIONAL = 8
  end

  # SuspensionReason contains the possible reasons for a suspension.
  module SuspensionReason
    # Not set.
    SUSPENSION_REASON_UNSPECIFIED = 0

    # The KMS key used by the instance is either revoked or denied access to.
    KMS_KEY_ISSUE = 1
  end
end

#labels ⇒ `::Google::Protobuf::Map{::String => ::String}`

Returns Resource labels to represent user provided metadata.

Returns:

(::Google::Protobuf::Map{::String => ::String}) —
Resource labels to represent user provided metadata.

# File 'proto_docs/google/cloud/filestore/v1/cloud_filestore_service.rb', line 227

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The instance state.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The instance is being created.
    CREATING = 1

    # The instance is available for use.
    READY = 2

    # Work is being done on the instance. You can get further details from the
    # `statusMessage` field of the `Instance` resource.
    REPAIRING = 3

    # The instance is shutting down.
    DELETING = 4

    # The instance is experiencing an issue and might be unusable. You can get
    # further details from the `statusMessage` field of the `Instance`
    # resource.
    ERROR = 6

    # The instance is restoring a backup to an existing file share and may be
    # unusable during this time.
    RESTORING = 7

    # The instance is suspended. You can get further details from
    # the `suspension_reasons` field of the `Instance` resource.
    SUSPENDED = 8

    # The instance is in the process of becoming suspended.
    SUSPENDING = 9

    # The instance is in the process of becoming active.
    RESUMING = 10

    # The instance is reverting to a snapshot.
    REVERTING = 12
  end

  # Available service tiers.
  module Tier
    # Not set.
    TIER_UNSPECIFIED = 0

    # STANDARD tier. BASIC_HDD is the preferred term for this tier.
    STANDARD = 1

    # PREMIUM tier. BASIC_SSD is the preferred term for this tier.
    PREMIUM = 2

    # 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_HDD = 3

    # 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.
    BASIC_SSD = 4

    # HIGH_SCALE instances offer expanded capacity and performance scaling
    # capabilities.
    HIGH_SCALE_SSD = 5

    # ENTERPRISE instances offer the features and availability needed for
    # mission-critical workloads.
    ENTERPRISE = 6

    # ZONAL instances offer expanded capacity and performance scaling
    # capabilities.
    ZONAL = 7

    # REGIONAL instances offer the features and availability needed for
    # mission-critical workloads.
    REGIONAL = 8
  end

  # SuspensionReason contains the possible reasons for a suspension.
  module SuspensionReason
    # Not set.
    SUSPENSION_REASON_UNSPECIFIED = 0

    # The KMS key used by the instance is either revoked or denied access to.
    KMS_KEY_ISSUE = 1
  end
end

#name ⇒ `::String` (readonly)

Returns Output only. The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instance}.

Returns:

(::String) —
Output only. The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instance}.

# File 'proto_docs/google/cloud/filestore/v1/cloud_filestore_service.rb', line 227

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The instance state.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The instance is being created.
    CREATING = 1

    # The instance is available for use.
    READY = 2

    # Work is being done on the instance. You can get further details from the
    # `statusMessage` field of the `Instance` resource.
    REPAIRING = 3

    # The instance is shutting down.
    DELETING = 4

    # The instance is experiencing an issue and might be unusable. You can get
    # further details from the `statusMessage` field of the `Instance`
    # resource.
    ERROR = 6

    # The instance is restoring a backup to an existing file share and may be
    # unusable during this time.
    RESTORING = 7

    # The instance is suspended. You can get further details from
    # the `suspension_reasons` field of the `Instance` resource.
    SUSPENDED = 8

    # The instance is in the process of becoming suspended.
    SUSPENDING = 9

    # The instance is in the process of becoming active.
    RESUMING = 10

    # The instance is reverting to a snapshot.
    REVERTING = 12
  end

  # Available service tiers.
  module Tier
    # Not set.
    TIER_UNSPECIFIED = 0

    # STANDARD tier. BASIC_HDD is the preferred term for this tier.
    STANDARD = 1

    # PREMIUM tier. BASIC_SSD is the preferred term for this tier.
    PREMIUM = 2

    # 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_HDD = 3

    # 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.
    BASIC_SSD = 4

    # HIGH_SCALE instances offer expanded capacity and performance scaling
    # capabilities.
    HIGH_SCALE_SSD = 5

    # ENTERPRISE instances offer the features and availability needed for
    # mission-critical workloads.
    ENTERPRISE = 6

    # ZONAL instances offer expanded capacity and performance scaling
    # capabilities.
    ZONAL = 7

    # REGIONAL instances offer the features and availability needed for
    # mission-critical workloads.
    REGIONAL = 8
  end

  # SuspensionReason contains the possible reasons for a suspension.
  module SuspensionReason
    # Not set.
    SUSPENSION_REASON_UNSPECIFIED = 0

    # The KMS key used by the instance is either revoked or denied access to.
    KMS_KEY_ISSUE = 1
  end
end

#networks ⇒ `::Array<::Google::Cloud::Filestore::V1::NetworkConfig>`

Returns 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.

# File 'proto_docs/google/cloud/filestore/v1/cloud_filestore_service.rb', line 227

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The instance state.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The instance is being created.
    CREATING = 1

    # The instance is available for use.
    READY = 2

    # Work is being done on the instance. You can get further details from the
    # `statusMessage` field of the `Instance` resource.
    REPAIRING = 3

    # The instance is shutting down.
    DELETING = 4

    # The instance is experiencing an issue and might be unusable. You can get
    # further details from the `statusMessage` field of the `Instance`
    # resource.
    ERROR = 6

    # The instance is restoring a backup to an existing file share and may be
    # unusable during this time.
    RESTORING = 7

    # The instance is suspended. You can get further details from
    # the `suspension_reasons` field of the `Instance` resource.
    SUSPENDED = 8

    # The instance is in the process of becoming suspended.
    SUSPENDING = 9

    # The instance is in the process of becoming active.
    RESUMING = 10

    # The instance is reverting to a snapshot.
    REVERTING = 12
  end

  # Available service tiers.
  module Tier
    # Not set.
    TIER_UNSPECIFIED = 0

    # STANDARD tier. BASIC_HDD is the preferred term for this tier.
    STANDARD = 1

    # PREMIUM tier. BASIC_SSD is the preferred term for this tier.
    PREMIUM = 2

    # 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_HDD = 3

    # 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.
    BASIC_SSD = 4

    # HIGH_SCALE instances offer expanded capacity and performance scaling
    # capabilities.
    HIGH_SCALE_SSD = 5

    # ENTERPRISE instances offer the features and availability needed for
    # mission-critical workloads.
    ENTERPRISE = 6

    # ZONAL instances offer expanded capacity and performance scaling
    # capabilities.
    ZONAL = 7

    # REGIONAL instances offer the features and availability needed for
    # mission-critical workloads.
    REGIONAL = 8
  end

  # SuspensionReason contains the possible reasons for a suspension.
  module SuspensionReason
    # Not set.
    SUSPENSION_REASON_UNSPECIFIED = 0

    # The KMS key used by the instance is either revoked or denied access to.
    KMS_KEY_ISSUE = 1
  end
end

#satisfies_pzi ⇒ `::Boolean` (readonly)

Returns Output only. Reserved for future use.

Returns:

(::Boolean) —
Output only. Reserved for future use.

# File 'proto_docs/google/cloud/filestore/v1/cloud_filestore_service.rb', line 227

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The instance state.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The instance is being created.
    CREATING = 1

    # The instance is available for use.
    READY = 2

    # Work is being done on the instance. You can get further details from the
    # `statusMessage` field of the `Instance` resource.
    REPAIRING = 3

    # The instance is shutting down.
    DELETING = 4

    # The instance is experiencing an issue and might be unusable. You can get
    # further details from the `statusMessage` field of the `Instance`
    # resource.
    ERROR = 6

    # The instance is restoring a backup to an existing file share and may be
    # unusable during this time.
    RESTORING = 7

    # The instance is suspended. You can get further details from
    # the `suspension_reasons` field of the `Instance` resource.
    SUSPENDED = 8

    # The instance is in the process of becoming suspended.
    SUSPENDING = 9

    # The instance is in the process of becoming active.
    RESUMING = 10

    # The instance is reverting to a snapshot.
    REVERTING = 12
  end

  # Available service tiers.
  module Tier
    # Not set.
    TIER_UNSPECIFIED = 0

    # STANDARD tier. BASIC_HDD is the preferred term for this tier.
    STANDARD = 1

    # PREMIUM tier. BASIC_SSD is the preferred term for this tier.
    PREMIUM = 2

    # 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_HDD = 3

    # 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.
    BASIC_SSD = 4

    # HIGH_SCALE instances offer expanded capacity and performance scaling
    # capabilities.
    HIGH_SCALE_SSD = 5

    # ENTERPRISE instances offer the features and availability needed for
    # mission-critical workloads.
    ENTERPRISE = 6

    # ZONAL instances offer expanded capacity and performance scaling
    # capabilities.
    ZONAL = 7

    # REGIONAL instances offer the features and availability needed for
    # mission-critical workloads.
    REGIONAL = 8
  end

  # SuspensionReason contains the possible reasons for a suspension.
  module SuspensionReason
    # Not set.
    SUSPENSION_REASON_UNSPECIFIED = 0

    # The KMS key used by the instance is either revoked or denied access to.
    KMS_KEY_ISSUE = 1
  end
end

#satisfies_pzs ⇒ `::Google::Protobuf::BoolValue` (readonly)

Returns Output only. Reserved for future use.

Returns:

(::Google::Protobuf::BoolValue) —
Output only. Reserved for future use.

# File 'proto_docs/google/cloud/filestore/v1/cloud_filestore_service.rb', line 227

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The instance state.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The instance is being created.
    CREATING = 1

    # The instance is available for use.
    READY = 2

    # Work is being done on the instance. You can get further details from the
    # `statusMessage` field of the `Instance` resource.
    REPAIRING = 3

    # The instance is shutting down.
    DELETING = 4

    # The instance is experiencing an issue and might be unusable. You can get
    # further details from the `statusMessage` field of the `Instance`
    # resource.
    ERROR = 6

    # The instance is restoring a backup to an existing file share and may be
    # unusable during this time.
    RESTORING = 7

    # The instance is suspended. You can get further details from
    # the `suspension_reasons` field of the `Instance` resource.
    SUSPENDED = 8

    # The instance is in the process of becoming suspended.
    SUSPENDING = 9

    # The instance is in the process of becoming active.
    RESUMING = 10

    # The instance is reverting to a snapshot.
    REVERTING = 12
  end

  # Available service tiers.
  module Tier
    # Not set.
    TIER_UNSPECIFIED = 0

    # STANDARD tier. BASIC_HDD is the preferred term for this tier.
    STANDARD = 1

    # PREMIUM tier. BASIC_SSD is the preferred term for this tier.
    PREMIUM = 2

    # 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_HDD = 3

    # 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.
    BASIC_SSD = 4

    # HIGH_SCALE instances offer expanded capacity and performance scaling
    # capabilities.
    HIGH_SCALE_SSD = 5

    # ENTERPRISE instances offer the features and availability needed for
    # mission-critical workloads.
    ENTERPRISE = 6

    # ZONAL instances offer expanded capacity and performance scaling
    # capabilities.
    ZONAL = 7

    # REGIONAL instances offer the features and availability needed for
    # mission-critical workloads.
    REGIONAL = 8
  end

  # SuspensionReason contains the possible reasons for a suspension.
  module SuspensionReason
    # Not set.
    SUSPENSION_REASON_UNSPECIFIED = 0

    # The KMS key used by the instance is either revoked or denied access to.
    KMS_KEY_ISSUE = 1
  end
end

#state ⇒ `::Google::Cloud::Filestore::V1::Instance::State` (readonly)

Returns Output only. The instance state.

Returns:

(::Google::Cloud::Filestore::V1::Instance::State) —
Output only. The instance state.

# File 'proto_docs/google/cloud/filestore/v1/cloud_filestore_service.rb', line 227

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The instance state.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The instance is being created.
    CREATING = 1

    # The instance is available for use.
    READY = 2

    # Work is being done on the instance. You can get further details from the
    # `statusMessage` field of the `Instance` resource.
    REPAIRING = 3

    # The instance is shutting down.
    DELETING = 4

    # The instance is experiencing an issue and might be unusable. You can get
    # further details from the `statusMessage` field of the `Instance`
    # resource.
    ERROR = 6

    # The instance is restoring a backup to an existing file share and may be
    # unusable during this time.
    RESTORING = 7

    # The instance is suspended. You can get further details from
    # the `suspension_reasons` field of the `Instance` resource.
    SUSPENDED = 8

    # The instance is in the process of becoming suspended.
    SUSPENDING = 9

    # The instance is in the process of becoming active.
    RESUMING = 10

    # The instance is reverting to a snapshot.
    REVERTING = 12
  end

  # Available service tiers.
  module Tier
    # Not set.
    TIER_UNSPECIFIED = 0

    # STANDARD tier. BASIC_HDD is the preferred term for this tier.
    STANDARD = 1

    # PREMIUM tier. BASIC_SSD is the preferred term for this tier.
    PREMIUM = 2

    # 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_HDD = 3

    # 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.
    BASIC_SSD = 4

    # HIGH_SCALE instances offer expanded capacity and performance scaling
    # capabilities.
    HIGH_SCALE_SSD = 5

    # ENTERPRISE instances offer the features and availability needed for
    # mission-critical workloads.
    ENTERPRISE = 6

    # ZONAL instances offer expanded capacity and performance scaling
    # capabilities.
    ZONAL = 7

    # REGIONAL instances offer the features and availability needed for
    # mission-critical workloads.
    REGIONAL = 8
  end

  # SuspensionReason contains the possible reasons for a suspension.
  module SuspensionReason
    # Not set.
    SUSPENSION_REASON_UNSPECIFIED = 0

    # The KMS key used by the instance is either revoked or denied access to.
    KMS_KEY_ISSUE = 1
  end
end

#status_message ⇒ `::String` (readonly)

Returns Output only. Additional information about the instance state, if available.

Returns:

(::String) —
Output only. Additional information about the instance state, if available.

# File 'proto_docs/google/cloud/filestore/v1/cloud_filestore_service.rb', line 227

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The instance state.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The instance is being created.
    CREATING = 1

    # The instance is available for use.
    READY = 2

    # Work is being done on the instance. You can get further details from the
    # `statusMessage` field of the `Instance` resource.
    REPAIRING = 3

    # The instance is shutting down.
    DELETING = 4

    # The instance is experiencing an issue and might be unusable. You can get
    # further details from the `statusMessage` field of the `Instance`
    # resource.
    ERROR = 6

    # The instance is restoring a backup to an existing file share and may be
    # unusable during this time.
    RESTORING = 7

    # The instance is suspended. You can get further details from
    # the `suspension_reasons` field of the `Instance` resource.
    SUSPENDED = 8

    # The instance is in the process of becoming suspended.
    SUSPENDING = 9

    # The instance is in the process of becoming active.
    RESUMING = 10

    # The instance is reverting to a snapshot.
    REVERTING = 12
  end

  # Available service tiers.
  module Tier
    # Not set.
    TIER_UNSPECIFIED = 0

    # STANDARD tier. BASIC_HDD is the preferred term for this tier.
    STANDARD = 1

    # PREMIUM tier. BASIC_SSD is the preferred term for this tier.
    PREMIUM = 2

    # 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_HDD = 3

    # 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.
    BASIC_SSD = 4

    # HIGH_SCALE instances offer expanded capacity and performance scaling
    # capabilities.
    HIGH_SCALE_SSD = 5

    # ENTERPRISE instances offer the features and availability needed for
    # mission-critical workloads.
    ENTERPRISE = 6

    # ZONAL instances offer expanded capacity and performance scaling
    # capabilities.
    ZONAL = 7

    # REGIONAL instances offer the features and availability needed for
    # mission-critical workloads.
    REGIONAL = 8
  end

  # SuspensionReason contains the possible reasons for a suspension.
  module SuspensionReason
    # Not set.
    SUSPENSION_REASON_UNSPECIFIED = 0

    # The KMS key used by the instance is either revoked or denied access to.
    KMS_KEY_ISSUE = 1
  end
end

#suspension_reasons ⇒ `::Array<::Google::Cloud::Filestore::V1::Instance::SuspensionReason>` (readonly)

Returns Output only. Field indicates all the reasons the instance is in "SUSPENDED" state.

Returns:

(::Array<::Google::Cloud::Filestore::V1::Instance::SuspensionReason>) —
Output only. Field indicates all the reasons the instance is in "SUSPENDED" state.

# File 'proto_docs/google/cloud/filestore/v1/cloud_filestore_service.rb', line 227

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The instance state.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The instance is being created.
    CREATING = 1

    # The instance is available for use.
    READY = 2

    # Work is being done on the instance. You can get further details from the
    # `statusMessage` field of the `Instance` resource.
    REPAIRING = 3

    # The instance is shutting down.
    DELETING = 4

    # The instance is experiencing an issue and might be unusable. You can get
    # further details from the `statusMessage` field of the `Instance`
    # resource.
    ERROR = 6

    # The instance is restoring a backup to an existing file share and may be
    # unusable during this time.
    RESTORING = 7

    # The instance is suspended. You can get further details from
    # the `suspension_reasons` field of the `Instance` resource.
    SUSPENDED = 8

    # The instance is in the process of becoming suspended.
    SUSPENDING = 9

    # The instance is in the process of becoming active.
    RESUMING = 10

    # The instance is reverting to a snapshot.
    REVERTING = 12
  end

  # Available service tiers.
  module Tier
    # Not set.
    TIER_UNSPECIFIED = 0

    # STANDARD tier. BASIC_HDD is the preferred term for this tier.
    STANDARD = 1

    # PREMIUM tier. BASIC_SSD is the preferred term for this tier.
    PREMIUM = 2

    # 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_HDD = 3

    # 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.
    BASIC_SSD = 4

    # HIGH_SCALE instances offer expanded capacity and performance scaling
    # capabilities.
    HIGH_SCALE_SSD = 5

    # ENTERPRISE instances offer the features and availability needed for
    # mission-critical workloads.
    ENTERPRISE = 6

    # ZONAL instances offer expanded capacity and performance scaling
    # capabilities.
    ZONAL = 7

    # REGIONAL instances offer the features and availability needed for
    # mission-critical workloads.
    REGIONAL = 8
  end

  # SuspensionReason contains the possible reasons for a suspension.
  module SuspensionReason
    # Not set.
    SUSPENSION_REASON_UNSPECIFIED = 0

    # The KMS key used by the instance is either revoked or denied access to.
    KMS_KEY_ISSUE = 1
  end
end

#tier ⇒ `::Google::Cloud::Filestore::V1::Instance::Tier`

Returns The service tier of the instance.

Returns:

(::Google::Cloud::Filestore::V1::Instance::Tier) —
The service tier of the instance.

# File 'proto_docs/google/cloud/filestore/v1/cloud_filestore_service.rb', line 227

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The instance state.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The instance is being created.
    CREATING = 1

    # The instance is available for use.
    READY = 2

    # Work is being done on the instance. You can get further details from the
    # `statusMessage` field of the `Instance` resource.
    REPAIRING = 3

    # The instance is shutting down.
    DELETING = 4

    # The instance is experiencing an issue and might be unusable. You can get
    # further details from the `statusMessage` field of the `Instance`
    # resource.
    ERROR = 6

    # The instance is restoring a backup to an existing file share and may be
    # unusable during this time.
    RESTORING = 7

    # The instance is suspended. You can get further details from
    # the `suspension_reasons` field of the `Instance` resource.
    SUSPENDED = 8

    # The instance is in the process of becoming suspended.
    SUSPENDING = 9

    # The instance is in the process of becoming active.
    RESUMING = 10

    # The instance is reverting to a snapshot.
    REVERTING = 12
  end

  # Available service tiers.
  module Tier
    # Not set.
    TIER_UNSPECIFIED = 0

    # STANDARD tier. BASIC_HDD is the preferred term for this tier.
    STANDARD = 1

    # PREMIUM tier. BASIC_SSD is the preferred term for this tier.
    PREMIUM = 2

    # 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_HDD = 3

    # 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.
    BASIC_SSD = 4

    # HIGH_SCALE instances offer expanded capacity and performance scaling
    # capabilities.
    HIGH_SCALE_SSD = 5

    # ENTERPRISE instances offer the features and availability needed for
    # mission-critical workloads.
    ENTERPRISE = 6

    # ZONAL instances offer expanded capacity and performance scaling
    # capabilities.
    ZONAL = 7

    # REGIONAL instances offer the features and availability needed for
    # mission-critical workloads.
    REGIONAL = 8
  end

  # SuspensionReason contains the possible reasons for a suspension.
  module SuspensionReason
    # Not set.
    SUSPENSION_REASON_UNSPECIFIED = 0

    # The KMS key used by the instance is either revoked or denied access to.
    KMS_KEY_ISSUE = 1
  end
end

Class: Google::Cloud::Filestore::V1::Instance

Overview

Defined Under Namespace

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

#description ⇒ ::String

#etag ⇒ ::String

#file_shares ⇒ ::Array<::Google::Cloud::Filestore::V1::FileShareConfig>

#kms_key_name ⇒ ::String

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

#name ⇒ ::String (readonly)

#networks ⇒ ::Array<::Google::Cloud::Filestore::V1::NetworkConfig>

#satisfies_pzi ⇒ ::Boolean (readonly)

#satisfies_pzs ⇒ ::Google::Protobuf::BoolValue (readonly)

#state ⇒ ::Google::Cloud::Filestore::V1::Instance::State (readonly)

#status_message ⇒ ::String (readonly)

#suspension_reasons ⇒ ::Array<::Google::Cloud::Filestore::V1::Instance::SuspensionReason> (readonly)

#tier ⇒ ::Google::Cloud::Filestore::V1::Instance::Tier

#create_time ⇒ `::Google::Protobuf::Timestamp` (readonly)

#description ⇒ `::String`

#etag ⇒ `::String`

#file_shares ⇒ `::Array<::Google::Cloud::Filestore::V1::FileShareConfig>`

#kms_key_name ⇒ `::String`

#labels ⇒ `::Google::Protobuf::Map{::String => ::String}`

#name ⇒ `::String` (readonly)

#networks ⇒ `::Array<::Google::Cloud::Filestore::V1::NetworkConfig>`

#satisfies_pzi ⇒ `::Boolean` (readonly)

#satisfies_pzs ⇒ `::Google::Protobuf::BoolValue` (readonly)

#state ⇒ `::Google::Cloud::Filestore::V1::Instance::State` (readonly)

#status_message ⇒ `::String` (readonly)

#suspension_reasons ⇒ `::Array<::Google::Cloud::Filestore::V1::Instance::SuspensionReason>` (readonly)

#tier ⇒ `::Google::Cloud::Filestore::V1::Instance::Tier`