Class BigtableConfig.Builder (1.161.0)

public static final class BigtableConfig.Builder extends GeneratedMessage.Builder<BigtableConfig.Builder> implements BigtableConfigOrBuilder

Configuration for a Bigtable subscription, which will write a Pub/Sub message to a Bigtable row. See the ColumnFamilyMapping documentation below for details on how the row keys and columns will be written.

Protobuf type google.pubsub.v1.BigtableConfig

Static Methods

getDescriptor()

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

Methods

build()

public BigtableConfig build()
Returns
Type Description
BigtableConfig

buildPartial()

public BigtableConfig buildPartial()
Returns
Type Description
BigtableConfig

clear()

public BigtableConfig.Builder clear()
Returns
Type Description
BigtableConfig.Builder
Overrides

clearAppProfileId()

public BigtableConfig.Builder clearAppProfileId()

Optional. The app profile to use for the Bigtable writes. If not specified, the "default" application profile will be used. The app profile must use single-cluster routing.

string app_profile_id = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BigtableConfig.Builder

This builder for chaining.

clearColumnFamilyMapping()

public BigtableConfig.Builder clearColumnFamilyMapping()

Optional. Configuration that allows writing row keys and/or columns based on fields in the input message. The input message format must be JSON if this field is set.

.google.pubsub.v1.BigtableConfig.ColumnFamilyMapping column_family_mapping = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BigtableConfig.Builder

clearMessageMapping()

public BigtableConfig.Builder clearMessageMapping()
Returns
Type Description
BigtableConfig.Builder

clearServiceAccountEmail()

public BigtableConfig.Builder clearServiceAccountEmail()

Optional. The service account to use to write to Bigtable. The subscription creator or updater that specifies this field must have iam.serviceAccounts.actAs permission on the service account. If not specified, the Pub/Sub service agent, service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.

string service_account_email = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BigtableConfig.Builder

This builder for chaining.

clearState()

public BigtableConfig.Builder clearState()

Output only. An output-only field that indicates whether or not the subscription can receive messages.

.google.pubsub.v1.BigtableConfig.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BigtableConfig.Builder

This builder for chaining.

clearTable()

public BigtableConfig.Builder clearTable()

Optional. The unique name of the table to write messages to.

Values are of the form projects/<project>/instances/<instance>/tables/<table>.

string table = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BigtableConfig.Builder

This builder for chaining.

clearWriteMetadata()

public BigtableConfig.Builder clearWriteMetadata()

Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key to additional columns in the table under the pubsub_metadata column family. The subscription name, message_id, and publish_time fields are put in their own columns while all other message properties (other than data) are written to a JSON object in the attributes column.

bool write_metadata = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BigtableConfig.Builder

This builder for chaining.

getAppProfileId()

public String getAppProfileId()

Optional. The app profile to use for the Bigtable writes. If not specified, the "default" application profile will be used. The app profile must use single-cluster routing.

string app_profile_id = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The appProfileId.

getAppProfileIdBytes()

public ByteString getAppProfileIdBytes()

Optional. The app profile to use for the Bigtable writes. If not specified, the "default" application profile will be used. The app profile must use single-cluster routing.

string app_profile_id = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for appProfileId.

getColumnFamilyMapping()

public BigtableConfig.ColumnFamilyMapping getColumnFamilyMapping()

Optional. Configuration that allows writing row keys and/or columns based on fields in the input message. The input message format must be JSON if this field is set.

.google.pubsub.v1.BigtableConfig.ColumnFamilyMapping column_family_mapping = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BigtableConfig.ColumnFamilyMapping

The columnFamilyMapping.

getColumnFamilyMappingBuilder()

public BigtableConfig.ColumnFamilyMapping.Builder getColumnFamilyMappingBuilder()

Optional. Configuration that allows writing row keys and/or columns based on fields in the input message. The input message format must be JSON if this field is set.

.google.pubsub.v1.BigtableConfig.ColumnFamilyMapping column_family_mapping = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BigtableConfig.ColumnFamilyMapping.Builder

