com.google.api.services.pubsub.model

Class BigtableConfig

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.pubsub.model.BigtableConfig

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class BigtableConfig
extends com.google.api.client.json.GenericJson

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.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Pub/Sub API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
BigtableConfig()

Method Summary

Modifier and Type	Method and Description
BigtableConfig	clone()
String	getAppProfileId() Optional.
String	getServiceAccountEmail() Optional.
String	getState() Output only.
String	getTable() Optional.
Boolean	getWriteMetadata() Optional.
BigtableConfig	set(String fieldName, Object value)
BigtableConfig	setAppProfileId(String appProfileId) Optional.
BigtableConfig	setServiceAccountEmail(String serviceAccountEmail) Optional.
BigtableConfig	setState(String state) Output only.
BigtableConfig	setTable(String table) Optional.
BigtableConfig	setWriteMetadata(Boolean writeMetadata) Optional.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

BigtableConfig

public BigtableConfig()

Method Detail

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.

Returns:

value or null for none

setAppProfileId

public BigtableConfig setAppProfileId(String appProfileId)

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.

Parameters:

appProfileId - appProfileId or null for none

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](https://cloud.google.com/iam/docs/service-agents), service-{project_number}@gcp-sa- pubsub.iam.gserviceaccount.com, is used.

Returns:

value or null for none

setServiceAccountEmail

public BigtableConfig setServiceAccountEmail(String serviceAccountEmail)

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](https://cloud.google.com/iam/docs/service-agents), service-{project_number}@gcp-sa- pubsub.iam.gserviceaccount.com, is used.

Parameters:

serviceAccountEmail - serviceAccountEmail or null for none

getState

public String getState()

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

Returns:

value or null for none

setState

public BigtableConfig setState(String state)

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

Parameters:

state - state or null for none

getTable

public String getTable()

Optional. The unique name of the table to write messages to. Values are of the form `projects//instances//tables/`.

Returns:

value or null for none

setTable

public BigtableConfig setTable(String table)

Optional. The unique name of the table to write messages to. Values are of the form `projects//instances//tables/`.

Parameters:

table - table or null for none

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.

Returns:

value or null for none

setWriteMetadata

public BigtableConfig setWriteMetadata(Boolean writeMetadata)

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.

Parameters:

writeMetadata - writeMetadata or null for none

set

public BigtableConfig set(String fieldName,
                          Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public BigtableConfig clone()

Overrides:

clone in class com.google.api.client.json.GenericJson