Class: Google::Cloud::Datastream::V1::Stream

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/datastream/v1/datastream_resources.rb

Overview

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

Defined Under Namespace

Modules: State Classes: BackfillAllStrategy, BackfillNoneStrategy, LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#backfill_all ⇒ ::Google::Cloud::Datastream::V1::Stream::BackfillAllStrategy

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

Returns:



1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
 
# File 'proto_docs/google/cloud/datastream/v1/datastream_resources.rb', line 1123

class Stream
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Backfill strategy to automatically backfill the Stream's objects.
  # Specific objects can be excluded.
  # @!attribute [rw] oracle_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::OracleRdbms]
  #     Oracle data source objects to avoid backfilling.
  # @!attribute [rw] mysql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::MysqlRdbms]
  #     MySQL data source objects to avoid backfilling.
  # @!attribute [rw] postgresql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::PostgresqlRdbms]
  #     PostgreSQL data source objects to avoid backfilling.
  # @!attribute [rw] sql_server_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::SqlServerRdbms]
  #     SQLServer data source objects to avoid backfilling
  class BackfillAllStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Backfill strategy to disable automatic backfill for the Stream's objects.
  class BackfillNoneStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Stream state.
  module State
    # Unspecified stream state.
    STATE_UNSPECIFIED = 0

    # The stream has been created but has not yet started streaming data.
    NOT_STARTED = 1

    # The stream is running.
    RUNNING = 2

    # The stream is paused.
    PAUSED = 3

    # The stream is in maintenance mode.
    #
    # Updates are rejected on the resource in this state.
    MAINTENANCE = 4

    # The stream is experiencing an error that is preventing data from being
    # streamed.
    FAILED = 5

    # The stream has experienced a terminal failure.
    FAILED_PERMANENTLY = 6

    # The stream is starting, but not yet running.
    STARTING = 7

    # The Stream is no longer reading new events, but still writing events in
    # the buffer.
    DRAINING = 8
  end
end

#backfill_none ⇒ ::Google::Cloud::Datastream::V1::Stream::BackfillNoneStrategy

Returns Do not automatically backfill any objects.

Returns:



1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
 
# File 'proto_docs/google/cloud/datastream/v1/datastream_resources.rb', line 1123

class Stream
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Backfill strategy to automatically backfill the Stream's objects.
  # Specific objects can be excluded.
  # @!attribute [rw] oracle_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::OracleRdbms]
  #     Oracle data source objects to avoid backfilling.
  # @!attribute [rw] mysql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::MysqlRdbms]
  #     MySQL data source objects to avoid backfilling.
  # @!attribute [rw] postgresql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::PostgresqlRdbms]
  #     PostgreSQL data source objects to avoid backfilling.
  # @!attribute [rw] sql_server_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::SqlServerRdbms]
  #     SQLServer data source objects to avoid backfilling
  class BackfillAllStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Backfill strategy to disable automatic backfill for the Stream's objects.
  class BackfillNoneStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Stream state.
  module State
    # Unspecified stream state.
    STATE_UNSPECIFIED = 0

    # The stream has been created but has not yet started streaming data.
    NOT_STARTED = 1

    # The stream is running.
    RUNNING = 2

    # The stream is paused.
    PAUSED = 3

    # The stream is in maintenance mode.
    #
    # Updates are rejected on the resource in this state.
    MAINTENANCE = 4

    # The stream is experiencing an error that is preventing data from being
    # streamed.
    FAILED = 5

    # The stream has experienced a terminal failure.
    FAILED_PERMANENTLY = 6

    # The stream is starting, but not yet running.
    STARTING = 7

    # The Stream is no longer reading new events, but still writing events in
    # the buffer.
    DRAINING = 8
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The creation time of the stream.

Returns:



1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
 
# File 'proto_docs/google/cloud/datastream/v1/datastream_resources.rb', line 1123

