Class: Google::Bigtable::Admin::V2::Snapshot

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/table.rb

Overview

A snapshot of a table at a particular time. A snapshot can be used as a checkpoint for data restoration or a data source for a new table.

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

Defined Under Namespace

Modules: State

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ Google::Protobuf::Timestamp

Returns (OutputOnly) The time when the snapshot is created.

Returns:



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/table.rb', line 192

class Snapshot
  # Possible states of a snapshot.
  module State
    # The state of the snapshot could not be determined.
    STATE_NOT_KNOWN = 0

    # The snapshot has been successfully created and can serve all requests.
    READY = 1

    # The snapshot is currently being created, and may be destroyed if the
    # creation process encounters an error. A snapshot may not be restored to a
    # table while it is being created.
    CREATING = 2
  end
end

#data_size_bytes ⇒ Integer

Returns (OutputOnly) The size of the data in the source table at the time the snapshot was taken. In some cases, this value may be computed asynchronously via a background process and a placeholder of 0 will be used in the meantime.

Returns:

  • (Integer) —

    (OutputOnly) The size of the data in the source table at the time the snapshot was taken. In some cases, this value may be computed asynchronously via a background process and a placeholder of 0 will be used in the meantime.



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/table.rb', line 192

class Snapshot
  # Possible states of a snapshot.
  module State
    # The state of the snapshot could not be determined.
    STATE_NOT_KNOWN = 0

    # The snapshot has been successfully created and can serve all requests.
    READY = 1

    # The snapshot is currently being created, and may be destroyed if the
    # creation process encounters an error. A snapshot may not be restored to a
    # table while it is being created.
    CREATING = 2
  end
end

#delete_time ⇒ Google::Protobuf::Timestamp

Returns (OutputOnly) The time when the snapshot will be deleted. The maximum amount of time a snapshot can stay active is 365 days. If 'ttl' is not specified, the default maximum of 365 days will be used.

Returns:

  • (Google::Protobuf::Timestamp) —

    (OutputOnly) The time when the snapshot will be deleted. The maximum amount of time a snapshot can stay active is 365 days. If 'ttl' is not specified, the default maximum of 365 days will be used.



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/table.rb', line 192

class Snapshot
  # Possible states of a snapshot.
  module State
    # The state of the snapshot could not be determined.
    STATE_NOT_KNOWN = 0

    # The snapshot has been successfully created and can serve all requests.
    READY = 1

    # The snapshot is currently being created, and may be destroyed if the
    # creation process encounters an error. A snapshot may not be restored to a
    # table while it is being created.
    CREATING = 2
  end
end

#description ⇒ String

Returns (OutputOnly) Description of the snapshot.

Returns:

  • (String) —

    (OutputOnly) Description of the snapshot.



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/table.rb', line 192

class Snapshot
  # Possible states of a snapshot.
  module State
    # The state of the snapshot could not be determined.
    STATE_NOT_KNOWN = 0

    # The snapshot has been successfully created and can serve all requests.
    READY = 1

    # The snapshot is currently being created, and may be destroyed if the
    # creation process encounters an error. A snapshot may not be restored to a
    # table while it is being created.
    CREATING = 2
  end
end

#name ⇒ String

Returns (OutputOnly) The unique name of the snapshot. Values are of the form projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/<snapshot>.

Returns:

  • (String) —

    (OutputOnly) The unique name of the snapshot. Values are of the form projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/<snapshot>.



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/table.rb', line 192

class Snapshot
  # Possible states of a snapshot.
  module State
    # The state of the snapshot could not be determined.
    STATE_NOT_KNOWN = 0

    # The snapshot has been successfully created and can serve all requests.
    READY = 1

    # The snapshot is currently being created, and may be destroyed if the
    # creation process encounters an error. A snapshot may not be restored to a
    # table while it is being created.
    CREATING = 2
  end
end

#source_table ⇒ Google::Bigtable::Admin::V2::Table

Returns (OutputOnly) The source table at the time the snapshot was taken.

Returns:



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/table.rb', line 192

class Snapshot
  # Possible states of a snapshot.
  module State
    # The state of the snapshot could not be determined.
    STATE_NOT_KNOWN = 0

    # The snapshot has been successfully created and can serve all requests.
    READY = 1

    # The snapshot is currently being created, and may be destroyed if the
    # creation process encounters an error. A snapshot may not be restored to a
    # table while it is being created.
    CREATING = 2
  end
end

#state ⇒ Google::Bigtable::Admin::V2::Snapshot::State

Returns (OutputOnly) The current state of the snapshot.

Returns:



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/table.rb', line 192

class Snapshot
  # Possible states of a snapshot.
  module State
    # The state of the snapshot could not be determined.
    STATE_NOT_KNOWN = 0

    # The snapshot has been successfully created and can serve all requests.
    READY = 1

    # The snapshot is currently being created, and may be destroyed if the
    # creation process encounters an error. A snapshot may not be restored to a
    # table while it is being created.
    CREATING = 2
  end
end