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.

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.



1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
 
# File 'proto_docs/google/cloud/datastream/v1/datastream_resources.rb', line 1463

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.
  #
  #     Note: The following fields are mutually exclusive: `oracle_excluded_objects`, `mysql_excluded_objects`, `postgresql_excluded_objects`, `sql_server_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] mysql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::MysqlRdbms]
  #     MySQL data source objects to avoid backfilling.
  #
  #     Note: The following fields are mutually exclusive: `mysql_excluded_objects`, `oracle_excluded_objects`, `postgresql_excluded_objects`, `sql_server_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] postgresql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::PostgresqlRdbms]
  #     PostgreSQL data source objects to avoid backfilling.
  #
  #     Note: The following fields are mutually exclusive: `postgresql_excluded_objects`, `oracle_excluded_objects`, `mysql_excluded_objects`, `sql_server_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] sql_server_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::SqlServerRdbms]
  #     SQLServer data source objects to avoid backfilling
  #
  #     Note: The following fields are mutually exclusive: `sql_server_excluded_objects`, `oracle_excluded_objects`, `mysql_excluded_objects`, `postgresql_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] salesforce_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::SalesforceOrg]
  #     Salesforce data source objects to avoid backfilling
  #
  #     Note: The following fields are mutually exclusive: `salesforce_excluded_objects`, `oracle_excluded_objects`, `mysql_excluded_objects`, `postgresql_excluded_objects`, `sql_server_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  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.

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:



1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
 
# File 'proto_docs/google/cloud/datastream/v1/datastream_resources.rb', line 1463

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.
  #
  #     Note: The following fields are mutually exclusive: `oracle_excluded_objects`, `mysql_excluded_objects`, `postgresql_excluded_objects`, `sql_server_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] mysql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::MysqlRdbms]
  #     MySQL data source objects to avoid backfilling.
  #
  #     Note: The following fields are mutually exclusive: `mysql_excluded_objects`, `oracle_excluded_objects`, `postgresql_excluded_objects`, `sql_server_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] postgresql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::PostgresqlRdbms]
  #     PostgreSQL data source objects to avoid backfilling.
  #
  #     Note: The following fields are mutually exclusive: `postgresql_excluded_objects`, `oracle_excluded_objects`, `mysql_excluded_objects`, `sql_server_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] sql_server_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::SqlServerRdbms]
  #     SQLServer data source objects to avoid backfilling
  #
  #     Note: The following fields are mutually exclusive: `sql_server_excluded_objects`, `oracle_excluded_objects`, `mysql_excluded_objects`, `postgresql_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] salesforce_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::SalesforceOrg]
  #     Salesforce data source objects to avoid backfilling
  #
  #     Note: The following fields are mutually exclusive: `salesforce_excluded_objects`, `oracle_excluded_objects`, `mysql_excluded_objects`, `postgresql_excluded_objects`, `sql_server_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  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:



1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
 
# File 'proto_docs/google/cloud/datastream/v1/datastream_resources.rb', line 1463

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.
  #
  #     Note: The following fields are mutually exclusive: `oracle_excluded_objects`, `mysql_excluded_objects`, `postgresql_excluded_objects`, `sql_server_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] mysql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::MysqlRdbms]
  #     MySQL data source objects to avoid backfilling.
  #
  #     Note: The following fields are mutually exclusive: `mysql_excluded_objects`, `oracle_excluded_objects`, `postgresql_excluded_objects`, `sql_server_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] postgresql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::PostgresqlRdbms]
  #     PostgreSQL data source objects to avoid backfilling.
  #
  #     Note: The following fields are mutually exclusive: `postgresql_excluded_objects`, `oracle_excluded_objects`, `mysql_excluded_objects`, `sql_server_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] sql_server_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::SqlServerRdbms]
  #     SQLServer data source objects to avoid backfilling
  #
  #     Note: The following fields are mutually exclusive: `sql_server_excluded_objects`, `oracle_excluded_objects`, `mysql_excluded_objects`, `postgresql_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] salesforce_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::SalesforceOrg]
  #     Salesforce data source objects to avoid backfilling
  #
  #     Note: The following fields are mutually exclusive: `salesforce_excluded_objects`, `oracle_excluded_objects`, `mysql_excluded_objects`, `postgresql_excluded_objects`, `sql_server_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  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.



1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
 
# File 'proto_docs/google/cloud/datastream/v1/datastream_resources.rb', line 1463

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.
  #
  #     Note: The following fields are mutually exclusive: `oracle_excluded_objects`, `mysql_excluded_objects`, `postgresql_excluded_objects`, `sql_server_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] mysql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::MysqlRdbms]
  #     MySQL data source objects to avoid backfilling.
  #
  #     Note: The following fields are mutually exclusive: `mysql_excluded_objects`, `oracle_excluded_objects`, `postgresql_excluded_objects`, `sql_server_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] postgresql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::PostgresqlRdbms]
  #     PostgreSQL data source objects to avoid backfilling.
  #
  #     Note: The following fields are mutually exclusive: `postgresql_excluded_objects`, `oracle_excluded_objects`, `mysql_excluded_objects`, `sql_server_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] sql_server_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::SqlServerRdbms]
  #     SQLServer data source objects to avoid backfilling
  #
  #     Note: The following fields are mutually exclusive: `sql_server_excluded_objects`, `oracle_excluded_objects`, `mysql_excluded_objects`, `postgresql_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] salesforce_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::SalesforceOrg]
  #     Salesforce data source objects to avoid backfilling
  #
  #     Note: The following fields are mutually exclusive: `salesforce_excluded_objects`, `oracle_excluded_objects`, `mysql_excluded_objects`, `postgresql_excluded_objects`, `sql_server_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  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:



1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
 
# File 'proto_docs/google/cloud/datastream/v1/datastream_resources.rb', line 1463

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.
  #
  #     Note: The following fields are mutually exclusive: `oracle_excluded_objects`, `mysql_excluded_objects`, `postgresql_excluded_objects`, `sql_server_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] mysql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::MysqlRdbms]
  #     MySQL data source objects to avoid backfilling.
  #
  #     Note: The following fields are mutually exclusive: `mysql_excluded_objects`, `oracle_excluded_objects`, `postgresql_excluded_objects`, `sql_server_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] postgresql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::PostgresqlRdbms]
  #     PostgreSQL data source objects to avoid backfilling.
  #
  #     Note: The following fields are mutually exclusive: `postgresql_excluded_objects`, `oracle_excluded_objects`, `mysql_excluded_objects`, `sql_server_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] sql_server_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::SqlServerRdbms]
  #     SQLServer data source objects to avoid backfilling
  #
  #     Note: The following fields are mutually exclusive: `sql_server_excluded_objects`, `oracle_excluded_objects`, `mysql_excluded_objects`, `postgresql_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] salesforce_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::SalesforceOrg]
  #     Salesforce data source objects to avoid backfilling
  #
  #     Note: The following fields are mutually exclusive: `salesforce_excluded_objects`, `oracle_excluded_objects`, `mysql_excluded_objects`, `postgresql_excluded_objects`, `sql_server_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  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.



1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
 
# File 'proto_docs/google/cloud/datastream/v1/datastream_resources.rb', line 1463

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.
  #
  #     Note: The following fields are mutually exclusive: `oracle_excluded_objects`, `mysql_excluded_objects`, `postgresql_excluded_objects`, `sql_server_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] mysql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::MysqlRdbms]
  #     MySQL data source objects to avoid backfilling.
  #
  #     Note: The following fields are mutually exclusive: `mysql_excluded_objects`, `oracle_excluded_objects`, `postgresql_excluded_objects`, `sql_server_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] postgresql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::PostgresqlRdbms]
  #     PostgreSQL data source objects to avoid backfilling.
  #
  #     Note: The following fields are mutually exclusive: `postgresql_excluded_objects`, `oracle_excluded_objects`, `mysql_excluded_objects`, `sql_server_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] sql_server_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::SqlServerRdbms]
  #     SQLServer data source objects to avoid backfilling
  #
  #     Note: The following fields are mutually exclusive: `sql_server_excluded_objects`, `oracle_excluded_objects`, `mysql_excluded_objects`, `postgresql_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] salesforce_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::SalesforceOrg]
  #     Salesforce data source objects to avoid backfilling
  #
  #     Note: The following fields are mutually exclusive: `salesforce_excluded_objects`, `oracle_excluded_objects`, `mysql_excluded_objects`, `postgresql_excluded_objects`, `sql_server_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  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:



1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
 