getColumnFamilyMappingOrBuilder()

public BigtableConfig.ColumnFamilyMappingOrBuilder getColumnFamilyMappingOrBuilder()

Optional. Configuration that allows writing row keys and/or columns based on fields in the input message. The input message format must be JSON if this field is set.

.google.pubsub.v1.BigtableConfig.ColumnFamilyMapping column_family_mapping = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BigtableConfig.ColumnFamilyMappingOrBuilder

getDefaultInstanceForType()

public BigtableConfig getDefaultInstanceForType()
Returns
Type Description
BigtableConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getMessageMappingCase()

public BigtableConfig.MessageMappingCase getMessageMappingCase()
Returns
Type Description
BigtableConfig.MessageMappingCase

getServiceAccountEmail()

public String getServiceAccountEmail()

Optional. The service account to use to write to Bigtable. The subscription creator or updater that specifies this field must have iam.serviceAccounts.actAs permission on the service account. If not specified, the Pub/Sub service agent, service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.

string service_account_email = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The serviceAccountEmail.

getServiceAccountEmailBytes()

public ByteString getServiceAccountEmailBytes()

Optional. The service account to use to write to Bigtable. The subscription creator or updater that specifies this field must have iam.serviceAccounts.actAs permission on the service account. If not specified, the Pub/Sub service agent, service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.

string service_account_email = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for serviceAccountEmail.

getState()

public BigtableConfig.State getState()

Output only. An output-only field that indicates whether or not the subscription can receive messages.

.google.pubsub.v1.BigtableConfig.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BigtableConfig.State

The state.

getStateValue()

public int getStateValue()

Output only. An output-only field that indicates whether or not the subscription can receive messages.

.google.pubsub.v1.BigtableConfig.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getTable()

public String getTable()

Optional. The unique name of the table to write messages to.

Values are of the form projects/<project>/instances/<instance>/tables/<table>.

string table = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The table.

getTableBytes()

public ByteString getTableBytes()

Optional. The unique name of the table to write messages to.

Values are of the form projects/<project>/instances/<instance>/tables/<table>.

string table = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for table.

getWriteMetadata()

public boolean getWriteMetadata()

Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key to additional columns in the table under the pubsub_metadata column family. The subscription name, message_id, and publish_time fields are put in their own columns while all other message properties (other than data) are written to a JSON object in the attributes column.

bool write_metadata = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The writeMetadata.

hasColumnFamilyMapping()

public boolean hasColumnFamilyMapping()

Optional. Configuration that allows writing row keys and/or columns based on fields in the input message. The input message format must be JSON if this field is set.

.google.pubsub.v1.BigtableConfig.ColumnFamilyMapping column_family_mapping = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the columnFamilyMapping field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeColumnFamilyMapping(BigtableConfig.ColumnFamilyMapping value)

public BigtableConfig.Builder mergeColumnFamilyMapping(BigtableConfig.ColumnFamilyMapping value)

Optional. Configuration that allows writing row keys and/or columns based on fields in the input message. The input message format must be JSON if this field is set.

.google.pubsub.v1.BigtableConfig.ColumnFamilyMapping column_family_mapping = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value BigtableConfig.ColumnFamilyMapping
Returns
Type Description
BigtableConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BigtableConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BigtableConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public BigtableConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
BigtableConfig.Builder
Overrides

mergeFrom(BigtableConfig other)

public BigtableConfig.Builder mergeFrom(BigtableConfig other)
Parameter
Name Description
other BigtableConfig
Returns
Type Description
BigtableConfig.Builder

setAppProfileId(String value)

public BigtableConfig.Builder setAppProfileId(String value)

Optional. The app profile to use for the Bigtable writes. If not specified, the "default" application profile will be used. The app profile must use single-cluster routing.

string app_profile_id = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The appProfileId to set.

Returns
Type Description
BigtableConfig.Builder

This builder for chaining.

setAppProfileIdBytes(ByteString value)

