Class: Google::Bigtable::Admin::V2::Table

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

Overview

A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster.

Defined Under Namespace

Modules: TimestampGranularity, View Classes: ClusterState

Instance Attribute Summary collapse

Instance Attribute Details

#cluster_states ⇒ Hash{String => Google::Bigtable::Admin::V2::Table::ClusterState}

Returns (+OutputOnly+) Map from cluster ID to per-cluster table state. If it could not be determined whether or not the table has data in a particular cluster (for example, if its zone is unavailable), then there will be an entry for the cluster with UNKNOWN +replication_status+. Views: +REPLICATION_VIEW+, +FULL+

Returns:

  • (Hash{String => Google::Bigtable::Admin::V2::Table::ClusterState}) —

    (+OutputOnly+) Map from cluster ID to per-cluster table state. If it could not be determined whether or not the table has data in a particular cluster (for example, if its zone is unavailable), then there will be an entry for the cluster with UNKNOWN +replication_status+. Views: +REPLICATION_VIEW+, +FULL+



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/table.rb', line 47

class Table
  # The state of a table's data in a particular cluster.
  # @!attribute [rw] replication_state
  #   @return [Google::Bigtable::Admin::V2::Table::ClusterState::ReplicationState]
  #     (+OutputOnly+)
  #     The state of replication for the table in this cluster.
  class ClusterState
    # Table replication states.
    module ReplicationState
      # The replication state of the table is unknown in this cluster.
      STATE_NOT_KNOWN = 0

      # The cluster was recently created, and the table must finish copying
      # over pre-existing data from other clusters before it can begin
      # receiving live replication updates and serving Data API requests.
      INITIALIZING = 1

      # The table is temporarily unable to serve Data API requests from this
      # cluster due to planned internal maintenance.
      PLANNED_MAINTENANCE = 2

      # The table is temporarily unable to serve Data API requests from this
      # cluster due to unplanned or emergency maintenance.
      UNPLANNED_MAINTENANCE = 3

      # The table can serve Data API requests from this cluster. Depending on
      # replication delay, reads may not immediately reflect the state of the
      # table in other clusters.
      READY = 4
    end
  end

  # Possible timestamp granularities to use when keeping multiple versions
  # of data in a table.
  module TimestampGranularity
    # The user did not specify a granularity. Should not be returned.
    # When specified during table creation, MILLIS will be used.
    TIMESTAMP_GRANULARITY_UNSPECIFIED = 0

    # The table keeps data versioned at a granularity of 1ms.
    MILLIS = 1
  end

  # Defines a view over a table's fields.
  module View
    # Uses the default view for each method as documented in its request.
    VIEW_UNSPECIFIED = 0

    # Only populates +name+.
    NAME_ONLY = 1

    # Only populates +name+ and fields related to the table's schema.
    SCHEMA_VIEW = 2

    # Only populates +name+ and fields related to the table's
    # replication state.
    REPLICATION_VIEW = 3

    # Populates all fields.
    FULL = 4
  end
end

#column_families ⇒ Hash{String => Google::Bigtable::Admin::V2::ColumnFamily}

Returns (+CreationOnly+) The column families configured for this table, mapped by column family ID. Views: +SCHEMA_VIEW+, +FULL+

Returns:



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/table.rb', line 47

class Table
  # The state of a table's data in a particular cluster.
  # @!attribute [rw] replication_state
  #   @return [Google::Bigtable::Admin::V2::Table::ClusterState::ReplicationState]
  #     (+OutputOnly+)
  #     The state of replication for the table in this cluster.
  class ClusterState
    # Table replication states.
    module ReplicationState
      # The replication state of the table is unknown in this cluster.
      STATE_NOT_KNOWN = 0

      # The cluster was recently created, and the table must finish copying
      # over pre-existing data from other clusters before it can begin
      # receiving live replication updates and serving Data API requests.
      INITIALIZING = 1

      # The table is temporarily unable to serve Data API requests from this
      # cluster due to planned internal maintenance.
      PLANNED_MAINTENANCE = 2

      # The table is temporarily unable to serve Data API requests from this
      # cluster due to unplanned or emergency maintenance.
      UNPLANNED_MAINTENANCE = 3

      # The table can serve Data API requests from this cluster. Depending on
      # replication delay, reads may not immediately reflect the state of the
      # table in other clusters.
      READY = 4
    end
  end

  # Possible timestamp granularities to use when keeping multiple versions
  # of data in a table.
  module TimestampGranularity
    # The user did not specify a granularity. Should not be returned.
    # When specified during table creation, MILLIS will be used.
    TIMESTAMP_GRANULARITY_UNSPECIFIED = 0

    # The table keeps data versioned at a granularity of 1ms.
    MILLIS = 1
  end

  # Defines a view over a table's fields.
  module View
    # Uses the default view for each method as documented in its request.
    VIEW_UNSPECIFIED = 0

    # Only populates +name+.
    NAME_ONLY = 1

    # Only populates +name+ and fields related to the table's schema.
    SCHEMA_VIEW = 2

    # Only populates +name+ and fields related to the table's
    # replication state.
    REPLICATION_VIEW = 3

    # Populates all fields.
    FULL = 4
  end
end

