Class: Google::Cloud::Spanner::Admin::Database::V1::Backup

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

Overview

A backup of a Cloud Spanner database.

Defined Under Namespace

Modules: State

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns Output only. The time the CreateBackup request is received. If the request does not specify version_time, the version_time of the backup will be equivalent to the create_time.

Returns:

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

    Output only. The time the CreateBackup request is received. If the request does not specify version_time, the version_time of the backup will be equivalent to the create_time.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/spanner/admin/database/v1/backup.rb', line 86

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

  # Indicates the current state of the backup.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The pending backup is still being created. Operations on the
    # backup may fail with `FAILED_PRECONDITION` in this state.
    CREATING = 1

    # The backup is complete and ready for use.
    READY = 2
  end
end

#database ⇒ ::String

Returns Required for the CreateBackup operation. Name of the database from which this backup was created. This needs to be in the same instance as the backup. Values are of the form projects/<project>/instances/<instance>/databases/<database>.

Returns:

  • (::String) —

    Required for the CreateBackup operation. Name of the database from which this backup was created. This needs to be in the same instance as the backup. Values are of the form projects/<project>/instances/<instance>/databases/<database>.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/spanner/admin/database/v1/backup.rb', line 86

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

  # Indicates the current state of the backup.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The pending backup is still being created. Operations on the
    # backup may fail with `FAILED_PRECONDITION` in this state.
    CREATING = 1

    # The backup is complete and ready for use.
    READY = 2
  end
end

#encryption_info ⇒ ::Google::Cloud::Spanner::Admin::Database::V1::EncryptionInfo (readonly)

Returns Output only. The encryption information for the backup.

Returns:



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/spanner/admin/database/v1/backup.rb', line 86

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

  # Indicates the current state of the backup.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The pending backup is still being created. Operations on the
    # backup may fail with `FAILED_PRECONDITION` in this state.
    CREATING = 1

    # The backup is complete and ready for use.
    READY = 2
  end
end

#expire_time ⇒ ::Google::Protobuf::Timestamp

Returns Required for the CreateBackup operation. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 366 days from the time the CreateBackup request is processed. Once the expire_time has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup.

Returns:

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

    Required for the CreateBackup operation. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 366 days from the time the CreateBackup request is processed. Once the expire_time has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/spanner/admin/database/v1/backup.rb', line 86

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

  # Indicates the current state of the backup.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The pending backup is still being created. Operations on the
    # backup may fail with `FAILED_PRECONDITION` in this state.
    CREATING = 1

    # The backup is complete and ready for use.
    READY = 2
  end
end

#name ⇒ ::String

Returns Output only for the CreateBackup operation. Required for the UpdateBackup operation.

A globally unique identifier for the backup which cannot be changed. Values are of the form projects/<project>/instances/<instance>/backups/[a-z][a-z0-9_\-]*[a-z0-9] The final segment of the name must be between 2 and 60 characters in length.

The backup is stored in the location(s) specified in the instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form projects/<project>/instances/<instance>.

Returns:

  • (::String) —

    Output only for the CreateBackup operation. Required for the UpdateBackup operation.

    A globally unique identifier for the backup which cannot be changed. Values are of the form projects/<project>/instances/<instance>/backups/[a-z][a-z0-9_\-]*[a-z0-9] The final segment of the name must be between 2 and 60 characters in length.

    The backup is stored in the location(s) specified in the instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form projects/<project>/instances/<instance>.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/spanner/admin/database/v1/backup.rb', line 86

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

  # Indicates the current state of the backup.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The pending backup is still being created. Operations on the
    # backup may fail with `FAILED_PRECONDITION` in this state.
    CREATING = 1

    # The backup is complete and ready for use.
    READY = 2
  end
end

#referencing_databases ⇒ ::Array<::String> (readonly)

Returns Output only. The names of the restored databases that reference the backup. The database names are of the form projects/<project>/instances/<instance>/databases/<database>. Referencing databases may exist in different instances. The existence of any referencing database prevents the backup from being deleted. When a restored database from the backup enters the READY state, the reference to the backup is removed.

Returns:

  • (::Array<::String>) —

    Output only. The names of the restored databases that reference the backup. The database names are of the form projects/<project>/instances/<instance>/databases/<database>. Referencing databases may exist in different instances. The existence of any referencing database prevents the backup from being deleted. When a restored database from the backup enters the READY state, the reference to the backup is removed.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/spanner/admin/database/v1/backup.rb', line 86

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

  # Indicates the current state of the backup.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The pending backup is still being created. Operations on the
    # backup may fail with `FAILED_PRECONDITION` in this state.
    CREATING = 1

    # The backup is complete and ready for use.
    READY = 2
  end
end

#size_bytes ⇒ ::Integer (readonly)

Returns Output only. Size of the backup in bytes.

Returns:

  • (::Integer) —

    Output only. Size of the backup in bytes.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/spanner/admin/database/v1/backup.rb', line 86

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

  # Indicates the current state of the backup.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The pending backup is still being created. Operations on the
    # backup may fail with `FAILED_PRECONDITION` in this state.
    CREATING = 1

    # The backup is complete and ready for use.
    READY = 2
  end
end

#state ⇒ ::Google::Cloud::Spanner::Admin::Database::V1::Backup::State (readonly)

Returns Output only. The current state of the backup.

Returns:



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/spanner/admin/database/v1/backup.rb', line 86

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

  # Indicates the current state of the backup.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The pending backup is still being created. Operations on the
    # backup may fail with `FAILED_PRECONDITION` in this state.
    CREATING = 1

    # The backup is complete and ready for use.
    READY = 2
  end
end

#version_time ⇒ ::Google::Protobuf::Timestamp

Returns The backup will contain an externally consistent copy of the database at the timestamp specified by version_time. If version_time is not specified, the system will set version_time to the create_time of the backup.

Returns:

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

    The backup will contain an externally consistent copy of the database at the timestamp specified by version_time. If version_time is not specified, the system will set version_time to the create_time of the backup.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/spanner/admin/database/v1/backup.rb', line 86

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

  # Indicates the current state of the backup.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The pending backup is still being created. Operations on the
    # backup may fail with `FAILED_PRECONDITION` in this state.
    CREATING = 1

    # The backup is complete and ready for use.
    READY = 2
  end
end