class Stream
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Backfill strategy to automatically backfill the Stream's objects.
  # Specific objects can be excluded.
  # @!attribute [rw] oracle_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::OracleRdbms]
  #     Oracle data source objects to avoid backfilling.
  # @!attribute [rw] mysql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::MysqlRdbms]
  #     MySQL data source objects to avoid backfilling.
  # @!attribute [rw] postgresql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::PostgresqlRdbms]
  #     PostgreSQL data source objects to avoid backfilling.
  # @!attribute [rw] sql_server_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::SqlServerRdbms]
  #     SQLServer data source objects to avoid backfilling
  class BackfillAllStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Backfill strategy to disable automatic backfill for the Stream's objects.
  class BackfillNoneStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Stream state.
  module State
    # Unspecified stream state.
    STATE_UNSPECIFIED = 0

    # The stream has been created but has not yet started streaming data.
    NOT_STARTED = 1

    # The stream is running.
    RUNNING = 2

    # The stream is paused.
    PAUSED = 3

    # The stream is in maintenance mode.
    #
    # Updates are rejected on the resource in this state.
    MAINTENANCE = 4

    # The stream is experiencing an error that is preventing data from being
    # streamed.
    FAILED = 5

    # The stream has experienced a terminal failure.
    FAILED_PERMANENTLY = 6

    # The stream is starting, but not yet running.
    STARTING = 7

    # The Stream is no longer reading new events, but still writing events in
    # the buffer.
    DRAINING = 8
  end
end

#customer_managed_encryption_key ⇒ ::String

Returns 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.



1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
 
# File 'proto_docs/google/cloud/datastream/v1/datastream_resources.rb', line 1123

class Stream
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Backfill strategy to automatically backfill the Stream's objects.
  # Specific objects can be excluded.
  # @!attribute [rw] oracle_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::OracleRdbms]
  #     Oracle data source objects to avoid backfilling.
  # @!attribute [rw] mysql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::MysqlRdbms]
  #     MySQL data source objects to avoid backfilling.
  # @!attribute [rw] postgresql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::PostgresqlRdbms]
  #     PostgreSQL data source objects to avoid backfilling.
  # @!attribute [rw] sql_server_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::SqlServerRdbms]
  #     SQLServer data source objects to avoid backfilling
  class BackfillAllStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Backfill strategy to disable automatic backfill for the Stream's objects.
  class BackfillNoneStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Stream state.
  module State
    # Unspecified stream state.
    STATE_UNSPECIFIED = 0

    # The stream has been created but has not yet started streaming data.
    NOT_STARTED = 1

    # The stream is running.
    RUNNING = 2

    # The stream is paused.
    PAUSED = 3

    # The stream is in maintenance mode.
    #
    # Updates are rejected on the resource in this state.
    MAINTENANCE = 4

    # The stream is experiencing an error that is preventing data from being
    # streamed.
    FAILED = 5

    # The stream has experienced a terminal failure.
    FAILED_PERMANENTLY = 6

    # The stream is starting, but not yet running.
    STARTING = 7

    # The Stream is no longer reading new events, but still writing events in
    # the buffer.
    DRAINING = 8
  end
end

#destination_config ⇒ ::Google::Cloud::Datastream::V1::DestinationConfig

Returns Required. Destination connection profile configuration.

Returns:



1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
 
# File 'proto_docs/google/cloud/datastream/v1/datastream_resources.rb', line 1123

class Stream
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Backfill strategy to automatically backfill the Stream's objects.
  # Specific objects can be excluded.
  # @!attribute [rw] oracle_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::OracleRdbms]
  #     Oracle data source objects to avoid backfilling.
  # @!attribute [rw] mysql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::MysqlRdbms]
  #     MySQL data source objects to avoid backfilling.
  # @!attribute [rw] postgresql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::PostgresqlRdbms]
  #     PostgreSQL data source objects to avoid backfilling.
  # @!attribute [rw] sql_server_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::SqlServerRdbms]
  #     SQLServer data source objects to avoid backfilling
  class BackfillAllStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Backfill strategy to disable automatic backfill for the Stream's objects.
  class BackfillNoneStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Stream state.
  module State
    # Unspecified stream state.
    STATE_UNSPECIFIED = 0

    # The stream has been created but has not yet started streaming data.
    NOT_STARTED = 1

    # The stream is running.
    RUNNING = 2

    # The stream is paused.
    PAUSED = 3

    # The stream is in maintenance mode.
    #
    # Updates are rejected on the resource in this state.
    MAINTENANCE = 4

    # The stream is experiencing an error that is preventing data from being
    # streamed.
    FAILED = 5

    # The stream has experienced a terminal failure.
    FAILED_PERMANENTLY = 6

    # The stream is starting, but not yet running.
    STARTING = 7

    # The Stream is no longer reading new events, but still writing events in
    # the buffer.
    DRAINING = 8
  end
end

#display_name ⇒ ::String

Returns Required. Display name.

Returns:

  • (::String) —

    Required. Display name.



1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
 
# File 'proto_docs/google/cloud/datastream/v1/datastream_resources.rb', line 1123

