Class: Google::Bigtable::Admin::V2::ModifyColumnFamiliesRequest

Inherits:

Object

Object
Google::Bigtable::Admin::V2::ModifyColumnFamiliesRequest

show all

Defined in:: lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/bigtable_table_admin.rb

Overview

Request message for BigtableTableAdmin::ModifyColumnFamilies

Defined Under Namespace

Classes: Modification

Instance Attribute Summary collapse

#modifications ⇒ Array<Google::Bigtable::Admin::V2::ModifyColumnFamiliesRequest::Modification>
Required.
#name ⇒ String
Required.

Instance Attribute Details

#modifications ⇒ `Array<Google::Bigtable::Admin::V2::ModifyColumnFamiliesRequest::Modification>`

Returns Required. Modifications to be atomically applied to the specified table's families. Entries are applied in order, meaning that earlier modifications can be masked by later ones (in the case of repeated updates to the same family, for example).

Returns:

(Array<Google::Bigtable::Admin::V2::ModifyColumnFamiliesRequest::Modification>) —
Required. Modifications to be atomically applied to the specified table's families. Entries are applied in order, meaning that earlier modifications can be masked by later ones (in the case of repeated updates to the same family, for example).

# File 'lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/bigtable_table_admin.rb', line 172

class ModifyColumnFamiliesRequest
  # A create, update, or delete of a particular column family.
  # @!attribute [rw] id
  #   @return [String]
  #     The ID of the column family to be modified.
  # @!attribute [rw] create
  #   @return [Google::Bigtable::Admin::V2::ColumnFamily]
  #     Create a new column family with the specified schema, or fail if
  #     one already exists with the given ID.
  # @!attribute [rw] update
  #   @return [Google::Bigtable::Admin::V2::ColumnFamily]
  #     Update an existing column family to the specified schema, or fail
  #     if no column family exists with the given ID.
  # @!attribute [rw] drop
  #   @return [true, false]
  #     Drop (delete) the column family with the given ID, or fail if no such
  #     family exists.
  class Modification; end
end

#name ⇒ `String`

Returns Required. The unique name of the table whose families should be modified. Values are of the form projects/{project}/instances/{instance}/tables/{table}.