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

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/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 (readonly)

Returns Output only. The time when the snapshot is created.

Returns:



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'proto_docs/google/bigtable/admin/v2/table.rb', line 323

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

  # 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 (readonly)

Returns Output only. 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) —

    Output only. 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.



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'proto_docs/google/bigtable/admin/v2/table.rb', line 323

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

  # 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 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) —

    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.



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'proto_docs/google/bigtable/admin/v2/table.rb', line 323

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

  # 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 Description of the snapshot.

Returns:

  • (::String) —

    Description of the snapshot.



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'proto_docs/google/bigtable/admin/v2/table.rb', line 323

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

  # 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 The unique name of the snapshot. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}.

Returns:

  • (::String) —

    The unique name of the snapshot. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}.



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'proto_docs/google/bigtable/admin/v2/table.rb', line 323

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

  # 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::Cloud::Bigtable::Admin::V2::Table (readonly)

Returns Output only. The source table at the time the snapshot was taken.

Returns:



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'proto_docs/google/bigtable/admin/v2/table.rb', line 323

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

  # 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::Cloud::Bigtable::Admin::V2::Snapshot::State (readonly)

Returns Output only. The current state of the snapshot.

Returns:



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'proto_docs/google/bigtable/admin/v2/table.rb', line 323

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

  # 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