Reference documentation and code samples for the Cloud Bigtable Admin V2 API class Google::Cloud::Bigtable::Admin::V2::ModifyColumnFamiliesRequest::Modification.
A create, update, or delete of a particular column family.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#create
def create() -> ::Google::Cloud::Bigtable::Admin::V2::ColumnFamily
Returns
- (::Google::Cloud::Bigtable::Admin::V2::ColumnFamily) — Create a new column family with the specified schema, or fail if one already exists with the given ID.
#create=
def create=(value) -> ::Google::Cloud::Bigtable::Admin::V2::ColumnFamily
Parameter
- value (::Google::Cloud::Bigtable::Admin::V2::ColumnFamily) — Create a new column family with the specified schema, or fail if one already exists with the given ID.
Returns
- (::Google::Cloud::Bigtable::Admin::V2::ColumnFamily) — Create a new column family with the specified schema, or fail if one already exists with the given ID.
#drop
def drop() -> ::Boolean
Returns
- (::Boolean) — Drop (delete) the column family with the given ID, or fail if no such family exists.
#drop=
def drop=(value) -> ::Boolean
Parameter
- value (::Boolean) — Drop (delete) the column family with the given ID, or fail if no such family exists.
Returns
- (::Boolean) — Drop (delete) the column family with the given ID, or fail if no such family exists.
#id
def id() -> ::String
Returns
- (::String) — The ID of the column family to be modified.
#id=
def id=(value) -> ::String
Parameter
- value (::String) — The ID of the column family to be modified.
Returns
- (::String) — The ID of the column family to be modified.
#update
def update() -> ::Google::Cloud::Bigtable::Admin::V2::ColumnFamily
Returns
- (::Google::Cloud::Bigtable::Admin::V2::ColumnFamily) — Update an existing column family to the specified schema, or fail if no column family exists with the given ID.
#update=
def update=(value) -> ::Google::Cloud::Bigtable::Admin::V2::ColumnFamily
Parameter
- value (::Google::Cloud::Bigtable::Admin::V2::ColumnFamily) — Update an existing column family to the specified schema, or fail if no column family exists with the given ID.
Returns
- (::Google::Cloud::Bigtable::Admin::V2::ColumnFamily) — Update an existing column family to the specified schema, or fail if no column family exists with the given ID.
#update_mask
def update_mask() -> ::Google::Protobuf::FieldMask
Returns
-
(::Google::Protobuf::FieldMask) — Optional. A mask specifying which fields (e.g.
gc_rule
) in theupdate
mod should be updated, ignored for other modification types. If unset or empty, we treat it as updatinggc_rule
to be backward compatible.
#update_mask=
def update_mask=(value) -> ::Google::Protobuf::FieldMask
Parameter
-
value (::Google::Protobuf::FieldMask) — Optional. A mask specifying which fields (e.g.
gc_rule
) in theupdate
mod should be updated, ignored for other modification types. If unset or empty, we treat it as updatinggc_rule
to be backward compatible.
Returns
-
(::Google::Protobuf::FieldMask) — Optional. A mask specifying which fields (e.g.
gc_rule
) in theupdate
mod should be updated, ignored for other modification types. If unset or empty, we treat it as updatinggc_rule
to be backward compatible.