Reference documentation and code samples for the Google Cloud Datastream V1 Client class StreamObject.
A specific stream object (e.g a specific DB table).
Generated from protobuf message google.cloud.datastream.v1.StreamObject
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. The object resource's name. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. The creation time of the object. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. The last update time of the object. |
↳ display_name |
string
Required. Display name. |
↳ errors |
array<Google\Cloud\Datastream\V1\Error>
Output only. Active errors on the object. |
↳ backfill_job |
Google\Cloud\Datastream\V1\BackfillJob
The latest backfill job that was initiated for the stream object. |
↳ source_object |
Google\Cloud\Datastream\V1\SourceObjectIdentifier
The object identifier in the data source. |
getName
Output only. The object resource's name.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Output only. The object resource's name.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. The creation time of the object.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. The creation time of the object.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateTime
Output only. The last update time of the object.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The last update time of the object.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDisplayName
Required. Display name.
| Returns | |
|---|---|
| Type | Description |
string | |
setDisplayName
Required. Display name.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getErrors
Output only. Active errors on the object.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setErrors
Output only. Active errors on the object.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Datastream\V1\Error>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getBackfillJob
The latest backfill job that was initiated for the stream object.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Datastream\V1\BackfillJob|null | |
hasBackfillJob
clearBackfillJob
setBackfillJob
The latest backfill job that was initiated for the stream object.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Datastream\V1\BackfillJob
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSourceObject
The object identifier in the data source.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Datastream\V1\SourceObjectIdentifier|null | |
hasSourceObject
clearSourceObject
setSourceObject
The object identifier in the data source.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Datastream\V1\SourceObjectIdentifier
|
| Returns | |
|---|---|
| Type | Description |
$this | |