class Stream
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Backfill strategy to automatically backfill the Stream's objects.
  # Specific objects can be excluded.
  # @!attribute [rw] oracle_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::OracleRdbms]
  #     Oracle data source objects to avoid backfilling.
  # @!attribute [rw] mysql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::MysqlRdbms]
  #     MySQL data source objects to avoid backfilling.
  # @!attribute [rw] postgresql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::PostgresqlRdbms]
  #     PostgreSQL data source objects to avoid backfilling.
  # @!attribute [rw] sql_server_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::SqlServerRdbms]
  #     SQLServer data source objects to avoid backfilling
  class BackfillAllStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Backfill strategy to disable automatic backfill for the Stream's objects.
  class BackfillNoneStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Stream state.
  module State
    # Unspecified stream state.
    STATE_UNSPECIFIED = 0

    # The stream has been created but has not yet started streaming data.
    NOT_STARTED = 1

    # The stream is running.
    RUNNING = 2

    # The stream is paused.
    PAUSED = 3

    # The stream is in maintenance mode.
    #
    # Updates are rejected on the resource in this state.
    MAINTENANCE = 4

    # The stream is experiencing an error that is preventing data from being
    # streamed.
    FAILED = 5

    # The stream has experienced a terminal failure.
    FAILED_PERMANENTLY = 6

    # The stream is starting, but not yet running.
    STARTING = 7

    # The Stream is no longer reading new events, but still writing events in
    # the buffer.
    DRAINING = 8
  end
end

#errors ⇒ ::Array<::Google::Cloud::Datastream::V1::Error> (readonly)

Returns Output only. Errors on the Stream.

Returns:



1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
 
# File 'proto_docs/google/cloud/datastream/v1/datastream_resources.rb', line 1123

class Stream
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Backfill strategy to automatically backfill the Stream's objects.
  # Specific objects can be excluded.
  # @!attribute [rw] oracle_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::OracleRdbms]
  #     Oracle data source objects to avoid backfilling.
  # @!attribute [rw] mysql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::MysqlRdbms]
  #     MySQL data source objects to avoid backfilling.
  # @!attribute [rw] postgresql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::PostgresqlRdbms]
  #     PostgreSQL data source objects to avoid backfilling.
  # @!attribute [rw] sql_server_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::SqlServerRdbms]
  #     SQLServer data source objects to avoid backfilling
  class BackfillAllStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Backfill strategy to disable automatic backfill for the Stream's objects.
  class BackfillNoneStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Stream state.
  module State
    # Unspecified stream state.
    STATE_UNSPECIFIED = 0

    # The stream has been created but has not yet started streaming data.
    NOT_STARTED = 1

    # The stream is running.
    RUNNING = 2

    # The stream is paused.
    PAUSED = 3

    # The stream is in maintenance mode.
    #
    # Updates are rejected on the resource in this state.
    MAINTENANCE = 4

    # The stream is experiencing an error that is preventing data from being
    # streamed.
    FAILED = 5

    # The stream has experienced a terminal failure.
    FAILED_PERMANENTLY = 6

    # The stream is starting, but not yet running.
    STARTING = 7

    # The Stream is no longer reading new events, but still writing events in
    # the buffer.
    DRAINING = 8
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Labels.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Labels.



1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
 
# File 'proto_docs/google/cloud/datastream/v1/datastream_resources.rb', line 1123

class Stream
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Backfill strategy to automatically backfill the Stream's objects.
  # Specific objects can be excluded.
  # @!attribute [rw] oracle_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::OracleRdbms]
  #     Oracle data source objects to avoid backfilling.
  # @!attribute [rw] mysql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::MysqlRdbms]
  #     MySQL data source objects to avoid backfilling.
  # @!attribute [rw] postgresql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::PostgresqlRdbms]
  #     PostgreSQL data source objects to avoid backfilling.
  # @!attribute [rw] sql_server_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::SqlServerRdbms]
  #     SQLServer data source objects to avoid backfilling
  class BackfillAllStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Backfill strategy to disable automatic backfill for the Stream's objects.
  class BackfillNoneStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Stream state.
  module State
    # Unspecified stream state.
    STATE_UNSPECIFIED = 0

    # The stream has been created but has not yet started streaming data.
    NOT_STARTED = 1

    # The stream is running.
    RUNNING = 2

    # The stream is paused.
    PAUSED = 3

    # The stream is in maintenance mode.
    #
    # Updates are rejected on the resource in this state.
    MAINTENANCE = 4

    # The stream is experiencing an error that is preventing data from being
    # streamed.
    FAILED = 5

    # The stream has experienced a terminal failure.
    FAILED_PERMANENTLY = 6

    # The stream is starting, but not yet running.
    STARTING = 7

    # The Stream is no longer reading new events, but still writing events in
    # the buffer.
    DRAINING = 8
  end
