Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily

Inherits:

Object

• Object
• Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily

Includes:

Core::Hashable, Core::JsonObjectSupport

Defined in:

lib/google/apis/discoveryengine_v1alpha/classes.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb

Overview

The column family of the Bigtable.

Instance Attribute Summary

• #columns ⇒ Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn>

  The list of objects that contains column level information for each column.

• #encoding ⇒ String

  The encoding mode of the values when the type is not STRING.

• #field_name ⇒ String

  The field name to use for this column family in the document.

• #type ⇒ String

  The type of values in this column family.

Instance Method Summary

• #initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily constructor

  A new instance of GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily

Returns a new instance of GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily.

# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3490

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

Instance Attribute Details

#columns ⇒ Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn>

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:

• (Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn>)

# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3464

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)

# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3473

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)

# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3481

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)

# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3488

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3495

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