# File 'proto_docs/google/cloud/datastream/v1/datastream_resources.rb', line 1463

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.
  #
  #     Note: The following fields are mutually exclusive: `oracle_excluded_objects`, `mysql_excluded_objects`, `postgresql_excluded_objects`, `sql_server_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] mysql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::MysqlRdbms]
  #     MySQL data source objects to avoid backfilling.
  #
  #     Note: The following fields are mutually exclusive: `mysql_excluded_objects`, `oracle_excluded_objects`, `postgresql_excluded_objects`, `sql_server_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] postgresql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::PostgresqlRdbms]
  #     PostgreSQL data source objects to avoid backfilling.
  #
  #     Note: The following fields are mutually exclusive: `postgresql_excluded_objects`, `oracle_excluded_objects`, `mysql_excluded_objects`, `sql_server_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] sql_server_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::SqlServerRdbms]
  #     SQLServer data source objects to avoid backfilling
  #
  #     Note: The following fields are mutually exclusive: `sql_server_excluded_objects`, `oracle_excluded_objects`, `mysql_excluded_objects`, `postgresql_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] salesforce_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::SalesforceOrg]
  #     Salesforce data source objects to avoid backfilling
  #
  #     Note: The following fields are mutually exclusive: `salesforce_excluded_objects`, `oracle_excluded_objects`, `mysql_excluded_objects`, `postgresql_excluded_objects`, `sql_server_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  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.



1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
 
# File 'proto_docs/google/cloud/datastream/v1/datastream_resources.rb', line 1463

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.
  #
  #     Note: The following fields are mutually exclusive: `oracle_excluded_objects`, `mysql_excluded_objects`, `postgresql_excluded_objects`, `sql_server_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] mysql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::MysqlRdbms]
  #     MySQL data source objects to avoid backfilling.
  #
  #     Note: The following fields are mutually exclusive: `mysql_excluded_objects`, `oracle_excluded_objects`, `postgresql_excluded_objects`, `sql_server_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] postgresql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::PostgresqlRdbms]
  #     PostgreSQL data source objects to avoid backfilling.
  #
  #     Note: The following fields are mutually exclusive: `postgresql_excluded_objects`, `oracle_excluded_objects`, `mysql_excluded_objects`, `sql_server_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] sql_server_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::SqlServerRdbms]
  #     SQLServer data source objects to avoid backfilling
  #
  #     Note: The following fields are mutually exclusive: `sql_server_excluded_objects`, `oracle_excluded_objects`, `mysql_excluded_objects`, `postgresql_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] salesforce_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::SalesforceOrg]
  #     Salesforce data source objects to avoid backfilling
  #
  #     Note: The following fields are mutually exclusive: `salesforce_excluded_objects`, `oracle_excluded_objects`, `mysql_excluded_objects`, `postgresql_excluded_objects`, `sql_server_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  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.



1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
 
# File 'proto_docs/google/cloud/datastream/v1/datastream_resources.rb', line 1463

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.
  #
  #     Note: The following fields are mutually exclusive: `oracle_excluded_objects`, `mysql_excluded_objects`, `postgresql_excluded_objects`, `sql_server_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] mysql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::MysqlRdbms]
  #     MySQL data source objects to avoid backfilling.
  #
  #     Note: The following fields are mutually exclusive: `mysql_excluded_objects`, `oracle_excluded_objects`, `postgresql_excluded_objects`, `sql_server_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] postgresql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::PostgresqlRdbms]
  #     PostgreSQL data source objects to avoid backfilling.
  #
  #     Note: The following fields are mutually exclusive: `postgresql_excluded_objects`, `oracle_excluded_objects`, `mysql_excluded_objects`, `sql_server_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] sql_server_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::SqlServerRdbms]
  #     SQLServer data source objects to avoid backfilling
  #
  #     Note: The following fields are mutually exclusive: `sql_server_excluded_objects`, `oracle_excluded_objects`, `mysql_excluded_objects`, `postgresql_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] salesforce_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::SalesforceOrg]
  #     Salesforce data source objects to avoid backfilling
  #
  #     Note: The following fields are mutually exclusive: `salesforce_excluded_objects`, `oracle_excluded_objects`, `mysql_excluded_objects`, `postgresql_excluded_objects`, `sql_server_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  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. Identifier. The stream's name.

Returns:

  • (::String) —

    Output only. Identifier. The stream's name.



1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
 