end

#last_recovery_time ⇒ ::Google::Protobuf::Timestamp (readonly)

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

Returns:

  • (::Google::Protobuf::Timestamp) —

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



1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
 
# File 'proto_docs/google/cloud/datastream/v1/datastream_resources.rb', line 1123

class Stream
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Backfill strategy to automatically backfill the Stream's objects.
  # Specific objects can be excluded.
  # @!attribute [rw] oracle_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::OracleRdbms]
  #     Oracle data source objects to avoid backfilling.
  # @!attribute [rw] mysql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::MysqlRdbms]
  #     MySQL data source objects to avoid backfilling.
  # @!attribute [rw] postgresql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::PostgresqlRdbms]
  #     PostgreSQL data source objects to avoid backfilling.
  # @!attribute [rw] sql_server_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::SqlServerRdbms]
  #     SQLServer data source objects to avoid backfilling
  class BackfillAllStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Backfill strategy to disable automatic backfill for the Stream's objects.
  class BackfillNoneStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Stream state.
  module State
    # Unspecified stream state.
    STATE_UNSPECIFIED = 0

    # The stream has been created but has not yet started streaming data.
    NOT_STARTED = 1

    # The stream is running.
    RUNNING = 2

    # The stream is paused.
    PAUSED = 3

    # The stream is in maintenance mode.
    #
    # Updates are rejected on the resource in this state.
    MAINTENANCE = 4

    # The stream is experiencing an error that is preventing data from being
    # streamed.
    FAILED = 5

    # The stream has experienced a terminal failure.
    FAILED_PERMANENTLY = 6

    # The stream is starting, but not yet running.
    STARTING = 7

    # The Stream is no longer reading new events, but still writing events in
    # the buffer.
    DRAINING = 8
  end
end

#name ⇒ ::String (readonly)

Returns Output only. The stream's name.

Returns:

  • (::String) —

    Output only. The stream's name.



1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
 
# File 'proto_docs/google/cloud/datastream/v1/datastream_resources.rb', line 1123

class Stream
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Backfill strategy to automatically backfill the Stream's objects.
  # Specific objects can be excluded.
  # @!attribute [rw] oracle_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::OracleRdbms]
  #     Oracle data source objects to avoid backfilling.
  # @!attribute [rw] mysql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::MysqlRdbms]
  #     MySQL data source objects to avoid backfilling.
  # @!attribute [rw] postgresql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::PostgresqlRdbms]
  #     PostgreSQL data source objects to avoid backfilling.
  # @!attribute [rw] sql_server_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::SqlServerRdbms]
  #     SQLServer data source objects to avoid backfilling
  class BackfillAllStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Backfill strategy to disable automatic backfill for the Stream's objects.
  class BackfillNoneStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Stream state.
  module State
    # Unspecified stream state.
    STATE_UNSPECIFIED = 0

    # The stream has been created but has not yet started streaming data.
    NOT_STARTED = 1

    # The stream is running.
    RUNNING = 2

    # The stream is paused.
    PAUSED = 3

    # The stream is in maintenance mode.
    #
    # Updates are rejected on the resource in this state.
    MAINTENANCE = 4

    # The stream is experiencing an error that is preventing data from being
    # streamed.
    FAILED = 5

    # The stream has experienced a terminal failure.
    FAILED_PERMANENTLY = 6

    # The stream is starting, but not yet running.
    STARTING = 7

    # The Stream is no longer reading new events, but still writing events in
    # the buffer.
    DRAINING = 8
  end
end

#source_config ⇒ ::Google::Cloud::Datastream::V1::SourceConfig

Returns Required. Source connection profile configuration.

Returns:



1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
 
# File 'proto_docs/google/cloud/datastream/v1/datastream_resources.rb', line 1123

