Google Cloud Datastream V1 Client - Class StreamObject (1.1.0)

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
NameDescription
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
TypeDescription
string

setName

Output only. The object resource's name.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCreateTime

Output only. The creation time of the object.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The creation time of the object.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getUpdateTime

Output only. The last update time of the object.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The last update time of the object.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getDisplayName

Required. Display name.

Returns
TypeDescription
string

setDisplayName

Required. Display name.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getErrors

Output only. Active errors on the object.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setErrors

Output only. Active errors on the object.

Parameter
NameDescription
var array<Google\Cloud\Datastream\V1\Error>
Returns
TypeDescription
$this

getBackfillJob

The latest backfill job that was initiated for the stream object.

Returns
TypeDescription
Google\Cloud\Datastream\V1\BackfillJob|null

hasBackfillJob

clearBackfillJob

setBackfillJob

The latest backfill job that was initiated for the stream object.

Parameter
NameDescription
var Google\Cloud\Datastream\V1\BackfillJob
Returns
TypeDescription
$this

getSourceObject

The object identifier in the data source.

Returns
TypeDescription
Google\Cloud\Datastream\V1\SourceObjectIdentifier|null

hasSourceObject

clearSourceObject

setSourceObject

The object identifier in the data source.

Parameter
NameDescription
var Google\Cloud\Datastream\V1\SourceObjectIdentifier
Returns
TypeDescription
$this