Package com.google.cloud.discoveryengine.v1beta

Interface BigtableOptions.BigtableColumnOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
BigtableOptions.BigtableColumn, BigtableOptions.BigtableColumn.Builder
Enclosing class:
BigtableOptions
public static interface BigtableOptions.BigtableColumnOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    BigtableOptions.Encoding
    getEncoding()
    The encoding mode of the values when the type is not `STRING`.
    int
    getEncodingValue()
    The encoding mode of the values when the type is not `STRING`.
    String
    getFieldName()
    The field name to use for this column in the document.
    com.google.protobuf.ByteString
    getFieldNameBytes()
    The field name to use for this column in the document.
    com.google.protobuf.ByteString
    getQualifier()
    Required.
    BigtableOptions.Type
    getType()
    The type of values in this column family.
    int
    getTypeValue()
    The type of values in this column family.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getQualifier

      com.google.protobuf.ByteString getQualifier()
       Required. Qualifier of the column. If it cannot be decoded with utf-8,
 use a base-64 encoded string instead.
      bytes qualifier = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The qualifier.

    • getFieldName

      String getFieldName()
       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.
      string field_name = 2;
      Returns:
      The fieldName.

    • getFieldNameBytes

      com.google.protobuf.ByteString getFieldNameBytes()
       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.
      string field_name = 2;
      Returns:
      The bytes for fieldName.

    • getEncodingValue

      int getEncodingValue()
       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.
      .google.cloud.discoveryengine.v1beta.BigtableOptions.Encoding encoding = 3;
      Returns:
      The enum numeric value on the wire for encoding.

    • getEncoding

      BigtableOptions.Encoding getEncoding()
       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.
      .google.cloud.discoveryengine.v1beta.BigtableOptions.Encoding encoding = 3;
      Returns:
      The encoding.

    • getTypeValue

      int getTypeValue()
       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`.
      .google.cloud.discoveryengine.v1beta.BigtableOptions.Type type = 4;
      Returns:
      The enum numeric value on the wire for type.

    • getType

      BigtableOptions.Type getType()
       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`.
      .google.cloud.discoveryengine.v1beta.BigtableOptions.Type type = 4;
      Returns:
      The type.