Class BigtableConfig.Builder (1.150.1)

1.150.1 (latest) 1.149.0 1.148.0 1.147.0 1.145.0 1.143.1 1.142.0 1.141.5 1.140.2 1.139.4 1.138.0 1.137.1 1.136.1 1.135.0 1.134.2 1.133.1 1.132.2 1.131.0 1.130.0 1.129.6 1.127.3 1.126.6 1.125.13 1.123.18 1.122.2 1.121.1 1.120.24 1.119.1 1.118.0 1.117.0 1.116.4 1.115.5

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

Configuration for a Bigtable subscription. The Pub/Sub message will be written to a Bigtable row as follows:

• row key: subscription name 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

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > BigtableConfig.Builder

Implements

BigtableConfigOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

GeneratedMessage.Builder<BuilderType>.clear()

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.

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.

getDefaultInstanceForType()

public BigtableConfig getDefaultInstanceForType()

Returns
Type	Description
BigtableConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

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.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public BigtableConfig.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
BigtableConfig.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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.

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.