Class: Google::Cloud::Spanner::Admin::Instance::V1::FreeInstanceMetadata

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb

Overview

Free instance specific metadata that is kept even after an instance has been upgraded for tracking purposes.

Defined Under Namespace

Modules: ExpireBehavior

Instance Attribute Summary collapse

Instance Attribute Details

#expire_behavior ⇒ ::Google::Cloud::Spanner::Admin::Instance::V1::FreeInstanceMetadata::ExpireBehavior

Returns Specifies the expiration behavior of a free instance. The default of ExpireBehavior is REMOVE_AFTER_GRACE_PERIOD. This can be modified during or after creation, and before expiration.

Returns:



1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
 
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 1022

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

  # Allows users to change behavior when a free instance expires.
  module ExpireBehavior
    # Not specified.
    EXPIRE_BEHAVIOR_UNSPECIFIED = 0

    # When the free instance expires, upgrade the instance to a provisioned
    # instance.
    FREE_TO_PROVISIONED = 1

    # When the free instance expires, disable the instance, and delete it
    # after the grace period passes if it has not been upgraded.
    REMOVE_AFTER_GRACE_PERIOD = 2
  end
end

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

Returns Output only. Timestamp after which the instance will either be upgraded or scheduled for deletion after a grace period. ExpireBehavior is used to choose between upgrading or scheduling the free instance for deletion. This timestamp is set during the creation of a free instance.

Returns:

  • (::Google::Protobuf::Timestamp) —

    Output only. Timestamp after which the instance will either be upgraded or scheduled for deletion after a grace period. ExpireBehavior is used to choose between upgrading or scheduling the free instance for deletion. This timestamp is set during the creation of a free instance.



1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
 
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 1022

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

  # Allows users to change behavior when a free instance expires.
  module ExpireBehavior
    # Not specified.
    EXPIRE_BEHAVIOR_UNSPECIFIED = 0

    # When the free instance expires, upgrade the instance to a provisioned
    # instance.
    FREE_TO_PROVISIONED = 1

    # When the free instance expires, disable the instance, and delete it
    # after the grace period passes if it has not been upgraded.
    REMOVE_AFTER_GRACE_PERIOD = 2
  end
end

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

Returns Output only. If present, the timestamp at which the free instance was upgraded to a provisioned instance.

Returns:



1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
 
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 1022

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

  # Allows users to change behavior when a free instance expires.
  module ExpireBehavior
    # Not specified.
    EXPIRE_BEHAVIOR_UNSPECIFIED = 0

    # When the free instance expires, upgrade the instance to a provisioned
    # instance.
    FREE_TO_PROVISIONED = 1

    # When the free instance expires, disable the instance, and delete it
    # after the grace period passes if it has not been upgraded.
    REMOVE_AFTER_GRACE_PERIOD = 2
  end
end