Class: Google::Cloud::DiscoveryEngine::V1::BigtableOptions

Inherits:

Object

Object
Google::Cloud::DiscoveryEngine::V1::BigtableOptions

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/discoveryengine/v1/import_config.rb

Overview

The Bigtable Options object that contains information to support the import.

Defined Under Namespace

Modules: Encoding, Type Classes: BigtableColumn, BigtableColumnFamily, FamiliesEntry

Instance Attribute Summary collapse

#families ⇒ ::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1::BigtableOptions::BigtableColumnFamily}
The mapping from family names to an object that contains column families level information for the given column family.
#key_field_name ⇒ ::String
The field name used for saving row key value in the document.

Instance Attribute Details

#families ⇒ `::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1::BigtableOptions::BigtableColumnFamily}`

Returns The mapping from family names to an object that contains column families level information for the given column family. If a family is not present in this map it will be ignored.

Returns:

(::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1::BigtableOptions::BigtableColumnFamily}) —
The mapping from family names to an object that contains column families level information for the given column family. If a family is not present in this map it will be ignored.

# File 'proto_docs/google/cloud/discoveryengine/v1/import_config.rb', line 149

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

  # The column family of the Bigtable.
  # @!attribute [rw] field_name
  #   @return [::String]
  #     The field name to use for this column family in the document. The
  #     name has to match the pattern `[a-zA-Z0-9][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.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::DiscoveryEngine::V1::BigtableOptions::Encoding]
  #     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.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::DiscoveryEngine::V1::BigtableOptions::Type]
  #     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`.
  # @!attribute [rw] columns
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::BigtableOptions::BigtableColumn>]
  #     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.
  class BigtableColumnFamily
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The column of the Bigtable.
  # @!attribute [rw] qualifier
  #   @return [::String]
  #     Required. Qualifier of the column. If it cannot be decoded with utf-8,
  #     use a base-64 encoded string instead.
  # @!attribute [rw] field_name
  #   @return [::String]
  #     The field name to use for this column in the document. The name has to
  #     match the pattern `[a-zA-Z0-9][a-zA-Z0-9-_]*`.
  #     If not set, it is parsed from the qualifier bytes with best effort.
  #     However, due to different naming patterns, field name collisions could
  #     happen, where parsing behavior is undefined.
  # @!attribute [rw] encoding
  #   @return [::Google::Cloud::DiscoveryEngine::V1::BigtableOptions::Encoding]
  #     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.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::DiscoveryEngine::V1::BigtableOptions::Type]
  #     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`.
  class BigtableColumn
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1::BigtableOptions::BigtableColumnFamily]
  class FamiliesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of values in a Bigtable column or column family.
  # The values are expected to be encoded using
  # [HBase
  # Bytes.toBytes](https://hbase.apache.org/apidocs/org/apache/hadoop/hbase/util/Bytes.html)
  # function when the encoding value is set to `BINARY`.
  module Type
    # The type is unspecified.
    TYPE_UNSPECIFIED = 0

    # String type.
    STRING = 1

    # Numerical type.
    NUMBER = 2

    # Integer type.
    INTEGER = 3

    # Variable length integer type.
    VAR_INTEGER = 4

    # BigDecimal type.
    BIG_NUMERIC = 5

    # Boolean type.
    BOOLEAN = 6

    # JSON type.
    JSON = 7
  end

  # The encoding mode of a Bigtable column or column family.
  module Encoding
    # The encoding is unspecified.
    ENCODING_UNSPECIFIED = 0

    # Text encoding.
    TEXT = 1

    # Binary encoding.
    BINARY = 2
  end
end

#key_field_name ⇒ `::String`

Returns The field name used for saving row key value in the document. The name has to match the pattern [a-zA-Z0-9][a-zA-Z0-9-_]*.