class Stream
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Backfill strategy to automatically backfill the Stream's objects.
  # Specific objects can be excluded.
  # @!attribute [rw] oracle_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::OracleRdbms]
  #     Oracle data source objects to avoid backfilling.
  # @!attribute [rw] mysql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::MysqlRdbms]
  #     MySQL data source objects to avoid backfilling.
  # @!attribute [rw] postgresql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::PostgresqlRdbms]
  #     PostgreSQL data source objects to avoid backfilling.
  # @!attribute [rw] sql_server_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::SqlServerRdbms]
  #     SQLServer data source objects to avoid backfilling
  class BackfillAllStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Backfill strategy to disable automatic backfill for the Stream's objects.
  class BackfillNoneStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Stream state.
  module State
    # Unspecified stream state.
    STATE_UNSPECIFIED = 0

    # The stream has been created but has not yet started streaming data.
    NOT_STARTED = 1

    # The stream is running.
    RUNNING = 2

    # The stream is paused.
    PAUSED = 3

    # The stream is in maintenance mode.
    #
    # Updates are rejected on the resource in this state.
    MAINTENANCE = 4

    # The stream is experiencing an error that is preventing data from being
    # streamed.
    FAILED = 5

    # The stream has experienced a terminal failure.
    FAILED_PERMANENTLY = 6

    # The stream is starting, but not yet running.
    STARTING = 7

    # The Stream is no longer reading new events, but still writing events in
    # the buffer.
    DRAINING = 8
  end
end

#state ⇒ ::Google::Cloud::Datastream::V1::Stream::State

Returns The state of the stream.

Returns:



1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
 
# File 'proto_docs/google/cloud/datastream/v1/datastream_resources.rb', line 1123

class Stream
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Backfill strategy to automatically backfill the Stream's objects.
  # Specific objects can be excluded.
  # @!attribute [rw] oracle_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::OracleRdbms]
  #     Oracle data source objects to avoid backfilling.
  # @!attribute [rw] mysql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::MysqlRdbms]
  #     MySQL data source objects to avoid backfilling.
  # @!attribute [rw] postgresql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::PostgresqlRdbms]
  #     PostgreSQL data source objects to avoid backfilling.
  # @!attribute [rw] sql_server_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::SqlServerRdbms]
  #     SQLServer data source objects to avoid backfilling
  class BackfillAllStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Backfill strategy to disable automatic backfill for the Stream's objects.
  class BackfillNoneStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Stream state.
  module State
    # Unspecified stream state.
    STATE_UNSPECIFIED = 0

    # The stream has been created but has not yet started streaming data.
    NOT_STARTED = 1

    # The stream is running.
    RUNNING = 2

    # The stream is paused.
    PAUSED = 3

    # The stream is in maintenance mode.
    #
    # Updates are rejected on the resource in this state.
    MAINTENANCE = 4

    # The stream is experiencing an error that is preventing data from being
    # streamed.
    FAILED = 5

    # The stream has experienced a terminal failure.
    FAILED_PERMANENTLY = 6

    # The stream is starting, but not yet running.
    STARTING = 7

    # The Stream is no longer reading new events, but still writing events in
    # the buffer.
    DRAINING = 8
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The last update time of the stream.

Returns:



1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
 
# File 'proto_docs/google/cloud/datastream/v1/datastream_resources.rb', line 1123

class Stream
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Backfill strategy to automatically backfill the Stream's objects.
  # Specific objects can be excluded.
  # @!attribute [rw] oracle_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::OracleRdbms]
  #     Oracle data source objects to avoid backfilling.
  # @!attribute [rw] mysql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::MysqlRdbms]
  #     MySQL data source objects to avoid backfilling.
  # @!attribute [rw] postgresql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::PostgresqlRdbms]
  #     PostgreSQL data source objects to avoid backfilling.
  # @!attribute [rw] sql_server_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::SqlServerRdbms]
  #     SQLServer data source objects to avoid backfilling
  class BackfillAllStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Backfill strategy to disable automatic backfill for the Stream's objects.
  class BackfillNoneStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Stream state.
  module State
    # Unspecified stream state.
    STATE_UNSPECIFIED = 0

    # The stream has been created but has not yet started streaming data.
    NOT_STARTED = 1

    # The stream is running.
    RUNNING = 2

    # The stream is paused.
    PAUSED = 3

    # The stream is in maintenance mode.
    #
    # Updates are rejected on the resource in this state.
    MAINTENANCE = 4

    # The stream is experiencing an error that is preventing data from being
    # streamed.
    FAILED = 5

    # The stream has experienced a terminal failure.
    FAILED_PERMANENTLY = 6

    # The stream is starting, but not yet running.
    STARTING = 7

    # The Stream is no longer reading new events, but still writing events in
    # the buffer.
    DRAINING = 8
  end
end