Class BigtableConfig.ColumnFamilyMapping (1.161.0)

public static final class BigtableConfig.ColumnFamilyMapping extends GeneratedMessage implements BigtableConfig.ColumnFamilyMappingOrBuilder

Configuration for writing a Pub/Sub message to a Bigtable row with a user-defined key and writing to column families.

If this field is set:

  • The subscription messages must be formatted as JSON.
  • The row key mapping is configured in the key_definition section.
  • The top-level fields will be written either:
  • By default, they will be written to the data column family with the field name as the column qualifier.
  • But if the field name matches an existing column family (except for the default data column), then that field will be written to that column family, either as a scalar or its next level nested fields if it's a JSON object.
  • The cell timestamp will be the message publish timestamp.

    If the field is not set, the default behavior is to write:

  • row key: subscription name, message ID hash, and message ID delimited by #.

  • columns: message bytes written to a single column family data with an empty-string column qualifier.
  • cell timestamp: the message publish timestamp.

Protobuf type google.pubsub.v1.BigtableConfig.ColumnFamilyMapping

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > BigtableConfig.ColumnFamilyMapping

Static Fields

DELIMITED_KEY_FIELD_NUMBER

public static final int DELIMITED_KEY_FIELD_NUMBER
Field Value
Type Description
int

ROW_KEY_SCHEMA_FIELD_NUMBER

public static final int ROW_KEY_SCHEMA_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static BigtableConfig.ColumnFamilyMapping getDefaultInstance()
Returns
Type Description
BigtableConfig.ColumnFamilyMapping

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static BigtableConfig.ColumnFamilyMapping.Builder newBuilder()
Returns
Type Description
BigtableConfig.ColumnFamilyMapping.Builder

newBuilder(BigtableConfig.ColumnFamilyMapping prototype)

public static BigtableConfig.ColumnFamilyMapping.Builder newBuilder(BigtableConfig.ColumnFamilyMapping prototype)
Parameter
Name Description
prototype BigtableConfig.ColumnFamilyMapping
Returns
Type Description
BigtableConfig.ColumnFamilyMapping.Builder

parseDelimitedFrom(InputStream input)

public static BigtableConfig.ColumnFamilyMapping parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BigtableConfig.ColumnFamilyMapping
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BigtableConfig.ColumnFamilyMapping parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BigtableConfig.ColumnFamilyMapping
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static BigtableConfig.ColumnFamilyMapping parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
BigtableConfig.ColumnFamilyMapping
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BigtableConfig.ColumnFamilyMapping parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BigtableConfig.ColumnFamilyMapping
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BigtableConfig.ColumnFamilyMapping parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
BigtableConfig.ColumnFamilyMapping
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BigtableConfig.ColumnFamilyMapping parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BigtableConfig.ColumnFamilyMapping
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BigtableConfig.ColumnFamilyMapping parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
BigtableConfig.ColumnFamilyMapping
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BigtableConfig.ColumnFamilyMapping parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BigtableConfig.ColumnFamilyMapping
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static BigtableConfig.ColumnFamilyMapping parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BigtableConfig.ColumnFamilyMapping
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BigtableConfig.ColumnFamilyMapping parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BigtableConfig.ColumnFamilyMapping
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static BigtableConfig.ColumnFamilyMapping parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
BigtableConfig.ColumnFamilyMapping
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BigtableConfig.ColumnFamilyMapping parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BigtableConfig.ColumnFamilyMapping
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<BigtableConfig.ColumnFamilyMapping> parser()
Returns
Type Description
Parser<ColumnFamilyMapping>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public BigtableConfig.ColumnFamilyMapping getDefaultInstanceForType()
Returns
Type Description
BigtableConfig.ColumnFamilyMapping

getDelimitedKey()

public BigtableConfig.ColumnFamilyMapping.DelimitedKey getDelimitedKey()

Optional. If set, the row key is constructed from the given key fields and delimiter. All key fields must be present in the message; otherwise, the message remains in the subscription backlog.

.google.pubsub.v1.BigtableConfig.ColumnFamilyMapping.DelimitedKey delimited_key = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BigtableConfig.ColumnFamilyMapping.DelimitedKey

The delimitedKey.

getDelimitedKeyOrBuilder()

public BigtableConfig.ColumnFamilyMapping.DelimitedKeyOrBuilder getDelimitedKeyOrBuilder()

Optional. If set, the row key is constructed from the given key fields and delimiter. All key fields must be present in the message; otherwise, the message remains in the subscription backlog.

.google.pubsub.v1.BigtableConfig.ColumnFamilyMapping.DelimitedKey delimited_key = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BigtableConfig.ColumnFamilyMapping.DelimitedKeyOrBuilder

getKeyDefinitionCase()

public BigtableConfig.ColumnFamilyMapping.KeyDefinitionCase getKeyDefinitionCase()
Returns
Type Description
BigtableConfig.ColumnFamilyMapping.KeyDefinitionCase

getParserForType()

public Parser<BigtableConfig.ColumnFamilyMapping> getParserForType()
Returns
Type Description
Parser<ColumnFamilyMapping>
Overrides

getRowKeySchema()

public BigtableConfig.ColumnFamilyMapping.RowKeySchema getRowKeySchema()

Optional. If set, the row key is constructed from the field names of the table's structured row key ({$universe.dns_names.final_documentation_domain}/bigtable/docs/manage-row-key-schemas). Note that if the field is nullable in the structured row key, then it need not be present in the message; null will be used instead.

.google.pubsub.v1.BigtableConfig.ColumnFamilyMapping.RowKeySchema row_key_schema = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BigtableConfig.ColumnFamilyMapping.RowKeySchema

The rowKeySchema.

getRowKeySchemaOrBuilder()

public BigtableConfig.ColumnFamilyMapping.RowKeySchemaOrBuilder getRowKeySchemaOrBuilder()

Optional. If set, the row key is constructed from the field names of the table's structured row key ({$universe.dns_names.final_documentation_domain}/bigtable/docs/manage-row-key-schemas). Note that if the field is nullable in the structured row key, then it need not be present in the message; null will be used instead.

.google.pubsub.v1.BigtableConfig.ColumnFamilyMapping.RowKeySchema row_key_schema = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BigtableConfig.ColumnFamilyMapping.RowKeySchemaOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasDelimitedKey()

public boolean hasDelimitedKey()

Optional. If set, the row key is constructed from the given key fields and delimiter. All key fields must be present in the message; otherwise, the message remains in the subscription backlog.

.google.pubsub.v1.BigtableConfig.ColumnFamilyMapping.DelimitedKey delimited_key = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the delimitedKey field is set.

hasRowKeySchema()

public boolean hasRowKeySchema()

Optional. If set, the row key is constructed from the field names of the table's structured row key ({$universe.dns_names.final_documentation_domain}/bigtable/docs/manage-row-key-schemas). Note that if the field is nullable in the structured row key, then it need not be present in the message; null will be used instead.

.google.pubsub.v1.BigtableConfig.ColumnFamilyMapping.RowKeySchema row_key_schema = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the rowKeySchema field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public BigtableConfig.ColumnFamilyMapping.Builder newBuilderForType()
Returns
Type Description
BigtableConfig.ColumnFamilyMapping.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected BigtableConfig.ColumnFamilyMapping.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
BigtableConfig.ColumnFamilyMapping.Builder
Overrides

toBuilder()

public BigtableConfig.ColumnFamilyMapping.Builder toBuilder()
Returns
Type Description
BigtableConfig.ColumnFamilyMapping.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException