Class: Google::Cloud::Firestore::V1::TargetChange

Inherits:

Object

• Object
• Google::Cloud::Firestore::V1::TargetChange

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/firestore/v1/firestore.rb

Overview

Targets being watched have changed.

Defined Under Namespace

Modules: TargetChangeType

Instance Attribute Summary

• #cause ⇒ ::Google::Rpc::Status

  The error that resulted in this change, if applicable.

• #read_time ⇒ ::Google::Protobuf::Timestamp

  The consistent read_time for the given target_ids (omitted when the target_ids are not at a consistent snapshot).

• #resume_token ⇒ ::String

  A token that can be used to resume the stream for the given target_ids, or all targets if target_ids is empty.

• #target_change_type ⇒ ::Google::Cloud::Firestore::V1::TargetChange::TargetChangeType

  The type of change that occurred.

• #target_ids ⇒ ::Array<::Integer>

  The target IDs of targets that have changed.

Instance Attribute Details

#cause ⇒ ::Google::Rpc::Status

# File 'proto_docs/google/firestore/v1/firestore.rb', line 680

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

  # The type of change.
  module TargetChangeType
    # No change has occurred. Used only to send an updated `resume_token`.
    NO_CHANGE = 0

    # The targets have been added.
    ADD = 1

    # The targets have been removed.
    REMOVE = 2

    # The targets reflect all changes committed before the targets were added
    # to the stream.
    #
    # This will be sent after or with a `read_time` that is greater than or
    # equal to the time at which the targets were added.
    #
    # Listeners can wait for this change if read-after-write semantics
    # are desired.
    CURRENT = 3

    # The targets have been reset, and a new initial state for the targets
    # will be returned in subsequent changes.
    #
    # After the initial state is complete, `CURRENT` will be returned even
    # if the target was previously indicated to be `CURRENT`.
    RESET = 4
  end
end

#read_time ⇒ ::Google::Protobuf::Timestamp

# File 'proto_docs/google/firestore/v1/firestore.rb', line 680

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

  # The type of change.
  module TargetChangeType
    # No change has occurred. Used only to send an updated `resume_token`.
    NO_CHANGE = 0

    # The targets have been added.
    ADD = 1

    # The targets have been removed.
    REMOVE = 2

    # The targets reflect all changes committed before the targets were added
    # to the stream.
    #
    # This will be sent after or with a `read_time` that is greater than or
    # equal to the time at which the targets were added.
    #
    # Listeners can wait for this change if read-after-write semantics
    # are desired.
    CURRENT = 3

    # The targets have been reset, and a new initial state for the targets
    # will be returned in subsequent changes.
    #
    # After the initial state is complete, `CURRENT` will be returned even
    # if the target was previously indicated to be `CURRENT`.
    RESET = 4
  end
end

#resume_token ⇒ ::String

# File 'proto_docs/google/firestore/v1/firestore.rb', line 680

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

  # The type of change.
  module TargetChangeType
    # No change has occurred. Used only to send an updated `resume_token`.
    NO_CHANGE = 0

    # The targets have been added.
    ADD = 1

    # The targets have been removed.
    REMOVE = 2

    # The targets reflect all changes committed before the targets were added
    # to the stream.
    #
    # This will be sent after or with a `read_time` that is greater than or
    # equal to the time at which the targets were added.
    #
    # Listeners can wait for this change if read-after-write semantics
    # are desired.
    CURRENT = 3

    # The targets have been reset, and a new initial state for the targets
    # will be returned in subsequent changes.
    #
    # After the initial state is complete, `CURRENT` will be returned even
    # if the target was previously indicated to be `CURRENT`.
    RESET = 4
  end
end

#target_change_type ⇒ ::Google::Cloud::Firestore::V1::TargetChange::TargetChangeType

# File 'proto_docs/google/firestore/v1/firestore.rb', line 680

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

  # The type of change.
  module TargetChangeType
    # No change has occurred. Used only to send an updated `resume_token`.
    NO_CHANGE = 0

    # The targets have been added.
    ADD = 1

    # The targets have been removed.
    REMOVE = 2

    # The targets reflect all changes committed before the targets were added
    # to the stream.
    #
    # This will be sent after or with a `read_time` that is greater than or
    # equal to the time at which the targets were added.
    #
    # Listeners can wait for this change if read-after-write semantics
    # are desired.
    CURRENT = 3

    # The targets have been reset, and a new initial state for the targets
    # will be returned in subsequent changes.
    #
    # After the initial state is complete, `CURRENT` will be returned even
    # if the target was previously indicated to be `CURRENT`.
    RESET = 4
  end
end

#target_ids ⇒ ::Array<::Integer>

# File 'proto_docs/google/firestore/v1/firestore.rb', line 680

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

  # The type of change.
  module TargetChangeType
    # No change has occurred. Used only to send an updated `resume_token`.
    NO_CHANGE = 0

    # The targets have been added.
    ADD = 1

    # The targets have been removed.
    REMOVE = 2

    # The targets reflect all changes committed before the targets were added
    # to the stream.
    #
    # This will be sent after or with a `read_time` that is greater than or
    # equal to the time at which the targets were added.
    #
    # Listeners can wait for this change if read-after-write semantics
    # are desired.
    CURRENT = 3

    # The targets have been reset, and a new initial state for the targets
    # will be returned in subsequent changes.
    #
    # After the initial state is complete, `CURRENT` will be returned even
    # if the target was previously indicated to be `CURRENT`.
    RESET = 4
  end
end