Class: Google::Apis::BigqueryV2::BigtableColumnFamily

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/bigquery_v2/classes.rb,
generated/google/apis/bigquery_v2/representations.rb,
generated/google/apis/bigquery_v2/representations.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ BigtableColumnFamily

Returns a new instance of BigtableColumnFamily.


618
619
620
# File 'generated/google/apis/bigquery_v2/classes.rb', line 618

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#columnsArray<Google::Apis::BigqueryV2::BigtableColumn>

[Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field. Corresponds to the JSON property columns


583
584
585
# File 'generated/google/apis/bigquery_v2/classes.rb', line 583

def columns
  @columns
end

#encodingString

[Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it. Corresponds to the JSON property encoding

Returns:

  • (String)

592
593
594
# File 'generated/google/apis/bigquery_v2/classes.rb', line 592

def encoding
  @encoding
end

#family_idString

Identifier of the column family. Corresponds to the JSON property familyId

Returns:

  • (String)

597
598
599
# File 'generated/google/apis/bigquery_v2/classes.rb', line 597

def family_id
  @family_id
end

#only_read_latestBoolean Also known as: only_read_latest?

[Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column. Corresponds to the JSON property onlyReadLatest

Returns:

  • (Boolean)

605
606
607
# File 'generated/google/apis/bigquery_v2/classes.rb', line 605

def only_read_latest
  @only_read_latest
end

#typeString

[Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case- sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it. Corresponds to the JSON property type

Returns:

  • (String)

616
617
618
# File 'generated/google/apis/bigquery_v2/classes.rb', line 616

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


623
624
625
626
627
628
629
# File 'generated/google/apis/bigquery_v2/classes.rb', line 623

def update!(**args)
  @columns = args[:columns] if args.key?(:columns)
  @encoding = args[:encoding] if args.key?(:encoding)
  @family_id = args[:family_id] if args.key?(:family_id)
  @only_read_latest = args[:only_read_latest] if args.key?(:only_read_latest)
  @type = args[:type] if args.key?(:type)
end