# File 'proto_docs/google/cloud/datastream/v1/datastream_resources.rb', line 1463

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.
  #
  #     Note: The following fields are mutually exclusive: `oracle_excluded_objects`, `mysql_excluded_objects`, `postgresql_excluded_objects`, `sql_server_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] mysql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::MysqlRdbms]
  #     MySQL data source objects to avoid backfilling.
  #
  #     Note: The following fields are mutually exclusive: `mysql_excluded_objects`, `oracle_excluded_objects`, `postgresql_excluded_objects`, `sql_server_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] postgresql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::PostgresqlRdbms]
  #     PostgreSQL data source objects to avoid backfilling.
  #
  #     Note: The following fields are mutually exclusive: `postgresql_excluded_objects`, `oracle_excluded_objects`, `mysql_excluded_objects`, `sql_server_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] sql_server_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::SqlServerRdbms]
  #     SQLServer data source objects to avoid backfilling
  #
  #     Note: The following fields are mutually exclusive: `sql_server_excluded_objects`, `oracle_excluded_objects`, `mysql_excluded_objects`, `postgresql_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] salesforce_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::SalesforceOrg]
  #     Salesforce data source objects to avoid backfilling
  #
  #     Note: The following fields are mutually exclusive: `salesforce_excluded_objects`, `oracle_excluded_objects`, `mysql_excluded_objects`, `postgresql_excluded_objects`, `sql_server_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  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

#satisfies_pzi ⇒ ::Boolean (readonly)

Returns Output only. Reserved for future use.

Returns:

  • (::Boolean) —

    Output only. Reserved for future use.



1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
 
# File 'proto_docs/google/cloud/datastream/v1/datastream_resources.rb', line 1463

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.
  #
  #     Note: The following fields are mutually exclusive: `oracle_excluded_objects`, `mysql_excluded_objects`, `postgresql_excluded_objects`, `sql_server_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] mysql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::MysqlRdbms]
  #     MySQL data source objects to avoid backfilling.
  #
  #     Note: The following fields are mutually exclusive: `mysql_excluded_objects`, `oracle_excluded_objects`, `postgresql_excluded_objects`, `sql_server_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] postgresql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::PostgresqlRdbms]
  #     PostgreSQL data source objects to avoid backfilling.
  #
  #     Note: The following fields are mutually exclusive: `postgresql_excluded_objects`, `oracle_excluded_objects`, `mysql_excluded_objects`, `sql_server_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] sql_server_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::SqlServerRdbms]
  #     SQLServer data source objects to avoid backfilling
  #
  #     Note: The following fields are mutually exclusive: `sql_server_excluded_objects`, `oracle_excluded_objects`, `mysql_excluded_objects`, `postgresql_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] salesforce_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::SalesforceOrg]
  #     Salesforce data source objects to avoid backfilling
  #
  #     Note: The following fields are mutually exclusive: `salesforce_excluded_objects`, `oracle_excluded_objects`, `mysql_excluded_objects`, `postgresql_excluded_objects`, `sql_server_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  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

#satisfies_pzs ⇒ ::Boolean (readonly)

Returns Output only. Reserved for future use.

Returns:

  • (::Boolean) —

    Output only. Reserved for future use.



1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
 
# File 'proto_docs/google/cloud/datastream/v1/datastream_resources.rb', line 1463

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.
  #
  #     Note: The following fields are mutually exclusive: `oracle_excluded_objects`, `mysql_excluded_objects`, `postgresql_excluded_objects`, `sql_server_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] mysql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::MysqlRdbms]
  #     MySQL data source objects to avoid backfilling.
  #
  #     Note: The following fields are mutually exclusive: `mysql_excluded_objects`, `oracle_excluded_objects`, `postgresql_excluded_objects`, `sql_server_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] postgresql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::PostgresqlRdbms]
  #     PostgreSQL data source objects to avoid backfilling.
  #
  #     Note: The following fields are mutually exclusive: `postgresql_excluded_objects`, `oracle_excluded_objects`, `mysql_excluded_objects`, `sql_server_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] sql_server_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::SqlServerRdbms]
  #     SQLServer data source objects to avoid backfilling
  #
  #     Note: The following fields are mutually exclusive: `sql_server_excluded_objects`, `oracle_excluded_objects`, `mysql_excluded_objects`, `postgresql_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] salesforce_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::SalesforceOrg]
  #     Salesforce data source objects to avoid backfilling
  #
  #     Note: The following fields are mutually exclusive: `salesforce_excluded_objects`, `oracle_excluded_objects`, `mysql_excluded_objects`, `postgresql_excluded_objects`, `sql_server_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  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:



