Reference documentation and code samples for the Google Cloud Datastream V1 Client class SpannerSourceConfig.
Configuration for syncing data from a Spanner source.
Generated from protobuf message google.cloud.datastream.v1.SpannerSourceConfig
Namespace
Google \ Cloud \ Datastream \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ change_stream_name |
string
Required. Immutable. The change stream name to use for the stream. |
↳ spanner_rpc_priority |
int
Optional. The RPC priority to use for the stream. |
↳ fgac_role |
string
Optional. The FGAC role to use for the stream. |
↳ max_concurrent_cdc_tasks |
int
Optional. Maximum number of concurrent CDC tasks. |
↳ max_concurrent_backfill_tasks |
int
Optional. Maximum number of concurrent backfill tasks. |
↳ include_objects |
SpannerDatabase
Optional. The Spanner objects to retrieve from the data source. If some objects are both included and excluded, an error will be thrown. |
↳ exclude_objects |
SpannerDatabase
Optional. The Spanner objects to avoid retrieving. If some objects are both included and excluded, an error will be thrown. |
↳ backfill_data_boost_enabled |
bool
Optional. Whether to use Data Boost for Spanner backfills. Defaults to false if not set. |
getChangeStreamName
Required. Immutable. The change stream name to use for the stream.
| Returns | |
|---|---|
| Type | Description |
string |
|
setChangeStreamName
Required. Immutable. The change stream name to use for the stream.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSpannerRpcPriority
Optional. The RPC priority to use for the stream.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type SpannerRpcPriority. |
setSpannerRpcPriority
Optional. The RPC priority to use for the stream.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type SpannerRpcPriority. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFgacRole
Optional. The FGAC role to use for the stream.
| Returns | |
|---|---|
| Type | Description |
string |
|
setFgacRole
Optional. The FGAC role to use for the stream.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMaxConcurrentCdcTasks
Optional. Maximum number of concurrent CDC tasks.
| Returns | |
|---|---|
| Type | Description |
int |
|
setMaxConcurrentCdcTasks
Optional. Maximum number of concurrent CDC tasks.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMaxConcurrentBackfillTasks
Optional. Maximum number of concurrent backfill tasks.
| Returns | |
|---|---|
| Type | Description |
int |
|
setMaxConcurrentBackfillTasks
Optional. Maximum number of concurrent backfill tasks.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIncludeObjects
Optional. The Spanner objects to retrieve from the data source. If some objects are both included and excluded, an error will be thrown.
| Returns | |
|---|---|
| Type | Description |
SpannerDatabase|null |
|
hasIncludeObjects
clearIncludeObjects
setIncludeObjects
Optional. The Spanner objects to retrieve from the data source. If some objects are both included and excluded, an error will be thrown.
| Parameter | |
|---|---|
| Name | Description |
var |
SpannerDatabase
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getExcludeObjects
Optional. The Spanner objects to avoid retrieving. If some objects are both included and excluded, an error will be thrown.
| Returns | |
|---|---|
| Type | Description |
SpannerDatabase|null |
|
hasExcludeObjects
clearExcludeObjects
setExcludeObjects
Optional. The Spanner objects to avoid retrieving. If some objects are both included and excluded, an error will be thrown.
| Parameter | |
|---|---|
| Name | Description |
var |
SpannerDatabase
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBackfillDataBoostEnabled
Optional. Whether to use Data Boost for Spanner backfills. Defaults to false if not set.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setBackfillDataBoostEnabled
Optional. Whether to use Data Boost for Spanner backfills. Defaults to false if not set.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|