#granularity ⇒ Google::Bigtable::Admin::V2::Table::TimestampGranularity

Returns (+CreationOnly+) The granularity (i.e. +MILLIS+) at which timestamps are stored in this table. Timestamps not matching the granularity will be rejected. If unspecified at creation time, the value will be set to +MILLIS+. Views: +SCHEMA_VIEW+, +FULL+

Returns:

  • (Google::Bigtable::Admin::V2::Table::TimestampGranularity) —

    (+CreationOnly+) The granularity (i.e. +MILLIS+) at which timestamps are stored in this table. Timestamps not matching the granularity will be rejected. If unspecified at creation time, the value will be set to +MILLIS+. Views: +SCHEMA_VIEW+, +FULL+



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/table.rb', line 47

class Table
  # The state of a table's data in a particular cluster.
  # @!attribute [rw] replication_state
  #   @return [Google::Bigtable::Admin::V2::Table::ClusterState::ReplicationState]
  #     (+OutputOnly+)
  #     The state of replication for the table in this cluster.
  class ClusterState
    # Table replication states.
    module ReplicationState
      # The replication state of the table is unknown in this cluster.
      STATE_NOT_KNOWN = 0

      # The cluster was recently created, and the table must finish copying
      # over pre-existing data from other clusters before it can begin
      # receiving live replication updates and serving Data API requests.
      INITIALIZING = 1

      # The table is temporarily unable to serve Data API requests from this
      # cluster due to planned internal maintenance.
      PLANNED_MAINTENANCE = 2

      # The table is temporarily unable to serve Data API requests from this
      # cluster due to unplanned or emergency maintenance.
      UNPLANNED_MAINTENANCE = 3

      # The table can serve Data API requests from this cluster. Depending on
      # replication delay, reads may not immediately reflect the state of the
      # table in other clusters.
      READY = 4
    end
  end

  # Possible timestamp granularities to use when keeping multiple versions
  # of data in a table.
  module TimestampGranularity
    # The user did not specify a granularity. Should not be returned.
    # When specified during table creation, MILLIS will be used.
    TIMESTAMP_GRANULARITY_UNSPECIFIED = 0

    # The table keeps data versioned at a granularity of 1ms.
    MILLIS = 1
  end

  # Defines a view over a table's fields.
  module View
    # Uses the default view for each method as documented in its request.
    VIEW_UNSPECIFIED = 0

    # Only populates +name+.
    NAME_ONLY = 1

    # Only populates +name+ and fields related to the table's schema.
    SCHEMA_VIEW = 2

    # Only populates +name+ and fields related to the table's
    # replication state.
    REPLICATION_VIEW = 3

    # Populates all fields.
    FULL = 4
  end
end

#name ⇒ String

Returns (+OutputOnly+) The unique name of the table. Values are of the form +projects//instances//tables/[a-zA-Z0-9][-.a-zA-Z0-9]*+. Views: +NAME_ONLY+, +SCHEMA_VIEW+, +REPLICATION_VIEW+, +FULL+

Returns:

  • (String) —

    (+OutputOnly+) The unique name of the table. Values are of the form +projects//instances//tables/[a-zA-Z0-9][-.a-zA-Z0-9]*+. Views: +NAME_ONLY+, +SCHEMA_VIEW+, +REPLICATION_VIEW+, +FULL+



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/table.rb', line 47

class Table
  # The state of a table's data in a particular cluster.
  # @!attribute [rw] replication_state
  #   @return [Google::Bigtable::Admin::V2::Table::ClusterState::ReplicationState]
  #     (+OutputOnly+)
  #     The state of replication for the table in this cluster.
  class ClusterState
    # Table replication states.
    module ReplicationState
      # The replication state of the table is unknown in this cluster.
      STATE_NOT_KNOWN = 0

      # The cluster was recently created, and the table must finish copying
      # over pre-existing data from other clusters before it can begin
      # receiving live replication updates and serving Data API requests.
      INITIALIZING = 1

      # The table is temporarily unable to serve Data API requests from this
      # cluster due to planned internal maintenance.
      PLANNED_MAINTENANCE = 2

      # The table is temporarily unable to serve Data API requests from this
      # cluster due to unplanned or emergency maintenance.
      UNPLANNED_MAINTENANCE = 3

      # The table can serve Data API requests from this cluster. Depending on
      # replication delay, reads may not immediately reflect the state of the
      # table in other clusters.
      READY = 4
    end
  end

  # Possible timestamp granularities to use when keeping multiple versions
  # of data in a table.
  module TimestampGranularity
    # The user did not specify a granularity. Should not be returned.
    # When specified during table creation, MILLIS will be used.
    TIMESTAMP_GRANULARITY_UNSPECIFIED = 0

    # The table keeps data versioned at a granularity of 1ms.
    MILLIS = 1
  end

  # Defines a view over a table's fields.
  module View
    # Uses the default view for each method as documented in its request.
    VIEW_UNSPECIFIED = 0

    # Only populates +name+.
    NAME_ONLY = 1

    # Only populates +name+ and fields related to the table's schema.
    SCHEMA_VIEW = 2

    # Only populates +name+ and fields related to the table's
    # replication state.
    REPLICATION_VIEW = 3

    # Populates all fields.
    FULL = 4
  end
end