1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
 
# File 'proto_docs/google/cloud/datastream/v1/datastream_resources.rb', line 1463

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.
  #
  #     Note: The following fields are mutually exclusive: `oracle_excluded_objects`, `mysql_excluded_objects`, `postgresql_excluded_objects`, `sql_server_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] mysql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::MysqlRdbms]
  #     MySQL data source objects to avoid backfilling.
  #
  #     Note: The following fields are mutually exclusive: `mysql_excluded_objects`, `oracle_excluded_objects`, `postgresql_excluded_objects`, `sql_server_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] postgresql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::PostgresqlRdbms]
  #     PostgreSQL data source objects to avoid backfilling.
  #
  #     Note: The following fields are mutually exclusive: `postgresql_excluded_objects`, `oracle_excluded_objects`, `mysql_excluded_objects`, `sql_server_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] sql_server_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::SqlServerRdbms]
  #     SQLServer data source objects to avoid backfilling
  #
  #     Note: The following fields are mutually exclusive: `sql_server_excluded_objects`, `oracle_excluded_objects`, `mysql_excluded_objects`, `postgresql_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] salesforce_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::SalesforceOrg]
  #     Salesforce data source objects to avoid backfilling
  #
  #     Note: The following fields are mutually exclusive: `salesforce_excluded_objects`, `oracle_excluded_objects`, `mysql_excluded_objects`, `postgresql_excluded_objects`, `sql_server_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  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:



1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
 
# File 'proto_docs/google/cloud/datastream/v1/datastream_resources.rb', line 1463

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.
  #
  #     Note: The following fields are mutually exclusive: `oracle_excluded_objects`, `mysql_excluded_objects`, `postgresql_excluded_objects`, `sql_server_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] mysql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::MysqlRdbms]
  #     MySQL data source objects to avoid backfilling.
  #
  #     Note: The following fields are mutually exclusive: `mysql_excluded_objects`, `oracle_excluded_objects`, `postgresql_excluded_objects`, `sql_server_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] postgresql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::PostgresqlRdbms]
  #     PostgreSQL data source objects to avoid backfilling.
  #
  #     Note: The following fields are mutually exclusive: `postgresql_excluded_objects`, `oracle_excluded_objects`, `mysql_excluded_objects`, `sql_server_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] sql_server_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::SqlServerRdbms]
  #     SQLServer data source objects to avoid backfilling
  #
  #     Note: The following fields are mutually exclusive: `sql_server_excluded_objects`, `oracle_excluded_objects`, `mysql_excluded_objects`, `postgresql_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] salesforce_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::SalesforceOrg]
  #     Salesforce data source objects to avoid backfilling
  #
  #     Note: The following fields are mutually exclusive: `salesforce_excluded_objects`, `oracle_excluded_objects`, `mysql_excluded_objects`, `postgresql_excluded_objects`, `sql_server_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  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:



1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
 
# File 'proto_docs/google/cloud/datastream/v1/datastream_resources.rb', line 1463

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.
  #
  #     Note: The following fields are mutually exclusive: `oracle_excluded_objects`, `mysql_excluded_objects`, `postgresql_excluded_objects`, `sql_server_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] mysql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::MysqlRdbms]
  #     MySQL data source objects to avoid backfilling.
  #
  #     Note: The following fields are mutually exclusive: `mysql_excluded_objects`, `oracle_excluded_objects`, `postgresql_excluded_objects`, `sql_server_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] postgresql_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::PostgresqlRdbms]
  #     PostgreSQL data source objects to avoid backfilling.
  #
  #     Note: The following fields are mutually exclusive: `postgresql_excluded_objects`, `oracle_excluded_objects`, `mysql_excluded_objects`, `sql_server_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] sql_server_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::SqlServerRdbms]
  #     SQLServer data source objects to avoid backfilling
  #
  #     Note: The following fields are mutually exclusive: `sql_server_excluded_objects`, `oracle_excluded_objects`, `mysql_excluded_objects`, `postgresql_excluded_objects`, `salesforce_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] salesforce_excluded_objects
  #   @return [::Google::Cloud::Datastream::V1::SalesforceOrg]
  #     Salesforce data source objects to avoid backfilling
  #
  #     Note: The following fields are mutually exclusive: `salesforce_excluded_objects`, `oracle_excluded_objects`, `mysql_excluded_objects`, `postgresql_excluded_objects`, `sql_server_excluded_objects`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  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