Class SpannerSourceConfig (1.102.0)

public final class SpannerSourceConfig extends GeneratedMessage implements SpannerSourceConfigOrBuilder

Configuration for syncing data from a Spanner source.

Protobuf type google.cloud.datastream.v1.SpannerSourceConfig

Static Fields

BACKFILL_DATA_BOOST_ENABLED_FIELD_NUMBER

public static final int BACKFILL_DATA_BOOST_ENABLED_FIELD_NUMBER
Field Value
Type Description
int

CHANGE_STREAM_NAME_FIELD_NUMBER

public static final int CHANGE_STREAM_NAME_FIELD_NUMBER
Field Value
Type Description
int

EXCLUDE_OBJECTS_FIELD_NUMBER

public static final int EXCLUDE_OBJECTS_FIELD_NUMBER
Field Value
Type Description
int

FGAC_ROLE_FIELD_NUMBER

public static final int FGAC_ROLE_FIELD_NUMBER
Field Value
Type Description
int

INCLUDE_OBJECTS_FIELD_NUMBER

public static final int INCLUDE_OBJECTS_FIELD_NUMBER
Field Value
Type Description
int

MAX_CONCURRENT_BACKFILL_TASKS_FIELD_NUMBER

public static final int MAX_CONCURRENT_BACKFILL_TASKS_FIELD_NUMBER
Field Value
Type Description
int

MAX_CONCURRENT_CDC_TASKS_FIELD_NUMBER

public static final int MAX_CONCURRENT_CDC_TASKS_FIELD_NUMBER
Field Value
Type Description
int

SPANNER_RPC_PRIORITY_FIELD_NUMBER

public static final int SPANNER_RPC_PRIORITY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SpannerSourceConfig getDefaultInstance()
Returns
Type Description
SpannerSourceConfig

getDescriptor()

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

newBuilder()

public static SpannerSourceConfig.Builder newBuilder()
Returns
Type Description
SpannerSourceConfig.Builder

newBuilder(SpannerSourceConfig prototype)

public static SpannerSourceConfig.Builder newBuilder(SpannerSourceConfig prototype)
Parameter
Name Description
prototype SpannerSourceConfig
Returns
Type Description
SpannerSourceConfig.Builder

parseDelimitedFrom(InputStream input)

public static SpannerSourceConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SpannerSourceConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SpannerSourceConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SpannerSourceConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SpannerSourceConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SpannerSourceConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SpannerSourceConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SpannerSourceConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SpannerSourceConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SpannerSourceConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SpannerSourceConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SpannerSourceConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SpannerSourceConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SpannerSourceConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SpannerSourceConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SpannerSourceConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SpannerSourceConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SpannerSourceConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SpannerSourceConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SpannerSourceConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SpannerSourceConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SpannerSourceConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SpannerSourceConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SpannerSourceConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SpannerSourceConfig> parser()
Returns
Type Description
Parser<SpannerSourceConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getBackfillDataBoostEnabled()

public boolean getBackfillDataBoostEnabled()

Optional. Whether to use Data Boost for Spanner backfills. Defaults to false if not set.

bool backfill_data_boost_enabled = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The backfillDataBoostEnabled.

getChangeStreamName()

public String getChangeStreamName()

Required. Immutable. The change stream name to use for the stream.

string change_stream_name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The changeStreamName.

getChangeStreamNameBytes()

public ByteString getChangeStreamNameBytes()

Required. Immutable. The change stream name to use for the stream.

string change_stream_name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for changeStreamName.

getDefaultInstanceForType()

public SpannerSourceConfig getDefaultInstanceForType()
Returns
Type Description
SpannerSourceConfig

getExcludeObjects()

public SpannerDatabase getExcludeObjects()

Optional. The Spanner objects to avoid retrieving. If some objects are both included and excluded, an error will be thrown.

.google.cloud.datastream.v1.SpannerDatabase exclude_objects = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SpannerDatabase

The excludeObjects.

getExcludeObjectsOrBuilder()

public SpannerDatabaseOrBuilder getExcludeObjectsOrBuilder()

Optional. The Spanner objects to avoid retrieving. If some objects are both included and excluded, an error will be thrown.

.google.cloud.datastream.v1.SpannerDatabase exclude_objects = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SpannerDatabaseOrBuilder

getFgacRole()

public String getFgacRole()

Optional. The FGAC role to use for the stream.

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

Returns
Type Description
String

The fgacRole.

getFgacRoleBytes()

public ByteString getFgacRoleBytes()

Optional. The FGAC role to use for the stream.

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

Returns
Type Description
ByteString

The bytes for fgacRole.

getIncludeObjects()

public SpannerDatabase getIncludeObjects()

Optional. The Spanner objects to retrieve from the data source. If some objects are both included and excluded, an error will be thrown.

.google.cloud.datastream.v1.SpannerDatabase include_objects = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SpannerDatabase

The includeObjects.

getIncludeObjectsOrBuilder()

public SpannerDatabaseOrBuilder getIncludeObjectsOrBuilder()

Optional. The Spanner objects to retrieve from the data source. If some objects are both included and excluded, an error will be thrown.

.google.cloud.datastream.v1.SpannerDatabase include_objects = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SpannerDatabaseOrBuilder

getMaxConcurrentBackfillTasks()

public int getMaxConcurrentBackfillTasks()

Optional. Maximum number of concurrent backfill tasks.

int32 max_concurrent_backfill_tasks = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The maxConcurrentBackfillTasks.

getMaxConcurrentCdcTasks()

public int getMaxConcurrentCdcTasks()

Optional. Maximum number of concurrent CDC tasks.

int32 max_concurrent_cdc_tasks = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The maxConcurrentCdcTasks.

getParserForType()

public Parser<SpannerSourceConfig> getParserForType()
Returns
Type Description
Parser<SpannerSourceConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSpannerRpcPriority()

public SpannerSourceConfig.SpannerRpcPriority getSpannerRpcPriority()

Optional. The RPC priority to use for the stream.

.google.cloud.datastream.v1.SpannerSourceConfig.SpannerRpcPriority spanner_rpc_priority = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SpannerSourceConfig.SpannerRpcPriority

The spannerRpcPriority.

getSpannerRpcPriorityValue()

public int getSpannerRpcPriorityValue()

Optional. The RPC priority to use for the stream.

.google.cloud.datastream.v1.SpannerSourceConfig.SpannerRpcPriority spanner_rpc_priority = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for spannerRpcPriority.

hasExcludeObjects()

public boolean hasExcludeObjects()

Optional. The Spanner objects to avoid retrieving. If some objects are both included and excluded, an error will be thrown.

.google.cloud.datastream.v1.SpannerDatabase exclude_objects = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the excludeObjects field is set.

hasIncludeObjects()

public boolean hasIncludeObjects()

Optional. The Spanner objects to retrieve from the data source. If some objects are both included and excluded, an error will be thrown.

.google.cloud.datastream.v1.SpannerDatabase include_objects = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the includeObjects field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SpannerSourceConfig.Builder newBuilderForType()
Returns
Type Description
SpannerSourceConfig.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected SpannerSourceConfig.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SpannerSourceConfig.Builder
Overrides

toBuilder()

public SpannerSourceConfig.Builder toBuilder()
Returns
Type Description
SpannerSourceConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException