Google Cloud Datastream V1 Client - Class Stream (2.1.1)

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
↳ display_name
string

Required. Display name.

↳ source_config
SourceConfig

Required. Source connection profile configuration.

↳ destination_config
DestinationConfig

Required. Destination connection profile configuration.

↳ state
int

The state of the stream.

↳ backfill_all
Stream\BackfillAllStrategy

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

↳ backfill_none
Stream\BackfillNoneStrategy

Do not automatically backfill any objects.

↳ errors
array< 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.

↳ last_recovery_time
Google\Protobuf\Timestamp

Output only. If the stream was recovered, the time of the last recovery. Note: This field is currently experimental.

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

hasCreateTime

clearCreateTime

setCreateTime

Output only. The creation time of the stream.

Parameter
Name
Description
Returns
Type
Description
$this

getUpdateTime

Output only. The last update time of the stream.

Returns
Type
Description

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The last update time of the stream.

Parameter
Name
Description
Returns
Type
Description
$this

getLabels

Labels.

Returns
Type
Description

setLabels

Labels.

Parameter
Name
Description
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
SourceConfig |null

hasSourceConfig

clearSourceConfig

setSourceConfig

Required. Source connection profile configuration.

Parameter
Name
Description
Returns
Type
Description
$this

getDestinationConfig

Required. Destination connection profile configuration.

Returns
Type
Description

hasDestinationConfig

clearDestinationConfig

setDestinationConfig

Required. Destination connection profile configuration.

Parameter
Name
Description
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

hasBackfillAll

setBackfillAll

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

Parameter
Name
Description
Returns
Type
Description
$this

getBackfillNone

Do not automatically backfill any objects.

Returns
Type
Description

hasBackfillNone

setBackfillNone

Do not automatically backfill any objects.

Parameter
Name
Description
Returns
Type
Description
$this

getErrors

Output only. Errors on the Stream.

Returns
Type
Description

setErrors

Output only. Errors on the Stream.

Parameter
Name
Description
var
array< 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

getLastRecoveryTime

Output only. If the stream was recovered, the time of the last recovery.

Note: This field is currently experimental.

Returns
Type
Description

hasLastRecoveryTime

clearLastRecoveryTime

setLastRecoveryTime

Output only. If the stream was recovered, the time of the last recovery.

Note: This field is currently experimental.

Parameter
Name
Description
Returns
Type
Description
$this

getBackfillStrategy

Returns
Type
Description
string
Design a Mobile Site
View Site in Mobile | Classic
Share by: