Class Stream (1.9.2)

Stream(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name	Description
`name`	`str` Output only. The stream's name.
`create_time`	`google.protobuf.timestamp_pb2.Timestamp` Output only. The creation time of the stream.
`update_time`	`google.protobuf.timestamp_pb2.Timestamp` Output only. The last update time of the stream.
`labels`	`MutableMapping[str, str]` Labels.
`display_name`	`str` Required. Display name.
`source_config`	`google.cloud.datastream_v1.types.SourceConfig` Required. Source connection profile configuration.
`destination_config`	`google.cloud.datastream_v1.types.DestinationConfig` Required. Destination connection profile configuration.
`state`	`google.cloud.datastream_v1.types.Stream.State` The state of the stream.
`backfill_all`	`google.cloud.datastream_v1.types.Stream.BackfillAllStrategy` Automatically backfill objects included in the stream source configuration. Specific objects can be excluded. This field is a member of `oneof`_ `backfill_strategy`.
`backfill_none`	`google.cloud.datastream_v1.types.Stream.BackfillNoneStrategy` Do not automatically backfill any objects. This field is a member of `oneof`_ `backfill_strategy`.
`errors`	`MutableSequence[google.cloud.datastream_v1.types.Error]` Output only. Errors on the Stream.
`customer_managed_encryption_key`	`str` 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. This field is a member of `oneof`_ `_customer_managed_encryption_key`.

Classes

BackfillAllStrategy

BackfillAllStrategy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Backfill strategy to automatically backfill the Stream's objects. Specific objects can be excluded.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

BackfillNoneStrategy

BackfillNoneStrategy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Backfill strategy to disable automatic backfill for the Stream's objects.

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
`kwargs`	`dict` Keys and values corresponding to the fields of the message.
`mapping`	`Union[dict, .Message]` A dictionary or message to be used to determine the values for this message.
`ignore_unknown_fields`	`Optional(bool)` If True, do not raise errors for unknown fields. Only applied if `mapping` is a mapping type or there are keyword parameters.

State

State(value)

Stream state.

Values: STATE_UNSPECIFIED (0): Unspecified stream state. NOT_STARTED (1): The stream has been created but has not yet started streaming data. RUNNING (2): The stream is running. PAUSED (3): The stream is paused. MAINTENANCE (4): The stream is in maintenance mode.

    Updates are rejected on the resource in this
    state.
FAILED (5):
    The stream is experiencing an error that is
    preventing data from being streamed.
FAILED_PERMANENTLY (6):
    The stream has experienced a terminal
    failure.
STARTING (7):
    The stream is starting, but not yet running.
DRAINING (8):
    The Stream is no longer reading new events,
    but still writing events in the buffer.