Interface BigtableConfigOrBuilder (1.161.0)

public interface BigtableConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAppProfileId()

public abstract 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 abstract 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 abstract 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.

getColumnFamilyMappingOrBuilder()

public abstract 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

getMessageMappingCase()

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

getServiceAccountEmail()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.