Google Cloud Datastream V1 Client - Class Stream (1.5.5)

Reference documentation and code samples for the Google Cloud Datastream V1 Client class Stream.

A resource representing streaming data from a source to a destination.

Generated from protobuf message google.cloud.datastream.v1.Stream

Namespace

Google \ Cloud \ Datastream \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Output only. The stream's name.
`↳ create_time`	`Google\Protobuf\Timestamp` Output only. The creation time of the stream.
`↳ update_time`	`Google\Protobuf\Timestamp` Output only. The last update time of the stream.
`↳ labels`	`array\|Google\Protobuf\Internal\MapField` Labels.
`↳ display_name`	`string` Required. Display name.
`↳ source_config`	`Google\Cloud\Datastream\V1\SourceConfig` Required. Source connection profile configuration.
`↳ destination_config`	`Google\Cloud\Datastream\V1\DestinationConfig` Required. Destination connection profile configuration.
`↳ state`	`int` The state of the stream.
`↳ backfill_all`	`Google\Cloud\Datastream\V1\Stream\BackfillAllStrategy` Automatically backfill objects included in the stream source configuration. Specific objects can be excluded.
`↳ backfill_none`	`Google\Cloud\Datastream\V1\Stream\BackfillNoneStrategy` Do not automatically backfill any objects.
`↳ errors`	`array<Google\Cloud\Datastream\V1\Error>` Output only. Errors on the Stream.
`↳ customer_managed_encryption_key`	`string` Immutable. A reference to a KMS encryption key. If provided, it will be used to encrypt the data. If left blank, data will be encrypted using an internal Stream-specific encryption key provisioned through KMS.

getName

Output only. The stream's name.

Returns
Type	Description
`string`

setName

Output only. The stream's name.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCreateTime

Output only. The creation time of the stream.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

Output only. The creation time of the stream.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getUpdateTime

Output only. The last update time of the stream.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The last update time of the stream.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getLabels

Labels.

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setLabels

Labels.

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

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`

getSourceConfig

Required. Source connection profile configuration.

Returns
Type	Description
`Google\Cloud\Datastream\V1\SourceConfig\|null`

hasSourceConfig

clearSourceConfig

setSourceConfig

Required. Source connection profile configuration.

Parameter
Name	Description
`var`	`Google\Cloud\Datastream\V1\SourceConfig`

Returns
Type	Description
`$this`

getDestinationConfig

Required. Destination connection profile configuration.

Returns
Type	Description
`Google\Cloud\Datastream\V1\DestinationConfig\|null`

hasDestinationConfig

clearDestinationConfig

setDestinationConfig

Required. Destination connection profile configuration.

Parameter
Name	Description
`var`	`Google\Cloud\Datastream\V1\DestinationConfig`

Returns
Type	Description
`$this`

getState

The state of the stream.

Returns
Type	Description
`int`

setState

The state of the stream.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getBackfillAll

Automatically backfill objects included in the stream source configuration. Specific objects can be excluded.

Returns
Type	Description
`Google\Cloud\Datastream\V1\Stream\BackfillAllStrategy\|null`

hasBackfillAll

setBackfillAll

Automatically backfill objects included in the stream source configuration. Specific objects can be excluded.

Parameter
Name	Description
`var`	`Google\Cloud\Datastream\V1\Stream\BackfillAllStrategy`

Returns
Type	Description
`$this`

getBackfillNone

Do not automatically backfill any objects.

Returns
Type	Description
`Google\Cloud\Datastream\V1\Stream\BackfillNoneStrategy\|null`

hasBackfillNone

setBackfillNone

Do not automatically backfill any objects.

Parameter
Name	Description
`var`	`Google\Cloud\Datastream\V1\Stream\BackfillNoneStrategy`

Returns
Type	Description
`$this`

getErrors

Output only. Errors on the Stream.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setErrors

Output only. Errors on the Stream.

Parameter
Name	Description
`var`	`array<Google\Cloud\Datastream\V1\Error>`

Returns
Type	Description
`$this`

getCustomerManagedEncryptionKey

Immutable. A reference to a KMS encryption key.

If provided, it will be used to encrypt the data. If left blank, data will be encrypted using an internal Stream-specific encryption key provisioned through KMS.

Returns
Type	Description
`string`

hasCustomerManagedEncryptionKey

clearCustomerManagedEncryptionKey

setCustomerManagedEncryptionKey

Immutable. A reference to a KMS encryption key.

If provided, it will be used to encrypt the data. If left blank, data will be encrypted using an internal Stream-specific encryption key provisioned through KMS.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getBackfillStrategy

Returns
Type	Description
`string`