Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumnFamily

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

Overview

The column family of the Bigtable.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumnFamily

Returns a new instance of GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumnFamily.



1796
1797
1798
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 1796

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

Instance Attribute Details

#columns ⇒ Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1BigtableOptionsBigtableColumn>

The list of objects that contains column level information for each column. If a column is not present in this list it will be ignored. Corresponds to the JSON property columns

Returns:



1770
1771
1772
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 1770

def columns
  @columns
end

#encoding ⇒ String

The encoding mode 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) 


1779
1780
1781
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 1779

def encoding
  @encoding
end

#field_name ⇒ String

The field name to use for this column family in the document. The name has to match the pattern a-zA-Z0-9*. If not set, it is parsed from the family name with best effort. However, due to different naming patterns, field name collisions could happen, where parsing behavior is undefined. Corresponds to the JSON property fieldName

Returns:

  • (String) 


1787
1788
1789
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 1787

def field_name
  @field_name
end

#type ⇒ String

The type of values in this column family. The values are expected to be encoded using HBase Bytes.toBytes function when the encoding value is set to BINARY. Corresponds to the JSON property type

Returns:

  • (String) 


1794
1795
1796
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 1794

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1801
1802
1803
1804
1805
1806
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 1801

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