Class MongoDbCursorMethodsProperties


  • public final class MongoDbCursorMethodsProperties
    extends Object
    Cursor methods for Mongodb query.
    • Constructor Detail

      • MongoDbCursorMethodsProperties

        public MongoDbCursorMethodsProperties()
    • Method Detail

      • project

        public Object project()
        Get the project property: Specifies the fields to return in the documents that match the query filter. To return all fields in the matching documents, omit this parameter. Type: string (or Expression with resultType string).
        Returns:
        the project value.
      • withProject

        public MongoDbCursorMethodsProperties withProject​(Object project)
        Set the project property: Specifies the fields to return in the documents that match the query filter. To return all fields in the matching documents, omit this parameter. Type: string (or Expression with resultType string).
        Parameters:
        project - the project value to set.
        Returns:
        the MongoDbCursorMethodsProperties object itself.
      • sort

        public Object sort()
        Get the sort property: Specifies the order in which the query returns matching documents. Type: string (or Expression with resultType string). Type: string (or Expression with resultType string).
        Returns:
        the sort value.
      • withSort

        public MongoDbCursorMethodsProperties withSort​(Object sort)
        Set the sort property: Specifies the order in which the query returns matching documents. Type: string (or Expression with resultType string). Type: string (or Expression with resultType string).
        Parameters:
        sort - the sort value to set.
        Returns:
        the MongoDbCursorMethodsProperties object itself.
      • skip

        public Object skip()
        Get the skip property: Specifies the how many documents skipped and where MongoDB begins returning results. This approach may be useful in implementing paginated results. Type: integer (or Expression with resultType integer).
        Returns:
        the skip value.
      • withSkip

        public MongoDbCursorMethodsProperties withSkip​(Object skip)
        Set the skip property: Specifies the how many documents skipped and where MongoDB begins returning results. This approach may be useful in implementing paginated results. Type: integer (or Expression with resultType integer).
        Parameters:
        skip - the skip value to set.
        Returns:
        the MongoDbCursorMethodsProperties object itself.
      • limit

        public Object limit()
        Get the limit property: Specifies the maximum number of documents the server returns. limit() is analogous to the LIMIT statement in a SQL database. Type: integer (or Expression with resultType integer).
        Returns:
        the limit value.
      • withLimit

        public MongoDbCursorMethodsProperties withLimit​(Object limit)
        Set the limit property: Specifies the maximum number of documents the server returns. limit() is analogous to the LIMIT statement in a SQL database. Type: integer (or Expression with resultType integer).
        Parameters:
        limit - the limit value to set.
        Returns:
        the MongoDbCursorMethodsProperties object itself.
      • additionalProperties

        public Map<String,​Object> additionalProperties()
        Get the additionalProperties property: Cursor methods for Mongodb query.
        Returns:
        the additionalProperties value.
      • withAdditionalProperties

        public MongoDbCursorMethodsProperties withAdditionalProperties​(Map<String,​Object> additionalProperties)
        Set the additionalProperties property: Cursor methods for Mongodb query.
        Parameters:
        additionalProperties - the additionalProperties value to set.
        Returns:
        the MongoDbCursorMethodsProperties object itself.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.