public BigtableConfig.Builder setAppProfileIdBytes(ByteString value)

Optional. The app profile to use for the Bigtable writes. If not specified, the "default" application profile will be used. The app profile must use single-cluster routing.

string app_profile_id = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for appProfileId to set.

Returns
Type Description
BigtableConfig.Builder

This builder for chaining.

setColumnFamilyMapping(BigtableConfig.ColumnFamilyMapping value)

public BigtableConfig.Builder setColumnFamilyMapping(BigtableConfig.ColumnFamilyMapping value)

Optional. Configuration that allows writing row keys and/or columns based on fields in the input message. The input message format must be JSON if this field is set.

.google.pubsub.v1.BigtableConfig.ColumnFamilyMapping column_family_mapping = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value BigtableConfig.ColumnFamilyMapping
Returns
Type Description
BigtableConfig.Builder

setColumnFamilyMapping(BigtableConfig.ColumnFamilyMapping.Builder builderForValue)

public BigtableConfig.Builder setColumnFamilyMapping(BigtableConfig.ColumnFamilyMapping.Builder builderForValue)

Optional. Configuration that allows writing row keys and/or columns based on fields in the input message. The input message format must be JSON if this field is set.

.google.pubsub.v1.BigtableConfig.ColumnFamilyMapping column_family_mapping = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue BigtableConfig.ColumnFamilyMapping.Builder
Returns
Type Description
BigtableConfig.Builder

setServiceAccountEmail(String value)

public BigtableConfig.Builder setServiceAccountEmail(String value)

Optional. The service account to use to write to Bigtable. The subscription creator or updater that specifies this field must have iam.serviceAccounts.actAs permission on the service account. If not specified, the Pub/Sub service agent, service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.

string service_account_email = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The serviceAccountEmail to set.

Returns
Type Description
BigtableConfig.Builder

This builder for chaining.

setServiceAccountEmailBytes(ByteString value)

public BigtableConfig.Builder setServiceAccountEmailBytes(ByteString value)

Optional. The service account to use to write to Bigtable. The subscription creator or updater that specifies this field must have iam.serviceAccounts.actAs permission on the service account. If not specified, the Pub/Sub service agent, service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.

string service_account_email = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for serviceAccountEmail to set.

Returns
Type Description
BigtableConfig.Builder

This builder for chaining.

setState(BigtableConfig.State value)

public BigtableConfig.Builder setState(BigtableConfig.State value)

Output only. An output-only field that indicates whether or not the subscription can receive messages.

.google.pubsub.v1.BigtableConfig.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value BigtableConfig.State

The state to set.

Returns
Type Description
BigtableConfig.Builder

This builder for chaining.

setStateValue(int value)

public BigtableConfig.Builder setStateValue(int value)

Output only. An output-only field that indicates whether or not the subscription can receive messages.

.google.pubsub.v1.BigtableConfig.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.

Returns
Type Description
BigtableConfig.Builder

This builder for chaining.

setTable(String value)

public BigtableConfig.Builder setTable(String value)

Optional. The unique name of the table to write messages to.

Values are of the form projects/<project>/instances/<instance>/tables/<table>.

string table = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The table to set.

Returns
Type Description
BigtableConfig.Builder

This builder for chaining.

setTableBytes(ByteString value)

public BigtableConfig.Builder setTableBytes(ByteString value)

Optional. The unique name of the table to write messages to.

Values are of the form projects/<project>/instances/<instance>/tables/<table>.

string table = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for table to set.

Returns
Type Description
BigtableConfig.Builder

This builder for chaining.

setWriteMetadata(boolean value)

public BigtableConfig.Builder setWriteMetadata(boolean value)

Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key to additional columns in the table under the pubsub_metadata column family. The subscription name, message_id, and publish_time fields are put in their own columns while all other message properties (other than data) are written to a JSON object in the attributes column.

bool write_metadata = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The writeMetadata to set.

Returns
Type Description
BigtableConfig.Builder

This builder for chaining.