public static final class SpannerSourceConfig.Builder extends GeneratedMessage.Builder<SpannerSourceConfig.Builder> implements SpannerSourceConfigOrBuilderConfiguration for syncing data from a Spanner source.
Protobuf type google.cloud.datastream.v1.SpannerSourceConfig
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > SpannerSourceConfig.BuilderImplements
SpannerSourceConfigOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
build()
public SpannerSourceConfig build()| Returns | |
|---|---|
| Type | Description |
SpannerSourceConfig |
|
buildPartial()
public SpannerSourceConfig buildPartial()| Returns | |
|---|---|
| Type | Description |
SpannerSourceConfig |
|
clear()
public SpannerSourceConfig.Builder clear()| Returns | |
|---|---|
| Type | Description |
SpannerSourceConfig.Builder |
|
clearBackfillDataBoostEnabled()
public SpannerSourceConfig.Builder clearBackfillDataBoostEnabled()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 |
SpannerSourceConfig.Builder |
This builder for chaining. |
clearChangeStreamName()
public SpannerSourceConfig.Builder clearChangeStreamName()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 |
SpannerSourceConfig.Builder |
This builder for chaining. |
clearExcludeObjects()
public SpannerSourceConfig.Builder clearExcludeObjects()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 |
SpannerSourceConfig.Builder |
|
clearFgacRole()
public SpannerSourceConfig.Builder clearFgacRole()Optional. The FGAC role to use for the stream.
string fgac_role = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SpannerSourceConfig.Builder |
This builder for chaining. |
clearIncludeObjects()
public SpannerSourceConfig.Builder clearIncludeObjects()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 |
SpannerSourceConfig.Builder |
|
clearMaxConcurrentBackfillTasks()
public SpannerSourceConfig.Builder clearMaxConcurrentBackfillTasks()Optional. Maximum number of concurrent backfill tasks.
int32 max_concurrent_backfill_tasks = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SpannerSourceConfig.Builder |
This builder for chaining. |
clearMaxConcurrentCdcTasks()
public SpannerSourceConfig.Builder clearMaxConcurrentCdcTasks()Optional. Maximum number of concurrent CDC tasks.
int32 max_concurrent_cdc_tasks = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SpannerSourceConfig.Builder |
This builder for chaining. |
clearSpannerRpcPriority()
public SpannerSourceConfig.Builder clearSpannerRpcPriority()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.Builder |
This builder for chaining. |
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 |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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. |
getExcludeObjectsBuilder()
public SpannerDatabase.Builder getExcludeObjectsBuilder()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.Builder |
|
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. |
getIncludeObjectsBuilder()
public SpannerDatabase.Builder getIncludeObjectsBuilder()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.Builder |
|
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. |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeExcludeObjects(SpannerDatabase value)
public SpannerSourceConfig.Builder mergeExcludeObjects(SpannerDatabase value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
SpannerDatabase |
| Returns | |
|---|---|
| Type | Description |
SpannerSourceConfig.Builder |
|
mergeFrom(SpannerSourceConfig other)
public SpannerSourceConfig.Builder mergeFrom(SpannerSourceConfig other)| Parameter | |
|---|---|
| Name | Description |
other |
SpannerSourceConfig |
| Returns | |
|---|---|
| Type | Description |
SpannerSourceConfig.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SpannerSourceConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SpannerSourceConfig.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public SpannerSourceConfig.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
SpannerSourceConfig.Builder |
|
mergeIncludeObjects(SpannerDatabase value)
public SpannerSourceConfig.Builder mergeIncludeObjects(SpannerDatabase value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
SpannerDatabase |
| Returns | |
|---|---|
| Type | Description |
SpannerSourceConfig.Builder |
|
setBackfillDataBoostEnabled(boolean value)
public SpannerSourceConfig.Builder setBackfillDataBoostEnabled(boolean value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe backfillDataBoostEnabled to set. |
| Returns | |
|---|---|
| Type | Description |
SpannerSourceConfig.Builder |
This builder for chaining. |
setChangeStreamName(String value)
public SpannerSourceConfig.Builder setChangeStreamName(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe changeStreamName to set. |
| Returns | |
|---|---|
| Type | Description |
SpannerSourceConfig.Builder |
This builder for chaining. |
setChangeStreamNameBytes(ByteString value)
public SpannerSourceConfig.Builder setChangeStreamNameBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for changeStreamName to set. |
| Returns | |
|---|---|
| Type | Description |
SpannerSourceConfig.Builder |
This builder for chaining. |
setExcludeObjects(SpannerDatabase value)
public SpannerSourceConfig.Builder setExcludeObjects(SpannerDatabase value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
SpannerDatabase |
| Returns | |
|---|---|
| Type | Description |
SpannerSourceConfig.Builder |
|
setExcludeObjects(SpannerDatabase.Builder builderForValue)
public SpannerSourceConfig.Builder setExcludeObjects(SpannerDatabase.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
SpannerDatabase.Builder |
| Returns | |
|---|---|
| Type | Description |
SpannerSourceConfig.Builder |
|
setFgacRole(String value)
public SpannerSourceConfig.Builder setFgacRole(String value)Optional. The FGAC role to use for the stream.
string fgac_role = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe fgacRole to set. |
| Returns | |
|---|---|
| Type | Description |
SpannerSourceConfig.Builder |
This builder for chaining. |
setFgacRoleBytes(ByteString value)
public SpannerSourceConfig.Builder setFgacRoleBytes(ByteString value)Optional. The FGAC role to use for the stream.
string fgac_role = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for fgacRole to set. |
| Returns | |
|---|---|
| Type | Description |
SpannerSourceConfig.Builder |
This builder for chaining. |
setIncludeObjects(SpannerDatabase value)
public SpannerSourceConfig.Builder setIncludeObjects(SpannerDatabase value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
SpannerDatabase |
| Returns | |
|---|---|
| Type | Description |
SpannerSourceConfig.Builder |
|
setIncludeObjects(SpannerDatabase.Builder builderForValue)
public SpannerSourceConfig.Builder setIncludeObjects(SpannerDatabase.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
SpannerDatabase.Builder |
| Returns | |
|---|---|
| Type | Description |
SpannerSourceConfig.Builder |
|
setMaxConcurrentBackfillTasks(int value)
public SpannerSourceConfig.Builder setMaxConcurrentBackfillTasks(int value)Optional. Maximum number of concurrent backfill tasks.
int32 max_concurrent_backfill_tasks = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe maxConcurrentBackfillTasks to set. |
| Returns | |
|---|---|
| Type | Description |
SpannerSourceConfig.Builder |
This builder for chaining. |
setMaxConcurrentCdcTasks(int value)
public SpannerSourceConfig.Builder setMaxConcurrentCdcTasks(int value)Optional. Maximum number of concurrent CDC tasks.
int32 max_concurrent_cdc_tasks = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe maxConcurrentCdcTasks to set. |
| Returns | |
|---|---|
| Type | Description |
SpannerSourceConfig.Builder |
This builder for chaining. |
setSpannerRpcPriority(SpannerSourceConfig.SpannerRpcPriority value)
public SpannerSourceConfig.Builder setSpannerRpcPriority(SpannerSourceConfig.SpannerRpcPriority value)Optional. The RPC priority to use for the stream.
.google.cloud.datastream.v1.SpannerSourceConfig.SpannerRpcPriority spanner_rpc_priority = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
SpannerSourceConfig.SpannerRpcPriorityThe spannerRpcPriority to set. |
| Returns | |
|---|---|
| Type | Description |
SpannerSourceConfig.Builder |
This builder for chaining. |
setSpannerRpcPriorityValue(int value)
public SpannerSourceConfig.Builder setSpannerRpcPriorityValue(int value)Optional. The RPC priority to use for the stream.
.google.cloud.datastream.v1.SpannerSourceConfig.SpannerRpcPriority spanner_rpc_priority = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for spannerRpcPriority to set. |
| Returns | |
|---|---|
| Type | Description |
SpannerSourceConfig.Builder |
This builder for chaining. |