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

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/bigtable/admin/v2/bigtable_table_admin.rb

Overview

Request message for google.bigtable.admin.v2.BigtableTableAdmin.ModifyColumnFamilies

Defined Under Namespace

Classes: Modification

Instance Attribute Summary collapse

Instance Attribute Details

#ignore_warnings ⇒ ::Boolean

Returns Optional. If true, ignore safety checks when modifying the column families.

Returns:

  • (::Boolean) —

    Optional. If true, ignore safety checks when modifying the column families.



348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'proto_docs/google/bigtable/admin/v2/bigtable_table_admin.rb', line 348

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

  # 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::Cloud::Bigtable::Admin::V2::ColumnFamily]
  #     Create a new column family with the specified schema, or fail if
  #     one already exists with the given ID.
  #
  #     Note: The following fields are mutually exclusive: `create`, `update`, `drop`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] update
  #   @return [::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.
  #
  #     Note: The following fields are mutually exclusive: `update`, `create`, `drop`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] drop
  #   @return [::Boolean]
  #     Drop (delete) the column family with the given ID, or fail if no such
  #     family exists.
  #
  #     Note: The following fields are mutually exclusive: `drop`, `create`, `update`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] update_mask
  #   @return [::Google::Protobuf::FieldMask]
  #     Optional. A mask specifying which fields (e.g. `gc_rule`) in the `update`
  #     mod should be updated, ignored for other modification types. If unset or
  #     empty, we treat it as updating `gc_rule` to be backward compatible.
  class Modification
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#modifications ⇒ ::Array<::Google::Cloud::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:



348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'proto_docs/google/bigtable/admin/v2/bigtable_table_admin.rb', line 348

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

  # 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::Cloud::Bigtable::Admin::V2::ColumnFamily]
  #     Create a new column family with the specified schema, or fail if
  #     one already exists with the given ID.
  #
  #     Note: The following fields are mutually exclusive: `create`, `update`, `drop`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] update
  #   @return [::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.
  #
  #     Note: The following fields are mutually exclusive: `update`, `create`, `drop`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] drop
  #   @return [::Boolean]
  #     Drop (delete) the column family with the given ID, or fail if no such
  #     family exists.
  #
  #     Note: The following fields are mutually exclusive: `drop`, `create`, `update`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] update_mask
  #   @return [::Google::Protobuf::FieldMask]
  #     Optional. A mask specifying which fields (e.g. `gc_rule`) in the `update`
  #     mod should be updated, ignored for other modification types. If unset or
  #     empty, we treat it as updating `gc_rule` to be backward compatible.
  class Modification
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  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}.

Returns:

  • (::String) —

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



348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'proto_docs/google/bigtable/admin/v2/bigtable_table_admin.rb', line 348

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

  # 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::Cloud::Bigtable::Admin::V2::ColumnFamily]
  #     Create a new column family with the specified schema, or fail if
  #     one already exists with the given ID.
  #
  #     Note: The following fields are mutually exclusive: `create`, `update`, `drop`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] update
  #   @return [::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.
  #
  #     Note: The following fields are mutually exclusive: `update`, `create`, `drop`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] drop
  #   @return [::Boolean]
  #     Drop (delete) the column family with the given ID, or fail if no such
  #     family exists.
  #
  #     Note: The following fields are mutually exclusive: `drop`, `create`, `update`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] update_mask
  #   @return [::Google::Protobuf::FieldMask]
  #     Optional. A mask specifying which fields (e.g. `gc_rule`) in the `update`
  #     mod should be updated, ignored for other modification types. If unset or
  #     empty, we treat it as updating `gc_rule` to be backward compatible.
  class Modification
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end