Reference documentation and code samples for the Datastream V1 API class Google::Cloud::Datastream::V1::Stream.
A resource representing streaming data from a source to a destination.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#backfill_all
def backfill_all() -> ::Google::Cloud::Datastream::V1::Stream::BackfillAllStrategy
Returns
-
(::Google::Cloud::Datastream::V1::Stream::BackfillAllStrategy) — Automatically backfill objects included in the stream source
configuration. Specific objects can be excluded.
Note: The following fields are mutually exclusive:
backfill_all,backfill_none. If a field in that set is populated, all other fields in the set will automatically be cleared.
#backfill_all=
def backfill_all=(value) -> ::Google::Cloud::Datastream::V1::Stream::BackfillAllStrategy
Parameter
-
value (::Google::Cloud::Datastream::V1::Stream::BackfillAllStrategy) — Automatically backfill objects included in the stream source
configuration. Specific objects can be excluded.
Note: The following fields are mutually exclusive:
backfill_all,backfill_none. If a field in that set is populated, all other fields in the set will automatically be cleared.
Returns
-
(::Google::Cloud::Datastream::V1::Stream::BackfillAllStrategy) — Automatically backfill objects included in the stream source
configuration. Specific objects can be excluded.
Note: The following fields are mutually exclusive:
backfill_all,backfill_none. If a field in that set is populated, all other fields in the set will automatically be cleared.
#backfill_none
def backfill_none() -> ::Google::Cloud::Datastream::V1::Stream::BackfillNoneStrategy
Returns
-
(::Google::Cloud::Datastream::V1::Stream::BackfillNoneStrategy) — Do not automatically backfill any objects.
Note: The following fields are mutually exclusive:
backfill_none,backfill_all. If a field in that set is populated, all other fields in the set will automatically be cleared.
#backfill_none=
def backfill_none=(value) -> ::Google::Cloud::Datastream::V1::Stream::BackfillNoneStrategy
Parameter
-
value (::Google::Cloud::Datastream::V1::Stream::BackfillNoneStrategy) — Do not automatically backfill any objects.
Note: The following fields are mutually exclusive:
backfill_none,backfill_all. If a field in that set is populated, all other fields in the set will automatically be cleared.
Returns
-
(::Google::Cloud::Datastream::V1::Stream::BackfillNoneStrategy) — Do not automatically backfill any objects.
Note: The following fields are mutually exclusive:
backfill_none,backfill_all. If a field in that set is populated, all other fields in the set will automatically be cleared.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The creation time of the stream.
#customer_managed_encryption_key
def customer_managed_encryption_key() -> ::String
Returns
- (::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.
#customer_managed_encryption_key=
def customer_managed_encryption_key=(value) -> ::String
Parameter
- value (::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.
Returns
- (::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.
#destination_config
def destination_config() -> ::Google::Cloud::Datastream::V1::DestinationConfig
Returns
- (::Google::Cloud::Datastream::V1::DestinationConfig) — Required. Destination connection profile configuration.
#destination_config=
def destination_config=(value) -> ::Google::Cloud::Datastream::V1::DestinationConfig
Parameter
- value (::Google::Cloud::Datastream::V1::DestinationConfig) — Required. Destination connection profile configuration.
Returns
- (::Google::Cloud::Datastream::V1::DestinationConfig) — Required. Destination connection profile configuration.
#display_name
def display_name() -> ::String
Returns
- (::String) — Required. Display name.
#display_name=
def display_name=(value) -> ::String
Parameter
- value (::String) — Required. Display name.
Returns
- (::String) — Required. Display name.
#errors
def errors() -> ::Array<::Google::Cloud::Datastream::V1::Error>
Returns
- (::Array<::Google::Cloud::Datastream::V1::Error>) — Output only. Errors on the Stream.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Labels.
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
- value (::Google::Protobuf::Map{::String => ::String}) — Labels.
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Labels.
#last_recovery_time
def last_recovery_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. If the stream was recovered, the time of the last recovery. Note: This field is currently experimental.
#name
def name() -> ::String
Returns
- (::String) — Output only. Identifier. The stream's name.
#satisfies_pzi
def satisfies_pzi() -> ::Boolean
Returns
- (::Boolean) — Output only. Reserved for future use.
#satisfies_pzs
def satisfies_pzs() -> ::Boolean
Returns
- (::Boolean) — Output only. Reserved for future use.
#source_config
def source_config() -> ::Google::Cloud::Datastream::V1::SourceConfig
Returns
- (::Google::Cloud::Datastream::V1::SourceConfig) — Required. Source connection profile configuration.
#source_config=
def source_config=(value) -> ::Google::Cloud::Datastream::V1::SourceConfig
Parameter
- value (::Google::Cloud::Datastream::V1::SourceConfig) — Required. Source connection profile configuration.
Returns
- (::Google::Cloud::Datastream::V1::SourceConfig) — Required. Source connection profile configuration.
#state
def state() -> ::Google::Cloud::Datastream::V1::Stream::State
Returns
- (::Google::Cloud::Datastream::V1::Stream::State) — The state of the stream.
#state=
def state=(value) -> ::Google::Cloud::Datastream::V1::Stream::State
Parameter
- value (::Google::Cloud::Datastream::V1::Stream::State) — The state of the stream.
Returns
- (::Google::Cloud::Datastream::V1::Stream::State) — The state of the stream.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The last update time of the stream.