Class: Google::Cloud::Firestore::V1::Target

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

Overview

A specification of a set of documents to listen to.

Defined Under Namespace

Classes: DocumentsTarget, QueryTarget

Instance Attribute Summary collapse

Instance Attribute Details

#documents ⇒ ::Google::Cloud::Firestore::V1::Target::DocumentsTarget

Returns A target specified by a set of document names.

Returns:



615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
 
# File 'proto_docs/google/firestore/v1/firestore.rb', line 615

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

  # A target specified by a set of documents names.
  # @!attribute [rw] documents
  #   @return [::Array<::String>]
  #     The names of the documents to retrieve. In the format:
  #     `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
  #     The request will fail if any of the document is not a child resource of
  #     the given `database`. Duplicate names will be elided.
  class DocumentsTarget
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A target specified by a query.
  # @!attribute [rw] parent
  #   @return [::String]
  #     The parent resource name. In the format:
  #     `projects/{project_id}/databases/{database_id}/documents` or
  #     `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
  #     For example:
  #     `projects/my-project/databases/my-database/documents` or
  #     `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
  # @!attribute [rw] structured_query
  #   @return [::Google::Cloud::Firestore::V1::StructuredQuery]
  #     A structured query.
  class QueryTarget
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#once ⇒ ::Boolean

Returns If the target should be removed once it is current and consistent.

Returns:

  • (::Boolean) —

    If the target should be removed once it is current and consistent.



615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
 
# File 'proto_docs/google/firestore/v1/firestore.rb', line 615

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

  # A target specified by a set of documents names.
  # @!attribute [rw] documents
  #   @return [::Array<::String>]
  #     The names of the documents to retrieve. In the format:
  #     `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
  #     The request will fail if any of the document is not a child resource of
  #     the given `database`. Duplicate names will be elided.
  class DocumentsTarget
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A target specified by a query.
  # @!attribute [rw] parent
  #   @return [::String]
  #     The parent resource name. In the format:
  #     `projects/{project_id}/databases/{database_id}/documents` or
  #     `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
  #     For example:
  #     `projects/my-project/databases/my-database/documents` or
  #     `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
  # @!attribute [rw] structured_query
  #   @return [::Google::Cloud::Firestore::V1::StructuredQuery]
  #     A structured query.
  class QueryTarget
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#query ⇒ ::Google::Cloud::Firestore::V1::Target::QueryTarget

Returns A target specified by a query.

Returns:



615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
 
# File 'proto_docs/google/firestore/v1/firestore.rb', line 615

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

  # A target specified by a set of documents names.
  # @!attribute [rw] documents
  #   @return [::Array<::String>]
  #     The names of the documents to retrieve. In the format:
  #     `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
  #     The request will fail if any of the document is not a child resource of
  #     the given `database`. Duplicate names will be elided.
  class DocumentsTarget
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A target specified by a query.
  # @!attribute [rw] parent
  #   @return [::String]
  #     The parent resource name. In the format:
  #     `projects/{project_id}/databases/{database_id}/documents` or
  #     `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
  #     For example:
  #     `projects/my-project/databases/my-database/documents` or
  #     `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
  # @!attribute [rw] structured_query
  #   @return [::Google::Cloud::Firestore::V1::StructuredQuery]
  #     A structured query.
  class QueryTarget
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

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

Returns Start listening after a specific read_time.

The client must know the state of matching documents at this time.

Returns:

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

    Start listening after a specific read_time.

    The client must know the state of matching documents at this time.



615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
 
# File 'proto_docs/google/firestore/v1/firestore.rb', line 615

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

  # A target specified by a set of documents names.
  # @!attribute [rw] documents
  #   @return [::Array<::String>]
  #     The names of the documents to retrieve. In the format:
  #     `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
  #     The request will fail if any of the document is not a child resource of
  #     the given `database`. Duplicate names will be elided.
  class DocumentsTarget
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A target specified by a query.
  # @!attribute [rw] parent
  #   @return [::String]
  #     The parent resource name. In the format:
  #     `projects/{project_id}/databases/{database_id}/documents` or
  #     `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
  #     For example:
  #     `projects/my-project/databases/my-database/documents` or
  #     `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
  # @!attribute [rw] structured_query
  #   @return [::Google::Cloud::Firestore::V1::StructuredQuery]
  #     A structured query.
  class QueryTarget
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#resume_token ⇒ ::String

Returns A resume token from a prior TargetChange for an identical target.

Using a resume token with a different target is unsupported and may fail.

Returns:

  • (::String) —

    A resume token from a prior TargetChange for an identical target.

    Using a resume token with a different target is unsupported and may fail.



615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
 
# File 'proto_docs/google/firestore/v1/firestore.rb', line 615

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

  # A target specified by a set of documents names.
  # @!attribute [rw] documents
  #   @return [::Array<::String>]
  #     The names of the documents to retrieve. In the format:
  #     `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
  #     The request will fail if any of the document is not a child resource of
  #     the given `database`. Duplicate names will be elided.
  class DocumentsTarget
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A target specified by a query.
  # @!attribute [rw] parent
  #   @return [::String]
  #     The parent resource name. In the format:
  #     `projects/{project_id}/databases/{database_id}/documents` or
  #     `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
  #     For example:
  #     `projects/my-project/databases/my-database/documents` or
  #     `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
  # @!attribute [rw] structured_query
  #   @return [::Google::Cloud::Firestore::V1::StructuredQuery]
  #     A structured query.
  class QueryTarget
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#target_id ⇒ ::Integer

Returns The target ID that identifies the target on the stream. Must be a positive number and non-zero.

Returns:

  • (::Integer) —

    The target ID that identifies the target on the stream. Must be a positive number and non-zero.



615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
 
# File 'proto_docs/google/firestore/v1/firestore.rb', line 615

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

  # A target specified by a set of documents names.
  # @!attribute [rw] documents
  #   @return [::Array<::String>]
  #     The names of the documents to retrieve. In the format:
  #     `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
  #     The request will fail if any of the document is not a child resource of
  #     the given `database`. Duplicate names will be elided.
  class DocumentsTarget
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A target specified by a query.
  # @!attribute [rw] parent
  #   @return [::String]
  #     The parent resource name. In the format:
  #     `projects/{project_id}/databases/{database_id}/documents` or
  #     `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
  #     For example:
  #     `projects/my-project/databases/my-database/documents` or
  #     `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
  # @!attribute [rw] structured_query
  #   @return [::Google::Cloud::Firestore::V1::StructuredQuery]
  #     A structured query.
  class QueryTarget
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end