public static final class BigtableConfig.ColumnFamilyMapping.Builder extends GeneratedMessage.Builder<BigtableConfig.ColumnFamilyMapping.Builder> implements BigtableConfig.ColumnFamilyMappingOrBuilderConfiguration 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_definitionsection. - The top-level fields will be written either:
- By default, they will be written to the
datacolumn family with the field name as the column qualifier. - But if the field name matches an existing column family (except for
the default
datacolumn), 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
datawith an empty-string column qualifier. - cell timestamp: the message publish timestamp.
Protobuf type google.pubsub.v1.BigtableConfig.ColumnFamilyMapping
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > BigtableConfig.ColumnFamilyMapping.BuilderImplements
BigtableConfig.ColumnFamilyMappingOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
build()
public BigtableConfig.ColumnFamilyMapping build()| Returns | |
|---|---|
| Type | Description |
BigtableConfig.ColumnFamilyMapping |
|
buildPartial()
public BigtableConfig.ColumnFamilyMapping buildPartial()| Returns | |
|---|---|
| Type | Description |
BigtableConfig.ColumnFamilyMapping |
|
clear()
public BigtableConfig.ColumnFamilyMapping.Builder clear()| Returns | |
|---|---|
| Type | Description |
BigtableConfig.ColumnFamilyMapping.Builder |
|
clearDelimitedKey()
public BigtableConfig.ColumnFamilyMapping.Builder clearDelimitedKey()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.Builder |
|
clearKeyDefinition()
public BigtableConfig.ColumnFamilyMapping.Builder clearKeyDefinition()| Returns | |
|---|---|
| Type | Description |
BigtableConfig.ColumnFamilyMapping.Builder |
|
clearRowKeySchema()
public BigtableConfig.ColumnFamilyMapping.Builder clearRowKeySchema()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.Builder |
|
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. |
getDelimitedKeyBuilder()
public BigtableConfig.ColumnFamilyMapping.DelimitedKey.Builder getDelimitedKeyBuilder()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.Builder |
|
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 |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getKeyDefinitionCase()
public BigtableConfig.ColumnFamilyMapping.KeyDefinitionCase getKeyDefinitionCase()| Returns | |
|---|---|
| Type | Description |
BigtableConfig.ColumnFamilyMapping.KeyDefinitionCase |
|
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. |
getRowKeySchemaBuilder()
public BigtableConfig.ColumnFamilyMapping.RowKeySchema.Builder getRowKeySchemaBuilder()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.Builder |
|
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 |
|
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. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeDelimitedKey(BigtableConfig.ColumnFamilyMapping.DelimitedKey value)
public BigtableConfig.ColumnFamilyMapping.Builder mergeDelimitedKey(BigtableConfig.ColumnFamilyMapping.DelimitedKey value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
BigtableConfig.ColumnFamilyMapping.DelimitedKey |
| Returns | |
|---|---|
| Type | Description |
BigtableConfig.ColumnFamilyMapping.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public BigtableConfig.ColumnFamilyMapping.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
BigtableConfig.ColumnFamilyMapping.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public BigtableConfig.ColumnFamilyMapping.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
BigtableConfig.ColumnFamilyMapping.Builder |
|
mergeFrom(BigtableConfig.ColumnFamilyMapping other)
public BigtableConfig.ColumnFamilyMapping.Builder mergeFrom(BigtableConfig.ColumnFamilyMapping other)| Parameter | |
|---|---|
| Name | Description |
other |
BigtableConfig.ColumnFamilyMapping |
| Returns | |
|---|---|
| Type | Description |
BigtableConfig.ColumnFamilyMapping.Builder |
|
mergeRowKeySchema(BigtableConfig.ColumnFamilyMapping.RowKeySchema value)
public BigtableConfig.ColumnFamilyMapping.Builder mergeRowKeySchema(BigtableConfig.ColumnFamilyMapping.RowKeySchema value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
BigtableConfig.ColumnFamilyMapping.RowKeySchema |
| Returns | |
|---|---|
| Type | Description |
BigtableConfig.ColumnFamilyMapping.Builder |
|
setDelimitedKey(BigtableConfig.ColumnFamilyMapping.DelimitedKey value)
public BigtableConfig.ColumnFamilyMapping.Builder setDelimitedKey(BigtableConfig.ColumnFamilyMapping.DelimitedKey value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
BigtableConfig.ColumnFamilyMapping.DelimitedKey |
| Returns | |
|---|---|
| Type | Description |
BigtableConfig.ColumnFamilyMapping.Builder |
|
setDelimitedKey(BigtableConfig.ColumnFamilyMapping.DelimitedKey.Builder builderForValue)
public BigtableConfig.ColumnFamilyMapping.Builder setDelimitedKey(BigtableConfig.ColumnFamilyMapping.DelimitedKey.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
BigtableConfig.ColumnFamilyMapping.DelimitedKey.Builder |
| Returns | |
|---|---|
| Type | Description |
BigtableConfig.ColumnFamilyMapping.Builder |
|
setRowKeySchema(BigtableConfig.ColumnFamilyMapping.RowKeySchema value)
public BigtableConfig.ColumnFamilyMapping.Builder setRowKeySchema(BigtableConfig.ColumnFamilyMapping.RowKeySchema value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
BigtableConfig.ColumnFamilyMapping.RowKeySchema |
| Returns | |
|---|---|
| Type | Description |
BigtableConfig.ColumnFamilyMapping.Builder |
|
setRowKeySchema(BigtableConfig.ColumnFamilyMapping.RowKeySchema.Builder builderForValue)
public BigtableConfig.ColumnFamilyMapping.Builder setRowKeySchema(BigtableConfig.ColumnFamilyMapping.RowKeySchema.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
BigtableConfig.ColumnFamilyMapping.RowKeySchema.Builder |
| Returns | |
|---|---|
| Type | Description |
BigtableConfig.ColumnFamilyMapping.Builder |
|