Class: Google::Cloud::Bigtable::Admin::V2::Backup

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 backup of a Cloud Bigtable table.

Defined Under Namespace

Modules: BackupType, State

Instance Attribute Summary collapse

Instance Attribute Details

#backup_type ⇒ ::Google::Cloud::Bigtable::Admin::V2::Backup::BackupType

Returns Indicates the backup type of the backup.

Returns:



585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
 
# File 'proto_docs/google/bigtable/admin/v2/table.rb', line 585

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

  # The type of the backup.
  module BackupType
    # Not specified.
    BACKUP_TYPE_UNSPECIFIED = 0

    # The default type for Cloud Bigtable managed backups. Supported for
    # backups created in both HDD and SSD instances. Requires optimization when
    # restored to a table in an SSD instance.
    STANDARD = 1

    # A backup type with faster restore to SSD performance. Only supported for
    # backups created in SSD instances. A new SSD table restored from a hot
    # backup reaches production performance more quickly than a standard
    # backup.
    HOT = 2
  end
end

#encryption_info ⇒ ::Google::Cloud::Bigtable::Admin::V2::EncryptionInfo (readonly)

Returns Output only. The encryption information for the backup.

Returns:



585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
 
# File 'proto_docs/google/bigtable/admin/v2/table.rb', line 585

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

  # The type of the backup.
  module BackupType
    # Not specified.
    BACKUP_TYPE_UNSPECIFIED = 0

    # The default type for Cloud Bigtable managed backups. Supported for
    # backups created in both HDD and SSD instances. Requires optimization when
    # restored to a table in an SSD instance.
    STANDARD = 1

    # A backup type with faster restore to SSD performance. Only supported for
    # backups created in SSD instances. A new SSD table restored from a hot
    # backup reaches production performance more quickly than a standard
    # backup.
    HOT = 2
  end
end

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

Returns Output only. end_time is the time that the backup was finished. The row data in the backup will be no newer than this timestamp.

Returns:

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

    Output only. end_time is the time that the backup was finished. The row data in the backup will be no newer than this timestamp.



585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
 
# File 'proto_docs/google/bigtable/admin/v2/table.rb', line 585

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

  # The type of the backup.
  module BackupType
    # Not specified.
    BACKUP_TYPE_UNSPECIFIED = 0

    # The default type for Cloud Bigtable managed backups. Supported for
    # backups created in both HDD and SSD instances. Requires optimization when
    # restored to a table in an SSD instance.
    STANDARD = 1

    # A backup type with faster restore to SSD performance. Only supported for
    # backups created in SSD instances. A new SSD table restored from a hot
    # backup reaches production performance more quickly than a standard
    # backup.
    HOT = 2
  end
end

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

Returns Required. The expiration time of the backup. When creating a backup or updating its expire_time, the value must be greater than the backup creation time by:

  • At least 6 hours
  • At most 90 days

Once the expire_time has passed, Cloud Bigtable will delete the backup.

Returns:

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

    Required. The expiration time of the backup. When creating a backup or updating its expire_time, the value must be greater than the backup creation time by:

    • At least 6 hours
    • At most 90 days

    Once the expire_time has passed, Cloud Bigtable will delete the backup.



585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
 
# File 'proto_docs/google/bigtable/admin/v2/table.rb', line 585

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

  # The type of the backup.
  module BackupType
    # Not specified.
    BACKUP_TYPE_UNSPECIFIED = 0

    # The default type for Cloud Bigtable managed backups. Supported for
    # backups created in both HDD and SSD instances. Requires optimization when
    # restored to a table in an SSD instance.
    STANDARD = 1

    # A backup type with faster restore to SSD performance. Only supported for
    # backups created in SSD instances. A new SSD table restored from a hot
    # backup reaches production performance more quickly than a standard
    # backup.
    HOT = 2
  end
end

#hot_to_standard_time ⇒ ::Google::Protobuf::Timestamp

Returns The time at which the hot backup will be converted to a standard backup. Once the hot_to_standard_time has passed, Cloud Bigtable will convert the hot backup to a standard backup. This value must be greater than the backup creation time by:

  • At least 24 hours

This field only applies for hot backups. When creating or updating a standard backup, attempting to set this field will fail the request.

Returns:

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

    The time at which the hot backup will be converted to a standard backup. Once the hot_to_standard_time has passed, Cloud Bigtable will convert the hot backup to a standard backup. This value must be greater than the backup creation time by:

    • At least 24 hours

    This field only applies for hot backups. When creating or updating a standard backup, attempting to set this field will fail the request.



585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
 
# File 'proto_docs/google/bigtable/admin/v2/table.rb', line 585

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

  # The type of the backup.
  module BackupType
    # Not specified.
    BACKUP_TYPE_UNSPECIFIED = 0

    # The default type for Cloud Bigtable managed backups. Supported for
    # backups created in both HDD and SSD instances. Requires optimization when
    # restored to a table in an SSD instance.
    STANDARD = 1

    # A backup type with faster restore to SSD performance. Only supported for
    # backups created in SSD instances. A new SSD table restored from a hot
    # backup reaches production performance more quickly than a standard
    # backup.
    HOT = 2
  end
end

#name ⇒ ::String

Returns A globally unique identifier for the backup which cannot be changed. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}/ backups/[_a-zA-Z0-9][-_.a-zA-Z0-9]* The final segment of the name must be between 1 and 50 characters in length.

The backup is stored in the cluster identified by the prefix of the backup name of the form projects/{project}/instances/{instance}/clusters/{cluster}.

Returns:

  • (::String) —

    A globally unique identifier for the backup which cannot be changed. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}/ backups/[_a-zA-Z0-9][-_.a-zA-Z0-9]* The final segment of the name must be between 1 and 50 characters in length.

    The backup is stored in the cluster identified by the prefix of the backup name of the form projects/{project}/instances/{instance}/clusters/{cluster}.



585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
 
# File 'proto_docs/google/bigtable/admin/v2/table.rb', line 585

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

  # The type of the backup.
  module BackupType
    # Not specified.
    BACKUP_TYPE_UNSPECIFIED = 0

    # The default type for Cloud Bigtable managed backups. Supported for
    # backups created in both HDD and SSD instances. Requires optimization when
    # restored to a table in an SSD instance.
    STANDARD = 1

    # A backup type with faster restore to SSD performance. Only supported for
    # backups created in SSD instances. A new SSD table restored from a hot
    # backup reaches production performance more quickly than a standard
    # backup.
    HOT = 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.



585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
 
# File 'proto_docs/google/bigtable/admin/v2/table.rb', line 585

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

  # The type of the backup.
  module BackupType
    # Not specified.
    BACKUP_TYPE_UNSPECIFIED = 0

    # The default type for Cloud Bigtable managed backups. Supported for
    # backups created in both HDD and SSD instances. Requires optimization when
    # restored to a table in an SSD instance.
    STANDARD = 1

    # A backup type with faster restore to SSD performance. Only supported for
    # backups created in SSD instances. A new SSD table restored from a hot
    # backup reaches production performance more quickly than a standard
    # backup.
    HOT = 2
  end
end

#source_backup ⇒ ::String (readonly)

Returns Output only. Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects//instances//clusters//backups/.

Returns:

  • (::String) —

    Output only. Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects//instances//clusters//backups/



585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
 
# File 'proto_docs/google/bigtable/admin/v2/table.rb', line 585

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

  # The type of the backup.
  module BackupType
    # Not specified.
    BACKUP_TYPE_UNSPECIFIED = 0

    # The default type for Cloud Bigtable managed backups. Supported for
    # backups created in both HDD and SSD instances. Requires optimization when
    # restored to a table in an SSD instance.
    STANDARD = 1

    # A backup type with faster restore to SSD performance. Only supported for
    # backups created in SSD instances. A new SSD table restored from a hot
    # backup reaches production performance more quickly than a standard
    # backup.
    HOT = 2
  end
end

#source_table ⇒ ::String

Returns Required. Immutable. Name of the table 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}/tables/{source_table}.

Returns:

  • (::String) —

    Required. Immutable. Name of the table 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}/tables/{source_table}.



585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
 
# File 'proto_docs/google/bigtable/admin/v2/table.rb', line 585

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

  # The type of the backup.
  module BackupType
    # Not specified.
    BACKUP_TYPE_UNSPECIFIED = 0

    # The default type for Cloud Bigtable managed backups. Supported for
    # backups created in both HDD and SSD instances. Requires optimization when
    # restored to a table in an SSD instance.
    STANDARD = 1

    # A backup type with faster restore to SSD performance. Only supported for
    # backups created in SSD instances. A new SSD table restored from a hot
    # backup reaches production performance more quickly than a standard
    # backup.
    HOT = 2
  end
end

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

Returns Output only. start_time is the time that the backup was started (i.e. approximately the time the CreateBackup request is received). The row data in this backup will be no older than this timestamp.

Returns:

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

    Output only. start_time is the time that the backup was started (i.e. approximately the time the CreateBackup request is received). The row data in this backup will be no older than this timestamp.



585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
 
# File 'proto_docs/google/bigtable/admin/v2/table.rb', line 585

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

  # The type of the backup.
  module BackupType
    # Not specified.
    BACKUP_TYPE_UNSPECIFIED = 0

    # The default type for Cloud Bigtable managed backups. Supported for
    # backups created in both HDD and SSD instances. Requires optimization when
    # restored to a table in an SSD instance.
    STANDARD = 1

    # A backup type with faster restore to SSD performance. Only supported for
    # backups created in SSD instances. A new SSD table restored from a hot
    # backup reaches production performance more quickly than a standard
    # backup.
    HOT = 2
  end
end

#state ⇒ ::Google::Cloud::Bigtable::Admin::V2::Backup::State (readonly)

Returns Output only. The current state of the backup.

Returns:



585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
 
# File 'proto_docs/google/bigtable/admin/v2/table.rb', line 585

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

  # The type of the backup.
  module BackupType
    # Not specified.
    BACKUP_TYPE_UNSPECIFIED = 0

    # The default type for Cloud Bigtable managed backups. Supported for
    # backups created in both HDD and SSD instances. Requires optimization when
    # restored to a table in an SSD instance.
    STANDARD = 1

    # A backup type with faster restore to SSD performance. Only supported for
    # backups created in SSD instances. A new SSD table restored from a hot
    # backup reaches production performance more quickly than a standard
    # backup.
    HOT = 2
  end
end